[deliverable/linux.git] / drivers / usb / core / hcd.h

/*
 * Copyright (c) 2001-2002 by David Brownell
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */


#ifdef __KERNEL__

#include <linux/rwsem.h>

/* This file contains declarations of usbcore internals that are mostly
 * used or exposed by Host Controller Drivers.
 */

/*
 * USB Packet IDs (PIDs)
 */
#define USB_PID_EXT			0xf0	/* USB 2.0 LPM ECN */
#define USB_PID_OUT			0xe1
#define USB_PID_ACK			0xd2
#define USB_PID_DATA0			0xc3
#define USB_PID_PING			0xb4	/* USB 2.0 */
#define USB_PID_SOF			0xa5
#define USB_PID_NYET			0x96	/* USB 2.0 */
#define USB_PID_DATA2			0x87	/* USB 2.0 */
#define USB_PID_SPLIT			0x78	/* USB 2.0 */
#define USB_PID_IN			0x69
#define USB_PID_NAK			0x5a
#define USB_PID_DATA1			0x4b
#define USB_PID_PREAMBLE		0x3c	/* Token mode */
#define USB_PID_ERR			0x3c	/* USB 2.0: handshake mode */
#define USB_PID_SETUP			0x2d
#define USB_PID_STALL			0x1e
#define USB_PID_MDATA			0x0f	/* USB 2.0 */

/*-------------------------------------------------------------------------*/

/*
 * USB Host Controller Driver (usb_hcd) framework
 *
 * Since "struct usb_bus" is so thin, you can't share much code in it.
 * This framework is a layer over that, and should be more sharable.
 *
 * @authorized_default: Specifies if new devices are authorized to
 *                      connect by default or they require explicit
 *                      user space authorization; this bit is settable
 *                      through /sys/class/usb_host/X/authorized_default.
 *                      For the rest is RO, so we don't lock to r/w it.
 */

/*-------------------------------------------------------------------------*/

struct usb_hcd {

	/*
	 * housekeeping
	 */
	struct usb_bus		self;		/* hcd is-a bus */
	struct kref		kref;		/* reference counter */

	const char		*product_desc;	/* product/vendor string */
	char			irq_descr[24];	/* driver + bus # */

	struct timer_list	rh_timer;	/* drives root-hub polling */
	struct urb		*status_urb;	/* the current status urb */
#ifdef CONFIG_PM
	struct work_struct	wakeup_work;	/* for remote wakeup */
#endif

	/*
	 * hardware info/state
	 */
	const struct hc_driver	*driver;	/* hw-specific hooks */

	/* Flags that need to be manipulated atomically */
	unsigned long		flags;
#define HCD_FLAG_HW_ACCESSIBLE	0x00000001
#define HCD_FLAG_SAW_IRQ	0x00000002

	unsigned		rh_registered:1;/* is root hub registered? */

	/* The next flag is a stopgap, to be removed when all the HCDs
	 * support the new root-hub polling mechanism. */
	unsigned		uses_new_polling:1;
	unsigned		poll_rh:1;	/* poll for rh status? */
	unsigned		poll_pending:1;	/* status has changed? */
	unsigned		wireless:1;	/* Wireless USB HCD */
	unsigned		authorized_default:1;
	unsigned		has_tt:1;	/* Integrated TT in root hub */

	int			irq;		/* irq allocated */
	void __iomem		*regs;		/* device memory/io */
	u64			rsrc_start;	/* memory/io resource start */
	u64			rsrc_len;	/* memory/io resource length */
	unsigned		power_budget;	/* in mA, 0 = no limit */

#define HCD_BUFFER_POOLS	4
	struct dma_pool		*pool [HCD_BUFFER_POOLS];

	int			state;
#	define	__ACTIVE		0x01
#	define	__SUSPEND		0x04
#	define	__TRANSIENT		0x80

#	define	HC_STATE_HALT		0
#	define	HC_STATE_RUNNING	(__ACTIVE)
#	define	HC_STATE_QUIESCING	(__SUSPEND|__TRANSIENT|__ACTIVE)
#	define	HC_STATE_RESUMING	(__SUSPEND|__TRANSIENT)
#	define	HC_STATE_SUSPENDED	(__SUSPEND)

#define	HC_IS_RUNNING(state) ((state) & __ACTIVE)
#define	HC_IS_SUSPENDED(state) ((state) & __SUSPEND)

	/* more shared queuing code would be good; it should support
	 * smarter scheduling, handle transaction translators, etc;
	 * input size of periodic table to an interrupt scheduler.
	 * (ohci 32, uhci 1024, ehci 256/512/1024).
	 */

