[Skiboot] [PATCH 081/110] doc: prettify OPAL_GET_MSI_[32|64]

Stewart Smith stewart at linux.ibm.com
Fri May 31 16:13:22 AEST 2019


Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 doc/opal-api/opal-get-msi-39-40.rst | 45 +++++++++++++++++++++++++++--
 1 file changed, 42 insertions(+), 3 deletions(-)

diff --git a/doc/opal-api/opal-get-msi-39-40.rst b/doc/opal-api/opal-get-msi-39-40.rst
index 14bd980b8495..86741ce22a49 100644
--- a/doc/opal-api/opal-get-msi-39-40.rst
+++ b/doc/opal-api/opal-get-msi-39-40.rst
@@ -1,10 +1,49 @@
+===================================
 OPAL_GET_MSI_32 and OPAL_GET_MSI_64
 ===================================
-::
+
+.. code-block:: c
+
+   #define OPAL_GET_MSI_32				39
+   #define OPAL_GET_MSI_64				40
+
+   int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number,
+                           uint32_t xive_num, uint8_t msi_range,
+                           uint32_t *msi_address, uint32_t *message_data);
+
+   int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
+                           uint32_t xive_num, uint8_t msi_range,
+                           uint64_t *msi_address, uint32_t *message_data);
+
+.. _OPAL_GET_MSI_32:
+
+OPAL_GET_MSI_32
+===============
+
+.. code-block:: c
 
    #define OPAL_GET_MSI_32				39
+
+   int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number,
+                           uint32_t xive_num, uint8_t msi_range,
+                           uint32_t *msi_address, uint32_t *message_data);
+
+See :ref:`OPAL_GET_MSI_64`.
+
+.. _OPAL_GET_MSI_64:
+
+OPAL_GET_MSI_64
+===============
+
+.. code-block:: c
+
    #define OPAL_GET_MSI_64				40
 
+   int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
+                           uint32_t xive_num, uint8_t msi_range,
+                           uint64_t *msi_address, uint32_t *message_data);
+
+
 **WARNING:** the following documentation is from old sources, and is possibly
 not representative of OPALv3 as implemented by skiboot. This should be
 used as a starting point for full documentation.
@@ -34,14 +73,14 @@ returns the MSI DMA message data value the PE uses to signal that interrupt.
   MSI DMA address must be unique for any given consecutive power of 2 set
   of 32 message data values,. which in turn select particular PHB XIVEs.
   This value must be a power of 2 value in the range of 0 to 32. OPAL
-  returns opal_parameter for values outside of this range.
+  returns :ref:`OPAL_PARAMETER` for values outside of this range.
 
 For MSI conventional, the MSI address and message data returned apply to a
 power of 2 sequential set of XIVRs starting from the xive_number for the
 power of 2 msi_range input argument. The message data returned represents the
 power of 2 aligned starting message data value of the first interrupt number
 in that sequential range. Valid msi_range input values are from 1 to 32.
-Non-power of 2 values result in a return code of opal_PARAMETER .
+Non-power of 2 values result in a return code of :ref:`OPAL_PARAMETER`.
 
 An msi_range value of 0 or 1 signifies that OPAL should return the message
 data and message address for exactly one MSI specified by the input XIVE
-- 
2.21.0



More information about the Skiboot mailing list