Skip to content

Commit

Permalink
doc: combine 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 91a1f44 commit 5eac08c
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 79 deletions.
2 changes: 2 additions & 0 deletions doc/device-tree/ibm,opal/sensor-groups.rst
@@ -1,3 +1,5 @@
.. _device-tree/ibm,opal/sensor-groups:

ibm,opal/sensor-groups
----------------------

Expand Down
38 changes: 0 additions & 38 deletions doc/opal-api/opal-sensor-group-clear-156.rst

This file was deleted.

41 changes: 0 additions & 41 deletions doc/opal-api/opal-sensor-group-enable-163.rst

This file was deleted.

88 changes: 88 additions & 0 deletions doc/opal-api/opal-sensor-group-enable-clear-163-156.rst
@@ -0,0 +1,88 @@
.. _opal-sensor-groups:

==================
OPAL Sensor Groups
==================

See :ref:`device-tree/ibm,opal/sensor-groups` for device tree layout.

.. _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.

For example this call is used to disable/enable copying of sensor
group by OCC to main memory.

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


Returns
-------

:ref:`OPAL_SUCCESS`
Success
:ref:`OPAL_UNSUPPORTED`
No support to enable/disable the sensor group
:ref:`OPAL_HARDWARE`
Unable to procced due to the current hardware state
:ref:`OPAL_PERMISSION`
Hardware cannot take the request
:ref:`OPAL_ASYNC_COMPLETION`
Request was sent and an async completion message will be sent with
token and status of the request.
:ref:`OPAL_BUSY`
Previous request in progress
:ref:`OPAL_INTERNAL_ERROR`
Error in request response
:ref:`OPAL_TIMEOUT`
Timeout in request completion

.. _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.


Returns
-------

:ref:`OPAL_SUCCESS`
Success
:ref:`OPAL_UNSUPPORTED`
No support for clearing the sensor group
:ref:`OPAL_HARDWARE`
Unable to procced due to the current hardware state
:ref:`OPAL_PERMISSION`
Hardware cannot take the request
:ref:`OPAL_ASYNC_COMPLETION`
Request was sent and an async completion message will be sent with
token and status of the request.
:ref:`OPAL_BUSY`
Previous request in progress
:ref:`OPAL_INTERNAL_ERROR`
Error in request response
:ref:`OPAL_TIMEOUT`
Timeout in request completion

0 comments on commit 5eac08c

Please sign in to comment.