aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.ibm.com>2019-05-31 16:13:09 +1000
committerStewart Smith <stewart@linux.ibm.com>2019-06-03 10:20:00 +1000
commit484e81580580c8850f383144aad9845b9c4bc495 (patch)
tree078369c912972e52159ce0026adf02ad7daac05b
parent9dd1df6b37d0c22a62dae0d1561ecd302f39af09 (diff)
downloadskiboot-484e81580580c8850f383144aad9845b9c4bc495.zip
skiboot-484e81580580c8850f383144aad9845b9c4bc495.tar.gz
skiboot-484e81580580c8850f383144aad9845b9c4bc495.tar.bz2
doc: Add skeleton OPAL_PCI_EEH_FREEZE_CLEAR docs
Fixes: https://github.com/open-power/skiboot/issues/101 Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
-rw-r--r--doc/opal-api/opal-pci-eeh-freeze-clear-26.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/opal-api/opal-pci-eeh-freeze-clear-26.rst b/doc/opal-api/opal-pci-eeh-freeze-clear-26.rst
new file mode 100644
index 0000000..af796f0
--- /dev/null
+++ b/doc/opal-api/opal-pci-eeh-freeze-clear-26.rst
@@ -0,0 +1,33 @@
+.. _OPAL_PCI_EEH_FREEZE_CLEAR:
+
+OPAL_PCI_EEH_FREEZE_CLEAR
+=========================
+
+.. code-block:: c
+
+ #define OPAL_PCI_EEH_FREEZE_CLEAR 26
+
+ enum OpalEehFreezeActionToken {
+ OPAL_EEH_ACTION_CLEAR_FREEZE_MMIO = 1,
+ OPAL_EEH_ACTION_CLEAR_FREEZE_DMA = 2,
+ OPAL_EEH_ACTION_CLEAR_FREEZE_ALL = 3,
+
+ OPAL_EEH_ACTION_SET_FREEZE_MMIO = 1,
+ OPAL_EEH_ACTION_SET_FREEZE_DMA = 2,
+ OPAL_EEH_ACTION_SET_FREEZE_ALL = 3
+ };
+
+ int64_t opal_pci_eeh_freeze_clear(uint64_t phb_id, uint64_t pe_number, uint64_t eeh_action_token);
+
+
+Returns
+-------
+:ref:`OPAL_SUCCESS`
+ Success!
+:ref:`OPAL_PARAMETER`
+ Invalid PHB
+:ref:`OPAL_UNSUPPORTED`
+ PHB doesn't support this operation.
+:ref:`OPAL_HARDWARE`
+ Hardware issue prevents completing operation. OPAL may have detected it
+ being broken.