From dee9fdb30bea0058b740dc644439dd69025197aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= Date: Mon, 9 Mar 2015 21:56:20 +0100 Subject: sensor: add documentation for the OPAL_SENSOR_READ call MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Cédric Le Goater Signed-off-by: Stewart Smith --- doc/opal-api/opal-sensor-read-88.txt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 doc/opal-api/opal-sensor-read-88.txt (limited to 'doc') 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 -- cgit v1.1