]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/commitdiff
dt-bindings: mt8173-xhci: add generic compatible and rename file
authorChunfeng Yun <chunfeng.yun@mediatek.com>
Wed, 30 Aug 2017 11:34:10 +0000 (19:34 +0800)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 31 Aug 2017 16:08:46 +0000 (18:08 +0200)
The mt8173-xhci.txt actually holds the bindings for all mediatek
SoCs with xHCI controller, so add a generic compatible and change
the name to mediatek,mtk-xhci.txt to reflect that.

Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt [new file with mode: 0644]
Documentation/devicetree/bindings/usb/mt8173-mtu3.txt
Documentation/devicetree/bindings/usb/mt8173-xhci.txt [deleted file]

diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt
new file mode 100644 (file)
index 0000000..5611a2e
--- /dev/null
@@ -0,0 +1,111 @@
+MT8173 xHCI
+
+The device node for Mediatek SOC USB3.0 host controller
+
+There are two scenarios: the first one only supports xHCI driver;
+the second one supports dual-role mode, and the host is based on xHCI
+driver. Take account of backward compatibility, we divide bindings
+into two parts.
+
+1st: only supports xHCI driver
+------------------------------------------------------------------------
+
+Required properties:
+ - compatible : should be "mediatek,<soc-model>-xhci", "mediatek,mtk-xhci",
+       soc-model is the name of SoC, such as mt8173, mt2712 etc, when using
+       "mediatek,mtk-xhci" compatible string, you need SoC specific ones in
+       addition, one of:
+       - "mediatek,mt8173-xhci"
+ - reg : specifies physical base address and size of the registers
+ - reg-names: should be "mac" for xHCI MAC and "ippc" for IP port control
+ - interrupts : interrupt used by the controller
+ - power-domains : a phandle to USB power domain node to control USB's
+       mtcmos
+ - vusb33-supply : regulator of USB avdd3.3v
+
+ - clocks : a list of phandle + clock-specifier pairs, one for each
+       entry in clock-names
+ - clock-names : must contain
+       "sys_ck": for clock of xHCI MAC
+       "ref_ck": for reference clock of xHCI MAC
+       "wakeup_deb_p0": for USB wakeup debounce clock of port0
+       "wakeup_deb_p1": for USB wakeup debounce clock of port1
+
+ - phys : a list of phandle + phy specifier pairs
+
+Optional properties:
+ - mediatek,wakeup-src : 1: ip sleep wakeup mode; 2: line state wakeup
+       mode;
+ - mediatek,syscon-wakeup : phandle to syscon used to access USB wakeup
+       control register, it depends on "mediatek,wakeup-src".
+ - vbus-supply : reference to the VBUS regulator;
+ - usb3-lpm-capable : supports USB3.0 LPM
+ - pinctrl-names : a pinctrl state named "default" must be defined
+ - pinctrl-0 : pin control group
+       See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
+
+Example:
+usb30: usb@11270000 {
+       compatible = "mediatek,mt8173-xhci";
+       reg = <0 0x11270000 0 0x1000>,
+             <0 0x11280700 0 0x0100>;
+       reg-names = "mac", "ippc";
+       interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
+       power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
+       clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>,
+                <&pericfg CLK_PERI_USB0>,
+                <&pericfg CLK_PERI_USB1>;
+       clock-names = "sys_ck", "ref_ck",
+                     "wakeup_deb_p0",
+                     "wakeup_deb_p1";
+       phys = <&phy_port0 PHY_TYPE_USB3>,
+              <&phy_port1 PHY_TYPE_USB2>;
+       vusb33-supply = <&mt6397_vusb_reg>;
+       vbus-supply = <&usb_p1_vbus>;
+       usb3-lpm-capable;
+       mediatek,syscon-wakeup = <&pericfg>;
+       mediatek,wakeup-src = <1>;
+};
+
+2nd: dual-role mode with xHCI driver
+------------------------------------------------------------------------
+
+In the case, xhci is added as subnode to mtu3. An example and the DT binding
+details of mtu3 can be found in:
+Documentation/devicetree/bindings/usb/mediatek,mtu3.txt
+
+Required properties:
+ - compatible : should be "mediatek,<soc-model>-xhci", "mediatek,mtk-xhci",
+       soc-model is the name of SoC, such as mt8173, mt2712 etc, when using
+       "mediatek,mtk-xhci" compatible string, you need SoC specific ones in
+       addition, one of:
+       - "mediatek,mt8173-xhci"
+ - reg : specifies physical base address and size of the registers
+ - reg-names: should be "mac" for xHCI MAC
+ - interrupts : interrupt used by the host controller
+ - power-domains : a phandle to USB power domain node to control USB's
+       mtcmos
+ - vusb33-supply : regulator of USB avdd3.3v
+
+ - clocks : a list of phandle + clock-specifier pairs, one for each
+       entry in clock-names
+ - clock-names : must be
+       "sys_ck": for clock of xHCI MAC
+       "ref_ck": for reference clock of xHCI MAC
+
+Optional properties:
+ - vbus-supply : reference to the VBUS regulator;
+ - usb3-lpm-capable : supports USB3.0 LPM
+
+Example:
+usb30: usb@11270000 {
+       compatible = "mediatek,mt8173-xhci";
+       reg = <0 0x11270000 0 0x1000>;
+       reg-names = "mac";
+       interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
+       power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
+       clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>;
+       clock-names = "sys_ck", "ref_ck";
+       vusb33-supply = <&mt6397_vusb_reg>;
+       usb3-lpm-capable;
+};
index 1d7c3bc677f75c43bba01362952bfec648b43e35..b8ea394397bfbee71b923f96e054e7d6e9e0eb50 100644 (file)
@@ -44,7 +44,7 @@ Optional properties:
 Sub-nodes:
 The xhci should be added as subnode to mtu3 as shown in the following example
 if host mode is enabled. The DT binding details of xhci can be found in:
