summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-pci-get-presence-state-119.rst
blob: 23ea831910e39df0585103caf44764e06eeec8aa (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
OPAL_PCI_GET_PRESENCE_STATE
===========================

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
------------
OPAL_SUCCESS
  PCI slot's presence state is retrieved successfully

OPAL_PARAMETER
  The indicated PCI slot isn't found

OPAL_UNSUPPORTED
  Presence retrieval not supported on the PCI slot
OpenPOWER on IntegriCloud