[2/2] dt-bindings: usb: tegra: Convert to json-schema

From: Thierry Reding <treding@nvidia.com>

Convert the old plain-text device tree bindings for the USB EHCI
controller found on NVIDIA Tegra SoCs to the json-schema format.

Signed-off-by: Thierry Reding <treding@nvidia.com>
---
 .../bindings/usb/nvidia,tegra20-ehci.txt      |  23 ---
 .../bindings/usb/nvidia,tegra20-ehci.yaml     | 151 ++++++++++++++++++
 2 files changed, 151 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.txt
 create mode 100644 Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml

On Mon, 21 Jun 2021 16:15:59 +0200, Thierry Reding wrote:
> From: Thierry Reding <treding@nvidia.com>
> 
> Convert the old plain-text device tree bindings for the USB EHCI
> controller found on NVIDIA Tegra SoCs to the json-schema format.
> 
> Signed-off-by: Thierry Reding <treding@nvidia.com>
> ---
>  .../bindings/usb/nvidia,tegra20-ehci.txt      |  23 ---
>  .../bindings/usb/nvidia,tegra20-ehci.yaml     | 151 ++++++++++++++++++
>  2 files changed, 151 insertions(+), 23 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml:22:9: [warning] wrong indentation: expected 10 but found 8 (indentation)
./Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml:23:11: [warning] wrong indentation: expected 12 but found 10 (indentation)
./Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml:28:9: [warning] wrong indentation: expected 10 but found 8 (indentation)
./Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml:30:9: [warning] wrong indentation: expected 10 but found 8 (indentation)

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.example.dt.yaml: usb@7d000000: 'clock-names' does not match any of the regexes: 'pinctrl-[0-9]+'
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml
\ndoc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1495151

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.

On Mon, Jun 21, 2021 at 04:15:59PM +0200, Thierry Reding wrote:
> From: Thierry Reding <treding@nvidia.com>
> 
> Convert the old plain-text device tree bindings for the USB EHCI
> controller found on NVIDIA Tegra SoCs to the json-schema format.
> 
> Signed-off-by: Thierry Reding <treding@nvidia.com>
> ---
>  .../bindings/usb/nvidia,tegra20-ehci.txt      |  23 ---
>  .../bindings/usb/nvidia,tegra20-ehci.yaml     | 151 ++++++++++++++++++
>  2 files changed, 151 insertions(+), 23 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.txt b/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.txt
> deleted file mode 100644
> index f60785f73d3d..000000000000
> --- a/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.txt
> +++ /dev/null
> @@ -1,23 +0,0 @@
> -Tegra SOC USB controllers
> -
> -The device node for a USB controller that is part of a Tegra
> -SOC is as described in the document "Open Firmware Recommended
> -Practice : Universal Serial Bus" with the following modifications
> -and additions :
> -
> -Required properties :
> - - compatible : For Tegra20, must contain "nvidia,tegra20-ehci".
> -   For Tegra30, must contain "nvidia,tegra30-ehci".  Otherwise, must contain
> -   "nvidia,<chip>-ehci" plus at least one of the above, where <chip> is
> -   tegra114, tegra124, tegra132, or tegra210.
> - - nvidia,phy : phandle of the PHY that the controller is connected to.
> - - clocks : Must contain one entry, for the module clock.
> -   See ../clocks/clock-bindings.txt for details.
> - - resets : Must contain an entry for each entry in reset-names.
> -   See ../reset/reset.txt for details.
> - - reset-names : Must include the following entries:
> -   - usb
> -
> -Optional properties:
> - - nvidia,needs-double-reset : boolean is to be set for some of the Tegra20
> -   USB ports, which need reset twice due to hardware issues.
> diff --git a/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml b/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml
> new file mode 100644
> index 000000000000..3d942f598eac
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/nvidia,tegra20-ehci.yaml
> @@ -0,0 +1,151 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/usb/nvidia,tegra20-ehci.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Device tree binding for NVIDIA Tegra USB controllers
> +
> +description: |
> +  The device node for a USB controller that is part of a Tegra SOC is as
> +  described in the document "Open Firmware Recommended Practice : Universal
> +  Serial Bus". Modifications and additions are detailed in this document.
> +
> +maintainers:
> +  - Thierry Reding <treding@nvidia.com>
> +  - Jon Hunter <jonathanh@nvidia.com>
> +

