[Skiboot] [patch v2]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

Signed-off-by: Nageswara R Sastry <rnsastry at linux.vnet.ibm.com>
---
 doc/opal-api/opal-get-xive-source-38.rst | 38 ++++++++++++++++++++++++++++++++
 1 file changed, 38 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..e1feae2
--- /dev/null
+++ b/doc/opal-api/opal-get-xive-source-38.rst
@@ -0,0 +1,38 @@
+OPAL_GET_XIVE_SOURCE
+====================
+::
+
+   #define OPAL_GET_XIVE_SOURCE				38
+
+::
+   int64_t opal_get_xive_source(uint64_t phb_id, uint32_t xive_num,
+                                int32_t *interrupt_source_number)
+
+  This function validates the given ``xive_num`` and sets the 
+  ``interrupt_source_number``. And returns the proper return code.
+
+``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 number
+
+Return Codes
+------------
+``OPAL_PARAMETER``
+  The indicated ``phb_id`` not found
+
+``OPAL_UNSUPPORTED``
+  Presence retrieval not supported on the ``phb_id``
+
+  Based on the return value of ``get_xive_source`` the return code contains
+  either ``OPAL_SUCCESS`` or ``OPAL_PARAMETER``
+
+``OPAL_SUCCESS``
+  Indicates Success!
-- 
2.7.4 (Apple Git-66)