aboutsummaryrefslogtreecommitdiffstats
path: root/roms/skiboot/doc/opal-api/opal-pci-get-power-state-120.rst
diff options
context:
space:
mode:
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-pci-get-power-state-120.rst')
-rw-r--r--roms/skiboot/doc/opal-api/opal-pci-get-power-state-120.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-pci-get-power-state-120.rst b/roms/skiboot/doc/opal-api/opal-pci-get-power-state-120.rst
new file mode 100644
index 000000000..fa0375d83
--- /dev/null
+++ b/roms/skiboot/doc/opal-api/opal-pci-get-power-state-120.rst
@@ -0,0 +1,37 @@
+.. _OPAL_PCI_GET_POWER_STATE:
+
+OPAL_PCI_GET_POWER_STATE
+========================
+
+.. code-block:: c
+
+ #define OPAL_PCI_GET_POWER_STATE 120
+
+ int64_t opal_pci_get_power_state(uint64_t id, uint64_t data);
+
+Get PCI slot power state
+
+Parameter
+---------
+
+``uint64_t id``
+ PCI slot ID
+
+``uint64_t data``
+ memory buffer pointer for power state
+
+Calling
+-------
+
+Retrieve PCI slot's power state. The retrieved power state is stored
+in buffer pointed by @data.
+
+Return Codes
+------------
+
+:ref:`OPAL_SUCCESS`
+ PCI slot's power state is retrieved successfully
+:ref:`OPAL_PARAMETER`
+ The indicated PCI slot isn't found
+:ref:`OPAL_UNSUPPORTED`
+ Power state retrieval not supported on the PCI slot