Introduce a general USB hub binding that describes downstream ports
and hard wired USB devices for on-board USB hubs.
Signed-off-by: Pin-yen Lin <treapking@chromium.org>
---
Changes in v3:
- Remove redundant schemas
Changes in v2:
- New in v2
.../devicetree/bindings/usb/usb-hub.yaml | 84 +++++++++++++++++++
1 file changed, 84 insertions(+)
create mode 100644 Documentation/devicetree/bindings/usb/usb-hub.yaml
diff --git a/Documentation/devicetree/bindings/usb/usb-hub.yaml b/Documentation/devicetree/bindings/usb/usb-hub.yaml
new file mode 100644
index 00000000000000..5238ab10576308
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/usb-hub.yaml
@@ -0,0 +1,84 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/usb-hub.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Generic USB Hub
+
+maintainers:
+ - Pin-yen Lin <treapking@chromium.org>
+
+allOf:
+ - $ref: usb-device.yaml#
+
+properties:
+ '#address-cells':
+ const: 1
+
+ peer-hub:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description:
+ phandle to the peer hub on the controller.
+
+ ports:
+ $ref: /schemas/graph.yaml#/properties/ports
+ description:
+ The downstream facing USB ports
+
+ patternProperties:
+ "^port@[1-9a-f][0-9a-f]*$":
+ $ref: /schemas/graph.yaml#/properties/port
+
+patternProperties:
+ '^.*@[1-9a-f][0-9a-f]*$':
+ description: The hard wired USB devices
+ type: object
+ $ref: /schemas/usb/usb-device.yaml
+ additionalProperties: true
+
+required:
+ - compatible
+ - reg
+
+additionalProperties: true
+
+examples:
+ - |
+ usb {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ /* 2.0 hub on port 1 */
+ hub_2_0: hub@1 {
+ compatible = "usb123,4567";
+ reg = <1>;
+ peer-hub = <&hub_3_0>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+ /* USB 2.0 device on port 5 */
+ device@5 {
+ reg = <5>;
+ compatible = "usb765,4321";
+ };
+ };
+
+ /* 3.0 hub on port 2 */
+ hub_3_0: hub@2 {
+ compatible = "usb123,abcd";
+ reg = <2>;
+ peer-hub = <&hub_2_0>;
+
+ ports {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ /* Type-A connector on port 3 */
+ port@3 {
+ reg = <3>;
+ endpoint {
+ remote-endpoint = <&usb_a0_ss>;
+ };
+ };
+ };
+ };
+ };
--
2.49.0.805.g082f7c87e0-googQuoting Pin-yen Lin (2025-04-22 01:28:27) > diff --git a/Documentation/devicetree/bindings/usb/usb-hub.yaml b/Documentation/devicetree/bindings/usb/usb-hub.yaml > new file mode 100644 > index 00000000000000..5238ab10576308 > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/usb-hub.yaml > @@ -0,0 +1,84 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/usb/usb-hub.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Generic USB Hub > + > +maintainers: > + - Pin-yen Lin <treapking@chromium.org> > + > +allOf: > + - $ref: usb-device.yaml# > + > +properties: > + '#address-cells': > + const: 1 > + > + peer-hub: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + phandle to the peer hub on the controller. > + > + ports: > + $ref: /schemas/graph.yaml#/properties/ports > + description: > + The downstream facing USB ports > + > + patternProperties: > + "^port@[1-9a-f][0-9a-f]*$": > + $ref: /schemas/graph.yaml#/properties/port > + > +patternProperties: > + '^.*@[1-9a-f][0-9a-f]*$': > + description: The hard wired USB devices > + type: object > + $ref: /schemas/usb/usb-device.yaml > + additionalProperties: true > + > +required: > + - compatible > + - reg Can 'reg' be dropped because usb-device.yaml requires it?
Hi Stephen, On Tue, Apr 29, 2025 at 7:47 AM Stephen Boyd <swboyd@chromium.org> wrote: > > Quoting Pin-yen Lin (2025-04-22 01:28:27) > > diff --git a/Documentation/devicetree/bindings/usb/usb-hub.yaml b/Documentation/devicetree/bindings/usb/usb-hub.yaml > > new file mode 100644 > > index 00000000000000..5238ab10576308 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/usb/usb-hub.yaml > > @@ -0,0 +1,84 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/usb/usb-hub.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: Generic USB Hub > > + > > +maintainers: > > + - Pin-yen Lin <treapking@chromium.org> > > + > > +allOf: > > + - $ref: usb-device.yaml# > > + > > +properties: > > + '#address-cells': > > + const: 1 > > + > > + peer-hub: > > + $ref: /schemas/types.yaml#/definitions/phandle > > + description: > > + phandle to the peer hub on the controller. > > + > > + ports: > > + $ref: /schemas/graph.yaml#/properties/ports > > + description: > > + The downstream facing USB ports > > + > > + patternProperties: > > + "^port@[1-9a-f][0-9a-f]*$": > > + $ref: /schemas/graph.yaml#/properties/port > > + > > +patternProperties: > > + '^.*@[1-9a-f][0-9a-f]*$': > > + description: The hard wired USB devices > > + type: object > > + $ref: /schemas/usb/usb-device.yaml > > + additionalProperties: true > > + > > +required: > > + - compatible > > + - reg > > Can 'reg' be dropped because usb-device.yaml requires it? As I replied in patch 3/4, I see other schemas still re-define them as required. I can send a new version to drop this if no one comes out and say this is actually a convention. Regards, Pin-yen
On Tue, 22 Apr 2025 16:28:27 +0800, Pin-yen Lin wrote: > Introduce a general USB hub binding that describes downstream ports > and hard wired USB devices for on-board USB hubs. > > Signed-off-by: Pin-yen Lin <treapking@chromium.org> > > --- > > Changes in v3: > - Remove redundant schemas > > Changes in v2: > - New in v2 > > .../devicetree/bindings/usb/usb-hub.yaml | 84 +++++++++++++++++++ > 1 file changed, 84 insertions(+) > create mode 100644 Documentation/devicetree/bindings/usb/usb-hub.yaml > Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
© 2016 - 2025 Red Hat, Inc.