aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.vnet.ibm.com>2015-02-06 16:29:37 +1100
committerStewart Smith <stewart@linux.vnet.ibm.com>2015-02-06 16:29:37 +1100
commitd9db0f84c0edac86c49b5c7c084e88e391715123 (patch)
tree649176f28004fb08f197204ddc27965d34005e9c
parent774d32584fad22ebd7470b47253918924cbd01a4 (diff)
downloadskiboot-d9db0f84c0edac86c49b5c7c084e88e391715123.zip
skiboot-d9db0f84c0edac86c49b5c7c084e88e391715123.tar.gz
skiboot-d9db0f84c0edac86c49b5c7c084e88e391715123.tar.bz2
Add documentation for OPAL_CHECK_TOKEN
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
-rw-r--r--doc/opal-api/opal-check-token-80.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/opal-api/opal-check-token-80.txt b/doc/opal-api/opal-check-token-80.txt
new file mode 100644
index 0000000..4c5f7c3
--- /dev/null
+++ b/doc/opal-api/opal-check-token-80.txt
@@ -0,0 +1,23 @@
+OPAL_CHECK_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.