diff mbox series

[v2,1/2] dt-bindings: pwm: convert atmel pwm to json-schema

Message ID 20220307144652.162706-2-sergiu.moga@microchip.com (mailing list archive)
State New, archived
Headers show
Series dt-bindings: pwm: convert atmel pwm to json-schema | expand

Commit Message

Sergiu Moga March 7, 2022, 2:46 p.m. UTC 
Convert PWM binding for Atmel/Microchip SoCs to Device Tree Schema
format.

Signed-off-by: Sergiu Moga <sergiu.moga@microchip.com>
---
 .../bindings/pwm/atmel,at91sam-pwm.yaml       | 42 +++++++++++++++++++
 .../devicetree/bindings/pwm/atmel-pwm.txt     | 35 ----------------
 2 files changed, 42 insertions(+), 35 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
 delete mode 100644 Documentation/devicetree/bindings/pwm/atmel-pwm.txt

Comments

Krzysztof Kozlowski March 7, 2022, 2:55 p.m. UTC | #1 
On 07/03/2022 15:46, Sergiu Moga wrote:
> Convert PWM binding for Atmel/Microchip SoCs to Device Tree Schema
> format.
> 
> Signed-off-by: Sergiu Moga <sergiu.moga@microchip.com>
> ---
>  .../bindings/pwm/atmel,at91sam-pwm.yaml       | 42 +++++++++++++++++++
>  .../devicetree/bindings/pwm/atmel-pwm.txt     | 35 ----------------
>  2 files changed, 42 insertions(+), 35 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
>  delete mode 100644 Documentation/devicetree/bindings/pwm/atmel-pwm.txt
> 
> diff --git a/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml b/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
> new file mode 100644
> index 000000000000..2d5dd51a6a55
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
> @@ -0,0 +1,42 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/atmel,at91sam-pwm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel/Microchip PWM controller
> +
> +allOf:
> +  - $ref: "pwm.yaml#"

allOf by convention should go between maintaners and properties.

> +
> +maintainers:
> +  - Claudiu Beznea <claudiu.beznea@microchip.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - atmel,at91sam9rl-pwm
> +      - atmel,sama5d3-pwm
> +      - atmel,sama5d2-pwm
> +      - microchip,sam9x60-pwm
> +
> +  reg:
> +    maxItems: 1
> +
> +  "#pwm-cells":
> +    const: 3
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: true

This has to be either additionalProperties:false or
"unevaluatedProperties:false".

> +
> +examples:
> +  - |
> +        pwm0: pwm@f8034000 {
> +                compatible = "atmel,at91sam9rl-pwm";
> +                reg = <0xf8034000 0x400>;
> +                #pwm-cells = <3>;

Also please change indentation to 2 or 4 spaces (like we use for all DTS
examples). Four is preferred (only personally).

You also need to update the path in MAINTAINERS.

Best regards,
Krzysztof
Sergiu Moga March 7, 2022, 3:24 p.m. UTC | #2 
On 07.03.2022 16:55, Krzysztof Kozlowski wrote:
> On 07/03/2022 15:46, Sergiu Moga wrote:
>> Convert PWM binding for Atmel/Microchip SoCs to Device Tree Schema
>> format.
>>
>> Signed-off-by: Sergiu Moga <sergiu.moga@microchip.com>
>> ---
>>   .../bindings/pwm/atmel,at91sam-pwm.yaml       | 42 +++++++++++++++++++
>>   .../devicetree/bindings/pwm/atmel-pwm.txt     | 35 ----------------
>>   2 files changed, 42 insertions(+), 35 deletions(-)
>>   create mode 100644 Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
>>   delete mode 100644 Documentation/devicetree/bindings/pwm/atmel-pwm.txt
>>
>> diff --git a/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml b/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
>> new file mode 100644
>> index 000000000000..2d5dd51a6a55
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
>> @@ -0,0 +1,42 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/pwm/atmel,at91sam-pwm.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Atmel/Microchip PWM controller
>> +
>> +allOf:
>> +  - $ref: "pwm.yaml#"
> allOf by convention should go between maintaners and properties.
>
Understood.

>> +
>> +maintainers:
>> +  - Claudiu Beznea <claudiu.beznea@microchip.com>
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - atmel,at91sam9rl-pwm
>> +      - atmel,sama5d3-pwm
>> +      - atmel,sama5d2-pwm
>> +      - microchip,sam9x60-pwm
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  "#pwm-cells":
>> +    const: 3
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: true
> This has to be either additionalProperties:false or
> "unevaluatedProperties:false".
>
>
Indeed, I believe `unevaluatedProperties: false` would be better here. 
Thank you.

>> +
>> +examples:
>> +  - |
>> +        pwm0: pwm@f8034000 {
>> +                compatible = "atmel,at91sam9rl-pwm";
>> +                reg = <0xf8034000 0x400>;
>> +                #pwm-cells = <3>;
> Also please change indentation to 2 or 4 spaces (like we use for all DTS
> examples). Four is preferred (only personally).
>
Noted, I will change the indentation to 4 spaces.

> You also need to update the path in MAINTAINERS.
>
Noted.

> Best regards,
> Krzysztof

Thank you for the feedback.

Sergiu
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml b/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
new file mode 100644
index 000000000000..2d5dd51a6a55
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/atmel,at91sam-pwm.yaml
@@ -0,0 +1,42 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/atmel,at91sam-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel/Microchip PWM controller
+
+allOf:
+  - $ref: "pwm.yaml#"
+
+maintainers:
+  - Claudiu Beznea <claudiu.beznea@microchip.com>
+
+properties:
+  compatible:
+    enum:
+      - atmel,at91sam9rl-pwm
+      - atmel,sama5d3-pwm
+      - atmel,sama5d2-pwm
+      - microchip,sam9x60-pwm
+
+  reg:
+    maxItems: 1
+
+  "#pwm-cells":
+    const: 3
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: true
+
+examples:
+  - |
+        pwm0: pwm@f8034000 {
+                compatible = "atmel,at91sam9rl-pwm";
+                reg = <0xf8034000 0x400>;
+                #pwm-cells = <3>;
+        };
diff --git a/Documentation/devicetree/bindings/pwm/atmel-pwm.txt b/Documentation/devicetree/bindings/pwm/atmel-pwm.txt
deleted file mode 100644
index fbb5325be1f0..000000000000
--- a/Documentation/devicetree/bindings/pwm/atmel-pwm.txt
+++ /dev/null
@@ -1,35 +0,0 @@ 
-Atmel PWM controller
-
-Required properties:
-  - compatible: should be one of:
-    - "atmel,at91sam9rl-pwm"
-    - "atmel,sama5d3-pwm"
-    - "atmel,sama5d2-pwm"
-    - "microchip,sam9x60-pwm"
-  - reg: physical base address and length of the controller's registers
-  - #pwm-cells: Should be 3. See pwm.yaml in this directory for a
-    description of the cells format.
-
-Example:
-
-	pwm0: pwm@f8034000 {
-		compatible = "atmel,at91sam9rl-pwm";
-		reg = <0xf8034000 0x400>;
-		#pwm-cells = <3>;
-	};
-
-	pwmleds {
-		compatible = "pwm-leds";
-
-		d1 {
-			label = "d1";
-			pwms = <&pwm0 3 5000 0>
-			max-brightness = <255>;
-		};
-
-		d2 {
-			label = "d2";
-			pwms = <&pwm0 1 5000 1>
-			max-brightness = <255>;
-		};
-	};