File: opal-check-async-completion-86.rst

package info (click to toggle)
skiboot 7.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 35,624 kB
  • sloc: ansic: 221,198; sh: 11,580; cpp: 5,767; python: 3,421; makefile: 1,773; asm: 1,503; perl: 1,479; tcl: 1,188; pascal: 107
file content (35 lines) | stat: -rw-r--r-- 787 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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.