diff mbox series

[107/110] doc: skeleton OPAL_PCI_EEH_FREEZE_SET docs

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

Checks

Context Check Description
snowpatch_ozlabs/apply_patch success Successfully applied on branch master (76f7316bc8fc8a18fdbfcbc0e1fe1bb992d2a7d7)
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot fail Test snowpatch/job/snowpatch-skiboot on branch master
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot-dco success Signed-off-by present

Commit Message

Stewart Smith May 31, 2019, 6:13 a.m. UTC 
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-pci-eeh-freeze-set-97.rst | 29 +++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 doc/opal-api/opal-pci-eeh-freeze-set-97.rst
diff mbox series

Patch

diff --git a/doc/opal-api/opal-pci-eeh-freeze-set-97.rst b/doc/opal-api/opal-pci-eeh-freeze-set-97.rst
new file mode 100644
index 000000000000..b601ef689aff
--- /dev/null
+++ b/doc/opal-api/opal-pci-eeh-freeze-set-97.rst
@@ -0,0 +1,29 @@ 
+.. _OPAL_PCI_EEH_FREEZE_SET:
+
+OPAL_PCI_EEH_FREEZE_SET
+=======================
+
+.. code-block:: c
+
+   #define OPAL_PCI_EEH_FREEZE_SET			97
+
+   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_set(uint64_t phb_id, uint64_t pe_number, uint64_t eeh_action_token);
+
+Returns
+-------
+:ref:`OPAL_PARAMETER`
+     Invalid parameter.
+:ref:`OPAL_UNSUPPORTED`
+     Unsupported operation
+:ref:`OPAL_HARDWARE`
+     Hardware in a bad state.