diff mbox series

[v2,1/3] dt-bindings: thermal-zones: Document critical-action

Message ID 20230828141341.1583591-1-festevam@gmail.com
State New
Headers show
Series [v2,1/3] dt-bindings: thermal-zones: Document critical-action | expand

Commit Message

Fabio Estevam Aug. 28, 2023, 2:13 p.m. UTC 
From: Fabio Estevam <festevam@denx.de>

Document the critical-action property to describe the thermal
action that will be taken after the critical temperature is reached.

The possible values are "shutdown" and "reboot".

Signed-off-by: Fabio Estevam <festevam@denx.de>
---
Changes since v1:
- Make 'critical-action' to be of string type.

 .../devicetree/bindings/thermal/thermal-zones.yaml     | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/thermal-zones.yaml b/Documentation/devicetree/bindings/thermal/thermal-zones.yaml
index 4f3acdc4dec0..a01456356d9f 100644
--- a/Documentation/devicetree/bindings/thermal/thermal-zones.yaml
+++ b/Documentation/devicetree/bindings/thermal/thermal-zones.yaml
@@ -75,6 +75,16 @@  patternProperties:
           framework and assumes that the thermal sensors in this zone
           support interrupts.
 
+      critical-action:
+        $ref: /schemas/types.yaml#/definitions/string
+        description:
+          The action that happens after the critical temperature is reached.
+          Possible values are "shutdown" and "reboot".
+
+        enum:
+          - shutdown    # Trigger a shutdown after the critical temperature is reached
+          - reboot      # Trigger a reboot after the critical temperature is reached
+
       thermal-sensors:
         $ref: /schemas/types.yaml#/definitions/phandle-array
         maxItems: 1