[PATCH v3] dt-bindings: pwm: brcm,kona-pwm: convert to YAML

[PATCH v3] dt-bindings: pwm: brcm,kona-pwm: convert to YAML

[Stanislav Jakubek]

Convert Broadcom Kona family PWM controller bindings to DT schema.

Change during conversion:
  - add used, but previously undocumented brcm,bcm11351-pwm compatible

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
---
Changes in V3:
  - change "" include in example to <>
  - rebase on next-20230616
  - collect Krzysztof's R-b

Changes in V2:
  - mention the new compatible in the commit message (Krzysztof)

 .../devicetree/bindings/pwm/brcm,kona-pwm.txt | 21 --------
 .../bindings/pwm/brcm,kona-pwm.yaml           | 51 +++++++++++++++++++
 2 files changed, 51 insertions(+), 21 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/pwm/brcm,kona-pwm.txt
 create mode 100644 Documentation/devicetree/bindings/pwm/brcm,kona-pwm.yaml

diff --git a/Documentation/devicetree/bindings/pwm/brcm,kona-pwm.txt b/Documentation/devicetree/bindings/pwm/brcm,kona-pwm.txt
deleted file mode 100644
index c42eecfc81ed..000000000000
--- a/Documentation/devicetree/bindings/pwm/brcm,kona-pwm.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-Broadcom Kona PWM controller device tree bindings
-
-This controller has 6 channels.
-
-Required Properties :
-- compatible: should contain "brcm,kona-pwm"
-- reg: physical base address and length of the controller's registers
-- clocks: phandle + clock specifier pair for the external clock
-- #pwm-cells: Should be 3. See pwm.yaml in this directory for a
-  description of the cells format.
-
-Refer to clocks/clock-bindings.txt for generic clock consumer properties.
-
-Example:
-
-pwm: pwm@3e01a000 {
-	compatible = "brcm,bcm11351-pwm", "brcm,kona-pwm";
-	reg = <0x3e01a000 0xc4>;
-	clocks = <&pwm_clk>;
-	#pwm-cells = <3>;
-};
diff --git a/Documentation/devicetree/bindings/pwm/brcm,kona-pwm.yaml b/Documentation/devicetree/bindings/pwm/brcm,kona-pwm.yaml
new file mode 100644
index 000000000000..e86c8053b366
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/brcm,kona-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/brcm,kona-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom Kona family PWM controller
+
+description:
+  This controller has 6 channels.
+
+maintainers:
+  - Florian Fainelli <f.fainelli@gmail.com>
+
+allOf:
+  - $ref: pwm.yaml#
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - brcm,bcm11351-pwm
+      - const: brcm,kona-pwm
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  '#pwm-cells':
+    const: 3
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/bcm281xx.h>
+
+    pwm@3e01a000 {
+       compatible = "brcm,bcm11351-pwm", "brcm,kona-pwm";
+       reg = <0x3e01a000 0xcc>;
+       clocks = <&slave_ccu BCM281XX_SLAVE_CCU_PWM>;
+       #pwm-cells = <3>;
+    };
+...
-- 
2.25.1

Re: [PATCH v3] dt-bindings: pwm: brcm,kona-pwm: convert to YAML

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 657 bytes --]

Hello,

On Sun, Jun 18, 2023 at 04:23:27PM +0200, Stanislav Jakubek wrote:
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - brcm,bcm11351-pwm
> +      - const: brcm,kona-pwm

This is not the simplest way to express the currently supported
combination. I assume that's done this way in the expectation that the
set of SoCs with a compatible PWM will grow?

Well, fine for me:

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

Thanks!
Uwe

-- 
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH v3] dt-bindings: pwm: brcm,kona-pwm: convert to YAML

[Florian Fainelli]

[-- Attachment #1: Type: text/plain, Size: 523 bytes --]

On 7/15/23 12:22, Uwe Kleine-König wrote:
> Hello,
> 
> On Sun, Jun 18, 2023 at 04:23:27PM +0200, Stanislav Jakubek wrote:
>> +properties:
>> +  compatible:
>> +    items:
>> +      - enum:
>> +          - brcm,bcm11351-pwm
>> +      - const: brcm,kona-pwm
> 
> This is not the simplest way to express the currently supported
> combination. I assume that's done this way in the expectation that the
> set of SoCs with a compatible PWM will grow?

The platform being completely defunct, I doubt it every will.
-- 
Florian


[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4221 bytes --]

Re: [PATCH v3] dt-bindings: pwm: brcm,kona-pwm: convert to YAML

[Thierry Reding]

On Sun, 18 Jun 2023 16:23:27 +0200, Stanislav Jakubek wrote:
> Convert Broadcom Kona family PWM controller bindings to DT schema.
> 
> Change during conversion:
>   - add used, but previously undocumented brcm,bcm11351-pwm compatible
> 
> 

Applied, thanks!

[1/1] dt-bindings: pwm: brcm,kona-pwm: convert to YAML
      commit: 8b9d91d23c18423d4e4bda735f20b669fb28115f

Best regards,
-- 
Thierry Reding <thierry.reding@gmail.com>