diff options
| author | Cédric Le Goater <clg@fr.ibm.com> | 2015-03-09 21:56:20 +0100 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2015-03-24 18:22:55 +1100 |
| commit | dee9fdb30bea0058b740dc644439dd69025197aa (patch) | |
| tree | bd429b1836cda39de02eb64362061d7790b2273e /doc | |
| parent | 3c0627cb13b40f76a2339c021ed7581fa6293fdf (diff) | |
| download | skiboot-dee9fdb30bea0058b740dc644439dd69025197aa.zip skiboot-dee9fdb30bea0058b740dc644439dd69025197aa.tar.gz skiboot-dee9fdb30bea0058b740dc644439dd69025197aa.tar.bz2 | |
sensor: add documentation for the OPAL_SENSOR_READ call
Signed-off-by: Cédric Le Goater <clg@fr.ibm.com>
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/opal-api/opal-sensor-read-88.txt | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/opal-api/opal-sensor-read-88.txt b/doc/opal-api/opal-sensor-read-88.txt new file mode 100644 index 0000000..d0b1a08 --- /dev/null +++ b/doc/opal-api/opal-sensor-read-88.txt @@ -0,0 +1,32 @@ +OPAL_SENSOR_READ +---------------- + +The OPAL sensor call reads a sensor data using a unique handler to +identity the targeted sensor. + + +This call can be asynchronous, when a message needs to be sent to a +service processor for example. In this case, the call will return +OPAL_ASYNC_COMPLETION and the token parameter will be used to wait for +the completion of the request. + + +Parameters: + uint32_t sensor_handler + int token + uint32_t *sensor_data + + +Return values: + OPAL_SUCCESS + OPAL_PARAMETER - invalid sensor handler + +in case of communication with the FSP on IBM systems + + OPAL_ASYNC_COMPLETION - a request was sent and an async completion will + be triggered with the @token argument + OPAL_PARTIAL - the request completed but the data returned is invalid + OPAL_BUSY_EVENT - a previous request is still pending + OPAL_NO_MEM - allocation failed + OPAL_INTERNAL_ERROR - communication failure with the FSP + OPAL_HARDWARE - FSP is not available |