[people/ms/u-boot.git] / include / usb.h

/*
 * (C) Copyright 2001
 * Denis Peter, MPL AG Switzerland
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * 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., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 * Note: Part of this code has been derived from linux
 *
 */
#ifndef _USB_H_
#define _USB_H_

#include <usb_defs.h>
#include <linux/usb/ch9.h>

/*
 * The EHCI spec says that we must align to at least 32 bytes.  However,
 * some platforms require larger alignment.
 */
#if ARCH_DMA_MINALIGN > 32
#define USB_DMA_MINALIGN	ARCH_DMA_MINALIGN
#else
#define USB_DMA_MINALIGN	32
#endif

/* Everything is aribtrary */
#define USB_ALTSETTINGALLOC		4
#define USB_MAXALTSETTING		128	/* Hard limit */

#define USB_MAX_DEVICE			32
#define USB_MAXCONFIG			8
#define USB_MAXINTERFACES		8
#define USB_MAXENDPOINTS		16
#define USB_MAXCHILDREN			8	/* This is arbitrary */
#define USB_MAX_HUB			16

#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */

/*
 * This is the timeout to allow for submitting an urb in ms. We allow more
 * time for a BULK device to react - some are slow.
 */
#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)

/* device request (setup) */
struct devrequest {
	unsigned char	requesttype;
	unsigned char	request;
	unsigned short	value;
	unsigned short	index;
	unsigned short	length;
} __attribute__ ((packed));

/* Interface */
struct usb_interface {
	struct usb_interface_descriptor desc;

	unsigned char	no_of_ep;
	unsigned char	num_altsetting;
	unsigned char	act_altsetting;

	struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
} __attribute__ ((packed));

/* Configuration information.. */
struct usb_config {
	struct usb_config_descriptor desc;

	unsigned char	no_of_if;	/* number of interfaces */
	struct usb_interface if_desc[USB_MAXINTERFACES];
} __attribute__ ((packed));

enum {
	/* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
	PACKET_SIZE_8   = 0,
	PACKET_SIZE_16  = 1,
	PACKET_SIZE_32  = 2,
	PACKET_SIZE_64  = 3,
};

struct usb_device {
	int	devnum;			/* Device number on USB bus */
	int	speed;			/* full/low/high */
	char	mf[32];			/* manufacturer */
	char	prod[32];		/* product */
	char	serial[32];		/* serial number */

	/* Maximum packet size; one of: PACKET_SIZE_* */
	int maxpacketsize;
	/* one bit for each endpoint ([0] = IN, [1] = OUT) */
	unsigned int toggle[2];
	/* endpoint halts; one bit per endpoint # & direction;
	 * [0] = IN, [1] = OUT
	 */
	unsigned int halted[2];
	int epmaxpacketin[16];		/* INput endpoint specific maximums */
	int epmaxpacketout[16];		/* OUTput endpoint specific maximums */

	int configno;			/* selected config number */
	/* Device Descriptor */
	struct usb_device_descriptor descriptor
		__attribute__((aligned(ARCH_DMA_MINALIGN)));
	struct usb_config config; /* config descriptor */

	int have_langid;		/* whether string_langid is valid yet */
	int string_langid;		/* language ID for strings */
	int (*irq_handle)(struct usb_device *dev);
	unsigned long irq_status;
	int irq_act_len;		/* transfered bytes */
	void *privptr;
	/*
	 * Child devices -  if this is a hub device
	 * Each instance needs its own set of data structures.
	 */
	unsigned long status;
	int act_len;			/* transfered bytes */
	int maxchild;			/* Number of ports if hub */
	int portnr;
	struct usb_device *parent;
	struct usb_device *children[USB_MAXCHILDREN];

	void *controller;		/* hardware controller private data */
};

/**********************************************************************
 * this is how the lowlevel part communicate with the outer world
 */

#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
	defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
	defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
	defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
	defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
	defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \
	defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \
	defined(CONFIG_USB_MUSB_OMAP2PLUS)

int usb_lowlevel_init(int index, void **controller);
int usb_lowlevel_stop(int index);

int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
			void *buffer, int transfer_len);
int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
			int transfer_len, struct devrequest *setup);
int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
			int transfer_len, int interval);

