aboutsummaryrefslogtreecommitdiffstats
path: root/roms/skiboot/doc/opal-api/opal-pci-get-hub-diag-data-50.rst
diff options
context:
space:
mode:
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-pci-get-hub-diag-data-50.rst')
-rw-r--r--roms/skiboot/doc/opal-api/opal-pci-get-hub-diag-data-50.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-pci-get-hub-diag-data-50.rst b/roms/skiboot/doc/opal-api/opal-pci-get-hub-diag-data-50.rst
new file mode 100644
index 000000000..7ee98063e
--- /dev/null
+++ b/roms/skiboot/doc/opal-api/opal-pci-get-hub-diag-data-50.rst
@@ -0,0 +1,34 @@
+.. _OPAL_PCI_GET_HUB_DIAG_DATA:
+
+OPAL_PCI_GET_HUB_DIAG_DATA
+==========================
+
+.. code-block:: c
+
+ #define OPAL_PCI_GET_HUB_DIAG_DATA 50
+
+ int64_t opal_pci_get_hub_diag_data(uint64_t hub_id, void *diag_buffer, uint64_t diag_buffer_len);
+
+Fetch diagnostic data for an IO hub. This was only implemented for hardware
+specific to POWER7 systems, something that was only ever available
+internally to IBM for development purposes.
+
+It is currently not used.
+
+If :ref:`OPAL_PCI_NEXT_ERROR` error type is `OPAL_EEH_IOC_ERROR` and severity
+is `OPAL_EEH_SEV_INF`, then the OS should call :ref:`OPAL_PCI_GET_HUB_DIAG_DATA`
+to retreive diagnostic data to log appropriately.
+
+Returns
+-------
+:ref:`OPAL_SUCCESS`
+ Diagnostic data copied successfully
+:ref:`OPAL_PARAMETER`
+ Invalid address, invalid hub ID, or insufficient space in buffer for
+ diagnostic data.
+:ref:`OPAL_UNSUPPORTED`
+ hub doesn't support retreiving diagnostic data.
+:ref:`OPAL_CLOSED`
+ No pending error.
+:ref:`OPAL_INTERNAL_ERROR`
+ Something went wrong.