Re: [PATCH] dt-bindings: usb: dwc3: Move Amlogic G12A DWC3 Glue Bindings to YAML schemas

From: Rob Herring
Date: Tue Oct 29 2019 - 12:00:44 EST

On Mon, Oct 21, 2019 at 03:23:22PM +0200, Neil Armstrong wrote:
> Now that we have the DT validation in place, let's convert the device tree
> bindings for the Amlogic G12A DWC3 Glue Bindings over to a YAML schemas,
> the AXG and GXL glue bindings will be converted later.
>
> Signed-off-by: Neil Armstrong <narmstrong@xxxxxxxxxxxx>
> ---
> .../devicetree/bindings/usb/amlogic,dwc3.txt | 88 ------------
> .../usb/amlogic,meson-g12a-usb-ctrl.yaml | 132 ++++++++++++++++++
> 2 files changed, 132 insertions(+), 88 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
>
> diff --git a/Documentation/devicetree/bindings/usb/amlogic,dwc3.txt b/Documentation/devicetree/bindings/usb/amlogic,dwc3.txt
> index b9f04e617eb7..9a8b631904fd 100644
> --- a/Documentation/devicetree/bindings/usb/amlogic,dwc3.txt
> +++ b/Documentation/devicetree/bindings/usb/amlogic,dwc3.txt
> @@ -40,91 +40,3 @@ Example device nodes:
> phy-names = "usb2-phy", "usb3-phy";
> };
> };
> -
> -Amlogic Meson G12A DWC3 USB SoC Controller Glue
> -
> -The Amlogic G12A embeds a DWC3 USB IP Core configured for USB2 and USB3
> -in host-only mode, and a DWC2 IP Core configured for USB2 peripheral mode
> -only.
> -
> -A glue connects the DWC3 core to USB2 PHYs and optionnaly to an USB3 PHY.
> -
> -One of the USB2 PHY can be re-routed in peripheral mode to a DWC2 USB IP.
> -
> -The DWC3 Glue controls the PHY routing and power, an interrupt line is
> -connected to the Glue to serve as OTG ID change detection.
> -
> -Required properties:
> -- compatible: Should be "amlogic,meson-g12a-usb-ctrl"
> -- clocks: a handle for the "USB" clock
> -- resets: a handle for the shared "USB" reset line
> -- reg: The base address and length of the registers
> -- interrupts: the interrupt specifier for the OTG detection
> -- phys: handle to used PHYs on the system
> - - a <0> phandle can be used if a PHY is not used
> -- phy-names: names of the used PHYs on the system :
> - - "usb2-phy0" for USB2 PHY0 if USBHOST_A port is used
> - - "usb2-phy1" for USB2 PHY1 if USBOTG_B port is used
> - - "usb3-phy0" for USB3 PHY if USB3_0 is used
> -- dr_mode: should be "host", "peripheral", or "otg" depending on
> - the usage and configuration of the OTG Capable port.
> - - "host" and "peripheral" means a fixed Host or Device only connection
> - - "otg" means the port can be used as both Host or Device and
> - be switched automatically using the OTG ID pin.
> -
> -Optional properties:
> -- vbus-supply: should be a phandle to the regulator controlling the VBUS
> - power supply when used in OTG switchable mode
> -
> -Required child nodes:
> -
> -A child node must exist to represent the core DWC3 IP block. The name of
> -the node is not important. The content of the node is defined in dwc3.txt.
> -
> -A child node must exist to represent the core DWC2 IP block. The name of
> -the node is not important. The content of the node is defined in dwc2.txt.
> -
> -PHY documentation is provided in the following places:
> -- Documentation/devicetree/bindings/phy/meson-g12a-usb2-phy.txt
> -- Documentation/devicetree/bindings/phy/meson-g12a-usb3-pcie-phy.txt
> -
> -Example device nodes:
> - usb: usb@ffe09000 {
> - compatible = "amlogic,meson-g12a-usb-ctrl";
> - reg = <0x0 0xffe09000 0x0 0xa0>;
> - interrupts = <GIC_SPI 16 IRQ_TYPE_LEVEL_HIGH>;
> - #address-cells = <2>;
> - #size-cells = <2>;
> - ranges;
> -
> - clocks = <&clkc CLKID_USB>;
> - resets = <&reset RESET_USB>;
> -
> - dr_mode = "otg";
> -
> - phys = <&usb2_phy0>, <&usb2_phy1>,
> - <&usb3_pcie_phy PHY_TYPE_USB3>;
> - phy-names = "usb2-phy0", "usb2-phy1", "usb3-phy0";
> -
> - dwc2: usb@ff400000 {
> - compatible = "amlogic,meson-g12a-usb", "snps,dwc2";
> - reg = <0x0 0xff400000 0x0 0x40000>;
> - interrupts = <GIC_SPI 31 IRQ_TYPE_LEVEL_HIGH>;
> - clocks = <&clkc CLKID_USB1_DDR_BRIDGE>;
> - clock-names = "ddr";
> - phys = <&usb2_phy1>;
> - dr_mode = "peripheral";
> - g-rx-fifo-size = <192>;
> - g-np-tx-fifo-size = <128>;
> - g-tx-fifo-size = <128 128 16 16 16>;
> - };
> -
> - dwc3: usb@ff500000 {
> - compatible = "snps,dwc3";
> - reg = <0x0 0xff500000 0x0 0x100000>;
> - interrupts = <GIC_SPI 30 IRQ_TYPE_LEVEL_HIGH>;
> - dr_mode = "host";
> - snps,dis_u2_susphy_quirk;
> - snps,quirk-frame-length-adjustment;
> - };
> - };
> diff --git a/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml b/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
> new file mode 100644
> index 000000000000..45bcc98ee9a4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
> @@ -0,0 +1,132 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2019 BayLibre, SAS
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/usb/amlogic,meson-g12a-usb-ctrl.yaml#";
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> +
> +title: Amlogic Meson G12A DWC3 USB SoC Controller Glue
> +
> +maintainers:
> + - Neil Armstrong <narmstrong@xxxxxxxxxxxx>
> +
> +description: |
> + The Amlogic G12A embeds a DWC3 USB IP Core configured for USB2 and USB3
> + in host-only mode, and a DWC2 IP Core configured for USB2 peripheral mode
> + only.
> +
> + A glue connects the DWC3 core to USB2 PHYs and optionnaly to an USB3 PHY.
> +
> + One of the USB2 PHY can be re-routed in peripheral mode to a DWC2 USB IP.
> +
> + The DWC3 Glue controls the PHY routing and power, an interrupt line is
> + connected to the Glue to serve as OTG ID change detection.
> +
> +properties:
> + compatible:
> + enum:
> + - amlogic,meson-g12a-usb-ctrl
> +
> + ranges: true
> +
> + "#address-cells":
> + enum: [ 1, 2 ]
> +
> + "#size-cells":
> + enum: [ 1, 2 ]
> +
> + clocks:
> + minItems: 1
> +
> + resets:
> + minItems: 1
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + phy-names:
> + items:
> + - const: usb2-phy0 # USB2 PHY0 if USBHOST_A port is used
> + - const: usb2-phy1 # USB2 PHY1 if USBOTG_B port is used
> + - const: usb3-phy0 # USB3 PHY if USB3_0 is used
> +
> + phys:
> + minItems: 1
> + maxItems: 3
> +
> + dr_mode:
> + enum:
> + - host # fixed Host connection
> + - peripheral # fixed Device connection
> + - otg # Host or Device and switched automatically using the OTG ID pin

