[Skiboot] [patch v4] doc/opal-api: Documentation for OPAL_GET_XIVE_SOURCE

[Nageswara R Sastry]

Documentation for OPAL_GET_XIVE_SOURCE 38

Changes from V1 to V2
moved xive_number to xive_num

Changes from V2 to V3
handled compilation warning

Changes from V3 to V4
removed function and define statements

Signed-off-by: Nageswara R Sastry <rnsastry at linux.vnet.ibm.com>
---
 doc/opal-api/opal-get-xive-source-38.rst | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 doc/opal-api/opal-get-xive-source-38.rst

diff --git a/doc/opal-api/opal-get-xive-source-38.rst b/doc/opal-api/opal-get-xive-source-38.rst
new file mode 100644
index 0000000..2989c80
--- /dev/null
+++ b/doc/opal-api/opal-get-xive-source-38.rst
@@ -0,0 +1,32 @@
+OPAL_GET_XIVE_SOURCE
+====================
+::
+
+  This function validates the given ``xive_num`` and sets the 
+  ``interrupt_source_number``. Then returns the proper return code.
+
+Parameters
+----------
+
+``phb_id``
+  The ``phb_id`` parameter is the value from the PHB node ``ibm,opal-phbid``
+  property.
+
+``xive_num``
+  The ``xive_num`` is the index of an XIVE that corresponds to a particular
+  interrupt.
+
+``interrupt_source_number``
+  The ``interrupt_source_number`` is a value formed by the combination of the
+  device tree MSI property base BUID and ``xive_num``
+
+Return Codes
+------------
+``OPAL_PARAMETER``
+  The indicated ``phb_id`` not found
+
+``OPAL_UNSUPPORTED``
+  Presence retrieval not supported on the ``phb_id``
+
+``OPAL_SUCCESS``
+  Indicates Success!
-- 
2.7.4 (Apple Git-66)