/* Defines */
#define USB_UHCI_VEND_ID	0x8086
#define USB_UHCI_DEV_ID		0x7112

/*
 * PXA25x can only act as USB device. There are drivers
 * which works with USB CDC gadgets implementations.
 * Some of them have common routines which can be used
 * in boards init functions e.g. udc_disconnect() used for
 * forced device disconnection from host.
 */
#elif defined(CONFIG_USB_GADGET_PXA2XX)

extern void udc_disconnect(void);

#else
#error USB Lowlevel not defined
#endif

#ifdef CONFIG_USB_STORAGE

#define USB_MAX_STOR_DEV 5
block_dev_desc_t *usb_stor_get_dev(int index);
int usb_stor_scan(int mode);
int usb_stor_info(void);

#endif

#ifdef CONFIG_USB_HOST_ETHER

#define USB_MAX_ETH_DEV 5
int usb_host_eth_scan(int mode);

#endif

#ifdef CONFIG_USB_KEYBOARD

int drv_usb_kbd_init(void);
int usb_kbd_deregister(void);

#endif
/* routines */
int usb_init(void); /* initialize the USB Controller */
int usb_stop(void); /* stop the USB Controller */


int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
			int report_id);
struct usb_device *usb_get_dev_index(int index);
int usb_control_msg(struct usb_device *dev, unsigned int pipe,
			unsigned char request, unsigned char requesttype,
			unsigned short value, unsigned short index,
			void *data, unsigned short size, int timeout);
int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
			void *data, int len, int *actual_length, int timeout);
int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
			void *buffer, int transfer_len, int interval);
int usb_disable_asynch(int disable);
int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
				int cfgno);
int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
			unsigned char id, void *buf, int size);
int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
			unsigned char type, unsigned char id, void *buf,
			int size);
int usb_clear_halt(struct usb_device *dev, int pipe);
int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
int usb_set_interface(struct usb_device *dev, int interface, int alternate);

/* big endian -> little endian conversion */
/* some CPUs are already little endian e.g. the ARM920T */
#define __swap_16(x) \
	({ unsigned short x_ = (unsigned short)x; \
	 (unsigned short)( \
		((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
	})
#define __swap_32(x) \
	({ unsigned long x_ = (unsigned long)x; \
	 (unsigned long)( \
		((x_ & 0x000000FFUL) << 24) | \
		((x_ & 0x0000FF00UL) <<	 8) | \
		((x_ & 0x00FF0000UL) >>	 8) | \
		((x_ & 0xFF000000UL) >> 24)); \
	})

#ifdef __LITTLE_ENDIAN
# define swap_16(x) (x)
# define swap_32(x) (x)
#else
# define swap_16(x) __swap_16(x)
# define swap_32(x) __swap_32(x)
#endif

/*
 * Calling this entity a "pipe" is glorifying it. A USB pipe
 * is something embarrassingly simple: it basically consists
 * of the following information:
 *  - device number (7 bits)
 *  - endpoint number (4 bits)
 *  - current Data0/1 state (1 bit)
 *  - direction (1 bit)
 *  - speed (2 bits)
 *  - max packet size (2 bits: 8, 16, 32 or 64)
 *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
 *
 * That's 18 bits. Really. Nothing more. And the USB people have
 * documented these eighteen bits as some kind of glorious
 * virtual data structure.
 *
 * Let's not fall in that trap. We'll just encode it as a simple
 * unsigned int. The encoding is:
 *
 *  - max size:		bits 0-1	(00 = 8, 01 = 16, 10 = 32, 11 = 64)
 *  - direction:	bit 7		(0 = Host-to-Device [Out],
 *					(1 = Device-to-Host [In])
 *  - device:		bits 8-14
 *  - endpoint:		bits 15-18
 *  - Data0/1:		bit 19
 *  - pipe type:	bits 30-31	(00 = isochronous, 01 = interrupt,
 *					 10 = control, 11 = bulk)
 *
 * Why? Because it's arbitrary, and whatever encoding we select is really
 * up to us. This one happens to share a lot of bit positions with the UHCI
 * specification, so that much of the uhci driver can just mask the bits
 * appropriately.
 */
/* Create various pipes... */
#define create_pipe(dev,endpoint) \
		(((dev)->devnum << 8) | ((endpoint) << 15) | \
		(dev)->maxpacketsize)
#define default_pipe(dev) ((dev)->speed << 26)

#define usb_sndctrlpipe(dev, endpoint)	((PIPE_CONTROL << 30) | \
					 create_pipe(dev, endpoint))
#define usb_rcvctrlpipe(dev, endpoint)	((PIPE_CONTROL << 30) | \
					 create_pipe(dev, endpoint) | \
					 USB_DIR_IN)
#define usb_sndisocpipe(dev, endpoint)	((PIPE_ISOCHRONOUS << 30) | \
					 create_pipe(dev, endpoint))
