diff options
| author | Stewart Smith <stewart@linux.ibm.com> | 2019-05-31 16:13:42 +1000 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.ibm.com> | 2019-06-03 10:20:00 +1000 |
| commit | d64431cca54bb8e376d0a5adba9cd156cfffc72b (patch) | |
| tree | 66ad241ddc7f1c8b5251117bf0b3a2d35454d38e /doc | |
| parent | 971a2993ac8ae64958a684ee048a937aeb884cfe (diff) | |
| download | skiboot-d64431cca54bb8e376d0a5adba9cd156cfffc72b.zip skiboot-d64431cca54bb8e376d0a5adba9cd156cfffc72b.tar.gz skiboot-d64431cca54bb8e376d0a5adba9cd156cfffc72b.tar.bz2 | |
doc: prettify OPAL_CHECK_ASYNC_COMPLETION
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/opal-api/opal-check-async-completion-86.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/opal-api/opal-check-async-completion-86.rst b/doc/opal-api/opal-check-async-completion-86.rst index 9c1505f..1744c69 100644 --- a/doc/opal-api/opal-check-async-completion-86.rst +++ b/doc/opal-api/opal-check-async-completion-86.rst @@ -1,10 +1,15 @@ +.. _OPAL_CHECK_ASYNC_COMPLETION: + OPAL_CHECK_ASYNC_COMPLETION =========================== -OPAL_CHECK_ASYNC_COMPLETION checks if an async OPAL pending message was completed. (see :ref:`opal-messages`). +:ref:`OPAL_CHECK_ASYNC_COMPLETION` checks if an async OPAL pending message was +completed. (see :ref:`opal-messages`). .. code-block:: c + #define OPAL_CHECK_ASYNC_COMPLETION 86 + int64_t opal_check_completion(uint64_t *buffer, uint64_t size, uint64_t token); Parameters: @@ -16,15 +21,15 @@ size token async message token +Currently unused by Linux, but it is used by FreeBSD. + Return values ------------- -OPAL_PARAMETER +:ref:`OPAL_PARAMETER` buffer parameter is an invalid pointer (NULL or > top of RAM). - -OPAL_SUCCESS +:ref:`OPAL_SUCCESS` message successfully copied to buffer. - -OPAL_BUSY +:ref:`OPAL_BUSY` message is still pending and should be re-checked later. |