doc: prettify OPAL_CHECK_ASYNC_COMPLETION
+.. _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.
