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> /* SA_INTERRUPT */
18 #include <linux/jiffies.h>
20 #include <asm/hardware.h>
22 #include <asm/mach-types.h>
24 #include <asm/arch/mux.h>
25 #include <asm/arch/irqs.h>
26 #include <asm/arch/gpio.h>
27 #include <asm/arch/fpga.h>
28 #include <asm/arch/usb.h>
29 #include <asm/hardware/clock.h>
32 /* OMAP-1510 OHCI has its own MMU for DMA */
33 #define OMAP1510_LB_MEMSIZE 32 /* Should be same as SDRAM size */
34 #define OMAP1510_LB_CLOCK_DIV 0xfffec10c
35 #define OMAP1510_LB_MMU_CTL 0xfffec208
36 #define OMAP1510_LB_MMU_LCK 0xfffec224
37 #define OMAP1510_LB_MMU_LD_TLB 0xfffec228
38 #define OMAP1510_LB_MMU_CAM_H 0xfffec22c
39 #define OMAP1510_LB_MMU_CAM_L 0xfffec230
40 #define OMAP1510_LB_MMU_RAM_H 0xfffec234
41 #define OMAP1510_LB_MMU_RAM_L 0xfffec238
44 #ifndef CONFIG_ARCH_OMAP
45 #error "This file is OMAP bus glue. CONFIG_OMAP must be defined."
48 #ifdef CONFIG_TPS65010
49 #include <asm/arch/tps65010.h>
57 static inline int tps65010_set_gpio_out_value(unsigned gpio, unsigned value)
64 extern int usb_disabled(void);
65 extern int ocpi_enable(void);
67 static struct clk *usb_host_ck;
69 static void omap_ohci_clock_power(int on)
72 clk_enable(usb_host_ck);
73 /* guesstimate for T5 == 1x 32K clock + APLL lock time */
76 clk_disable(usb_host_ck);
81 * Board specific gang-switched transceiver power on/off.
82 * NOTE: OSK supplies power from DC, not battery.
84 static int omap_ohci_transceiver_power(int on)
87 if (machine_is_omap_innovator() && cpu_is_omap1510())
88 fpga_write(fpga_read(INNOVATOR_FPGA_CAM_USB_CONTROL)
89 | ((1 << 5/*usb1*/) | (1 << 3/*usb2*/)),
90 INNOVATOR_FPGA_CAM_USB_CONTROL);
91 else if (machine_is_omap_osk())
92 tps65010_set_gpio_out_value(GPIO1, LOW);
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, HIGH);
106 * OMAP-1510 specific Local Bus clock on/off
108 static int omap_1510_local_bus_power(int on)
111 omap_writel((1 << 1) | (1 << 0), OMAP1510_LB_MMU_CTL);
114 omap_writel(0, OMAP1510_LB_MMU_CTL);
121 * OMAP-1510 specific Local Bus initialization
122 * NOTE: This assumes 32MB memory size in OMAP1510LB_MEMSIZE.
123 * See also arch/mach-omap/memory.h for __virt_to_dma() and
124 * __dma_to_virt() which need to match with the physical
125 * Local Bus address below.
127 static int omap_1510_local_bus_init(void)
130 unsigned long lbaddr, physaddr;
132 omap_writel((omap_readl(OMAP1510_LB_CLOCK_DIV) & 0xfffffff8) | 0x4,
133 OMAP1510_LB_CLOCK_DIV);
135 /* Configure the Local Bus MMU table */
136 for (tlb = 0; tlb < OMAP1510_LB_MEMSIZE; tlb++) {
137 lbaddr = tlb * 0x00100000 + OMAP1510_LB_OFFSET;
138 physaddr = tlb * 0x00100000 + PHYS_OFFSET;
139 omap_writel((lbaddr & 0x0fffffff) >> 22, OMAP1510_LB_MMU_CAM_H);
140 omap_writel(((lbaddr & 0x003ffc00) >> 6) | 0xc,
141 OMAP1510_LB_MMU_CAM_L);
142 omap_writel(physaddr >> 16, OMAP1510_LB_MMU_RAM_H);
143 omap_writel((physaddr & 0x0000fc00) | 0x300, OMAP1510_LB_MMU_RAM_L);
144 omap_writel(tlb << 4, OMAP1510_LB_MMU_LCK);
145 omap_writel(0x1, OMAP1510_LB_MMU_LD_TLB);
148 /* Enable the walking table */
149 omap_writel(omap_readl(OMAP1510_LB_MMU_CTL) | (1 << 3), OMAP1510_LB_MMU_CTL);
155 #ifdef CONFIG_USB_OTG
157 static void start_hnp(struct ohci_hcd *ohci)
159 const unsigned port = ohci_to_hcd(ohci)->self.otg_port - 1;
162 otg_start_hnp(ohci->transceiver);
164 local_irq_save(flags);
165 ohci->transceiver->state = OTG_STATE_A_SUSPEND;
166 writel (RH_PS_PSS, &ohci->regs->roothub.portstatus [port]);
167 OTG_CTRL_REG &= ~OTG_A_BUSREQ;
168 local_irq_restore(flags);
173 /*-------------------------------------------------------------------------*/
175 static int omap_start_hc(struct ohci_hcd *ohci, struct platform_device *pdev)
177 struct omap_usb_config *config = pdev->dev.platform_data;
178 int need_transceiver = (config->otg != 0);
181 dev_dbg(&pdev->dev, "starting USB Controller\n");
184 ohci_to_hcd(ohci)->self.otg_port = config->otg;
185 /* default/minimum OTG power budget: 8 mA */
186 ohci_to_hcd(ohci)->power_budget = 8;
189 /* boards can use OTG transceivers in non-OTG modes */
190 need_transceiver = need_transceiver
191 || machine_is_omap_h2() || machine_is_omap_h3();
193 if (cpu_is_omap16xx())
196 #ifdef CONFIG_ARCH_OMAP_OTG
197 if (need_transceiver) {
198 ohci->transceiver = otg_get_transceiver();
199 if (ohci->transceiver) {
200 int status = otg_set_host(ohci->transceiver,
201 &ohci_to_hcd(ohci)->self);
202 dev_dbg(&pdev->dev, "init %s transceiver, status %d\n",
203 ohci->transceiver->label, status);
205 if (ohci->transceiver)
206 put_device(ohci->transceiver->dev);
210 dev_err(&pdev->dev, "can't find transceiver\n");
216 omap_ohci_clock_power(1);
218 if (cpu_is_omap1510()) {
219 omap_1510_local_bus_power(1);
220 omap_1510_local_bus_init();
223 if ((ret = ohci_init(ohci)) < 0)
226 /* board-specific power switching and overcurrent support */
227 if (machine_is_omap_osk() || machine_is_omap_innovator()) {
228 u32 rh = roothub_a (ohci);
230 /* power switching (ganged by default) */
233 /* TPS2045 switch for internal transceiver (port 1) */
234 if (machine_is_omap_osk()) {
235 ohci_to_hcd(ohci)->power_budget = 250;
239 /* gpio9 for overcurrent detction */
240 omap_cfg_reg(W8_1610_GPIO9);
241 omap_request_gpio(9);
242 omap_set_gpio_direction(9, 1 /* IN */);
244 /* for paranoia's sake: disable USB.PUEN */
245 omap_cfg_reg(W4_USB_HIGHZ);
247 ohci_writel(ohci, rh, &ohci->regs->roothub.a);
248 distrust_firmware = 0;
251 /* FIXME khubd hub requests should manage power switching */
252 omap_ohci_transceiver_power(1);
254 /* board init will have already handled HMC and mux setup.
255 * any external transceiver should already be initialized
256 * too, so all configured ports use the right signaling now.
262 static void omap_stop_hc(struct platform_device *pdev)
264 dev_dbg(&pdev->dev, "stopping USB Controller\n");
265 omap_ohci_clock_power(0);
269 /*-------------------------------------------------------------------------*/
271 void usb_hcd_omap_remove (struct usb_hcd *, struct platform_device *);
273 /* configure so an HC device and id are always provided */
274 /* always called with process context; sleeping is OK */
278 * usb_hcd_omap_probe - initialize OMAP-based HCDs
279 * Context: !in_interrupt()
281 * Allocates basic resources for this USB host controller, and
282 * then invokes the start() method for the HCD associated with it
283 * through the hotplug entry's driver_data.
285 int usb_hcd_omap_probe (const struct hc_driver *driver,
286 struct platform_device *pdev)
289 struct usb_hcd *hcd = 0;
290 struct ohci_hcd *ohci;
292 if (pdev->num_resources != 2) {
293 printk(KERN_ERR "hcd probe: invalid num_resources: %i\n",
294 pdev->num_resources);
298 if (pdev->resource[0].flags != IORESOURCE_MEM
299 || pdev->resource[1].flags != IORESOURCE_IRQ) {
300 printk(KERN_ERR "hcd probe: invalid resource type\n");
304 usb_host_ck = clk_get(0, "usb_hhc_ck");
305 if (IS_ERR(usb_host_ck))
306 return PTR_ERR(usb_host_ck);
308 hcd = usb_create_hcd (driver, &pdev->dev, pdev->dev.bus_id);
313 hcd->rsrc_start = pdev->resource[0].start;
314 hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
316 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
317 dev_dbg(&pdev->dev, "request_mem_region failed\n");
322 hcd->regs = (void __iomem *) (int) IO_ADDRESS(hcd->rsrc_start);
324 ohci = hcd_to_ohci(hcd);
327 retval = omap_start_hc(ohci, pdev);
331 retval = usb_add_hcd(hcd, platform_get_irq(pdev, 0), SA_INTERRUPT);
337 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
341 clk_put(usb_host_ck);
346 /* may be called with controller, bus, and devices active */
349 * usb_hcd_omap_remove - shutdown processing for OMAP-based HCDs
350 * @dev: USB Host Controller being removed
351 * Context: !in_interrupt()
353 * Reverses the effect of usb_hcd_omap_probe(), first invoking
354 * the HCD's stop() method. It is always called from a thread
355 * context, normally "rmmod", "apmd", or something similar.
358 void usb_hcd_omap_remove (struct usb_hcd *hcd, struct platform_device *pdev)
361 if (machine_is_omap_osk())
364 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
366 clk_put(usb_host_ck);
369 /*-------------------------------------------------------------------------*/
372 ohci_omap_start (struct usb_hcd *hcd)
374 struct omap_usb_config *config;
375 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
378 config = hcd->self.controller->platform_data;
379 if (config->otg || config->rwc)
380 writel(OHCI_CTRL_RWC, &ohci->regs->control);
382 if ((ret = ohci_run (ohci)) < 0) {
383 dev_err(hcd->self.controller, "can't start\n");
390 /*-------------------------------------------------------------------------*/
392 static const struct hc_driver ohci_omap_hc_driver = {
393 .description = hcd_name,
394 .product_desc = "OMAP OHCI",
395 .hcd_priv_size = sizeof(struct ohci_hcd),
398 * generic hardware linkage
401 .flags = HCD_USB11 | HCD_MEMORY,
404 * basic lifecycle operations
406 .start = ohci_omap_start,
410 * managing i/o requests and associated device resources
412 .urb_enqueue = ohci_urb_enqueue,
413 .urb_dequeue = ohci_urb_dequeue,
414 .endpoint_disable = ohci_endpoint_disable,
419 .get_frame_number = ohci_get_frame,
424 .hub_status_data = ohci_hub_status_data,
425 .hub_control = ohci_hub_control,
427 .bus_suspend = ohci_bus_suspend,
428 .bus_resume = ohci_bus_resume,
430 .start_port_reset = ohci_start_port_reset,
433 /*-------------------------------------------------------------------------*/
435 static int ohci_hcd_omap_drv_probe(struct device *dev)
437 return usb_hcd_omap_probe(&ohci_omap_hc_driver,
438 to_platform_device(dev));
441 static int ohci_hcd_omap_drv_remove(struct device *dev)
443 struct platform_device *pdev = to_platform_device(dev);
444 struct usb_hcd *hcd = dev_get_drvdata(dev);
445 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
447 usb_hcd_omap_remove(hcd, pdev);
448 if (ohci->transceiver) {
449 (void) otg_set_host(ohci->transceiver, 0);
450 put_device(ohci->transceiver->dev);
452 dev_set_drvdata(dev, NULL);
457 /*-------------------------------------------------------------------------*/
461 static int ohci_omap_suspend(struct device *dev, pm_message_t message)
463 struct ohci_hcd *ohci = hcd_to_ohci(dev_get_drvdata(dev));
465 if (time_before(jiffies, ohci->next_statechange))
467 ohci->next_statechange = jiffies;
469 omap_ohci_clock_power(0);
470 ohci_to_hcd(ohci)->state = HC_STATE_SUSPENDED;
471 dev->power.power_state = PMSG_SUSPEND;
475 static int ohci_omap_resume(struct device *dev)
477 struct ohci_hcd *ohci = hcd_to_ohci(dev_get_drvdata(dev));
479 if (time_before(jiffies, ohci->next_statechange))
481 ohci->next_statechange = jiffies;
483 omap_ohci_clock_power(1);
484 dev->power.power_state = PMSG_ON;
485 usb_hcd_resume_root_hub(dev_get_drvdata(dev));
491 /*-------------------------------------------------------------------------*/
494 * Driver definition to register with the OMAP bus
496 static struct device_driver ohci_hcd_omap_driver = {
498 .owner = THIS_MODULE,
499 .bus = &platform_bus_type,
500 .probe = ohci_hcd_omap_drv_probe,
501 .remove = ohci_hcd_omap_drv_remove,
503 .suspend = ohci_omap_suspend,
504 .resume = ohci_omap_resume,
508 static int __init ohci_hcd_omap_init (void)
510 printk (KERN_DEBUG "%s: " DRIVER_INFO " (OMAP)\n", hcd_name);
514 pr_debug("%s: block sizes: ed %Zd td %Zd\n", hcd_name,
515 sizeof (struct ed), sizeof (struct td));
517 return driver_register(&ohci_hcd_omap_driver);
520 static void __exit ohci_hcd_omap_cleanup (void)
522 driver_unregister(&ohci_hcd_omap_driver);
525 module_init (ohci_hcd_omap_init);
526 module_exit (ohci_hcd_omap_cleanup);