Convert the Amlogic Always-On Clock Controller bindings to dt-schema.
Signed-off-by: Neil Armstrong <neil.armstrong@linaro.org>
---
.../bindings/clock/amlogic,gxbb-aoclkc.txt | 64 -----------
.../bindings/clock/amlogic,gxbb-aoclkc.yaml | 120 +++++++++++++++++++++
2 files changed, 120 insertions(+), 64 deletions(-)
diff --git a/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.txt b/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.txt
deleted file mode 100644
index c41f0be5d438..000000000000
--- a/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.txt
+++ /dev/null
@@ -1,64 +0,0 @@
-* Amlogic GXBB AO Clock and Reset Unit
-
-The Amlogic GXBB AO clock controller generates and supplies clock to various
-controllers within the Always-On part of the SoC.
-
-Required Properties:
-
-- compatible: value should be different for each SoC family as :
- - GXBB (S905) : "amlogic,meson-gxbb-aoclkc"
- - GXL (S905X, S905D) : "amlogic,meson-gxl-aoclkc"
- - GXM (S912) : "amlogic,meson-gxm-aoclkc"
- - AXG (A113D, A113X) : "amlogic,meson-axg-aoclkc"
- - G12A (S905X2, S905D2, S905Y2) : "amlogic,meson-g12a-aoclkc"
- followed by the common "amlogic,meson-gx-aoclkc"
-- clocks: list of clock phandle, one for each entry clock-names.
-- clock-names: should contain the following:
- * "xtal" : the platform xtal
- * "mpeg-clk" : the main clock controller mother clock (aka clk81)
- * "ext-32k-0" : external 32kHz reference #0 if any (optional)
- * "ext-32k-1" : external 32kHz reference #1 if any (optional - gx only)
- * "ext-32k-2" : external 32kHz reference #2 if any (optional - gx only)
-
-- #clock-cells: should be 1.
-
-Each clock is assigned an identifier and client nodes can use this identifier
-to specify the clock which they consume. All available clocks are defined as
-preprocessor macros in the dt-bindings/clock/gxbb-aoclkc.h header and can be
-used in device tree sources.
-
-- #reset-cells: should be 1.
-
-Each reset is assigned an identifier and client nodes can use this identifier
-to specify the reset which they consume. All available resets are defined as
-preprocessor macros in the dt-bindings/reset/gxbb-aoclkc.h header and can be
-used in device tree sources.
-
-Parent node should have the following properties :
-- compatible: "amlogic,meson-gx-ao-sysctrl", "syscon", "simple-mfd"
-- reg: base address and size of the AO system control register space.
-
-Example: AO Clock controller node:
-
-ao_sysctrl: sys-ctrl@0 {
- compatible = "amlogic,meson-gx-ao-sysctrl", "syscon", "simple-mfd";
- reg = <0x0 0x0 0x0 0x100>;
-
- clkc_AO: clock-controller {
- compatible = "amlogic,meson-gxbb-aoclkc", "amlogic,meson-gx-aoclkc";
- #clock-cells = <1>;
- #reset-cells = <1>;
- clocks = <&xtal>, <&clkc CLKID_CLK81>;
- clock-names = "xtal", "mpeg-clk";
- };
-
-Example: UART controller node that consumes the clock and reset generated
- by the clock controller:
-
- uart_AO: serial@4c0 {
- compatible = "amlogic,meson-uart";
- reg = <0x4c0 0x14>;
- interrupts = <0 90 1>;
- clocks = <&clkc_AO CLKID_AO_UART1>;
- resets = <&clkc_AO RESET_AO_UART1>;
- };
diff --git a/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.yaml b/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.yaml
new file mode 100644
index 000000000000..3ac432a112ca
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.yaml
@@ -0,0 +1,120 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/amlogic,gxbb-aoclkc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Amlogic Always-On Clock Controller
+
+maintainers:
+ - Neil Armstrong <neil.armstrong@linaro.org>
+
+properties:
+ compatible:
+ oneOf:
+ - items:
+ - enum:
+ - amlogic,meson-gxbb-aoclkc
+ - amlogic,meson-gxl-aoclkc
+ - amlogic,meson-gxm-aoclkc
+ - amlogic,meson-axg-aoclkc
+ - const: amlogic,meson-gx-aoclkc
+ - items:
+ - enum:
+ - amlogic,meson-axg-aoclkc
+ - amlogic,meson-g12a-aoclkc
+
+ clocks:
+ minItems: 2
+
+ clock-names:
+ minItems: 2
+
+ '#clock-cells':
+ const: 1
+
+ '#reset-cells':
+ const: 1
+
+required:
+ - compatible
+ - clocks
+ - clock-names
+ - '#clock-cells'
+ - '#reset-cells'
+
+allOf:
+ - if:
+ properties:
+ compatible:
+ enum:
+ - amlogic,meson-gxbb-clkc
+
+ then:
+ properties:
+ clocks:
+ minItems: 2
+ maxItems: 5
+
+ clock-names:
+ minItems: 2
+ items:
+ - const: xtal
+ - const: mpeg-clk
+ - const: ext-32k-0
+ - const: ext-32k-1
+ - const: ext-32k-2
+
+ - if:
+ properties:
+ compatible:
+ enum:
+ - amlogic,meson-g12a-aoclkc
+
+ then:
+ properties:
+ clocks:
+ minItems: 2
+ maxItems: 3
+
+ clock-names:
+ minItems: 2
+ items:
+ - const: xtal
+ - const: mpeg-clk
+ - const: ext-32k-0
+
+ - if:
+ properties:
+ compatible:
+ enum:
+ - amlogic,meson-gxl-clkc
+ - amlogic,meson-gxm-clkc
+ - amlogic,meson-axg-clkc
+
+ then:
+ properties:
+ clocks:
+ maxItems: 2
+
+ clock-names:
+ items:
+ - const: xtal
+ - const: mpeg-clk
+
+additionalProperties: false
+
+examples:
+ - |
+ sysctrl: system-controller@0 {
+ compatible = "amlogic,meson-gx-ao-sysctrl", "simple-mfd", "syscon";
+ reg = <0 0x100>;
+
+ clkc: clock-controller {
+ compatible = "amlogic,meson-gxbb-aoclkc", "amlogic,meson-gx-aoclkc";
+ #clock-cells = <1>;
+ #reset-cells = <1>;
+ clocks = <&xtal>, <&clk81>;
+ clock-names = "xtal", "mpeg-clk";
+ };
+ };
--
2.34.1On 09/02/2023 14:41, Neil Armstrong wrote:
> Convert the Amlogic Always-On Clock Controller bindings to dt-schema.
Subject prefix: clock, not soc
>
> Signed-off-by: Neil Armstrong <neil.armstrong@linaro.org>
> ---
> .../bindings/clock/amlogic,gxbb-aoclkc.txt | 64 -----------
> .../bindings/clock/amlogic,gxbb-aoclkc.yaml | 120 +++++++++++++++++++++
> 2 files changed, 120 insertions(+), 64 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.txt b/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.txt
> deleted file mode 100644
> index c41f0be5d438..000000000000
> --- a/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.txt
> +++ /dev/null
> @@ -1,64 +0,0 @@
> -* Amlogic GXBB AO Clock and Reset Unit
> -
> -The Amlogic GXBB AO clock controller generates and supplies clock to various
> -controllers within the Always-On part of the SoC.
> -
> -Required Properties:
> -
> -- compatible: value should be different for each SoC family as :
> - - GXBB (S905) : "amlogic,meson-gxbb-aoclkc"
> - - GXL (S905X, S905D) : "amlogic,meson-gxl-aoclkc"
> - - GXM (S912) : "amlogic,meson-gxm-aoclkc"
> - - AXG (A113D, A113X) : "amlogic,meson-axg-aoclkc"
> - - G12A (S905X2, S905D2, S905Y2) : "amlogic,meson-g12a-aoclkc"
> - followed by the common "amlogic,meson-gx-aoclkc"
> -- clocks: list of clock phandle, one for each entry clock-names.
> -- clock-names: should contain the following:
> - * "xtal" : the platform xtal
> - * "mpeg-clk" : the main clock controller mother clock (aka clk81)
> - * "ext-32k-0" : external 32kHz reference #0 if any (optional)
> - * "ext-32k-1" : external 32kHz reference #1 if any (optional - gx only)
> - * "ext-32k-2" : external 32kHz reference #2 if any (optional - gx only)
> -
> -- #clock-cells: should be 1.
> -
> -Each clock is assigned an identifier and client nodes can use this identifier
> -to specify the clock which they consume. All available clocks are defined as
> -preprocessor macros in the dt-bindings/clock/gxbb-aoclkc.h header and can be
> -used in device tree sources.
> -
> -- #reset-cells: should be 1.
> -
> -Each reset is assigned an identifier and client nodes can use this identifier
> -to specify the reset which they consume. All available resets are defined as
> -preprocessor macros in the dt-bindings/reset/gxbb-aoclkc.h header and can be
> -used in device tree sources.
> -
> -Parent node should have the following properties :
> -- compatible: "amlogic,meson-gx-ao-sysctrl", "syscon", "simple-mfd"
> -- reg: base address and size of the AO system control register space.
> -
> -Example: AO Clock controller node:
> -
> -ao_sysctrl: sys-ctrl@0 {
> - compatible = "amlogic,meson-gx-ao-sysctrl", "syscon", "simple-mfd";
> - reg = <0x0 0x0 0x0 0x100>;
> -
> - clkc_AO: clock-controller {
> - compatible = "amlogic,meson-gxbb-aoclkc", "amlogic,meson-gx-aoclkc";
> - #clock-cells = <1>;
> - #reset-cells = <1>;
> - clocks = <&xtal>, <&clkc CLKID_CLK81>;
> - clock-names = "xtal", "mpeg-clk";
> - };
> -
> -Example: UART controller node that consumes the clock and reset generated
> - by the clock controller:
> -
> - uart_AO: serial@4c0 {
> - compatible = "amlogic,meson-uart";
> - reg = <0x4c0 0x14>;
> - interrupts = <0 90 1>;
> - clocks = <&clkc_AO CLKID_AO_UART1>;
> - resets = <&clkc_AO RESET_AO_UART1>;
> - };
> diff --git a/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.yaml b/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.yaml
> new file mode 100644
> index 000000000000..3ac432a112ca
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/amlogic,gxbb-aoclkc.yaml
> @@ -0,0 +1,120 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/clock/amlogic,gxbb-aoclkc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Amlogic Always-On Clock Controller
> +
> +maintainers:
> + - Neil Armstrong <neil.armstrong@linaro.org>
> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - enum:
> + - amlogic,meson-gxbb-aoclkc
> + - amlogic,meson-gxl-aoclkc
> + - amlogic,meson-gxm-aoclkc
> + - amlogic,meson-axg-aoclkc
> + - const: amlogic,meson-gx-aoclkc
> + - items:
Drop this "items"
> + - enum:
> + - amlogic,meson-axg-aoclkc
This does not look correct. Either this is standalone compatible or
followed with a fallback.
> + - amlogic,meson-g12a-aoclkc
> +
> + clocks:
> + minItems: 2
maxItems instead... or you wanted to define constraints? Then you need
min and maxItems.
> +
> + clock-names:
> + minItems: 2
ditto
> +
> + '#clock-cells':
> + const: 1
> +
> + '#reset-cells':
> + const: 1
> +
> +required:
> + - compatible
> + - clocks
> + - clock-names
> + - '#clock-cells'
> + - '#reset-cells'
> +
> +allOf:
> + - if:
> + properties:
> + compatible:
> + enum:
> + - amlogic,meson-gxbb-clkc
This won't work. Test it... It's not even documented.
> +
> + then:
> + properties:
> + clocks:
> + minItems: 2
> + maxItems: 5
> +
> + clock-names:
> + minItems: 2
> + items:
> + - const: xtal
> + - const: mpeg-clk
> + - const: ext-32k-0
> + - const: ext-32k-1
> + - const: ext-32k-2
> +
> + - if:
> + properties:
> + compatible:
> + enum:
> + - amlogic,meson-g12a-aoclkc
> +
> + then:
> + properties:
> + clocks:
> + minItems: 2
> + maxItems: 3
> +
> + clock-names:
> + minItems: 2
> + items:
> + - const: xtal
> + - const: mpeg-clk
> + - const: ext-32k-0
> +
> + - if:
> + properties:
> + compatible:
> + enum:
> + - amlogic,meson-gxl-clkc
Another set of undocumented compatibles. There is no way this binding is
doing what it is supposed to do.
> + - amlogic,meson-gxm-clkc
> + - amlogic,meson-axg-clkc
> +
> + then:
> + properties:
> + clocks:
> + maxItems: 2
> +
> + clock-names:
> + items:
> + - const: xtal
> + - const: mpeg-clk
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + sysctrl: system-controller@0 {
> + compatible = "amlogic,meson-gx-ao-sysctrl", "simple-mfd", "syscon";
> + reg = <0 0x100>;
Drop parent node.
> +
> + clkc: clock-controller {
> + compatible = "amlogic,meson-gxbb-aoclkc", "amlogic,meson-gx-aoclkc";
> + #clock-cells = <1>;
> + #reset-cells = <1>;
> + clocks = <&xtal>, <&clk81>;
> + clock-names = "xtal", "mpeg-clk";
> + };
> + };
>
Best regards,
Krzysztof
© 2016 - 2026 Red Hat, Inc.