aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBreno Leitao <leitao@debian.org>2018-05-21 12:27:17 -0300
committerStewart Smith <stewart@linux.ibm.com>2018-05-29 18:22:01 +1000
commit67bdd1668e6a033eb5520105946ebb651f3adff2 (patch)
treeb652aada0bbbf58e4b414484932a1f4e358c3eb4 /doc
parentbbfd8738319f169070d816304f927cbf11fd685f (diff)
downloadskiboot-67bdd1668e6a033eb5520105946ebb651f3adff2.zip
skiboot-67bdd1668e6a033eb5520105946ebb651f3adff2.tar.gz
skiboot-67bdd1668e6a033eb5520105946ebb651f3adff2.tar.bz2
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/opal-api/opal-check-async-completion-86.rst30
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.