[Skiboot] [PATCH 044/110] doc: Add links to XIVE calls

[Stewart Smith]

Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 doc/xive.rst | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/doc/xive.rst b/doc/xive.rst
index fe7c737df63c..3a8f2203fdfc 100644
--- a/doc/xive.rst
+++ b/doc/xive.rst
@@ -271,6 +271,8 @@ IV - OPAL APIs
              These aren't fully specified (yet) but common sense shall
              apply.
 
+.. _OPAL_XIVE_RESET:
+
 OPAL_XIVE_RESET
 ^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -309,6 +311,8 @@ first.
 	  inside OPAL and as such is not suitable to be performed during normal
 	  runtime.
 
+.. _OPAL_XIVE_GET_IRQ_INFO:
+
 OPAL_XIVE_GET_IRQ_INFO
 ^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -385,6 +389,8 @@ OPAL_BUSY.
       the OS to use that to pick up a default target processor on
       the same chip.
 
+.. _OPAL_XIVE_EOI:
+
 OPAL_XIVE_EOI
 ^^^^^^^^^^^^^
 
@@ -403,6 +409,8 @@ is preferred.
 	  whether OPAL is in XICS emulation mode  or native XIVE exploitation
 	  mode.
 
+.. _OPAL_XIVE_GET_IRQ_CONFIG:
+
 OPAL_XIVE_GET_IRQ_CONFIG
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -427,6 +435,8 @@ interrupt number (the number that will be presented in the queue).
 * out_lirq: Will contain the logical interrupt assigned to the
   interrupt. By default this will be the same as girq.
 
+.. _OPAL_XIVE_SET_IRQ_CONFIG:
+
 OPAL_XIVE_SET_IRQ_CONFIG
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -479,6 +489,8 @@ in the target queue).
   a new handler for an interrupt that had none. In these case, losing
   interrupts happening while no handler was attached is considered fine.
 
+.. _OPAL_XIVE_GET_QUEUE_INFO:
+
 OPAL_XIVE_GET_QUEUE_INFO
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -543,6 +555,8 @@ with a virtual processor and a priority.
     When this is set, the EQ will escalate to the escalation interrupt
     when failing to notify.
 
+.. _OPAL_XIVE_SET_QUEUE_INFO:
+
 OPAL_XIVE_SET_QUEUE_INFO
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -578,6 +592,8 @@ and priority and adjust the behaviour of the queue via flags.
 	    all other flags and arguments are ignored and the queue
 	    configuration is wiped.
 
+.. _OPAL_XIVE_DONATE_PAGE:
+
 OPAL_XIVE_DONATE_PAGE
 ^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -601,6 +617,8 @@ for each chip in the system and hand it to OPAL before trying again.
 	  one page per chip. OPAL will keep returning the above error until
 	  enough pages have been provided.
 
+.. _OPAL_XIVE_ALLOCATE_VP_BLOCK:
+
 OPAL_XIVE_ALLOCATE_VP_BLOCK
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -625,6 +643,8 @@ below with the OPAL_XIVE_VP_ENABLED flag set before use.
 For all priorities, the corresponding queues must also be individually
 provisioned and enabled with opal_xive_set_queue_info.
 
+.. _OPAL_XIVE_FREE_VP_BLOCK:
+
 OPAL_XIVE_FREE_VP_BLOCK
 ^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -642,6 +662,8 @@ All the queues must also have been disabled.
 
 Failure to do any of the above will result in an OPAL_XIVE_FREE_ACTIVE error.
 
+.. _OPAL_XIVE_GET_VP_INFO:
+
 OPAL_XIVE_GET_VP_INFO
 ^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -673,6 +695,8 @@ This call returns information about a VP:
 
 * chip_id: The chip that VCPU was allocated on
 
+.. _OPAL_XIVE_SET_VP_INFO:
+
 OPAL_XIVE_SET_VP_INFO
 ^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -715,6 +739,7 @@ This call configures a VP:
 
     .. note:: When disabling a VP, all other VP settings are lost.
 
+.. _OPAL_XIVE_ALLOCATE_IRQ:
 
 OPAL_XIVE_ALLOCATE_IRQ
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -725,6 +750,8 @@ OPAL_XIVE_ALLOCATE_IRQ
 This call allocates a software IRQ on a given chip. It returns the
 interrupt number or a negative error code.
 
+.. _OPAL_XIVE_FREE_IRQ:
+
 OPAL_XIVE_FREE_IRQ
 ^^^^^^^^^^^^^^^^^^
 .. code-block:: c
@@ -735,6 +762,8 @@ This call frees a software IRQ that was allocated by
 opal_xive_allocate_irq. Passing any other interrupt number
 will result in an OPAL_PARAMETER error.
 
+.. _OPAL_XIVE_SYNC:
+
 OPAL_XIVE_SYNC
 ^^^^^^^^^^^^^^
 .. code-block:: c
@@ -761,6 +790,7 @@ processor.
 
 * id: Depends on the synchronization type, see above
 
+.. _OPAL_XIVE_DUMP:
 
 OPAL_XIVE_DUMP
 ^^^^^^^^^^^^^^
@@ -791,6 +821,7 @@ state information about the XIVE.
   - XIVE_DUMP_EMU:     Dump the state of the XICS emulation for a thread
 		       "id" is the PIR value of the thread
 
+.. _OPAL_XIVE_GET_QUEUE_STATE:
 
 OPAL_XIVE_GET_QUEUE_STATE
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -809,6 +840,7 @@ an enabled queue.
 
 * out_qindex: index of the queue
 
+.. _OPAL_XIVE_SET_QUEUE_STATE:
 
 OPAL_XIVE_SET_QUEUE_STATE
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -829,6 +861,8 @@ an enabled queue.
 * qindex: index of the queue
 
 
+.. _OPAL_XIVE_GET_VP_STATE:
+
 OPAL_XIVE_GET_VP_STATE
 ^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: c
-- 
2.21.0