	/* The HC driver's private data is stored at the end of
	 * this structure.
	 */
	unsigned long hcd_priv[0]
			__attribute__ ((aligned(sizeof(unsigned long))));
};

/* 2.4 does this a bit differently ... */
static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
{
	return &hcd->self;
}

static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
{
	return container_of(bus, struct usb_hcd, self);
}

struct hcd_timeout {	/* timeouts we allocate */
	struct list_head	timeout_list;
	struct timer_list	timer;
};

/*-------------------------------------------------------------------------*/


struct hc_driver {
	const char	*description;	/* "ehci-hcd" etc */
	const char	*product_desc;	/* product/vendor string */
	size_t		hcd_priv_size;	/* size of private data */

	/* irq handler */
	irqreturn_t	(*irq) (struct usb_hcd *hcd);

	int	flags;
#define	HCD_MEMORY	0x0001		/* HC regs use memory (else I/O) */
#define	HCD_LOCAL_MEM	0x0002		/* HC needs local memory */
#define	HCD_USB11	0x0010		/* USB 1.1 */
#define	HCD_USB2	0x0020		/* USB 2.0 */

	/* called to init HCD and root hub */
	int	(*reset) (struct usb_hcd *hcd);
	int	(*start) (struct usb_hcd *hcd);

	/* NOTE:  these suspend/resume calls relate to the HC as
	 * a whole, not just the root hub; they're for PCI bus glue.
	 */
	/* called after suspending the hub, before entering D3 etc */
	int	(*pci_suspend) (struct usb_hcd *hcd, pm_message_t message);

	/* called after entering D0 (etc), before resuming the hub */
	int	(*pci_resume) (struct usb_hcd *hcd);

	/* cleanly make HCD stop writing memory and doing I/O */
	void	(*stop) (struct usb_hcd *hcd);

	/* shutdown HCD */
	void	(*shutdown) (struct usb_hcd *hcd);

	/* return current frame number */
	int	(*get_frame_number) (struct usb_hcd *hcd);

	/* manage i/o requests, device state */
	int	(*urb_enqueue)(struct usb_hcd *hcd,
				struct urb *urb, gfp_t mem_flags);
	int	(*urb_dequeue)(struct usb_hcd *hcd,
				struct urb *urb, int status);

	/* hw synch, freeing endpoint resources that urb_dequeue can't */
	void 	(*endpoint_disable)(struct usb_hcd *hcd,
			struct usb_host_endpoint *ep);

	/* root hub support */
	int	(*hub_status_data) (struct usb_hcd *hcd, char *buf);
	int	(*hub_control) (struct usb_hcd *hcd,
				u16 typeReq, u16 wValue, u16 wIndex,
				char *buf, u16 wLength);
	int	(*bus_suspend)(struct usb_hcd *);
	int	(*bus_resume)(struct usb_hcd *);
	int	(*start_port_reset)(struct usb_hcd *, unsigned port_num);

		/* force handover of high-speed port to full-speed companion */
	void	(*relinquish_port)(struct usb_hcd *, int);
};

extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
		int status);
extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);

extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
extern int usb_hcd_unlink_urb(struct urb *urb, int status);
extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
		int status);
extern void usb_hcd_flush_endpoint(struct usb_device *udev,
		struct usb_host_endpoint *ep);
extern void usb_hcd_disable_endpoint(struct usb_device *udev,
		struct usb_host_endpoint *ep);
extern int usb_hcd_get_frame_number(struct usb_device *udev);

extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
		struct device *dev, char *bus_name);
extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
extern void usb_put_hcd(struct usb_hcd *hcd);
extern int usb_add_hcd(struct usb_hcd *hcd,
		unsigned int irqnum, unsigned long irqflags);
extern void usb_remove_hcd(struct usb_hcd *hcd);

struct platform_device;
extern void usb_hcd_platform_shutdown(struct platform_device *dev);

#ifdef CONFIG_PCI
struct pci_dev;
struct pci_device_id;
extern int usb_hcd_pci_probe(struct pci_dev *dev,
				const struct pci_device_id *id);
extern void usb_hcd_pci_remove(struct pci_dev *dev);

#ifdef CONFIG_PM
extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t state);
extern int usb_hcd_pci_resume(struct pci_dev *dev);
#endif /* CONFIG_PM */

extern void usb_hcd_pci_shutdown(struct pci_dev *dev);

#endif /* CONFIG_PCI */

/* pci-ish (pdev null is ok) buffer alloc/mapping support */
int hcd_buffer_create(struct usb_hcd *hcd);
void hcd_buffer_destroy(struct usb_hcd *hcd);

