Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: prettify OPAL_SENSOR_GROUP_ENABLE and OPAL_SENSOR_GROUP_CLEAR
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
- Loading branch information
1 parent
6c9a98a
commit fbd5f4c
Showing
2 changed files
with
36 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,38 @@ | ||
.. _opal-sensor-groups-clear: | ||
.. _OPAL_SENSOR_GROUP_CLEAR: | ||
|
||
OPAL_SENSOR_GROUP_CLEAR | ||
============================== | ||
======================= | ||
|
||
.. code-block:: c | ||
int opal_sensor_group_clear(u32 group_hndl, int token); | ||
#define OPAL_SENSOR_GROUP_CLEAR 156 | ||
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 | ||
:ref:`OPAL_SUCCESS` | ||
Success | ||
:ref:`OPAL_UNSUPPORTED` | ||
No support for clearing the sensor group | ||
|
||
OPAL_HARDWARE | ||
:ref:`OPAL_HARDWARE` | ||
Unable to procced due to the current hardware state | ||
|
||
OPAL_PERMISSION | ||
:ref:`OPAL_PERMISSION` | ||
Hardware cannot take the request | ||
|
||
OPAL_ASYNC_COMPLETION | ||
:ref:`OPAL_ASYNC_COMPLETION` | ||
Request was sent and an async completion message will be sent with | ||
token and status of the request. | ||
|
||
OPAL_BUSY | ||
:ref:`OPAL_BUSY` | ||
Previous request in progress | ||
|
||
OPAL_INTERNAL_ERROR | ||
:ref:`OPAL_INTERNAL_ERROR` | ||
Error in request response | ||
|
||
OPAL_TIMEOUT | ||
:ref:`OPAL_TIMEOUT` | ||
Timeout in request completion |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters