summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-sensor-read-88.txt
blob: d0b1a08ca5c924066702464ce147c310eccf6ec9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
OpenPOWER on IntegriCloud