From 8126e4c69407c1f9957ab2313015f46a30e1f1ec Mon Sep 17 00:00:00 2001 From: Russell Currey Date: Wed, 20 Jul 2016 14:40:04 +1000 Subject: doc/opal-api: Document OPAL_PCI_GET_PHB_DIAG_DATA2 Signed-off-by: Russell Currey Signed-off-by: Stewart Smith --- doc/opal-api/opal-pci-get-phb-diag-data2-64.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/opal-api/opal-pci-get-phb-diag-data2-64.txt (limited to 'doc/opal-api') diff --git a/doc/opal-api/opal-pci-get-phb-diag-data2-64.txt b/doc/opal-api/opal-pci-get-phb-diag-data2-64.txt new file mode 100644 index 0000000..837cbb9 --- /dev/null +++ b/doc/opal-api/opal-pci-get-phb-diag-data2-64.txt @@ -0,0 +1,24 @@ +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 OpalIoErrorData". + +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 -- cgit v1.1