[PATCH v2 1/2] dt-bindings: Add bindings for the virtual thermal sensor

From: Alexandre Bailon
Date: Fri Sep 17 2021 - 03:25:50 EST


This adds the device tree bidings for the virtual thermal sensor.
The virtual sensor could be used to a temperature computed from
many thermal sensors.

Signed-off-by: Alexandre Bailon <abailon@xxxxxxxxxxxx>
---
.../thermal/virtual,thermal-sensor.yaml | 67 +++++++++++++++++++
include/dt-bindings/thermal/virtual-sensor.h | 15 +++++
2 files changed, 82 insertions(+)
create mode 100644 Documentation/devicetree/bindings/thermal/virtual,thermal-sensor.yaml
create mode 100644 include/dt-bindings/thermal/virtual-sensor.h

diff --git a/Documentation/devicetree/bindings/thermal/virtual,thermal-sensor.yaml b/Documentation/devicetree/bindings/thermal/virtual,thermal-sensor.yaml
new file mode 100644
index 0000000000000..049620ed88a5b
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/virtual,thermal-sensor.yaml
@@ -0,0 +1,67 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright 2021 BayLibre
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/thermal-sensor.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Virtual thermal sensor binding
+
+description: |
+ The virtual thermal sensor devices provide temperature sensing capabilities
+ based on hardware thermal sensors. Basically, this could be used to get the
+ maximum, minimum or average temperature of the hardware thermal sensors.
+properties:
+ "#thermal-sensor-cells":
+ description:
+ Used to uniquely identify a thermal sensor instance within an IC. Will be
+ 0 on sensor nodes with only a single sensor and at least 1 on nodes
+ containing several internal sensors.
+ enum: [0, 1]
+
+ aggregation-function:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Used to select the operations to perform on the sensors to get the virtual
+ sensor temperature.
+ enum:
+ - VIRTUAL_THERMAL_SENSOR_MIN
+ - VIRTUAL_THERMAL_SENSOR_MAX
+ - VIRTUAL_THERMAL_SENSOR_AVG
+
+ thermal-sensors:
+ $ref: /schemas/types.yaml#/definitions/phandle-array
+ description:
+ The thermal sensor phandle and sensor specifier used to monitor this
+ thermal zone.
+
+required:
+ - "#thermal-sensor-cells"
+ - aggregation-function
+ - thermal-sensors
+
+additionalProperties: true
+
+examples:
+ - |
+ #include <dt-bindings/thermal/thermal.h>
+ #include <dt-bindings/thermal/virtual-sensor.h>
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/clock/mt8192-clk.h>
+
+ lvts: lvts@1100b000 {
+ compatible = "mediatek,mt6873-lvts";
+ reg = <0x1100b000 0x1000>;
+ clocks = <&infracfg CLK_INFRA_THERM>;
+ clock-names = "lvts_clk";
+ #thermal-sensor-cells = <0>;
+ interrupts = <GIC_SPI 147 IRQ_TYPE_LEVEL_HIGH>;
+ };
+
+ soc_max_sensor: soc_max_sensor {
+ compatible = "virtual,thermal-sensor";
+ #thermal-sensor-cells = <1>;
+ aggregation-function = <VIRTUAL_THERMAL_SENSOR_MAX>;
+ thermal-sensors = <&lvts 0>, <&lvts 1>;
+ };
+...
diff --git a/include/dt-bindings/thermal/virtual-sensor.h b/include/dt-bindings/thermal/virtual-sensor.h
new file mode 100644
index 0000000000000..93f6dc2453b85
--- /dev/null
+++ b/include/dt-bindings/thermal/virtual-sensor.h
@@ -0,0 +1,15 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+/*
+ * This header provides constants for virtual thermal sensor bindings.
+ *
+ * Copyright (C) 2021 BayLibre
+ */
+
+#ifndef _DT_BINDINGS_THERMAL_VIRTUAL_SENSOR_H
+#define _DT_BINDINGS_THERMAL_VIRTUAL_SENSOR_H
+
+#define VIRTUAL_THERMAL_SENSOR_MIN 0
+#define VIRTUAL_THERMAL_SENSOR_MAX 1
+#define VIRTUAL_THERMAL_SENSOR_AVG 2
+
+#endif /* _DT_BINDINGS_THERMAL_VIRTUAL_SENSOR_H */
--
2.31.1