#define usb_rcvisocpipe(dev, endpoint)	((PIPE_ISOCHRONOUS << 30) | \
					 create_pipe(dev, endpoint) | \
					 USB_DIR_IN)
#define usb_sndbulkpipe(dev, endpoint)	((PIPE_BULK << 30) | \
					 create_pipe(dev, endpoint))
#define usb_rcvbulkpipe(dev, endpoint)	((PIPE_BULK << 30) | \
					 create_pipe(dev, endpoint) | \
					 USB_DIR_IN)
#define usb_sndintpipe(dev, endpoint)	((PIPE_INTERRUPT << 30) | \
					 create_pipe(dev, endpoint))
#define usb_rcvintpipe(dev, endpoint)	((PIPE_INTERRUPT << 30) | \
					 create_pipe(dev, endpoint) | \
					 USB_DIR_IN)
#define usb_snddefctrl(dev)		((PIPE_CONTROL << 30) | \
					 default_pipe(dev))
#define usb_rcvdefctrl(dev)		((PIPE_CONTROL << 30) | \
					 default_pipe(dev) | \
					 USB_DIR_IN)

/* The D0/D1 toggle bits */
#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
#define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
						((dev)->toggle[out] & \
						 ~(1 << ep)) | ((bit) << ep))

/* Endpoint halt control/status */
#define usb_endpoint_out(ep_dir)	(((ep_dir >> 7) & 1) ^ 1)
#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))

#define usb_packetid(pipe)	(((pipe) & USB_DIR_IN) ? USB_PID_IN : \
				 USB_PID_OUT)

#define usb_pipeout(pipe)	((((pipe) >> 7) & 1) ^ 1)
#define usb_pipein(pipe)	(((pipe) >> 7) & 1)
#define usb_pipedevice(pipe)	(((pipe) >> 8) & 0x7f)
#define usb_pipe_endpdev(pipe)	(((pipe) >> 8) & 0x7ff)
#define usb_pipeendpoint(pipe)	(((pipe) >> 15) & 0xf)
#define usb_pipedata(pipe)	(((pipe) >> 19) & 1)
#define usb_pipetype(pipe)	(((pipe) >> 30) & 3)
#define usb_pipeisoc(pipe)	(usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
#define usb_pipeint(pipe)	(usb_pipetype((pipe)) == PIPE_INTERRUPT)
#define usb_pipecontrol(pipe)	(usb_pipetype((pipe)) == PIPE_CONTROL)
#define usb_pipebulk(pipe)	(usb_pipetype((pipe)) == PIPE_BULK)


/*************************************************************************
 * Hub Stuff
 */
struct usb_port_status {
	unsigned short wPortStatus;
	unsigned short wPortChange;
} __attribute__ ((packed));

struct usb_hub_status {
	unsigned short wHubStatus;
	unsigned short wHubChange;
} __attribute__ ((packed));


/* Hub descriptor */
struct usb_hub_descriptor {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
	unsigned char  bNbrPorts;
	unsigned short wHubCharacteristics;
	unsigned char  bPwrOn2PwrGood;
	unsigned char  bHubContrCurrent;
	unsigned char  DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
	unsigned char  PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
	/* DeviceRemovable and PortPwrCtrlMask want to be variable-length
	   bitmaps that hold max 255 entries. (bit0 is ignored) */
} __attribute__ ((packed));


struct usb_hub_device {
	struct usb_device *pusb_dev;
	struct usb_hub_descriptor desc;
};

int usb_hub_probe(struct usb_device *dev, int ifnum);
void usb_hub_reset(void);
int hub_port_reset(struct usb_device *dev, int port,
			  unsigned short *portstat);