-Documentation/devicetree/bindings/usb/mt8173-xhci.txt
+Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt
 
 Example:
 ssusb: usb@11271000 {
diff --git a/Documentation/devicetree/bindings/usb/mt8173-xhci.txt b/Documentation/devicetree/bindings/usb/mt8173-xhci.txt
deleted file mode 100644 (file)
index 0acfc8a..0000000
+++ /dev/null
@@ -1,103 +0,0 @@
-MT8173 xHCI
-
-The device node for Mediatek SOC USB3.0 host controller
-
-There are two scenarios: the first one only supports xHCI driver;
-the second one supports dual-role mode, and the host is based on xHCI
-driver. Take account of backward compatibility, we divide bindings
-into two parts.
-
-1st: only supports xHCI driver
-------------------------------------------------------------------------
-
-Required properties:
- - compatible : should contain "mediatek,mt8173-xhci"
- - reg : specifies physical base address and size of the registers
- - reg-names: should be "mac" for xHCI MAC and "ippc" for IP port control
- - interrupts : interrupt used by the controller
- - power-domains : a phandle to USB power domain node to control USB's
-       mtcmos
- - vusb33-supply : regulator of USB avdd3.3v
-
- - clocks : a list of phandle + clock-specifier pairs, one for each
-       entry in clock-names
- - clock-names : must contain
-       "sys_ck": for clock of xHCI MAC
-       "ref_ck": for reference clock of xHCI MAC
-       "wakeup_deb_p0": for USB wakeup debounce clock of port0
-       "wakeup_deb_p1": for USB wakeup debounce clock of port1
-
- - phys : a list of phandle + phy specifier pairs
-
-Optional properties:
- - mediatek,wakeup-src : 1: ip sleep wakeup mode; 2: line state wakeup
-       mode;
- - mediatek,syscon-wakeup : phandle to syscon used to access USB wakeup
-       control register, it depends on "mediatek,wakeup-src".
- - vbus-supply : reference to the VBUS regulator;
- - usb3-lpm-capable : supports USB3.0 LPM
- - pinctrl-names : a pinctrl state named "default" must be defined
- - pinctrl-0 : pin control group
-       See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
-
-Example:
-usb30: usb@11270000 {
-       compatible = "mediatek,mt8173-xhci";
-       reg = <0 0x11270000 0 0x1000>,
-             <0 0x11280700 0 0x0100>;
-       reg-names = "mac", "ippc";
-       interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
-       power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
-       clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>,
-                <&pericfg CLK_PERI_USB0>,
-                <&pericfg CLK_PERI_USB1>;
-       clock-names = "sys_ck", "ref_ck",
-                     "wakeup_deb_p0",
-                     "wakeup_deb_p1";
-       phys = <&phy_port0 PHY_TYPE_USB3>,
-              <&phy_port1 PHY_TYPE_USB2>;
-       vusb33-supply = <&mt6397_vusb_reg>;
-       vbus-supply = <&usb_p1_vbus>;
-       usb3-lpm-capable;
-       mediatek,syscon-wakeup = <&pericfg>;
-       mediatek,wakeup-src = <1>;
-};
-
-2nd: dual-role mode with xHCI driver
-------------------------------------------------------------------------
-
-In the case, xhci is added as subnode to mtu3. An example and the DT binding
-details of mtu3 can be found in:
-Documentation/devicetree/bindings/usb/mt8173-mtu3.txt
-
-Required properties:
- - compatible : should contain "mediatek,mt8173-xhci"
- - reg : specifies physical base address and size of the registers
- - reg-names: should be "mac" for xHCI MAC
- - interrupts : interrupt used by the host controller
- - power-domains : a phandle to USB power domain node to control USB's
-       mtcmos
- - vusb33-supply : regulator of USB avdd3.3v
-
- - clocks : a list of phandle + clock-specifier pairs, one for each
-       entry in clock-names
- - clock-names : must be
-       "sys_ck": for clock of xHCI MAC
-       "ref_ck": for reference clock of xHCI MAC
-
-Optional properties:
- - vbus-supply : reference to the VBUS regulator;
- - usb3-lpm-capable : supports USB3.0 LPM
-
-Example:
-usb30: usb@11270000 {
-       compatible = "mediatek,mt8173-xhci";
-       reg = <0 0x11270000 0 0x1000>;
-       reg-names = "mac";
-       interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
-       power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
-       clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>;
-       clock-names = "sys_ck", "ref_ck";
-       vusb33-supply = <&mt6397_vusb_reg>;
-       usb3-lpm-capable;
-};