diff options
author | 2023-10-10 14:33:42 +0000 | |
---|---|---|
committer | 2023-10-10 14:33:42 +0000 | |
commit | af1a266670d040d2f4083ff309d732d648afba2a (patch) | |
tree | 2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/skiboot/doc/opal-api/opal-check-token-80.rst | |
parent | e02cda008591317b1625707ff8e115a4841aa889 (diff) |
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/skiboot/doc/opal-api/opal-check-token-80.rst')
-rw-r--r-- | roms/skiboot/doc/opal-api/opal-check-token-80.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/roms/skiboot/doc/opal-api/opal-check-token-80.rst b/roms/skiboot/doc/opal-api/opal-check-token-80.rst new file mode 100644 index 000000000..34eb0a224 --- /dev/null +++ b/roms/skiboot/doc/opal-api/opal-check-token-80.rst @@ -0,0 +1,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. |