diff options
author | Stewart Smith <stewart@linux.ibm.com> | 2019-05-31 16:13:41 +1000 |
---|---|---|
committer | Stewart Smith <stewart@linux.ibm.com> | 2019-06-03 10:20:00 +1000 |
commit | 971a2993ac8ae64958a684ee048a937aeb884cfe (patch) | |
tree | 7f1cdd51a6b453437da1b8ce3632cd40bfe8c7d6 | |
parent | a6bbe935f0a1e50f442dc313ed238e0f0b7302cb (diff) | |
download | skiboot-971a2993ac8ae64958a684ee048a937aeb884cfe.zip skiboot-971a2993ac8ae64958a684ee048a937aeb884cfe.tar.gz skiboot-971a2993ac8ae64958a684ee048a937aeb884cfe.tar.bz2 |
doc: prettify OPAL_GET_MSG
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
-rw-r--r-- | doc/opal-api/opal-get-msg-85.rst | 22 |
1 files 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 2cc9307..a7afc68 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: + OPAL_GET_MSG ============ -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 ------------- -OPAL_RESOURCE +:ref:`OPAL_RESOURCE` no available message. - -OPAL_PARAMETER +:ref:`OPAL_PARAMETER` buffer is NULL or size is < 72 bytes. If buffer size < 72 bytes, the message will NOT be discarded by OPAL. - -OPAL_PARTIAL +:ref:`OPAL_PARTIAL` 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. - -OPAL_SUCCESS +:ref:`OPAL_SUCCESS` message successfully copied to buffer. |