summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-sensor-group-enable-163.rst
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.vnet.ibm.com>2018-02-21 14:33:40 +1100
committerStewart Smith <stewart@linux.vnet.ibm.com>2018-02-21 14:41:21 +1100
commite6272787ed96c9092a5116e2b15d211521ad6e61 (patch)
tree188529a8e0528a1b90994b799cd876020e96b3af /doc/opal-api/opal-sensor-group-enable-163.rst
parent237cd0c50a669af3aff4e804d19b785f7515179d (diff)
downloadblackbird-skiboot-e6272787ed96c9092a5116e2b15d211521ad6e61.tar.gz
blackbird-skiboot-e6272787ed96c9092a5116e2b15d211521ad6e61.zip
opal-api: Re-jig OPAL API numbers because OpenCAPI kernel merge
74d656d219b98ef3b96f92439337aa6392a7577d added OPAL APIs to kernel (and this commit is now in Linus' tree) that hadn't yet made their way to OPAL. Also, be slightly grumbly about it. Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api/opal-sensor-group-enable-163.rst')
-rw-r--r--doc/opal-api/opal-sensor-group-enable-163.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/opal-api/opal-sensor-group-enable-163.rst b/doc/opal-api/opal-sensor-group-enable-163.rst
new file mode 100644
index 00000000..b702dd5f
--- /dev/null
+++ b/doc/opal-api/opal-sensor-group-enable-163.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
OpenPOWER on IntegriCloud