[Skiboot] [PATCH 023/110] doc: prettify OPAL_PRD_MSG
Stewart Smith
stewart at linux.ibm.com
Fri May 31 16:12:24 AEST 2019
Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
doc/opal-api/opal-messages.rst | 4 +++-
doc/opal-api/opal-prd-msg-113.rst | 10 +++++++++-
2 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/doc/opal-api/opal-messages.rst b/doc/opal-api/opal-messages.rst
index b023622d2d26..e7de77d96850 100644
--- a/doc/opal-api/opal-messages.rst
+++ b/doc/opal-api/opal-messages.rst
@@ -134,6 +134,8 @@ requested and a forced shutdown will happen in future. Host OS can use
OPAL_GET_DPO_STATUS API to query OPAL the number of seconds remaining
before a forced poweroff will occur.
+.. _OPAL_MSG_PRD:
+
OPAL_MSG_PRD
------------
@@ -177,7 +179,7 @@ struct opal_prd_msg: ::
};
Responses from the kernel use the same message format, but are passed
-through the opal_prd_msg call.
+through the :ref:`OPAL_PRD_MSG` call.
OPAL_MSG_OCC
------------
diff --git a/doc/opal-api/opal-prd-msg-113.rst b/doc/opal-api/opal-prd-msg-113.rst
index 0cda30aa5285..91d30aca7552 100644
--- a/doc/opal-api/opal-prd-msg-113.rst
+++ b/doc/opal-api/opal-prd-msg-113.rst
@@ -1,8 +1,16 @@
+.. _OPAL_PRD_MSG:
+
OPAL_PRD_MSG
============
+.. code-block:: c
+
+ #define OPAL_PRD_MSG 113
+
+ int64_t opal_prd_msg(struct opal_prd_msg *msg);
+
The OPAL_PRD_MSG call is used to pass a struct opal_prd_msg from the HBRT
-code into opal, and is paired with the OPAL_PRD_MSG message type.
+code into opal, and is paired with the :ref:`OPAL_PRD_MSG` message type.
Parameters
----------
--
2.21.0
More information about the Skiboot
mailing list