[GitHub/mt8127/android_kernel_alcatel_ttab.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__

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

/*
 * USB Packet IDs (PIDs)
 */
#define USB_PID_UNDEF_0			0xf0
#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;

	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_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	(*suspend) (struct usb_hcd *hcd, pm_message_t message);

	/* called after entering D0 (etc), before resuming the hub */
	int	(*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 usb_host_endpoint *ep,
					struct urb *urb,
					gfp_t mem_flags);
	int	(*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);

	/* 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);
	void		(*hub_irq_enable)(struct usb_hcd *);
		/* Needed only if port-change IRQs are level-triggered */
};

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);
extern void usb_hcd_endpoint_disable (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);
	/* 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)
{
	if (bus->monitored)
		(*mon_ops->urb_complete)(bus, urb);
}

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) {}

#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"))


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