aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.ibm.com>2019-05-31 16:13:49 +1000
committerStewart Smith <stewart@linux.ibm.com>2019-06-03 10:20:00 +1000
commit3240ad51fa8126bd6dd381d0510fe1aa314284c0 (patch)
tree9c366b65eb8ba132876982e8ad2e05b56638dd3d
parent05cf82f958f27971a39ddd1f229c448166b390fc (diff)
downloadskiboot-3240ad51fa8126bd6dd381d0510fe1aa314284c0.zip
skiboot-3240ad51fa8126bd6dd381d0510fe1aa314284c0.tar.gz
skiboot-3240ad51fa8126bd6dd381d0510fe1aa314284c0.tar.bz2
doc: Document OPAL_CONFIG_CPU_IDLE_STATE
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
-rw-r--r--doc/opal-api/opal-config-cpu-idle-state-99.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/opal-api/opal-config-cpu-idle-state-99.rst b/doc/opal-api/opal-config-cpu-idle-state-99.rst
new file mode 100644
index 0000000..787d2ca
--- /dev/null
+++ b/doc/opal-api/opal-config-cpu-idle-state-99.rst
@@ -0,0 +1,32 @@
+.. _OPAL_CONFIG_CPU_IDLE_STATE:
+
+OPAL_CONFIG_CPU_IDLE_STATE
+==========================
+
+.. code-block:: c
+
+ #define OPAL_CONFIG_CPU_IDLE_STATE 99
+
+ /*
+ * Setup and cleanup method for fast-sleep workarounds
+ * state = 1 fast-sleep
+ * enter = 1 Enter state
+ * exit = 0 Exit state
+ */
+
+ #define OPAL_PM_SLEEP_ENABLED_ER1 0x00080000 /* with workaround */
+
+ int64_t opal_config_cpu_idle_state(uint64_t state, uint64_t enter);
+
+If the `OPAL_PM_SLEEP_ENABLED_ER1` bit is set on a stop state, then this OPAL
+call needs to be made upon entry and exit of stop state.
+This is currently needed for the `fastsleep_` idle state, present on POWER8
+systems.
+
+Returns
+-------
+
+:ref:`OPAL_SUCCESS`
+ Applied workaround
+:ref:`OPAL_PARAMETER`
+ Invalid state or enter/exit.