Merge tag 'docs-4.10-2' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / usb / mt8173-xhci.txt
1 MT8173 xHCI
2
3 The device node for Mediatek SOC USB3.0 host controller
4
5 There are two scenarios: the first one only supports xHCI driver;
6 the second one supports dual-role mode, and the host is based on xHCI
7 driver. Take account of backward compatibility, we divide bindings
8 into two parts.
9
10 1st: only supports xHCI driver
11 ------------------------------------------------------------------------
12
13 Required properties:
14  - compatible : should contain "mediatek,mt8173-xhci"
15  - reg : specifies physical base address and size of the registers
16  - reg-names: should be "mac" for xHCI MAC and "ippc" for IP port control
17  - interrupts : interrupt used by the controller
18  - power-domains : a phandle to USB power domain node to control USB's
19         mtcmos
20  - vusb33-supply : regulator of USB avdd3.3v
21
22  - clocks : a list of phandle + clock-specifier pairs, one for each
23         entry in clock-names
24  - clock-names : must contain
25         "sys_ck": for clock of xHCI MAC
26         "wakeup_deb_p0": for USB wakeup debounce clock of port0
27         "wakeup_deb_p1": for USB wakeup debounce clock of port1
28
29  - phys : a list of phandle + phy specifier pairs
30
31 Optional properties:
32  - mediatek,wakeup-src : 1: ip sleep wakeup mode; 2: line state wakeup
33         mode;
34  - mediatek,syscon-wakeup : phandle to syscon used to access USB wakeup
35         control register, it depends on "mediatek,wakeup-src".
36  - vbus-supply : reference to the VBUS regulator;
37  - usb3-lpm-capable : supports USB3.0 LPM
38  - pinctrl-names : a pinctrl state named "default" must be defined
39  - pinctrl-0 : pin control group
40         See: Documentation/devicetree/bindings/pinctrl/pinctrl-binding.txt
41
42 Example:
43 usb30: usb@11270000 {
44         compatible = "mediatek,mt8173-xhci";
45         reg = <0 0x11270000 0 0x1000>,
46               <0 0x11280700 0 0x0100>;
47         reg-names = "mac", "ippc";
48         interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
49         power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
50         clocks = <&topckgen CLK_TOP_USB30_SEL>,
51                  <&pericfg CLK_PERI_USB0>,
52                  <&pericfg CLK_PERI_USB1>;
53         clock-names = "sys_ck",
54                       "wakeup_deb_p0",
55                       "wakeup_deb_p1";
56         phys = <&phy_port0 PHY_TYPE_USB3>,
57                <&phy_port1 PHY_TYPE_USB2>;
58         vusb33-supply = <&mt6397_vusb_reg>;
59         vbus-supply = <&usb_p1_vbus>;
60         usb3-lpm-capable;
61         mediatek,syscon-wakeup = <&pericfg>;
62         mediatek,wakeup-src = <1>;
63 };
64
65 2nd: dual-role mode with xHCI driver
66 ------------------------------------------------------------------------
67
68 In the case, xhci is added as subnode to mtu3. An example and the DT binding
69 details of mtu3 can be found in:
70 Documentation/devicetree/bindings/usb/mtu3.txt
71
72 Required properties:
73  - compatible : should contain "mediatek,mt8173-xhci"
74  - reg : specifies physical base address and size of the registers
75  - reg-names: should be "mac" for xHCI MAC
76  - interrupts : interrupt used by the host controller
77  - power-domains : a phandle to USB power domain node to control USB's
78         mtcmos
79  - vusb33-supply : regulator of USB avdd3.3v
80
81  - clocks : a list of phandle + clock-specifier pairs, one for each
82         entry in clock-names
83  - clock-names : must be
84         "sys_ck": for clock of xHCI MAC
85
86 Optional properties:
87  - vbus-supply : reference to the VBUS regulator;
88  - usb3-lpm-capable : supports USB3.0 LPM
89
90 Example:
91 usb30: usb@11270000 {
92         compatible = "mediatek,mt8173-xhci";
93         reg = <0 0x11270000 0 0x1000>;
94         reg-names = "mac";
95         interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
96         power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
97         clocks = <&topckgen CLK_TOP_USB30_SEL>;
98         clock-names = "sys_ck";
99         vusb33-supply = <&mt6397_vusb_reg>;
100         usb3-lpm-capable;
101 };