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
10 * Written by Christopher Hoover <ch@hpl.hp.com>
11 * Based on fragments of previous driver by Rusell King et al.
13 * This file is licenced under the GPL.
16 #include <asm/hardware.h>
17 #include <asm/mach-types.h>
18 #include <asm/arch/assabet.h>
19 #include <asm/arch/badge4.h>
20 #include <asm/hardware/sa1111.h>
23 #error "This file is SA-1111 bus glue. CONFIG_SA1111 must be defined."
26 extern int usb_disabled(void);
28 /*-------------------------------------------------------------------------*/
30 static void sa1111_start_hc(struct sa1111_dev *dev)
32 unsigned int usb_rst = 0;
34 printk(KERN_DEBUG __FILE__
35 ": starting SA-1111 OHCI USB Controller\n");
37 #ifdef CONFIG_SA1100_BADGE4
38 if (machine_is_badge4()) {
39 badge4_set_5V(BADGE4_5V_USB, 1);
43 if (machine_is_xp860() ||
44 machine_has_neponset() ||
45 machine_is_pfs168() ||
47 usb_rst = USB_RESET_PWRSENSELOW | USB_RESET_PWRCTRLLOW;
50 * Configure the power sense and control lines. Place the USB
51 * host controller in reset.
53 sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
54 dev->mapbase + SA1111_USB_RESET);
57 * Now, carefully enable the USB clock, and take
58 * the USB host controller out of reset.
60 sa1111_enable_device(dev);
62 sa1111_writel(usb_rst, dev->mapbase + SA1111_USB_RESET);
65 static void sa1111_stop_hc(struct sa1111_dev *dev)
68 printk(KERN_DEBUG __FILE__
69 ": stopping SA-1111 OHCI USB Controller\n");
72 * Put the USB host controller into reset.
74 usb_rst = sa1111_readl(dev->mapbase + SA1111_USB_RESET);
75 sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
76 dev->mapbase + SA1111_USB_RESET);
81 sa1111_disable_device(dev);
83 #ifdef CONFIG_SA1100_BADGE4
84 if (machine_is_badge4()) {
85 /* Disable power to the USB bus */
86 badge4_set_5V(BADGE4_5V_USB, 0);
92 /*-------------------------------------------------------------------------*/
95 static void dump_hci_status(struct usb_hcd *hcd, const char *label)
97 unsigned long status = sa1111_readl(hcd->regs + SA1111_USB_STATUS);
99 dbg ("%s USB_STATUS = { %s%s%s%s%s}", label,
100 ((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
101 ((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
102 ((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
103 ((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
104 ((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
108 static irqreturn_t usb_hcd_sa1111_hcim_irq (int irq, void *__hcd, struct pt_regs * r)
110 struct usb_hcd *hcd = __hcd;
111 // unsigned long status = sa1111_readl(hcd->regs + SA1111_USB_STATUS);
113 //dump_hci_status(hcd, "irq");
116 /* may work better this way -- need to investigate further */
117 if (status & USB_STATUS_NIRQHCIM) {
118 //dbg ("not normal HC interrupt; ignoring");
123 usb_hcd_irq(irq, hcd, r);
126 * SA1111 seems to re-assert its interrupt immediately
127 * after processing an interrupt. Always return IRQ_HANDLED.
132 /*-------------------------------------------------------------------------*/
134 void usb_hcd_sa1111_remove (struct usb_hcd *, struct sa1111_dev *);
136 /* configure so an HC device and id are always provided */
137 /* always called with process context; sleeping is OK */
141 * usb_hcd_sa1111_probe - initialize SA-1111-based HCDs
142 * Context: !in_interrupt()
144 * Allocates basic resources for this USB host controller, and
145 * then invokes the start() method for the HCD associated with it
146 * through the hotplug entry's driver_data.
148 * Store this function in the HCD's struct pci_driver as probe().
150 int usb_hcd_sa1111_probe (const struct hc_driver *driver,
151 struct usb_hcd **hcd_out,
152 struct sa1111_dev *dev)
155 struct usb_hcd *hcd = 0;
157 if (!request_mem_region(dev->res.start,
158 dev->res.end - dev->res.start + 1, hcd_name)) {
159 dbg("request_mem_region failed");
163 sa1111_start_hc(dev);
165 hcd = driver->hcd_alloc ();
167 dbg ("hcd_alloc failed");
172 hcd->driver = (struct hc_driver *) driver;
173 hcd->description = driver->description;
174 hcd->irq = dev->irq[1];
175 hcd->regs = dev->mapbase;
176 hcd->self.controller = &dev->dev;
178 retval = hcd_buffer_create (hcd);
180 dbg ("pool alloc fail");
184 retval = request_irq (hcd->irq, usb_hcd_sa1111_hcim_irq, SA_INTERRUPT,
185 hcd->description, hcd);
187 dbg("request_irq failed");
192 info ("%s (SA-1111) at 0x%p, irq %d\n",
193 hcd->description, hcd->regs, hcd->irq);
195 usb_bus_init (&hcd->self);
196 hcd->self.op = &usb_hcd_operations;
197 hcd->self.hcpriv = (void *) hcd;
198 hcd->self.bus_name = "sa1111";
199 hcd->product_desc = "SA-1111 OHCI";
201 INIT_LIST_HEAD (&hcd->dev_list);
203 usb_register_bus (&hcd->self);
205 if ((retval = driver->start (hcd)) < 0)
207 usb_hcd_sa1111_remove(hcd, dev);
215 hcd_buffer_destroy (hcd);
217 driver->hcd_free(hcd);
220 release_mem_region(dev->res.start, dev->res.end - dev->res.start + 1);
225 /* may be called without controller electrically present */
226 /* may be called with controller, bus, and devices active */
229 * usb_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
230 * @dev: USB Host Controller being removed
231 * Context: !in_interrupt()
233 * Reverses the effect of usb_hcd_sa1111_probe(), first invoking
234 * the HCD's stop() method. It is always called from a thread
235 * context, normally "rmmod", "apmd", or something similar.
238 void usb_hcd_sa1111_remove (struct usb_hcd *hcd, struct sa1111_dev *dev)
240 struct usb_device *hub;
243 info ("remove: %s, state %x", hcd->self.bus_name, hcd->state);
248 hub = hcd->self.root_hub;
249 hcd->state = USB_STATE_QUIESCING;
251 dbg ("%s: roothub graceful disconnect", hcd->self.bus_name);
252 usb_disconnect (&hub);
254 hcd->driver->stop (hcd);
255 hcd->state = USB_STATE_HALT;
257 free_irq (hcd->irq, hcd);
258 hcd_buffer_destroy (hcd);
260 usb_deregister_bus (&hcd->self);
263 hcd->driver->hcd_free (hcd);
266 release_mem_region(dev->res.start, dev->res.end - dev->res.start + 1);
269 /*-------------------------------------------------------------------------*/
272 ohci_sa1111_start (struct usb_hcd *hcd)
274 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
277 ohci->hcca = dma_alloc_coherent (hcd->self.controller,
278 sizeof *ohci->hcca, &ohci->hcca_dma, 0);
282 memset (ohci->hcca, 0, sizeof (struct ohci_hcca));
283 if ((ret = ohci_mem_init (ohci)) < 0) {
287 ohci->regs = hcd->regs;
289 if (hc_reset (ohci) < 0) {
294 if (hc_start (ohci) < 0) {
295 err ("can't start %s", ohci->hcd.self.bus_name);
299 create_debug_files (ohci);
307 /*-------------------------------------------------------------------------*/
309 static const struct hc_driver ohci_sa1111_hc_driver = {
310 .description = hcd_name,
313 * generic hardware linkage
319 * basic lifecycle operations
321 .start = ohci_sa1111_start,
323 /* suspend: ohci_sa1111_suspend, -- tbd */
324 /* resume: ohci_sa1111_resume, -- tbd */
329 * memory lifecycle (except per-request)
331 .hcd_alloc = ohci_hcd_alloc,
332 .hcd_free = ohci_hcd_free,
335 * managing i/o requests and associated device resources
337 .urb_enqueue = ohci_urb_enqueue,
338 .urb_dequeue = ohci_urb_dequeue,
339 .endpoint_disable = ohci_endpoint_disable,
344 .get_frame_number = ohci_get_frame,
349 .hub_status_data = ohci_hub_status_data,
350 .hub_control = ohci_hub_control,
353 /*-------------------------------------------------------------------------*/
355 static int ohci_hcd_sa1111_drv_probe(struct sa1111_dev *dev)
357 struct usb_hcd *hcd = NULL;
363 ret = usb_hcd_sa1111_probe(&ohci_sa1111_hc_driver, &hcd, dev);
366 sa1111_set_drvdata(dev, hcd);
371 static int ohci_hcd_sa1111_drv_remove(struct sa1111_dev *dev)
373 struct usb_hcd *hcd = sa1111_get_drvdata(dev);
375 usb_hcd_sa1111_remove(hcd, dev);
377 sa1111_set_drvdata(dev, NULL);
382 static struct sa1111_driver ohci_hcd_sa1111_driver = {
384 .name = "sa1111-ohci",
386 .devid = SA1111_DEVID_USB,
387 .probe = ohci_hcd_sa1111_drv_probe,
388 .remove = ohci_hcd_sa1111_drv_remove,
391 static int __init ohci_hcd_sa1111_init (void)
393 dbg (DRIVER_INFO " (SA-1111)");
394 dbg ("block sizes: ed %d td %d",
395 sizeof (struct ed), sizeof (struct td));
397 return sa1111_driver_register(&ohci_hcd_sa1111_driver);
400 static void __exit ohci_hcd_sa1111_cleanup (void)
402 sa1111_driver_unregister(&ohci_hcd_sa1111_driver);
405 module_init (ohci_hcd_sa1111_init);
406 module_exit (ohci_hcd_sa1111_cleanup);