summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-get-xive-source-38.rst
blob: 2989c803efab9a04a41b656d069a9741f1cca5f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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!
OpenPOWER on IntegriCloud