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

[Mukesh Ojha]

On Thursday 11 August 2016 10:44 AM, Nageswara R Sastry wrote:
> Documentation for OPAL_GET_XIVE_SOURCE 38
>
> 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 number and sets the
s/XIVE number/``xive_num``/g
> +  ``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_number``
s/``xive_number``/``xive_num``/g
> +  The ``xive_number`` is the index of an XIVE that corresponds to a particular
> +  interrupt.
> +
> +``interrupt_source_number``
> +  The ``interrupt_source_number`` is value formed by the combination of the
s/is/is a/

Cheers,
Mukesh
> +  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!