From 99505c03f49312c5cc7d40a90728b048857a1078 Mon Sep 17 00:00:00 2001 From: Shilpasri G Bhat Date: Fri, 22 Dec 2017 10:34:08 +0530 Subject: sensor-groups: occ: Add support to disable/enable sensor group This patch adds a new opal call to enable/disable a sensor group. This call is used to select the sensor groups that needs to be copied to main memory by OCC at runtime. Signed-off-by: Shilpasri G Bhat [stewart: rebase and bump OPAL API number] Signed-off-by: Stewart Smith --- doc/opal-api/opal-sensor-group-enable-160.rst | 46 +++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 doc/opal-api/opal-sensor-group-enable-160.rst (limited to 'doc') diff --git a/doc/opal-api/opal-sensor-group-enable-160.rst b/doc/opal-api/opal-sensor-group-enable-160.rst new file mode 100644 index 0000000..b702dd5 --- /dev/null +++ b/doc/opal-api/opal-sensor-group-enable-160.rst @@ -0,0 +1,46 @@ +.. _opal-sensor-groups-enable: + +OPAL_SENSOR_GROUP_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. + +Parameters +---------- +:: + u32 handle + int token + bool enable + +Returns +------- +OPAL_SUCCESS + Success + +OPAL_UNSUPPORTED + No support to enable/disable 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 -- cgit v1.1