xref: /openbmc/u-boot/drivers/usb/host/ehci-mx6.c (revision be059e88)
1 /*
2  * Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
3  * Copyright (C) 2010 Freescale Semiconductor, Inc.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <common.h>
9 #include <usb.h>
10 #include <errno.h>
11 #include <wait_bit.h>
12 #include <linux/compiler.h>
13 #include <usb/ehci-ci.h>
14 #include <asm/io.h>
15 #include <asm/arch/imx-regs.h>
16 #include <asm/arch/clock.h>
17 #include <asm/imx-common/iomux-v3.h>
18 #include <asm/imx-common/sys_proto.h>
19 #include <dm.h>
20 #include <power/regulator.h>
21 
22 #include "ehci.h"
23 
24 DECLARE_GLOBAL_DATA_PTR;
25 
26 #define USB_OTGREGS_OFFSET	0x000
27 #define USB_H1REGS_OFFSET	0x200
28 #define USB_H2REGS_OFFSET	0x400
29 #define USB_H3REGS_OFFSET	0x600
30 #define USB_OTHERREGS_OFFSET	0x800
31 
32 #define USB_H1_CTRL_OFFSET	0x04
33 
34 #define USBPHY_CTRL				0x00000030
35 #define USBPHY_CTRL_SET				0x00000034
36 #define USBPHY_CTRL_CLR				0x00000038
37 #define USBPHY_CTRL_TOG				0x0000003c
38 
39 #define USBPHY_PWD				0x00000000
40 #define USBPHY_CTRL_SFTRST			0x80000000
41 #define USBPHY_CTRL_CLKGATE			0x40000000
42 #define USBPHY_CTRL_ENUTMILEVEL3		0x00008000
43 #define USBPHY_CTRL_ENUTMILEVEL2		0x00004000
44 #define USBPHY_CTRL_OTG_ID			0x08000000
45 
46 #define ANADIG_USB2_CHRG_DETECT_EN_B		0x00100000
47 #define ANADIG_USB2_CHRG_DETECT_CHK_CHRG_B	0x00080000
48 
49 #define ANADIG_USB2_PLL_480_CTRL_BYPASS		0x00010000
50 #define ANADIG_USB2_PLL_480_CTRL_ENABLE		0x00002000
51 #define ANADIG_USB2_PLL_480_CTRL_POWER		0x00001000
52 #define ANADIG_USB2_PLL_480_CTRL_EN_USB_CLKS	0x00000040
53 
54 #define USBNC_OFFSET		0x200
55 #define USBNC_PHY_STATUS_OFFSET	0x23C
56 #define USBNC_PHYSTATUS_ID_DIG	(1 << 4) /* otg_id status */
57 #define USBNC_PHYCFG2_ACAENB	(1 << 4) /* otg_id detection enable */
58 #define UCTRL_PWR_POL		(1 << 9) /* OTG Polarity of Power Pin */
59 #define UCTRL_OVER_CUR_POL	(1 << 8) /* OTG Polarity of Overcurrent */
60 #define UCTRL_OVER_CUR_DIS	(1 << 7) /* Disable OTG Overcurrent Detection */
61 
62 /* USBCMD */
63 #define UCMD_RUN_STOP           (1 << 0) /* controller run/stop */
64 #define UCMD_RESET		(1 << 1) /* controller reset */
65 
66 #if defined(CONFIG_MX6)
67 static const unsigned phy_bases[] = {
68 	USB_PHY0_BASE_ADDR,
69 	USB_PHY1_BASE_ADDR,
70 };
71 
72 static void usb_internal_phy_clock_gate(int index, int on)
73 {
74 	void __iomem *phy_reg;
75 
76 	if (index >= ARRAY_SIZE(phy_bases))
77 		return;
78 
79 	phy_reg = (void __iomem *)phy_bases[index];
80 	phy_reg += on ? USBPHY_CTRL_CLR : USBPHY_CTRL_SET;
81 	writel(USBPHY_CTRL_CLKGATE, phy_reg);
82 }
83 
84 static void usb_power_config(int index)
85 {
86 	struct anatop_regs __iomem *anatop =
87 		(struct anatop_regs __iomem *)ANATOP_BASE_ADDR;
88 	void __iomem *chrg_detect;
89 	void __iomem *pll_480_ctrl_clr;
90 	void __iomem *pll_480_ctrl_set;
91 
92 	switch (index) {
93 	case 0:
94 		chrg_detect = &anatop->usb1_chrg_detect;
95 		pll_480_ctrl_clr = &anatop->usb1_pll_480_ctrl_clr;
96 		pll_480_ctrl_set = &anatop->usb1_pll_480_ctrl_set;
97 		break;
98 	case 1:
99 		chrg_detect = &anatop->usb2_chrg_detect;
100 		pll_480_ctrl_clr = &anatop->usb2_pll_480_ctrl_clr;
101 		pll_480_ctrl_set = &anatop->usb2_pll_480_ctrl_set;
102 		break;
103 	default:
104 		return;
105 	}
106 	/*
107 	 * Some phy and power's special controls
108 	 * 1. The external charger detector needs to be disabled
109 	 * or the signal at DP will be poor
110 	 * 2. The PLL's power and output to usb
111 	 * is totally controlled by IC, so the Software only needs
112 	 * to enable them at initializtion.
113 	 */
114 	writel(ANADIG_USB2_CHRG_DETECT_EN_B |
115 		     ANADIG_USB2_CHRG_DETECT_CHK_CHRG_B,
116 		     chrg_detect);
117 
118 	writel(ANADIG_USB2_PLL_480_CTRL_BYPASS,
119 		     pll_480_ctrl_clr);
120 
121 	writel(ANADIG_USB2_PLL_480_CTRL_ENABLE |
122 		     ANADIG_USB2_PLL_480_CTRL_POWER |
123 		     ANADIG_USB2_PLL_480_CTRL_EN_USB_CLKS,
124 		     pll_480_ctrl_set);
125 }
126 
127 /* Return 0 : host node, <>0 : device mode */
128 static int usb_phy_enable(int index, struct usb_ehci *ehci)
129 {
130 	void __iomem *phy_reg;
131 	void __iomem *phy_ctrl;
132 	void __iomem *usb_cmd;
133 	int ret;
134 
135 	if (index >= ARRAY_SIZE(phy_bases))
136 		return 0;
137 
138 	phy_reg = (void __iomem *)phy_bases[index];
139 	phy_ctrl = (void __iomem *)(phy_reg + USBPHY_CTRL);
140 	usb_cmd = (void __iomem *)&ehci->usbcmd;
141 
142 	/* Stop then Reset */
143 	clrbits_le32(usb_cmd, UCMD_RUN_STOP);
144 	ret = wait_for_bit(__func__, usb_cmd, UCMD_RUN_STOP, false, 10000,
145 			   false);
146 	if (ret)
147 		return ret;
148 
149 	setbits_le32(usb_cmd, UCMD_RESET);
150 	ret = wait_for_bit(__func__, usb_cmd, UCMD_RESET, false, 10000, false);
151 	if (ret)
152 		return ret;
153 
154 	/* Reset USBPHY module */
155 	setbits_le32(phy_ctrl, USBPHY_CTRL_SFTRST);
156 	udelay(10);
157 
158 	/* Remove CLKGATE and SFTRST */
159 	clrbits_le32(phy_ctrl, USBPHY_CTRL_CLKGATE | USBPHY_CTRL_SFTRST);
160 	udelay(10);
161 
162 	/* Power up the PHY */
163 	writel(0, phy_reg + USBPHY_PWD);
164 	/* enable FS/LS device */
165 	setbits_le32(phy_ctrl, USBPHY_CTRL_ENUTMILEVEL2 |
166 			USBPHY_CTRL_ENUTMILEVEL3);
167 
168 	return 0;
169 }
170 
171 int usb_phy_mode(int port)
172 {
173 	void __iomem *phy_reg;
174 	void __iomem *phy_ctrl;
175 	u32 val;
176 
177 	phy_reg = (void __iomem *)phy_bases[port];
178 	phy_ctrl = (void __iomem *)(phy_reg + USBPHY_CTRL);
179 
180 	val = readl(phy_ctrl);
181 
182 	if (val & USBPHY_CTRL_OTG_ID)
183 		return USB_INIT_DEVICE;
184 	else
185 		return USB_INIT_HOST;
186 }
187 
188 /* Base address for this IP block is 0x02184800 */
189 struct usbnc_regs {
190 	u32	ctrl[4];	/* otg/host1-3 */
191 	u32	uh2_hsic_ctrl;
192 	u32	uh3_hsic_ctrl;
193 	u32	otg_phy_ctrl_0;
194 	u32	uh1_phy_ctrl_0;
195 };
196 #elif defined(CONFIG_MX7)
197 struct usbnc_regs {
198 	u32 ctrl1;
199 	u32 ctrl2;
200 	u32 reserve1[10];
201 	u32 phy_cfg1;
202 	u32 phy_cfg2;
203 	u32 reserve2;
204 	u32 phy_status;
205 	u32 reserve3[4];
206 	u32 adp_cfg1;
207 	u32 adp_cfg2;
208 	u32 adp_status;
209 };
210 
211 static void usb_power_config(int index)
212 {
213 	struct usbnc_regs *usbnc = (struct usbnc_regs *)(USB_BASE_ADDR +
214 			(0x10000 * index) + USBNC_OFFSET);
215 	void __iomem *phy_cfg2 = (void __iomem *)(&usbnc->phy_cfg2);
216 	void __iomem *ctrl = (void __iomem *)(&usbnc->ctrl1);
217 
218 	/*
219 	 * Clear the ACAENB to enable usb_otg_id detection,
220 	 * otherwise it is the ACA detection enabled.
221 	 */
222 	clrbits_le32(phy_cfg2, USBNC_PHYCFG2_ACAENB);
223 
224 	/* Set power polarity to high active */
225 #ifdef CONFIG_MXC_USB_OTG_HACTIVE
226 	setbits_le32(ctrl, UCTRL_PWR_POL);
227 #else
228 	clrbits_le32(ctrl, UCTRL_PWR_POL);
229 #endif
230 }
231 
232 int usb_phy_mode(int port)
233 {
234 	struct usbnc_regs *usbnc = (struct usbnc_regs *)(USB_BASE_ADDR +
235 			(0x10000 * port) + USBNC_OFFSET);
236 	void __iomem *status = (void __iomem *)(&usbnc->phy_status);
237 	u32 val;
238 
239 	val = readl(status);
240 
241 	if (val & USBNC_PHYSTATUS_ID_DIG)
242 		return USB_INIT_DEVICE;
243 	else
244 		return USB_INIT_HOST;
245 }
246 #endif
247 
248 static void usb_oc_config(int index)
249 {
250 #if defined(CONFIG_MX6)
251 	struct usbnc_regs *usbnc = (struct usbnc_regs *)(USB_BASE_ADDR +
252 			USB_OTHERREGS_OFFSET);
253 	void __iomem *ctrl = (void __iomem *)(&usbnc->ctrl[index]);
254 #elif defined(CONFIG_MX7)
255 	struct usbnc_regs *usbnc = (struct usbnc_regs *)(USB_BASE_ADDR +
256 			(0x10000 * index) + USBNC_OFFSET);
257 	void __iomem *ctrl = (void __iomem *)(&usbnc->ctrl1);
258 #endif
259 
260 #if CONFIG_MACH_TYPE == MACH_TYPE_MX6Q_ARM2
261 	/* mx6qarm2 seems to required a different setting*/
262 	clrbits_le32(ctrl, UCTRL_OVER_CUR_POL);
263 #else
264 	setbits_le32(ctrl, UCTRL_OVER_CUR_POL);
265 #endif
266 
267 	setbits_le32(ctrl, UCTRL_OVER_CUR_DIS);
268 }
269 
270 /**
271  * board_usb_phy_mode - override usb phy mode
272  * @port:	usb host/otg port
273  *
274  * Target board specific, override usb_phy_mode.
275  * When usb-otg is used as usb host port, iomux pad usb_otg_id can be
276  * left disconnected in this case usb_phy_mode will not be able to identify
277  * the phy mode that usb port is used.
278  * Machine file overrides board_usb_phy_mode.
279  *
280  * Return: USB_INIT_DEVICE or USB_INIT_HOST
281  */
282 int __weak board_usb_phy_mode(int port)
283 {
284 	return usb_phy_mode(port);
285 }
286 
287 /**
288  * board_ehci_hcd_init - set usb vbus voltage
289  * @port:      usb otg port
290  *
291  * Target board specific, setup iomux pad to setup supply vbus voltage
292  * for usb otg port. Machine board file overrides board_ehci_hcd_init
293  *
294  * Return: 0 Success
295  */
296 int __weak board_ehci_hcd_init(int port)
297 {
298 	return 0;
299 }
300 
301 /**
302  * board_ehci_power - enables/disables usb vbus voltage
303  * @port:      usb otg port
304  * @on:        on/off vbus voltage
305  *
306  * Enables/disables supply vbus voltage for usb otg port.
307  * Machine board file overrides board_ehci_power
308  *
309  * Return: 0 Success
310  */
311 int __weak board_ehci_power(int port, int on)
312 {
313 	return 0;
314 }
315 
316 int ehci_mx6_common_init(struct usb_ehci *ehci, int index)
317 {
318 	int ret;
319 
320 	enable_usboh3_clk(1);
321 	mdelay(1);
322 
323 	/* Do board specific initialization */
324 	ret = board_ehci_hcd_init(index);
325 	if (ret)
326 		return ret;
327 
328 	usb_power_config(index);
329 	usb_oc_config(index);
330 
331 #if defined(CONFIG_MX6)
332 	usb_internal_phy_clock_gate(index, 1);
333 	usb_phy_enable(index, ehci);
334 #endif
335 
336 	return 0;
337 }
338 
339 #ifndef CONFIG_DM_USB
340 int ehci_hcd_init(int index, enum usb_init_type init,
341 		struct ehci_hccr **hccr, struct ehci_hcor **hcor)
342 {
343 	enum usb_init_type type;
344 #if defined(CONFIG_MX6)
345 	u32 controller_spacing = 0x200;
346 #elif defined(CONFIG_MX7)
347 	u32 controller_spacing = 0x10000;
348 #endif
349 	struct usb_ehci *ehci = (struct usb_ehci *)(USB_BASE_ADDR +
350 		(controller_spacing * index));
351 	int ret;
352 
353 	if (index > 3)
354 		return -EINVAL;
355 
356 	ret = ehci_mx6_common_init(ehci, index);
357 	if (ret)
358 		return ret;
359 
360 	type = board_usb_phy_mode(index);
361 
362 	if (hccr && hcor) {
363 		*hccr = (struct ehci_hccr *)((uint32_t)&ehci->caplength);
364 		*hcor = (struct ehci_hcor *)((uint32_t)*hccr +
365 				HC_LENGTH(ehci_readl(&(*hccr)->cr_capbase)));
366 	}
367 
368 	if ((type == init) || (type == USB_INIT_DEVICE))
369 		board_ehci_power(index, (type == USB_INIT_DEVICE) ? 0 : 1);
370 	if (type != init)
371 		return -ENODEV;
372 	if (type == USB_INIT_DEVICE)
373 		return 0;
374 
375 	setbits_le32(&ehci->usbmode, CM_HOST);
376 	writel(CONFIG_MXC_USB_PORTSC, &ehci->portsc);
377 	setbits_le32(&ehci->portsc, USB_EN);
378 
379 	mdelay(10);
380 
381 	return 0;
382 }
383 
384 int ehci_hcd_stop(int index)
385 {
386 	return 0;
387 }
388 #else
389 struct ehci_mx6_priv_data {
390 	struct ehci_ctrl ctrl;
391 	struct usb_ehci *ehci;
392 	struct udevice *vbus_supply;
393 	enum usb_init_type init_type;
394 	int portnr;
395 };
396 
397 static int mx6_init_after_reset(struct ehci_ctrl *dev)
398 {
399 	struct ehci_mx6_priv_data *priv = dev->priv;
400 	enum usb_init_type type = priv->init_type;
401 	struct usb_ehci *ehci = priv->ehci;
402 	int ret;
403 
404 	ret = ehci_mx6_common_init(priv->ehci, priv->portnr);
405 	if (ret)
406 		return ret;
407 
408 	if (priv->vbus_supply) {
409 		ret = regulator_set_enable(priv->vbus_supply,
410 					   (type == USB_INIT_DEVICE) ?
411 					   false : true);
412 		if (ret) {
413 			puts("Error enabling VBUS supply\n");
414 			return ret;
415 		}
416 	}
417 
418 	if (type == USB_INIT_DEVICE)
419 		return 0;
420 
421 	setbits_le32(&ehci->usbmode, CM_HOST);
422 	writel(CONFIG_MXC_USB_PORTSC, &ehci->portsc);
423 	setbits_le32(&ehci->portsc, USB_EN);
424 
425 	mdelay(10);
426 
427 	return 0;
428 }
429 
430 static const struct ehci_ops mx6_ehci_ops = {
431 	.init_after_reset = mx6_init_after_reset
432 };
433 
434 static int ehci_usb_phy_mode(struct udevice *dev)
435 {
436 	struct usb_platdata *plat = dev_get_platdata(dev);
437 	void *__iomem addr = (void *__iomem)dev_get_addr(dev);
438 	void *__iomem phy_ctrl, *__iomem phy_status;
439 	const void *blob = gd->fdt_blob;
440 	int offset = dev->of_offset, phy_off;
441 	u32 val;
442 
443 	/*
444 	 * About fsl,usbphy, Refer to
445 	 * Documentation/devicetree/bindings/usb/ci-hdrc-usb2.txt.
446 	 */
447 	if (is_mx6()) {
448 		phy_off = fdtdec_lookup_phandle(blob,
449 						offset,
450 						"fsl,usbphy");
451 		if (phy_off < 0)
452 			return -EINVAL;
453 
454 		addr = (void __iomem *)fdtdec_get_addr(blob, phy_off,
455 						       "reg");
456 		if ((fdt_addr_t)addr == FDT_ADDR_T_NONE)
457 			return -EINVAL;
458 
459 		phy_ctrl = (void __iomem *)(addr + USBPHY_CTRL);
460 		val = readl(phy_ctrl);
461 
462 		if (val & USBPHY_CTRL_OTG_ID)
463 			plat->init_type = USB_INIT_DEVICE;
464 		else
465 			plat->init_type = USB_INIT_HOST;
466 	} else if (is_mx7()) {
467 		phy_status = (void __iomem *)(addr +
468 					      USBNC_PHY_STATUS_OFFSET);
469 		val = readl(phy_status);
470 
471 		if (val & USBNC_PHYSTATUS_ID_DIG)
472 			plat->init_type = USB_INIT_DEVICE;
473 		else
474 			plat->init_type = USB_INIT_HOST;
475 	} else {
476 		return -EINVAL;
477 	}
478 
479 	return 0;
480 }
481 
482 static int ehci_usb_ofdata_to_platdata(struct udevice *dev)
483 {
484 	struct usb_platdata *plat = dev_get_platdata(dev);
485 	const char *mode;
486 
487 	mode = fdt_getprop(gd->fdt_blob, dev->of_offset, "dr_mode", NULL);
488 	if (mode) {
489 		if (strcmp(mode, "peripheral") == 0)
490 			plat->init_type = USB_INIT_DEVICE;
491 		else if (strcmp(mode, "host") == 0)
492 			plat->init_type = USB_INIT_HOST;
493 		else if (strcmp(mode, "otg") == 0)
494 			return ehci_usb_phy_mode(dev);
495 		else
496 			return -EINVAL;
497 
498 		return 0;
499 	}
500 
501 	return ehci_usb_phy_mode(dev);
502 }
503 
504 static int ehci_usb_probe(struct udevice *dev)
505 {
506 	struct usb_platdata *plat = dev_get_platdata(dev);
507 	struct usb_ehci *ehci = (struct usb_ehci *)dev_get_addr(dev);
508 	struct ehci_mx6_priv_data *priv = dev_get_priv(dev);
509 	enum usb_init_type type = plat->init_type;
510 	struct ehci_hccr *hccr;
511 	struct ehci_hcor *hcor;
512 	int ret;
513 
514 	priv->ehci = ehci;
515 	priv->portnr = dev->seq;
516 	priv->init_type = type;
517 
518 	ret = device_get_supply_regulator(dev, "vbus-supply",
519 					  &priv->vbus_supply);
520 	if (ret)
521 		debug("%s: No vbus supply\n", dev->name);
522 
523 	ret = ehci_mx6_common_init(ehci, priv->portnr);
524 	if (ret)
525 		return ret;
526 
527 	if (priv->vbus_supply) {
528 		ret = regulator_set_enable(priv->vbus_supply,
529 					   (type == USB_INIT_DEVICE) ?
530 					   false : true);
531 		if (ret) {
532 			puts("Error enabling VBUS supply\n");
533 			return ret;
534 		}
535 	}
536 
537 	if (priv->init_type == USB_INIT_HOST) {
538 		setbits_le32(&ehci->usbmode, CM_HOST);
539 		writel(CONFIG_MXC_USB_PORTSC, &ehci->portsc);
540 		setbits_le32(&ehci->portsc, USB_EN);
541 	}
542 
543 	mdelay(10);
544 
545 	hccr = (struct ehci_hccr *)((uint32_t)&ehci->caplength);
546 	hcor = (struct ehci_hcor *)((uint32_t)hccr +
547 			HC_LENGTH(ehci_readl(&(hccr)->cr_capbase)));
548 
549 	return ehci_register(dev, hccr, hcor, &mx6_ehci_ops, 0, priv->init_type);
550 }
551 
552 static const struct udevice_id mx6_usb_ids[] = {
553 	{ .compatible = "fsl,imx27-usb" },
554 	{ }
555 };
556 
557 U_BOOT_DRIVER(usb_mx6) = {
558 	.name	= "ehci_mx6",
559 	.id	= UCLASS_USB,
560 	.of_match = mx6_usb_ids,
561 	.ofdata_to_platdata = ehci_usb_ofdata_to_platdata,
562 	.probe	= ehci_usb_probe,
563 	.remove = ehci_deregister,
564 	.ops	= &ehci_usb_ops,
565 	.platdata_auto_alloc_size = sizeof(struct usb_platdata),
566 	.priv_auto_alloc_size = sizeof(struct ehci_mx6_priv_data),
567 	.flags	= DM_FLAG_ALLOC_PRIV_DMA,
568 };
569 #endif
570