diff mbox series

[1/1] dt-bindings: pwm:Convert pwm-mtk-disp.txt format file to pwm-mtk-disp.yaml format file

Message ID 1644847276-27622-2-git-send-email-xinlei.lee@mediatek.com (mailing list archive)
State New, archived
Headers show
Series Convert pwm-mtk-disp.txt format file to pwm-mtk-disp.yaml format file | expand

Commit Message

Xinlei Lee (李昕磊) Feb. 14, 2022, 2:01 p.m. UTC 
From: xinlei lee <xinlei.lee@mediatek.com>

Signed-off-by: xinlei lee <xinlei.lee@mediatek.com>
---
 .../devicetree/bindings/pwm/pwm-mtk-disp.yaml      | 60 ++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml

Comments

Uwe Kleine-König Feb. 14, 2022, 2:11 p.m. UTC | #1 
Hello,

On Mon, Feb 14, 2022 at 10:01:16PM +0800, xinlei.lee@mediatek.com wrote:
> From: xinlei lee <xinlei.lee@mediatek.com>
> 
> Signed-off-by: xinlei lee <xinlei.lee@mediatek.com>
> ---
>  .../devicetree/bindings/pwm/pwm-mtk-disp.yaml      | 60 ++++++++++++++++++++++
>  1 file changed, 60 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> 
> diff --git a/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> new file mode 100644
> index 0000000..2f1183e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> @@ -0,0 +1,60 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/pwm-mtk-disp.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: mediatek PWM Controller Device Tree Bindings
> +
> +maintainers:
> +  - Thierry Reding <thierry.reding@gmail.com>
> +  - Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> +  - Lee Jones <lee.jones@linaro.org>
> +  - Rob Herring <robh+dt@kernel.org>

I would have expected some mediatek people here instead of the PWM and
dt maintainers.

> +
> +properties:
> +  compatible:
> +    enum:
> +      - mediatek,mt2701-disp-pwm
> +      - mediatek,mt6595-disp-pwm
> +      - mediatek,mt8173-disp-pwm
> +      - mediatek,mt8183-disp-pwm
> +      - mediatek,mt8186-disp-pwm
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: Main Clock
> +      - description: Mm Clock
> +
> +  clock-names:
> +    items:
> +      - const: main
> +      - const: mm
> +required:
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/clock/mt8186-clk.h>
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    disp_pwm: disp_pwm0@1100e000 {
> +        compatible = "mediatek,mt8183-disp-pwm";
> +        reg = <0x1100e000 0x1000>;
> +        interrupts = <GIC_SPI 143 IRQ_TYPE_LEVEL_HIGH>;
> +        clocks = <&topckgen CLK_TOP_DISP_PWM>,
> +                 <&infracfg_ao CLK_INFRA_AO_DISP_PWM>;
> +        clock-names = "main", "mm";
> +        status = "okay";
> +    };
> \ No newline at end of file

Please add this newline at EOF.

Best regards
Uwe
Krzysztof Kozlowski Feb. 14, 2022, 9:32 p.m. UTC | #2 
On 14/02/2022 15:01, xinlei.lee@mediatek.com wrote:
> From: xinlei lee <xinlei.lee@mediatek.com>

Commit msg is needed.

Subject - missing space after ':' and it is too long. No need to say
"format file" twice.

You miss "PATCH" in subject. Using `git format-patch` is the easiest way
to create proper patches.

> 
> Signed-off-by: xinlei lee <xinlei.lee@mediatek.com>
> ---
>  .../devicetree/bindings/pwm/pwm-mtk-disp.yaml      | 60 ++++++++++++++++++++++
>  1 file changed, 60 insertions(+)

I do not see the conversion here... You only add one file. Where is the
removal?

>  create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> 
> diff --git a/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> new file mode 100644
> index 0000000..2f1183e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml

Let's name the file as with most bindings, so with vendor:
"mediatek,pwm-disp.yaml"

> @@ -0,0 +1,60 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/pwm-mtk-disp.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: mediatek PWM Controller Device Tree Bindings
> +
> +maintainers:
> +  - Thierry Reding <thierry.reding@gmail.com>
> +  - Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> +  - Lee Jones <lee.jones@linaro.org>
> +  - Rob Herring <robh+dt@kernel.org>
> +

allOf referencing pwm.yaml

> +properties:
> +  compatible:
> +    enum:
> +      - mediatek,mt2701-disp-pwm
> +      - mediatek,mt6595-disp-pwm
> +      - mediatek,mt8173-disp-pwm
> +      - mediatek,mt8183-disp-pwm
> +      - mediatek,mt8186-disp-pwm
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: Main Clock
> +      - description: Mm Clock
> +


This schema was not tested. Please run it against your DTS files (make
dtbs_check). You need pwm-cells and power-domains. Maybe more...

