summaryrefslogtreecommitdiff
path: root/include/throttle_ap.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/throttle_ap.h')
-rw-r--r--include/throttle_ap.h51
1 files changed, 51 insertions, 0 deletions
diff --git a/include/throttle_ap.h b/include/throttle_ap.h
new file mode 100644
index 0000000000..e66a5c6bec
--- /dev/null
+++ b/include/throttle_ap.h
@@ -0,0 +1,51 @@
+/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+/* Common interface to throttle the AP */
+
+#ifndef __CROS_EC_THROTTLE_AP_H
+#define __CROS_EC_THROTTLE_AP_H
+
+/**
+ * Level of throttling desired.
+ */
+enum throttle_level {
+ THROTTLE_OFF = 0,
+ THROTTLE_ON,
+};
+
+/**
+ * Types of throttling desired. These are independent.
+ */
+enum throttle_type {
+ THROTTLE_SOFT = 0, /* for example, host events */
+ THROTTLE_HARD, /* for example, PROCHOT */
+ NUM_THROTTLE_TYPES
+};
+
+/**
+ * Possible sources for CPU throttling requests.
+ */
+enum throttle_sources {
+ THROTTLE_SRC_THERMAL = 0,
+ THROTTLE_SRC_POWER,
+};
+
+
+/**
+ * Enable/disable CPU throttling.
+ *
+ * This is a virtual "OR" operation. Any caller can enable CPU throttling of
+ * any type, but all callers must agree in order to disable that type.
+ *
+ * @param level Level of throttling desired
+ * @param type Type of throttling desired
+ * @param source Which task is requesting throttling
+ */
+void throttle_ap(enum throttle_level level,
+ enum throttle_type type,
+ enum throttle_sources source);
+
+#endif /* __CROS_EC_THROTTLE_AP_H */