diff options
author | Angelos Mouzakitis <a.mouzakitis@virtualopensystems.com> | 2023-10-10 14:33:42 +0000 |
---|---|---|
committer | Angelos Mouzakitis <a.mouzakitis@virtualopensystems.com> | 2023-10-10 14:33:42 +0000 |
commit | af1a266670d040d2f4083ff309d732d648afba2a (patch) | |
tree | 2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/skiboot/doc/opal-api/opal-pci-get-presence-state-119.rst | |
parent | e02cda008591317b1625707ff8e115a4841aa889 (diff) |
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-pci-get-presence-state-119.rst')
-rw-r--r-- | roms/skiboot/doc/opal-api/opal-pci-get-presence-state-119.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-pci-get-presence-state-119.rst b/roms/skiboot/doc/opal-api/opal-pci-get-presence-state-119.rst new file mode 100644 index 000000000..b31df47a8 --- /dev/null +++ b/roms/skiboot/doc/opal-api/opal-pci-get-presence-state-119.rst @@ -0,0 +1,39 @@ +.. _OPAL_PCI_GET_PRESENCE_STATE: + +OPAL_PCI_GET_PRESENCE_STATE +=========================== + +.. code-block: c + + #define OPAL_PCI_GET_PRESENCE_STATE 119 + + int64_t opal_pci_get_presence_state(uint64_t id, uint64_t data); + +Get PCI slot presence state + +Parameters +---------- + +``uint64_t id`` + PCI slot ID + +``uint64_t data`` + memory buffer pointer for presence state + +Calling +------- + +Retrieve PCI slot's presence state. The detected presence means there are +adapters inserted to the PCI slot. Otherwise, the PCI slot is regarded as +an empty one. The typical use is to ensure there are adapters existing +before probing the PCI slot in PCI hot add path. The retrieved presence +state is stored in buffer pointed by @data. + +Return Codes +------------ +:ref:`OPAL_SUCCESS` + PCI slot's presence state is retrieved successfully +:ref:`OPAL_PARAMETER` + The indicated PCI slot isn't found +:ref:`OPAL_UNSUPPORTED` + Presence retrieval not supported on the PCI slot |