Skip to content

Commit

Permalink
doc: prettify OPAL_SENSOR_GROUP_ENABLE and OPAL_SENSOR_GROUP_CLEAR
Browse files Browse the repository at this point in the history
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
  • Loading branch information
stewartsmith committed Jun 3, 2019
1 parent 6c9a98a commit fbd5f4c
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 45 deletions.
40 changes: 18 additions & 22 deletions doc/opal-api/opal-sensor-group-clear-156.rst
@@ -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
41 changes: 18 additions & 23 deletions doc/opal-api/opal-sensor-group-enable-163.rst
@@ -1,7 +1,14 @@
.. _opal-sensor-groups-enable:
.. _OPAL_SENSOR_GROUP_ENABLE:

OPAL_SENSOR_GROUP_ENABLE
==========================
========================

.. code-block:: c
#define OPAL_SENSOR_GROUP_ENABLE 163
int opal_sensor_group_enable(u32 group_hndl, int token, bool enable);
OPAL call to enable/disable the sensor group using a handle to identify
the type of sensor group provided in the device tree.

Expand All @@ -11,36 +18,24 @@ group by OCC to main memory.
The call can be asynchronus, where the token parameter is used to wait
for the completion.

Parameters
----------
::
u32 handle
int token
bool enable

Returns
-------
OPAL_SUCCESS
Success

OPAL_UNSUPPORTED
:ref:`OPAL_SUCCESS`
Success
:ref:`OPAL_UNSUPPORTED`
No support to enable/disable 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

0 comments on commit fbd5f4c

Please sign in to comment.