Skip to content

Commit

Permalink
doc: Add skeleton OPAL_PCI_EEH_FREEZE_CLEAR docs
Browse files Browse the repository at this point in the history
Fixes: #101
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
  • Loading branch information
stewartsmith committed Jun 3, 2019
1 parent 9dd1df6 commit 484e815
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/opal-api/opal-pci-eeh-freeze-clear-26.rst
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 484e815

Please sign in to comment.