diff options
author | Stewart Smith <stewart@linux.ibm.com> | 2019-05-31 16:12:48 +1000 |
---|---|---|
committer | Stewart Smith <stewart@linux.ibm.com> | 2019-06-03 10:19:59 +1000 |
commit | 5eac08c4b3a3aec10ca5853d81d86611fe2304f6 (patch) | |
tree | bb1f7399f292ca977b8013ed8ad7ac8ed1d5fa5c /doc | |
parent | 91a1f4409ca6e16847916bff286ec2ae208f93cd (diff) | |
download | skiboot-5eac08c4b3a3aec10ca5853d81d86611fe2304f6.zip skiboot-5eac08c4b3a3aec10ca5853d81d86611fe2304f6.tar.gz skiboot-5eac08c4b3a3aec10ca5853d81d86611fe2304f6.tar.bz2 |
doc: combine OPAL_SENSOR_GROUP_ENABLE and OPAL_SENSOR_GROUP_CLEAR
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/device-tree/ibm,opal/sensor-groups.rst | 2 | ||||
-rw-r--r-- | doc/opal-api/opal-sensor-group-clear-156.rst | 38 | ||||
-rw-r--r-- | doc/opal-api/opal-sensor-group-enable-163.rst | 41 | ||||
-rw-r--r-- | doc/opal-api/opal-sensor-group-enable-clear-163-156.rst | 88 |
4 files changed, 90 insertions, 79 deletions
diff --git a/doc/device-tree/ibm,opal/sensor-groups.rst b/doc/device-tree/ibm,opal/sensor-groups.rst index 05528d4..0370923 100644 --- a/doc/device-tree/ibm,opal/sensor-groups.rst +++ b/doc/device-tree/ibm,opal/sensor-groups.rst @@ -1,3 +1,5 @@ +.. _device-tree/ibm,opal/sensor-groups: + ibm,opal/sensor-groups ---------------------- diff --git a/doc/opal-api/opal-sensor-group-clear-156.rst b/doc/opal-api/opal-sensor-group-clear-156.rst deleted file mode 100644 index 1a51c84..0000000 --- a/doc/opal-api/opal-sensor-group-clear-156.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _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 diff --git a/doc/opal-api/opal-sensor-group-enable-163.rst b/doc/opal-api/opal-sensor-group-enable-163.rst deleted file mode 100644 index 222a202..0000000 --- a/doc/opal-api/opal-sensor-group-enable-163.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. _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 diff --git a/doc/opal-api/opal-sensor-group-enable-clear-163-156.rst b/doc/opal-api/opal-sensor-group-enable-clear-163-156.rst new file mode 100644 index 0000000..dbf5e3a --- /dev/null +++ b/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 |