diff mbox series

[v6,1/5] dt-bindings: usb: Add binding for Realtek RTS5411 hub controller

Message ID 20210305113832.v6.1.I248292623d3d0f6a4f0c5bc58478ca3c0062b49a@changeid
State Superseded
Headers show
Series USB: misc: Add onboard_usb_hub driver | expand

Commit Message

Matthias Kaehlcke March 5, 2021, 7:38 p.m. UTC 
The Realtek RTS5411 is a USB 3.0 hub controller with 4 ports.

This initial version of the binding only describes USB related
aspects of the RTS5411, it does not cover the option of
connecting the controller as an i2c slave.

Signed-off-by: Matthias Kaehlcke <mka@chromium.org>
---

Changes in v6:
- Realtek binding instead of generic onboard_usb_hub
- added 'companion-hub' property
- added reference to 'usb-device.yaml'
- 'fixed' indentation of compatible entries to keep yamllint happy
- added 'additionalProperties' entry
- updated commit message

Changes in v5:
- updated 'title'
- only use standard USB compatible strings
- deleted 'usb_hub' node
- renamed 'usb_controller' node to 'usb-controller'
- removed labels from USB nodes
- added 'vdd-supply' to USB nodes

Changes in v4:
- none

Changes in v3:
- updated commit message
- removed recursive reference to $self
- adjusted 'compatible' definition to support multiple entries
- changed USB controller phandle to be a node

Changes in v2:
- removed 'wakeup-source' and 'power-off-in-suspend' properties
- consistently use spaces for indentation in example

 .../bindings/usb/realtek,rts5411.yaml         | 58 +++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/realtek,rts5411.yaml

Comments

Rob Herring (Arm) March 6, 2021, 7:28 p.m. UTC | #1 
On Fri, 05 Mar 2021 11:38:49 -0800, Matthias Kaehlcke wrote:
> The Realtek RTS5411 is a USB 3.0 hub controller with 4 ports.
> 
> This initial version of the binding only describes USB related
> aspects of the RTS5411, it does not cover the option of
> connecting the controller as an i2c slave.
> 
> Signed-off-by: Matthias Kaehlcke <mka@chromium.org>
> ---
> 
> Changes in v6:
> - Realtek binding instead of generic onboard_usb_hub
> - added 'companion-hub' property
> - added reference to 'usb-device.yaml'
> - 'fixed' indentation of compatible entries to keep yamllint happy
> - added 'additionalProperties' entry
> - updated commit message
> 
> Changes in v5:
> - updated 'title'
> - only use standard USB compatible strings
> - deleted 'usb_hub' node
> - renamed 'usb_controller' node to 'usb-controller'
> - removed labels from USB nodes
> - added 'vdd-supply' to USB nodes
> 
> Changes in v4:
> - none
> 
> Changes in v3:
> - updated commit message
> - removed recursive reference to $self
> - adjusted 'compatible' definition to support multiple entries
> - changed USB controller phandle to be a node
> 
> Changes in v2:
> - removed 'wakeup-source' and 'power-off-in-suspend' properties
> - consistently use spaces for indentation in example
> 
>  .../bindings/usb/realtek,rts5411.yaml         | 58 +++++++++++++++++++
>  1 file changed, 58 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/realtek,rts5411.yaml
> 

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

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/realtek,rts5411.example.dt.yaml: hub@1: 'reg' does not match any of the regexes: 'pinctrl-[0-9]+'
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/realtek,rts5411.example.dt.yaml: hub@2: 'reg' does not match any of the regexes: 'pinctrl-[0-9]+'
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml

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

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.
Rob Herring (Arm) March 6, 2021, 7:43 p.m. UTC | #2 
On Fri, Mar 05, 2021 at 11:38:49AM -0800, Matthias Kaehlcke wrote:
> The Realtek RTS5411 is a USB 3.0 hub controller with 4 ports.

> 

> This initial version of the binding only describes USB related

> aspects of the RTS5411, it does not cover the option of

> connecting the controller as an i2c slave.

> 