This should have a common definition. You can assume it does, so you
just need 'true'.

> +
> + power-domains:
> + maxItems: 1
> +
> + vbus-supply:
> + description: VBUS power supply when used in OTG switchable mode
> + maxItems: 1
> +
> +patternProperties:
> + "^usb@[0-9a-f]+$":
> + type: object
> +
> +additionalProperties: false
> +
> +required:
> + - compatible
> + - "#address-cells"
> + - "#size-cells"
> + - ranges
> + - clocks
> + - resets
> + - reg
> + - interrupts
> + - phy-names
> + - phys
> + - dr_mode
> +
> +examples:
> + - |
> + usb: usb@ffe09000 {
> + compatible = "amlogic,meson-g12a-usb-ctrl";
> + reg = <0x0 0xffe09000 0x0 0xa0>;
> + interrupts = <16>;
> + #address-cells = <1>;
> + #size-cells = <1>;
> + ranges;
> +
> + clocks = <&clkc_usb>;
> + resets = <&reset_usb>;
> +
> + dr_mode = "otg";
> +
> + phys = <&usb2_phy0>, <&usb2_phy1>, <&usb3_phy0>;
> + phy-names = "usb2-phy0", "usb2-phy1", "usb3-phy0";
> +
> + dwc2: usb@ff400000 {
> + compatible = "amlogic,meson-g12a-usb", "snps,dwc2";
> + reg = <0xff400000 0x40000>;
> + interrupts = <31>;
> + clocks = <&clkc_usb1>;
> + clock-names = "ddr";
> + phys = <&usb2_phy1>;
> + dr_mode = "peripheral";

However, it seems folks just put 'dr_mode' where ever they please. I saw
one in usb phy yesterday. Just a comment, not really anything for you to
change here...

> + g-rx-fifo-size = <192>;
> + g-np-tx-fifo-size = <128>;
> + g-tx-fifo-size = <128 128 16 16 16>;
> + };
> +
> + dwc3: usb@ff500000 {
> + compatible = "snps,dwc3";
> + reg = <0xff500000 0x100000>;
> + interrupts = <30>;
> + dr_mode = "host";
> + snps,dis_u2_susphy_quirk;
> + snps,quirk-frame-length-adjustment;
> + };
> + };
> +
> --
> 2.22.0
>