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)
102 struct clk
*ch_clk
[] __counted_by(nch
);
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 usbtll_omap
*tll
;
207 dev_dbg(dev
, "starting TI HSUSB TLL Controller\n");
209 base
= devm_platform_ioremap_resource(pdev
, 0);
211 return PTR_ERR(base
);
213 pm_runtime_enable(dev
);
214 pm_runtime_get_sync(dev
);
216 ver
= usbtll_read(base
, OMAP_USBTLL_REVISION
);
218 case OMAP_USBTLL_REV1
:
219 case OMAP_USBTLL_REV4
:
220 nch
= OMAP_TLL_CHANNEL_COUNT
;
222 case OMAP_USBTLL_REV2
:
223 case OMAP_USBTLL_REV3
:
224 nch
= OMAP_REV2_TLL_CHANNEL_COUNT
;
227 nch
= OMAP_TLL_CHANNEL_COUNT
;
228 dev_dbg(dev
, "rev 0x%x not recognized, assuming %d channels\n",
233 tll
= devm_kzalloc(dev
, struct_size(tll
, ch_clk
, nch
), GFP_KERNEL
);
235 pm_runtime_put_sync(dev
);
236 pm_runtime_disable(dev
);
242 platform_set_drvdata(pdev
, tll
);
244 for (i
= 0; i
< nch
; i
++) {
245 char clkname
[] = "usb_tll_hs_usb_chx_clk";
247 snprintf(clkname
, sizeof(clkname
),
248 "usb_tll_hs_usb_ch%d_clk", i
);
249 tll
->ch_clk
[i
] = clk_get(dev
, clkname
);
251 if (IS_ERR(tll
->ch_clk
[i
]))
252 dev_dbg(dev
, "can't get clock : %s\n", clkname
);
254 clk_prepare(tll
->ch_clk
[i
]);
257 pm_runtime_put_sync(dev
);
258 /* only after this can omap_tll_enable/disable work */
259 spin_lock(&tll_lock
);
261 spin_unlock(&tll_lock
);
267 * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
268 * @pdev: USB Host Controller being removed
270 * Reverses the effect of usbtll_omap_probe().
272 static void usbtll_omap_remove(struct platform_device
*pdev
)
274 struct usbtll_omap
*tll
= platform_get_drvdata(pdev
);
277 spin_lock(&tll_lock
);
279 spin_unlock(&tll_lock
);
281 for (i
= 0; i
< tll
->nch
; i
++) {
282 if (!IS_ERR(tll
->ch_clk
[i
])) {
283 clk_unprepare(tll
->ch_clk
[i
]);
284 clk_put(tll
->ch_clk
[i
]);
288 pm_runtime_disable(&pdev
->dev
);
291 static const struct of_device_id usbtll_omap_dt_ids
[] = {
292 { .compatible
= "ti,usbhs-tll" },
296 MODULE_DEVICE_TABLE(of
, usbtll_omap_dt_ids
);
298 static struct platform_driver usbtll_omap_driver
= {
300 .name
= usbtll_driver_name
,
301 .of_match_table
= usbtll_omap_dt_ids
,
303 .probe
= usbtll_omap_probe
,
304 .remove
= usbtll_omap_remove
,
307 int omap_tll_init(struct usbhs_omap_platform_data
*pdata
)
312 struct usbtll_omap
*tll
;
317 pm_runtime_get_sync(tll_dev
);
319 spin_lock(&tll_lock
);
320 tll
= dev_get_drvdata(tll_dev
);
322 for (i
= 0; i
< tll
->nch
; i
++)
323 needs_tll
|= omap_usb_mode_needs_tll(pdata
->port_mode
[i
]);
326 void __iomem
*base
= tll
->base
;
328 /* Program Common TLL register */
329 reg
= usbtll_read(base
, OMAP_TLL_SHARED_CONF
);
330 reg
|= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
331 | OMAP_TLL_SHARED_CONF_USB_DIVRATION
);
332 reg
&= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN
;
333 reg
&= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN
;
335 usbtll_write(base
, OMAP_TLL_SHARED_CONF
, reg
);
337 /* Enable channels now */
338 for (i
= 0; i
< tll
->nch
; i
++) {
339 reg
= usbtll_read(base
, OMAP_TLL_CHANNEL_CONF(i
));
341 if (is_ohci_port(pdata
->port_mode
[i
])) {
342 reg
|= ohci_omap3_fslsmode(pdata
->port_mode
[i
])
343 << OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT
;
344 reg
|= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS
;
345 } else if (pdata
->port_mode
[i
] ==
346 OMAP_EHCI_PORT_MODE_TLL
) {
348 * Disable UTMI AutoIdle, BitStuffing
349 * and use SDR Mode. Enable ULPI AutoIdle.
351 reg
&= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
352 | OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE
);
353 reg
|= OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
;
354 reg
|= OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE
;
355 } else if (pdata
->port_mode
[i
] ==
356 OMAP_EHCI_PORT_MODE_HSIC
) {
358 * HSIC Mode requires UTMI port configurations
360 reg
|= OMAP_TLL_CHANNEL_CONF_DRVVBUS
361 | OMAP_TLL_CHANNEL_CONF_CHRGVBUS
362 | OMAP_TLL_CHANNEL_CONF_MODE_TRANSPARENT_UTMI
363 | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
;
367 reg
|= OMAP_TLL_CHANNEL_CONF_CHANEN
;
368 usbtll_write(base
, OMAP_TLL_CHANNEL_CONF(i
), reg
);
371 OMAP_TLL_ULPI_SCRATCH_REGISTER(i
),
376 spin_unlock(&tll_lock
);
377 pm_runtime_put_sync(tll_dev
);
381 EXPORT_SYMBOL_GPL(omap_tll_init
);
383 int omap_tll_enable(struct usbhs_omap_platform_data
*pdata
)
386 struct usbtll_omap
*tll
;
391 pm_runtime_get_sync(tll_dev
);
393 spin_lock(&tll_lock
);
394 tll
= dev_get_drvdata(tll_dev
);
396 for (i
= 0; i
< tll
->nch
; i
++) {
397 if (omap_usb_mode_needs_tll(pdata
->port_mode
[i
])) {
400 if (IS_ERR(tll
->ch_clk
[i
]))
403 r
= clk_enable(tll
->ch_clk
[i
]);
406 "Error enabling ch %d clock: %d\n", i
, r
);
411 spin_unlock(&tll_lock
);
415 EXPORT_SYMBOL_GPL(omap_tll_enable
);
417 int omap_tll_disable(struct usbhs_omap_platform_data
*pdata
)
420 struct usbtll_omap
*tll
;
425 spin_lock(&tll_lock
);
426 tll
= dev_get_drvdata(tll_dev
);
428 for (i
= 0; i
< tll
->nch
; i
++) {
429 if (omap_usb_mode_needs_tll(pdata
->port_mode
[i
])) {
430 if (!IS_ERR(tll
->ch_clk
[i
]))
431 clk_disable(tll
->ch_clk
[i
]);
435 spin_unlock(&tll_lock
);
436 pm_runtime_put_sync(tll_dev
);
440 EXPORT_SYMBOL_GPL(omap_tll_disable
);
442 MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
443 MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>");
444 MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
446 static int __init
omap_usbtll_drvinit(void)
448 return platform_driver_register(&usbtll_omap_driver
);
452 * init before usbhs core driver;
453 * The usbtll driver should be initialized before
454 * the usbhs core driver probe function is called.
456 fs_initcall(omap_usbtll_drvinit
);
458 static void __exit
omap_usbtll_drvexit(void)
460 platform_driver_unregister(&usbtll_omap_driver
);
462 module_exit(omap_usbtll_drvexit
);