struct usb_device *usb_alloc_new_device(void *controller);

int usb_new_device(struct usb_device *dev);
void usb_free_device(void);

#endif /*_USB_H_ */
Commit	Line	Data
012771d8 WD	1	/*
	2	* (C) Copyright 2001
	3	* Denis Peter, MPL AG Switzerland
	4	*
	5	* See file CREDITS for list of people who contributed to this
	6	* project.
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License as
	10	* published by the Free Software Foundation; either version 2 of
	11	* the License, or (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
5cf91d6b	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
012771d8 WD	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	21	* MA 02111-1307 USA
	22	*
	23	* Note: Part of this code has been derived from linux
	24	*
	25	*/
	26	#ifndef _USB_H_
	27	#define _USB_H_
	28
	29	#include <usb_defs.h>
c60795f4	30	#include <linux/usb/ch9.h>
012771d8	31
71c5de4f TR	32	/*
	33	* The EHCI spec says that we must align to at least 32 bytes. However,
	34	* some platforms require larger alignment.
	35	*/
	36	#if ARCH_DMA_MINALIGN > 32
	37	#define USB_DMA_MINALIGN ARCH_DMA_MINALIGN
	38	#else
	39	#define USB_DMA_MINALIGN 32
	40	#endif
	41
012771d8	42	/* Everything is aribtrary */
5cf91d6b WD	43	#define USB_ALTSETTINGALLOC 4
5cf91d6b WD	44	#define USB_MAXALTSETTING 128 /* Hard limit */
012771d8	45
5cf91d6b WD	46	#define USB_MAX_DEVICE 32
	47	#define USB_MAXCONFIG 8
	48	#define USB_MAXINTERFACES 8
	49	#define USB_MAXENDPOINTS 16
	50	#define USB_MAXCHILDREN 8 /* This is arbitrary */
	51	#define USB_MAX_HUB 16
012771d8 WD	52
	53	#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
	54
96820a35 SG	55	/*
	56	* This is the timeout to allow for submitting an urb in ms. We allow more
	57	* time for a BULK device to react - some are slow.
	58	*/
80b350a7	59	#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
96820a35	60
012771d8 WD	61	/* device request (setup) */
012771d8 WD	62	struct devrequest {
de39f8c1 MT	63	unsigned char requesttype;
	64	unsigned char request;
	65	unsigned short value;
	66	unsigned short index;
	67	unsigned short length;
012771d8 WD	68	} __attribute__ ((packed));
012771d8 WD	69
8f8bd565 TR	70	/* Interface */
	71	struct usb_interface {
	72	struct usb_interface_descriptor desc;
de39f8c1 MT	73
	74	unsigned char no_of_ep;
	75	unsigned char num_altsetting;
	76	unsigned char act_altsetting;
	77
012771d8 WD	78	struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
	79	} __attribute__ ((packed));
	80
