summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-sensor-group-clear-156.rst
blob: cf874af7b49def108a3367c78b816cfcf1a2f165 (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
33
34
35
36
37
38
39
40
41
42
.. _opal-sensor-groups-clear:

OPAL_SENSOR_GROUP_CLEAR
==============================
OPAL call to clear the sensor groups data using a handle to identify
the type of sensor group which is exported via DT.

The call can be asynchronus, where the token parameter is used to wait
for the completion.

Parameters
----------
::
        u32 handle
        int token

Returns
-------
OPAL_SUCCESS
  Success

OPAL_UNSUPPORTED
  No support for clearing the sensor group

OPAL_HARDWARE
  Unable to procced due to the current hardware state

OPAL_PERMISSION
  Hardware cannot take the request

OPAL_ASYNC_COMPLETION
  Request was sent and an async completion message will be sent with
  token and status of the request.

OPAL_BUSY
  Previous request in progress

OPAL_INTERNAL_ERROR
  Error in request response

OPAL_TIMEOUT
  Timeout in request completion
OpenPOWER on IntegriCloud