Merge tag 'for-5.3-rc4-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/kdave...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / usb / dwc2.txt
1 Platform DesignWare HS OTG USB 2.0 controller
2 -----------------------------------------------------
3
4 Required properties:
5 - compatible : One of:
6   - brcm,bcm2835-usb: The DWC2 USB controller instance in the BCM2835 SoC.
7   - hisilicon,hi6220-usb: The DWC2 USB controller instance in the hi6220 SoC.
8   - rockchip,rk3066-usb: The DWC2 USB controller instance in the rk3066 Soc;
9   - "rockchip,px30-usb", "rockchip,rk3066-usb", "snps,dwc2": for px30 Soc;
10   - "rockchip,rk3188-usb", "rockchip,rk3066-usb", "snps,dwc2": for rk3188 Soc;
11   - "rockchip,rk3288-usb", "rockchip,rk3066-usb", "snps,dwc2": for rk3288 Soc;
12   - "lantiq,arx100-usb": The DWC2 USB controller instance in Lantiq ARX SoCs;
13   - "lantiq,xrx200-usb": The DWC2 USB controller instance in Lantiq XRX SoCs;
14   - "amlogic,meson8-usb": The DWC2 USB controller instance in Amlogic Meson8 SoCs;
15   - "amlogic,meson8b-usb": The DWC2 USB controller instance in Amlogic Meson8b SoCs;
16   - "amlogic,meson-gxbb-usb": The DWC2 USB controller instance in Amlogic S905 SoCs;
17   - "amlogic,meson-g12a-usb": The DWC2 USB controller instance in Amlogic G12A SoCs;
18   - "amcc,dwc-otg": The DWC2 USB controller instance in AMCC Canyonlands 460EX SoCs;
19   - snps,dwc2: A generic DWC2 USB controller with default parameters.
20   - "st,stm32f4x9-fsotg": The DWC2 USB FS/HS controller instance in STM32F4x9 SoCs
21   configured in FS mode;
22   - "st,stm32f4x9-hsotg": The DWC2 USB HS controller instance in STM32F4x9 SoCs
23   configured in HS mode;
24   - "st,stm32f7-hsotg": The DWC2 USB HS controller instance in STM32F7 SoCs
25     configured in HS mode;
26 - reg : Should contain 1 register range (address and length)
27 - interrupts : Should contain 1 interrupt
28 - clocks: clock provider specifier
29 - clock-names: shall be "otg"
30 Refer to clk/clock-bindings.txt for generic clock consumer properties
31
32 Optional properties:
33 - phys: phy provider specifier
34 - phy-names: shall be "usb2-phy"
35 - vbus-supply: reference to the VBUS regulator. Depending on the current mode
36   this is enabled (in "host" mode") or disabled (in "peripheral" mode). The
37   regulator is updated if the controller is configured in "otg" mode and the
38   status changes between "host" and "peripheral".
39 Refer to phy/phy-bindings.txt for generic phy consumer properties
40 - dr_mode: shall be one of "host", "peripheral" and "otg"
41   Refer to usb/generic.txt
42 - g-rx-fifo-size: size of rx fifo size in gadget mode.
43 - g-np-tx-fifo-size: size of non-periodic tx fifo size in gadget mode.
44 - g-tx-fifo-size: size of periodic tx fifo per endpoint (except ep0) in gadget mode.
45 - snps,need-phy-for-wake: If present indicates that the phy needs to be left
46                           on for remote wakeup during suspend.
47 - snps,reset-phy-on-wake: If present indicates that we need to reset the PHY when
48                           we detect a wakeup.  This is due to a hardware errata.
49
50 Deprecated properties:
51 - g-use-dma: gadget DMA mode is automatically detected
52
53 Example:
54
55         usb@101c0000 {
56                 compatible = "ralink,rt3050-usb, snps,dwc2";
57                 reg = <0x101c0000 40000>;
58                 interrupts = <18>;
59                 clocks = <&usb_otg_ahb_clk>;
60                 clock-names = "otg";
61                 phys = <&usbphy>;
62                 phy-names = "usb2-phy";
63                 snps,need-phy-for-wake;
64         };