8f8bd565 TR	81	/* Configuration information.. */
8f8bd565 TR	82	struct usb_config {
c60795f4	83	struct usb_config_descriptor desc;
de39f8c1 MT	84
de39f8c1 MT	85	unsigned char no_of_if; /* number of interfaces */
8f8bd565	86	struct usb_interface if_desc[USB_MAXINTERFACES];
012771d8 WD	87	} __attribute__ ((packed));
012771d8 WD	88
48867208 RB	89	enum {
	90	/* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
	91	PACKET_SIZE_8 = 0,
	92	PACKET_SIZE_16 = 1,
	93	PACKET_SIZE_32 = 2,
	94	PACKET_SIZE_64 = 3,
	95	};
012771d8 WD	96
012771d8 WD	97	struct usb_device {
de39f8c1	98	int devnum; /* Device number on USB bus */
3e126484	99	int speed; /* full/low/high */
de39f8c1 MT	100	char mf[32]; /* manufacturer */
	101	char prod[32]; /* product */
	102	char serial[32]; /* serial number */
012771d8	103
48867208 RB	104	/* Maximum packet size; one of: PACKET_SIZE_* */
	105	int maxpacketsize;
	106	/* one bit for each endpoint ([0] = IN, [1] = OUT) */
	107	unsigned int toggle[2];
de39f8c1 MT	108	/* endpoint halts; one bit per endpoint # & direction;
	109	* [0] = IN, [1] = OUT
	110	*/
48867208	111	unsigned int halted[2];
012771d8 WD	112	int epmaxpacketin[16]; /* INput endpoint specific maximums */
	113	int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
	114
	115	int configno; /* selected config number */
f5766139 PS	116	/* Device Descriptor */
	117	struct usb_device_descriptor descriptor
	118	__attribute__((aligned(ARCH_DMA_MINALIGN)));
8f8bd565	119	struct usb_config config; /* config descriptor */
012771d8 WD	120
	121	int have_langid; /* whether string_langid is valid yet */
	122	int string_langid; /* language ID for strings */
	123	int (irq_handle)(struct usb_device dev);
	124	unsigned long irq_status;
5cf91d6b	125	int irq_act_len; /* transfered bytes */
012771d8 WD	126	void *privptr;
	127	/*
	128	* Child devices - if this is a hub device
	129	* Each instance needs its own set of data structures.
	130	*/
	131	unsigned long status;
	132	int act_len; /* transfered bytes */
	133	int maxchild; /* Number of ports if hub */
3e126484	134	int portnr;
012771d8 WD	135	struct usb_device *parent;
012771d8 WD	136	struct usb_device *children[USB_MAXCHILDREN];
c7e3b2b5 LS	137
c7e3b2b5 LS	138	void controller; / hardware controller private data */
012771d8 WD	139	};
	140
	141	/**********************************************************************
	142	* this is how the lowlevel part communicate with the outer world
	143	*/
	144
822af351	145	#if defined(CONFIG_USB_UHCI) \|\| defined(CONFIG_USB_OHCI) \|\| \
51ab142b	146	defined(CONFIG_USB_EHCI) \|\| defined(CONFIG_USB_OHCI_NEW) \|\| \
3e126484	147	defined(CONFIG_USB_SL811HS) \|\| defined(CONFIG_USB_ISP116X_HCD) \|\| \
f298e4b6	148	defined(CONFIG_USB_R8A66597_HCD) \|\| defined(CONFIG_USB_DAVINCI) \|\| \
e608f221	149	defined(CONFIG_USB_OMAP3) \|\| defined(CONFIG_USB_DA8XX) \|\| \
37931f02	150	defined(CONFIG_USB_BLACKFIN) \|\| defined(CONFIG_USB_AM35X) \|\| \
673a524b IY	151	defined(CONFIG_USB_MUSB_DSPS) \|\| defined(CONFIG_USB_MUSB_AM35X) \|\| \
673a524b IY	152	defined(CONFIG_USB_MUSB_OMAP2PLUS)
822af351	153
c7e3b2b5 LS	154	int usb_lowlevel_init(int index, void **controller);
	155	int usb_lowlevel_stop(int index);
	156
de39f8c1 MT	157	int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
de39f8c1 MT	158	void *buffer, int transfer_len);
012771d8	159	int submit_control_msg(struct usb_device dev, unsigned long pipe, void buffer,
de39f8c1	160	int transfer_len, struct devrequest *setup);
012771d8 WD	161	int submit_int_msg(struct usb_device dev, unsigned long pipe, void buffer,
	162	int transfer_len, int interval);
	163
	164	/* Defines */
de39f8c1 MT	165	#define USB_UHCI_VEND_ID 0x8086
de39f8c1 MT	166	#define USB_UHCI_DEV_ID 0x7112
012771d8	167
e5f24753 LD	168	/*
	169	* PXA25x can only act as USB device. There are drivers
	170	* which works with USB CDC gadgets implementations.
	171	* Some of them have common routines which can be used
	172	* in boards init functions e.g. udc_disconnect() used for
	173	* forced device disconnection from host.
	174	*/
	175	#elif defined(CONFIG_USB_GADGET_PXA2XX)
	176
	177	extern void udc_disconnect(void);
	178
012771d8 WD	179	#else
	180	#error USB Lowlevel not defined
	181	#endif
	182
	183	#ifdef CONFIG_USB_STORAGE
	184
	185	#define USB_MAX_STOR_DEV 5
	186	block_dev_desc_t *usb_stor_get_dev(int index);
	187	int usb_stor_scan(int mode);
e813eae3	188	int usb_stor_info(void);
012771d8 WD	189
	190	#endif
	191
