| Message ID | 20250415094227.3629916-2-treapking@chromium.org |
|---|---|
| State | New |
| Headers | show |
| Series | [v2,1/4] dt-bindings: usb: Introduce usb-hub.yaml | expand |
On Tue, Apr 15, 2025 at 05:41:58PM +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 v2: > - New in v2 > > .../devicetree/bindings/usb/usb-hub.yaml | 91 +++++++++++++++++++ > 1 file changed, 91 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..34cd248fa43c2d > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/usb-hub.yaml > @@ -0,0 +1,91 @@ > +# 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: > + compatible: true > + > + reg: true Drop these 2, already covered by usb-device.yaml. > + > + '#address-cells': > + const: 1 > + > + '#size-cells': > + const: 0 Drop this, already covered by usb-device.yaml. > + > + 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-9]$": Only 9 ports possible? Should be '^port@[1-9a-f][0-9a-f]*$' > + $ref: /schemas/graph.yaml#/properties/port > + > +patternProperties: > + '^.*@[1-9]$': > + 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.777.g153de2bbd5-goog >
diff --git a/Documentation/devicetree/bindings/usb/usb-hub.yaml b/Documentation/devicetree/bindings/usb/usb-hub.yaml new file mode 100644 index 00000000000000..34cd248fa43c2d --- /dev/null +++ b/Documentation/devicetree/bindings/usb/usb-hub.yaml @@ -0,0 +1,91 @@ +# 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: + compatible: true + + reg: true + + '#address-cells': + const: 1 + + '#size-cells': + const: 0 + + 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-9]$": + $ref: /schemas/graph.yaml#/properties/port + +patternProperties: + '^.*@[1-9]$': + 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>; + }; + }; + }; + }; + };
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 v2: - New in v2 .../devicetree/bindings/usb/usb-hub.yaml | 91 +++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 Documentation/devicetree/bindings/usb/usb-hub.yaml