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

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


/* String descriptor */
struct usb_string_descriptor {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
	unsigned short wData[1];
} __attribute__ ((packed));

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


/* All standard descriptors have these 2 fields in common */
struct usb_descriptor_header {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
} __attribute__ ((packed));

/* Device descriptor */
struct usb_device_descriptor {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
	unsigned short bcdUSB;
	unsigned char  bDeviceClass;
	unsigned char  bDeviceSubClass;
	unsigned char  bDeviceProtocol;
	unsigned char  bMaxPacketSize0;
	unsigned short idVendor;
	unsigned short idProduct;
	unsigned short bcdDevice;
	unsigned char  iManufacturer;
	unsigned char  iProduct;
	unsigned char  iSerialNumber;
	unsigned char  bNumConfigurations;
} __attribute__ ((packed));


/* Endpoint descriptor */
struct usb_endpoint_descriptor {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
	unsigned char  bEndpointAddress;
	unsigned char  bmAttributes;
	unsigned short wMaxPacketSize;
	unsigned char  bInterval;
	unsigned char  bRefresh;
	unsigned char  bSynchAddress;

} __attribute__ ((packed));
/* Interface descriptor */
struct usb_interface_descriptor {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
	unsigned char  bInterfaceNumber;
	unsigned char  bAlternateSetting;
	unsigned char  bNumEndpoints;
	unsigned char  bInterfaceClass;
	unsigned char  bInterfaceSubClass;
	unsigned char  bInterfaceProtocol;
	unsigned char  iInterface;

	unsigned char  no_of_ep;
	unsigned char  act_altsetting;
	struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
} __attribute__ ((packed));


/* Configuration descriptor information.. */
struct usb_config_descriptor {
	unsigned char  bLength;
	unsigned char  bDescriptorType;
	unsigned short wTotalLength;
	unsigned char  bNumInterfaces;
	unsigned char  bConfigurationValue;
	unsigned char  iConfiguration;
	unsigned char  bmAttributes;
	unsigned char  MaxPower;

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


struct usb_device {
	int devnum;								/* Device number on USB bus */
	int slow;									/* Slow device? */
	char mf[32];		     			/* manufacturer */
	char prod[32];		     		/* product */
	char serial[32];       	  /* serial number */

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

