2 * OHCI HCD(Host Controller Driver) for USB.
4 *(C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 *(C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
6 *(C) Copyright 2002 Hewlett-Packard Company
8 * Bus glue for Toshiba Mobile IO(TMIO) Controller's OHCI core
9 * (C) Copyright 2005 Chris Humbert <mahadri-usb@drigon.com>
10 * (C) Copyright 2007, 2008 Dmitry Baryshkov <dbaryshkov@gmail.com>
12 * This is known to work with the following variants:
13 * TC6393XB revision 3 (32kB SRAM)
15 * The TMIO's OHCI core DMAs through a small internal buffer that
16 * is directly addressable by the CPU.
18 * Written from sparse documentation from Toshiba and Sharp's driver
20 * usb-ohci-tc6393.c(C) Copyright 2004 Lineo Solutions, Inc.
22 * This program is free software; you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License version 2 as
24 * published by the Free Software Foundation.
27 /*#include <linux/fs.h>
28 #include <linux/mount.h>
29 #include <linux/pagemap.h>
30 #include <linux/init.h>
31 #include <linux/namei.h>
32 #include <linux/sched.h>*/
33 #include <linux/platform_device.h>
34 #include <linux/mfd/core.h>
35 #include <linux/mfd/tmio.h>
36 #include <linux/dma-mapping.h>
38 /*-------------------------------------------------------------------------*/
41 * USB Host Controller Configuration Register
43 #define CCR_REVID 0x08 /* b Revision ID */
44 #define CCR_BASE 0x10 /* l USB Control Register Base Address Low */
45 #define CCR_ILME 0x40 /* b Internal Local Memory Enable */
46 #define CCR_PM 0x4c /* w Power Management */
47 #define CCR_INTC 0x50 /* b INT Control */
48 #define CCR_LMW1L 0x54 /* w Local Memory Window 1 LMADRS Low */
49 #define CCR_LMW1H 0x56 /* w Local Memory Window 1 LMADRS High */
50 #define CCR_LMW1BL 0x58 /* w Local Memory Window 1 Base Address Low */
51 #define CCR_LMW1BH 0x5A /* w Local Memory Window 1 Base Address High */
52 #define CCR_LMW2L 0x5C /* w Local Memory Window 2 LMADRS Low */
53 #define CCR_LMW2H 0x5E /* w Local Memory Window 2 LMADRS High */
54 #define CCR_LMW2BL 0x60 /* w Local Memory Window 2 Base Address Low */
55 #define CCR_LMW2BH 0x62 /* w Local Memory Window 2 Base Address High */
56 #define CCR_MISC 0xFC /* b MISC */
58 #define CCR_PM_GKEN 0x0001
59 #define CCR_PM_CKRNEN 0x0002
60 #define CCR_PM_USBPW1 0x0004
61 #define CCR_PM_USBPW2 0x0008
62 #define CCR_PM_USBPW3 0x0008
63 #define CCR_PM_PMEE 0x0100
64 #define CCR_PM_PMES 0x8000
66 /*-------------------------------------------------------------------------*/
70 spinlock_t lock
; /* protects RMW cycles */
73 #define hcd_to_tmio(hcd) ((struct tmio_hcd *)(hcd_to_ohci(hcd) + 1))
75 /*-------------------------------------------------------------------------*/
77 static void tmio_write_pm(struct platform_device
*dev
)
79 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
80 struct tmio_hcd
*tmio
= hcd_to_tmio(hcd
);
84 spin_lock_irqsave(&tmio
->lock
, flags
);
86 pm
= CCR_PM_GKEN
| CCR_PM_CKRNEN
|
87 CCR_PM_PMEE
| CCR_PM_PMES
;
89 tmio_iowrite16(pm
, tmio
->ccr
+ CCR_PM
);
90 spin_unlock_irqrestore(&tmio
->lock
, flags
);
93 static void tmio_stop_hc(struct platform_device
*dev
)
95 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
96 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
97 struct tmio_hcd
*tmio
= hcd_to_tmio(hcd
);
100 pm
= CCR_PM_GKEN
| CCR_PM_CKRNEN
;
101 switch (ohci
->num_ports
) {
103 dev_err(&dev
->dev
, "Unsupported amount of ports: %d\n", ohci
->num_ports
);
111 tmio_iowrite8(0, tmio
->ccr
+ CCR_INTC
);
112 tmio_iowrite8(0, tmio
->ccr
+ CCR_ILME
);
113 tmio_iowrite16(0, tmio
->ccr
+ CCR_BASE
);
114 tmio_iowrite16(0, tmio
->ccr
+ CCR_BASE
+ 2);
115 tmio_iowrite16(pm
, tmio
->ccr
+ CCR_PM
);
118 static void tmio_start_hc(struct platform_device
*dev
)
120 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
121 struct tmio_hcd
*tmio
= hcd_to_tmio(hcd
);
122 unsigned long base
= hcd
->rsrc_start
;
125 tmio_iowrite16(base
, tmio
->ccr
+ CCR_BASE
);
126 tmio_iowrite16(base
>> 16, tmio
->ccr
+ CCR_BASE
+ 2);
127 tmio_iowrite8(1, tmio
->ccr
+ CCR_ILME
);
128 tmio_iowrite8(2, tmio
->ccr
+ CCR_INTC
);
130 dev_info(&dev
->dev
, "revision %d @ 0x%08llx, irq %d\n",
131 tmio_ioread8(tmio
->ccr
+ CCR_REVID
), hcd
->rsrc_start
, hcd
->irq
);
134 static int ohci_tmio_start(struct usb_hcd
*hcd
)
136 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
139 if ((ret
= ohci_init(ohci
)) < 0)
142 if ((ret
= ohci_run(ohci
)) < 0) {
143 err("can't start %s", hcd
->self
.bus_name
);
151 static const struct hc_driver ohci_tmio_hc_driver
= {
152 .description
= hcd_name
,
153 .product_desc
= "TMIO OHCI USB Host Controller",
154 .hcd_priv_size
= sizeof(struct ohci_hcd
) + sizeof (struct tmio_hcd
),
156 /* generic hardware linkage */
158 .flags
= HCD_USB11
| HCD_MEMORY
| HCD_LOCAL_MEM
,
160 /* basic lifecycle operations */
161 .start
= ohci_tmio_start
,
163 .shutdown
= ohci_shutdown
,
165 /* managing i/o requests and associated device resources */
166 .urb_enqueue
= ohci_urb_enqueue
,
167 .urb_dequeue
= ohci_urb_dequeue
,
168 .endpoint_disable
= ohci_endpoint_disable
,
170 /* scheduling support */
171 .get_frame_number
= ohci_get_frame
,
173 /* root hub support */
174 .hub_status_data
= ohci_hub_status_data
,
175 .hub_control
= ohci_hub_control
,
177 .bus_suspend
= ohci_bus_suspend
,
178 .bus_resume
= ohci_bus_resume
,
180 .start_port_reset
= ohci_start_port_reset
,
183 /*-------------------------------------------------------------------------*/
184 static struct platform_driver ohci_hcd_tmio_driver
;
186 static int __devinit
ohci_hcd_tmio_drv_probe(struct platform_device
*dev
)
188 const struct mfd_cell
*cell
= mfd_get_cell(dev
);
189 struct resource
*regs
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
190 struct resource
*config
= platform_get_resource(dev
, IORESOURCE_MEM
, 1);
191 struct resource
*sram
= platform_get_resource(dev
, IORESOURCE_MEM
, 2);
192 int irq
= platform_get_irq(dev
, 0);
193 struct tmio_hcd
*tmio
;
194 struct ohci_hcd
*ohci
;
204 hcd
= usb_create_hcd(&ohci_tmio_hc_driver
, &dev
->dev
, dev_name(&dev
->dev
));
207 goto err_usb_create_hcd
;
210 hcd
->rsrc_start
= regs
->start
;
211 hcd
->rsrc_len
= resource_size(regs
);
213 tmio
= hcd_to_tmio(hcd
);
215 spin_lock_init(&tmio
->lock
);
217 tmio
->ccr
= ioremap(config
->start
, resource_size(config
));
220 goto err_ioremap_ccr
;
223 hcd
->regs
= ioremap(hcd
->rsrc_start
, hcd
->rsrc_len
);
226 goto err_ioremap_regs
;
229 if (!dma_declare_coherent_memory(&dev
->dev
, sram
->start
,
232 DMA_MEMORY_MAP
| DMA_MEMORY_EXCLUSIVE
)) {
234 goto err_dma_declare
;
238 ret
= cell
->enable(dev
);
244 ohci
= hcd_to_ohci(hcd
);
247 ret
= usb_add_hcd(hcd
, irq
, 0);
261 dma_release_declared_memory(&dev
->dev
);
273 static int __devexit
ohci_hcd_tmio_drv_remove(struct platform_device
*dev
)
275 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
276 struct tmio_hcd
*tmio
= hcd_to_tmio(hcd
);
277 const struct mfd_cell
*cell
= mfd_get_cell(dev
);
283 dma_release_declared_memory(&dev
->dev
);
288 platform_set_drvdata(dev
, NULL
);
294 static int ohci_hcd_tmio_drv_suspend(struct platform_device
*dev
, pm_message_t state
)
296 const struct mfd_cell
*cell
= mfd_get_cell(dev
);
297 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
298 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
299 struct tmio_hcd
*tmio
= hcd_to_tmio(hcd
);
304 if (time_before(jiffies
, ohci
->next_statechange
))
306 ohci
->next_statechange
= jiffies
;
308 spin_lock_irqsave(&tmio
->lock
, flags
);
310 misc
= tmio_ioread8(tmio
->ccr
+ CCR_MISC
);
311 misc
|= 1 << 3; /* USSUSP */
312 tmio_iowrite8(misc
, tmio
->ccr
+ CCR_MISC
);
314 spin_unlock_irqrestore(&tmio
->lock
, flags
);
317 ret
= cell
->suspend(dev
);
324 static int ohci_hcd_tmio_drv_resume(struct platform_device
*dev
)
326 const struct mfd_cell
*cell
= mfd_get_cell(dev
);
327 struct usb_hcd
*hcd
= platform_get_drvdata(dev
);
328 struct ohci_hcd
*ohci
= hcd_to_ohci(hcd
);
329 struct tmio_hcd
*tmio
= hcd_to_tmio(hcd
);
334 if (time_before(jiffies
, ohci
->next_statechange
))
336 ohci
->next_statechange
= jiffies
;
339 ret
= cell
->resume(dev
);
346 spin_lock_irqsave(&tmio
->lock
, flags
);
348 misc
= tmio_ioread8(tmio
->ccr
+ CCR_MISC
);
349 misc
&= ~(1 << 3); /* USSUSP */
350 tmio_iowrite8(misc
, tmio
->ccr
+ CCR_MISC
);
352 spin_unlock_irqrestore(&tmio
->lock
, flags
);
354 ohci_finish_controller_resume(hcd
);
359 #define ohci_hcd_tmio_drv_suspend NULL
360 #define ohci_hcd_tmio_drv_resume NULL
363 static struct platform_driver ohci_hcd_tmio_driver
= {
364 .probe
= ohci_hcd_tmio_drv_probe
,
365 .remove
= __devexit_p(ohci_hcd_tmio_drv_remove
),
366 .shutdown
= usb_hcd_platform_shutdown
,
367 .suspend
= ohci_hcd_tmio_drv_suspend
,
368 .resume
= ohci_hcd_tmio_drv_resume
,
371 .owner
= THIS_MODULE
,