Merge tag 'pinctrl-v4.11-2' of git://git.kernel.org/pub/scm/linux/kernel/git/linusw...
[sfrench/cifs-2.6.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  - hub-reset-gpios : Should specify the gpio for hub reset
11
12 Optional properties :
13  - reg : I2C address on the selected bus (default is <0x2C>)
14  - skip-config : Skip Hub configuration, but only send the USB-Attach command
15  - vendor-id : USB Vendor ID of the hub (16 bit, default is 0x0424)
16  - product-id : USB Product ID of the hub (16 bit, default depends on type)
17  - device-id : USB Device ID of the hub (16 bit, default is 0x0bb3)
18  - language-id : USB Language ID (16 bit, default is 0x0000)
19  - manufacturer : USB Manufacturer string (max 31 characters long)
20  - product : USB Product string (max 31 characters long)
21  - serial : 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-{100us,4ms,8ms,16ms} : set over current timer delay (default is 8ms)
35  - compound-device : indicated the hub is part of a compound device
36  - port-mapping-mode : enable port mapping mode
37  - string-support : enable string descriptor support (required for manufacturer,
38         product and serial string configuration)
39  - non-removable-ports : Should specify the ports which have a non-removable
40         device connected.
41  - sp-disabled-ports : Specifies the ports which will be self-power disabled
42  - bp-disabled-ports : Specifies the ports which will be bus-power disabled
43  - max-sp-power : Specifies the maximum current the hub consumes from an
44         upstream port when operating as self-powered hub including the power
45         consumption of a permanently attached peripheral if the hub is
46         configured as a compound device. The value is given in mA in a 0 - 500
47         range (default is 2).
48  - max-bp-power : Specifies the maximum current the hub consumes from an
49         upstream port when operating as bus-powered hub including the power
50         consumption of a permanently attached peripheral if the hub is
51         configured as a compound device. The value is given in mA in a 0 - 500
52         range (default is 100).
53  - max-sp-current : Specifies the maximum current the hub consumes from an
54         upstream port when operating as self-powered hub EXCLUDING the power
55         consumption of a permanently attached peripheral if the hub is
56         configured as a compound device. The value is given in mA in a 0 - 500
57         range (default is 2).
58  - max-bp-current : Specifies the maximum current the hub consumes from an
59         upstream port when operating as bus-powered hub EXCLUDING the power
60         consumption of a permanently attached peripheral if the hub is
61         configured as a compound device. The value is given in mA in a 0 - 500
62         range (default is 100).
63  - power-on-time : Specifies the time it takes from the time the host initiates
64         the power-on sequence to a port until the port has adequate power. The
65         value is given in ms in a 0 - 510 range (default is 100ms).
66
67 Examples:
68         usb2512b@2c {
69                 compatible = "microchip,usb2512b";
70                 hub-reset-gpios = <&gpio1 4 GPIO_ACTIVE_LOW>;
71         };
72
73         usb2514b@2c {
74                 compatible = "microchip,usb2514b";
75                 reg = <0x2c>;
76                 reset-gpios = <&gpio1 4 GPIO_ACTIVE_LOW>;
77                 vendor-id = /bits/ 16 <0x0000>;
78                 product-id = /bits/ 16 <0x0000>;
79                 string-support;
80                 manufacturer = "Foo";
81                 product = "Foo-Bar";
82                 serial = "1234567890A";
83         };