[v2,1/2] dt-bindings: thermal: sprd: Add the Spreadtrum thermal documentation
diff mbox series

Message ID 8d5358a67746b2aff5f6995cabd11d0d7c9e579e.1575978484.git.baolin.wang7@gmail.com
State New
Headers show
Series
  • [v2,1/2] dt-bindings: thermal: sprd: Add the Spreadtrum thermal documentation
Related show

Commit Message

Baolin Wang Dec. 10, 2019, 12:07 p.m. UTC
From: Baolin Wang <baolin.wang@unisoc.com>

Add the Spreadtrum thermal documentation.

Signed-off-by: Baolin Wang <baolin.wang@unisoc.com>
Signed-off-by: Baolin Wang <baolin.wang7@gmail.com>
---
Changes from v1:
 - Change to yaml format.
---
 .../devicetree/bindings/thermal/sprd-thermal.yaml  |   97 ++++++++++++++++++++
 1 file changed, 97 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/sprd-thermal.yaml

Comments

Rob Herring Dec. 19, 2019, 8:12 p.m. UTC | #1
On Tue, Dec 10, 2019 at 08:07:17PM +0800, Baolin Wang wrote:
> From: Baolin Wang <baolin.wang@unisoc.com>
> 
> Add the Spreadtrum thermal documentation.
> 
> Signed-off-by: Baolin Wang <baolin.wang@unisoc.com>
> Signed-off-by: Baolin Wang <baolin.wang7@gmail.com>
> ---
> Changes from v1:
>  - Change to yaml format.
> ---
>  .../devicetree/bindings/thermal/sprd-thermal.yaml  |   97 ++++++++++++++++++++
>  1 file changed, 97 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
> 
> diff --git a/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml b/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
> new file mode 100644
> index 0000000..92d208a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
> @@ -0,0 +1,97 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/sprd-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Spreadtrum thermal sensor controller bindings
> +
> +maintainers:
> +  - Orson Zhai <orsonzhai@gmail.com>
> +  - Baolin Wang <baolin.wang7@gmail.com>
> +  - Chunyan Zhang <zhang.lyra@gmail.com>
> +
> +properties:
> +  compatible:
> +    const: sprd,ums512-thermal
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    items:
> +      - const: enable
> +
> +  nvmem-cells:
> +    maxItems: 2
> +    description:
> +      Reference to nvmem nodes for the calibration data.
> +
> +  nvmem-cells-names:
> +    maxItems: 2
> +    items:
> +      - const: thm_sign_cal
> +      - const: thm_ratio_cal
> +
> +  "#thermal-sensor-cells":
> +    const: 1
> +
> +  child-node:

You need actual child node names. It can be a pattern with 
patternProperties.

Make sure 'make dt_binding_check' passes.

> +    description: Represent one thermal sensor.
> +
> +    properties:
> +      reg:
> +        description: Specify the sensor id.
> +        maxItems: 1
> +
> +      nvmem-cells:
> +        maxItems: 1
> +        description:
> +          Reference to an nvmem node for the calibration data.
> +
> +      nvmem-cells-names:
> +        maxItems: 1
> +        items:
> +          - const: sen_delta_cal

Can be simplified to

nvmem-cells-names:
  const: sen_delta_cal

> +
> +    required:
> +      - reg
> +      - nvmem-cells
> +      - nvmem-cells-names
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +  - nvmem-cells
> +  - nvmem-cells-names
> +  - "#thermal-sensor-cells"
> +
> +examples:
> +  - |
> +        ap_thm0: thermal@32200000 {
> +                compatible = "sprd,ums512-thermal";
> +                reg = <0 0x32200000 0 0x10000>;
> +                clock-names = "enable";
> +                clocks = <&aonapb_gate 32>;
> +                #thermal-sensor-cells = <1>;
> +                nvmem-cells = <&thm0_sign>, <&thm0_ratio>;
> +                nvmem-cell-names = "thm_sign_cal", "thm_ratio_cal";
> +
> +                prometheus0-sensor@0 {
> +                        reg = <0>;

This should fail to build. You need #size-cells and #address-cells in 
the parent.

> +                        nvmem-cells = <&thm0_sen0>;
> +                        nvmem-cell-names = "sen_delta_cal";
> +                };
> +
> +                ank1-sensor@1 {
> +                        reg = <1>;
> +                        nvmem-cells = <&thm0_sen1>;
> +                        nvmem-cell-names = "sen_delta_cal";
> +                };
> +        };
> +...
> -- 
> 1.7.9.5
>
Baolin Wang Dec. 20, 2019, 1:42 a.m. UTC | #2
Hi Rob,