> Signed-off-by: Matthias Kaehlcke <mka@chromium.org>

> ---

> 

> Changes in v6:

> - Realtek binding instead of generic onboard_usb_hub

> - added 'companion-hub' property

> - added reference to 'usb-device.yaml'

> - 'fixed' indentation of compatible entries to keep yamllint happy

> - added 'additionalProperties' entry

> - updated commit message

> 

> Changes in v5:

> - updated 'title'

> - only use standard USB compatible strings

> - deleted 'usb_hub' node

> - renamed 'usb_controller' node to 'usb-controller'

> - removed labels from USB nodes

> - added 'vdd-supply' to USB nodes

> 

> Changes in v4:

> - none

> 

> Changes in v3:

> - updated commit message

> - removed recursive reference to $self

> - adjusted 'compatible' definition to support multiple entries

> - changed USB controller phandle to be a node

> 

> Changes in v2:

> - removed 'wakeup-source' and 'power-off-in-suspend' properties

> - consistently use spaces for indentation in example

> 

>  .../bindings/usb/realtek,rts5411.yaml         | 58 +++++++++++++++++++

>  1 file changed, 58 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/usb/realtek,rts5411.yaml

> 

> diff --git a/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml b/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml

> new file mode 100644

> index 000000000000..00e9b3d44583

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml

> @@ -0,0 +1,58 @@

> +# SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/usb/realtek,rts5411.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Binding for the Realtek RTS5411 USB 3.0 hub controller

> +

> +maintainers:

> +  - Matthias Kaehlcke <mka@chromium.org>

> +

> +allOf:

> +  - $ref: usb-device.yaml#

> +

> +properties:

> +  compatible:

> +    items:

> +      - enum:

> +          - usbbda,5411

> +          - usbbda,411

> +

> +  vdd-supply:

> +    description:

> +      phandle to the regulator that provides power to the hub.

> +

> +  companion-hub:

> +    description:

> +      phandle to the companion hub on the controller.


Needs a type ref.

> +

> +required:

> +  - compatible

> +  - reg

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    usb-controller {

> +        dr_mode = "host";

> +        #address-cells = <1>;

> +        #size-cells = <0>;

> +

> +        /* 2.0 hub on port 1 */

> +        hub_2_0: hub@1 {

> +            compatible = "usbbda,5411";

> +            reg = <1>;

> +            vdd-supply = <&pp3300_hub>;

> +            companion-hub = <&hub_3_0>;

> +        };

> +

> +        /* 3.0 hub on port 2 */

> +        hub_3_0: hub@2 {

> +            compatible = "usbbda,411";

> +            reg = <2>;

> +            vdd-supply = <&pp3300_hub>;

> +            companion-hub = <&hub_2_0>;

> +        };

> +    };

> -- 

> 2.30.1.766.gb4fecdf3b7-goog

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml b/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml
new file mode 100644
index 000000000000..00e9b3d44583
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/realtek,rts5411.yaml
@@ -0,0 +1,58 @@ 
+# SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/realtek,rts5411.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Binding for the Realtek RTS5411 USB 3.0 hub controller
+
+maintainers:
+  - Matthias Kaehlcke <mka@chromium.org>
+
+allOf:
+  - $ref: usb-device.yaml#
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - usbbda,5411
+          - usbbda,411
+
+  vdd-supply:
+    description:
+      phandle to the regulator that provides power to the hub.
+
+  companion-hub:
+    description:
+      phandle to the companion hub on the controller.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    usb-controller {
+        dr_mode = "host";
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        /* 2.0 hub on port 1 */
+        hub_2_0: hub@1 {
+            compatible = "usbbda,5411";
+            reg = <1>;
+            vdd-supply = <&pp3300_hub>;
+            companion-hub = <&hub_3_0>;
+        };
+
+        /* 3.0 hub on port 2 */
+        hub_3_0: hub@2 {
+            compatible = "usbbda,411";
+            reg = <2>;
+            vdd-supply = <&pp3300_hub>;
+            companion-hub = <&hub_2_0>;
+        };
+    };