> +  clock-names:
> +    items:
> +      - const: main
> +      - const: mm

Blank line.

> +required:

"compatible" is required, put it first in the list.

> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/clock/mt8186-clk.h>
> +    #include <dt-bindings/interrupt-controller/irq.h>

Blank line.

> +    disp_pwm: disp_pwm0@1100e000 {

node name: "pwm" (generic as schema and devicetree specification ask for).

> +        compatible = "mediatek,mt8183-disp-pwm";
> +        reg = <0x1100e000 0x1000>;
> +        interrupts = <GIC_SPI 143 IRQ_TYPE_LEVEL_HIGH>;
> +        clocks = <&topckgen CLK_TOP_DISP_PWM>,
> +                 <&infracfg_ao CLK_INFRA_AO_DISP_PWM>;
> +        clock-names = "main", "mm";
> +        status = "okay";

No need for status.

> +    };
> \ No newline at end of file


Best regards,
Krzysztof
Xinlei Lee (李昕磊) Feb. 15, 2022, 2:17 a.m. UTC | #3 
On Mon, 2022-02-14 at 22:32 +0100, Krzysztof Kozlowski wrote:
> On 14/02/2022 15:01, xinlei.lee@mediatek.com wrote:
> > From: xinlei lee <xinlei.lee@mediatek.com>
> 
> Commit msg is needed.
> 
> Subject - missing space after ':' and it is too long. No need to say
> "format file" twice.
> 
> You miss "PATCH" in subject. Using `git format-patch` is the easiest
> way
> to create proper patches.
> 
> > 
> > Signed-off-by: xinlei lee <xinlei.lee@mediatek.com>
> > ---
> >  .../devicetree/bindings/pwm/pwm-mtk-disp.yaml      | 60
> > ++++++++++++++++++++++
> >  1 file changed, 60 insertions(+)
> 
> I do not see the conversion here... You only add one file. Where is
> the
> removal?
> 
> >  create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-
> > disp.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/pwm/pwm-mtk-
> > disp.yaml b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> > new file mode 100644
> > index 0000000..2f1183e
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> 
> Let's name the file as with most bindings, so with vendor:
> "mediatek,pwm-disp.yaml"
> 
> > @@ -0,0 +1,60 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/pwm/pwm-mtk-disp.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: mediatek PWM Controller Device Tree Bindings
> > +
> > +maintainers:
> > +  - Thierry Reding <thierry.reding@gmail.com>
> > +  - Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> > +  - Lee Jones <lee.jones@linaro.org>
> > +  - Rob Herring <robh+dt@kernel.org>
> > +
> 
> allOf referencing pwm.yaml
> 
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - mediatek,mt2701-disp-pwm
> > +      - mediatek,mt6595-disp-pwm
> > +      - mediatek,mt8173-disp-pwm
> > +      - mediatek,mt8183-disp-pwm
> > +      - mediatek,mt8186-disp-pwm
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    items:
> > +      - description: Main Clock
> > +      - description: Mm Clock
> > +
> 
> 
> This schema was not tested. Please run it against your DTS files
> (make
> dtbs_check). You need pwm-cells and power-domains. Maybe more...
> 
> > +  clock-names:
> > +    items:
> > +      - const: main
> > +      - const: mm
> 
> Blank line.
> 
> > +required:
> 
> "compatible" is required, put it first in the list.
> 
> > +  - reg
> > +  - interrupts
> > +  - clocks
> > +  - clock-names> +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> > +    #include <dt-bindings/clock/mt8186-clk.h>
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> 
> Blank line.
> 
> > +    disp_pwm: disp_pwm0@1100e000 {
> 
> node name: "pwm" (generic as schema and devicetree specification ask
> for).
> 
> > +        compatible = "mediatek,mt8183-disp-pwm";
> > +        reg = <0x1100e000 0x1000>;
> > +        interrupts = <GIC_SPI 143 IRQ_TYPE_LEVEL_HIGH>;
> > +        clocks = <&topckgen CLK_TOP_DISP_PWM>,
> > +                 <&infracfg_ao CLK_INFRA_AO_DISP_PWM>;
> > +        clock-names = "main", "mm";
> > +        status = "okay";
> 
> No need for status.
> 
> > +    };
> > \ No newline at end of file
> 
> 
> Best regards,
> Krzysztof

Hi Krzysztof:

Thanks for your valuable comments, I will pay more attention to the
relevant details later, and I will revise according to your comments
and submit the next version in the near future.

