[PATCH] dt-bindings: serial: brcm,bcm2835-aux-uart: convert to dtschema

[PATCH] dt-bindings: serial: brcm,bcm2835-aux-uart: convert to dtschema

[Pratik Farkase]

Convert the Broadcom BCM2835 Auxiliar UART to newer DT schema.
Created DT schema based on the .txt file which had
`compatible`, `reg` `clocks` and `interrupts` as the
required properties. This binding is used by Broadcom BCM2835
SOC used in some Raspberry PI boards.
Changes from original file:
Implemented complete example which the original txt binding lacked.

Signed-off-by: Pratik Farkase <pratik.farkase@wsisweden.com>
---
 .../bindings/serial/brcm,bcm2835-aux-uart.txt | 18 --------
 .../serial/brcm,bcm2835-aux-uart.yaml         | 46 +++++++++++++++++++
 2 files changed, 46 insertions(+), 18 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt
 create mode 100644 Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml

diff --git a/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt b/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt
deleted file mode 100644
index b5cc6297cd1b..000000000000
--- a/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-* BCM2835 AUXILIAR UART
-
-Required properties:
-
-- compatible: "brcm,bcm2835-aux-uart"
-- reg: The base address of the UART register bank.
-- interrupts: A single interrupt specifier.
-- clocks: Clock driving the hardware; used to figure out the baud rate
-  divisor.
-
-Example:
-
-	uart1: serial@7e215040 {
-		compatible = "brcm,bcm2835-aux-uart";
-		reg = <0x7e215040 0x40>;
-		interrupts = <1 29>;
-		clocks = <&aux BCM2835_AUX_CLOCK_UART>;
-	};
diff --git a/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml b/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml
new file mode 100644
index 000000000000..c52ba2e33f28
--- /dev/null
+++ b/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml
@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/serial/brcm,bcm2835-aux-uart.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: BCM2835 AUXILIAR UART
+
+maintainers:
+  - Pratik Farkase <pratikfarkase94@gmail.com>
+
+allOf:
+  - $ref: serial.yaml
+
+properties:
+  compatible:
+    const: brcm,bcm2835-aux-uart
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/bcm2835.h>
+    #include <dt-bindings/clock/bcm2835-aux.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    uart1: serial@7e215040 {
+        compatible = "brcm,bcm2835-aux-uart";
+        reg = <0x7e215040 0x40>;
+        interrupts = <1 29>;
+        clocks = <&aux BCM2835_AUX_CLOCK_UART>;
+    };
-- 
2.34.1

Re: [PATCH] dt-bindings: serial: brcm,bcm2835-aux-uart: convert to dtschema

[Florian Fainelli]

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



On 4/15/2024 8:00 AM, Pratik Farkase wrote:
> Convert the Broadcom BCM2835 Auxiliar UART to newer DT schema.
> Created DT schema based on the .txt file which had
> `compatible`, `reg` `clocks` and `interrupts` as the
> required properties. This binding is used by Broadcom BCM2835
> SOC used in some Raspberry PI boards.
> Changes from original file:
> Implemented complete example which the original txt binding lacked.
> 
> Signed-off-by: Pratik Farkase <pratik.farkase@wsisweden.com>
> ---
>   .../bindings/serial/brcm,bcm2835-aux-uart.txt | 18 --------
>   .../serial/brcm,bcm2835-aux-uart.yaml         | 46 +++++++++++++++++++
>   2 files changed, 46 insertions(+), 18 deletions(-)
>   delete mode 100644 Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt
>   create mode 100644 Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml
> 
> diff --git a/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt b/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt
> deleted file mode 100644
> index b5cc6297cd1b..000000000000
> --- a/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.txt
> +++ /dev/null
> @@ -1,18 +0,0 @@
> -* BCM2835 AUXILIAR UART
> -
> -Required properties:
> -
> -- compatible: "brcm,bcm2835-aux-uart"
> -- reg: The base address of the UART register bank.
> -- interrupts: A single interrupt specifier.
> -- clocks: Clock driving the hardware; used to figure out the baud rate
> -  divisor.
> -
> -Example:
> -
> -	uart1: serial@7e215040 {
> -		compatible = "brcm,bcm2835-aux-uart";
> -		reg = <0x7e215040 0x40>;
> -		interrupts = <1 29>;
> -		clocks = <&aux BCM2835_AUX_CLOCK_UART>;
> -	};
> diff --git a/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml b/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml
> new file mode 100644
> index 000000000000..c52ba2e33f28
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/brcm,bcm2835-aux-uart.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/serial/brcm,bcm2835-aux-uart.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: BCM2835 AUXILIAR UART

AUXILIARY (it was already a typo in the previous binding document, but 
let's fix it).

> +
> +maintainers:
> +  - Pratik Farkase <pratikfarkase94@gmail.com>

Could you also add Stefan Wahren and myself to this list?

> +
> +allOf:
> +  - $ref: serial.yaml
> +
> +properties:
> +  compatible:
> +    const: brcm,bcm2835-aux-uart
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/bcm2835.h>
> +    #include <dt-bindings/clock/bcm2835-aux.h>
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    uart1: serial@7e215040 {
> +        compatible = "brcm,bcm2835-aux-uart";
> +        reg = <0x7e215040 0x40>;
> +        interrupts = <1 29>;
> +        clocks = <&aux BCM2835_AUX_CLOCK_UART>;
> +    };

-- 
Florian

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