On Fri, Dec 20, 2019 at 4:12 AM Rob Herring <robh@kernel.org> wrote:
>
> On Tue, Dec 10, 2019 at 08:07:17PM +0800, Baolin Wang wrote:
> > From: Baolin Wang <baolin.wang@unisoc.com>
> >
> > Add the Spreadtrum thermal documentation.
> >
> > Signed-off-by: Baolin Wang <baolin.wang@unisoc.com>
> > Signed-off-by: Baolin Wang <baolin.wang7@gmail.com>
> > ---
> > Changes from v1:
> >  - Change to yaml format.
> > ---
> >  .../devicetree/bindings/thermal/sprd-thermal.yaml  |   97 ++++++++++++++++++++
> >  1 file changed, 97 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml b/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
> > new file mode 100644
> > index 0000000..92d208a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
> > @@ -0,0 +1,97 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/thermal/sprd-thermal.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Spreadtrum thermal sensor controller bindings
> > +
> > +maintainers:
> > +  - Orson Zhai <orsonzhai@gmail.com>
> > +  - Baolin Wang <baolin.wang7@gmail.com>
> > +  - Chunyan Zhang <zhang.lyra@gmail.com>
> > +
> > +properties:
> > +  compatible:
> > +    const: sprd,ums512-thermal
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  clock-names:
> > +    items:
> > +      - const: enable
> > +
> > +  nvmem-cells:
> > +    maxItems: 2
> > +    description:
> > +      Reference to nvmem nodes for the calibration data.
> > +
> > +  nvmem-cells-names:
> > +    maxItems: 2
> > +    items:
> > +      - const: thm_sign_cal
> > +      - const: thm_ratio_cal
> > +
> > +  "#thermal-sensor-cells":
> > +    const: 1
> > +
> > +  child-node:
>
> You need actual child node names. It can be a pattern with
> patternProperties.

Ah, okay, I misunderstood this before.

>
> Make sure 'make dt_binding_check' passes.

Sure.

>
> > +    description: Represent one thermal sensor.
> > +
> > +    properties:
> > +      reg:
> > +        description: Specify the sensor id.
> > +        maxItems: 1
> > +
> > +      nvmem-cells:
> > +        maxItems: 1
> > +        description:
> > +          Reference to an nvmem node for the calibration data.
> > +
> > +      nvmem-cells-names:
> > +        maxItems: 1
> > +        items:
> > +          - const: sen_delta_cal
>
> Can be simplified to
>
> nvmem-cells-names:
>   const: sen_delta_cal

Okay.

>
> > +
> > +    required:
> > +      - reg
> > +      - nvmem-cells
> > +      - nvmem-cells-names
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - clocks
> > +  - clock-names
> > +  - nvmem-cells
> > +  - nvmem-cells-names
> > +  - "#thermal-sensor-cells"
> > +
> > +examples:
> > +  - |
> > +        ap_thm0: thermal@32200000 {
> > +                compatible = "sprd,ums512-thermal";
> > +                reg = <0 0x32200000 0 0x10000>;
> > +                clock-names = "enable";
> > +                clocks = <&aonapb_gate 32>;
> > +                #thermal-sensor-cells = <1>;
> > +                nvmem-cells = <&thm0_sign>, <&thm0_ratio>;
> > +                nvmem-cell-names = "thm_sign_cal", "thm_ratio_cal";
> > +
> > +                prometheus0-sensor@0 {
> > +                        reg = <0>;
>
> This should fail to build. You need #size-cells and #address-cells in
> the parent.

Yes, will fix in next version. Thanks for your comments.

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml b/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
new file mode 100644
index 0000000..92d208a
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/sprd-thermal.yaml
@@ -0,0 +1,97 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/sprd-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Spreadtrum thermal sensor controller bindings
+
+maintainers:
+  - Orson Zhai <orsonzhai@gmail.com>
+  - Baolin Wang <baolin.wang7@gmail.com>
+  - Chunyan Zhang <zhang.lyra@gmail.com>
+
+properties:
+  compatible:
+    const: sprd,ums512-thermal
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: enable
+
+  nvmem-cells:
+    maxItems: 2
+    description:
+      Reference to nvmem nodes for the calibration data.
+
+  nvmem-cells-names:
+    maxItems: 2
+    items:
+      - const: thm_sign_cal
+      - const: thm_ratio_cal
+
+  "#thermal-sensor-cells":
+    const: 1
+
+  child-node:
+    description: Represent one thermal sensor.
+
+    properties:
+      reg:
+        description: Specify the sensor id.
+        maxItems: 1
+
+      nvmem-cells:
+        maxItems: 1
+        description:
+          Reference to an nvmem node for the calibration data.
+
+      nvmem-cells-names:
+        maxItems: 1
+        items:
+          - const: sen_delta_cal
+
+    required:
+      - reg
+      - nvmem-cells
+      - nvmem-cells-names
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - nvmem-cells
+  - nvmem-cells-names
+  - "#thermal-sensor-cells"
+
+examples:
+  - |
+        ap_thm0: thermal@32200000 {
+                compatible = "sprd,ums512-thermal";
+                reg = <0 0x32200000 0 0x10000>;
+                clock-names = "enable";
+                clocks = <&aonapb_gate 32>;
+                #thermal-sensor-cells = <1>;
+                nvmem-cells = <&thm0_sign>, <&thm0_ratio>;
+                nvmem-cell-names = "thm_sign_cal", "thm_ratio_cal";
+
+                prometheus0-sensor@0 {
+                        reg = <0>;
+                        nvmem-cells = <&thm0_sen0>;
+                        nvmem-cell-names = "sen_delta_cal";
+                };
+
+                ank1-sensor@1 {
+                        reg = <1>;
+                        nvmem-cells = <&thm0_sen1>;
+                        nvmem-cell-names = "sen_delta_cal";
+                };
+        };
+...