/* * OHCI HCD (Host Controller Driver) for USB. * * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at> * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net> *  * [ Initialisation is based on Linus'  ] * [ uhci code and gregs ohci fragments ] * [ (C) Copyright 1999 Linus Torvalds  ] * [ (C) Copyright 1999 Gregory P. Smith] *  *  * OHCI is the main "non-Intel/VIA" standard for USB 1.1 host controller * interfaces (though some non-x86 Intel chips use it).  It supports * smarter hardware than UHCI.  A download link for the spec available * through the http://www.usb.org website. * * History: *  * 2004/03/24 LH7A404 support (Durgesh Pattamatta & Marc Singer) * 2004/02/04 use generic dma_* functions instead of pci_* (dsaxena@plexity.net) * 2003/02/24 show registers in sysfs (Kevin Brosius) * * 2002/09/03 get rid of ed hashtables, rework periodic scheduling and * 	bandwidth accounting; if debugging, show schedules in driverfs * 2002/07/19 fixes to management of ED and schedule state. * 2002/06/09 SA-1111 support (Christopher Hoover) * 2002/06/01 remember frame when HC won't see EDs any more; use that info *	to fix urb unlink races caused by interrupt latency assumptions; *	minor ED field and function naming updates * 2002/01/18 package as a patch for 2.5.3; this should match the *	2.4.17 kernel modulo some bugs being fixed. * * 2001/10/18 merge pmac cleanup (Benjamin Herrenschmidt) and bugfixes *	from post-2.4.5 patches. * 2001/09/20 URB_ZERO_PACKET support; hcca_dma portability, OPTi warning * 2001/09/07 match PCI PM changes, errnos from Linus' tree * 2001/05/05 fork 2.4.5 version into "hcd" framework, cleanup, simplify; *	pbook pci quirks gone (please fix pbook pci sw!) (db) * * 2001/04/08 Identify version on module load (gb) * 2001/03/24 td/ed hashing to remove bus_to_virt (Steve Longerbeam); 	pci_map_single (db) * 2001/03/21 td and dev/ed allocation uses new pci_pool API (db) * 2001/03/07 hcca allocation uses pci_alloc_consistent (Steve Longerbeam) * * 2000/09/26 fixed races in removing the private portion of the urb * 2000/09/07 disable bulk and control lists when unlinking the last *	endpoint descriptor in order to avoid unrecoverable errors on *	the Lucent chips. (rwc@sgi) * 2000/08/29 use bandwidth claiming hooks (thanks Randy!), fix some *	urb unlink probs, indentation fixes * 2000/08/11 various oops fixes mostly affecting iso and cleanup from *	device unplugs. * 2000/06/28 use PCI hotplug framework, for better power management *	and for Cardbus support (David Brownell) * 2000/earlier:  fixes for NEC/Lucent chips; suspend/resume handling *	when the controller loses power; handle UE; cleanup; ... * * v5.2 1999/12/07 URB 3rd preview,  * v5.1 1999/11/30 URB 2nd preview, cpia, (usb-scsi) * v5.0 1999/11/22 URB Technical preview, Paul Mackerras powerbook susp/resume  * 	i386: HUB, Keyboard, Mouse, Printer  * * v4.3 1999/10/27 multiple HCs, bulk_request * v4.2 1999/09/05 ISO API alpha, new dev alloc, neg Error-codes * v4.1 1999/08/27 Randy Dunlap's - ISO API first impl. * v4.0 1999/08/18  * v3.0 1999/06/25  * v2.1 1999/05/09  code clean up * v2.0 1999/05/04  * v1.0 1999/04/27 initial release * * This file is licenced under the GPL. */ #include <linux/config.h>#include <linux/module.h>#include <linux/moduleparam.h>#include <linux/pci.h>#include <linux/kernel.h>#include <linux/delay.h>#include <linux/ioport.h>#include <linux/sched.h>#include <linux/slab.h>#include <linux/smp_lock.h>#include <linux/errno.h>#include <linux/init.h>#include <linux/timer.h>#include <linux/list.h>#include <linux/usb.h>#include <linux/usb_otg.h>#include <linux/dma-mapping.h> #include <linux/dmapool.h>#include <linux/reboot.h>#include <asm/io.h>#include <asm/irq.h>#include <asm/system.h>#include <asm/unaligned.h>#include <asm/byteorder.h>#include "../core/hcd.h"#define DRIVER_VERSION "2005 April 22"#define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"#define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"/*-------------------------------------------------------------------------*/#undef OHCI_VERBOSE_DEBUG	/* not always helpful *//* For initializing controller (mask in an HCFS mode too) */#define	OHCI_CONTROL_INIT 	OHCI_CTRL_CBSR#define	OHCI_INTR_INIT \	(OHCI_INTR_MIE | OHCI_INTR_UE | OHCI_INTR_RD | OHCI_INTR_WDH)#ifdef __hppa__/* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */#define	IR_DISABLE#endif#ifdef CONFIG_ARCH_OMAP/* OMAP doesn't support IR (no SMM; not needed) */#define	IR_DISABLE#endif/*-------------------------------------------------------------------------*/static const char	hcd_name [] = "ohci_hcd";#include "ohci.h"static void ohci_dump (struct ohci_hcd *ohci, int verbose);static int ohci_init (struct ohci_hcd *ohci);static void ohci_stop (struct usb_hcd *hcd);static int ohci_reboot (struct notifier_block *, unsigned long , void *);#include "ohci-hub.c"#include "ohci-dbg.c"#include "ohci-mem.c"#include "ohci-q.c"/* * On architectures with edge-triggered interrupts we must never return * IRQ_NONE. */#if defined(CONFIG_SA1111)  /* ... or other edge-triggered systems */#define IRQ_NOTMINE	IRQ_HANDLED#else#define IRQ_NOTMINE	IRQ_NONE#endif/* Some boards misreport power switching/overcurrent */static int distrust_firmware = 1;module_param (distrust_firmware, bool, 0);MODULE_PARM_DESC (distrust_firmware,	"true to distrust firmware power/overcurrent setup");/* Some boards leave IR set wrongly, since they fail BIOS/SMM handshakes */static int no_handshake = 0;module_param (no_handshake, bool, 0);MODULE_PARM_DESC (no_handshake, "true (not default) disables BIOS handshake");/*-------------------------------------------------------------------------*//* * queue up an urb for anything except the root hub */static int ohci_urb_enqueue (	struct usb_hcd	*hcd,	struct usb_host_endpoint *ep,	struct urb	*urb,	gfp_t		mem_flags) {	struct ohci_hcd	*ohci = hcd_to_ohci (hcd);	struct ed	*ed;	urb_priv_t	*urb_priv;	unsigned int	pipe = urb->pipe;	int		i, size = 0;	unsigned long	flags;	int		retval = 0;	#ifdef OHCI_VERBOSE_DEBUG	urb_print (urb, "SUB", usb_pipein (pipe));#endif		/* every endpoint has a ed, locate and maybe (re)initialize it */	if (! (ed = ed_get (ohci, ep, urb->dev, pipe, urb->interval)))		return -ENOMEM;	/* for the private part of the URB we need the number of TDs (size) */	switch (ed->type) {		case PIPE_CONTROL:			/* td_submit_urb() doesn't yet handle these */			if (urb->transfer_buffer_length > 4096)				return -EMSGSIZE;			/* 1 TD for setup, 1 for ACK, plus ... */			size = 2;			/* FALLTHROUGH */		// case PIPE_INTERRUPT:		// case PIPE_BULK:		default:			/* one TD for every 4096 Bytes (can be upto 8K) */			size += urb->transfer_buffer_length / 4096;			/* ... and for any remaining bytes ... */			if ((urb->transfer_buffer_length % 4096) != 0)				size++;			/* ... and maybe a zero length packet to wrap it up */			if (size == 0)				size++;			else if ((urb->transfer_flags & URB_ZERO_PACKET) != 0				&& (urb->transfer_buffer_length					% usb_maxpacket (urb->dev, pipe,						usb_pipeout (pipe))) == 0)				size++;			break;		case PIPE_ISOCHRONOUS: /* number of packets from URB */			size = urb->number_of_packets;			break;	}	/* allocate the private part of the URB */	urb_priv = kmalloc (sizeof (urb_priv_t) + size * sizeof (struct td *),			mem_flags);	if (!urb_priv)		return -ENOMEM;	memset (urb_priv, 0, sizeof (urb_priv_t) + size * sizeof (struct td *));	INIT_LIST_HEAD (&urb_priv->pending);	urb_priv->length = size;	urb_priv->ed = ed;		/* allocate the TDs (deferring hash chain updates) */	for (i = 0; i < size; i++) {		urb_priv->td [i] = td_alloc (ohci, mem_flags);		if (!urb_priv->td [i]) {			urb_priv->length = i;			urb_free_priv (ohci, urb_priv);			return -ENOMEM;		}	}		spin_lock_irqsave (&ohci->lock, flags);	/* don't submit to a dead HC */	if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {		retval = -ENODEV;		goto fail;	}	if (!HC_IS_RUNNING(hcd->state)) {		retval = -ENODEV;		goto fail;	}	/* in case of unlink-during-submit */	spin_lock (&urb->lock);	if (urb->status != -EINPROGRESS) {		spin_unlock (&urb->lock);		urb->hcpriv = urb_priv;		finish_urb (ohci, urb, NULL);		retval = 0;		goto fail;	}	/* schedule the ed if needed */	if (ed->state == ED_IDLE) {		retval = ed_schedule (ohci, ed);		if (retval < 0)			goto fail0;		if (ed->type == PIPE_ISOCHRONOUS) {			u16	frame = ohci_frame_no(ohci);			/* delay a few frames before the first TD */			frame += max_t (u16, 8, ed->interval);			frame &= ~(ed->interval - 1);			frame |= ed->branch;			urb->start_frame = frame;			/* yes, only URB_ISO_ASAP is supported, and			 * urb->start_frame is never used as input.			 */		}	} else if (ed->type == PIPE_ISOCHRONOUS)		urb->start_frame = ed->last_iso + ed->interval;	/* fill the TDs and link them to the ed; and	 * enable that part of the schedule, if needed	 * and update count of queued periodic urbs	 */	urb->hcpriv = urb_priv;	td_submit_urb (ohci, urb);fail0:	spin_unlock (&urb->lock);fail:	if (retval)		urb_free_priv (ohci, urb_priv);	spin_unlock_irqrestore (&ohci->lock, flags);	return retval;}/* * decouple the URB from the HC queues (TDs, urb_priv); it's * already marked using urb->status.  reporting is always done * asynchronously, and we might be dealing with an urb that's * partially transferred, or an ED with other urbs being unlinked. */static int ohci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb){	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);	unsigned long		flags;	#ifdef OHCI_VERBOSE_DEBUG	urb_print (urb, "UNLINK", 1);#endif		  	spin_lock_irqsave (&ohci->lock, flags); 	if (HC_IS_RUNNING(hcd->state)) {		urb_priv_t  *urb_priv;		/* Unless an IRQ completed the unlink while it was being		 * handed to us, flag it for unlink and giveback, and force		 * some upcoming INTR_SF to call finish_unlinks()		 */		urb_priv = urb->hcpriv;		if (urb_priv) {			if (urb_priv->ed->state == ED_OPER)				start_ed_unlink (ohci, urb_priv->ed);		}	} else {		/*		 * with HC dead, we won't respect hc queue pointers		 * any more ... just clean up every urb's memory.		 */		if (urb->hcpriv)			finish_urb (ohci, urb, NULL);	}	spin_unlock_irqrestore (&ohci->lock, flags);	return 0;}/*-------------------------------------------------------------------------*//* frees config/altsetting state for endpoints, * including ED memory, dummy TD, and bulk/intr data toggle */static voidohci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep){	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);	unsigned long		flags;	struct ed		*ed = ep->hcpriv;	unsigned		limit = 1000;	/* ASSERT:  any requests/urbs are being unlinked */	/* ASSERT:  nobody can be submitting urbs for this any more */	if (!ed)		return;rescan:	spin_lock_irqsave (&ohci->lock, flags);	if (!HC_IS_RUNNING (hcd->state)) {sanitize:		ed->state = ED_IDLE;		finish_unlinks (ohci, 0, NULL);	}	switch (ed->state) {	case ED_UNLINK:		/* wait for hw to finish? */		/* major IRQ delivery trouble loses INTR_SF too... */		if (limit-- == 0) {			ohci_warn (ohci, "IRQ INTR_SF lossage\n");			goto sanitize;		}		spin_unlock_irqrestore (&ohci->lock, flags);		schedule_timeout_uninterruptible(1);		goto rescan;	case ED_IDLE:		/* fully unlinked */		if (list_empty (&ed->td_list)) {			td_free (ohci, ed->dummy);			ed_free (ohci, ed);			break;		}		/* else FALL THROUGH */	default:		/* caller was supposed to have unlinked any requests;		 * that's not our job.  can't recover; must leak ed.		 */		ohci_err (ohci, "leak ed %p (#%02x) state %d%s\n",			ed, ep->desc.bEndpointAddress, ed->state,			list_empty (&ed->td_list) ? "" : " (has tds)");		td_free (ohci, ed->dummy);		break;	}	ep->hcpriv = NULL;	spin_unlock_irqrestore (&ohci->lock, flags);	return;}static int ohci_get_frame (struct usb_hcd *hcd){	struct ohci_hcd		*ohci = hcd_to_ohci (hcd);	return ohci_frame_no(ohci);}static void ohci_usb_reset (struct ohci_hcd *ohci){	ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);	ohci->hc_control &= OHCI_CTRL_RWC;	ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);}/* reboot notifier forcibly disables IRQs and DMA, helping kexec and * other cases where the next software may expect clean state from the * "firmware".  this is bus-neutral, unlike shutdown() methods. */static intohci_reboot (struct notifier_block *block, unsigned long code, void *null){	struct ohci_hcd *ohci;	ohci = container_of (block, struct ohci_hcd, reboot_notifier);	ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);	ohci_usb_reset (ohci);	/* flush the writes */	(void) ohci_readl (ohci, &ohci->regs->control);	return 0;}/*-------------------------------------------------------------------------* * HC functions *-------------------------------------------------------------------------*//* init memory, and kick BIOS/SMM off */static int ohci_init (struct ohci_hcd *ohci){	int ret;	struct usb_hcd *hcd = ohci_to_hcd(ohci);	disable (ohci);	ohci->regs = hcd->regs;	ohci->next_statechange = jiffies;	/* REVISIT this BIOS handshake is now moved into PCI "quirks", and	 * was never needed for most non-PCI systems ... remove the code?	 */#ifndef IR_DISABLE	/* SMM owns the HC?  not for long! */	if (!no_handshake && ohci_readl (ohci,					&ohci->regs->control) & OHCI_CTRL_IR) {		u32 temp;		ohci_dbg (ohci, "USB HC TakeOver from BIOS/SMM\n");		/* this timeout is arbitrary.  we make it long, so systems		 * depending on usb keyboards may be usable even if the		 * BIOS/SMM code seems pretty broken.		 */