Re: [PATCH V3 1/7] dt-bindings: usb: usbmisc-imx: convert to DT schema

From: Rob Herring
Date: Mon Feb 27 2023 - 15:52:42 EST


On Sun, Feb 26, 2023 at 09:05:33PM +0800, Peng Fan (OSS) wrote:
> From: Peng Fan <peng.fan@xxxxxxx>
>
> Convert usbmisc-imx to DT schema format.
>
> Signed-off-by: Peng Fan <peng.fan@xxxxxxx>
> ---
> .../devicetree/bindings/usb/fsl,usbmisc.yaml | 54 +++++++++++++++++++
> .../devicetree/bindings/usb/usbmisc-imx.txt | 19 -------
> 2 files changed, 54 insertions(+), 19 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/usb/fsl,usbmisc.yaml
> delete mode 100644 Documentation/devicetree/bindings/usb/usbmisc-imx.txt
>
> diff --git a/Documentation/devicetree/bindings/usb/fsl,usbmisc.yaml b/Documentation/devicetree/bindings/usb/fsl,usbmisc.yaml
> new file mode 100644
> index 000000000000..517390b9d2c6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/fsl,usbmisc.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/fsl,usbmisc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale i.MX wrapper module for Chipidea USB2 controller
> +
> +maintainers:
> + - Xu Yang <xu.yang_2@xxxxxxx>
> + - Peng Fan <peng.fan@xxxxxxx>
> +
> +properties:
> + compatible:
> + oneOf:
> + - enum:
> + - fsl,imx6q-usbmisc
> + - fsl,imx7ulp-usbmisc
> + - fsl,vf610-usbmisc
> + - items:
> + - enum:
> + - fsl,imx6ul-usbmisc
> + - fsl,imx6sx-usbmisc
> + - fsl,imx7d-usbmisc
> + - const: fsl,imx6q-usbmisc
> + - items:
> + - enum:
> + - fsl,imx7ulp-usbmisc
> + - fsl,imx8mm-usbmisc
> + - const: fsl,imx7d-usbmisc

So imx8mm is compatible with imx7d, and imx7d is compatible with imx6q,
but imx8mm is not compatible with imx6q? That doesn't really make sense.
Maybe all 3 compatibles makes sense, but only if s/w understanding only
one of the fallback compatibles would function without knowledge of the
newer h/w.

> +
> + reg:
> + maxItems: 1
> +
> + '#index-cells':
> + const: 1
> + description: Cells used to describe usb controller index.

Please mark this as deprecated. If it is always 1 cell, then there's no
point.

> +
> +required:
> + - compatible
> + - reg
> + - '#index-cells'

And drop as required. That all can be a follow-up patch if you prefer or
in this patch is fine. Primarily, I don't want this pattern copied.

> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + usbmisc@2184800 {
> + #index-cells = <1>;
> + compatible = "fsl,imx6q-usbmisc";
> + reg = <0x02184800 0x200>;
> + };
> +
> +...
> diff --git a/Documentation/devicetree/bindings/usb/usbmisc-imx.txt b/Documentation/devicetree/bindings/usb/usbmisc-imx.txt
> deleted file mode 100644
> index 29b8f65ff849..000000000000
> --- a/Documentation/devicetree/bindings/usb/usbmisc-imx.txt
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -* Freescale i.MX non-core registers
> -
> -Required properties:
> -- #index-cells: Cells used to describe usb controller index. Should be <1>
> -- compatible: Should be one of below:
> - "fsl,imx6q-usbmisc" for imx6q
> - "fsl,vf610-usbmisc" for Vybrid vf610
> - "fsl,imx6sx-usbmisc" for imx6sx
> - "fsl,imx7d-usbmisc" for imx7d
> - "fsl,imx7ulp-usbmisc" for imx7ulp
> - "fsl,imx8mm-usbmisc" for imx8mm
> -- reg: Should contain registers location and length
> -
> -Examples:
> -usbmisc@2184800 {
> - #index-cells = <1>;
> - compatible = "fsl,imx6q-usbmisc";
> - reg = <0x02184800 0x200>;
> -};
> --
> 2.37.1
>