GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / usb / usb251xb.txt
1 Microchip USB 2.0 Hi-Speed Hub Controller
2
3 The device node for the configuration of a Microchip USB251xB/xBi USB 2.0
4 Hi-Speed Controller.
5
6 Required properties :
7  - compatible : Should be "microchip,usb251xb" or one of the specific types:
8         "microchip,usb2512b", "microchip,usb2512bi", "microchip,usb2513b",
9         "microchip,usb2513bi", "microchip,usb2514b", "microchip,usb2514bi"
10  - reset-gpios : Should specify the gpio for hub reset
11  - reg : I2C address on the selected bus (default is <0x2C>)
12
13 Optional properties :
14  - skip-config : Skip Hub configuration, but only send the USB-Attach command
15  - vendor-id : Set USB Vendor ID of the hub (16 bit, default is 0x0424)
16  - product-id : Set USB Product ID of the hub (16 bit, default depends on type)
17  - device-id : Set USB Device ID of the hub (16 bit, default is 0x0bb3)
18  - language-id : Set USB Language ID (16 bit, default is 0x0000)
19  - manufacturer : Set USB Manufacturer string (max 31 characters long)
20  - product : Set USB Product string (max 31 characters long)
21  - serial : Set USB Serial string (max 31 characters long)
22  - {bus,self}-powered : selects between self- and bus-powered operation (default
23         is self-powered)
24  - disable-hi-speed : disable USB Hi-Speed support
25  - {multi,single}-tt : selects between multi- and single-transaction-translator
26         (default is multi-tt)
27  - disable-eop : disable End of Packet generation in full-speed mode
28  - {ganged,individual}-sensing : select over-current sense type in self-powered
29         mode (default is individual)
30  - {ganged,individual}-port-switching : select port power switching mode
31         (default is individual)
32  - dynamic-power-switching : enable auto-switching from self- to bus-powered
33         operation if the local power source is removed or unavailable
34  - oc-delay-us : Delay time (in microseconds) for filtering the over-current
35         sense inputs. Valid values are 100, 4000, 8000 (default) and 16000. If
36         an invalid value is given, the default is used instead.
37  - compound-device : indicate the hub is part of a compound device
38  - port-mapping-mode : enable port mapping mode
39  - string-support : enable string descriptor support (required for manufacturer,
40         product and serial string configuration)
41  - non-removable-ports : Should specify the ports which have a non-removable
42         device connected.
43  - sp-disabled-ports : Specifies the ports which will be self-power disabled
44  - bp-disabled-ports : Specifies the ports which will be bus-power disabled
45  - power-on-time-ms : Specifies the time it takes from the time the host
46         initiates the power-on sequence to a port until the port has adequate
47         power. The value is given in ms in a 0 - 510 range (default is 100ms).
48
49 Examples:
50         usb2512b@2c {
51                 compatible = "microchip,usb2512b";
52                 reg = <0x2c>;
53                 reset-gpios = <&gpio1 4 GPIO_ACTIVE_LOW>;
54         };
55
56         usb2514b@2c {
57                 compatible = "microchip,usb2514b";
58                 reg = <0x2c>;
59                 reset-gpios = <&gpio1 4 GPIO_ACTIVE_LOW>;
60                 vendor-id = /bits/ 16 <0x0000>;
61                 product-id = /bits/ 16 <0x0000>;
62                 string-support;
63                 manufacturer = "Foo";
64                 product = "Foo-Bar";
65                 serial = "1234567890A";
66         };