diff mbox series

[1/2] dt-bindings: pwm: Add dt-bindings for Nuvoton MA35D1 SoC PWM Controller

Message ID 20241018034857.568-2-cwweng.linux@gmail.com
State Superseded
Headers show
Series Add support for nuvoton ma35d1 pwm controller | expand

Commit Message

Chi-Wen Weng Oct. 18, 2024, 3:48 a.m. UTC
Add documentation to describe nuvoton ma35d1 PWM controller.

Signed-off-by: Chi-Wen Weng <cwweng.linux@gmail.com>
---
 .../bindings/pwm/nuvoton,ma35d1-pwm.yaml      | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml

Comments

Krzysztof Kozlowski Oct. 18, 2024, 6:02 a.m. UTC | #1
On 18/10/2024 05:48, Chi-Wen Weng wrote:
> Add documentation to describe nuvoton ma35d1 PWM controller.

A nit, subject: drop second/last, redundant "dt-bindings for". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

> 
> Signed-off-by: Chi-Wen Weng <cwweng.linux@gmail.com>
> ---
>  .../bindings/pwm/nuvoton,ma35d1-pwm.yaml      | 45 +++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
> 
> diff --git a/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml b/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
> new file mode 100644
> index 000000000000..95f0a0819f53
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/nuvoton,ma35d1-pwm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Nuvoton MA35D1 PWM controller
> +
> +maintainers:
> +  - Chi-Wen Weng <cwweng@nuvoton.com>
> +
> +allOf:
> +  - $ref: pwm.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - nuvoton,ma35d1-pwm
> +
> +  reg:
> +    maxItems: 2

Instead list and describe the items.

> +
> +  clocks:
> +    maxItems: 1
> +
> +  "#pwm-cells":
> +    const: 2
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/nuvoton,ma35d1-clk.h>
> +
> +    pwm0: pwm@40580000 {

Drop unused label.

> +      compatible = "nuvoton,ma35d1-pwm";
> +      reg = <0 0x40580000 0 0x400>;

But you have only one item here? No, that's just incorrect.


> +      clocks = <&clk EPWM0_GATE>;

Best regards,
Krzysztof
Chi-Wen Weng Oct. 18, 2024, 10:27 a.m. UTC | #2
Hi Krzysztof,

Thank you for your reply.

On 2024/10/18 下午 02:02, Krzysztof Kozlowski wrote:
> On 18/10/2024 05:48, Chi-Wen Weng wrote:
>> Add documentation to describe nuvoton ma35d1 PWM controller.
> A nit, subject: drop second/last, redundant "dt-bindings for". The
> "dt-bindings" prefix is already stating that these are bindings.
> See also:
> https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18
Ok. I will fix it.
>> Signed-off-by: Chi-Wen Weng <cwweng.linux@gmail.com>
>> ---
>>   .../bindings/pwm/nuvoton,ma35d1-pwm.yaml      | 45 +++++++++++++++++++
>>   1 file changed, 45 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml b/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
>> new file mode 100644
>> index 000000000000..95f0a0819f53
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
>> @@ -0,0 +1,45 @@
>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/pwm/nuvoton,ma35d1-pwm.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Nuvoton MA35D1 PWM controller
>> +
>> +maintainers:
>> +  - Chi-Wen Weng <cwweng@nuvoton.com>
>> +
>> +allOf:
>> +  - $ref: pwm.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - nuvoton,ma35d1-pwm
>> +
>> +  reg:
>> +    maxItems: 2
> Instead list and describe the items.
Sorry, it should be 1. I will fix it.
>> +
>> +  clocks:
>> +    maxItems: 1
>> +
>> +  "#pwm-cells":
>> +    const: 2
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/clock/nuvoton,ma35d1-clk.h>
>> +
>> +    pwm0: pwm@40580000 {
> Drop unused label.
Ok. I will drop it.
>> +      compatible = "nuvoton,ma35d1-pwm";
>> +      reg = <0 0x40580000 0 0x400>;
> But you have only one item here? No, that's just incorrect.
>
Ok. I will fix it.
>> +      clocks = <&clk EPWM0_GATE>;
> Best regards,
> Krzysztof

Thanks.

Chi-Wen Weng
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml b/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
new file mode 100644
index 000000000000..95f0a0819f53
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/nuvoton,ma35d1-pwm.yaml
@@ -0,0 +1,45 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/nuvoton,ma35d1-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nuvoton MA35D1 PWM controller
+
+maintainers:
+  - Chi-Wen Weng <cwweng@nuvoton.com>
+
+allOf:
+  - $ref: pwm.yaml#
+
+properties:
+  compatible:
+    enum:
+      - nuvoton,ma35d1-pwm
+
+  reg:
+    maxItems: 2
+
+  clocks:
+    maxItems: 1
+
+  "#pwm-cells":
+    const: 2
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/nuvoton,ma35d1-clk.h>
+
+    pwm0: pwm@40580000 {
+      compatible = "nuvoton,ma35d1-pwm";
+      reg = <0 0x40580000 0 0x400>;
+      clocks = <&clk EPWM0_GATE>;
+      #pwm-cells = <2>;
+    };