dt-bindings: clock: convert bcm2835-aux-clock to yaml
authorStefan Wahren <wahrenst@gmx.net>
Sat, 3 May 2025 08:09:49 +0000 (10:09 +0200)
committerStephen Boyd <sboyd@kernel.org>
Tue, 6 May 2025 21:13:01 +0000 (14:13 -0700)
Convert the DT binding document for BCM2835 auxiliary peripheral clock
from .txt to YAML.

Signed-off-by: Stefan Wahren <wahrenst@gmx.net>
Link: https://lore.kernel.org/r/20250503080949.3945-1-wahrenst@gmx.net
Acked-by: Conor Dooley <conor.dooley@microchip.com>
[sboyd@kernel.org: Drop aux label]
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
Documentation/devicetree/bindings/clock/brcm,bcm2835-aux-clock.txt [deleted file]
Documentation/devicetree/bindings/clock/brcm,bcm2835-aux-clock.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm2835-aux-clock.txt b/Documentation/devicetree/bindings/clock/brcm,bcm2835-aux-clock.txt
deleted file mode 100644 (file)
index 4acfc8f..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-Broadcom BCM2835 auxiliary peripheral support
-
-This binding uses the common clock binding:
-    Documentation/devicetree/bindings/clock/clock-bindings.txt
-
-The auxiliary peripherals (UART, SPI1, and SPI2) have a small register
-area controlling clock gating to the peripherals, and providing an IRQ
-status register.
-
-Required properties:
-- compatible:  Should be "brcm,bcm2835-aux"
-- #clock-cells:        Should be <1>. The permitted clock-specifier values can be
-                 found in include/dt-bindings/clock/bcm2835-aux.h
-- reg:         Specifies base physical address and size of the registers
-- clocks:      The parent clock phandle
-
-Example:
-
-       clocks: cprman@7e101000 {
-               compatible = "brcm,bcm2835-cprman";
-               #clock-cells = <1>;
-               reg = <0x7e101000 0x2000>;
-               clocks = <&clk_osc>;
-       };
-
-       aux: aux@7e215004 {
-               compatible = "brcm,bcm2835-aux";
-               #clock-cells = <1>;
-               reg = <0x7e215000 0x8>;
-               clocks = <&clocks BCM2835_CLOCK_VPU>;
-       };
diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm2835-aux-clock.yaml b/Documentation/devicetree/bindings/clock/brcm,bcm2835-aux-clock.yaml
new file mode 100644 (file)
index 0000000..0f4050f
--- /dev/null
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/brcm,bcm2835-aux-clock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom BCM2835 auxiliary peripheral clock
+
+maintainers:
+  - Stefan Wahren <wahrenst@gmx.net>
+  - Raspberry Pi Kernel Maintenance <kernel-list@raspberrypi.com>
+
+description:
+  The auxiliary peripherals (UART, SPI1, and SPI2) have a small register
+  area controlling clock gating to the peripherals, and providing an IRQ
+  status register.
+
+properties:
+  compatible:
+    const: brcm,bcm2835-aux
+
+  reg:
+    maxItems: 1
+
+  "#clock-cells":
+    const: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - "#clock-cells"
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/bcm2835.h>
+    clock@7e215000 {
+        compatible = "brcm,bcm2835-aux";
+        reg = <0x7e215000 0x8>;
+        #clock-cells = <1>;
+        clocks = <&clocks BCM2835_CLOCK_VPU>;
+    };