aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/device-tree/ibm,opal/sensor-groups.rst40
-rw-r--r--doc/opal-api/opal-sensor-group-clear-156.rst42
2 files changed, 82 insertions, 0 deletions
diff --git a/doc/device-tree/ibm,opal/sensor-groups.rst b/doc/device-tree/ibm,opal/sensor-groups.rst
new file mode 100644
index 0000000..af21e7d
--- /dev/null
+++ b/doc/device-tree/ibm,opal/sensor-groups.rst
@@ -0,0 +1,40 @@
+ibm,opal/sensor-groups
+----------------------
+
+This node contains all sensor groups defined in the system.
+Each child node here represents a sensor group.
+
+For example : ::
+ occ-csm@1c00020/
+
+The compatible property is set to "ibm,opal-occ-sensor-group"
+
+Each child node has below properties:
+
+`type`
+ string to indicate the sensor group
+
+`sensor-group-id`
+ Uniquely identifies a sensor group.
+
+`ibm,chip-id`
+ This property is added if the sensor group is chip specific
+
+`sensors`
+ Phandles of all sensors belonging to this sensor group
+
+.. code-block:: dts
+
+ ibm,opal {
+ sensor-groups {
+ compatible = "ibm,opal-occ-sensor-group";
+
+ occ-csm@1c00020 {
+ name = "occ-csm"
+ type = "csm"
+ sensor-group-id = <0x01c00020>
+ ibm,chip-id = <0x00000008>
+ phandles = <
+ };
+ };
+ };
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