1 // SPDX-License-Identifier: GPL-2.0-only
3 * omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
5 * Copyright (C) 2012-2013 Texas Instruments Incorporated - https://www.ti.com
6 * Author: Keshava Munegowda <keshava_mgowda@ti.com>
7 * Author: Roger Quadros <rogerq@ti.com>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/slab.h>
13 #include <linux/spinlock.h>
14 #include <linux/platform_device.h>
15 #include <linux/clk.h>
17 #include <linux/err.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/platform_data/usb-omap.h>
24 #define USBTLL_DRIVER_NAME "usbhs_tll"
26 /* TLL Register Set */
27 #define OMAP_USBTLL_REVISION (0x00)
28 #define OMAP_USBTLL_SYSCONFIG (0x10)
29 #define OMAP_USBTLL_SYSCONFIG_CACTIVITY (1 << 8)
30 #define OMAP_USBTLL_SYSCONFIG_SIDLEMODE (1 << 3)
31 #define OMAP_USBTLL_SYSCONFIG_ENAWAKEUP (1 << 2)
32 #define OMAP_USBTLL_SYSCONFIG_SOFTRESET (1 << 1)
33 #define OMAP_USBTLL_SYSCONFIG_AUTOIDLE (1 << 0)
35 #define OMAP_USBTLL_SYSSTATUS (0x14)
36 #define OMAP_USBTLL_SYSSTATUS_RESETDONE (1 << 0)
38 #define OMAP_USBTLL_IRQSTATUS (0x18)
39 #define OMAP_USBTLL_IRQENABLE (0x1C)
41 #define OMAP_TLL_SHARED_CONF (0x30)
42 #define OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN (1 << 6)
43 #define OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN (1 << 5)
44 #define OMAP_TLL_SHARED_CONF_USB_DIVRATION (1 << 2)
45 #define OMAP_TLL_SHARED_CONF_FCLK_REQ (1 << 1)
46 #define OMAP_TLL_SHARED_CONF_FCLK_IS_ON (1 << 0)
48 #define OMAP_TLL_CHANNEL_CONF(num) (0x040 + 0x004 * num)
49 #define OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT 24
50 #define OMAP_TLL_CHANNEL_CONF_DRVVBUS (1 << 16)
51 #define OMAP_TLL_CHANNEL_CONF_CHRGVBUS (1 << 15)
52 #define OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF (1 << 11)
53 #define OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE (1 << 10)
54 #define OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE (1 << 9)
55 #define OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE (1 << 8)
56 #define OMAP_TLL_CHANNEL_CONF_MODE_TRANSPARENT_UTMI (2 << 1)
57 #define OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS (1 << 1)
58 #define OMAP_TLL_CHANNEL_CONF_CHANEN (1 << 0)
60 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0 0x0
61 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM 0x1
62 #define OMAP_TLL_FSLSMODE_3PIN_PHY 0x2
63 #define OMAP_TLL_FSLSMODE_4PIN_PHY 0x3
64 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0 0x4
65 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM 0x5
66 #define OMAP_TLL_FSLSMODE_3PIN_TLL 0x6
67 #define OMAP_TLL_FSLSMODE_4PIN_TLL 0x7
68 #define OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0 0xA
69 #define OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM 0xB
71 #define OMAP_TLL_ULPI_FUNCTION_CTRL(num) (0x804 + 0x100 * num)
72 #define OMAP_TLL_ULPI_INTERFACE_CTRL(num) (0x807 + 0x100 * num)
73 #define OMAP_TLL_ULPI_OTG_CTRL(num) (0x80A + 0x100 * num)
74 #define OMAP_TLL_ULPI_INT_EN_RISE(num) (0x80D + 0x100 * num)
75 #define OMAP_TLL_ULPI_INT_EN_FALL(num) (0x810 + 0x100 * num)
76 #define OMAP_TLL_ULPI_INT_STATUS(num) (0x813 + 0x100 * num)
77 #define OMAP_TLL_ULPI_INT_LATCH(num) (0x814 + 0x100 * num)
78 #define OMAP_TLL_ULPI_DEBUG(num) (0x815 + 0x100 * num)
79 #define OMAP_TLL_ULPI_SCRATCH_REGISTER(num) (0x816 + 0x100 * num)
81 #define OMAP_REV2_TLL_CHANNEL_COUNT 2
82 #define OMAP_TLL_CHANNEL_COUNT 3
83 #define OMAP_TLL_CHANNEL_1_EN_MASK (1 << 0)
84 #define OMAP_TLL_CHANNEL_2_EN_MASK (1 << 1)
85 #define OMAP_TLL_CHANNEL_3_EN_MASK (1 << 2)
87 /* Values of USBTLL_REVISION - Note: these are not given in the TRM */
88 #define OMAP_USBTLL_REV1 0x00000015 /* OMAP3 */
89 #define OMAP_USBTLL_REV2 0x00000018 /* OMAP 3630 */
90 #define OMAP_USBTLL_REV3 0x00000004 /* OMAP4 */
91 #define OMAP_USBTLL_REV4 0x00000006 /* OMAP5 */
93 #define is_ehci_tll_mode(x) (x == OMAP_EHCI_PORT_MODE_TLL)
95 /* only PHY and UNUSED modes don't need TLL */
96 #define omap_usb_mode_needs_tll(x) ((x) != OMAP_USBHS_PORT_MODE_UNUSED &&\
97 (x) != OMAP_EHCI_PORT_MODE_PHY)
101 int nch; /* num. of channels */
102 struct clk *ch_clk[]; /* must be the last member */
105 /*-------------------------------------------------------------------------*/
107 static const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
108 static struct device *tll_dev;
109 static DEFINE_SPINLOCK(tll_lock); /* serialize access to tll_dev */
111 /*-------------------------------------------------------------------------*/
113 static inline void usbtll_write(void __iomem *base, u32 reg, u32 val)
115 writel_relaxed(val, base + reg);
118 static inline u32 usbtll_read(void __iomem *base, u32 reg)
120 return readl_relaxed(base + reg);
123 static inline void usbtll_writeb(void __iomem *base, u32 reg, u8 val)
125 writeb_relaxed(val, base + reg);
128 /*-------------------------------------------------------------------------*/
130 static bool is_ohci_port(enum usbhs_omap_port_mode pmode)
133 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
134 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
135 case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
136 case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
137 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
138 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
139 case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
140 case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
141 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
142 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
151 * convert the port-mode enum to a value we can use in the FSLSMODE
152 * field of USBTLL_CHANNEL_CONF
154 static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
157 case OMAP_USBHS_PORT_MODE_UNUSED:
158 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
159 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
161 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
162 return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM;
164 case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
165 return OMAP_TLL_FSLSMODE_3PIN_PHY;
167 case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
168 return OMAP_TLL_FSLSMODE_4PIN_PHY;
170 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
171 return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0;
173 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
174 return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM;
176 case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
177 return OMAP_TLL_FSLSMODE_3PIN_TLL;
179 case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
180 return OMAP_TLL_FSLSMODE_4PIN_TLL;
182 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
183 return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0;
185 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
186 return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM;
188 pr_warn("Invalid port mode, using default\n");
189 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
194 * usbtll_omap_probe - initialize TI-based HCDs
196 * Allocates basic resources for this USB host controller.
198 * @pdev: Pointer to this device's platform device structure
200 static int usbtll_omap_probe(struct platform_device *pdev)
202 struct device *dev = &pdev->dev;
203 struct resource *res;
204 struct usbtll_omap *tll;
208 dev_dbg(dev, "starting TI HSUSB TLL Controller\n");
210 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
211 base = devm_ioremap_resource(dev, res);
213 return PTR_ERR(base);
215 pm_runtime_enable(dev);
216 pm_runtime_get_sync(dev);
218 ver = usbtll_read(base, OMAP_USBTLL_REVISION);
220 case OMAP_USBTLL_REV1:
221 case OMAP_USBTLL_REV4:
222 nch = OMAP_TLL_CHANNEL_COUNT;
224 case OMAP_USBTLL_REV2:
225 case OMAP_USBTLL_REV3:
226 nch = OMAP_REV2_TLL_CHANNEL_COUNT;
229 nch = OMAP_TLL_CHANNEL_COUNT;
230 dev_dbg(dev, "rev 0x%x not recognized, assuming %d channels\n",
235 tll = devm_kzalloc(dev, sizeof(*tll) + sizeof(tll->ch_clk[nch]),
238 pm_runtime_put_sync(dev);
239 pm_runtime_disable(dev);
245 platform_set_drvdata(pdev, tll);
247 for (i = 0; i < nch; i++) {
248 char clkname[] = "usb_tll_hs_usb_chx_clk";
250 snprintf(clkname, sizeof(clkname),
251 "usb_tll_hs_usb_ch%d_clk", i);
252 tll->ch_clk[i] = clk_get(dev, clkname);
254 if (IS_ERR(tll->ch_clk[i]))
255 dev_dbg(dev, "can't get clock : %s\n", clkname);
257 clk_prepare(tll->ch_clk[i]);
260 pm_runtime_put_sync(dev);
261 /* only after this can omap_tll_enable/disable work */
262 spin_lock(&tll_lock);
264 spin_unlock(&tll_lock);
270 * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
271 * @pdev: USB Host Controller being removed
273 * Reverses the effect of usbtll_omap_probe().
275 static int usbtll_omap_remove(struct platform_device *pdev)
277 struct usbtll_omap *tll = platform_get_drvdata(pdev);
280 spin_lock(&tll_lock);
282 spin_unlock(&tll_lock);
284 for (i = 0; i < tll->nch; i++) {
285 if (!IS_ERR(tll->ch_clk[i])) {
286 clk_unprepare(tll->ch_clk[i]);
287 clk_put(tll->ch_clk[i]);
291 pm_runtime_disable(&pdev->dev);
295 static const struct of_device_id usbtll_omap_dt_ids[] = {
296 { .compatible = "ti,usbhs-tll" },
300 MODULE_DEVICE_TABLE(of, usbtll_omap_dt_ids);
302 static struct platform_driver usbtll_omap_driver = {
304 .name = usbtll_driver_name,
305 .of_match_table = usbtll_omap_dt_ids,
307 .probe = usbtll_omap_probe,
308 .remove = usbtll_omap_remove,
311 int omap_tll_init(struct usbhs_omap_platform_data *pdata)
316 struct usbtll_omap *tll;
321 pm_runtime_get_sync(tll_dev);
323 spin_lock(&tll_lock);
324 tll = dev_get_drvdata(tll_dev);
326 for (i = 0; i < tll->nch; i++)
327 needs_tll |= omap_usb_mode_needs_tll(pdata->port_mode[i]);
330 void __iomem *base = tll->base;
332 /* Program Common TLL register */
333 reg = usbtll_read(base, OMAP_TLL_SHARED_CONF);
334 reg |= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
335 | OMAP_TLL_SHARED_CONF_USB_DIVRATION);
336 reg &= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN;
337 reg &= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN;
339 usbtll_write(base, OMAP_TLL_SHARED_CONF, reg);
341 /* Enable channels now */
342 for (i = 0; i < tll->nch; i++) {
343 reg = usbtll_read(base, OMAP_TLL_CHANNEL_CONF(i));
345 if (is_ohci_port(pdata->port_mode[i])) {
346 reg |= ohci_omap3_fslsmode(pdata->port_mode[i])
347 << OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT;
348 reg |= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS;
349 } else if (pdata->port_mode[i] ==
350 OMAP_EHCI_PORT_MODE_TLL) {
352 * Disable UTMI AutoIdle, BitStuffing
353 * and use SDR Mode. Enable ULPI AutoIdle.
355 reg &= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
356 | OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE);
357 reg |= OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF;
358 reg |= OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE;
359 } else if (pdata->port_mode[i] ==
360 OMAP_EHCI_PORT_MODE_HSIC) {
362 * HSIC Mode requires UTMI port configurations
364 reg |= OMAP_TLL_CHANNEL_CONF_DRVVBUS
365 | OMAP_TLL_CHANNEL_CONF_CHRGVBUS
366 | OMAP_TLL_CHANNEL_CONF_MODE_TRANSPARENT_UTMI
367 | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF;
371 reg |= OMAP_TLL_CHANNEL_CONF_CHANEN;
372 usbtll_write(base, OMAP_TLL_CHANNEL_CONF(i), reg);
375 OMAP_TLL_ULPI_SCRATCH_REGISTER(i),
380 spin_unlock(&tll_lock);
381 pm_runtime_put_sync(tll_dev);
385 EXPORT_SYMBOL_GPL(omap_tll_init);
387 int omap_tll_enable(struct usbhs_omap_platform_data *pdata)
390 struct usbtll_omap *tll;
395 pm_runtime_get_sync(tll_dev);
397 spin_lock(&tll_lock);
398 tll = dev_get_drvdata(tll_dev);
400 for (i = 0; i < tll->nch; i++) {
401 if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
404 if (IS_ERR(tll->ch_clk[i]))
407 r = clk_enable(tll->ch_clk[i]);
410 "Error enabling ch %d clock: %d\n", i, r);
415 spin_unlock(&tll_lock);
419 EXPORT_SYMBOL_GPL(omap_tll_enable);
421 int omap_tll_disable(struct usbhs_omap_platform_data *pdata)
424 struct usbtll_omap *tll;
429 spin_lock(&tll_lock);
430 tll = dev_get_drvdata(tll_dev);
432 for (i = 0; i < tll->nch; i++) {
433 if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
434 if (!IS_ERR(tll->ch_clk[i]))
435 clk_disable(tll->ch_clk[i]);
439 spin_unlock(&tll_lock);
440 pm_runtime_put_sync(tll_dev);
444 EXPORT_SYMBOL_GPL(omap_tll_disable);
446 MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
447 MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>");
448 MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
450 static int __init omap_usbtll_drvinit(void)
452 return platform_driver_register(&usbtll_omap_driver);
456 * init before usbhs core driver;
457 * The usbtll driver should be initialized before
458 * the usbhs core driver probe function is called.
460 fs_initcall(omap_usbtll_drvinit);
462 static void __exit omap_usbtll_drvexit(void)
464 platform_driver_unregister(&usbtll_omap_driver);
466 module_exit(omap_usbtll_drvexit);