Re: [PATCH v2 2/4] dt-bindings: soc: rockchip: convert grf.txt to YAML

From: Rob Herring
Date: Fri May 07 2021 - 16:47:53 EST


On Wed, May 05, 2021 at 03:40:26PM +0200, Johan Jonker wrote:
> Current dts files with 'grf' nodes are manually verified.
> In order to automate this process grf.txt has to be
> converted to YAML.
>
> Most compatibility strings are in use with "simple-mfd" added.
>
> Add description already in use:
> "rockchip,rv1108-pmugrf", "syscon"
>
> Add new descriptions for:
> "rockchip,rk3568-grf", "syscon", "simple-mfd"
> "rockchip,rk3568-pmugrf", "syscon", "simple-mfd"
>
> Signed-off-by: Johan Jonker <jbx6244@xxxxxxxxx>
> ---
> Changed V2:
> add rockchip,rk3328-grf-gpio.yaml
> rename grf-gpio nodename
> ---
> .../devicetree/bindings/soc/rockchip/grf.txt | 61 -----
> .../devicetree/bindings/soc/rockchip/grf.yaml | 280 +++++++++++++++++++++
> 2 files changed, 280 insertions(+), 61 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/soc/rockchip/grf.txt
> create mode 100644 Documentation/devicetree/bindings/soc/rockchip/grf.yaml


> diff --git a/Documentation/devicetree/bindings/soc/rockchip/grf.yaml b/Documentation/devicetree/bindings/soc/rockchip/grf.yaml
> new file mode 100644
> index 000000000..c7916beb4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/rockchip/grf.yaml
> @@ -0,0 +1,280 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/soc/rockchip/grf.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Rockchip General Register Files (GRF)
> +
> +maintainers:
> + - Heiko Stuebner <heiko@xxxxxxxxx>
> +
> +select:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - rockchip,px30-grf
> + - rockchip,px30-pmugrf
> + - rockchip,px30-usb2phy-grf
> + - rockchip,rk3036-grf
> + - rockchip,rk3066-grf
> + - rockchip,rk3188-grf
> + - rockchip,rk3228-grf
> + - rockchip,rk3288-grf
> + - rockchip,rk3288-sgrf
> + - rockchip,rk3308-core-grf
> + - rockchip,rk3308-detect-grf
> + - rockchip,rk3308-grf
> + - rockchip,rk3328-grf
> + - rockchip,rk3328-usb2phy-grf
> + - rockchip,rk3368-grf
> + - rockchip,rk3368-pmugrf
> + - rockchip,rk3399-grf
> + - rockchip,rk3399-pmugrf
> + - rockchip,rk3568-grf
> + - rockchip,rk3568-pmugrf
> + - rockchip,rv1108-grf
> + - rockchip,rv1108-pmugrf
> + - rockchip,rv1108-usbgrf
> +
> + required:
> + - compatible

You shouldn't need 'select' here. The tools handle not matching every
syscon or simple-mfd.

> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - enum:
> + - rockchip,rk3066-grf
> + - rockchip,rk3188-grf
> + - rockchip,rk3288-sgrf
> + - rockchip,rv1108-pmugrf
> + - rockchip,rv1108-usbgrf
> + - const: syscon
> + - items:
> + - enum:
> + - rockchip,px30-grf
> + - rockchip,px30-pmugrf
> + - rockchip,px30-usb2phy-grf
> + - rockchip,rk3036-grf
> + - rockchip,rk3228-grf
> + - rockchip,rk3288-grf
> + - rockchip,rk3308-core-grf
> + - rockchip,rk3308-detect-grf
> + - rockchip,rk3308-grf
> + - rockchip,rk3328-grf
> + - rockchip,rk3328-usb2phy-grf
> + - rockchip,rk3368-grf
> + - rockchip,rk3368-pmugrf
> + - rockchip,rk3399-grf
> + - rockchip,rk3399-pmugrf
> + - rockchip,rk3568-grf
> + - rockchip,rk3568-pmugrf
> + - rockchip,rv1108-grf
> + - const: syscon
> + - const: simple-mfd
> +
> + reg:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> +
> +additionalProperties: true

Never correct for a schema defining a whole node (IOW, only correct for
collections of shared properties).

unevaluatedProperties: false