	int configno;			/* selected config number */
	struct usb_device_descriptor descriptor; /* Device Descriptor */
	struct usb_config_descriptor 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 */
	struct usb_device *parent;
	struct usb_device *children[USB_MAXCHILDREN];
};

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

#ifdef CONFIG_USB_UHCI
int usb_lowlevel_init(void);
int usb_lowlevel_stop(void);
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

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

#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);
void usb_disable_asynch(int disable);
int usb_maxpacket(struct usb_device *dev,unsigned long pipe);
void __inline__ wait_ms(unsigned long ms);
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 */
#define swap_16(x) \
	((unsigned short)( \
		(((unsigned short)(x) & (unsigned short)0x00ffU) << 8) | \
		(((unsigned short)(x) & (unsigned short)0xff00U) >> 8) ))
#define swap_32(x) \
	((unsigned long)( \
		(((unsigned long)(x) & (unsigned long)0x000000ffUL) << 24) | \
		(((unsigned long)(x) & (unsigned long)0x0000ff00UL) <<  8) | \
		(((unsigned long)(x) & (unsigned long)0x00ff0000UL) >>  8) | \
		(((unsigned long)(x) & (unsigned long)0xff000000UL) >> 24) ))

/*
 * 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 (1 bit)
 *  - 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
 *  - speed:		bit 26		(0 = Full, 1 = Low Speed)
 *  - 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)->slow << 26) | (dev)->maxpacketsize)
#define default_pipe(dev) ((dev)->slow <<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_pipeslow(pipe)	(((pipe) >> 26) & 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;
};

#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
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	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>
	30
	31	/* Everything is aribtrary */
	32	#define USB_ALTSETTINGALLOC 4
	33	#define USB_MAXALTSETTING 128 /* Hard limit */
	34
	35	#define USB_MAX_DEVICE 32
	36	#define USB_MAXCONFIG 8
	37	#define USB_MAXINTERFACES 8
	38	#define USB_MAXENDPOINTS 16
	39	#define USB_MAXCHILDREN 8 /* This is arbitrary */
	40	#define USB_MAX_HUB 16
	41
	42	#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
	43
	44
	45	/* String descriptor */
	46	struct usb_string_descriptor {
	47	unsigned char bLength;
	48	unsigned char bDescriptorType;
	49	unsigned short wData[1];
	50	} __attribute__ ((packed));
	51
	52	/* device request (setup) */
	53	struct devrequest {
	54	unsigned char requesttype;
	55	unsigned char request;
	56	unsigned short value;
	57	unsigned short index;
	58	unsigned short length;
	59	} __attribute__ ((packed));
	60
	61
	62
	63	/* All standard descriptors have these 2 fields in common */
	64	struct usb_descriptor_header {
65	unsigned char bLength;
66	unsigned char bDescriptorType;
67	} __attribute__ ((packed));
68
69	/* Device descriptor */
70	struct usb_device_descriptor {
71	unsigned char bLength;
72	unsigned char bDescriptorType;
73	unsigned short bcdUSB;
74	unsigned char bDeviceClass;
75	unsigned char bDeviceSubClass;
76	unsigned char bDeviceProtocol;
77	unsigned char bMaxPacketSize0;
78	unsigned short idVendor;
79	unsigned short idProduct;
80	unsigned short bcdDevice;
81	unsigned char iManufacturer;
82	unsigned char iProduct;
83	unsigned char iSerialNumber;
84	unsigned char bNumConfigurations;
85	} __attribute__ ((packed));
86
87
88	/* Endpoint descriptor */
89	struct usb_endpoint_descriptor {
90	unsigned char bLength;
91	unsigned char bDescriptorType;
92	unsigned char bEndpointAddress;
93	unsigned char bmAttributes;
94	unsigned short wMaxPacketSize;
95	unsigned char bInterval;
96	unsigned char bRefresh;
97	unsigned char bSynchAddress;
98
99	} __attribute__ ((packed));
100	/* Interface descriptor */
101	struct usb_interface_descriptor {
102	unsigned char bLength;
103	unsigned char bDescriptorType;
104	unsigned char bInterfaceNumber;
105	unsigned char bAlternateSetting;
106	unsigned char bNumEndpoints;
107	unsigned char bInterfaceClass;
108	unsigned char bInterfaceSubClass;
109	unsigned char bInterfaceProtocol;
110	unsigned char iInterface;
111
112	unsigned char no_of_ep;
113	unsigned char act_altsetting;
114	struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
115	} __attribute__ ((packed));
116
117
118	/* Configuration descriptor information.. */
119	struct usb_config_descriptor {
120	unsigned char bLength;
121	unsigned char bDescriptorType;
122	unsigned short wTotalLength;
123	unsigned char bNumInterfaces;
124	unsigned char bConfigurationValue;
125	unsigned char iConfiguration;
126	unsigned char bmAttributes;
127	unsigned char MaxPower;
128
129	unsigned char no_of_if; /* number of interfaces */
130	struct usb_interface_descriptor if_desc[USB_MAXINTERFACES];
131	} __attribute__ ((packed));
132
133
134	struct usb_device {
135	int devnum; /* Device number on USB bus */
136	int slow; /* Slow device? */
137	char mf[32]; /* manufacturer */
138	char prod[32]; /* product */
139	char serial[32]; /* serial number */
140
141	int maxpacketsize; /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
142	unsigned int toggle[2]; /* one bit for each endpoint ([0] = IN, [1] = OUT) */
143	unsigned int halted[2]; /* endpoint halts; one bit per endpoint # & direction; */
144	/* [0] = IN, [1] = OUT */
145	int epmaxpacketin[16]; /* INput endpoint specific maximums */
146	int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
147
148	int configno; /* selected config number */
149	struct usb_device_descriptor descriptor; /* Device Descriptor */
150	struct usb_config_descriptor config; /* config descriptor */
151
152	int have_langid; /* whether string_langid is valid yet */
153	int string_langid; /* language ID for strings */
154	int (irq_handle)(struct usb_device dev);
155	unsigned long irq_status;
156	int irq_act_len; /* transfered bytes */
157	void *privptr;
158	/*
159	* Child devices - if this is a hub device
160	* Each instance needs its own set of data structures.
161	*/
162	unsigned long status;
163	int act_len; /* transfered bytes */
164	int maxchild; /* Number of ports if hub */
165	struct usb_device *parent;
166	struct usb_device *children[USB_MAXCHILDREN];
167	};
168
169	/**********************************************************************
170	* this is how the lowlevel part communicate with the outer world
171	*/
172
173	#ifdef CONFIG_USB_UHCI
174	int usb_lowlevel_init(void);
175	int usb_lowlevel_stop(void);
176	int submit_bulk_msg(struct usb_device dev, unsigned long pipe, void buffer,int transfer_len);
177	int submit_control_msg(struct usb_device dev, unsigned long pipe, void buffer,
178	int transfer_len,struct devrequest *setup);
179	int submit_int_msg(struct usb_device dev, unsigned long pipe, void buffer,
180	int transfer_len, int interval);
181
182	/* Defines */
183	#define USB_UHCI_VEND_ID 0x8086
184	#define USB_UHCI_DEV_ID 0x7112
185
186	#else
187	#error USB Lowlevel not defined
188	#endif
189
190	#ifdef CONFIG_USB_STORAGE
191
192	#define USB_MAX_STOR_DEV 5
193	block_dev_desc_t *usb_stor_get_dev(int index);
194	int usb_stor_scan(int mode);
195
196	#endif
197
198	#ifdef CONFIG_USB_KEYBOARD
199
200	int drv_usb_kbd_init(void);
201	int usb_kbd_deregister(void);
202
203	#endif
204	/* routines */
205	int usb_init(void); /* initialize the USB Controller */
206	int usb_stop(void); /* stop the USB Controller */
207
208
209	int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
210	int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id);
211	struct usb_device * usb_get_dev_index(int index);
212	int usb_control_msg(struct usb_device *dev, unsigned int pipe,
213	unsigned char request, unsigned char requesttype,
214	unsigned short value, unsigned short index,
215	void *data, unsigned short size, int timeout);
216	int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
217	void data, int len, int actual_length, int timeout);
218	int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
219	void *buffer,int transfer_len, int interval);
220	void usb_disable_asynch(int disable);
221	int usb_maxpacket(struct usb_device *dev,unsigned long pipe);
222	void __inline__ wait_ms(unsigned long ms);
223	int usb_get_configuration_no(struct usb_device dev,unsigned char buffer,int cfgno);
224	int usb_get_report(struct usb_device dev, int ifnum, unsigned char type, unsigned char id, void buf, int size);
225	int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
226	unsigned char type, unsigned char id, void *buf, int size);
227	int usb_clear_halt(struct usb_device *dev, int pipe);
228	int usb_string(struct usb_device dev, int index, char buf, size_t size);
229	int usb_set_interface(struct usb_device *dev, int interface, int alternate);
230
231	/* big endian -> little endian conversion */
232	#define swap_16(x) \
233	((unsigned short)( \
234	(((unsigned short)(x) & (unsigned short)0x00ffU) << 8) \| \
235	(((unsigned short)(x) & (unsigned short)0xff00U) >> 8) ))
236	#define swap_32(x) \
237	((unsigned long)( \
238	(((unsigned long)(x) & (unsigned long)0x000000ffUL) << 24) \| \
239	(((unsigned long)(x) & (unsigned long)0x0000ff00UL) << 8) \| \
240	(((unsigned long)(x) & (unsigned long)0x00ff0000UL) >> 8) \| \
241	(((unsigned long)(x) & (unsigned long)0xff000000UL) >> 24) ))
242
243	/*
244	* Calling this entity a "pipe" is glorifying it. A USB pipe
245	* is something embarrassingly simple: it basically consists
246	* of the following information:
247	* - device number (7 bits)
248	* - endpoint number (4 bits)
249	* - current Data0/1 state (1 bit)
250	* - direction (1 bit)
251	* - speed (1 bit)
252	* - max packet size (2 bits: 8, 16, 32 or 64)
253	* - pipe type (2 bits: control, interrupt, bulk, isochronous)
254	*
255	* That's 18 bits. Really. Nothing more. And the USB people have
256	* documented these eighteen bits as some kind of glorious
257	* virtual data structure.
258	*
259	* Let's not fall in that trap. We'll just encode it as a simple
260	* unsigned int. The encoding is:
261	*
262	* - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
263	* - direction: bit 7 (0 = Host-to-Device [Out], 1 = Device-to-Host [In])
264	* - device: bits 8-14
265	* - endpoint: bits 15-18
266	* - Data0/1: bit 19
267	* - speed: bit 26 (0 = Full, 1 = Low Speed)
268	* - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk)
269	*
270	* Why? Because it's arbitrary, and whatever encoding we select is really
271	* up to us. This one happens to share a lot of bit positions with the UHCI
272	* specification, so that much of the uhci driver can just mask the bits
273	* appropriately.
274	*/
275	/* Create various pipes... */
276	#define create_pipe(dev,endpoint) \
277	(((dev)->devnum << 8) \| (endpoint << 15) \| ((dev)->slow << 26) \| (dev)->maxpacketsize)
278	#define default_pipe(dev) ((dev)->slow <<26)
279
280	#define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) \| create_pipe(dev,endpoint))
281	#define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) \| create_pipe(dev,endpoint) \| USB_DIR_IN)
282	#define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) \| create_pipe(dev,endpoint))
283	#define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) \| create_pipe(dev,endpoint) \| USB_DIR_IN)
284	#define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) \| create_pipe(dev,endpoint))
285	#define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) \| create_pipe(dev,endpoint) \| USB_DIR_IN)
286	#define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) \| create_pipe(dev,endpoint))
287	#define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) \| create_pipe(dev,endpoint) \| USB_DIR_IN)
288	#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) \| default_pipe(dev))
289	#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) \| default_pipe(dev) \| USB_DIR_IN)
290
291	/* The D0/D1 toggle bits */
292	#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
293	#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
294	#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << ep)) \| ((bit) << ep))
295
296	/* Endpoint halt control/status */
297	#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
298	#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] \|= (1 << (ep)))
299	#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
300	#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
301
302	#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : USB_PID_OUT)
303
304	#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
305	#define usb_pipein(pipe) (((pipe) >> 7) & 1)
306	#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
307	#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
308	#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
309	#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
310	#define usb_pipeslow(pipe) (((pipe) >> 26) & 1)
311	#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
312	#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
313	#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
314	#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
315	#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
316
317
318	/*************************************************************************
319	* Hub Stuff
320	*/
321	struct usb_port_status {
322	unsigned short wPortStatus;
323	unsigned short wPortChange;
324	} __attribute__ ((packed));
325
326	struct usb_hub_status {
327	unsigned short wHubStatus;
328	unsigned short wHubChange;
329	} __attribute__ ((packed));
330
331
332	/* Hub descriptor */
333	struct usb_hub_descriptor {
334	unsigned char bLength;
335	unsigned char bDescriptorType;
336	unsigned char bNbrPorts;
337	unsigned short wHubCharacteristics;
338	unsigned char bPwrOn2PwrGood;
339	unsigned char bHubContrCurrent;
340	unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
341	unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
342	/* DeviceRemovable and PortPwrCtrlMask want to be variable-length
343	bitmaps that hold max 255 entries. (bit0 is ignored) */
344	} __attribute__ ((packed));
345
346
347	struct usb_hub_device {
348	struct usb_device *pusb_dev;
349	struct usb_hub_descriptor desc;
350	};
351
352	#endif /_USB_H_ /