Best Regards,
xinlei
Xinlei Lee (李昕磊) Feb. 15, 2022, 2:20 a.m. UTC | #4 
On Mon, 2022-02-14 at 15:11 +0100, Uwe Kleine-König wrote:
> Hello,
> 
> On Mon, Feb 14, 2022 at 10:01:16PM +0800, xinlei.lee@mediatek.com
> wrote:
> > From: xinlei lee <xinlei.lee@mediatek.com>
> > 
> > Signed-off-by: xinlei lee <xinlei.lee@mediatek.com>
> > ---
> >  .../devicetree/bindings/pwm/pwm-mtk-disp.yaml      | 60
> > ++++++++++++++++++++++
> >  1 file changed, 60 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-
> > disp.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/pwm/pwm-mtk-
> > disp.yaml b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> > new file mode 100644
> > index 0000000..2f1183e
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
> > @@ -0,0 +1,60 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/pwm/pwm-mtk-disp.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: mediatek PWM Controller Device Tree Bindings
> > +
> > +maintainers:
> > +  - Thierry Reding <thierry.reding@gmail.com>
> > +  - Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> > +  - Lee Jones <lee.jones@linaro.org>
> > +  - Rob Herring <robh+dt@kernel.org>
> 
> I would have expected some mediatek people here instead of the PWM
> and
> dt maintainers.
> 
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - mediatek,mt2701-disp-pwm
> > +      - mediatek,mt6595-disp-pwm
> > +      - mediatek,mt8173-disp-pwm
> > +      - mediatek,mt8183-disp-pwm
> > +      - mediatek,mt8186-disp-pwm
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    items:
> > +      - description: Main Clock
> > +      - description: Mm Clock
> > +
> > +  clock-names:
> > +    items:
> > +      - const: main
> > +      - const: mm
> > +required:
> > +  - reg
> > +  - interrupts
> > +  - clocks
> > +  - clock-names
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> > +    #include <dt-bindings/clock/mt8186-clk.h>
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    disp_pwm: disp_pwm0@1100e000 {
> > +        compatible = "mediatek,mt8183-disp-pwm";
> > +        reg = <0x1100e000 0x1000>;
> > +        interrupts = <GIC_SPI 143 IRQ_TYPE_LEVEL_HIGH>;
> > +        clocks = <&topckgen CLK_TOP_DISP_PWM>,
> > +                 <&infracfg_ao CLK_INFRA_AO_DISP_PWM>;
> > +        clock-names = "main", "mm";
> > +        status = "okay";
> > +    };
> > \ No newline at end of file
> 
> Please add this newline at EOF.
> 
> Best regards
> Uwe
> 

Hi Uwe:

Thanks for your valuable comments, I will pay more attention to the
relevant details later, and I will revise according to your comments
and submit the next version in the near future.

Best Regards,
xinlei
Rob Herring (Arm) Feb. 16, 2022, 4:06 a.m. UTC | #5 
On Mon, 14 Feb 2022 22:01:16 +0800, xinlei.lee@mediatek.com wrote:
> From: xinlei lee <xinlei.lee@mediatek.com>
> 
> Signed-off-by: xinlei lee <xinlei.lee@mediatek.com>
> ---
>  .../devicetree/bindings/pwm/pwm-mtk-disp.yaml      | 60 ++++++++++++++++++++++
>  1 file changed, 60 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-disp.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:
./Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml:60:7: [error] no new line character at the end of file (new-line-at-end-of-file)

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/pwm/pwm-mtk-disp.example.dts:20:18: fatal error: dt-bindings/clock/mt8186-clk.h: No such file or directory
   20 |         #include <dt-bindings/clock/mt8186-clk.h>
      |                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[1]: *** [scripts/Makefile.lib:378: Documentation/devicetree/bindings/pwm/pwm-mtk-disp.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1398: dt_binding_check] Error 2

doc reference errors (make refcheckdocs):

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

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.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
new file mode 100644
index 0000000..2f1183e
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.yaml
@@ -0,0 +1,60 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/pwm-mtk-disp.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: mediatek PWM Controller Device Tree Bindings
+
+maintainers:
+  - Thierry Reding <thierry.reding@gmail.com>
+  - Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
+  - Lee Jones <lee.jones@linaro.org>
+  - Rob Herring <robh+dt@kernel.org>
+
+properties:
+  compatible:
+    enum:
+      - mediatek,mt2701-disp-pwm
+      - mediatek,mt6595-disp-pwm
+      - mediatek,mt8173-disp-pwm
+      - mediatek,mt8183-disp-pwm
+      - mediatek,mt8186-disp-pwm
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: Main Clock
+      - description: Mm Clock
+
+  clock-names:
+    items:
+      - const: main
+      - const: mm
+required:
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/mt8186-clk.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    disp_pwm: disp_pwm0@1100e000 {
+        compatible = "mediatek,mt8183-disp-pwm";
+        reg = <0x1100e000 0x1000>;
+        interrupts = <GIC_SPI 143 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&topckgen CLK_TOP_DISP_PWM>,
+                 <&infracfg_ao CLK_INFRA_AO_DISP_PWM>;
+        clock-names = "main", "mm";
+        status = "okay";
+    };
\ No newline at end of file