diff mbox series

[097/110] doc: Add OPAL_PCI_MSI_EOI skeleton docs

Message ID 20190531061351.22973-98-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 
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-pci-msi-eoi-63.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 doc/opal-api/opal-pci-msi-eoi-63.rst
diff mbox series

Patch

diff --git a/doc/opal-api/opal-pci-msi-eoi-63.rst b/doc/opal-api/opal-pci-msi-eoi-63.rst
new file mode 100644
index 000000000000..24bdb789d54d
--- /dev/null
+++ b/doc/opal-api/opal-pci-msi-eoi-63.rst
@@ -0,0 +1,24 @@ 
+.. _OPAL_PCI_MSI_EOI:
+
+OPAL_PCI_MSI_EOI
+================
+
+.. code-block:: c
+
+   #define OPAL_PCI_MSI_EOI			63
+
+   int64_t opal_pci_msi_eoi(uint64_t phb_id, uint32_t hwirq);
+
+Only required on PHB3 (POWER8) based systems.
+
+Returns
+-------
+
+:ref:`OPAL_SUCCESS`
+     Success!
+:ref:`OPAL_PARAMETER`
+     Invalid PHB id or hwirq.
+:ref:`OPAL_HARDWARE`
+     Hardware or configuration issue.
+:ref:`OPAL_UNSUPPORTED`
+     Unsupported on this PHB.