aboutsummaryrefslogtreecommitdiff
path: root/doc/opal-api/opal-pci-get-power-state-120.rst
blob: fa0375d83e855c322cd1d6eaf7999589bcd06cf2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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