diff mbox

doc/opal-api: Document OPAL_PCI_GET_PHB_DIAG_DATA2

Message ID 20160720044004.27103-1-ruscur@russell.cc
State Accepted
Headers show

Commit Message

Russell Currey July 20, 2016, 4:40 a.m. UTC 
Signed-off-by: Russell Currey <ruscur@russell.cc>
---
 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

Comments

Stewart Smith July 20, 2016, 5:41 a.m. UTC | #1 
Russell Currey <ruscur@russell.cc> writes:
> Signed-off-by: Russell Currey <ruscur@russell.cc>
> ---
>  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


Merged to master as of 8126e4c, because obvious documentation patches++
diff mbox

Patch

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 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