usb: ehci-mx6: Fix bus enumeration for DM case
[oweals/u-boot.git] / drivers / usb / host / ehci-mx6.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
4  * Copyright (C) 2010 Freescale Semiconductor, Inc.
5  */
6
7 #include <common.h>
8 #include <usb.h>
9 #include <errno.h>
10 #include <wait_bit.h>
11 #include <linux/compiler.h>
12 #include <usb/ehci-ci.h>
13 #include <asm/io.h>
14 #include <asm/arch/imx-regs.h>
15 #include <asm/arch/clock.h>
16 #include <asm/mach-imx/iomux-v3.h>
17 #include <asm/mach-imx/sys_proto.h>
18 #include <dm.h>
19 #include <asm/mach-types.h>
20 #include <power/regulator.h>
21 #include <linux/usb/otg.h>
22
23 #include "ehci.h"
24
25 DECLARE_GLOBAL_DATA_PTR;
26
27 #define USB_OTGREGS_OFFSET      0x000
28 #define USB_H1REGS_OFFSET       0x200
29 #define USB_H2REGS_OFFSET       0x400
30 #define USB_H3REGS_OFFSET       0x600
31 #define USB_OTHERREGS_OFFSET    0x800
32
33 #define USB_H1_CTRL_OFFSET      0x04
34
35 #define USBPHY_CTRL                             0x00000030
36 #define USBPHY_CTRL_SET                         0x00000034
37 #define USBPHY_CTRL_CLR                         0x00000038
38 #define USBPHY_CTRL_TOG                         0x0000003c
39
40 #define USBPHY_PWD                              0x00000000
41 #define USBPHY_CTRL_SFTRST                      0x80000000
42 #define USBPHY_CTRL_CLKGATE                     0x40000000
43 #define USBPHY_CTRL_ENUTMILEVEL3                0x00008000
44 #define USBPHY_CTRL_ENUTMILEVEL2                0x00004000
45 #define USBPHY_CTRL_OTG_ID                      0x08000000
46
47 #define ANADIG_USB2_CHRG_DETECT_EN_B            0x00100000
48 #define ANADIG_USB2_CHRG_DETECT_CHK_CHRG_B      0x00080000
49
50 #define ANADIG_USB2_PLL_480_CTRL_BYPASS         0x00010000
51 #define ANADIG_USB2_PLL_480_CTRL_ENABLE         0x00002000
52 #define ANADIG_USB2_PLL_480_CTRL_POWER          0x00001000
53 #define ANADIG_USB2_PLL_480_CTRL_EN_USB_CLKS    0x00000040
54
55 #define USBNC_OFFSET            0x200
56 #define USBNC_PHY_STATUS_OFFSET 0x23C
57 #define USBNC_PHYSTATUS_ID_DIG  (1 << 4) /* otg_id status */
58 #define USBNC_PHYCFG2_ACAENB    (1 << 4) /* otg_id detection enable */
59 #define UCTRL_PWR_POL           (1 << 9) /* OTG Polarity of Power Pin */
60 #define UCTRL_OVER_CUR_POL      (1 << 8) /* OTG Polarity of Overcurrent */
61 #define UCTRL_OVER_CUR_DIS      (1 << 7) /* Disable OTG Overcurrent Detection */
62
63 /* USBCMD */
64 #define UCMD_RUN_STOP           (1 << 0) /* controller run/stop */
65 #define UCMD_RESET              (1 << 1) /* controller reset */
66
67 #if defined(CONFIG_MX6)
68 static const unsigned phy_bases[] = {
69         USB_PHY0_BASE_ADDR,
70         USB_PHY1_BASE_ADDR,
71 };
72
73 static void usb_internal_phy_clock_gate(int index, int on)
74 {
75         void __iomem *phy_reg;
76
77         if (index >= ARRAY_SIZE(phy_bases))
78                 return;
79
80         phy_reg = (void __iomem *)phy_bases[index];
81         phy_reg += on ? USBPHY_CTRL_CLR : USBPHY_CTRL_SET;
82         writel(USBPHY_CTRL_CLKGATE, phy_reg);
83 }
84
85 static void usb_power_config(int index)
86 {
87         struct anatop_regs __iomem *anatop =
88                 (struct anatop_regs __iomem *)ANATOP_BASE_ADDR;
89         void __iomem *chrg_detect;
90         void __iomem *pll_480_ctrl_clr;
91         void __iomem *pll_480_ctrl_set;
92
93         switch (index) {
94         case 0:
95                 chrg_detect = &anatop->usb1_chrg_detect;
96                 pll_480_ctrl_clr = &anatop->usb1_pll_480_ctrl_clr;
97                 pll_480_ctrl_set = &anatop->usb1_pll_480_ctrl_set;
98                 break;
99         case 1:
100                 chrg_detect = &anatop->usb2_chrg_detect;
101                 pll_480_ctrl_clr = &anatop->usb2_pll_480_ctrl_clr;
102                 pll_480_ctrl_set = &anatop->usb2_pll_480_ctrl_set;
103                 break;
104         default:
105                 return;
106         }
107         /*
108          * Some phy and power's special controls
109          * 1. The external charger detector needs to be disabled
110          * or the signal at DP will be poor
111          * 2. The PLL's power and output to usb
112          * is totally controlled by IC, so the Software only needs
113          * to enable them at initializtion.
114          */
115         writel(ANADIG_USB2_CHRG_DETECT_EN_B |
116                      ANADIG_USB2_CHRG_DETECT_CHK_CHRG_B,
117                      chrg_detect);
118
119         writel(ANADIG_USB2_PLL_480_CTRL_BYPASS,
120                      pll_480_ctrl_clr);
121
122         writel(ANADIG_USB2_PLL_480_CTRL_ENABLE |
123                      ANADIG_USB2_PLL_480_CTRL_POWER |
124                      ANADIG_USB2_PLL_480_CTRL_EN_USB_CLKS,
125                      pll_480_ctrl_set);
126 }
127
128 /* Return 0 : host node, <>0 : device mode */
129 static int usb_phy_enable(int index, struct usb_ehci *ehci)
130 {
131         void __iomem *phy_reg;
132         void __iomem *phy_ctrl;
133         void __iomem *usb_cmd;
134         int ret;
135
136         if (index >= ARRAY_SIZE(phy_bases))
137                 return 0;
138
139         phy_reg = (void __iomem *)phy_bases[index];
140         phy_ctrl = (void __iomem *)(phy_reg + USBPHY_CTRL);
141         usb_cmd = (void __iomem *)&ehci->usbcmd;
142
143         /* Stop then Reset */
144         clrbits_le32(usb_cmd, UCMD_RUN_STOP);
145         ret = wait_for_bit_le32(usb_cmd, UCMD_RUN_STOP, false, 10000, false);
146         if (ret)
147                 return ret;
148
149         setbits_le32(usb_cmd, UCMD_RESET);
150         ret = wait_for_bit_le32(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 #if !CONFIG_IS_ENABLED(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 CONFIG_IS_ENABLED(DM_REGULATOR)
409         if (priv->vbus_supply) {
410                 ret = regulator_set_enable(priv->vbus_supply,
411                                            (type == USB_INIT_DEVICE) ?
412                                            false : true);
413                 if (ret) {
414                         puts("Error enabling VBUS supply\n");
415                         return ret;
416                 }
417         }
418 #endif
419
420         if (type == USB_INIT_DEVICE)
421                 return 0;
422
423         setbits_le32(&ehci->usbmode, CM_HOST);
424         writel(CONFIG_MXC_USB_PORTSC, &ehci->portsc);
425         setbits_le32(&ehci->portsc, USB_EN);
426
427         mdelay(10);
428
429         return 0;
430 }
431
432 static const struct ehci_ops mx6_ehci_ops = {
433         .init_after_reset = mx6_init_after_reset
434 };
435
436 static int ehci_usb_phy_mode(struct udevice *dev)
437 {
438         struct usb_platdata *plat = dev_get_platdata(dev);
439         void *__iomem addr = (void *__iomem)devfdt_get_addr(dev);
440         void *__iomem phy_ctrl, *__iomem phy_status;
441         const void *blob = gd->fdt_blob;
442         int offset = dev_of_offset(dev), phy_off;
443         u32 val;
444
445         /*
446          * About fsl,usbphy, Refer to
447          * Documentation/devicetree/bindings/usb/ci-hdrc-usb2.txt.
448          */
449         if (is_mx6()) {
450                 phy_off = fdtdec_lookup_phandle(blob,
451                                                 offset,
452                                                 "fsl,usbphy");
453                 if (phy_off < 0)
454                         return -EINVAL;
455
456                 addr = (void __iomem *)fdtdec_get_addr(blob, phy_off,
457                                                        "reg");
458                 if ((fdt_addr_t)addr == FDT_ADDR_T_NONE)
459                         return -EINVAL;
460
461                 phy_ctrl = (void __iomem *)(addr + USBPHY_CTRL);
462                 val = readl(phy_ctrl);
463
464                 if (val & USBPHY_CTRL_OTG_ID)
465                         plat->init_type = USB_INIT_DEVICE;
466                 else
467                         plat->init_type = USB_INIT_HOST;
468         } else if (is_mx7()) {
469                 phy_status = (void __iomem *)(addr +
470                                               USBNC_PHY_STATUS_OFFSET);
471                 val = readl(phy_status);
472
473                 if (val & USBNC_PHYSTATUS_ID_DIG)
474                         plat->init_type = USB_INIT_DEVICE;
475                 else
476                         plat->init_type = USB_INIT_HOST;
477         } else {
478                 return -EINVAL;
479         }
480
481         return 0;
482 }
483
484 static int ehci_usb_ofdata_to_platdata(struct udevice *dev)
485 {
486         struct usb_platdata *plat = dev_get_platdata(dev);
487         enum usb_dr_mode dr_mode;
488
489         dr_mode = usb_get_dr_mode(dev_of_offset(dev));
490
491         switch (dr_mode) {
492         case USB_DR_MODE_HOST:
493                 plat->init_type = USB_INIT_HOST;
494                 break;
495         case USB_DR_MODE_PERIPHERAL:
496                 plat->init_type = USB_INIT_DEVICE;
497                 break;
498         case USB_DR_MODE_OTG:
499         case USB_DR_MODE_UNKNOWN:
500                 return ehci_usb_phy_mode(dev);
501         };
502
503         return 0;
504 }
505
506 static int ehci_usb_bind(struct udevice *dev)
507 {
508         /*
509          * TODO:
510          * This driver is only partly converted to DT probing and still uses
511          * a tremendous amount of hard-coded addresses. To make things worse,
512          * the driver depends on specific sequential indexing of controllers,
513          * from which it derives offsets in the PHY and ANATOP register sets.
514          *
515          * Here we attempt to calculate these indexes from DT information as
516          * well as we can. The USB controllers on all existing iMX6/iMX7 SoCs
517          * are placed next to each other, at addresses incremented by 0x200.
518          * Thus, the index is derived from the multiple of 0x200 offset from
519          * the first controller address.
520          *
521          * However, to complete conversion of this driver to DT probing, the
522          * following has to be done:
523          * - DM clock framework support for iMX must be implemented
524          * - usb_power_config() has to be converted to clock framework
525          *   -> Thus, the ad-hoc "index" variable goes away.
526          * - USB PHY handling has to be factored out into separate driver
527          *   -> Thus, the ad-hoc "index" variable goes away from the PHY
528          *      code, the PHY driver must parse it's address from DT. This
529          *      USB driver must find the PHY driver via DT phandle.
530          *   -> usb_power_config() shall be moved to PHY driver
531          * With these changes in place, the ad-hoc indexing goes away and
532          * the driver is fully converted to DT probing.
533          */
534         fdt_size_t size;
535         fdt_addr_t addr = devfdt_get_addr_size_index(dev, 0, &size);
536
537         dev->req_seq = (addr - USB_BASE_ADDR) / size;
538
539         return 0;
540 }
541
542 static int ehci_usb_probe(struct udevice *dev)
543 {
544         struct usb_platdata *plat = dev_get_platdata(dev);
545         struct usb_ehci *ehci = (struct usb_ehci *)devfdt_get_addr(dev);
546         struct ehci_mx6_priv_data *priv = dev_get_priv(dev);
547         enum usb_init_type type = plat->init_type;
548         struct ehci_hccr *hccr;
549         struct ehci_hcor *hcor;
550         int ret;
551
552         priv->ehci = ehci;
553         priv->portnr = dev->seq;
554         priv->init_type = type;
555
556 #if CONFIG_IS_ENABLED(DM_REGULATOR)
557         ret = device_get_supply_regulator(dev, "vbus-supply",
558                                           &priv->vbus_supply);
559         if (ret)
560                 debug("%s: No vbus supply\n", dev->name);
561 #endif
562         ret = ehci_mx6_common_init(ehci, priv->portnr);
563         if (ret)
564                 return ret;
565
566 #if CONFIG_IS_ENABLED(DM_REGULATOR)
567         if (priv->vbus_supply) {
568                 ret = regulator_set_enable(priv->vbus_supply,
569                                            (type == USB_INIT_DEVICE) ?
570                                            false : true);
571                 if (ret) {
572                         puts("Error enabling VBUS supply\n");
573                         return ret;
574                 }
575         }
576 #endif
577
578         if (priv->init_type == USB_INIT_HOST) {
579                 setbits_le32(&ehci->usbmode, CM_HOST);
580                 writel(CONFIG_MXC_USB_PORTSC, &ehci->portsc);
581                 setbits_le32(&ehci->portsc, USB_EN);
582         }
583
584         mdelay(10);
585
586         hccr = (struct ehci_hccr *)((uint32_t)&ehci->caplength);
587         hcor = (struct ehci_hcor *)((uint32_t)hccr +
588                         HC_LENGTH(ehci_readl(&(hccr)->cr_capbase)));
589
590         return ehci_register(dev, hccr, hcor, &mx6_ehci_ops, 0, priv->init_type);
591 }
592
593 static const struct udevice_id mx6_usb_ids[] = {
594         { .compatible = "fsl,imx27-usb" },
595         { }
596 };
597
598 U_BOOT_DRIVER(usb_mx6) = {
599         .name   = "ehci_mx6",
600         .id     = UCLASS_USB,
601         .of_match = mx6_usb_ids,
602         .ofdata_to_platdata = ehci_usb_ofdata_to_platdata,
603         .bind   = ehci_usb_bind,
604         .probe  = ehci_usb_probe,
605         .remove = ehci_deregister,
606         .ops    = &ehci_usb_ops,
607         .platdata_auto_alloc_size = sizeof(struct usb_platdata),
608         .priv_auto_alloc_size = sizeof(struct ehci_mx6_priv_data),
609         .flags  = DM_FLAG_ALLOC_PRIV_DMA,
610 };
611 #endif