doc: add entry for OPAL_CHECK_ASYNC_COMPLETION

Currently there is no documentation for function #86, aka
OPAL_CHECK_ASYNC_COMPLETION, which is used on both Linux and FreeBSD,
but not documented yet.

This patch simply adds an initial entry for this function on
OPAL documentation.

Signed-off-by: Breno Leitao <leitao@debian.org>
[stewart: clean up some formatting/details]
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>

1 files changed, 30 insertions, 0 deletions

diff --git a/doc/opal-api/opal-check-async-completion-86.rst b/doc/opal-api/opal-check-async-completion-86.rst
new file mode 100644
index 0000000..9c1505f
--- /dev/null
+++ b/doc/opal-api/opal-check-async-completion-86.rst
@@ -0,0 +1,30 @@
+OPAL_CHECK_ASYNC_COMPLETION
+===========================
+
+OPAL_CHECK_ASYNC_COMPLETION checks if an async OPAL pending message was completed. (see :ref:`opal-messages`).
+
+.. code-block:: c
+
+   int64_t opal_check_completion(uint64_t *buffer, uint64_t size, uint64_t token);
+
+Parameters:
+
+buffer
+  buffer to copy message into
+size
+  sizeof buffer to copy message into
+token
+  async message token
+
+
+Return values
+-------------
+
+OPAL_PARAMETER
+  buffer parameter is an invalid pointer (NULL or > top of RAM).
+
+OPAL_SUCCESS
+  message successfully copied to buffer.
+
+OPAL_BUSY
+  message is still pending and should be re-checked later.