> +
> +allOf:
> + - if:
> + properties:
> + compatible:
> + contains:
> + const: rockchip,px30-grf
> +
> + then:
> + properties:
> + lvds:
> + description:
> + Documentation/devicetree/bindings/display/rockchip/rockchip-lvds.txt
> +
> + - if:
> + properties:
> + compatible:
> + contains:
> + const: rockchip,rk3288-grf
> +
> + then:
> + properties:
> + edp-phy:
> + description:
> + Documentation/devicetree/bindings/phy/rockchip-dp-phy.txt
> +
> + usbphy:
> + description:
> + Documentation/devicetree/bindings/phy/rockchip-usb-phy.txt
> +
> + - if:
> + properties:
> + compatible:
> + contains:
> + const: rockchip,rk3328-grf
> +
> + then:
> + properties:
> + gpio:
> + type: object
> +
> + $ref: "/schemas/gpio/rockchip,rk3328-grf-gpio.yaml#"
> +
> + unevaluatedProperties: false
> +
> + power-controller:
> + type: object
> +
> + $ref: "/schemas/power/rockchip,power-controller.yaml#"
> +
> + unevaluatedProperties: false
> +
> + - if:
> + properties:
> + compatible:
> + contains:
> + const: rockchip,rk3399-grf
> +
> + then:
> + properties:
> + mipi-dphy-rx0:
> + type: object
> +
> + $ref: "/schemas/phy/rockchip-mipi-dphy-rx0.yaml#"
> +
> + unevaluatedProperties: false
> +
> + pcie-phy:
> + description:
> + Documentation/devicetree/bindings/phy/rockchip-pcie-phy.txt
> +
> + patternProperties:
> + "phy@[0-9a-f]+$":
> + description:
> + Documentation/devicetree/bindings/phy/rockchip-emmc-phy.txt
> +
> + - if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - rockchip,px30-pmugrf
> + - rockchip,rk3036-grf
> + - rockchip,rk3308-grf
> + - rockchip,rk3368-pmugrf
> +
> + then:
> + properties:
> + reboot-mode:
> + type: object
> +
> + $ref: "/schemas/power/reset/syscon-reboot-mode.yaml#"
> +
> + unevaluatedProperties: false
> +
> + - if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - rockchip,px30-usb2phy-grf
> + - rockchip,rk3228-grf
> + - rockchip,rk3328-usb2phy-grf
> + - rockchip,rk3399-grf
> + - rockchip,rv1108-grf
> +
> + then:
> + properties:
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 1
> +
> + required:
> + - "#address-cells"
> + - "#size-cells"
> +
> + patternProperties:
> + "usb2-phy@[0-9a-f]+$":
> + type: object
> +
> + $ref: "/schemas/phy/phy-rockchip-inno-usb2.yaml#"
> +
> + unevaluatedProperties: false
> +
> + - if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - rockchip,px30-pmugrf
> + - rockchip,px30-grf
> + - rockchip,rk3228-grf
> + - rockchip,rk3288-grf
> + - rockchip,rk3328-grf
> + - rockchip,rk3368-pmugrf
> + - rockchip,rk3368-grf
> + - rockchip,rk3399-pmugrf
> + - rockchip,rk3399-grf
> +
> + then:
> + properties:
> + io-domains:
> + description:
> + Documentation/devicetree/bindings/power/rockchip-io-domain.txt
> +
> + unevaluatedProperties: false

These 'if' sections are probably a sign that this should be separate
schemas for each 'if' subset. But fine to leave as-is.

> +
> +examples:
> + - |
> + #include <dt-bindings/clock/rk3399-cru.h>
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/power/rk3399-power.h>
> + grf: syscon@ff770000 {
> + compatible = "rockchip,rk3399-grf", "syscon", "simple-mfd";
> + reg = <0xff770000 0x10000>;
> + #address-cells = <1>;
> + #size-cells = <1>;
> +
> + mipi_dphy_rx0: mipi-dphy-rx0 {
> + compatible = "rockchip,rk3399-mipi-dphy-rx0";
> + clocks = <&cru SCLK_MIPIDPHY_REF>,
> + <&cru SCLK_DPHY_RX0_CFG>,
> + <&cru PCLK_VIO_GRF>;
> + clock-names = "dphy-ref", "dphy-cfg", "grf";
> + power-domains = <&power RK3399_PD_VIO>;
> + #phy-cells = <0>;
> + };
> +
> + u2phy0: usb2-phy@e450 {
> + compatible = "rockchip,rk3399-usb2phy";
> + reg = <0xe450 0x10>;
> + clocks = <&cru SCLK_USB2PHY0_REF>;
> + clock-names = "phyclk";
> + #clock-cells = <0>;
> + clock-output-names = "clk_usbphy0_480m";
> + #phy-cells = <0>;
> +
> + u2phy0_host: host-port {
> + #phy-cells = <0>;
> + interrupts = <GIC_SPI 27 IRQ_TYPE_LEVEL_HIGH 0>;
> + interrupt-names = "linestate";
> + };
> +
> + u2phy0_otg: otg-port {
> + #phy-cells = <0>;
> + interrupts = <GIC_SPI 103 IRQ_TYPE_LEVEL_HIGH 0>,
> + <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH 0>,
> + <GIC_SPI 106 IRQ_TYPE_LEVEL_HIGH 0>;
> + interrupt-names = "otg-bvalid", "otg-id",
> + "linestate";
> + };
> + };
> + };
> --
> 2.11.0
>