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