diff mbox series

[068/110] doc: Add skeleton OPAL_PCI_EEH_FREEZE_CLEAR docs

Message ID 20190531061351.22973-69-stewart@linux.ibm.com
State Accepted
Headers show
Series Big documentation cleanup/expansion | expand

Commit Message

Stewart Smith May 31, 2019, 6:13 a.m. UTC 
Fixes: https://github.com/open-power/skiboot/issues/101
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-pci-eeh-freeze-clear-26.rst | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 doc/opal-api/opal-pci-eeh-freeze-clear-26.rst
diff mbox series

Patch

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 000000000000..af796f0f376b
--- /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.