Merge tag 'linux-cpupower-4.15-rc2' of git://git.kernel.org/pub/scm/linux/kernel...
[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 USB251x/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         "microchip,usb2517", "microchip,usb2517i"
11  - reg : I2C address on the selected bus (default is <0x2C>)
12
13 Optional properties :
14  - reset-gpios : Should specify the gpio for hub reset
15  - skip-config : Skip Hub configuration, but only send the USB-Attach command
16  - vendor-id : Set USB Vendor ID of the hub (16 bit, default is 0x0424)
17  - product-id : Set USB Product ID of the hub (16 bit, default depends on type)
18  - device-id : Set USB Device ID of the hub (16 bit, default is 0x0bb3)
19  - language-id : Set USB Language ID (16 bit, default is 0x0000)
20  - manufacturer : Set USB Manufacturer string (max 31 characters long)
21  - product : Set USB Product string (max 31 characters long)
22  - serial : Set USB Serial string (max 31 characters long)
23  - {bus,self}-powered : selects between self- and bus-powered operation
24         (boolean, default is self-powered)
25  - disable-hi-speed : disable USB Hi-Speed support (boolean)
26  - {multi,single}-tt : selects between multi- and single-transaction-translator
27         (boolean, default is multi-tt)
28  - disable-eop : disable End of Packet generation in full-speed mode (boolean)
29  - {ganged,individual}-sensing : select over-current sense type in self-powered
30         mode (boolean, default is individual)
31  - {ganged,individual}-port-switching : select port power switching mode
32         (boolean, default is individual)
33  - dynamic-power-switching : enable auto-switching from self- to bus-powered
34         operation if the local power source is removed or unavailable (boolean)
35  - oc-delay-us : Delay time (in microseconds) for filtering the over-current
36         sense inputs. Valid values are 100, 4000, 8000 (default) and 16000. If
37         an invalid value is given, the default is used instead.
38  - compound-device : indicate the hub is part of a compound device (boolean)
39  - port-mapping-mode : enable port mapping mode (boolean)
40  - led-{usb,speed}-mode : led usb/speed indication mode selection
41         (boolean, default is speed mode)
42  - string-support : enable string descriptor support (required for manufacturer,
43         product and serial string configuration)
44  - non-removable-ports : Should specify the ports which have a non-removable
45         device connected.
46  - sp-disabled-ports : Specifies the ports which will be self-power disabled
47  - bp-disabled-ports : Specifies the ports which will be bus-power disabled
48  - sp-max-total-current-microamp: Specifies max current consumed by the hub
49         from VBUS when operating in self-powered hub. It includes the hub
50         silicon along with all associated circuitry including a permanently
51         attached peripheral (range: 0 - 100000 uA, default 1000 uA)
52  - bp-max-total-current-microamp: Specifies max current consumed by the hub
53         from VBUS when operating in self-powered hub. It includes the hub
54         silicon along with all associated circuitry including a permanently
55         attached peripheral (range: 0 - 510000 uA, default 100000 uA)
56  - sp-max-removable-current-microamp: Specifies max current consumed by the hub
57         from VBUS when operating in self-powered hub. It includes the hub
58         silicon along with all associated circuitry excluding a permanently
59         attached peripheral (range: 0 - 100000 uA, default 1000 uA)
60  - bp-max-removable-current-microamp: Specifies max current consumed by the hub
61         from VBUS when operating in self-powered hub. It includes the hub
62         silicon along with all associated circuitry excluding a permanently
63         attached peripheral (range: 0 - 510000 uA, default 100000 uA)
64  - power-on-time-ms : Specifies the time it takes from the time the host
65         initiates the power-on sequence to a port until the port has adequate
66         power. The value is given in ms in a 0 - 510 range (default is 100ms).
67
68 Examples:
69         usb2512b@2c {
70                 compatible = "microchip,usb2512b";
71                 reg = <0x2c>;
72                 reset-gpios = <&gpio1 4 GPIO_ACTIVE_LOW>;
73         };
74
75         usb2514b@2c {
76                 compatible = "microchip,usb2514b";
77                 reg = <0x2c>;
78                 vendor-id = /bits/ 16 <0x0000>;
79                 product-id = /bits/ 16 <0x0000>;
80                 string-support;
81                 manufacturer = "Foo";
82                 product = "Foo-Bar";
83                 serial = "1234567890A";
84         };