2 * omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
5 * Author: Keshava Munegowda <keshava_mgowda@ti.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 of
9 * the License as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/slab.h>
23 #include <linux/spinlock.h>
24 #include <linux/platform_device.h>
25 #include <linux/clk.h>
27 #include <linux/err.h>
28 #include <linux/pm_runtime.h>
29 #include <linux/platform_data/usb-omap.h>
31 #define USBTLL_DRIVER_NAME "usbhs_tll"
33 /* TLL Register Set */
34 #define OMAP_USBTLL_REVISION (0x00)
35 #define OMAP_USBTLL_SYSCONFIG (0x10)
36 #define OMAP_USBTLL_SYSCONFIG_CACTIVITY (1 << 8)
37 #define OMAP_USBTLL_SYSCONFIG_SIDLEMODE (1 << 3)
38 #define OMAP_USBTLL_SYSCONFIG_ENAWAKEUP (1 << 2)
39 #define OMAP_USBTLL_SYSCONFIG_SOFTRESET (1 << 1)
40 #define OMAP_USBTLL_SYSCONFIG_AUTOIDLE (1 << 0)
42 #define OMAP_USBTLL_SYSSTATUS (0x14)
43 #define OMAP_USBTLL_SYSSTATUS_RESETDONE (1 << 0)
45 #define OMAP_USBTLL_IRQSTATUS (0x18)
46 #define OMAP_USBTLL_IRQENABLE (0x1C)
48 #define OMAP_TLL_SHARED_CONF (0x30)
49 #define OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN (1 << 6)
50 #define OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN (1 << 5)
51 #define OMAP_TLL_SHARED_CONF_USB_DIVRATION (1 << 2)
52 #define OMAP_TLL_SHARED_CONF_FCLK_REQ (1 << 1)
53 #define OMAP_TLL_SHARED_CONF_FCLK_IS_ON (1 << 0)
55 #define OMAP_TLL_CHANNEL_CONF(num) (0x040 + 0x004 * num)
56 #define OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT 24
57 #define OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF (1 << 11)
58 #define OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE (1 << 10)
59 #define OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE (1 << 9)
60 #define OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE (1 << 8)
61 #define OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS (1 << 1)
62 #define OMAP_TLL_CHANNEL_CONF_CHANEN (1 << 0)
64 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0 0x0
65 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM 0x1
66 #define OMAP_TLL_FSLSMODE_3PIN_PHY 0x2
67 #define OMAP_TLL_FSLSMODE_4PIN_PHY 0x3
68 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0 0x4
69 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM 0x5
70 #define OMAP_TLL_FSLSMODE_3PIN_TLL 0x6
71 #define OMAP_TLL_FSLSMODE_4PIN_TLL 0x7
72 #define OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0 0xA
73 #define OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM 0xB
75 #define OMAP_TLL_ULPI_FUNCTION_CTRL(num) (0x804 + 0x100 * num)
76 #define OMAP_TLL_ULPI_INTERFACE_CTRL(num) (0x807 + 0x100 * num)
77 #define OMAP_TLL_ULPI_OTG_CTRL(num) (0x80A + 0x100 * num)
78 #define OMAP_TLL_ULPI_INT_EN_RISE(num) (0x80D + 0x100 * num)
79 #define OMAP_TLL_ULPI_INT_EN_FALL(num) (0x810 + 0x100 * num)
80 #define OMAP_TLL_ULPI_INT_STATUS(num) (0x813 + 0x100 * num)
81 #define OMAP_TLL_ULPI_INT_LATCH(num) (0x814 + 0x100 * num)
82 #define OMAP_TLL_ULPI_DEBUG(num) (0x815 + 0x100 * num)
83 #define OMAP_TLL_ULPI_SCRATCH_REGISTER(num) (0x816 + 0x100 * num)
85 #define OMAP_REV2_TLL_CHANNEL_COUNT 2
86 #define OMAP_TLL_CHANNEL_COUNT 3
87 #define OMAP_TLL_CHANNEL_1_EN_MASK (1 << 0)
88 #define OMAP_TLL_CHANNEL_2_EN_MASK (1 << 1)
89 #define OMAP_TLL_CHANNEL_3_EN_MASK (1 << 2)
91 /* Values of USBTLL_REVISION - Note: these are not given in the TRM */
92 #define OMAP_USBTLL_REV1 0x00000015 /* OMAP3 */
93 #define OMAP_USBTLL_REV2 0x00000018 /* OMAP 3630 */
94 #define OMAP_USBTLL_REV3 0x00000004 /* OMAP4 */
96 #define is_ehci_tll_mode(x) (x == OMAP_EHCI_PORT_MODE_TLL)
99 int nch
; /* num. of channels */
100 struct usbhs_omap_platform_data
*pdata
;
102 /* secure the register updates */
106 /*-------------------------------------------------------------------------*/
108 const char usbtll_driver_name
[] = USBTLL_DRIVER_NAME
;
109 struct platform_device
*tll_pdev
;
111 /*-------------------------------------------------------------------------*/
113 static inline void usbtll_write(void __iomem
*base
, u32 reg
, u32 val
)
115 __raw_writel(val
, base
+ reg
);
118 static inline u32
usbtll_read(void __iomem
*base
, u32 reg
)
120 return __raw_readl(base
+ reg
);
123 static inline void usbtll_writeb(void __iomem
*base
, u8 reg
, u8 val
)
125 __raw_writeb(val
, base
+ reg
);
128 static inline u8
usbtll_readb(void __iomem
*base
, u8 reg
)
130 return __raw_readb(base
+ reg
);
133 /*-------------------------------------------------------------------------*/
135 static bool is_ohci_port(enum usbhs_omap_port_mode pmode
)
138 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0
:
139 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM
:
140 case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0
:
141 case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM
:
142 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0
:
143 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM
:
144 case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0
:
145 case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM
:
146 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0
:
147 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM
:
156 * convert the port-mode enum to a value we can use in the FSLSMODE
157 * field of USBTLL_CHANNEL_CONF
159 static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode
)
162 case OMAP_USBHS_PORT_MODE_UNUSED
:
163 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0
:
164 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0
;
166 case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM
:
167 return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM
;
169 case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0
:
170 return OMAP_TLL_FSLSMODE_3PIN_PHY
;
172 case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM
:
173 return OMAP_TLL_FSLSMODE_4PIN_PHY
;
175 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0
:
176 return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0
;
178 case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM
:
179 return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM
;
181 case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0
:
182 return OMAP_TLL_FSLSMODE_3PIN_TLL
;
184 case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM
:
185 return OMAP_TLL_FSLSMODE_4PIN_TLL
;
187 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0
:
188 return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0
;
190 case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM
:
191 return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM
;
193 pr_warn("Invalid port mode, using default\n");
194 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0
;
199 * usbtll_omap_probe - initialize TI-based HCDs
201 * Allocates basic resources for this USB host controller.
203 static int usbtll_omap_probe(struct platform_device
*pdev
)
205 struct device
*dev
= &pdev
->dev
;
206 struct usbhs_omap_platform_data
*pdata
= dev
->platform_data
;
208 struct resource
*res
;
209 struct usbtll_omap
*tll
;
215 dev_dbg(dev
, "starting TI HSUSB TLL Controller\n");
217 tll
= devm_kzalloc(dev
, sizeof(struct usbtll_omap
), GFP_KERNEL
);
219 dev_err(dev
, "Memory allocation failed\n");
223 spin_lock_init(&tll
->lock
);
227 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
228 base
= devm_request_and_ioremap(dev
, res
);
230 ret
= -EADDRNOTAVAIL
;
231 dev_err(dev
, "Resource request/ioremap failed:%d\n", ret
);
235 platform_set_drvdata(pdev
, tll
);
236 pm_runtime_enable(dev
);
237 pm_runtime_get_sync(dev
);
239 spin_lock_irqsave(&tll
->lock
, flags
);
241 ver
= usbtll_read(base
, OMAP_USBTLL_REVISION
);
243 case OMAP_USBTLL_REV1
:
244 tll
->nch
= OMAP_TLL_CHANNEL_COUNT
;
246 case OMAP_USBTLL_REV2
:
247 case OMAP_USBTLL_REV3
:
248 tll
->nch
= OMAP_REV2_TLL_CHANNEL_COUNT
;
251 tll
->nch
= OMAP_TLL_CHANNEL_COUNT
;
253 "USB TLL Rev : 0x%x not recognized, assuming %d channels\n",
258 spin_unlock_irqrestore(&tll
->lock
, flags
);
260 tll
->ch_clk
= devm_kzalloc(dev
, sizeof(struct clk
* [tll
->nch
]),
264 dev_err(dev
, "Couldn't allocate memory for channel clocks\n");
268 for (i
= 0; i
< tll
->nch
; i
++) {
269 char clkname
[] = "usb_tll_hs_usb_chx_clk";
271 snprintf(clkname
, sizeof(clkname
),
272 "usb_tll_hs_usb_ch%d_clk", i
);
273 tll
->ch_clk
[i
] = clk_get(dev
, clkname
);
275 if (IS_ERR(tll
->ch_clk
[i
]))
276 dev_dbg(dev
, "can't get clock : %s\n", clkname
);
279 spin_lock_irqsave(&tll
->lock
, flags
);
281 if (is_ehci_tll_mode(pdata
->port_mode
[0]) ||
282 is_ehci_tll_mode(pdata
->port_mode
[1]) ||
283 is_ehci_tll_mode(pdata
->port_mode
[2]) ||
284 is_ohci_port(pdata
->port_mode
[0]) ||
285 is_ohci_port(pdata
->port_mode
[1]) ||
286 is_ohci_port(pdata
->port_mode
[2])) {
288 /* Program Common TLL register */
289 reg
= usbtll_read(base
, OMAP_TLL_SHARED_CONF
);
290 reg
|= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
291 | OMAP_TLL_SHARED_CONF_USB_DIVRATION
);
292 reg
&= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN
;
293 reg
&= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN
;
295 usbtll_write(base
, OMAP_TLL_SHARED_CONF
, reg
);
297 /* Enable channels now */
298 for (i
= 0; i
< tll
->nch
; i
++) {
299 reg
= usbtll_read(base
, OMAP_TLL_CHANNEL_CONF(i
));
301 if (is_ohci_port(pdata
->port_mode
[i
])) {
302 reg
|= ohci_omap3_fslsmode(pdata
->port_mode
[i
])
303 << OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT
;
304 reg
|= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS
;
305 } else if (pdata
->port_mode
[i
] ==
306 OMAP_EHCI_PORT_MODE_TLL
) {
308 * Disable AutoIdle, BitStuffing
311 reg
&= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
312 | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
313 | OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE
);
317 reg
|= OMAP_TLL_CHANNEL_CONF_CHANEN
;
318 usbtll_write(base
, OMAP_TLL_CHANNEL_CONF(i
), reg
);
321 OMAP_TLL_ULPI_SCRATCH_REGISTER(i
),
326 spin_unlock_irqrestore(&tll
->lock
, flags
);
327 pm_runtime_put_sync(dev
);
333 pm_runtime_put_sync(dev
);
334 pm_runtime_disable(dev
);
340 * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
341 * @pdev: USB Host Controller being removed
343 * Reverses the effect of usbtll_omap_probe().
345 static int usbtll_omap_remove(struct platform_device
*pdev
)
347 struct usbtll_omap
*tll
= platform_get_drvdata(pdev
);
350 for (i
= 0; i
< tll
->nch
; i
++)
351 if (!IS_ERR(tll
->ch_clk
[i
]))
352 clk_put(tll
->ch_clk
[i
]);
354 pm_runtime_disable(&pdev
->dev
);
358 static int usbtll_runtime_resume(struct device
*dev
)
360 struct usbtll_omap
*tll
= dev_get_drvdata(dev
);
361 struct usbhs_omap_platform_data
*pdata
= tll
->pdata
;
365 dev_dbg(dev
, "usbtll_runtime_resume\n");
368 dev_dbg(dev
, "missing platform_data\n");
372 spin_lock_irqsave(&tll
->lock
, flags
);
374 for (i
= 0; i
< tll
->nch
; i
++) {
375 if (is_ehci_tll_mode(pdata
->port_mode
[i
])) {
378 if (IS_ERR(tll
->ch_clk
[i
]))
381 r
= clk_enable(tll
->ch_clk
[i
]);
384 "Error enabling ch %d clock: %d\n", i
, r
);
389 spin_unlock_irqrestore(&tll
->lock
, flags
);
394 static int usbtll_runtime_suspend(struct device
*dev
)
396 struct usbtll_omap
*tll
= dev_get_drvdata(dev
);
397 struct usbhs_omap_platform_data
*pdata
= tll
->pdata
;
401 dev_dbg(dev
, "usbtll_runtime_suspend\n");
404 dev_dbg(dev
, "missing platform_data\n");
408 spin_lock_irqsave(&tll
->lock
, flags
);
410 for (i
= 0; i
< tll
->nch
; i
++) {
411 if (is_ehci_tll_mode(pdata
->port_mode
[i
])) {
412 if (!IS_ERR(tll
->ch_clk
[i
]))
413 clk_disable(tll
->ch_clk
[i
]);
417 spin_unlock_irqrestore(&tll
->lock
, flags
);
422 static const struct dev_pm_ops usbtllomap_dev_pm_ops
= {
423 SET_RUNTIME_PM_OPS(usbtll_runtime_suspend
,
424 usbtll_runtime_resume
,
428 static struct platform_driver usbtll_omap_driver
= {
430 .name
= (char *)usbtll_driver_name
,
431 .owner
= THIS_MODULE
,
432 .pm
= &usbtllomap_dev_pm_ops
,
434 .probe
= usbtll_omap_probe
,
435 .remove
= usbtll_omap_remove
,
438 int omap_tll_enable(void)
441 pr_err("missing omap usbhs tll platform_data\n");
444 return pm_runtime_get_sync(&tll_pdev
->dev
);
446 EXPORT_SYMBOL_GPL(omap_tll_enable
);
448 int omap_tll_disable(void)
451 pr_err("missing omap usbhs tll platform_data\n");
454 return pm_runtime_put_sync(&tll_pdev
->dev
);
456 EXPORT_SYMBOL_GPL(omap_tll_disable
);
458 MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
459 MODULE_ALIAS("platform:" USBHS_DRIVER_NAME
);
460 MODULE_LICENSE("GPL v2");
461 MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
463 static int __init
omap_usbtll_drvinit(void)
465 return platform_driver_register(&usbtll_omap_driver
);
469 * init before usbhs core driver;
470 * The usbtll driver should be initialized before
471 * the usbhs core driver probe function is called.
473 fs_initcall(omap_usbtll_drvinit
);
475 static void __exit
omap_usbtll_drvexit(void)
477 platform_driver_unregister(&usbtll_omap_driver
);
479 module_exit(omap_usbtll_drvexit
);