[Skiboot] [PATCH] doc: add entry for OPAL_CHECK_ASYNC_COMPLETION
Breno Leitao
leitao at debian.org
Tue May 22 01:27:17 AEST 2018
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 at debian.org>
---
doc/opal-api/opal-check-async-completion-86.rst | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
create mode 100644 doc/opal-api/opal-check-async-completion-86.rst
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..0ac760f
--- /dev/null
+++ b/doc/opal-api/opal-check-async-completion-86.rst
@@ -0,0 +1,23 @@
+OPAL_CHECK_ASYNC_COMPLETION
+===========================
+
+OPAL_CHECK_ASYNC_COMPLETION checks if an async OPAL pending message was completed. (see :ref:`opal-messages`).
+
+Parameters: ::
+
+ buffer to copy message into
+ sizeof buffer to copy message into
+ token of the message
+
+
+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.
--
1.8.3.1
More information about the Skiboot
mailing list