mfd: omap-usb-tll: Fix inverted bit use for USB TLL mode
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / mfd / omap-usb-tll.c
1 /**
2 * omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
3 *
4 * Copyright (C) 2012-2013 Texas Instruments Incorporated - http://www.ti.com
5 * Author: Keshava Munegowda <keshava_mgowda@ti.com>
6 * Author: Roger Quadros <rogerq@ti.com>
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 of
10 * the License as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/slab.h>
24 #include <linux/spinlock.h>
25 #include <linux/platform_device.h>
26 #include <linux/clk.h>
27 #include <linux/io.h>
28 #include <linux/err.h>
29 #include <linux/pm_runtime.h>
30 #include <linux/platform_data/usb-omap.h>
31 #include <linux/of.h>
32
33 #define USBTLL_DRIVER_NAME "usbhs_tll"
34
35 /* TLL Register Set */
36 #define OMAP_USBTLL_REVISION (0x00)
37 #define OMAP_USBTLL_SYSCONFIG (0x10)
38 #define OMAP_USBTLL_SYSCONFIG_CACTIVITY (1 << 8)
39 #define OMAP_USBTLL_SYSCONFIG_SIDLEMODE (1 << 3)
40 #define OMAP_USBTLL_SYSCONFIG_ENAWAKEUP (1 << 2)
41 #define OMAP_USBTLL_SYSCONFIG_SOFTRESET (1 << 1)
42 #define OMAP_USBTLL_SYSCONFIG_AUTOIDLE (1 << 0)
43
44 #define OMAP_USBTLL_SYSSTATUS (0x14)
45 #define OMAP_USBTLL_SYSSTATUS_RESETDONE (1 << 0)
46
47 #define OMAP_USBTLL_IRQSTATUS (0x18)
48 #define OMAP_USBTLL_IRQENABLE (0x1C)
49
50 #define OMAP_TLL_SHARED_CONF (0x30)
51 #define OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN (1 << 6)
52 #define OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN (1 << 5)
53 #define OMAP_TLL_SHARED_CONF_USB_DIVRATION (1 << 2)
54 #define OMAP_TLL_SHARED_CONF_FCLK_REQ (1 << 1)
55 #define OMAP_TLL_SHARED_CONF_FCLK_IS_ON (1 << 0)
56
57 #define OMAP_TLL_CHANNEL_CONF(num) (0x040 + 0x004 * num)
58 #define OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT 24
59 #define OMAP_TLL_CHANNEL_CONF_DRVVBUS (1 << 16)
60 #define OMAP_TLL_CHANNEL_CONF_CHRGVBUS (1 << 15)
61 #define OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF (1 << 11)
62 #define OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE (1 << 10)
63 #define OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE (1 << 9)
64 #define OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE (1 << 8)
65 #define OMAP_TLL_CHANNEL_CONF_MODE_TRANSPARENT_UTMI (2 << 1)
66 #define OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS (1 << 1)
67 #define OMAP_TLL_CHANNEL_CONF_CHANEN (1 << 0)
68
69 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0 0x0
70 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM 0x1
71 #define OMAP_TLL_FSLSMODE_3PIN_PHY 0x2
72 #define OMAP_TLL_FSLSMODE_4PIN_PHY 0x3
73 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0 0x4
74 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM 0x5
75 #define OMAP_TLL_FSLSMODE_3PIN_TLL 0x6
76 #define OMAP_TLL_FSLSMODE_4PIN_TLL 0x7
77 #define OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0 0xA
78 #define OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM 0xB
79
80 #define OMAP_TLL_ULPI_FUNCTION_CTRL(num) (0x804 + 0x100 * num)
81 #define OMAP_TLL_ULPI_INTERFACE_CTRL(num) (0x807 + 0x100 * num)
82 #define OMAP_TLL_ULPI_OTG_CTRL(num) (0x80A + 0x100 * num)
83 #define OMAP_TLL_ULPI_INT_EN_RISE(num) (0x80D + 0x100 * num)
84 #define OMAP_TLL_ULPI_INT_EN_FALL(num) (0x810 + 0x100 * num)
85 #define OMAP_TLL_ULPI_INT_STATUS(num) (0x813 + 0x100 * num)
86 #define OMAP_TLL_ULPI_INT_LATCH(num) (0x814 + 0x100 * num)
87 #define OMAP_TLL_ULPI_DEBUG(num) (0x815 + 0x100 * num)
88 #define OMAP_TLL_ULPI_SCRATCH_REGISTER(num) (0x816 + 0x100 * num)
89
90 #define OMAP_REV2_TLL_CHANNEL_COUNT 2
91 #define OMAP_TLL_CHANNEL_COUNT 3
92 #define OMAP_TLL_CHANNEL_1_EN_MASK (1 << 0)
93 #define OMAP_TLL_CHANNEL_2_EN_MASK (1 << 1)
94 #define OMAP_TLL_CHANNEL_3_EN_MASK (1 << 2)
95
96 /* Values of USBTLL_REVISION - Note: these are not given in the TRM */
97 #define OMAP_USBTLL_REV1 0x00000015 /* OMAP3 */
98 #define OMAP_USBTLL_REV2 0x00000018 /* OMAP 3630 */
99 #define OMAP_USBTLL_REV3 0x00000004 /* OMAP4 */
100 #define OMAP_USBTLL_REV4 0x00000006 /* OMAP5 */
101
102 #define is_ehci_tll_mode(x) (x == OMAP_EHCI_PORT_MODE_TLL)
103
104 /* only PHY and UNUSED modes don't need TLL */
105 #define omap_usb_mode_needs_tll(x) ((x) != OMAP_USBHS_PORT_MODE_UNUSED &&\
106 (x) != OMAP_EHCI_PORT_MODE_PHY)
107
108 struct usbtll_omap {
109 int nch; /* num. of channels */
110 struct clk **ch_clk;
111 void __iomem *base;
112 };
113
114 /*-------------------------------------------------------------------------*/
115
116 static const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
117 static struct device *tll_dev;
118 static DEFINE_SPINLOCK(tll_lock); /* serialize access to tll_dev */
119
120 /*-------------------------------------------------------------------------*/
121
122 static inline void usbtll_write(void __iomem *base, u32 reg, u32 val)
123 {
124 __raw_writel(val, base + reg);
125 }
126
127 static inline u32 usbtll_read(void __iomem *base, u32 reg)
128 {
129 return __raw_readl(base + reg);
130 }
131
132 static inline void usbtll_writeb(void __iomem *base, u8 reg, u8 val)
133 {
134 __raw_writeb(val, base + reg);
135 }
136
137 static inline u8 usbtll_readb(void __iomem *base, u8 reg)
138 {
139 return __raw_readb(base + reg);
140 }
141
142 /*-------------------------------------------------------------------------*/
143
144 static bool is_ohci_port(enum usbhs_omap_port_mode pmode)
145 {
146 switch (pmode) {
147 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
148 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
149 case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
150 case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
151 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
152 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
153 case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
154 case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
155 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
156 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
157 return true;
158
159 default:
160 return false;
161 }
162 }
163
164 /*
165 * convert the port-mode enum to a value we can use in the FSLSMODE
166 * field of USBTLL_CHANNEL_CONF
167 */
168 static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
169 {
170 switch (mode) {
171 case OMAP_USBHS_PORT_MODE_UNUSED:
172 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
173 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
174
175 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
176 return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM;
177
178 case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
179 return OMAP_TLL_FSLSMODE_3PIN_PHY;
180
181 case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
182 return OMAP_TLL_FSLSMODE_4PIN_PHY;
183
184 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
185 return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0;
186
187 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
188 return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM;
189
190 case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
191 return OMAP_TLL_FSLSMODE_3PIN_TLL;
192
193 case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
194 return OMAP_TLL_FSLSMODE_4PIN_TLL;
195
196 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
197 return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0;
198
199 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
200 return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM;
201 default:
202 pr_warn("Invalid port mode, using default\n");
203 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
204 }
205 }
206
207 /**
208 * usbtll_omap_probe - initialize TI-based HCDs
209 *
210 * Allocates basic resources for this USB host controller.
211 */
212 static int usbtll_omap_probe(struct platform_device *pdev)
213 {
214 struct device *dev = &pdev->dev;
215 struct resource *res;
216 struct usbtll_omap *tll;
217 int ret = 0;
218 int i, ver;
219
220 dev_dbg(dev, "starting TI HSUSB TLL Controller\n");
221
222 tll = devm_kzalloc(dev, sizeof(struct usbtll_omap), GFP_KERNEL);
223 if (!tll) {
224 dev_err(dev, "Memory allocation failed\n");
225 return -ENOMEM;
226 }
227
228 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
229 tll->base = devm_ioremap_resource(dev, res);
230 if (IS_ERR(tll->base))
231 return PTR_ERR(tll->base);
232
233 platform_set_drvdata(pdev, tll);
234 pm_runtime_enable(dev);
235 pm_runtime_get_sync(dev);
236
237 ver = usbtll_read(tll->base, OMAP_USBTLL_REVISION);
238 switch (ver) {
239 case OMAP_USBTLL_REV1:
240 case OMAP_USBTLL_REV4:
241 tll->nch = OMAP_TLL_CHANNEL_COUNT;
242 break;
243 case OMAP_USBTLL_REV2:
244 case OMAP_USBTLL_REV3:
245 tll->nch = OMAP_REV2_TLL_CHANNEL_COUNT;
246 break;
247 default:
248 tll->nch = OMAP_TLL_CHANNEL_COUNT;
249 dev_dbg(dev,
250 "USB TLL Rev : 0x%x not recognized, assuming %d channels\n",
251 ver, tll->nch);
252 break;
253 }
254
255 tll->ch_clk = devm_kzalloc(dev, sizeof(struct clk * [tll->nch]),
256 GFP_KERNEL);
257 if (!tll->ch_clk) {
258 ret = -ENOMEM;
259 dev_err(dev, "Couldn't allocate memory for channel clocks\n");
260 goto err_clk_alloc;
261 }
262
263 for (i = 0; i < tll->nch; i++) {
264 char clkname[] = "usb_tll_hs_usb_chx_clk";
265
266 snprintf(clkname, sizeof(clkname),
267 "usb_tll_hs_usb_ch%d_clk", i);
268 tll->ch_clk[i] = clk_get(dev, clkname);
269
270 if (IS_ERR(tll->ch_clk[i]))
271 dev_dbg(dev, "can't get clock : %s\n", clkname);
272 else
273 clk_prepare(tll->ch_clk[i]);
274 }
275
276 pm_runtime_put_sync(dev);
277 /* only after this can omap_tll_enable/disable work */
278 spin_lock(&tll_lock);
279 tll_dev = dev;
280 spin_unlock(&tll_lock);
281
282 return 0;
283
284 err_clk_alloc:
285 pm_runtime_put_sync(dev);
286 pm_runtime_disable(dev);
287
288 return ret;
289 }
290
291 /**
292 * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
293 * @pdev: USB Host Controller being removed
294 *
295 * Reverses the effect of usbtll_omap_probe().
296 */
297 static int usbtll_omap_remove(struct platform_device *pdev)
298 {
299 struct usbtll_omap *tll = platform_get_drvdata(pdev);
300 int i;
301
302 spin_lock(&tll_lock);
303 tll_dev = NULL;
304 spin_unlock(&tll_lock);
305
306 for (i = 0; i < tll->nch; i++) {
307 if (!IS_ERR(tll->ch_clk[i])) {
308 clk_unprepare(tll->ch_clk[i]);
309 clk_put(tll->ch_clk[i]);
310 }
311 }
312
313 pm_runtime_disable(&pdev->dev);
314 return 0;
315 }
316
317 static const struct of_device_id usbtll_omap_dt_ids[] = {
318 { .compatible = "ti,usbhs-tll" },
319 { }
320 };
321
322 MODULE_DEVICE_TABLE(of, usbtll_omap_dt_ids);
323
324 static struct platform_driver usbtll_omap_driver = {
325 .driver = {
326 .name = (char *)usbtll_driver_name,
327 .owner = THIS_MODULE,
328 .of_match_table = of_match_ptr(usbtll_omap_dt_ids),
329 },
330 .probe = usbtll_omap_probe,
331 .remove = usbtll_omap_remove,
332 };
333
334 int omap_tll_init(struct usbhs_omap_platform_data *pdata)
335 {
336 int i;
337 bool needs_tll;
338 unsigned reg;
339 struct usbtll_omap *tll;
340
341 spin_lock(&tll_lock);
342
343 if (!tll_dev) {
344 spin_unlock(&tll_lock);
345 return -ENODEV;
346 }
347
348 tll = dev_get_drvdata(tll_dev);
349
350 needs_tll = false;
351 for (i = 0; i < tll->nch; i++)
352 needs_tll |= omap_usb_mode_needs_tll(pdata->port_mode[i]);
353
354 pm_runtime_get_sync(tll_dev);
355
356 if (needs_tll) {
357 void __iomem *base = tll->base;
358
359 /* Program Common TLL register */
360 reg = usbtll_read(base, OMAP_TLL_SHARED_CONF);
361 reg |= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
362 | OMAP_TLL_SHARED_CONF_USB_DIVRATION);
363 reg &= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN;
364 reg &= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN;
365
366 usbtll_write(base, OMAP_TLL_SHARED_CONF, reg);
367
368 /* Enable channels now */
369 for (i = 0; i < tll->nch; i++) {
370 reg = usbtll_read(base, OMAP_TLL_CHANNEL_CONF(i));
371
372 if (is_ohci_port(pdata->port_mode[i])) {
373 reg |= ohci_omap3_fslsmode(pdata->port_mode[i])
374 << OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT;
375 reg |= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS;
376 } else if (pdata->port_mode[i] ==
377 OMAP_EHCI_PORT_MODE_TLL) {
378 /*
379 * Disable AutoIdle, BitStuffing
380 * and use SDR Mode
381 */
382 reg &= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
383 | OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE);
384 reg |= OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF;
385 } else if (pdata->port_mode[i] ==
386 OMAP_EHCI_PORT_MODE_HSIC) {
387 /*
388 * HSIC Mode requires UTMI port configurations
389 */
390 reg |= OMAP_TLL_CHANNEL_CONF_DRVVBUS
391 | OMAP_TLL_CHANNEL_CONF_CHRGVBUS
392 | OMAP_TLL_CHANNEL_CONF_MODE_TRANSPARENT_UTMI
393 | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF;
394 } else {
395 continue;
396 }
397 reg |= OMAP_TLL_CHANNEL_CONF_CHANEN;
398 usbtll_write(base, OMAP_TLL_CHANNEL_CONF(i), reg);
399
400 usbtll_writeb(base,
401 OMAP_TLL_ULPI_SCRATCH_REGISTER(i),
402 0xbe);
403 }
404 }
405
406 pm_runtime_put_sync(tll_dev);
407
408 spin_unlock(&tll_lock);
409
410 return 0;
411 }
412 EXPORT_SYMBOL_GPL(omap_tll_init);
413
414 int omap_tll_enable(struct usbhs_omap_platform_data *pdata)
415 {
416 int i;
417 struct usbtll_omap *tll;
418
419 spin_lock(&tll_lock);
420
421 if (!tll_dev) {
422 spin_unlock(&tll_lock);
423 return -ENODEV;
424 }
425
426 tll = dev_get_drvdata(tll_dev);
427
428 pm_runtime_get_sync(tll_dev);
429
430 for (i = 0; i < tll->nch; i++) {
431 if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
432 int r;
433
434 if (IS_ERR(tll->ch_clk[i]))
435 continue;
436
437 r = clk_enable(tll->ch_clk[i]);
438 if (r) {
439 dev_err(tll_dev,
440 "Error enabling ch %d clock: %d\n", i, r);
441 }
442 }
443 }
444
445 spin_unlock(&tll_lock);
446
447 return 0;
448 }
449 EXPORT_SYMBOL_GPL(omap_tll_enable);
450
451 int omap_tll_disable(struct usbhs_omap_platform_data *pdata)
452 {
453 int i;
454 struct usbtll_omap *tll;
455
456 spin_lock(&tll_lock);
457
458 if (!tll_dev) {
459 spin_unlock(&tll_lock);
460 return -ENODEV;
461 }
462
463 tll = dev_get_drvdata(tll_dev);
464
465 for (i = 0; i < tll->nch; i++) {
466 if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
467 if (!IS_ERR(tll->ch_clk[i]))
468 clk_disable(tll->ch_clk[i]);
469 }
470 }
471
472 pm_runtime_put_sync(tll_dev);
473
474 spin_unlock(&tll_lock);
475
476 return 0;
477 }
478 EXPORT_SYMBOL_GPL(omap_tll_disable);
479
480 MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
481 MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>");
482 MODULE_ALIAS("platform:" USBHS_DRIVER_NAME);
483 MODULE_LICENSE("GPL v2");
484 MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
485
486 static int __init omap_usbtll_drvinit(void)
487 {
488 return platform_driver_register(&usbtll_omap_driver);
489 }
490
491 /*
492 * init before usbhs core driver;
493 * The usbtll driver should be initialized before
494 * the usbhs core driver probe function is called.
495 */
496 fs_initcall(omap_usbtll_drvinit);
497
498 static void __exit omap_usbtll_drvexit(void)
499 {
500 platform_driver_unregister(&usbtll_omap_driver);
501 }
502 module_exit(omap_usbtll_drvexit);