diff options
| author | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-07-27 17:43:18 +1000 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-02 18:12:48 +1000 |
| commit | b93c30a70332544112edc1d7cee6ea78545b8fec (patch) | |
| tree | 4889d077663e847bf4a2ca609cdd4eac2758b037 /doc/opal-api/opal-test-0.rst | |
| parent | 24e7fd3aa79697c019f215e1dd1a270b1b014e89 (diff) | |
| download | blackbird-skiboot-b93c30a70332544112edc1d7cee6ea78545b8fec.tar.gz blackbird-skiboot-b93c30a70332544112edc1d7cee6ea78545b8fec.zip | |
doc/opal-api: rename .txt to .rst
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api/opal-test-0.rst')
| -rw-r--r-- | doc/opal-api/opal-test-0.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/opal-api/opal-test-0.rst b/doc/opal-api/opal-test-0.rst new file mode 100644 index 00000000..f7322271 --- /dev/null +++ b/doc/opal-api/opal-test-0.rst @@ -0,0 +1,30 @@ +OPAL_TEST +--------- + +OPAL_TEST is a REQUIRED call for OPAL and conforming implementations MUST +have it. + +It is designed to test basic OPAL call functionality. + +Token: +#define OPAL_TEST 0 + +Arguments: + uint64_t arg + +Returns: + 0xfeedf00d + + +Function: +OPAL_TEST MAY print a string to the OPAL log with the value of argument. + +For example, the reference implementation (skiboot) implements OPAL_TEST as: + +static uint64_t opal_test_func(uint64_t arg) +{ + printf("OPAL: Test function called with arg 0x%llx\n", arg); + + return 0xfeedf00d; +} + |
