2 * OHCI HCD (Host Controller Driver) for USB.
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2005 David Brownell
6 * (C) Copyright 2002 Hewlett-Packard Company
10 * Modified for OMAP by Tony Lindgren <tony@atomide.com>
11 * Based on the 2.4 OMAP OHCI driver originally done by MontaVista Software Inc.
12 * and on ohci-sa1111.c by Christopher Hoover <ch@hpl.hp.com>
14 * This file is licenced under the GPL.
17 #include <linux/signal.h>
18 #include <linux/jiffies.h>
19 #include <linux/platform_device.h>
20 #include <linux/clk.h>
21 #include <linux/gpio.h>
24 #include <asm/mach-types.h>
27 #include <plat/fpga.h>
29 #include <mach/hardware.h>
30 #include <mach/irqs.h>
34 /* OMAP-1510 OHCI has its own MMU for DMA */
35 #define OMAP1510_LB_MEMSIZE 32 /* Should be same as SDRAM size */
36 #define OMAP1510_LB_CLOCK_DIV 0xfffec10c
37 #define OMAP1510_LB_MMU_CTL 0xfffec208
38 #define OMAP1510_LB_MMU_LCK 0xfffec224
39 #define OMAP1510_LB_MMU_LD_TLB 0xfffec228
40 #define OMAP1510_LB_MMU_CAM_H 0xfffec22c
41 #define OMAP1510_LB_MMU_CAM_L 0xfffec230
42 #define OMAP1510_LB_MMU_RAM_H 0xfffec234
43 #define OMAP1510_LB_MMU_RAM_L 0xfffec238
46 #ifndef CONFIG_ARCH_OMAP
47 #error "This file is OMAP bus glue. CONFIG_OMAP must be defined."
50 #ifdef CONFIG_TPS65010
51 #include <linux/i2c/tps65010.h>
59 static inline int tps65010_set_gpio_out_value(unsigned gpio, unsigned value)
66 extern int usb_disabled(void);
67 extern int ocpi_enable(void);
69 static struct clk *usb_host_ck;
70 static struct clk *usb_dc_ck;
71 static int host_enabled;
72 static int host_initialized;
74 static void omap_ohci_clock_power(int on)
77 clk_enable(usb_dc_ck);
78 clk_enable(usb_host_ck);
79 /* guesstimate for T5 == 1x 32K clock + APLL lock time */
82 clk_disable(usb_host_ck);
83 clk_disable(usb_dc_ck);
88 * Board specific gang-switched transceiver power on/off.
89 * NOTE: OSK supplies power from DC, not battery.
91 static int omap_ohci_transceiver_power(int on)
94 if (machine_is_omap_innovator() && cpu_is_omap1510())
95 fpga_write(fpga_read(INNOVATOR_FPGA_CAM_USB_CONTROL)
96 | ((1 << 5/*usb1*/) | (1 << 3/*usb2*/)),
97 INNOVATOR_FPGA_CAM_USB_CONTROL);
98 else if (machine_is_omap_osk())
99 tps65010_set_gpio_out_value(GPIO1, LOW);
101 if (machine_is_omap_innovator() && cpu_is_omap1510())
102 fpga_write(fpga_read(INNOVATOR_FPGA_CAM_USB_CONTROL)
103 & ~((1 << 5/*usb1*/) | (1 << 3/*usb2*/)),
104 INNOVATOR_FPGA_CAM_USB_CONTROL);
105 else if (machine_is_omap_osk())
106 tps65010_set_gpio_out_value(GPIO1, HIGH);
112 #ifdef CONFIG_ARCH_OMAP15XX
114 * OMAP-1510 specific Local Bus clock on/off
116 static int omap_1510_local_bus_power(int on)
119 omap_writel((1 << 1) | (1 << 0), OMAP1510_LB_MMU_CTL);
122 omap_writel(0, OMAP1510_LB_MMU_CTL);
129 * OMAP-1510 specific Local Bus initialization
130 * NOTE: This assumes 32MB memory size in OMAP1510LB_MEMSIZE.
131 * See also arch/mach-omap/memory.h for __virt_to_dma() and
132 * __dma_to_virt() which need to match with the physical
133 * Local Bus address below.
135 static int omap_1510_local_bus_init(void)
138 unsigned long lbaddr, physaddr;
140 omap_writel((omap_readl(OMAP1510_LB_CLOCK_DIV) & 0xfffffff8) | 0x4,
141 OMAP1510_LB_CLOCK_DIV);
143 /* Configure the Local Bus MMU table */
144 for (tlb = 0; tlb < OMAP1510_LB_MEMSIZE; tlb++) {
145 lbaddr = tlb * 0x00100000 + OMAP1510_LB_OFFSET;
146 physaddr = tlb * 0x00100000 + PHYS_OFFSET;
147 omap_writel((lbaddr & 0x0fffffff) >> 22, OMAP1510_LB_MMU_CAM_H);
148 omap_writel(((lbaddr & 0x003ffc00) >> 6) | 0xc,
149 OMAP1510_LB_MMU_CAM_L);
150 omap_writel(physaddr >> 16, OMAP1510_LB_MMU_RAM_H);
151 omap_writel((physaddr & 0x0000fc00) | 0x300, OMAP1510_LB_MMU_RAM_L);
152 omap_writel(tlb << 4, OMAP1510_LB_MMU_LCK);
153 omap_writel(0x1, OMAP1510_LB_MMU_LD_TLB);
156 /* Enable the walking table */
157 omap_writel(omap_readl(OMAP1510_LB_MMU_CTL) | (1 << 3), OMAP1510_LB_MMU_CTL);
163 #define omap_1510_local_bus_power(x) {}
164 #define omap_1510_local_bus_init() {}
167 #ifdef CONFIG_USB_OTG
169 static void start_hnp(struct ohci_hcd *ohci)
171 const unsigned port = ohci_to_hcd(ohci)->self.otg_port - 1;
175 otg_start_hnp(ohci->transceiver->otg);
177 local_irq_save(flags);
178 ohci->transceiver->state = OTG_STATE_A_SUSPEND;
179 writel (RH_PS_PSS, &ohci->regs->roothub.portstatus [port]);
180 l = omap_readl(OTG_CTRL);
182 omap_writel(l, OTG_CTRL);
183 local_irq_restore(flags);
188 /*-------------------------------------------------------------------------*/
190 static int ohci_omap_init(struct usb_hcd *hcd)
192 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
193 struct omap_usb_config *config = hcd->self.controller->platform_data;
194 int need_transceiver = (config->otg != 0);
197 dev_dbg(hcd->self.controller, "starting USB Controller\n");
200 ohci_to_hcd(ohci)->self.otg_port = config->otg;
201 /* default/minimum OTG power budget: 8 mA */
202 ohci_to_hcd(ohci)->power_budget = 8;
205 /* boards can use OTG transceivers in non-OTG modes */
206 need_transceiver = need_transceiver
207 || machine_is_omap_h2() || machine_is_omap_h3();
209 /* XXX OMAP16xx only */
210 if (config->ocpi_enable)
211 config->ocpi_enable();
213 #ifdef CONFIG_USB_OTG
214 if (need_transceiver) {
215 ohci->transceiver = usb_get_transceiver();
216 if (ohci->transceiver) {
217 int status = otg_set_host(ohci->transceiver->otg,
218 &ohci_to_hcd(ohci)->self);
219 dev_dbg(hcd->self.controller, "init %s transceiver, status %d\n",
220 ohci->transceiver->label, status);
222 usb_put_transceiver(ohci->transceiver);
226 dev_err(hcd->self.controller, "can't find transceiver\n");
229 ohci->start_hnp = start_hnp;
233 omap_ohci_clock_power(1);
235 if (cpu_is_omap15xx()) {
236 omap_1510_local_bus_power(1);
237 omap_1510_local_bus_init();
240 if ((ret = ohci_init(ohci)) < 0)
243 /* board-specific power switching and overcurrent support */
244 if (machine_is_omap_osk() || machine_is_omap_innovator()) {
245 u32 rh = roothub_a (ohci);
247 /* power switching (ganged by default) */
250 /* TPS2045 switch for internal transceiver (port 1) */
251 if (machine_is_omap_osk()) {
252 ohci_to_hcd(ohci)->power_budget = 250;
256 /* gpio9 for overcurrent detction */
257 omap_cfg_reg(W8_1610_GPIO9);
258 gpio_request(9, "OHCI overcurrent");
259 gpio_direction_input(9);
261 /* for paranoia's sake: disable USB.PUEN */
262 omap_cfg_reg(W4_USB_HIGHZ);
264 ohci_writel(ohci, rh, &ohci->regs->roothub.a);
265 ohci->flags &= ~OHCI_QUIRK_HUB_POWER;
266 } else if (machine_is_nokia770()) {
267 /* We require a self-powered hub, which should have
268 * plenty of power. */
269 ohci_to_hcd(ohci)->power_budget = 0;
272 /* FIXME khubd hub requests should manage power switching */
273 omap_ohci_transceiver_power(1);
275 /* board init will have already handled HMC and mux setup.
276 * any external transceiver should already be initialized
277 * too, so all configured ports use the right signaling now.
283 static void ohci_omap_stop(struct usb_hcd *hcd)
285 dev_dbg(hcd->self.controller, "stopping USB Controller\n");
287 omap_ohci_clock_power(0);
291 /*-------------------------------------------------------------------------*/
294 * usb_hcd_omap_probe - initialize OMAP-based HCDs
295 * Context: !in_interrupt()
297 * Allocates basic resources for this USB host controller, and
298 * then invokes the start() method for the HCD associated with it
299 * through the hotplug entry's driver_data.
301 static int usb_hcd_omap_probe (const struct hc_driver *driver,
302 struct platform_device *pdev)
305 struct usb_hcd *hcd = 0;
306 struct ohci_hcd *ohci;
308 if (pdev->num_resources != 2) {
309 printk(KERN_ERR "hcd probe: invalid num_resources: %i\n",
310 pdev->num_resources);
314 if (pdev->resource[0].flags != IORESOURCE_MEM
315 || pdev->resource[1].flags != IORESOURCE_IRQ) {
316 printk(KERN_ERR "hcd probe: invalid resource type\n");
320 usb_host_ck = clk_get(&pdev->dev, "usb_hhc_ck");
321 if (IS_ERR(usb_host_ck))
322 return PTR_ERR(usb_host_ck);
324 if (!cpu_is_omap15xx())
325 usb_dc_ck = clk_get(&pdev->dev, "usb_dc_ck");
327 usb_dc_ck = clk_get(&pdev->dev, "lb_ck");
329 if (IS_ERR(usb_dc_ck)) {
330 clk_put(usb_host_ck);
331 return PTR_ERR(usb_dc_ck);
335 hcd = usb_create_hcd (driver, &pdev->dev, dev_name(&pdev->dev));
340 hcd->rsrc_start = pdev->resource[0].start;
341 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
343 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
344 dev_dbg(&pdev->dev, "request_mem_region failed\n");
349 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
351 dev_err(&pdev->dev, "can't ioremap OHCI HCD\n");
356 ohci = hcd_to_ohci(hcd);
359 host_initialized = 0;
362 irq = platform_get_irq(pdev, 0);
367 retval = usb_add_hcd(hcd, irq, 0);
371 host_initialized = 1;
374 omap_ohci_clock_power(0);
380 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
385 clk_put(usb_host_ck);
390 /* may be called with controller, bus, and devices active */
393 * usb_hcd_omap_remove - shutdown processing for OMAP-based HCDs
394 * @dev: USB Host Controller being removed
395 * Context: !in_interrupt()
397 * Reverses the effect of usb_hcd_omap_probe(), first invoking
398 * the HCD's stop() method. It is always called from a thread
399 * context, normally "rmmod", "apmd", or something similar.
402 usb_hcd_omap_remove (struct usb_hcd *hcd, struct platform_device *pdev)
404 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
407 if (ohci->transceiver) {
408 (void) otg_set_host(ohci->transceiver->otg, 0);
409 usb_put_transceiver(ohci->transceiver);
411 if (machine_is_omap_osk())
414 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
417 clk_put(usb_host_ck);
420 /*-------------------------------------------------------------------------*/
423 ohci_omap_start (struct usb_hcd *hcd)
425 struct omap_usb_config *config;
426 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
431 config = hcd->self.controller->platform_data;
432 if (config->otg || config->rwc) {
433 ohci->hc_control = OHCI_CTRL_RWC;
434 writel(OHCI_CTRL_RWC, &ohci->regs->control);
437 if ((ret = ohci_run (ohci)) < 0) {
438 dev_err(hcd->self.controller, "can't start\n");
445 /*-------------------------------------------------------------------------*/
447 static const struct hc_driver ohci_omap_hc_driver = {
448 .description = hcd_name,
449 .product_desc = "OMAP OHCI",
450 .hcd_priv_size = sizeof(struct ohci_hcd),
453 * generic hardware linkage
456 .flags = HCD_USB11 | HCD_MEMORY,
459 * basic lifecycle operations
461 .reset = ohci_omap_init,
462 .start = ohci_omap_start,
463 .stop = ohci_omap_stop,
464 .shutdown = ohci_shutdown,
467 * managing i/o requests and associated device resources
469 .urb_enqueue = ohci_urb_enqueue,
470 .urb_dequeue = ohci_urb_dequeue,
471 .endpoint_disable = ohci_endpoint_disable,
476 .get_frame_number = ohci_get_frame,
481 .hub_status_data = ohci_hub_status_data,
482 .hub_control = ohci_hub_control,
484 .bus_suspend = ohci_bus_suspend,
485 .bus_resume = ohci_bus_resume,
487 .start_port_reset = ohci_start_port_reset,
490 /*-------------------------------------------------------------------------*/
492 static int ohci_hcd_omap_drv_probe(struct platform_device *dev)
494 return usb_hcd_omap_probe(&ohci_omap_hc_driver, dev);
497 static int ohci_hcd_omap_drv_remove(struct platform_device *dev)
499 struct usb_hcd *hcd = platform_get_drvdata(dev);
501 usb_hcd_omap_remove(hcd, dev);
502 platform_set_drvdata(dev, NULL);
507 /*-------------------------------------------------------------------------*/
511 static int ohci_omap_suspend(struct platform_device *dev, pm_message_t message)
513 struct ohci_hcd *ohci = hcd_to_ohci(platform_get_drvdata(dev));
515 if (time_before(jiffies, ohci->next_statechange))
517 ohci->next_statechange = jiffies;
519 omap_ohci_clock_power(0);
523 static int ohci_omap_resume(struct platform_device *dev)
525 struct usb_hcd *hcd = platform_get_drvdata(dev);
526 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
528 if (time_before(jiffies, ohci->next_statechange))
530 ohci->next_statechange = jiffies;
532 omap_ohci_clock_power(1);
533 ohci_finish_controller_resume(hcd);
539 /*-------------------------------------------------------------------------*/
542 * Driver definition to register with the OMAP bus
544 static struct platform_driver ohci_hcd_omap_driver = {
545 .probe = ohci_hcd_omap_drv_probe,
546 .remove = ohci_hcd_omap_drv_remove,
547 .shutdown = usb_hcd_platform_shutdown,
549 .suspend = ohci_omap_suspend,
550 .resume = ohci_omap_resume,
553 .owner = THIS_MODULE,
558 MODULE_ALIAS("platform:ohci");