89d48367 SG	192	#ifdef CONFIG_USB_HOST_ETHER
	193
	194	#define USB_MAX_ETH_DEV 5
	195	int usb_host_eth_scan(int mode);
	196
	197	#endif
	198
012771d8 WD	199	#ifdef CONFIG_USB_KEYBOARD
	200
	201	int drv_usb_kbd_init(void);
	202	int usb_kbd_deregister(void);
	203
	204	#endif
	205	/* routines */
	206	int usb_init(void); /* initialize the USB Controller */
	207	int usb_stop(void); /* stop the USB Controller */
	208
	209
	210	int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
de39f8c1 MT	211	int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
	212	int report_id);
	213	struct usb_device *usb_get_dev_index(int index);
012771d8 WD	214	int usb_control_msg(struct usb_device *dev, unsigned int pipe,
	215	unsigned char request, unsigned char requesttype,
	216	unsigned short value, unsigned short index,
	217	void *data, unsigned short size, int timeout);
	218	int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
	219	void data, int len, int actual_length, int timeout);
	220	int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
de39f8c1	221	void *buffer, int transfer_len, int interval);
89d48367	222	int usb_disable_asynch(int disable);
de39f8c1	223	int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
de39f8c1 MT	224	int usb_get_configuration_no(struct usb_device dev, unsigned char buffer,
	225	int cfgno);
	226	int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
	227	unsigned char id, void *buf, int size);
012771d8	228	int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
de39f8c1 MT	229	unsigned char type, unsigned char id, void *buf,
de39f8c1 MT	230	int size);
012771d8 WD	231	int usb_clear_halt(struct usb_device *dev, int pipe);
	232	int usb_string(struct usb_device dev, int index, char buf, size_t size);
	233	int usb_set_interface(struct usb_device *dev, int interface, int alternate);
	234
	235	/* big endian -> little endian conversion */
149dded2	236	/* some CPUs are already little endian e.g. the ARM920T */
ae3b770e	237	#define __swap_16(x) \
3f85ce27 WD	238	({ unsigned short x_ = (unsigned short)x; \
3f85ce27 WD	239	(unsigned short)( \
de39f8c1	240	((x_ & 0x00FFU) << 8) \| ((x_ & 0xFF00U) >> 8)); \
3f85ce27	241	})
ae3b770e	242	#define __swap_32(x) \
3f85ce27 WD	243	({ unsigned long x_ = (unsigned long)x; \
	244	(unsigned long)( \
	245	((x_ & 0x000000FFUL) << 24) \| \
5cf91d6b WD	246	((x_ & 0x0000FF00UL) << 8) \| \
5cf91d6b WD	247	((x_ & 0x00FF0000UL) >> 8) \| \
de39f8c1	248	((x_ & 0xFF000000UL) >> 24)); \
3f85ce27	249	})
ae3b770e	250
c7d703f3	251	#ifdef __LITTLE_ENDIAN
ae3b770e MK	252	# define swap_16(x) (x)
	253	# define swap_32(x) (x)
	254	#else
	255	# define swap_16(x) __swap_16(x)
	256	# define swap_32(x) __swap_32(x)
c7d703f3	257	#endif
012771d8 WD	258
	259	/*
	260	* Calling this entity a "pipe" is glorifying it. A USB pipe
	261	* is something embarrassingly simple: it basically consists
	262	* of the following information:
	263	* - device number (7 bits)
	264	* - endpoint number (4 bits)
	265	* - current Data0/1 state (1 bit)
	266	* - direction (1 bit)
3e126484	267	* - speed (2 bits)
012771d8 WD	268	* - max packet size (2 bits: 8, 16, 32 or 64)
	269	* - pipe type (2 bits: control, interrupt, bulk, isochronous)
	270	*
	271	* That's 18 bits. Really. Nothing more. And the USB people have
	272	* documented these eighteen bits as some kind of glorious
	273	* virtual data structure.
	274	*
	275	* Let's not fall in that trap. We'll just encode it as a simple
	276	* unsigned int. The encoding is:
	277	*
	278	* - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
de39f8c1 MT	279	* - direction: bit 7 (0 = Host-to-Device [Out],
de39f8c1 MT	280	* (1 = Device-to-Host [In])
012771d8 WD	281	* - device: bits 8-14
	282	* - endpoint: bits 15-18
	283	* - Data0/1: bit 19
de39f8c1 MT	284	* - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
de39f8c1 MT	285	* 10 = control, 11 = bulk)
012771d8 WD	286	*
	287	* Why? Because it's arbitrary, and whatever encoding we select is really
	288	* up to us. This one happens to share a lot of bit positions with the UHCI
	289	* specification, so that much of the uhci driver can just mask the bits
	290	* appropriately.
	291	*/
	292	/* Create various pipes... */
	293	#define create_pipe(dev,endpoint) \
