Message ID | f99d284dc70ca897d3908b1e4c92a9910f350584.1683729282.git.michal.simek@amd.com |
---|---|
State | Superseded |
Headers | show |
Series | [v3] dt-bindings: usb: Add support for Microchip usb5744 hub controller | expand |
On 10/05/2023 16:34, Michal Simek wrote: > The Microchip usb5744 is a SS/HS USB 3.0 hub controller with 4 ports. > Add description for USB related aspects of the USB5744 hub, it as > well cover the option of connecting the controller as an i2c slave. > When i2c interface is connected hub needs to be initialized first. > Hub itself has fixed i2c address 0x2D but hardcoding address is not good > idea because address can be shifted by i2c address translator in the > middle. > > Signed-off-by: Piyush Mehta <piyush.mehta@amd.com> > Signed-off-by: Michal Simek <michal.simek@amd.com> > --- > > Changes in v3: > - add maxItems to reg property > - remove select and define properties not used for i2c node and required > for usb > - s/binding/support/ in subject > - reword descripion to remove binding word from commit message > - wire usb-device.yaml for usb hub properties > > Changes in v2: > - fix i2c-bus property > - swap usb2.0/3.0 compatible strings > - fix indentation in example (4 spaces) > - add new i2c node with microchip,usb5744 compatible property > > It looks like that usb8041 has also an optional i2c interface which is not > covered. But it is mentioned at commit 40e58a8a7ca6 ("dt-bindings: usb: > Add binding for TI USB8041 hub controller"). > > i2c-bus name property was suggested by Rob at > https://lore.kernel.org/all/CAL_JsqJedhX6typpUKbnzV7CLK6UZVjq3CyG9iY_j5DLPqvVdw@mail.gmail.com/ > and > https://lore.kernel.org/all/CAL_JsqJZBbu+UXqUNdZwg-uv0PAsNg55026PTwhKr5wQtxCjVQ@mail.gmail.com/ > > the question is if adding address like this is acceptable. > But it must be specified. > > Driver will follow based on final dt-binding. > > $ref: usb-device.yaml# should be also added but have no idea how to wire it > up to be applied only on usb node not i2c one. > > --- > .../bindings/usb/microchip,usb5744.yaml | 107 ++++++++++++++++++ > 1 file changed, 107 insertions(+) > create mode 100644 Documentation/devicetree/bindings/usb/microchip,usb5744.yaml > > diff --git a/Documentation/devicetree/bindings/usb/microchip,usb5744.yaml b/Documentation/devicetree/bindings/usb/microchip,usb5744.yaml > new file mode 100644 > index 000000000000..408c5bf00cc2 > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/microchip,usb5744.yaml > @@ -0,0 +1,107 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/usb/microchip,usb5744.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Microchip USB5744 4-port Hub Controller > + > +description: > + Microchip's USB5744 SmartHubTM IC is a 4 port, SuperSpeed (SS)/Hi-Speed (HS), > + low power, low pin count configurable and fully compliant with the USB 3.1 > + Gen 1 specification. The USB5744 also supports Full Speed (FS) and Low Speed > + (LS) USB signaling, offering complete coverage of all defined USB operating > + speeds. The new SuperSpeed hubs operate in parallel with the USB 2.0 > + controller, so 5 Gbps SuperSpeed data transfers are not affected by slower > + USB 2.0 traffic. > + > +maintainers: > + - Piyush Mehta <piyush.mehta@amd.com> > + - Michal Simek <michal.simek@amd.com> > + > +properties: > + compatible: > + enum: > + - usb424,2744 > + - usb424,5744 > + - microchip,usb5744 > + > + reg: > + maxItems: 1 > + > + reset-gpios: > + maxItems: 1 > + description: > + GPIO controlling the GRST# pin. > + > + vdd-supply: > + description: > + VDD power supply to the hub > + > + peer-hub: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + phandle to the peer hub on the controller. > + > + i2c-bus: > + $ref: /schemas/types.yaml#/definitions/phandle > + description: > + phandle of an usb hub connected via i2c bus. > + > +allOf: Put allOf: block after required:. Just like in example schema. > + - if: > + properties: > + compatible: > + contains: > + const: microchip,usb5744 > + then: > + properties: > + reset-gpios: false > + vdd-supply: false > + peer-hub: false > + i2c-bus: false > + else: > + $ref: /schemas/usb/usb-device.yaml > + required: > + - peer-hub > + > +required: > + - compatible > + - reg > + Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/usb/microchip,usb5744.yaml b/Documentation/devicetree/bindings/usb/microchip,usb5744.yaml new file mode 100644 index 000000000000..408c5bf00cc2 --- /dev/null +++ b/Documentation/devicetree/bindings/usb/microchip,usb5744.yaml @@ -0,0 +1,107 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/usb/microchip,usb5744.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Microchip USB5744 4-port Hub Controller + +description: + Microchip's USB5744 SmartHubTM IC is a 4 port, SuperSpeed (SS)/Hi-Speed (HS), + low power, low pin count configurable and fully compliant with the USB 3.1 + Gen 1 specification. The USB5744 also supports Full Speed (FS) and Low Speed + (LS) USB signaling, offering complete coverage of all defined USB operating + speeds. The new SuperSpeed hubs operate in parallel with the USB 2.0 + controller, so 5 Gbps SuperSpeed data transfers are not affected by slower + USB 2.0 traffic. + +maintainers: + - Piyush Mehta <piyush.mehta@amd.com> + - Michal Simek <michal.simek@amd.com> + +properties: + compatible: + enum: + - usb424,2744 + - usb424,5744 + - microchip,usb5744 + + reg: + maxItems: 1 + + reset-gpios: + maxItems: 1 + description: + GPIO controlling the GRST# pin. + + vdd-supply: + description: + VDD power supply to the hub + + peer-hub: + $ref: /schemas/types.yaml#/definitions/phandle + description: + phandle to the peer hub on the controller. + + i2c-bus: + $ref: /schemas/types.yaml#/definitions/phandle + description: + phandle of an usb hub connected via i2c bus. + +allOf: + - if: + properties: + compatible: + contains: + const: microchip,usb5744 + then: + properties: + reset-gpios: false + vdd-supply: false + peer-hub: false + i2c-bus: false + else: + $ref: /schemas/usb/usb-device.yaml + required: + - peer-hub + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + #include <dt-bindings/gpio/gpio.h> + i2c: i2c { + #address-cells = <1>; + #size-cells = <0>; + hub: usb-hub@2d { + compatible = "microchip,usb5744"; + reg = <0x2d>; + }; + }; + + usb { + #address-cells = <1>; + #size-cells = <0>; + + /* 2.0 hub on port 1 */ + hub_2_0: hub@1 { + compatible = "usb424,2744"; + reg = <1>; + peer-hub = <&hub_3_0>; + i2c-bus = <&hub>; + reset-gpios = <&gpio 3 GPIO_ACTIVE_LOW>; + }; + + /* 3.0 hub on port 2 */ + hub_3_0: hub@2 { + compatible = "usb424,5744"; + reg = <2>; + peer-hub = <&hub_2_0>; + i2c-bus = <&hub>; + reset-gpios = <&gpio 3 GPIO_ACTIVE_LOW>; + }; + };