[Skiboot] [PATCH 100/110] doc: prettify OPAL_GET_MSG

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

Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
 doc/opal-api/opal-get-msg-85.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/doc/opal-api/opal-get-msg-85.rst b/doc/opal-api/opal-get-msg-85.rst
index 2cc9307e19d4..a7afc686ca8e 100644
--- a/doc/opal-api/opal-get-msg-85.rst
+++ b/doc/opal-api/opal-get-msg-85.rst
@@ -1,12 +1,15 @@
-OPAL_GET_MSG will get the next pending OPAL Message (see :ref:`opal-messages`).
+.. code-block:: c
+   #define OPAL_GET_MSG				85
-Parameters: ::
+   int64_t opal_get_msg(uint64_t *buffer, uint64_t size);
-	buffer to copy message into
-	sizeof buffer to copy message into
+:ref:`OPAL_GET_MSG` will get the next pending OPAL Message (see :ref:`opal-messages`).
 The maximum size of an opal message is specified in the device tree passed
 to the host OS: ::
@@ -27,14 +30,12 @@ bytes or opal-msg-size. It MUST NOT supply a buffer of < 72 bytes.
 Return values
   no available message.
   buffer is NULL or size is < 72 bytes.
   If buffer size < 72 bytes, the message will NOT be discarded by OPAL.
   If pending opal message is greater than supplied buffer.
   In this case the message is *DISCARDED* by OPAL.
   This is to keep compatibility with host Operating Systems
@@ -42,6 +43,5 @@ OPAL_PARTIAL
   **NOT CURRENTLY IMPLEMENTED**. Specified so that host OS can
   prepare for the possible future with either a sensible
   error message or by gracefully ignoring such OPAL messages.
   message successfully copied to buffer.

More information about the Skiboot mailing list