d0fe1128	294	(((dev)->devnum << 8) \| ((endpoint) << 15) \| \
c60795f4	295	(dev)->maxpacketsize)
3e126484	296	#define default_pipe(dev) ((dev)->speed << 26)
de39f8c1 MT	297
	298	#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) \| \
	299	create_pipe(dev, endpoint))
	300	#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) \| \
	301	create_pipe(dev, endpoint) \| \
	302	USB_DIR_IN)
	303	#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) \| \
	304	create_pipe(dev, endpoint))
	305	#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) \| \
	306	create_pipe(dev, endpoint) \| \
	307	USB_DIR_IN)
	308	#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) \| \
	309	create_pipe(dev, endpoint))
	310	#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) \| \
	311	create_pipe(dev, endpoint) \| \
	312	USB_DIR_IN)
	313	#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) \| \
	314	create_pipe(dev, endpoint))
	315	#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) \| \
	316	create_pipe(dev, endpoint) \| \
	317	USB_DIR_IN)
	318	#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) \| \
	319	default_pipe(dev))
	320	#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) \| \
	321	default_pipe(dev) \| \
	322	USB_DIR_IN)
012771d8 WD	323
	324	/* The D0/D1 toggle bits */
	325	#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
5cf91d6b	326	#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
de39f8c1 MT	327	#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
	328	((dev)->toggle[out] & \
	329	~(1 << ep)) \| ((bit) << ep))
012771d8 WD	330
	331	/* Endpoint halt control/status */
	332	#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
	333	#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] \|= (1 << (ep)))
	334	#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
	335	#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
	336
de39f8c1 MT	337	#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
de39f8c1 MT	338	USB_PID_OUT)
012771d8 WD	339
	340	#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
	341	#define usb_pipein(pipe) (((pipe) >> 7) & 1)
	342	#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
	343	#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
	344	#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
	345	#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
012771d8 WD	346	#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
	347	#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
	348	#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
	349	#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
	350	#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
	351
	352
	353	/*************************************************************************
	354	* Hub Stuff
	355	*/
	356	struct usb_port_status {
	357	unsigned short wPortStatus;
	358	unsigned short wPortChange;
	359	} __attribute__ ((packed));
	360
	361	struct usb_hub_status {
	362	unsigned short wHubStatus;
	363	unsigned short wHubChange;
	364	} __attribute__ ((packed));
	365
	366
	367	/* Hub descriptor */
	368	struct usb_hub_descriptor {
	369	unsigned char bLength;
	370	unsigned char bDescriptorType;
	371	unsigned char bNbrPorts;
	372	unsigned short wHubCharacteristics;
	373	unsigned char bPwrOn2PwrGood;
	374	unsigned char bHubContrCurrent;
	375	unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
	376	unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
de39f8c1	377	/* DeviceRemovable and PortPwrCtrlMask want to be variable-length
012771d8 WD	378	bitmaps that hold max 255 entries. (bit0 is ignored) */
	379	} __attribute__ ((packed));
	380
	381
	382	struct usb_hub_device {
	383	struct usb_device *pusb_dev;
	384	struct usb_hub_descriptor desc;
	385	};
	386
23faf2bc MV	387	int usb_hub_probe(struct usb_device *dev, int ifnum);
	388	void usb_hub_reset(void);
	389	int hub_port_reset(struct usb_device *dev, int port,
	390	unsigned short *portstat);
	391
c7e3b2b5 LS	392	struct usb_device usb_alloc_new_device(void controller);
c7e3b2b5 LS	393
23faf2bc	394	int usb_new_device(struct usb_device *dev);
359439d2	395	void usb_free_device(void);
23faf2bc	396
012771d8	397	#endif /_USB_H_ /