[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__

/* 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.
 */

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

struct usb_hcd {	/* usb_bus.hcpriv points to this */

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

	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 */

	/*
	 * 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? */

	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;
}


// urb.hcpriv is really hardware-specific

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

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

/*
 * FIXME usb_operations should vanish or become hc_driver,
 * when usb_bus and usb_hcd become the same thing.
 */

struct usb_operations {
	int (*get_frame_number) (struct usb_device *usb_dev);
	int (*submit_urb) (struct urb *urb, gfp_t mem_flags);
	int (*unlink_urb) (struct urb *urb, int status);

	/* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
	void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
			gfp_t mem_flags,
			dma_addr_t *dma);
	void (*buffer_free)(struct usb_bus *bus, size_t size,
			void *addr, dma_addr_t dma);

	void (*disable)(struct usb_device *udev,
			struct usb_host_endpoint *ep);
};

/* each driver provides one of these, and hardware init support */

struct pt_regs;

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, struct pt_regs *regs);

	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 void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);

extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
		struct device *dev, char *bus_name);
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, struct pt_regs *r);

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 */

extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
		int bustime, int isoc);
extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
		int isoc);

/*
 * 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)

extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);

/*
 * 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 struct usb_bus *usb_alloc_bus (struct usb_operations *);

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 struct usb_bus *usb_bus_get (struct usb_bus *bus);
extern void usb_bus_put (struct usb_bus *bus);

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_suspend_root_hub (struct usb_hcd *hcd);
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_bus *bus);
extern int hcd_bus_resume (struct usb_bus *bus);
#else
static inline void usb_hcd_suspend_root_hub(struct usb_hcd *hcd)
{
	return;
}

static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
{
	return;
}

static inline int hcd_bus_suspend(struct usb_bus *bus)
{
	return 0;
}

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