diff mbox series

[1/1] dt-bindings: usb: microchip,usb2514: Fix reference USB device schema

Message ID 20240814065833.36372-1-alexander.stein@ew.tq-group.com (mailing list archive)
State Superseded
Headers show
Series [1/1] dt-bindings: usb: microchip,usb2514: Fix reference USB device schema | expand

Commit Message

Alexander Stein Aug. 14, 2024, 6:58 a.m. UTC
An USB hub is not a HCD, but an USB device. Fix the referenced schema
accordingly. Adjust example to keep it aligned to other schemas.

Fixes: bfbf2e4b77e27 ("dt-bindings: usb: Document the Microchip USB2514 hub")
Signed-off-by: Alexander Stein <alexander.stein@ew.tq-group.com>
---
As this USB hub also can contain an USB (ethernet) sub device, I copied
the subdevice part from usb-hcd.yaml.

I had to add 'additionalProperties: true' as well, because I got that warning
upon dt_binding_check otherwise:
> Documentation/devicetree/bindings/usb/microchip,usb2514.yaml: 
>   ^.*@[0-9a-f]{1,2}$: Missing additionalProperties/unevaluatedProperties constraint

I added a Fixes tag to keep this schema aligned in v6.10 stable tree.

 .../devicetree/bindings/usb/microchip,usb2514.yaml    | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

Comments

Greg KH Aug. 14, 2024, 7:16 a.m. UTC | #1
On Wed, Aug 14, 2024 at 08:58:32AM +0200, Alexander Stein wrote:
> An USB hub is not a HCD, but an USB device. Fix the referenced schema
> accordingly. Adjust example to keep it aligned to other schemas.
> 
> Fixes: bfbf2e4b77e27 ("dt-bindings: usb: Document the Microchip USB2514 hub")
> Signed-off-by: Alexander Stein <alexander.stein@ew.tq-group.com>
> ---
> As this USB hub also can contain an USB (ethernet) sub device, I copied
> the subdevice part from usb-hcd.yaml.
> 
> I had to add 'additionalProperties: true' as well, because I got that warning
> upon dt_binding_check otherwise:
> > Documentation/devicetree/bindings/usb/microchip,usb2514.yaml: 
> >   ^.*@[0-9a-f]{1,2}$: Missing additionalProperties/unevaluatedProperties constraint
> 
> I added a Fixes tag to keep this schema aligned in v6.10 stable tree.
> 
>  .../devicetree/bindings/usb/microchip,usb2514.yaml    | 11 +++++++++--
>  1 file changed, 9 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml b/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml
> index 245e8c3ce6699..aa3db8e373c70 100644
> --- a/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml
> +++ b/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml
> @@ -10,7 +10,7 @@ maintainers:
>    - Fabio Estevam <festevam@gmail.com>
>  
>  allOf:
> -  - $ref: usb-hcd.yaml#
> +  - $ref: usb-device.yaml#
>  
>  properties:
>    compatible:
> @@ -36,6 +36,13 @@ required:
>    - compatible
>    - reg
>  
> +patternProperties:
> +  "^.*@[0-9a-f]{1,2}$":
> +    description: The hard wired USB devices
> +    type: object
> +    $ref: /schemas/usb/usb-device.yaml
> +    additionalProperties: true
> +
>  unevaluatedProperties: false
>  
>  examples:
> @@ -47,7 +54,7 @@ examples:
>          #address-cells = <1>;
>          #size-cells = <0>;
>  
> -        usb-hub@1 {
> +        hub@1 {
>              compatible = "usb424,2514";
>              reg = <1>;
>              clocks = <&clks IMX6QDL_CLK_CKO>;
> -- 
> 2.34.1
> 
> 

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman.  You have sent him
a patch that has triggered this response.  He used to manually respond
to these common problems, but in order to save his sanity (he kept
writing the same thing over and over, yet to different people), I was
created.  Hopefully you will not take offence and will fix the problem
in your patch and resubmit it so that it can be accepted into the Linux
kernel tree.

You are receiving this message because of the following common error(s)
as indicated below:

- You have marked a patch with a "Fixes:" tag for a commit that is in an
  older released kernel, yet you do not have a cc: stable line in the
  signed-off-by area at all, which means that the patch will not be
  applied to any older kernel releases.  To properly fix this, please
  follow the documented rules in the
  Documentation/process/stable-kernel-rules.rst file for how to resolve
  this.

If you wish to discuss this problem further, or you have questions about
how to resolve this issue, please feel free to respond to this email and
Greg will reply once he has dug out from the pending patches received
from other developers.

thanks,

greg k-h's patch email bot
Krzysztof Kozlowski Aug. 14, 2024, 1:13 p.m. UTC | #2
On 14/08/2024 08:58, Alexander Stein wrote:
> An USB hub is not a HCD, but an USB device. Fix the referenced schema
> accordingly. Adjust example to keep it aligned to other schemas.
> 
> Fixes: bfbf2e4b77e27 ("dt-bindings: usb: Document the Microchip USB2514 hub")
> Signed-off-by: Alexander Stein <alexander.stein@ew.tq-group.com>
> ---
> As this USB hub also can contain an USB (ethernet) sub device, I copied
> the subdevice part from usb-hcd.yaml.
> 
> I had to add 'additionalProperties: true' as well, because I got that warning
> upon dt_binding_check otherwise:


Thanks for fixing this.

>  
> +patternProperties:
> +  "^.*@[0-9a-f]{1,2}$":
> +    description: The hard wired USB devices
> +    type: object
> +    $ref: /schemas/usb/usb-device.yaml
> +    additionalProperties: true
> +
>  unevaluatedProperties: false
>  
>  examples:
> @@ -47,7 +54,7 @@ examples:
>          #address-cells = <1>;
>          #size-cells = <0>;
>  
> -        usb-hub@1 {
> +        hub@1 {

This is not needed. Both are correct - usb-hub and hub. I prefer not to
rename all "phy" nodes to "usb-phy" and vice versa.

Rest is good, so with dropping this renaming hunk:

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof
Rob Herring (Arm) Aug. 14, 2024, 1:33 p.m. UTC | #3
On Wed, Aug 14, 2024 at 08:58:32AM +0200, Alexander Stein wrote:
> An USB hub is not a HCD, but an USB device. Fix the referenced schema
> accordingly. Adjust example to keep it aligned to other schemas.
> 
> Fixes: bfbf2e4b77e27 ("dt-bindings: usb: Document the Microchip USB2514 hub")

checkpatch.pl complains the hash is 13 chars rather than 12.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml b/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml
index 245e8c3ce6699..aa3db8e373c70 100644
--- a/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml
+++ b/Documentation/devicetree/bindings/usb/microchip,usb2514.yaml
@@ -10,7 +10,7 @@  maintainers:
   - Fabio Estevam <festevam@gmail.com>
 
 allOf:
-  - $ref: usb-hcd.yaml#
+  - $ref: usb-device.yaml#
 
 properties:
   compatible:
@@ -36,6 +36,13 @@  required:
   - compatible
   - reg
 
+patternProperties:
+  "^.*@[0-9a-f]{1,2}$":
+    description: The hard wired USB devices
+    type: object
+    $ref: /schemas/usb/usb-device.yaml
+    additionalProperties: true
+
 unevaluatedProperties: false
 
 examples:
@@ -47,7 +54,7 @@  examples:
         #address-cells = <1>;
         #size-cells = <0>;
 
-        usb-hub@1 {
+        hub@1 {
             compatible = "usb424,2514";
             reg = <1>;
             clocks = <&clks IMX6QDL_CLK_CKO>;