xref: /linux/drivers/usb/host/ohci-hcd.c (revision 9ce7677cfd7cd871adb457c80bea3b581b839641)
1 /*
2  * OHCI HCD (Host Controller Driver) for USB.
3  *
4  * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5  * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
6  *
7  * [ Initialisation is based on Linus'  ]
8  * [ uhci code and gregs ohci fragments ]
9  * [ (C) Copyright 1999 Linus Torvalds  ]
10  * [ (C) Copyright 1999 Gregory P. Smith]
11  *
12  *
13  * OHCI is the main "non-Intel/VIA" standard for USB 1.1 host controller
14  * interfaces (though some non-x86 Intel chips use it).  It supports
15  * smarter hardware than UHCI.  A download link for the spec available
16  * through the http://www.usb.org website.
17  *
18  * History:
19  *
20  * 2004/03/24 LH7A404 support (Durgesh Pattamatta & Marc Singer)
21  * 2004/02/04 use generic dma_* functions instead of pci_* (dsaxena@plexity.net)
22  * 2003/02/24 show registers in sysfs (Kevin Brosius)
23  *
24  * 2002/09/03 get rid of ed hashtables, rework periodic scheduling and
25  * 	bandwidth accounting; if debugging, show schedules in driverfs
26  * 2002/07/19 fixes to management of ED and schedule state.
27  * 2002/06/09 SA-1111 support (Christopher Hoover)
28  * 2002/06/01 remember frame when HC won't see EDs any more; use that info
29  *	to fix urb unlink races caused by interrupt latency assumptions;
30  *	minor ED field and function naming updates
31  * 2002/01/18 package as a patch for 2.5.3; this should match the
32  *	2.4.17 kernel modulo some bugs being fixed.
33  *
34  * 2001/10/18 merge pmac cleanup (Benjamin Herrenschmidt) and bugfixes
35  *	from post-2.4.5 patches.
36  * 2001/09/20 URB_ZERO_PACKET support; hcca_dma portability, OPTi warning
37  * 2001/09/07 match PCI PM changes, errnos from Linus' tree
38  * 2001/05/05 fork 2.4.5 version into "hcd" framework, cleanup, simplify;
39  *	pbook pci quirks gone (please fix pbook pci sw!) (db)
40  *
41  * 2001/04/08 Identify version on module load (gb)
42  * 2001/03/24 td/ed hashing to remove bus_to_virt (Steve Longerbeam);
43  	pci_map_single (db)
44  * 2001/03/21 td and dev/ed allocation uses new pci_pool API (db)
45  * 2001/03/07 hcca allocation uses pci_alloc_consistent (Steve Longerbeam)
46  *
47  * 2000/09/26 fixed races in removing the private portion of the urb
48  * 2000/09/07 disable bulk and control lists when unlinking the last
49  *	endpoint descriptor in order to avoid unrecoverable errors on
50  *	the Lucent chips. (rwc@sgi)
51  * 2000/08/29 use bandwidth claiming hooks (thanks Randy!), fix some
52  *	urb unlink probs, indentation fixes
53  * 2000/08/11 various oops fixes mostly affecting iso and cleanup from
54  *	device unplugs.
55  * 2000/06/28 use PCI hotplug framework, for better power management
56  *	and for Cardbus support (David Brownell)
57  * 2000/earlier:  fixes for NEC/Lucent chips; suspend/resume handling
58  *	when the controller loses power; handle UE; cleanup; ...
59  *
60  * v5.2 1999/12/07 URB 3rd preview,
61  * v5.1 1999/11/30 URB 2nd preview, cpia, (usb-scsi)
62  * v5.0 1999/11/22 URB Technical preview, Paul Mackerras powerbook susp/resume
63  * 	i386: HUB, Keyboard, Mouse, Printer
64  *
65  * v4.3 1999/10/27 multiple HCs, bulk_request
66  * v4.2 1999/09/05 ISO API alpha, new dev alloc, neg Error-codes
67  * v4.1 1999/08/27 Randy Dunlap's - ISO API first impl.
68  * v4.0 1999/08/18
69  * v3.0 1999/06/25
70  * v2.1 1999/05/09  code clean up
71  * v2.0 1999/05/04
72  * v1.0 1999/04/27 initial release
73  *
74  * This file is licenced under the GPL.
75  */
76 
77 #include <linux/config.h>
78 
79 #ifdef CONFIG_USB_DEBUG
80 #	define DEBUG
81 #else
82 #	undef DEBUG
83 #endif
84 
85 #include <linux/module.h>
86 #include <linux/moduleparam.h>
87 #include <linux/pci.h>
88 #include <linux/kernel.h>
89 #include <linux/delay.h>
90 #include <linux/ioport.h>
91 #include <linux/sched.h>
92 #include <linux/slab.h>
93 #include <linux/smp_lock.h>
94 #include <linux/errno.h>
95 #include <linux/init.h>
96 #include <linux/timer.h>
97 #include <linux/list.h>
98 #include <linux/usb.h>
99 #include <linux/usb_otg.h>
100 #include <linux/dma-mapping.h>
101 #include <linux/dmapool.h>
102 #include <linux/reboot.h>
103 
104 #include <asm/io.h>
105 #include <asm/irq.h>
106 #include <asm/system.h>
107 #include <asm/unaligned.h>
108 #include <asm/byteorder.h>
109 
110 #include "../core/hcd.h"
111 
112 #define DRIVER_VERSION "2005 April 22"
113 #define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"
114 #define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"
115 
116 /*-------------------------------------------------------------------------*/
117 
118 #undef OHCI_VERBOSE_DEBUG	/* not always helpful */
119 
120 /* For initializing controller (mask in an HCFS mode too) */
121 #define	OHCI_CONTROL_INIT 	OHCI_CTRL_CBSR
122 #define	OHCI_INTR_INIT \
123 	(OHCI_INTR_MIE | OHCI_INTR_UE | OHCI_INTR_RD | OHCI_INTR_WDH)
124 
125 #ifdef __hppa__
126 /* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
127 #define	IR_DISABLE
128 #endif
129 
130 #ifdef CONFIG_ARCH_OMAP
131 /* OMAP doesn't support IR (no SMM; not needed) */
132 #define	IR_DISABLE
133 #endif
134 
135 /*-------------------------------------------------------------------------*/
136 
137 static const char	hcd_name [] = "ohci_hcd";
138 
139 #include "ohci.h"
140 
141 static void ohci_dump (struct ohci_hcd *ohci, int verbose);
142 static int ohci_init (struct ohci_hcd *ohci);
143 static void ohci_stop (struct usb_hcd *hcd);
144 static int ohci_reboot (struct notifier_block *, unsigned long , void *);
145 
146 #include "ohci-hub.c"
147 #include "ohci-dbg.c"
148 #include "ohci-mem.c"
149 #include "ohci-q.c"
150 
151 
152 /*
153  * On architectures with edge-triggered interrupts we must never return
154  * IRQ_NONE.
155  */
156 #if defined(CONFIG_SA1111)  /* ... or other edge-triggered systems */
157 #define IRQ_NOTMINE	IRQ_HANDLED
158 #else
159 #define IRQ_NOTMINE	IRQ_NONE
160 #endif
161 
162 
163 /* Some boards misreport power switching/overcurrent */
164 static int distrust_firmware = 1;
165 module_param (distrust_firmware, bool, 0);
166 MODULE_PARM_DESC (distrust_firmware,
167 	"true to distrust firmware power/overcurrent setup");
168 
169 /* Some boards leave IR set wrongly, since they fail BIOS/SMM handshakes */
170 static int no_handshake = 0;
171 module_param (no_handshake, bool, 0);
172 MODULE_PARM_DESC (no_handshake, "true (not default) disables BIOS handshake");
173 
174 /*-------------------------------------------------------------------------*/
175 
176 /*
177  * queue up an urb for anything except the root hub
178  */
179 static int ohci_urb_enqueue (
180 	struct usb_hcd	*hcd,
181 	struct usb_host_endpoint *ep,
182 	struct urb	*urb,
183 	gfp_t		mem_flags
184 ) {
185 	struct ohci_hcd	*ohci = hcd_to_ohci (hcd);
186 	struct ed	*ed;
187 	urb_priv_t	*urb_priv;
188 	unsigned int	pipe = urb->pipe;
189 	int		i, size = 0;
190 	unsigned long	flags;
191 	int		retval = 0;
192 
193 #ifdef OHCI_VERBOSE_DEBUG
194 	urb_print (urb, "SUB", usb_pipein (pipe));
195 #endif
196 
197 	/* every endpoint has a ed, locate and maybe (re)initialize it */
198 	if (! (ed = ed_get (ohci, ep, urb->dev, pipe, urb->interval)))
199 		return -ENOMEM;
200 
201 	/* for the private part of the URB we need the number of TDs (size) */
202 	switch (ed->type) {
203 		case PIPE_CONTROL:
204 			/* td_submit_urb() doesn't yet handle these */
205 			if (urb->transfer_buffer_length > 4096)
206 				return -EMSGSIZE;
207 
208 			/* 1 TD for setup, 1 for ACK, plus ... */
209 			size = 2;
210 			/* FALLTHROUGH */
211 		// case PIPE_INTERRUPT:
212 		// case PIPE_BULK:
213 		default:
214 			/* one TD for every 4096 Bytes (can be upto 8K) */
215 			size += urb->transfer_buffer_length / 4096;
216 			/* ... and for any remaining bytes ... */
217 			if ((urb->transfer_buffer_length % 4096) != 0)
218 				size++;
219 			/* ... and maybe a zero length packet to wrap it up */
220 			if (size == 0)
221 				size++;
222 			else if ((urb->transfer_flags & URB_ZERO_PACKET) != 0
223 				&& (urb->transfer_buffer_length
224 					% usb_maxpacket (urb->dev, pipe,
225 						usb_pipeout (pipe))) == 0)
226 				size++;
227 			break;
228 		case PIPE_ISOCHRONOUS: /* number of packets from URB */
229 			size = urb->number_of_packets;
230 			break;
231 	}
232 
233 	/* allocate the private part of the URB */
234 	urb_priv = kmalloc (sizeof (urb_priv_t) + size * sizeof (struct td *),
235 			mem_flags);
236 	if (!urb_priv)
237 		return -ENOMEM;
238 	memset (urb_priv, 0, sizeof (urb_priv_t) + size * sizeof (struct td *));
239 	INIT_LIST_HEAD (&urb_priv->pending);
240 	urb_priv->length = size;
241 	urb_priv->ed = ed;
242 
243 	/* allocate the TDs (deferring hash chain updates) */
244 	for (i = 0; i < size; i++) {
245 		urb_priv->td [i] = td_alloc (ohci, mem_flags);
246 		if (!urb_priv->td [i]) {
247 			urb_priv->length = i;
248 			urb_free_priv (ohci, urb_priv);
249 			return -ENOMEM;
250 		}
251 	}
252 
253 	spin_lock_irqsave (&ohci->lock, flags);
254 
255 	/* don't submit to a dead HC */
256 	if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
257 		retval = -ENODEV;
258 		goto fail;
259 	}
260 	if (!HC_IS_RUNNING(hcd->state)) {
261 		retval = -ENODEV;
262 		goto fail;
263 	}
264 
265 	/* in case of unlink-during-submit */
266 	spin_lock (&urb->lock);
267 	if (urb->status != -EINPROGRESS) {
268 		spin_unlock (&urb->lock);
269 		urb->hcpriv = urb_priv;
270 		finish_urb (ohci, urb, NULL);
271 		retval = 0;
272 		goto fail;
273 	}
274 
275 	/* schedule the ed if needed */
276 	if (ed->state == ED_IDLE) {
277 		retval = ed_schedule (ohci, ed);
278 		if (retval < 0)
279 			goto fail0;
280 		if (ed->type == PIPE_ISOCHRONOUS) {
281 			u16	frame = ohci_frame_no(ohci);
282 
283 			/* delay a few frames before the first TD */
284 			frame += max_t (u16, 8, ed->interval);
285 			frame &= ~(ed->interval - 1);
286 			frame |= ed->branch;
287 			urb->start_frame = frame;
288 
289 			/* yes, only URB_ISO_ASAP is supported, and
290 			 * urb->start_frame is never used as input.
291 			 */
292 		}
293 	} else if (ed->type == PIPE_ISOCHRONOUS)
294 		urb->start_frame = ed->last_iso + ed->interval;
295 
296 	/* fill the TDs and link them to the ed; and
297 	 * enable that part of the schedule, if needed
298 	 * and update count of queued periodic urbs
299 	 */
300 	urb->hcpriv = urb_priv;
301 	td_submit_urb (ohci, urb);
302 
303 fail0:
304 	spin_unlock (&urb->lock);
305 fail:
306 	if (retval)
307 		urb_free_priv (ohci, urb_priv);
308 	spin_unlock_irqrestore (&ohci->lock, flags);
309 	return retval;
310 }
311 
312 /*
313  * decouple the URB from the HC queues (TDs, urb_priv); it's
314  * already marked using urb->status.  reporting is always done
315  * asynchronously, and we might be dealing with an urb that's
316  * partially transferred, or an ED with other urbs being unlinked.
317  */
318 static int ohci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
319 {
320 	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);
321 	unsigned long		flags;
322 
323 #ifdef OHCI_VERBOSE_DEBUG
324 	urb_print (urb, "UNLINK", 1);
325 #endif
326 
327 	spin_lock_irqsave (&ohci->lock, flags);
328  	if (HC_IS_RUNNING(hcd->state)) {
329 		urb_priv_t  *urb_priv;
330 
331 		/* Unless an IRQ completed the unlink while it was being
332 		 * handed to us, flag it for unlink and giveback, and force
333 		 * some upcoming INTR_SF to call finish_unlinks()
334 		 */
335 		urb_priv = urb->hcpriv;
336 		if (urb_priv) {
337 			if (urb_priv->ed->state == ED_OPER)
338 				start_ed_unlink (ohci, urb_priv->ed);
339 		}
340 	} else {
341 		/*
342 		 * with HC dead, we won't respect hc queue pointers
343 		 * any more ... just clean up every urb's memory.
344 		 */
345 		if (urb->hcpriv)
346 			finish_urb (ohci, urb, NULL);
347 	}
348 	spin_unlock_irqrestore (&ohci->lock, flags);
349 	return 0;
350 }
351 
352 /*-------------------------------------------------------------------------*/
353 
354 /* frees config/altsetting state for endpoints,
355  * including ED memory, dummy TD, and bulk/intr data toggle
356  */
357 
358 static void
359 ohci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
360 {
361 	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);
362 	unsigned long		flags;
363 	struct ed		*ed = ep->hcpriv;
364 	unsigned		limit = 1000;
365 
366 	/* ASSERT:  any requests/urbs are being unlinked */
367 	/* ASSERT:  nobody can be submitting urbs for this any more */
368 
369 	if (!ed)
370 		return;
371 
372 rescan:
373 	spin_lock_irqsave (&ohci->lock, flags);
374 
375 	if (!HC_IS_RUNNING (hcd->state)) {
376 sanitize:
377 		ed->state = ED_IDLE;
378 		finish_unlinks (ohci, 0, NULL);
379 	}
380 
381 	switch (ed->state) {
382 	case ED_UNLINK:		/* wait for hw to finish? */
383 		/* major IRQ delivery trouble loses INTR_SF too... */
384 		if (limit-- == 0) {
385 			ohci_warn (ohci, "IRQ INTR_SF lossage\n");
386 			goto sanitize;
387 		}
388 		spin_unlock_irqrestore (&ohci->lock, flags);
389 		schedule_timeout_uninterruptible(1);
390 		goto rescan;
391 	case ED_IDLE:		/* fully unlinked */
392 		if (list_empty (&ed->td_list)) {
393 			td_free (ohci, ed->dummy);
394 			ed_free (ohci, ed);
395 			break;
396 		}
397 		/* else FALL THROUGH */
398 	default:
399 		/* caller was supposed to have unlinked any requests;
400 		 * that's not our job.  can't recover; must leak ed.
401 		 */
402 		ohci_err (ohci, "leak ed %p (#%02x) state %d%s\n",
403 			ed, ep->desc.bEndpointAddress, ed->state,
404 			list_empty (&ed->td_list) ? "" : " (has tds)");
405 		td_free (ohci, ed->dummy);
406 		break;
407 	}
408 	ep->hcpriv = NULL;
409 	spin_unlock_irqrestore (&ohci->lock, flags);
410 	return;
411 }
412 
413 static int ohci_get_frame (struct usb_hcd *hcd)
414 {
415 	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);
416 
417 	return ohci_frame_no(ohci);
418 }
419 
420 static void ohci_usb_reset (struct ohci_hcd *ohci)
421 {
422 	ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
423 	ohci->hc_control &= OHCI_CTRL_RWC;
424 	ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
425 }
426 
427 /* reboot notifier forcibly disables IRQs and DMA, helping kexec and
428  * other cases where the next software may expect clean state from the
429  * "firmware".  this is bus-neutral, unlike shutdown() methods.
430  */
431 static int
432 ohci_reboot (struct notifier_block *block, unsigned long code, void *null)
433 {
434 	struct ohci_hcd *ohci;
435 
436 	ohci = container_of (block, struct ohci_hcd, reboot_notifier);
437 	ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
438 	ohci_usb_reset (ohci);
439 	/* flush the writes */
440 	(void) ohci_readl (ohci, &ohci->regs->control);
441 	return 0;
442 }
443 
444 /*-------------------------------------------------------------------------*
445  * HC functions
446  *-------------------------------------------------------------------------*/
447 
448 /* init memory, and kick BIOS/SMM off */
449 
450 static int ohci_init (struct ohci_hcd *ohci)
451 {
452 	int ret;
453 
454 	disable (ohci);
455 	ohci->regs = ohci_to_hcd(ohci)->regs;
456 	ohci->next_statechange = jiffies;
457 
458 #ifndef IR_DISABLE
459 	/* SMM owns the HC?  not for long! */
460 	if (!no_handshake && ohci_readl (ohci,
461 					&ohci->regs->control) & OHCI_CTRL_IR) {
462 		u32 temp;
463 
464 		ohci_dbg (ohci, "USB HC TakeOver from BIOS/SMM\n");
465 
466 		/* this timeout is arbitrary.  we make it long, so systems
467 		 * depending on usb keyboards may be usable even if the
468 		 * BIOS/SMM code seems pretty broken.
469 		 */
470 		temp = 500;	/* arbitrary: five seconds */
471 
472 		ohci_writel (ohci, OHCI_INTR_OC, &ohci->regs->intrenable);
473 		ohci_writel (ohci, OHCI_OCR, &ohci->regs->cmdstatus);
474 		while (ohci_readl (ohci, &ohci->regs->control) & OHCI_CTRL_IR) {
475 			msleep (10);
476 			if (--temp == 0) {
477 				ohci_err (ohci, "USB HC takeover failed!"
478 					"  (BIOS/SMM bug)\n");
479 				return -EBUSY;
480 			}
481 		}
482 		ohci_usb_reset (ohci);
483 	}
484 #endif
485 
486 	/* Disable HC interrupts */
487 	ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
488 	// flush the writes
489 	(void) ohci_readl (ohci, &ohci->regs->control);
490 
491 	/* Read the number of ports unless overridden */
492 	if (ohci->num_ports == 0)
493 		ohci->num_ports = roothub_a(ohci) & RH_A_NDP;
494 
495 	if (ohci->hcca)
496 		return 0;
497 
498 	ohci->hcca = dma_alloc_coherent (ohci_to_hcd(ohci)->self.controller,
499 			sizeof *ohci->hcca, &ohci->hcca_dma, 0);
500 	if (!ohci->hcca)
501 		return -ENOMEM;
502 
503 	if ((ret = ohci_mem_init (ohci)) < 0)
504 		ohci_stop (ohci_to_hcd(ohci));
505 
506 	return ret;
507 
508 }
509 
510 /*-------------------------------------------------------------------------*/
511 
512 /* Start an OHCI controller, set the BUS operational
513  * resets USB and controller
514  * enable interrupts
515  */
516 static int ohci_run (struct ohci_hcd *ohci)
517 {
518   	u32			mask, temp;
519 	int			first = ohci->fminterval == 0;
520 
521 	disable (ohci);
522 
523 	/* boot firmware should have set this up (5.1.1.3.1) */
524 	if (first) {
525 
526 		temp = ohci_readl (ohci, &ohci->regs->fminterval);
527 		ohci->fminterval = temp & 0x3fff;
528 		if (ohci->fminterval != FI)
529 			ohci_dbg (ohci, "fminterval delta %d\n",
530 				ohci->fminterval - FI);
531 		ohci->fminterval |= FSMP (ohci->fminterval) << 16;
532 		/* also: power/overcurrent flags in roothub.a */
533 	}
534 
535   	/* Reset USB nearly "by the book".  RemoteWakeupConnected
536 	 * saved if boot firmware (BIOS/SMM/...) told us it's connected
537 	 * (for OHCI integrated on mainboard, it normally is)
538 	 */
539 	ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
540 	ohci_dbg (ohci, "resetting from state '%s', control = 0x%x\n",
541 			hcfs2string (ohci->hc_control & OHCI_CTRL_HCFS),
542 			ohci->hc_control);
543 
544 	if (ohci->hc_control & OHCI_CTRL_RWC
545 			&& !(ohci->flags & OHCI_QUIRK_AMD756))
546 		ohci_to_hcd(ohci)->can_wakeup = 1;
547 
548 	switch (ohci->hc_control & OHCI_CTRL_HCFS) {
549 	case OHCI_USB_OPER:
550 		temp = 0;
551 		break;
552 	case OHCI_USB_SUSPEND:
553 	case OHCI_USB_RESUME:
554 		ohci->hc_control &= OHCI_CTRL_RWC;
555 		ohci->hc_control |= OHCI_USB_RESUME;
556 		temp = 10 /* msec wait */;
557 		break;
558 	// case OHCI_USB_RESET:
559 	default:
560 		ohci->hc_control &= OHCI_CTRL_RWC;
561 		ohci->hc_control |= OHCI_USB_RESET;
562 		temp = 50 /* msec wait */;
563 		break;
564 	}
565 	ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
566 	// flush the writes
567 	(void) ohci_readl (ohci, &ohci->regs->control);
568 	msleep(temp);
569 	temp = roothub_a (ohci);
570 	if (!(temp & RH_A_NPS)) {
571 		/* power down each port */
572 		for (temp = 0; temp < ohci->num_ports; temp++)
573 			ohci_writel (ohci, RH_PS_LSDA,
574 				&ohci->regs->roothub.portstatus [temp]);
575 	}
576 	// flush those writes
577 	(void) ohci_readl (ohci, &ohci->regs->control);
578 	memset (ohci->hcca, 0, sizeof (struct ohci_hcca));
579 
580 	/* 2msec timelimit here means no irqs/preempt */
581 	spin_lock_irq (&ohci->lock);
582 
583 retry:
584 	/* HC Reset requires max 10 us delay */
585 	ohci_writel (ohci, OHCI_HCR,  &ohci->regs->cmdstatus);
586 	temp = 30;	/* ... allow extra time */
587 	while ((ohci_readl (ohci, &ohci->regs->cmdstatus) & OHCI_HCR) != 0) {
588 		if (--temp == 0) {
589 			spin_unlock_irq (&ohci->lock);
590 			ohci_err (ohci, "USB HC reset timed out!\n");
591 			return -1;
592 		}
593 		udelay (1);
594 	}
595 
596 	/* now we're in the SUSPEND state ... must go OPERATIONAL
597 	 * within 2msec else HC enters RESUME
598 	 *
599 	 * ... but some hardware won't init fmInterval "by the book"
600 	 * (SiS, OPTi ...), so reset again instead.  SiS doesn't need
601 	 * this if we write fmInterval after we're OPERATIONAL.
602 	 * Unclear about ALi, ServerWorks, and others ... this could
603 	 * easily be a longstanding bug in chip init on Linux.
604 	 */
605 	if (ohci->flags & OHCI_QUIRK_INITRESET) {
606 		ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
607 		// flush those writes
608 		(void) ohci_readl (ohci, &ohci->regs->control);
609 	}
610 
611 	/* Tell the controller where the control and bulk lists are
612 	 * The lists are empty now. */
613 	ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
614 	ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
615 
616 	/* a reset clears this */
617 	ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
618 
619 	periodic_reinit (ohci);
620 
621 	/* some OHCI implementations are finicky about how they init.
622 	 * bogus values here mean not even enumeration could work.
623 	 */
624 	if ((ohci_readl (ohci, &ohci->regs->fminterval) & 0x3fff0000) == 0
625 			|| !ohci_readl (ohci, &ohci->regs->periodicstart)) {
626 		if (!(ohci->flags & OHCI_QUIRK_INITRESET)) {
627 			ohci->flags |= OHCI_QUIRK_INITRESET;
628 			ohci_dbg (ohci, "enabling initreset quirk\n");
629 			goto retry;
630 		}
631 		spin_unlock_irq (&ohci->lock);
632 		ohci_err (ohci, "init err (%08x %04x)\n",
633 			ohci_readl (ohci, &ohci->regs->fminterval),
634 			ohci_readl (ohci, &ohci->regs->periodicstart));
635 		return -EOVERFLOW;
636 	}
637 
638  	/* start controller operations */
639 	ohci->hc_control &= OHCI_CTRL_RWC;
640  	ohci->hc_control |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
641  	ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
642 	ohci_to_hcd(ohci)->state = HC_STATE_RUNNING;
643 
644 	/* wake on ConnectStatusChange, matching external hubs */
645 	ohci_writel (ohci, RH_HS_DRWE, &ohci->regs->roothub.status);
646 
647 	/* Choose the interrupts we care about now, others later on demand */
648 	mask = OHCI_INTR_INIT;
649 	ohci_writel (ohci, mask, &ohci->regs->intrstatus);
650 	ohci_writel (ohci, mask, &ohci->regs->intrenable);
651 
652 	/* handle root hub init quirks ... */
653 	temp = roothub_a (ohci);
654 	temp &= ~(RH_A_PSM | RH_A_OCPM);
655 	if (ohci->flags & OHCI_QUIRK_SUPERIO) {
656 		/* NSC 87560 and maybe others */
657 		temp |= RH_A_NOCP;
658 		temp &= ~(RH_A_POTPGT | RH_A_NPS);
659 		ohci_writel (ohci, temp, &ohci->regs->roothub.a);
660 	} else if ((ohci->flags & OHCI_QUIRK_AMD756) || distrust_firmware) {
661 		/* hub power always on; required for AMD-756 and some
662 		 * Mac platforms.  ganged overcurrent reporting, if any.
663 		 */
664 		temp |= RH_A_NPS;
665 		ohci_writel (ohci, temp, &ohci->regs->roothub.a);
666 	}
667 	ohci_writel (ohci, RH_HS_LPSC, &ohci->regs->roothub.status);
668 	ohci_writel (ohci, (temp & RH_A_NPS) ? 0 : RH_B_PPCM,
669 						&ohci->regs->roothub.b);
670 	// flush those writes
671 	(void) ohci_readl (ohci, &ohci->regs->control);
672 
673 	spin_unlock_irq (&ohci->lock);
674 
675 	// POTPGT delay is bits 24-31, in 2 ms units.
676 	mdelay ((temp >> 23) & 0x1fe);
677 	ohci_to_hcd(ohci)->state = HC_STATE_RUNNING;
678 
679 	ohci_dump (ohci, 1);
680 
681 	if (ohci_to_hcd(ohci)->self.root_hub == NULL) {
682 		register_reboot_notifier (&ohci->reboot_notifier);
683 		create_debug_files (ohci);
684 	}
685 
686 	return 0;
687 }
688 
689 /*-------------------------------------------------------------------------*/
690 
691 /* an interrupt happens */
692 
693 static irqreturn_t ohci_irq (struct usb_hcd *hcd, struct pt_regs *ptregs)
694 {
695 	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);
696 	struct ohci_regs __iomem *regs = ohci->regs;
697  	int			ints;
698 
699 	/* we can eliminate a (slow) ohci_readl()
700 	   if _only_ WDH caused this irq */
701 	if ((ohci->hcca->done_head != 0)
702 			&& ! (hc32_to_cpup (ohci, &ohci->hcca->done_head)
703 				& 0x01)) {
704 		ints =  OHCI_INTR_WDH;
705 
706 	/* cardbus/... hardware gone before remove() */
707 	} else if ((ints = ohci_readl (ohci, &regs->intrstatus)) == ~(u32)0) {
708 		disable (ohci);
709 		ohci_dbg (ohci, "device removed!\n");
710 		return IRQ_HANDLED;
711 
712 	/* interrupt for some other device? */
713 	} else if ((ints &= ohci_readl (ohci, &regs->intrenable)) == 0) {
714 		return IRQ_NOTMINE;
715 	}
716 
717 	if (ints & OHCI_INTR_UE) {
718 		disable (ohci);
719 		ohci_err (ohci, "OHCI Unrecoverable Error, disabled\n");
720 		// e.g. due to PCI Master/Target Abort
721 
722 		ohci_dump (ohci, 1);
723 		ohci_usb_reset (ohci);
724 	}
725 
726 	if (ints & OHCI_INTR_RD) {
727 		ohci_vdbg (ohci, "resume detect\n");
728 		ohci_writel (ohci, OHCI_INTR_RD, &regs->intrstatus);
729 		if (hcd->state != HC_STATE_QUIESCING)
730 			usb_hcd_resume_root_hub(hcd);
731 	}
732 
733 	if (ints & OHCI_INTR_WDH) {
734 		if (HC_IS_RUNNING(hcd->state))
735 			ohci_writel (ohci, OHCI_INTR_WDH, &regs->intrdisable);
736 		spin_lock (&ohci->lock);
737 		dl_done_list (ohci, ptregs);
738 		spin_unlock (&ohci->lock);
739 		if (HC_IS_RUNNING(hcd->state))
740 			ohci_writel (ohci, OHCI_INTR_WDH, &regs->intrenable);
741 	}
742 
743 	/* could track INTR_SO to reduce available PCI/... bandwidth */
744 
745 	/* handle any pending URB/ED unlinks, leaving INTR_SF enabled
746 	 * when there's still unlinking to be done (next frame).
747 	 */
748 	spin_lock (&ohci->lock);
749 	if (ohci->ed_rm_list)
750 		finish_unlinks (ohci, ohci_frame_no(ohci), ptregs);
751 	if ((ints & OHCI_INTR_SF) != 0 && !ohci->ed_rm_list
752 			&& HC_IS_RUNNING(hcd->state))
753 		ohci_writel (ohci, OHCI_INTR_SF, &regs->intrdisable);
754 	spin_unlock (&ohci->lock);
755 
756 	if (HC_IS_RUNNING(hcd->state)) {
757 		ohci_writel (ohci, ints, &regs->intrstatus);
758 		ohci_writel (ohci, OHCI_INTR_MIE, &regs->intrenable);
759 		// flush those writes
760 		(void) ohci_readl (ohci, &ohci->regs->control);
761 	}
762 
763 	return IRQ_HANDLED;
764 }
765 
766 /*-------------------------------------------------------------------------*/
767 
768 static void ohci_stop (struct usb_hcd *hcd)
769 {
770 	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);
771 
772 	ohci_dbg (ohci, "stop %s controller (state 0x%02x)\n",
773 		hcfs2string (ohci->hc_control & OHCI_CTRL_HCFS),
774 		hcd->state);
775 	ohci_dump (ohci, 1);
776 
777 	flush_scheduled_work();
778 
779 	ohci_usb_reset (ohci);
780 	ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
781 
782 	remove_debug_files (ohci);
783 	unregister_reboot_notifier (&ohci->reboot_notifier);
784 	ohci_mem_cleanup (ohci);
785 	if (ohci->hcca) {
786 		dma_free_coherent (hcd->self.controller,
787 				sizeof *ohci->hcca,
788 				ohci->hcca, ohci->hcca_dma);
789 		ohci->hcca = NULL;
790 		ohci->hcca_dma = 0;
791 	}
792 }
793 
794 /*-------------------------------------------------------------------------*/
795 
796 /* must not be called from interrupt context */
797 
798 #ifdef	CONFIG_PM
799 
800 static int ohci_restart (struct ohci_hcd *ohci)
801 {
802 	int temp;
803 	int i;
804 	struct urb_priv *priv;
805 	struct usb_device *root = ohci_to_hcd(ohci)->self.root_hub;
806 
807 	/* mark any devices gone, so they do nothing till khubd disconnects.
808 	 * recycle any "live" eds/tds (and urbs) right away.
809 	 * later, khubd disconnect processing will recycle the other state,
810 	 * (either as disconnect/reconnect, or maybe someday as a reset).
811 	 */
812 	spin_lock_irq(&ohci->lock);
813 	disable (ohci);
814 	for (i = 0; i < root->maxchild; i++) {
815 		if (root->children [i])
816 			usb_set_device_state (root->children[i],
817 				USB_STATE_NOTATTACHED);
818 	}
819 	if (!list_empty (&ohci->pending))
820 		ohci_dbg(ohci, "abort schedule...\n");
821 	list_for_each_entry (priv, &ohci->pending, pending) {
822 		struct urb	*urb = priv->td[0]->urb;
823 		struct ed	*ed = priv->ed;
824 
825 		switch (ed->state) {
826 		case ED_OPER:
827 			ed->state = ED_UNLINK;
828 			ed->hwINFO |= cpu_to_hc32(ohci, ED_DEQUEUE);
829 			ed_deschedule (ohci, ed);
830 
831 			ed->ed_next = ohci->ed_rm_list;
832 			ed->ed_prev = NULL;
833 			ohci->ed_rm_list = ed;
834 			/* FALLTHROUGH */
835 		case ED_UNLINK:
836 			break;
837 		default:
838 			ohci_dbg(ohci, "bogus ed %p state %d\n",
839 					ed, ed->state);
840 		}
841 
842 		spin_lock (&urb->lock);
843 		urb->status = -ESHUTDOWN;
844 		spin_unlock (&urb->lock);
845 	}
846 	finish_unlinks (ohci, 0, NULL);
847 	spin_unlock_irq(&ohci->lock);
848 
849 	/* paranoia, in case that didn't work: */
850 
851 	/* empty the interrupt branches */
852 	for (i = 0; i < NUM_INTS; i++) ohci->load [i] = 0;
853 	for (i = 0; i < NUM_INTS; i++) ohci->hcca->int_table [i] = 0;
854 
855 	/* no EDs to remove */
856 	ohci->ed_rm_list = NULL;
857 
858 	/* empty control and bulk lists */
859 	ohci->ed_controltail = NULL;
860 	ohci->ed_bulktail    = NULL;
861 
862 	if ((temp = ohci_run (ohci)) < 0) {
863 		ohci_err (ohci, "can't restart, %d\n", temp);
864 		return temp;
865 	} else {
866 		/* here we "know" root ports should always stay powered,
867 		 * and that if we try to turn them back on the root hub
868 		 * will respond to CSC processing.
869 		 */
870 		i = ohci->num_ports;
871 		while (i--)
872 			ohci_writel (ohci, RH_PS_PSS,
873 				&ohci->regs->roothub.portstatus [temp]);
874 		ohci_dbg (ohci, "restart complete\n");
875 	}
876 	return 0;
877 }
878 #endif
879 
880 /*-------------------------------------------------------------------------*/
881 
882 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
883 
884 MODULE_AUTHOR (DRIVER_AUTHOR);
885 MODULE_DESCRIPTION (DRIVER_INFO);
886 MODULE_LICENSE ("GPL");
887 
888 #ifdef CONFIG_PCI
889 #include "ohci-pci.c"
890 #endif
891 
892 #ifdef CONFIG_SA1111
893 #include "ohci-sa1111.c"
894 #endif
895 
896 #ifdef CONFIG_ARCH_S3C2410
897 #include "ohci-s3c2410.c"
898 #endif
899 
900 #ifdef CONFIG_ARCH_OMAP
901 #include "ohci-omap.c"
902 #endif
903 
904 #ifdef CONFIG_ARCH_LH7A404
905 #include "ohci-lh7a404.c"
906 #endif
907 
908 #ifdef CONFIG_PXA27x
909 #include "ohci-pxa27x.c"
910 #endif
911 
912 #ifdef CONFIG_SOC_AU1X00
913 #include "ohci-au1xxx.c"
914 #endif
915 
916 #ifdef CONFIG_USB_OHCI_HCD_PPC_SOC
917 #include "ohci-ppc-soc.c"
918 #endif
919 
920 #if !(defined(CONFIG_PCI) \
921       || defined(CONFIG_SA1111) \
922       || defined(CONFIG_ARCH_S3C2410) \
923       || defined(CONFIG_ARCH_OMAP) \
924       || defined (CONFIG_ARCH_LH7A404) \
925       || defined (CONFIG_PXA27x) \
926       || defined (CONFIG_SOC_AU1X00) \
927       || defined (CONFIG_USB_OHCI_HCD_PPC_SOC) \
928 	)
929 #error "missing bus glue for ohci-hcd"
930 #endif
931