diff options
author | Shilpasri G Bhat <shilpa.bhat@linux.vnet.ibm.com> | 2017-07-28 00:45:33 +0530 |
---|---|---|
committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2017-07-28 14:53:19 +1000 |
commit | 5c2510d171cb0a0a7e34e659f2b7a2483decf7de (patch) | |
tree | a61199a5f4828b37c8b65dea3324f7b2f82d6af3 /doc/opal-api | |
parent | fa57f7ccff403e5035c5cec32f92ac4826438195 (diff) | |
download | skiboot-5c2510d171cb0a0a7e34e659f2b7a2483decf7de.zip skiboot-5c2510d171cb0a0a7e34e659f2b7a2483decf7de.tar.gz skiboot-5c2510d171cb0a0a7e34e659f2b7a2483decf7de.tar.bz2 |
sensors: occ: Add support to clear sensor groups
Adds a generic API to clear sensor groups. OCC inband sensor groups
such as CSM, Profiler and Job Scheduler can be cleared using this API.
It will clear the min/max of all sensors belonging to OCC sensor
groups.
Signed-off-by: Shilpasri G Bhat <shilpa.bhat@linux.vnet.ibm.com>
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api')
-rw-r--r-- | doc/opal-api/opal-sensor-group-clear-156.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/opal-api/opal-sensor-group-clear-156.rst b/doc/opal-api/opal-sensor-group-clear-156.rst new file mode 100644 index 0000000..cf874af --- /dev/null +++ b/doc/opal-api/opal-sensor-group-clear-156.rst @@ -0,0 +1,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 |