[Skiboot] [PATCH 019/110] doc: prettify OPAL_INT_* calls

Stewart Smith stewart at linux.ibm.com
Fri May 31 16:12:20 AEST 2019


Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 doc/opal-api/opal-int-eoi-124.rst      | 13 ++++++++-----
 doc/opal-api/opal-int-get-xirr-122.rst | 13 ++++++++-----
 doc/opal-api/opal-int-set-cppr-123.rst | 12 +++++++-----
 doc/opal-api/opal-int-set-mfrr-125.rst | 14 +++++++++-----
 doc/xive.rst                           |  1 +
 5 files changed, 33 insertions(+), 20 deletions(-)

diff --git a/doc/opal-api/opal-int-eoi-124.rst b/doc/opal-api/opal-int-eoi-124.rst
index ec5bdd264399..c7d991c884ba 100644
--- a/doc/opal-api/opal-int-eoi-124.rst
+++ b/doc/opal-api/opal-int-eoi-124.rst
@@ -1,10 +1,13 @@
+.. _OPAL_INT_EOI:
+
 OPAL_INT_EOI
 ============
-::
 
-   static int64_t opal_xive_eoi(uint32_t xirr)
+.. code-block:: c
+
+   #define OPAL_INT_EOI				124
 
-**Not yet implemented.**
+   static int64_t opal_int_eoi(uint32_t xirr);
 
 Modelled on the ``H_EOI`` PAPR call.
 
@@ -17,5 +20,5 @@ For P9 and above systems where host doesn't know about interrupt controller.
 An OS can instead make OPAL calls for XICS emulation.
 
 For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
-exist in the device tree. If OPAL does not create such a device, the host
-OS MUST NOT use this call.
+exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
+such a device, the host OS MUST NOT use this call.
diff --git a/doc/opal-api/opal-int-get-xirr-122.rst b/doc/opal-api/opal-int-get-xirr-122.rst
index b79be6f7a420..85daa15f441d 100644
--- a/doc/opal-api/opal-int-get-xirr-122.rst
+++ b/doc/opal-api/opal-int-get-xirr-122.rst
@@ -1,10 +1,13 @@
+.. _OPAL_INT_GET_XIRR:
+
 OPAL_INT_GET_XIRR
 =================
-::
 
-   int64_t opal_xive_get_xirr(uint32_t *out_xirr, bool just_poll)
+.. code-block:: c
+
+   #define OPAL_INT_GET_XIRR			122
 
-**Not yet implemented.**
+   int64_t opal_int_get_xirr(uint32_t *out_xirr, bool just_poll);
 
 Modelled on the PAPR call.
 
@@ -12,5 +15,5 @@ For P9 and above systems where host doesn't know about interrupt controller.
 An OS can instead make OPAL calls for XICS emulation.
 
 For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
-exist in the device tree. If OPAL does not create such a device, the host
-OS MUST NOT use this call.
+exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
+such a device, the host OS MUST NOT use this call.
diff --git a/doc/opal-api/opal-int-set-cppr-123.rst b/doc/opal-api/opal-int-set-cppr-123.rst
index ad1e5a4b69f1..918022a82602 100644
--- a/doc/opal-api/opal-int-set-cppr-123.rst
+++ b/doc/opal-api/opal-int-set-cppr-123.rst
@@ -1,11 +1,13 @@
+.. _OPAL_INT_SET_CPPR:
+
 OPAL_INT_SET_CPPR
 =================
-::
 
-   static int64_t opal_xive_set_cppr(uint8_t cppr)
+.. code-block:: c
 
+   #define	OPAL_INT_SET_CPPR			123
 
-**Not yet implemented.**
+   static int64_t opal_int_set_cppr(uint8_t cppr);
 
 Modelled on the ``H_CPPR`` PAPR call.
 
@@ -13,5 +15,5 @@ For P9 and above systems where host doesn't know about interrupt controller.
 An OS can instead make OPAL calls for XICS emulation.
 
 For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
-exist in the device tree. If OPAL does not create such a device, the host
-OS MUST NOT use this call.
+exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
+such a device, the host OS MUST NOT use this call.
diff --git a/doc/opal-api/opal-int-set-mfrr-125.rst b/doc/opal-api/opal-int-set-mfrr-125.rst
index 46b090299024..8e0f1853024a 100644
--- a/doc/opal-api/opal-int-set-mfrr-125.rst
+++ b/doc/opal-api/opal-int-set-mfrr-125.rst
@@ -1,10 +1,14 @@
+.. _OPAL_INT_SET_MFRR:
+
 OPAL_INT_SET_MFRR
 =================
-::
 
-   static int64_t opal_xive_set_mfrr(uint32_t cpu, uint8_t mfrr)
+.. code-block:: c
+
+   #define OPAL_INT_SET_MFRR			125
+
+   static int64_t opal_int_set_mfrr(uint32_t cpu, uint8_t mfrr);
 
-**Not yet implemented.**
 
 Modelled on the ``H_IPI`` PAPR call.
 
@@ -12,5 +16,5 @@ For P9 and above systems where host doesn't know about interrupt controller.
 An OS can instead make OPAL calls for XICS emulation.
 
 For an OS to use this OPAL call, an ``ibm,opal-intc`` compatible device must
-exist in the device tree. If OPAL does not create such a device, the host
-OS MUST NOT use this call.
+exist in the device tree (see :ref:`xive-device-tree`). If OPAL does not create
+such a device, the host OS MUST NOT use this call.
diff --git a/doc/xive.rst b/doc/xive.rst
index 42a60907f393..fe7c737df63c 100644
--- a/doc/xive.rst
+++ b/doc/xive.rst
@@ -1,6 +1,7 @@
 P9 XIVE Exploitation
 ====================
 
+.. _xive-device-tree:
 
 I - Device-tree updates
 -----------------------
-- 
2.21.0



More information about the Skiboot mailing list