This should reference usb-hcd.yaml.

> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +        - enum:
> +          - nvidia,tegra210-ehci
> +          - nvidia,tegra124-ehci
> +          - nvidia,tegra114-ehci
> +        - const: nvidia,tegra30-ehci
> +      - items:
> +        - const: nvidia,tegra30-ehci
> +      - items:
> +        - const: nvidia,tegra20-ehci
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  phy_type:
> +    $ref: /schemas/types.yaml#/definitions/string

This is covered by usb-hcd.yaml. You may want to constrain it to only 
the types supported.

> +
> +  clocks:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1
> +
> +  reset-names:
> +    items:
> +      - const: usb
> +
> +  nvidia,phy:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description:
> +      phandle of the PHY that the controller is connected to
> +
> +  nvidia,needs-double-reset:
> +    type: boolean
> +    description:
> +      This must be set for some instances of the USB controller found on
> +      Tegra20 that need to be reset twice due to some hardware issue.
> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - resets
> +  - reset-names
> +  - phy_type
> +  - nvidia,phy
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/tegra20-car.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    usb@c5000000 {
> +        compatible = "nvidia,tegra20-ehci";
> +        reg = <0xc5000000 0x4000>;
> +        interrupts = <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> +        phy_type = "utmi";
> +        clocks = <&tegra_car TEGRA20_CLK_USBD>;
> +        resets = <&tegra_car 22>;
> +        reset-names = "usb";
> +        nvidia,needs-double-reset;
> +        nvidia,phy = <&phy1>;
> +    };
> +
> +  - |
> +    #include <dt-bindings/clock/tegra30-car.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    usb@7d000000 {
> +        compatible = "nvidia,tegra30-ehci";
> +        reg = <0x7d000000 0x4000>;
> +        interrupts = <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> +        phy_type = "utmi";
> +        clocks = <&tegra_car TEGRA30_CLK_USBD>;
> +        resets = <&tegra_car 22>;
> +        reset-names = "usb";
> +        nvidia,needs-double-reset;
> +        nvidia,phy = <&phy1>;
> +    };
> +
> +  - |
> +    #include <dt-bindings/clock/tegra114-car.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    usb@7d000000 {
> +        compatible = "nvidia,tegra114-ehci", "nvidia,tegra30-ehci";
> +        reg = <0x7d000000 0x4000>;
> +        interrupts = <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> +        phy_type = "utmi";
> +        clocks = <&tegra_car TEGRA114_CLK_USBD>;
> +        resets = <&tegra_car 22>;
> +        reset-names = "usb";
> +        nvidia,phy = <&phy1>;
> +    };
> +
> +  - |
> +    #include <dt-bindings/clock/tegra124-car.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    usb@7d000000 {
> +        compatible = "nvidia,tegra124-ehci", "nvidia,tegra30-ehci";
> +        reg = <0x7d000000 0x4000>;
> +        interrupts = <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> +        phy_type = "utmi";
> +        clocks = <&tegra_car TEGRA124_CLK_USBD>;
> +        resets = <&tegra_car 22>;
> +        reset-names = "usb";
> +        nvidia,phy = <&phy1>;
> +    };
> +
> +  - |
> +    #include <dt-bindings/clock/tegra210-car.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    usb@7d000000 {
> +        compatible = "nvidia,tegra210-ehci", "nvidia,tegra30-ehci";
> +        reg = <0x7d000000 0x4000>;
> +        interrupts = <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> +        phy_type = "utmi";
> +        clocks = <&tegra_car TEGRA210_CLK_USBD>;
> +        clock-names = "usb";
> +        resets = <&tegra_car 22>;
> +        reset-names = "usb";
> +        nvidia,phy = <&phy1>;
> +    };

Seems a bit excessive to have 4 examples.

> -- 
> 2.32.0
> 
>