diff mbox series

[v1,2/3] dt-bindings: thermal: Convert ls2k to json-schema

Message ID 20220919034915.26912-2-zhuyinbo@loongson.cn (mailing list archive)
State New, archived
Delegated to: Daniel Lezcano
Headers show
Series [v1,1/3] MAINTAINERS: add maintainer for thermal driver for ls2k SoCs | expand

Commit Message

Yinbo Zhu Sept. 19, 2022, 3:49 a.m. UTC
Convert the ls2k thermal binding to DT schema format using json-schema

Signed-off-by: Yinbo Zhu <zhuyinbo@loongson.cn>
---
 .../bindings/thermal/ls2k-thermal.yaml        | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml

Comments

Krzysztof Kozlowski Sept. 19, 2022, 6:58 a.m. UTC | #1
On Mon, 19 Sep 2022 11:49:14 +0800, Yinbo Zhu wrote:
> Convert the ls2k thermal binding to DT schema format using json-schema
> 
> Signed-off-by: Yinbo Zhu <zhuyinbo@loongson.cn>
> ---
>  .../bindings/thermal/ls2k-thermal.yaml        | 51 +++++++++++++++++++
>  1 file changed, 51 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml: properties:interrupt-parent: False schema does not allow {'maxItems': 1}
	from schema $id: http://devicetree.org/meta-schemas/interrupts.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml: ignoring, error in schema: properties: interrupt-parent
Documentation/devicetree/bindings/thermal/ls2k-thermal.example.dtb:0:0: /example-0/tsensor@1fe01500: failed to match any schema with compatible: ['loongson,2k-tsensor']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Krzysztof Kozlowski Sept. 19, 2022, 7:03 a.m. UTC | #2
On 19/09/2022 05:49, Yinbo Zhu wrote:
> Convert the ls2k thermal binding to DT schema format using json-schema
> 
> Signed-off-by: Yinbo Zhu <zhuyinbo@loongson.cn>

FYI, All your patches were marked as spam, unfortunately.

> ---
>  .../bindings/thermal/ls2k-thermal.yaml        | 51 +++++++++++++++++++
>  1 file changed, 51 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml
> 
> diff --git a/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml b/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml
> new file mode 100644
> index 000000000000..44bc5d4626d1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml

Filename based on compatible.

> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/ls2k-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Thermal sensors on loongson 2k SoCs
> +
> +maintainers:
> +  - zhanghongchen <zhanghongchen@loongson.cn>
> +  - Yinbo Zhu <zhuyinbo@loongson.cn>
> +
> +properties:
> +  compatible:
> +    const: loongson,2k-thermal
> +
> +  reg:
> +    maxItems: 1
> +
> +  id:
> +    const: 0

Why? What is this? No description, no type (is there such standard
property?), no vendor prefix... and always equal to 0?

> +
> +  interrupt-parent:
> +    maxItems: 1

That's not needed, I think.

> +
> +  interrupts:
> +    maxItems: 1
> +
> +  "#thermal-sensor-cells":
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - id
> +  - interrupt-parent
> +  - interrupts
> +  - '#thermal-sensor-cells'
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    tsensor: tsensor@1fe01500 {

Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

Use names used by other examples.

> +        compatible = "loongson,2k-tsensor";
> +        reg = <0 0x1fe01500 0 0x30>;
> +        id = <0>;
> +        interrupt-parent = <&icu>;
> +        interrupts = <7>;
> +        #thermal-sensor-cells = <1>;
> +    };


Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml b/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml
new file mode 100644
index 000000000000..44bc5d4626d1
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/ls2k-thermal.yaml
@@ -0,0 +1,51 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/ls2k-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Thermal sensors on loongson 2k SoCs
+
+maintainers:
+  - zhanghongchen <zhanghongchen@loongson.cn>
+  - Yinbo Zhu <zhuyinbo@loongson.cn>
+
+properties:
+  compatible:
+    const: loongson,2k-thermal
+
+  reg:
+    maxItems: 1
+
+  id:
+    const: 0
+
+  interrupt-parent:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  "#thermal-sensor-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - id
+  - interrupt-parent
+  - interrupts
+  - '#thermal-sensor-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    tsensor: tsensor@1fe01500 {
+        compatible = "loongson,2k-tsensor";
+        reg = <0 0x1fe01500 0 0x30>;
+        id = <0>;
+        interrupt-parent = <&icu>;
+        interrupts = <7>;
+        #thermal-sensor-cells = <1>;
+    };