GNU Linux-libre 4.9.337-gnu1
[releases.git] / drivers / usb / chipidea / usbmisc_imx.c
1 /*
2  * Copyright 2012 Freescale Semiconductor, Inc.
3  *
4  * The code contained herein is licensed under the GNU General Public
5  * License. You may obtain a copy of the GNU General Public License
6  * Version 2 or later at the following locations:
7  *
8  * http://www.opensource.org/licenses/gpl-license.html
9  * http://www.gnu.org/copyleft/gpl.html
10  */
11
12 #include <linux/module.h>
13 #include <linux/of_platform.h>
14 #include <linux/err.h>
15 #include <linux/io.h>
16 #include <linux/delay.h>
17
18 #include "ci_hdrc_imx.h"
19
20 #define MX25_USB_PHY_CTRL_OFFSET        0x08
21 #define MX25_BM_EXTERNAL_VBUS_DIVIDER   BIT(23)
22
23 #define MX25_EHCI_INTERFACE_SINGLE_UNI  (2 << 0)
24 #define MX25_EHCI_INTERFACE_DIFF_UNI    (0 << 0)
25 #define MX25_EHCI_INTERFACE_MASK        (0xf)
26
27 #define MX25_OTG_SIC_SHIFT              29
28 #define MX25_OTG_SIC_MASK               (0x3 << MX25_OTG_SIC_SHIFT)
29 #define MX25_OTG_PM_BIT                 BIT(24)
30 #define MX25_OTG_PP_BIT                 BIT(11)
31 #define MX25_OTG_OCPOL_BIT              BIT(3)
32
33 #define MX25_H1_SIC_SHIFT               21
34 #define MX25_H1_SIC_MASK                (0x3 << MX25_H1_SIC_SHIFT)
35 #define MX25_H1_PP_BIT                  BIT(18)
36 #define MX25_H1_PM_BIT                  BIT(16)
37 #define MX25_H1_IPPUE_UP_BIT            BIT(7)
38 #define MX25_H1_IPPUE_DOWN_BIT          BIT(6)
39 #define MX25_H1_TLL_BIT                 BIT(5)
40 #define MX25_H1_USBTE_BIT               BIT(4)
41 #define MX25_H1_OCPOL_BIT               BIT(2)
42
43 #define MX27_H1_PM_BIT                  BIT(8)
44 #define MX27_H2_PM_BIT                  BIT(16)
45 #define MX27_OTG_PM_BIT                 BIT(24)
46
47 #define MX53_USB_OTG_PHY_CTRL_0_OFFSET  0x08
48 #define MX53_USB_OTG_PHY_CTRL_1_OFFSET  0x0c
49 #define MX53_USB_UH2_CTRL_OFFSET        0x14
50 #define MX53_USB_UH3_CTRL_OFFSET        0x18
51 #define MX53_BM_OVER_CUR_DIS_H1         BIT(5)
52 #define MX53_BM_OVER_CUR_DIS_OTG        BIT(8)
53 #define MX53_BM_OVER_CUR_DIS_UHx        BIT(30)
54 #define MX53_USB_PHYCTRL1_PLLDIV_MASK   0x3
55 #define MX53_USB_PLL_DIV_24_MHZ         0x01
56
57 #define MX6_BM_NON_BURST_SETTING        BIT(1)
58 #define MX6_BM_OVER_CUR_DIS             BIT(7)
59 #define MX6_BM_OVER_CUR_POLARITY        BIT(8)
60 #define MX6_BM_WAKEUP_ENABLE            BIT(10)
61 #define MX6_BM_ID_WAKEUP                BIT(16)
62 #define MX6_BM_VBUS_WAKEUP              BIT(17)
63 #define MX6SX_BM_DPDM_WAKEUP_EN         BIT(29)
64 #define MX6_BM_WAKEUP_INTR              BIT(31)
65 #define MX6_USB_OTG1_PHY_CTRL           0x18
66 /* For imx6dql, it is host-only controller, for later imx6, it is otg's */
67 #define MX6_USB_OTG2_PHY_CTRL           0x1c
68 #define MX6SX_USB_VBUS_WAKEUP_SOURCE(v) (v << 8)
69 #define MX6SX_USB_VBUS_WAKEUP_SOURCE_VBUS       MX6SX_USB_VBUS_WAKEUP_SOURCE(0)
70 #define MX6SX_USB_VBUS_WAKEUP_SOURCE_AVALID     MX6SX_USB_VBUS_WAKEUP_SOURCE(1)
71 #define MX6SX_USB_VBUS_WAKEUP_SOURCE_BVALID     MX6SX_USB_VBUS_WAKEUP_SOURCE(2)
72 #define MX6SX_USB_VBUS_WAKEUP_SOURCE_SESS_END   MX6SX_USB_VBUS_WAKEUP_SOURCE(3)
73
74 #define VF610_OVER_CUR_DIS              BIT(7)
75
76 #define MX7D_USBNC_USB_CTRL2            0x4
77 #define MX7D_USB_VBUS_WAKEUP_SOURCE_MASK        0x3
78 #define MX7D_USB_VBUS_WAKEUP_SOURCE(v)          (v << 0)
79 #define MX7D_USB_VBUS_WAKEUP_SOURCE_VBUS        MX7D_USB_VBUS_WAKEUP_SOURCE(0)
80 #define MX7D_USB_VBUS_WAKEUP_SOURCE_AVALID      MX7D_USB_VBUS_WAKEUP_SOURCE(1)
81 #define MX7D_USB_VBUS_WAKEUP_SOURCE_BVALID      MX7D_USB_VBUS_WAKEUP_SOURCE(2)
82 #define MX7D_USB_VBUS_WAKEUP_SOURCE_SESS_END    MX7D_USB_VBUS_WAKEUP_SOURCE(3)
83
84 struct usbmisc_ops {
85         /* It's called once when probe a usb device */
86         int (*init)(struct imx_usbmisc_data *data);
87         /* It's called once after adding a usb device */
88         int (*post)(struct imx_usbmisc_data *data);
89         /* It's called when we need to enable/disable usb wakeup */
90         int (*set_wakeup)(struct imx_usbmisc_data *data, bool enabled);
91 };
92
93 struct imx_usbmisc {
94         void __iomem *base;
95         spinlock_t lock;
96         const struct usbmisc_ops *ops;
97 };
98
99 static int usbmisc_imx25_init(struct imx_usbmisc_data *data)
100 {
101         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
102         unsigned long flags;
103         u32 val = 0;
104
105         if (data->index > 1)
106                 return -EINVAL;
107
108         spin_lock_irqsave(&usbmisc->lock, flags);
109         switch (data->index) {
110         case 0:
111                 val = readl(usbmisc->base);
112                 val &= ~(MX25_OTG_SIC_MASK | MX25_OTG_PP_BIT);
113                 val |= (MX25_EHCI_INTERFACE_DIFF_UNI & MX25_EHCI_INTERFACE_MASK) << MX25_OTG_SIC_SHIFT;
114                 val |= (MX25_OTG_PM_BIT | MX25_OTG_OCPOL_BIT);
115                 writel(val, usbmisc->base);
116                 break;
117         case 1:
118                 val = readl(usbmisc->base);
119                 val &= ~(MX25_H1_SIC_MASK | MX25_H1_PP_BIT |  MX25_H1_IPPUE_UP_BIT);
120                 val |= (MX25_EHCI_INTERFACE_SINGLE_UNI & MX25_EHCI_INTERFACE_MASK) << MX25_H1_SIC_SHIFT;
121                 val |= (MX25_H1_PM_BIT | MX25_H1_OCPOL_BIT | MX25_H1_TLL_BIT |
122                         MX25_H1_USBTE_BIT | MX25_H1_IPPUE_DOWN_BIT);
123
124                 writel(val, usbmisc->base);
125
126                 break;
127         }
128         spin_unlock_irqrestore(&usbmisc->lock, flags);
129
130         return 0;
131 }
132
133 static int usbmisc_imx25_post(struct imx_usbmisc_data *data)
134 {
135         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
136         void __iomem *reg;
137         unsigned long flags;
138         u32 val;
139
140         if (data->index > 2)
141                 return -EINVAL;
142
143         if (data->evdo) {
144                 spin_lock_irqsave(&usbmisc->lock, flags);
145                 reg = usbmisc->base + MX25_USB_PHY_CTRL_OFFSET;
146                 val = readl(reg);
147                 writel(val | MX25_BM_EXTERNAL_VBUS_DIVIDER, reg);
148                 spin_unlock_irqrestore(&usbmisc->lock, flags);
149                 usleep_range(5000, 10000); /* needed to stabilize voltage */
150         }
151
152         return 0;
153 }
154
155 static int usbmisc_imx27_init(struct imx_usbmisc_data *data)
156 {
157         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
158         unsigned long flags;
159         u32 val;
160
161         switch (data->index) {
162         case 0:
163                 val = MX27_OTG_PM_BIT;
164                 break;
165         case 1:
166                 val = MX27_H1_PM_BIT;
167                 break;
168         case 2:
169                 val = MX27_H2_PM_BIT;
170                 break;
171         default:
172                 return -EINVAL;
173         }
174
175         spin_lock_irqsave(&usbmisc->lock, flags);
176         if (data->disable_oc)
177                 val = readl(usbmisc->base) | val;
178         else
179                 val = readl(usbmisc->base) & ~val;
180         writel(val, usbmisc->base);
181         spin_unlock_irqrestore(&usbmisc->lock, flags);
182
183         return 0;
184 }
185
186 static int usbmisc_imx53_init(struct imx_usbmisc_data *data)
187 {
188         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
189         void __iomem *reg = NULL;
190         unsigned long flags;
191         u32 val = 0;
192
193         if (data->index > 3)
194                 return -EINVAL;
195
196         /* Select a 24 MHz reference clock for the PHY  */
197         val = readl(usbmisc->base + MX53_USB_OTG_PHY_CTRL_1_OFFSET);
198         val &= ~MX53_USB_PHYCTRL1_PLLDIV_MASK;
199         val |= MX53_USB_PLL_DIV_24_MHZ;
200         writel(val, usbmisc->base + MX53_USB_OTG_PHY_CTRL_1_OFFSET);
201
202         if (data->disable_oc) {
203                 spin_lock_irqsave(&usbmisc->lock, flags);
204                 switch (data->index) {
205                 case 0:
206                         reg = usbmisc->base + MX53_USB_OTG_PHY_CTRL_0_OFFSET;
207                         val = readl(reg) | MX53_BM_OVER_CUR_DIS_OTG;
208                         break;
209                 case 1:
210                         reg = usbmisc->base + MX53_USB_OTG_PHY_CTRL_0_OFFSET;
211                         val = readl(reg) | MX53_BM_OVER_CUR_DIS_H1;
212                         break;
213                 case 2:
214                         reg = usbmisc->base + MX53_USB_UH2_CTRL_OFFSET;
215                         val = readl(reg) | MX53_BM_OVER_CUR_DIS_UHx;
216                         break;
217                 case 3:
218                         reg = usbmisc->base + MX53_USB_UH3_CTRL_OFFSET;
219                         val = readl(reg) | MX53_BM_OVER_CUR_DIS_UHx;
220                         break;
221                 }
222                 if (reg && val)
223                         writel(val, reg);
224                 spin_unlock_irqrestore(&usbmisc->lock, flags);
225         }
226
227         return 0;
228 }
229
230 static int usbmisc_imx6q_set_wakeup
231         (struct imx_usbmisc_data *data, bool enabled)
232 {
233         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
234         unsigned long flags;
235         u32 val;
236         u32 wakeup_setting = (MX6_BM_WAKEUP_ENABLE |
237                 MX6_BM_VBUS_WAKEUP | MX6_BM_ID_WAKEUP);
238         int ret = 0;
239
240         if (data->index > 3)
241                 return -EINVAL;
242
243         spin_lock_irqsave(&usbmisc->lock, flags);
244         val = readl(usbmisc->base + data->index * 4);
245         if (enabled) {
246                 val |= wakeup_setting;
247                 writel(val, usbmisc->base + data->index * 4);
248         } else {
249                 if (val & MX6_BM_WAKEUP_INTR)
250                         pr_debug("wakeup int at ci_hdrc.%d\n", data->index);
251                 val &= ~wakeup_setting;
252                 writel(val, usbmisc->base + data->index * 4);
253         }
254         spin_unlock_irqrestore(&usbmisc->lock, flags);
255
256         return ret;
257 }
258
259 static int usbmisc_imx6q_init(struct imx_usbmisc_data *data)
260 {
261         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
262         unsigned long flags;
263         u32 reg;
264
265         if (data->index > 3)
266                 return -EINVAL;
267
268         spin_lock_irqsave(&usbmisc->lock, flags);
269
270         reg = readl(usbmisc->base + data->index * 4);
271         if (data->disable_oc) {
272                 reg |= MX6_BM_OVER_CUR_DIS;
273         } else if (data->oc_polarity == 1) {
274                 /* High active */
275                 reg &= ~(MX6_BM_OVER_CUR_DIS | MX6_BM_OVER_CUR_POLARITY);
276         } else {
277                 reg &= ~(MX6_BM_OVER_CUR_DIS);
278         }
279         writel(reg, usbmisc->base + data->index * 4);
280
281         /* SoC non-burst setting */
282         reg = readl(usbmisc->base + data->index * 4);
283         writel(reg | MX6_BM_NON_BURST_SETTING,
284                         usbmisc->base + data->index * 4);
285
286         spin_unlock_irqrestore(&usbmisc->lock, flags);
287
288         usbmisc_imx6q_set_wakeup(data, false);
289
290         return 0;
291 }
292
293 static int usbmisc_imx6sx_init(struct imx_usbmisc_data *data)
294 {
295         void __iomem *reg = NULL;
296         unsigned long flags;
297         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
298         u32 val;
299
300         usbmisc_imx6q_init(data);
301
302         if (data->index == 0 || data->index == 1) {
303                 reg = usbmisc->base + MX6_USB_OTG1_PHY_CTRL + data->index * 4;
304                 spin_lock_irqsave(&usbmisc->lock, flags);
305                 /* Set vbus wakeup source as bvalid */
306                 val = readl(reg);
307                 writel(val | MX6SX_USB_VBUS_WAKEUP_SOURCE_BVALID, reg);
308                 /*
309                  * Disable dp/dm wakeup in device mode when vbus is
310                  * not there.
311                  */
312                 val = readl(usbmisc->base + data->index * 4);
313                 writel(val & ~MX6SX_BM_DPDM_WAKEUP_EN,
314                         usbmisc->base + data->index * 4);
315                 spin_unlock_irqrestore(&usbmisc->lock, flags);
316         }
317
318         return 0;
319 }
320
321 static int usbmisc_vf610_init(struct imx_usbmisc_data *data)
322 {
323         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
324         u32 reg;
325
326         /*
327          * Vybrid only has one misc register set, but in two different
328          * areas. These is reflected in two instances of this driver.
329          */
330         if (data->index >= 1)
331                 return -EINVAL;
332
333         if (data->disable_oc) {
334                 reg = readl(usbmisc->base);
335                 writel(reg | VF610_OVER_CUR_DIS, usbmisc->base);
336         }
337
338         return 0;
339 }
340
341 static int usbmisc_imx7d_set_wakeup
342         (struct imx_usbmisc_data *data, bool enabled)
343 {
344         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
345         unsigned long flags;
346         u32 val;
347         u32 wakeup_setting = (MX6_BM_WAKEUP_ENABLE |
348                 MX6_BM_VBUS_WAKEUP | MX6_BM_ID_WAKEUP);
349
350         spin_lock_irqsave(&usbmisc->lock, flags);
351         val = readl(usbmisc->base);
352         if (enabled) {
353                 writel(val | wakeup_setting, usbmisc->base);
354         } else {
355                 if (val & MX6_BM_WAKEUP_INTR)
356                         dev_dbg(data->dev, "wakeup int\n");
357                 writel(val & ~wakeup_setting, usbmisc->base);
358         }
359         spin_unlock_irqrestore(&usbmisc->lock, flags);
360
361         return 0;
362 }
363
364 static int usbmisc_imx7d_init(struct imx_usbmisc_data *data)
365 {
366         struct imx_usbmisc *usbmisc = dev_get_drvdata(data->dev);
367         unsigned long flags;
368         u32 reg;
369
370         if (data->index >= 1)
371                 return -EINVAL;
372
373         spin_lock_irqsave(&usbmisc->lock, flags);
374         reg = readl(usbmisc->base);
375         if (data->disable_oc) {
376                 reg |= MX6_BM_OVER_CUR_DIS;
377         } else if (data->oc_polarity == 1) {
378                 /* High active */
379                 reg &= ~(MX6_BM_OVER_CUR_DIS | MX6_BM_OVER_CUR_POLARITY);
380         }
381         writel(reg, usbmisc->base);
382
383         reg = readl(usbmisc->base + MX7D_USBNC_USB_CTRL2);
384         reg &= ~MX7D_USB_VBUS_WAKEUP_SOURCE_MASK;
385         writel(reg | MX7D_USB_VBUS_WAKEUP_SOURCE_BVALID,
386                  usbmisc->base + MX7D_USBNC_USB_CTRL2);
387         spin_unlock_irqrestore(&usbmisc->lock, flags);
388
389         usbmisc_imx7d_set_wakeup(data, false);
390
391         return 0;
392 }
393
394 static const struct usbmisc_ops imx25_usbmisc_ops = {
395         .init = usbmisc_imx25_init,
396         .post = usbmisc_imx25_post,
397 };
398
399 static const struct usbmisc_ops imx27_usbmisc_ops = {
400         .init = usbmisc_imx27_init,
401 };
402
403 static const struct usbmisc_ops imx53_usbmisc_ops = {
404         .init = usbmisc_imx53_init,
405 };
406
407 static const struct usbmisc_ops imx6q_usbmisc_ops = {
408         .set_wakeup = usbmisc_imx6q_set_wakeup,
409         .init = usbmisc_imx6q_init,
410 };
411
412 static const struct usbmisc_ops vf610_usbmisc_ops = {
413         .init = usbmisc_vf610_init,
414 };
415
416 static const struct usbmisc_ops imx6sx_usbmisc_ops = {
417         .set_wakeup = usbmisc_imx6q_set_wakeup,
418         .init = usbmisc_imx6sx_init,
419 };
420
421 static const struct usbmisc_ops imx7d_usbmisc_ops = {
422         .init = usbmisc_imx7d_init,
423         .set_wakeup = usbmisc_imx7d_set_wakeup,
424 };
425
426 int imx_usbmisc_init(struct imx_usbmisc_data *data)
427 {
428         struct imx_usbmisc *usbmisc;
429
430         if (!data)
431                 return 0;
432
433         usbmisc = dev_get_drvdata(data->dev);
434         if (!usbmisc->ops->init)
435                 return 0;
436         return usbmisc->ops->init(data);
437 }
438 EXPORT_SYMBOL_GPL(imx_usbmisc_init);
439
440 int imx_usbmisc_init_post(struct imx_usbmisc_data *data)
441 {
442         struct imx_usbmisc *usbmisc;
443
444         if (!data)
445                 return 0;
446
447         usbmisc = dev_get_drvdata(data->dev);
448         if (!usbmisc->ops->post)
449                 return 0;
450         return usbmisc->ops->post(data);
451 }
452 EXPORT_SYMBOL_GPL(imx_usbmisc_init_post);
453
454 int imx_usbmisc_set_wakeup(struct imx_usbmisc_data *data, bool enabled)
455 {
456         struct imx_usbmisc *usbmisc;
457
458         if (!data)
459                 return 0;
460
461         usbmisc = dev_get_drvdata(data->dev);
462         if (!usbmisc->ops->set_wakeup)
463                 return 0;
464         return usbmisc->ops->set_wakeup(data, enabled);
465 }
466 EXPORT_SYMBOL_GPL(imx_usbmisc_set_wakeup);
467
468 static const struct of_device_id usbmisc_imx_dt_ids[] = {
469         {
470                 .compatible = "fsl,imx25-usbmisc",
471                 .data = &imx25_usbmisc_ops,
472         },
473         {
474                 .compatible = "fsl,imx35-usbmisc",
475                 .data = &imx25_usbmisc_ops,
476         },
477         {
478                 .compatible = "fsl,imx27-usbmisc",
479                 .data = &imx27_usbmisc_ops,
480         },
481         {
482                 .compatible = "fsl,imx51-usbmisc",
483                 .data = &imx53_usbmisc_ops,
484         },
485         {
486                 .compatible = "fsl,imx53-usbmisc",
487                 .data = &imx53_usbmisc_ops,
488         },
489         {
490                 .compatible = "fsl,imx6q-usbmisc",
491                 .data = &imx6q_usbmisc_ops,
492         },
493         {
494                 .compatible = "fsl,vf610-usbmisc",
495                 .data = &vf610_usbmisc_ops,
496         },
497         {
498                 .compatible = "fsl,imx6sx-usbmisc",
499                 .data = &imx6sx_usbmisc_ops,
500         },
501         {
502                 .compatible = "fsl,imx6ul-usbmisc",
503                 .data = &imx6sx_usbmisc_ops,
504         },
505         {
506                 .compatible = "fsl,imx7d-usbmisc",
507                 .data = &imx7d_usbmisc_ops,
508         },
509         { /* sentinel */ }
510 };
511 MODULE_DEVICE_TABLE(of, usbmisc_imx_dt_ids);
512
513 static int usbmisc_imx_probe(struct platform_device *pdev)
514 {
515         struct resource *res;
516         struct imx_usbmisc *data;
517         const struct of_device_id *of_id;
518
519         of_id = of_match_device(usbmisc_imx_dt_ids, &pdev->dev);
520         if (!of_id)
521                 return -ENODEV;
522
523         data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
524         if (!data)
525                 return -ENOMEM;
526
527         spin_lock_init(&data->lock);
528
529         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
530         data->base = devm_ioremap_resource(&pdev->dev, res);
531         if (IS_ERR(data->base))
532                 return PTR_ERR(data->base);
533
534         data->ops = (const struct usbmisc_ops *)of_id->data;
535         platform_set_drvdata(pdev, data);
536
537         return 0;
538 }
539
540 static int usbmisc_imx_remove(struct platform_device *pdev)
541 {
542         return 0;
543 }
544
545 static struct platform_driver usbmisc_imx_driver = {
546         .probe = usbmisc_imx_probe,
547         .remove = usbmisc_imx_remove,
548         .driver = {
549                 .name = "usbmisc_imx",
550                 .of_match_table = usbmisc_imx_dt_ids,
551          },
552 };
553
554 module_platform_driver(usbmisc_imx_driver);
555
556 MODULE_ALIAS("platform:usbmisc-imx");
557 MODULE_LICENSE("GPL v2");
558 MODULE_DESCRIPTION("driver for imx usb non-core registers");
559 MODULE_AUTHOR("Richard Zhao <richard.zhao@freescale.com>");