File: opal-check-token-80.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 (31 lines) | stat: -rw-r--r-- 891 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
.. _OPAL_CHECK_TOKEN:

OPAL_CHECK_TOKEN
================

.. code-block:: c

   #define OPAL_CHECK_TOKEN			80

   int64_t opal_check_token(uint64_t token);

This OPAL call allows the host OS to determine if a particular OPAL call is present
on a system. This allows for simple compatibility between OPAL versions and different
OPAL implementations/platforms.

One parameter is accepted: the OPAL token number.

``OPAL_CHECK_TOKEN`` will return: ::

  enum OpalCheckTokenStatus {
    OPAL_TOKEN_ABSENT = 0,
    OPAL_TOKEN_PRESENT = 1
  };

indicating the presence/absence of the particular OPAL_CALL.

``OPAL_CHECK_TOKEN`` is REQUIRED to be implemented by a conformant OPAL implementation.

For skiboot, only positively ancient internal-to-IBM versions were missing
OPAL_CHECK_TOKEN. In this case, OPAL_PARAMETER would be returned. There is no
reason for a host OS to support this behaviour.