aboutsummaryrefslogtreecommitdiffstats
path: root/roms/skiboot/doc/opal-api/opal-config-cpu-idle-state-99.rst
diff options
context:
space:
mode:
authorAngelos Mouzakitis <a.mouzakitis@virtualopensystems.com>2023-10-10 14:33:42 +0000
committerAngelos Mouzakitis <a.mouzakitis@virtualopensystems.com>2023-10-10 14:33:42 +0000
commitaf1a266670d040d2f4083ff309d732d648afba2a (patch)
tree2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/skiboot/doc/opal-api/opal-config-cpu-idle-state-99.rst
parente02cda008591317b1625707ff8e115a4841aa889 (diff)
Add submodule dependency filesHEADmaster
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-config-cpu-idle-state-99.rst')
-rw-r--r--roms/skiboot/doc/opal-api/opal-config-cpu-idle-state-99.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-config-cpu-idle-state-99.rst b/roms/skiboot/doc/opal-api/opal-config-cpu-idle-state-99.rst
new file mode 100644
index 000000000..787d2cae9
--- /dev/null
+++ b/roms/skiboot/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.