[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 */
	unsigned		saw_irq : 1;
	unsigned		can_wakeup:1;	/* hw supports wakeup? */
	unsigned		remote_wakeup:1;/* sw should use wakeup? */
	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, unsigned 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,
			unsigned 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);

	/* global suspend/resume of bus */
	int (*hub_suspend)(struct usb_bus *);
	int (*hub_resume)(struct usb_bus *);
};

/* 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 bus glue.
	 */
	/* called after all devices were suspended */
	int	(*suspend) (struct usb_hcd *hcd, pm_message_t message);

	/* called before any devices get resumed */
	int	(*resume) (struct usb_hcd *hcd);

	/* cleanly make HCD stop writing memory and doing I/O */
	void	(*stop) (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,
					unsigned 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		(*hub_suspend)(struct usb_hcd *);
	int		(*hub_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);

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

#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,
	unsigned 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_hcd_resume_root_hub (struct usb_hcd *hcd);

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 semaphore 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))

/*
 * 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_add_bus(struct usb_bus *bus);
extern void usbfs_remove_bus(struct usb_bus *bus);
extern void usbfs_add_device(struct usb_device *dev);
extern void usbfs_remove_device(struct usb_device *dev);
extern void usbfs_update_special (void);

extern int usbfs_init(void);
extern void usbfs_cleanup(void);

#else /* CONFIG_USB_DEVICEFS */

static inline void usbfs_add_bus(struct usb_bus *bus) {}
static inline void usbfs_remove_bus(struct usb_bus *bus) {}
static inline void usbfs_add_device(struct usb_device *dev) {}
static inline void usbfs_remove_device(struct usb_device *dev) {}
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); */
	void (*bus_add)(struct usb_bus *bus);
	void (*bus_remove)(struct usb_bus *bus);
};

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);
}
 
static inline void usbmon_notify_bus_add(struct usb_bus *bus)
{
	if (mon_ops)
		(*mon_ops->bus_add)(bus);
}

static inline void usbmon_notify_bus_remove(struct usb_bus *bus)
{
	if (mon_ops)
		(*mon_ops->bus_remove)(bus);
}

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) {}
static inline void usbmon_notify_bus_add(struct usb_bus *bus) {}
static inline void usbmon_notify_bus_remove(struct usb_bus *bus) {}

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