diff mbox series

[v8,1/2] dt-bindings: thermal: k3-j72xx: Add VTM bindings documentation

Message ID 20220517121423.8017-2-j-keerthy@ti.com
State Superseded
Headers show
Series thermal: k3_j72xx_bandgap: Add the bandgap driver support | expand

Commit Message

J, KEERTHY May 17, 2022, 12:14 p.m. UTC
Add VTM bindings documentation. In the Voltage Thermal
Management Module(VTM), K3 J72XX supplies a voltage
reference and a temperature sensor feature that are gathered in the band
gap voltage and temperature sensor (VBGAPTS) module. The band
gap provides current and voltage reference for its internal
circuits and other analog IP blocks. The analog-to-digital
converter (ADC) produces an output value that is proportional
to the silicon temperature.

Signed-off-by: Keerthy <j-keerthy@ti.com>
---
 .../bindings/thermal/ti,j72xx-thermal.yaml    | 63 +++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/ti,j72xx-thermal.yaml

Comments

J, KEERTHY May 17, 2022, 3:07 p.m. UTC | #1
On 5/17/2022 8:08 PM, Krzysztof Kozlowski wrote:
> On 17/05/2022 14:14, Keerthy wrote:
>> Add VTM bindings documentation. In the Voltage Thermal
>> Management Module(VTM), K3 J72XX supplies a voltage
>> reference and a temperature sensor feature that are gathered in the band
>> gap voltage and temperature sensor (VBGAPTS) module. The band
>> gap provides current and voltage reference for its internal
>> circuits and other analog IP blocks. The analog-to-digital
>> converter (ADC) produces an output value that is proportional
>> to the silicon temperature.
>>
>> Signed-off-by: Keerthy <j-keerthy@ti.com>
> 
> It seems I am repeating myself... Tags are still missing...

I still do not have a Reviewed-by from you. Should i add yours?
You are still giving additional comments so I did not add.

> 
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/soc/ti,sci_pm_domain.h>
>> +    wkup_vtm0: thermal-sensor@42040000 {
>> +        compatible = "ti,j721e-vtm";
>> +        reg = <0x42040000 0x350>,
>> +            <0x42050000 0x350>,
>> +            <0x43000300 0x10>;
> 
> Please align the continued entries with opening <.

Okay. I will fix that.

> 
>> +        power-domains = <&k3_pds 154 TI_SCI_PD_EXCLUSIVE>;
>> +        #thermal-sensor-cells = <1>;
>> +    };
>> +
>> +    mpu_thermal: mpu-thermal {
>> +        polling-delay-passive = <250>; /* milliseconds */
>> +        polling-delay = <500>; /* milliseconds */
>> +        thermal-sensors = <&wkup_vtm0 0>;
>> +
>> +        trips {
>> +                mpu_crit: mpu-crit {
> 
> You still have here incorrect/inconsistent indentation. Entire DTS
> example goes usually with 4 spaces.

Okay.

> 
>> +                        temperature = <125000>; /* milliCelsius */
>> +                        hysteresis = <2000>; /* milliCelsius */
>> +                        type = "critical";
>> +                };
>> +        };
>> +    };
>> +...
> 
>

Thanks,
Keerthy

> Best regards,
> Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/ti,j72xx-thermal.yaml b/Documentation/devicetree/bindings/thermal/ti,j72xx-thermal.yaml
new file mode 100644
index 000000000000..38429e6122eb
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/ti,j72xx-thermal.yaml
@@ -0,0 +1,63 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/ti,j72xx-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments J72XX VTM (DTS) binding
+
+maintainers:
+  - Keerthy <j-keerthy@ti.com>
+
+properties:
+  compatible:
+    enum:
+      - ti,j721e-vtm
+      - ti,j7200-vtm
+
+  reg:
+    items:
+      - description: VTM cfg1 register space
+      - description: VTM cfg2 register space
+      - description: VTM efuse register space
+
+  power-domains:
+    maxItems: 1
+
+  "#thermal-sensor-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - power-domains
+  - "#thermal-sensor-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/soc/ti,sci_pm_domain.h>
+    wkup_vtm0: thermal-sensor@42040000 {
+        compatible = "ti,j721e-vtm";
+        reg = <0x42040000 0x350>,
+            <0x42050000 0x350>,
+            <0x43000300 0x10>;
+        power-domains = <&k3_pds 154 TI_SCI_PD_EXCLUSIVE>;
+        #thermal-sensor-cells = <1>;
+    };
+
+    mpu_thermal: mpu-thermal {
+        polling-delay-passive = <250>; /* milliseconds */
+        polling-delay = <500>; /* milliseconds */
+        thermal-sensors = <&wkup_vtm0 0>;
+
+        trips {
+                mpu_crit: mpu-crit {
+                        temperature = <125000>; /* milliCelsius */
+                        hysteresis = <2000>; /* milliCelsius */
+                        type = "critical";
+                };
+        };
+    };
+...