diff mbox series

dt-bindings: usb: add properties for hard wired devices

Message ID 20200928063950.64722-1-chunfeng.yun@mediatek.com (mailing list archive)
State New, archived
Headers show
Series dt-bindings: usb: add properties for hard wired devices | expand

Commit Message

Chunfeng Yun (云春峰) Sept. 28, 2020, 6:39 a.m. UTC
Add some optional properties which are needed for hard wired devices

Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
---
 Documentation/devicetree/bindings/usb/usb-hcd.yaml | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Rob Herring (Arm) Sept. 28, 2020, 6:12 p.m. UTC | #1
On Mon, Sep 28, 2020 at 02:39:50PM +0800, Chunfeng Yun wrote:
> Add some optional properties which are needed for hard wired devices
> 
> Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
> ---
>  Documentation/devicetree/bindings/usb/usb-hcd.yaml | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> index 7263b7f2b510..1194a82887e7 100644
> --- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> +++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> @@ -22,6 +22,17 @@ properties:
>      description:
>        Name specifier for the USB PHY
>  
> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 0
> +
> +patternProperties:
> +  "^hub|device@[0-9a-f]+$":

Could be any class of device, so '@[0-9a-f]+$'

> +    type: object
> +    description: The hard wired USB devices. See usb/usb-device.txt

Ideally, we'd convert usb-device.txt to schema and reference it here.

> +
>  examples:
>    - |
>      usb {
> -- 
> 2.18.0
Rob Herring (Arm) Sept. 28, 2020, 6:13 p.m. UTC | #2
On Mon, 28 Sep 2020 14:39:50 +0800, Chunfeng Yun wrote:
> Add some optional properties which are needed for hard wired devices
> 
> Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
> ---
>  Documentation/devicetree/bindings/usb/usb-hcd.yaml | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 


My bot found errors running 'make dt_binding_check' on your patch:

/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/qcom,dwc3.example.dt.yaml: usb@a6f8800: #address-cells:0:0: 1 was expected
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/usb-hcd.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/qcom,dwc3.example.dt.yaml: usb@a6f8800: #size-cells:0:0: 0 was expected
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/usb-hcd.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.example.dt.yaml: usb@ffe09000: #size-cells:0:0: 0 was expected
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/usb-hcd.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/socionext,uniphier-usb3ss-phy.example.dt.yaml: usb-glue@65b00000: #size-cells:0:0: 0 was expected
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/usb-hcd.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/socionext,uniphier-usb3hs-phy.example.dt.yaml: usb-glue@65b00000: #size-cells:0:0: 0 was expected
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/usb-hcd.yaml


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

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

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
Chunfeng Yun (云春峰) Sept. 29, 2020, 6:06 a.m. UTC | #3
On Mon, 2020-09-28 at 13:12 -0500, Rob Herring wrote:
> On Mon, Sep 28, 2020 at 02:39:50PM +0800, Chunfeng Yun wrote:
> > Add some optional properties which are needed for hard wired devices
> > 
> > Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
> > ---
> >  Documentation/devicetree/bindings/usb/usb-hcd.yaml | 11 +++++++++++
> >  1 file changed, 11 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> > index 7263b7f2b510..1194a82887e7 100644
> > --- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> > +++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> > @@ -22,6 +22,17 @@ properties:
> >      description:
> >        Name specifier for the USB PHY
> >  
> > +  "#address-cells":
> > +    const: 1
> > +
> > +  "#size-cells":
> > +    const: 0
> > +
> > +patternProperties:
> > +  "^hub|device@[0-9a-f]+$":
> 
> Could be any class of device, so '@[0-9a-f]+$'
You mean we will use different standard node name for each usb class?
e.g.
Use 'ethernet@*' for a usb ethernet adapter, and use 'camera@*' for a
usb camera sensor?

> 
> > +    type: object
> > +    description: The hard wired USB devices. See usb/usb-device.txt
> 
> Ideally, we'd convert usb-device.txt to schema and reference it here.
Ok, I'll try to do it.

BTW: Does the compatible support pattern? Is there any example I can
refer to?

Thanks

> 
> > +
> >  examples:
> >    - |
> >      usb {
> > -- 
> > 2.18.0
Rob Herring (Arm) Sept. 29, 2020, 1:56 p.m. UTC | #4
On Tue, Sep 29, 2020 at 1:09 AM Chunfeng Yun <chunfeng.yun@mediatek.com> wrote:
>
> On Mon, 2020-09-28 at 13:12 -0500, Rob Herring wrote:
> > On Mon, Sep 28, 2020 at 02:39:50PM +0800, Chunfeng Yun wrote:
> > > Add some optional properties which are needed for hard wired devices
> > >
> > > Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
> > > ---
> > >  Documentation/devicetree/bindings/usb/usb-hcd.yaml | 11 +++++++++++
> > >  1 file changed, 11 insertions(+)
> > >
> > > diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> > > index 7263b7f2b510..1194a82887e7 100644
> > > --- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> > > +++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
> > > @@ -22,6 +22,17 @@ properties:
> > >      description:
> > >        Name specifier for the USB PHY
> > >
> > > +  "#address-cells":
> > > +    const: 1
> > > +
> > > +  "#size-cells":
> > > +    const: 0
> > > +
> > > +patternProperties:
> > > +  "^hub|device@[0-9a-f]+$":
> >
> > Could be any class of device, so '@[0-9a-f]+$'
> You mean we will use different standard node name for each usb class?
> e.g.
> Use 'ethernet@*' for a usb ethernet adapter, and use 'camera@*' for a
> usb camera sensor?

Yes.

> > > +    type: object
> > > +    description: The hard wired USB devices. See usb/usb-device.txt
> >
> > Ideally, we'd convert usb-device.txt to schema and reference it here.
> Ok, I'll try to do it.
>
> BTW: Does the compatible support pattern? Is there any example I can
> refer to?

Yes, use 'pattern' keyword.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
index 7263b7f2b510..1194a82887e7 100644
--- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -22,6 +22,17 @@  properties:
     description:
       Name specifier for the USB PHY
 
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+patternProperties:
+  "^hub|device@[0-9a-f]+$":
+    type: object
+    description: The hard wired USB devices. See usb/usb-device.txt
+
 examples:
   - |
     usb {