1 // SPDX-License-Identifier: GPL-2.0+
3 * Freescale i.MX28 USB Host driver
5 * Copyright (C) 2011 Marek Vasut <marek.vasut@gmail.com>
6 * on behalf of DENX Software Engineering GmbH
11 #include <asm/arch/imx-regs.h>
13 #include <linux/delay.h>
15 #include <power/regulator.h>
19 /* This DIGCTL register ungates clock to USB */
20 #define HW_DIGCTL_CTRL 0x8001c000
21 #define HW_DIGCTL_CTRL_USB0_CLKGATE (1 << 2)
22 #define HW_DIGCTL_CTRL_USB1_CLKGATE (1 << 16)
24 struct ehci_mxs_port {
26 struct mxs_usbphy_regs *phy_regs;
28 struct mxs_register_32 *pll;
30 uint32_t pll_dis_bits;
34 static int ehci_mxs_toggle_clock(const struct ehci_mxs_port *port, int enable)
36 struct mxs_register_32 *digctl_ctrl =
37 (struct mxs_register_32 *)HW_DIGCTL_CTRL;
38 int pll_offset, dig_offset;
41 pll_offset = offsetof(struct mxs_register_32, reg_set);
42 dig_offset = offsetof(struct mxs_register_32, reg_clr);
43 writel(port->gate_bits, (u32)&digctl_ctrl->reg + dig_offset);
44 writel(port->pll_en_bits, (u32)port->pll + pll_offset);
46 pll_offset = offsetof(struct mxs_register_32, reg_clr);
47 dig_offset = offsetof(struct mxs_register_32, reg_set);
48 writel(port->pll_dis_bits, (u32)port->pll + pll_offset);
49 writel(port->gate_bits, (u32)&digctl_ctrl->reg + dig_offset);
55 static int __ehci_hcd_init(struct ehci_mxs_port *port, enum usb_init_type init,
56 struct ehci_hccr **hccr, struct ehci_hcor **hcor)
58 u32 usb_base, cap_base;
61 /* Reset the PHY block */
62 writel(USBPHY_CTRL_SFTRST, &port->phy_regs->hw_usbphy_ctrl_set);
64 writel(USBPHY_CTRL_SFTRST | USBPHY_CTRL_CLKGATE,
65 &port->phy_regs->hw_usbphy_ctrl_clr);
67 /* Enable USB clock */
68 ret = ehci_mxs_toggle_clock(port, 1);
73 writel(0, &port->phy_regs->hw_usbphy_pwd);
75 /* Enable UTMI+ Level 2 and Level 3 compatibility */
76 writel(USBPHY_CTRL_ENUTMILEVEL3 | USBPHY_CTRL_ENUTMILEVEL2 | 1,
77 &port->phy_regs->hw_usbphy_ctrl_set);
79 usb_base = port->usb_regs + 0x100;
80 *hccr = (struct ehci_hccr *)usb_base;
82 cap_base = ehci_readl(&(*hccr)->cr_capbase);
83 *hcor = (struct ehci_hcor *)(usb_base + HC_LENGTH(cap_base));
88 static int __ehci_hcd_stop(struct ehci_mxs_port *port)
90 u32 usb_base, cap_base, tmp;
91 struct ehci_hccr *hccr;
92 struct ehci_hcor *hcor;
94 /* Stop the USB port */
95 usb_base = port->usb_regs + 0x100;
96 hccr = (struct ehci_hccr *)usb_base;
97 cap_base = ehci_readl(&hccr->cr_capbase);
98 hcor = (struct ehci_hcor *)(usb_base + HC_LENGTH(cap_base));
100 tmp = ehci_readl(&hcor->or_usbcmd);
102 ehci_writel(&hcor->or_usbcmd, tmp);
104 /* Disable the PHY */
105 tmp = USBPHY_PWD_RXPWDRX | USBPHY_PWD_RXPWDDIFF |
106 USBPHY_PWD_RXPWD1PT1 | USBPHY_PWD_RXPWDENV |
107 USBPHY_PWD_TXPWDV2I | USBPHY_PWD_TXPWDIBIAS |
109 writel(tmp, &port->phy_regs->hw_usbphy_pwd);
111 /* Disable USB clock */
112 return ehci_mxs_toggle_clock(port, 0);
115 #if !CONFIG_IS_ENABLED(DM_USB)
116 static const struct ehci_mxs_port mxs_port[] = {
117 #ifdef CONFIG_EHCI_MXS_PORT0
120 (struct mxs_usbphy_regs *)MXS_USBPHY0_BASE,
121 (struct mxs_register_32 *)(MXS_CLKCTRL_BASE +
122 offsetof(struct mxs_clkctrl_regs,
123 hw_clkctrl_pll0ctrl0_reg)),
124 CLKCTRL_PLL0CTRL0_EN_USB_CLKS | CLKCTRL_PLL0CTRL0_POWER,
125 CLKCTRL_PLL0CTRL0_EN_USB_CLKS,
126 HW_DIGCTL_CTRL_USB0_CLKGATE,
129 #ifdef CONFIG_EHCI_MXS_PORT1
132 (struct mxs_usbphy_regs *)MXS_USBPHY1_BASE,
133 (struct mxs_register_32 *)(MXS_CLKCTRL_BASE +
134 offsetof(struct mxs_clkctrl_regs,
135 hw_clkctrl_pll1ctrl0_reg)),
136 CLKCTRL_PLL1CTRL0_EN_USB_CLKS | CLKCTRL_PLL1CTRL0_POWER,
137 CLKCTRL_PLL1CTRL0_EN_USB_CLKS,
138 HW_DIGCTL_CTRL_USB1_CLKGATE,
143 int __weak board_ehci_hcd_init(int port)
148 int __weak board_ehci_hcd_exit(int port)
153 int ehci_hcd_init(int index, enum usb_init_type init,
154 struct ehci_hccr **hccr, struct ehci_hcor **hcor)
158 const struct ehci_mxs_port *port;
160 if ((index < 0) || (index >= ARRAY_SIZE(mxs_port))) {
161 printf("Invalid port index (index = %d)!\n", index);
165 ret = board_ehci_hcd_init(index);
169 port = &mxs_port[index];
170 return __ehci_hcd_init(port, init, hccr, hcor);
173 int ehci_hcd_stop(int index)
176 const struct ehci_mxs_port *port;
178 if ((index < 0) || (index >= ARRAY_SIZE(mxs_port))) {
179 printf("Invalid port index (index = %d)!\n", index);
183 port = &mxs_port[index];
185 ret = __ehci_hcd_stop(port);
186 board_ehci_hcd_exit(index);
190 #else /* CONFIG_IS_ENABLED(DM_USB) */
191 struct ehci_mxs_priv_data {
192 struct ehci_ctrl ctrl;
193 struct usb_ehci *ehci;
194 struct udevice *vbus_supply;
195 struct ehci_mxs_port port;
196 enum usb_init_type init_type;
200 * Below defines correspond to imx28 clk Linux (v5.15.y)
201 * clock driver to provide proper offset for PHY[01]
204 #define CLK_USB_PHY0 62
205 #define CLK_USB_PHY1 63
206 #define PLL0CTRL0(base) ((base) + 0x0000)
207 #define PLL1CTRL0(base) ((base) + 0x0020)
209 static int ehci_usb_ofdata_to_platdata(struct udevice *dev)
211 struct ehci_mxs_priv_data *priv = dev_get_priv(dev);
212 struct usb_plat *plat = dev_get_plat(dev);
213 struct ehci_mxs_port *port = &priv->port;
214 u32 phandle, phy_reg, clk_reg, clk_id;
215 ofnode phy_node, clk_node;
219 mode = ofnode_read_string(dev->node_, "dr_mode");
221 if (strcmp(mode, "peripheral") == 0)
222 plat->init_type = USB_INIT_DEVICE;
223 else if (strcmp(mode, "host") == 0)
224 plat->init_type = USB_INIT_HOST;
229 /* Read base address of the USB IP block */
230 ret = ofnode_read_u32(dev->node_, "reg", &port->usb_regs);
234 /* Read base address of the USB PHY IP block */
235 ret = ofnode_read_u32(dev->node_, "fsl,usbphy", &phandle);
239 phy_node = ofnode_get_by_phandle(phandle);
240 if (!ofnode_valid(phy_node))
243 ret = ofnode_read_u32(phy_node, "reg", &phy_reg);
247 port->phy_regs = (struct mxs_usbphy_regs *)phy_reg;
249 /* Read base address of the CLK IP block and proper ID */
250 ret = ofnode_read_u32_index(phy_node, "clocks", 0, &phandle);
254 ret = ofnode_read_u32_index(phy_node, "clocks", 1, &clk_id);
258 clk_node = ofnode_get_by_phandle(phandle);
259 if (!ofnode_valid(clk_node))
262 ret = ofnode_read_u32(clk_node, "reg", &clk_reg);
266 port->pll = (struct mxs_register_32 *)clk_reg;
268 /* Provide proper offset for USB PHY clocks */
269 if (clk_id == CLK_USB_PHY0)
270 port->pll = PLL0CTRL0(port->pll);
272 if (clk_id == CLK_USB_PHY1)
273 port->pll = PLL1CTRL0(port->pll);
275 debug("%s: pll_reg: 0x%p clk_id: %d\n", __func__, port->pll, clk_id);
277 * On the imx28 the values provided by CLKCTRL_PLL0* defines to are the
278 * same as ones for CLKCTRL_PLL1*. As a result the former can be used
279 * for both ports - i.e. (usb[01]).
281 port->pll_en_bits = CLKCTRL_PLL0CTRL0_EN_USB_CLKS |
282 CLKCTRL_PLL0CTRL0_POWER;
283 port->pll_dis_bits = CLKCTRL_PLL0CTRL0_EN_USB_CLKS;
284 port->gate_bits = HW_DIGCTL_CTRL_USB0_CLKGATE;
289 static int ehci_usb_probe(struct udevice *dev)
291 struct usb_plat *plat = dev_get_plat(dev);
292 struct usb_ehci *ehci = dev_read_addr_ptr(dev);
293 struct ehci_mxs_priv_data *priv = dev_get_priv(dev);
294 struct ehci_mxs_port *port = &priv->port;
295 enum usb_init_type type = plat->init_type;
296 struct ehci_hccr *hccr;
297 struct ehci_hcor *hcor;
301 priv->init_type = type;
303 debug("%s: USB type: %s reg: 0x%x phy_reg 0x%p\n", __func__,
304 type == USB_INIT_HOST ? "HOST" : "DEVICE", port->usb_regs,
305 (uint32_t *)port->phy_regs);
307 #if CONFIG_IS_ENABLED(DM_REGULATOR)
308 ret = device_get_supply_regulator(dev, "vbus-supply",
311 debug("%s: No vbus supply\n", dev->name);
313 if (!ret && priv->vbus_supply) {
314 ret = regulator_set_enable(priv->vbus_supply,
315 (type == USB_INIT_DEVICE) ?
318 puts("Error enabling VBUS supply\n");
323 ret = __ehci_hcd_init(port, type, &hccr, &hcor);
328 return ehci_register(dev, hccr, hcor, NULL, 0, priv->init_type);
331 static int ehci_usb_remove(struct udevice *dev)
333 struct ehci_mxs_priv_data *priv = dev_get_priv(dev);
334 struct ehci_mxs_port *port = &priv->port;
337 ret = ehci_deregister(dev);
341 #if CONFIG_IS_ENABLED(DM_REGULATOR)
342 if (priv->vbus_supply) {
343 ret = regulator_set_enable(priv->vbus_supply, false);
345 puts("Error disabling VBUS supply\n");
350 return __ehci_hcd_stop(port);
353 static const struct udevice_id mxs_usb_ids[] = {
354 { .compatible = "fsl,imx28-usb" },
358 U_BOOT_DRIVER(usb_mxs) = {
361 .of_match = mxs_usb_ids,
362 .of_to_plat = ehci_usb_ofdata_to_platdata,
363 .probe = ehci_usb_probe,
364 .remove = ehci_usb_remove,
365 .ops = &ehci_usb_ops,
366 .plat_auto = sizeof(struct usb_plat),
367 .priv_auto = sizeof(struct ehci_mxs_priv_data),
368 .flags = DM_FLAG_ALLOC_PRIV_DMA,
370 #endif /* !CONFIG_IS_ENABLED(DM_USB) */