void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
	gfp_t mem_flags, dma_addr_t *dma);
void hcd_buffer_free(struct usb_bus *bus, size_t size,
	void *addr, dma_addr_t dma);

/* generic bus glue, needed for host controllers that don't use PCI */
extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);

extern void usb_hc_died(struct usb_hcd *hcd);
extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);

/* -------------------------------------------------------------------------- */

/* Enumeration is only for the hub driver, or HCD virtual root hubs */
extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
					struct usb_bus *, unsigned port);
extern int usb_new_device(struct usb_device *dev);
extern void usb_disconnect(struct usb_device **);

extern int usb_get_configuration(struct usb_device *dev);
extern void usb_destroy_configuration(struct usb_device *dev);

/*-------------------------------------------------------------------------*/

/*
 * HCD Root Hub support
 */

#include "hub.h"

/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
#define DeviceRequest \
	((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
#define DeviceOutRequest \
	((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)

#define InterfaceRequest \
	((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)

#define EndpointRequest \
	((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
#define EndpointOutRequest \
	((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)

/* class requests from the USB 2.0 hub spec, table 11-15 */
/* GetBusState and SetHubDescriptor are optional, omitted */
#define ClearHubFeature		(0x2000 | USB_REQ_CLEAR_FEATURE)
#define ClearPortFeature	(0x2300 | USB_REQ_CLEAR_FEATURE)
#define GetHubDescriptor	(0xa000 | USB_REQ_GET_DESCRIPTOR)
#define GetHubStatus		(0xa000 | USB_REQ_GET_STATUS)
#define GetPortStatus		(0xa300 | USB_REQ_GET_STATUS)
#define SetHubFeature		(0x2000 | USB_REQ_SET_FEATURE)
#define SetPortFeature		(0x2300 | USB_REQ_SET_FEATURE)


/*-------------------------------------------------------------------------*/

/*
 * Generic bandwidth allocation constants/support
 */
#define FRAME_TIME_USECS	1000L
#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
		/* Trying not to use worst-case bit-stuffing
		 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
		/* bytecount = data payload byte count */

#define NS_TO_US(ns)	((ns + 500L) / 1000L)
			/* convert & round nanoseconds to microseconds */


/*
 * Full/low speed bandwidth allocation constants/support.
 */
#define BW_HOST_DELAY	1000L		/* nanoseconds */
#define BW_HUB_LS_SETUP	333L		/* nanoseconds */
			/* 4 full-speed bit times (est.) */

#define FRAME_TIME_BITS			12000L	/* frame = 1 millisecond */
#define FRAME_TIME_MAX_BITS_ALLOC	(90L * FRAME_TIME_BITS / 100L)
#define FRAME_TIME_MAX_USECS_ALLOC	(90L * FRAME_TIME_USECS / 100L)

/*
 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 * to preallocate bandwidth)
 */
#define USB2_HOST_DELAY	5	/* nsec, guess */
#define HS_NSECS(bytes) (((55 * 8 * 2083) \
	+ (2083UL * (3 + BitTime(bytes))))/1000 \
	+ USB2_HOST_DELAY)
#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
	+ (2083UL * (3 + BitTime(bytes))))/1000 \
	+ USB2_HOST_DELAY)
#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))

extern long usb_calc_bus_time(int speed, int is_input,
			int isoc, int bytecount);

/*-------------------------------------------------------------------------*/

extern void usb_set_device_state(struct usb_device *udev,
		enum usb_device_state new_state);

/*-------------------------------------------------------------------------*/

/* exported only within usbcore */

extern struct list_head usb_bus_list;
extern struct mutex usb_bus_list_lock;
extern wait_queue_head_t usb_kill_urb_queue;

extern void usb_enable_root_hub_irq(struct usb_bus *bus);

extern int usb_find_interface_driver(struct usb_device *dev,
	struct usb_interface *interface);

#define usb_endpoint_out(ep_dir)	(!((ep_dir) & USB_DIR_IN))

#ifdef CONFIG_PM
extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
extern void usb_root_hub_lost_power(struct usb_device *rhdev);
extern int hcd_bus_suspend(struct usb_device *rhdev);
extern int hcd_bus_resume(struct usb_device *rhdev);
#else
static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
{
	return;
}
#endif /* CONFIG_PM */

/*
 * USB device fs stuff
 */

#ifdef CONFIG_USB_DEVICEFS

/*
 * these are expected to be called from the USB core/hub thread
 * with the kernel lock held
 */
extern void usbfs_update_special(void);
extern int usbfs_init(void);
extern void usbfs_cleanup(void);

#else /* CONFIG_USB_DEVICEFS */

static inline void usbfs_update_special(void) {}
static inline int usbfs_init(void) { return 0; }
static inline void usbfs_cleanup(void) { }

#endif /* CONFIG_USB_DEVICEFS */

/*-------------------------------------------------------------------------*/

#if defined(CONFIG_USB_MON)

struct usb_mon_operations {
	void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
	void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
	void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
	/* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
};

extern struct usb_mon_operations *mon_ops;

static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
{
	if (bus->monitored)
		(*mon_ops->urb_submit)(bus, urb);
}

static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
    int error)
{
	if (bus->monitored)
		(*mon_ops->urb_submit_error)(bus, urb, error);
}

static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
		int status)
{
	if (bus->monitored)
		(*mon_ops->urb_complete)(bus, urb, status);
}

int usb_mon_register(struct usb_mon_operations *ops);
void usb_mon_deregister(void);

#else

static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
    int error) {}
static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
		int status) {}

#endif /* CONFIG_USB_MON */

/*-------------------------------------------------------------------------*/

/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
#define bitmap 	DeviceRemovable


/*-------------------------------------------------------------------------*/

/* random stuff */

#define	RUN_CONTEXT (in_irq() ? "in_irq" \
		: (in_interrupt() ? "in_interrupt" : "can sleep"))


/* This rwsem is for use only by the hub driver and ehci-hcd.
 * Nobody else should touch it.
 */
extern struct rw_semaphore ehci_cf_port_reset_rwsem;

#endif /* __KERNEL__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (c) 2001-2002 by David Brownell
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License as published by the
	6	* Free Software Foundation; either version 2 of the License, or (at your
	7	* option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful, but
	10	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
	11	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	12	* for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software Foundation,
	16	* Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	17	*/
	18
	19
	20	#ifdef __KERNEL__
	21
32fe0198 AS	22	#include <linux/rwsem.h>
32fe0198 AS	23
1da177e4 LT	24	/* This file contains declarations of usbcore internals that are mostly
	25	* used or exposed by Host Controller Drivers.
	26	*/
	27
	28	/*
	29	* USB Packet IDs (PIDs)
	30	*/
dbe0dbb7	31	#define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
1da177e4 LT	32	#define USB_PID_OUT 0xe1
	33	#define USB_PID_ACK 0xd2
	34	#define USB_PID_DATA0 0xc3
	35	#define USB_PID_PING 0xb4 /* USB 2.0 */
	36	#define USB_PID_SOF 0xa5
	37	#define USB_PID_NYET 0x96 /* USB 2.0 */
	38	#define USB_PID_DATA2 0x87 /* USB 2.0 */
	39	#define USB_PID_SPLIT 0x78 /* USB 2.0 */
	40	#define USB_PID_IN 0x69
	41	#define USB_PID_NAK 0x5a
	42	#define USB_PID_DATA1 0x4b
	43	#define USB_PID_PREAMBLE 0x3c /* Token mode */
	44	#define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
	45	#define USB_PID_SETUP 0x2d
	46	#define USB_PID_STALL 0x1e
	47	#define USB_PID_MDATA 0x0f /* USB 2.0 */
	48
	49	/-------------------------------------------------------------------------/
	50
	51	/*
	52	* USB Host Controller Driver (usb_hcd) framework
	53	*
	54	* Since "struct usb_bus" is so thin, you can't share much code in it.
	55	* This framework is a layer over that, and should be more sharable.
5234ce1b IPG	56	*
	57	* @authorized_default: Specifies if new devices are authorized to
	58	* connect by default or they require explicit
	59	* user space authorization; this bit is settable
	60	* through /sys/class/usb_host/X/authorized_default.
	61	* For the rest is RO, so we don't lock to r/w it.
1da177e4 LT	62	*/
	63
	64	/-------------------------------------------------------------------------/
	65
17200583	66	struct usb_hcd {
1da177e4 LT	67
	68	/*
	69	* housekeeping
	70	*/
	71	struct usb_bus self; /* hcd is-a bus */
17200583	72	struct kref kref; /* reference counter */
1da177e4 LT	73
	74	const char product_desc; / product/vendor string */
	75	char irq_descr[24]; /* driver + bus # */
	76
d5926ae7 AS	77	struct timer_list rh_timer; /* drives root-hub polling */
d5926ae7 AS	78	struct urb status_urb; / the current status urb */
6b157c9b AS	79	#ifdef CONFIG_PM
	80	struct work_struct wakeup_work; /* for remote wakeup */
	81	#endif
1da177e4 LT	82
	83	/*
	84	* hardware info/state
	85	*/
	86	const struct hc_driver driver; / hw-specific hooks */
8de98402 BH	87
	88	/* Flags that need to be manipulated atomically */
	89	unsigned long flags;
	90	#define HCD_FLAG_HW_ACCESSIBLE 0x00000001
	91	#define HCD_FLAG_SAW_IRQ 0x00000002
	92
1da177e4 LT	93	unsigned rh_registered:1;/* is root hub registered? */
1da177e4 LT	94
d5926ae7 AS	95	/* The next flag is a stopgap, to be removed when all the HCDs
	96	* support the new root-hub polling mechanism. */
	97	unsigned uses_new_polling:1;
	98	unsigned poll_rh:1; /* poll for rh status? */
	99	unsigned poll_pending:1; /* status has changed? */
0165de09	100	unsigned wireless:1; /* Wireless USB HCD */
5234ce1b	101	unsigned authorized_default:1;
7329e211	102	unsigned has_tt:1; /* Integrated TT in root hub */
d5926ae7	103
1da177e4 LT	104	int irq; /* irq allocated */
	105	void __iomem regs; / device memory/io */
	106	u64 rsrc_start; /* memory/io resource start */
	107	u64 rsrc_len; /* memory/io resource length */
7d35b929	108	unsigned power_budget; /* in mA, 0 = no limit */
1da177e4 LT	109
	110	#define HCD_BUFFER_POOLS 4
	111	struct dma_pool *pool [HCD_BUFFER_POOLS];
	112
	113	int state;
	114	# define __ACTIVE 0x01
	115	# define __SUSPEND 0x04
	116	# define __TRANSIENT 0x80
	117
	118	# define HC_STATE_HALT 0
	119	# define HC_STATE_RUNNING (__ACTIVE)
	120	# define HC_STATE_QUIESCING (__SUSPEND\|__TRANSIENT\|__ACTIVE)
	121	# define HC_STATE_RESUMING (__SUSPEND\|__TRANSIENT)
	122	# define HC_STATE_SUSPENDED (__SUSPEND)
	123
	124	#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
	125	#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
	126
	127	/* more shared queuing code would be good; it should support
	128	* smarter scheduling, handle transaction translators, etc;
84cca820	129	* input size of periodic table to an interrupt scheduler.
1da177e4 LT	130	* (ohci 32, uhci 1024, ehci 256/512/1024).
	131	*/
	132
	133	/* The HC driver's private data is stored at the end of
	134	* this structure.
	135	*/
	136	unsigned long hcd_priv[0]
84cca820	137	__attribute__ ((aligned(sizeof(unsigned long))));
1da177e4 LT	138	};
	139
	140	/* 2.4 does this a bit differently ... */
84cca820	141	static inline struct usb_bus hcd_to_bus(struct usb_hcd hcd)
1da177e4 LT	142	{
	143	return &hcd->self;
	144	}
	145
84cca820	146	static inline struct usb_hcd bus_to_hcd(struct usb_bus bus)
17200583 AS	147	{
	148	return container_of(bus, struct usb_hcd, self);
	149	}
1da177e4 LT	150
	151	struct hcd_timeout { /* timeouts we allocate */
	152	struct list_head timeout_list;
	153	struct timer_list timer;
	154	};
	155
	156	/-------------------------------------------------------------------------/
	157
1da177e4	158
1da177e4 LT	159	struct hc_driver {
	160	const char description; / "ehci-hcd" etc */
	161	const char product_desc; / product/vendor string */
	162	size_t hcd_priv_size; /* size of private data */
	163
	164	/* irq handler */
7d12e780	165	irqreturn_t (irq) (struct usb_hcd hcd);
1da177e4 LT	166
	167	int flags;
	168	#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
b3476675	169	#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
1da177e4 LT	170	#define HCD_USB11 0x0010 /* USB 1.1 */
	171	#define HCD_USB2 0x0020 /* USB 2.0 */
	172
	173	/* called to init HCD and root hub */
	174	int (reset) (struct usb_hcd hcd);
	175	int (start) (struct usb_hcd hcd);
	176
	177	/* NOTE: these suspend/resume calls relate to the HC as
5f827ea3	178	* a whole, not just the root hub; they're for PCI bus glue.
1da177e4	179	*/
5f827ea3	180	/* called after suspending the hub, before entering D3 etc */
7be7d741	181	int (pci_suspend) (struct usb_hcd hcd, pm_message_t message);
1da177e4	182
5f827ea3	183	/* called after entering D0 (etc), before resuming the hub */
7be7d741	184	int (pci_resume) (struct usb_hcd hcd);
1da177e4 LT	185
	186	/* cleanly make HCD stop writing memory and doing I/O */
	187	void (stop) (struct usb_hcd hcd);
	188
64a21d02 AG	189	/* shutdown HCD */
	190	void (shutdown) (struct usb_hcd hcd);
	191
1da177e4 LT	192	/* return current frame number */
	193	int (get_frame_number) (struct usb_hcd hcd);
	194
	195	/* manage i/o requests, device state */
e9df41c5 AS	196	int (urb_enqueue)(struct usb_hcd hcd,
	197	struct urb *urb, gfp_t mem_flags);
	198	int (urb_dequeue)(struct usb_hcd hcd,
	199	struct urb *urb, int status);
1da177e4 LT	200
	201	/* hw synch, freeing endpoint resources that urb_dequeue can't */
	202	void (endpoint_disable)(struct usb_hcd hcd,
	203	struct usb_host_endpoint *ep);
	204
	205	/* root hub support */
84cca820 GKH	206	int (hub_status_data) (struct usb_hcd hcd, char *buf);
84cca820 GKH	207	int (hub_control) (struct usb_hcd hcd,
1da177e4 LT	208	u16 typeReq, u16 wValue, u16 wIndex,
1da177e4 LT	209	char *buf, u16 wLength);
84cca820 GKH	210	int (bus_suspend)(struct usb_hcd );
	211	int (bus_resume)(struct usb_hcd );
	212	int (start_port_reset)(struct usb_hcd , unsigned port_num);
90da096e BR	213
90da096e BR	214	/* force handover of high-speed port to full-speed companion */
84cca820	215	void (relinquish_port)(struct usb_hcd , int);
1da177e4 LT	216	};
1da177e4 LT	217
e9df41c5 AS	218	extern int usb_hcd_link_urb_to_ep(struct usb_hcd hcd, struct urb urb);
	219	extern int usb_hcd_check_unlink_urb(struct usb_hcd hcd, struct urb urb,
	220	int status);
	221	extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd hcd, struct urb urb);
	222
84cca820 GKH	223	extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
84cca820 GKH	224	extern int usb_hcd_unlink_urb(struct urb *urb, int status);
4a00027d AS	225	extern void usb_hcd_giveback_urb(struct usb_hcd hcd, struct urb urb,
4a00027d AS	226	int status);
95cf82f9 AS	227	extern void usb_hcd_flush_endpoint(struct usb_device *udev,
	228	struct usb_host_endpoint *ep);
	229	extern void usb_hcd_disable_endpoint(struct usb_device *udev,
a6d2bb9f	230	struct usb_host_endpoint *ep);
84cca820	231	extern int usb_hcd_get_frame_number(struct usb_device *udev);
1da177e4	232
84cca820	233	extern struct usb_hcd usb_create_hcd(const struct hc_driver driver,
1da177e4	234	struct device dev, char bus_name);
84cca820 GKH	235	extern struct usb_hcd usb_get_hcd(struct usb_hcd hcd);
84cca820 GKH	236	extern void usb_put_hcd(struct usb_hcd *hcd);
1da177e4 LT	237	extern int usb_add_hcd(struct usb_hcd *hcd,
	238	unsigned int irqnum, unsigned long irqflags);
	239	extern void usb_remove_hcd(struct usb_hcd *hcd);
	240
64a21d02	241	struct platform_device;
84cca820	242	extern void usb_hcd_platform_shutdown(struct platform_device *dev);
64a21d02	243
1da177e4 LT	244	#ifdef CONFIG_PCI
	245	struct pci_dev;
	246	struct pci_device_id;
84cca820	247	extern int usb_hcd_pci_probe(struct pci_dev *dev,
1da177e4	248	const struct pci_device_id *id);
84cca820	249	extern void usb_hcd_pci_remove(struct pci_dev *dev);
1da177e4 LT	250
1da177e4 LT	251	#ifdef CONFIG_PM
84cca820 GKH	252	extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t state);
84cca820 GKH	253	extern int usb_hcd_pci_resume(struct pci_dev *dev);
1da177e4 LT	254	#endif /* CONFIG_PM */
1da177e4 LT	255
84cca820	256	extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
64a21d02	257
1da177e4 LT	258	#endif /* CONFIG_PCI */
	259
	260	/* pci-ish (pdev null is ok) buffer alloc/mapping support */
84cca820 GKH	261	int hcd_buffer_create(struct usb_hcd *hcd);
84cca820 GKH	262	void hcd_buffer_destroy(struct usb_hcd *hcd);
1da177e4	263
84cca820	264	void hcd_buffer_alloc(struct usb_bus bus, size_t size,
55016f10	265	gfp_t mem_flags, dma_addr_t *dma);
84cca820	266	void hcd_buffer_free(struct usb_bus *bus, size_t size,
1da177e4 LT	267	void *addr, dma_addr_t dma);
	268
	269	/* generic bus glue, needed for host controllers that don't use PCI */
84cca820	270	extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
d5926ae7	271
84cca820	272	extern void usb_hc_died(struct usb_hcd *hcd);
d5926ae7	273	extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
1da177e4 LT	274
	275	/* -------------------------------------------------------------------------- */
	276
	277	/* Enumeration is only for the hub driver, or HCD virtual root hubs */
	278	extern struct usb_device usb_alloc_dev(struct usb_device parent,
	279	struct usb_bus *, unsigned port);
	280	extern int usb_new_device(struct usb_device *dev);
	281	extern void usb_disconnect(struct usb_device **);
	282
	283	extern int usb_get_configuration(struct usb_device *dev);
	284	extern void usb_destroy_configuration(struct usb_device *dev);
	285
	286	/-------------------------------------------------------------------------/
	287
	288	/*
	289	* HCD Root Hub support
	290	*/
	291
	292	#include "hub.h"
	293
	294	/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
	295	#define DeviceRequest \
	296	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	297	#define DeviceOutRequest \
	298	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_DEVICE)<<8)
	299
	300	#define InterfaceRequest \
	301	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	302
	303	#define EndpointRequest \
	304	((USB_DIR_IN\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	305	#define EndpointOutRequest \
	306	((USB_DIR_OUT\|USB_TYPE_STANDARD\|USB_RECIP_INTERFACE)<<8)
	307
	308	/* class requests from the USB 2.0 hub spec, table 11-15 */
	309	/* GetBusState and SetHubDescriptor are optional, omitted */
	310	#define ClearHubFeature (0x2000 \| USB_REQ_CLEAR_FEATURE)
	311	#define ClearPortFeature (0x2300 \| USB_REQ_CLEAR_FEATURE)
	312	#define GetHubDescriptor (0xa000 \| USB_REQ_GET_DESCRIPTOR)
	313	#define GetHubStatus (0xa000 \| USB_REQ_GET_STATUS)
	314	#define GetPortStatus (0xa300 \| USB_REQ_GET_STATUS)
	315	#define SetHubFeature (0x2000 \| USB_REQ_SET_FEATURE)
	316	#define SetPortFeature (0x2300 \| USB_REQ_SET_FEATURE)
	317
	318
	319	/-------------------------------------------------------------------------/
	320
	321	/*
	322	* Generic bandwidth allocation constants/support
	323	*/
	324	#define FRAME_TIME_USECS 1000L
84cca820	325	#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
1da177e4	326	/* Trying not to use worst-case bit-stuffing
84cca820	327	* of (7/6 * 8 * bytecount) = 9.33 * bytecount */
1da177e4 LT	328	/* bytecount = data payload byte count */
	329
	330	#define NS_TO_US(ns) ((ns + 500L) / 1000L)
	331	/* convert & round nanoseconds to microseconds */
	332
1da177e4 LT	333
	334	/*
	335	* Full/low speed bandwidth allocation constants/support.
	336	*/
	337	#define BW_HOST_DELAY 1000L /* nanoseconds */
	338	#define BW_HUB_LS_SETUP 333L /* nanoseconds */
84cca820	339	/* 4 full-speed bit times (est.) */
1da177e4	340
84cca820	341	#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
1da177e4 LT	342	#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
	343	#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
	344
1da177e4	345	/*
498f78e6	346	* Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
1da177e4 LT	347	* ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
	348	* to preallocate bandwidth)
	349	*/
	350	#define USB2_HOST_DELAY 5 /* nsec, guess */
84cca820	351	#define HS_NSECS(bytes) (((55 * 8 * 2083) \
f956e7cd	352	+ (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4	353	+ USB2_HOST_DELAY)
84cca820	354	#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
f956e7cd	355	+ (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4	356	+ USB2_HOST_DELAY)
498f78e6 DS	357	#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
498f78e6 DS	358	#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
1da177e4	359
84cca820	360	extern long usb_calc_bus_time(int speed, int is_input,
1da177e4 LT	361	int isoc, int bytecount);
	362
	363	/-------------------------------------------------------------------------/
	364
1da177e4 LT	365	extern void usb_set_device_state(struct usb_device *udev,
	366	enum usb_device_state new_state);
	367
	368	/-------------------------------------------------------------------------/
	369
	370	/* exported only within usbcore */
	371
	372	extern struct list_head usb_bus_list;
4186ecf8	373	extern struct mutex usb_bus_list_lock;
1da177e4 LT	374	extern wait_queue_head_t usb_kill_urb_queue;
1da177e4 LT	375
84cca820	376	extern void usb_enable_root_hub_irq(struct usb_bus *bus);
d5926ae7	377
84cca820	378	extern int usb_find_interface_driver(struct usb_device *dev,
1da177e4 LT	379	struct usb_interface *interface);
	380
	381	#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
	382
0c0382e3	383	#ifdef CONFIG_PM
84cca820 GKH	384	extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
84cca820 GKH	385	extern void usb_root_hub_lost_power(struct usb_device *rhdev);
686314cf AS	386	extern int hcd_bus_suspend(struct usb_device *rhdev);
686314cf AS	387	extern int hcd_bus_resume(struct usb_device *rhdev);
0c0382e3	388	#else
db2d55b7 AM	389	static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
	390	{
	391	return;
	392	}
0c0382e3 AS	393	#endif /* CONFIG_PM */
0c0382e3 AS	394
1da177e4 LT	395	/*
	396	* USB device fs stuff
	397	*/
	398
	399	#ifdef CONFIG_USB_DEVICEFS
	400
	401	/*
	402	* these are expected to be called from the USB core/hub thread
	403	* with the kernel lock held
	404	*/
84cca820	405	extern void usbfs_update_special(void);
1da177e4 LT	406	extern int usbfs_init(void);
	407	extern void usbfs_cleanup(void);
	408
	409	#else /* CONFIG_USB_DEVICEFS */
	410
84cca820	411	static inline void usbfs_update_special(void) {}
1da177e4 LT	412	static inline int usbfs_init(void) { return 0; }
	413	static inline void usbfs_cleanup(void) { }
	414
	415	#endif /* CONFIG_USB_DEVICEFS */
	416
	417	/-------------------------------------------------------------------------/
	418
4749f32d	419	#if defined(CONFIG_USB_MON)
1da177e4 LT	420
	421	struct usb_mon_operations {
	422	void (urb_submit)(struct usb_bus bus, struct urb *urb);
	423	void (urb_submit_error)(struct usb_bus bus, struct urb *urb, int err);
9347d51c	424	void (urb_complete)(struct usb_bus bus, struct urb *urb, int status);
1da177e4	425	/* void (urb_unlink)(struct usb_bus bus, struct urb urb); /
1da177e4 LT	426	};
	427
	428	extern struct usb_mon_operations *mon_ops;
	429
	430	static inline void usbmon_urb_submit(struct usb_bus bus, struct urb urb)
	431	{
	432	if (bus->monitored)
	433	(*mon_ops->urb_submit)(bus, urb);
	434	}
	435
	436	static inline void usbmon_urb_submit_error(struct usb_bus bus, struct urb urb,
	437	int error)
	438	{
	439	if (bus->monitored)
	440	(*mon_ops->urb_submit_error)(bus, urb, error);
	441	}
	442
9347d51c AS	443	static inline void usbmon_urb_complete(struct usb_bus bus, struct urb urb,
9347d51c AS	444	int status)
1da177e4 LT	445	{
1da177e4 LT	446	if (bus->monitored)
9347d51c	447	(*mon_ops->urb_complete)(bus, urb, status);
1da177e4	448	}
1da177e4 LT	449
	450	int usb_mon_register(struct usb_mon_operations *ops);
	451	void usb_mon_deregister(void);
	452
	453	#else
	454
	455	static inline void usbmon_urb_submit(struct usb_bus bus, struct urb urb) {}
	456	static inline void usbmon_urb_submit_error(struct usb_bus bus, struct urb urb,
	457	int error) {}
9347d51c AS	458	static inline void usbmon_urb_complete(struct usb_bus bus, struct urb urb,
9347d51c AS	459	int status) {}
1da177e4 LT	460
	461	#endif /* CONFIG_USB_MON */
	462
	463	/-------------------------------------------------------------------------/
	464
	465	/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
84cca820	466	/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
1da177e4 LT	467	#define bitmap DeviceRemovable
	468
	469
	470	/-------------------------------------------------------------------------/
	471
	472	/* random stuff */
	473
84cca820 GKH	474	#define RUN_CONTEXT (in_irq() ? "in_irq" \
84cca820 GKH	475	: (in_interrupt() ? "in_interrupt" : "can sleep"))
1da177e4 LT	476
1da177e4 LT	477
32fe0198 AS	478	/* This rwsem is for use only by the hub driver and ehci-hcd.
	479	* Nobody else should touch it.
	480	*/
	481	extern struct rw_semaphore ehci_cf_port_reset_rwsem;
1da177e4	482
32fe0198	483	#endif /* __KERNEL__ */