diff options
author | Angelos Mouzakitis <a.mouzakitis@virtualopensystems.com> | 2023-10-10 14:33:42 +0000 |
---|---|---|
committer | Angelos Mouzakitis <a.mouzakitis@virtualopensystems.com> | 2023-10-10 14:33:42 +0000 |
commit | af1a266670d040d2f4083ff309d732d648afba2a (patch) | |
tree | 2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/skiboot/doc/opal-api/opal-check-async-completion-86.rst | |
parent | e02cda008591317b1625707ff8e115a4841aa889 (diff) |
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-check-async-completion-86.rst')
-rw-r--r-- | roms/skiboot/doc/opal-api/opal-check-async-completion-86.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-check-async-completion-86.rst b/roms/skiboot/doc/opal-api/opal-check-async-completion-86.rst new file mode 100644 index 000000000..1744c6928 --- /dev/null +++ b/roms/skiboot/doc/opal-api/opal-check-async-completion-86.rst @@ -0,0 +1,35 @@ +.. _OPAL_CHECK_ASYNC_COMPLETION: + +OPAL_CHECK_ASYNC_COMPLETION +=========================== + +: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: + +buffer + buffer to copy message into +size + sizeof buffer to copy message into +token + async message token + +Currently unused by Linux, but it is used by FreeBSD. + + +Return values +------------- + +:ref:`OPAL_PARAMETER` + buffer parameter is an invalid pointer (NULL or > top of RAM). +:ref:`OPAL_SUCCESS` + message successfully copied to buffer. +:ref:`OPAL_BUSY` + message is still pending and should be re-checked later. |