diff mbox series

dt-bindings: pxa-pwm: Convert to YAML

Message ID 20240105-pxa-pwm-yaml-v1-1-4ded9d00c38f@skole.hr
State Superseded
Headers show
Series dt-bindings: pxa-pwm: Convert to YAML | expand

Commit Message

Duje Mihanović Jan. 5, 2024, 10:50 p.m. UTC
Convert the PXA PWM binding file from TXT to YAML.

Signed-off-by: Duje Mihanović <duje.mihanovic@skole.hr>
---
 Documentation/devicetree/bindings/pwm/pwm-pxa.yaml | 51 ++++++++++++++++++++++
 Documentation/devicetree/bindings/pwm/pxa-pwm.txt  | 30 -------------
 2 files changed, 51 insertions(+), 30 deletions(-)


---
base-commit: 610a9b8f49fbcf1100716370d3b5f6f884a2835a
change-id: 20240105-pxa-pwm-yaml-8dbb00dfe7c6

Best regards,

Comments

Uwe Kleine-König Jan. 6, 2024, 12:32 p.m. UTC | #1
Hello,

On Fri, Jan 05, 2024 at 11:50:32PM +0100, Duje Mihanović wrote:
> Convert the PXA PWM binding file from TXT to YAML.
> 
> Signed-off-by: Duje Mihanović <duje.mihanovic@skole.hr>

LGTM

Reviewed-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

I'd wait for an ack by the dt people before picking this up.

Best regards
Uwe
Krzysztof Kozlowski Jan. 6, 2024, 5:01 p.m. UTC | #2
On 05/01/2024 23:50, Duje Mihanović wrote:
> Convert the PXA PWM binding file from TXT to YAML.
> 
> Signed-off-by: Duje Mihanović <duje.mihanovic@skole.hr>
> ---
>  Documentation/devicetree/bindings/pwm/pwm-pxa.yaml | 51 ++++++++++++++++++++++
>  Documentation/devicetree/bindings/pwm/pxa-pwm.txt  | 30 -------------
>  2 files changed, 51 insertions(+), 30 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/pwm/pwm-pxa.yaml b/Documentation/devicetree/bindings/pwm/pwm-pxa.yaml
> new file mode 100644
> index 000000000000..fb20e4e1daa8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/pwm-pxa.yaml

Please keep new style of naming, so:
marvell,pxa-pwm.yaml

> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/pwm-pxa.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell PXA PWM
> +
> +maintainers:
> +  - Duje Mihanović <duje.mihanovic@skole.hr>
> +
> +allOf:
> +  - $ref: pwm.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - marvell,pxa250-pwm
> +      - marvell,pxa270-pwm
> +      - marvell,pxa168-pwm
> +      - marvell,pxa910-pwm
> +
> +  reg:
> +    # Length should be 0x10
> +    maxItems: 1
> +
> +  "#pwm-cells":
> +    # Used for specifying the period length in nanoseconds
> +    const: 1
> +
> +  clocks:
> +    maxItems: 1

These were not in the original binding. Please mention briefly such
change in commit msg.


Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pwm/pwm-pxa.yaml b/Documentation/devicetree/bindings/pwm/pwm-pxa.yaml
new file mode 100644
index 000000000000..fb20e4e1daa8
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/pwm-pxa.yaml
@@ -0,0 +1,51 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/pwm-pxa.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell PXA PWM
+
+maintainers:
+  - Duje Mihanović <duje.mihanovic@skole.hr>
+
+allOf:
+  - $ref: pwm.yaml#
+
+properties:
+  compatible:
+    enum:
+      - marvell,pxa250-pwm
+      - marvell,pxa270-pwm
+      - marvell,pxa168-pwm
+      - marvell,pxa910-pwm
+
+  reg:
+    # Length should be 0x10
+    maxItems: 1
+
+  "#pwm-cells":
+    # Used for specifying the period length in nanoseconds
+    const: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - "#pwm-cells"
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/pxa-clock.h>
+
+    pwm0: pwm@40b00000 {
+      compatible = "marvell,pxa250-pwm";
+      reg = <0x40b00000 0x10>;
+      #pwm-cells = <1>;
+      clocks = <&clks CLK_PWM0>;
+    };
diff --git a/Documentation/devicetree/bindings/pwm/pxa-pwm.txt b/Documentation/devicetree/bindings/pwm/pxa-pwm.txt
deleted file mode 100644
index 5ae9f1e3c338..000000000000
--- a/Documentation/devicetree/bindings/pwm/pxa-pwm.txt
+++ /dev/null
@@ -1,30 +0,0 @@ 
-Marvell PWM controller
-
-Required properties:
-- compatible: should be one or more of:
-  - "marvell,pxa250-pwm"
-  - "marvell,pxa270-pwm"
-  - "marvell,pxa168-pwm"
-  - "marvell,pxa910-pwm"
-- reg: Physical base address and length of the registers used by the PWM channel
-  Note that one device instance must be created for each PWM that is used, so the
-  length covers only the register window for one PWM output, not that of the
-  entire PWM controller.  Currently length is 0x10 for all supported devices.
-- #pwm-cells: Should be 1.  This cell is used to specify the period in
-  nanoseconds.
-
-Example PWM device node:
-
-pwm0: pwm@40b00000 {
-	compatible = "marvell,pxa250-pwm";
-	reg = <0x40b00000 0x10>;
-	#pwm-cells = <1>;
-};
-
-Example PWM client node:
-
-backlight {
-	compatible = "pwm-backlight";
-	pwms = <&pwm0 5000000>;
-	...
-}