summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-pci-get-phb-diag-data2-64.rst
blob: 58f65dbec55f86645bdccbe59fd54398046d4983 (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
38
OPAL_PCI_GET_PHB_DIAG_DATA2
===========================

Get PCI diagnostic data from a given PHB

Parameters
----------
``uint64_t phb_id``
  the ID of the PHB you want to retrieve data from

``void *diag_buffer``
  an allocated buffer to store diag data in

``uint64_t diag_buffer_len``
  size in bytes of the diag buffer

Calling
-------

Retrieve the PHB's diagnostic data.  The diagnostic data is stored in the
buffer pointed by @diag_buffer.  Different PHB versions will store different
diagnostics, defined in include/opal-api.h as ``struct OpalIo<PHBVer>ErrorData``.

``OPAL_PCI_GET_PHB_DIAG_DATA`` is deprecated and ``OPAL_PCI_GET_PHB_DIAG_DATA2`` should be used instead.

Return Codes
------------
OPAL_SUCCESS
  Diagnostic data has been retrieved and stored successfully

OPAL_PARAMETER
  The given buffer is too small to store the diagnostic data

OPAL_HARDWARE
  The PHB is in a broken state and its data cannot be retreived

OPAL_UNSUPPORTED
  Diagnostic data is not implemented for this PHB type
OpenPOWER on IntegriCloud