Re: [PATCH v3 1/4] dt-bindings: thermal: k3: Add VTM bindings documentation

[Keerthy]

On 19/02/20 8:22 pm, Rob Herring wrote:
> On Wed, Feb 19, 2020 at 01:13:11PM +0530, Keerthy wrote:
> > Add VTM bindings documentation. In the Voltage Thermal
> > Management Module(VTM), K3 AM654 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@xxxxxx>
> > ---
> >
> > Changes in v3:
> >
> >    * Fixed errors seen with:
> >      dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/thermal/ti,am654-thermal.yaml
> >
> >   .../bindings/thermal/ti,am654-thermal.yaml    | 57 +++++++++++++++++++
> >   1 file changed, 57 insertions(+)
> >   create mode 100644 Documentation/devicetree/bindings/thermal/ti,am654-thermal.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/thermal/ti,am654-thermal.yaml b/Documentation/devicetree/bindings/thermal/ti,am654-thermal.yaml
> > new file mode 100644
> > index 000000000000..b6dc95c3acab
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/thermal/ti,am654-thermal.yaml
> > @@ -0,0 +1,57 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/thermal/ti,am654-thermal.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Texas Instruments AM654 VTM (DTS) binding
> > +
> > +maintainers:
> > +  - Keerthy <j-keerthy@xxxxxx>
> > +
> > +properties:
> > +  compatible:
> > +    const: ti,am654-vtm
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  power-domains:
> > +    maxItems: 1
> > +    description: phandle to the associated power domain
>
> No need to redefine a standard property description.

Okay.

> > +
> > +  "#thermal-sensor-cells":
> > +    const: 1
> > +
> > +required:
> > +  - "#thermal-sensor-cells"
> > +  - compatible
> > +  - reg
> > +  - power-domains
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/soc/ti,sci_pm_domain.h>
> > +    vtm: wkup_vtm0@42050000 {
>
> thermal-sensor@...
>
> Use generic node names and don't use '_' in node names

vtm stands for voltage thermal manager and comprises of multiple 
sensors. This is similar to omap bandgap. Should i replace vtm with more 
generic name like thermal? as used in:

Documentation/devicetree/bindings/thermal/st,stm32-thermal.yaml

- Keerthy

> > +        compatible = "ti,am654-vtm";
> > +        reg = <0x0 0x42050000 0x0 0x25c>;
> > +        power-domains = <&k3_pds 80 TI_SCI_PD_EXCLUSIVE>;
> > +        #thermal-sensor-cells = <1>;
> > +    };
> > +
> > +    mpu0_thermal: mpu0_thermal {
> > +        polling-delay-passive = <250>; /* milliseconds */
> > +        polling-delay = <500>; /* milliseconds */
> > +        thermal-sensors = <&vtm0 0>;
> > +
> > +        trips {
> > +                mpu0_crit: mpu0_crit {
> > +                        temperature = <125000>; /* milliCelsius */
> > +                        hysteresis = <2000>; /* milliCelsius */
> > +                        type = "critical";
> > +                };
> > +        };
> > +    };
> > +...
> > --
> > 2.17.1