aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.ibm.com>2019-05-31 16:13:36 +1000
committerStewart Smith <stewart@linux.ibm.com>2019-06-03 10:20:00 +1000
commit40bd86dd1ca953501949b3df4fcb462e4474e5cc (patch)
tree7192840718943266aca03b03fde79379ccd5e925 /doc
parent66b4b96a271064c18590fe83b22d291699555dfa (diff)
downloadskiboot-40bd86dd1ca953501949b3df4fcb462e4474e5cc.zip
skiboot-40bd86dd1ca953501949b3df4fcb462e4474e5cc.tar.gz
skiboot-40bd86dd1ca953501949b3df4fcb462e4474e5cc.tar.bz2
doc: Add skeleton for OPAL_PCI_NEXT_ERROR
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/opal-api/opal-pci-next-error-60.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/opal-api/opal-pci-next-error-60.rst b/doc/opal-api/opal-pci-next-error-60.rst
new file mode 100644
index 0000000..1453835
--- /dev/null
+++ b/doc/opal-api/opal-pci-next-error-60.rst
@@ -0,0 +1,41 @@
+.. _OPAL_PCI_NEXT_ERROR:
+
+OPAL_PCI_NEXT_ERROR
+===================
+
+.. code-block:: c
+
+ #define OPAL_PCI_NEXT_ERROR 60
+
+ enum OpalPciStatusToken {
+ OPAL_EEH_NO_ERROR = 0,
+ OPAL_EEH_IOC_ERROR = 1,
+ OPAL_EEH_PHB_ERROR = 2,
+ OPAL_EEH_PE_ERROR = 3,
+ OPAL_EEH_PE_MMIO_ERROR = 4,
+ OPAL_EEH_PE_DMA_ERROR = 5
+ };
+
+ enum OpalPciErrorSeverity {
+ OPAL_EEH_SEV_NO_ERROR = 0,
+ OPAL_EEH_SEV_IOC_DEAD = 1,
+ OPAL_EEH_SEV_PHB_DEAD = 2,
+ OPAL_EEH_SEV_PHB_FENCED = 3,
+ OPAL_EEH_SEV_PE_ER = 4,
+ OPAL_EEH_SEV_INF = 5
+ };
+
+ int64_t opal_pci_next_error(uint64_t phb_id, uint64_t *first_frozen_pe,
+ uint16_t *pci_error_type, uint16_t *severity);
+
+Retreives details of a PCIe error.
+
+Returns
+-------
+
+:ref:`OPAL_SUCCESS`
+ Successfully filled `pci_error_type` and `severity` with error details.
+:ref:`OPAL_UNSUPPORTED`
+ Unsupported operation on this PHB.
+:ref:`OPAL_PARAMETER`
+ Invalid phb_id, or address for other arguments.