GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / usb / generic.txt
1 Generic USB Properties
2
3 Optional properties:
4  - maximum-speed: tells USB controllers we want to work up to a certain
5                         speed. Valid arguments are "super-speed", "high-speed",
6                         "full-speed" and "low-speed". In case this isn't passed
7                         via DT, USB controllers should default to their maximum
8                         HW capability.
9  - dr_mode: tells Dual-Role USB controllers that we want to work on a
10                         particular mode. Valid arguments are "host",
11                         "peripheral" and "otg". In case this attribute isn't
12                         passed via DT, USB DRD controllers should default to
13                         OTG.
14  - phy_type: tells USB controllers that we want to configure the core to support
15                         a UTMI+ PHY with an 8- or 16-bit interface if UTMI+ is
16                         selected. Valid arguments are "utmi" and "utmi_wide".
17                         In case this isn't passed via DT, USB controllers should
18                         default to HW capability.
19  - otg-rev: tells usb driver the release number of the OTG and EH supplement
20                         with which the device and its descriptors are compliant,
21                         in binary-coded decimal (i.e. 2.0 is 0200H). This
22                         property is used if any real OTG features(HNP/SRP/ADP)
23                         is enabled, if ADP is required, otg-rev should be
24                         0x0200 or above.
25  - companion: phandle of a companion
26  - hnp-disable: tells OTG controllers we want to disable OTG HNP, normally HNP
27                         is the basic function of real OTG except you want it
28                         to be a srp-capable only B device.
29  - srp-disable: tells OTG controllers we want to disable OTG SRP, SRP is
30                         optional for OTG device.
31  - adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is
32                         optional for OTG device.
33
34 This is an attribute to a USB controller such as:
35
36 dwc3@4a030000 {
37         compatible = "synopsys,dwc3";
38         reg = <0x4a030000 0xcfff>;
39         interrupts = <0 92 4>
40         usb-phy = <&usb2_phy>, <&usb3,phy>;
41         maximum-speed = "super-speed";
42         dr_mode = "otg";
43         phy_type = "utmi_wide";
44         otg-rev = <0x0200>;
45         adp-disable;
46 };