[J-u-boot.git] / include / usb.h

/*
 * (C) Copyright 2001
 * Denis Peter, MPL AG Switzerland
 *
 * SPDX-License-Identifier:	GPL-2.0+
 * 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];
	/*
	 * Super Speed Device will have Super Speed Endpoint
	 * Companion Descriptor  (section 9.6.7 of usb 3.0 spec)
	 * Revision 1.0 June 6th 2011
	 */
	struct usb_ss_ep_comp_descriptor ss_ep_comp_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 */
	/* slot_id - for xHCI enabled devices */
	unsigned int slot_id;
};

/*
 * You can initialize platform's USB host or device
 * ports by passing this enum as an argument to
 * board_usb_init().
 */
enum usb_init_type {
	USB_INIT_HOST,
	USB_INIT_DEVICE
};

/**********************************************************************
 * 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) || defined(CONFIG_USB_XHCI)

int usb_lowlevel_init(int index, enum usb_init_type init, 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);

#endif

/*
 * board-specific hardware initialization, called by
 * usb drivers and u-boot commands
 *
 * @param index USB controller number
 * @param init initializes controller as USB host or device
 */
int board_usb_init(int index, enum usb_init_type init);

/*
 * can be used to clean up after failed USB initialization attempt
 * vide: board_usb_init()
 *
 * @param index USB controller number for selective cleanup
 * @param init usb_init_type passed to board_usb_init()
 */
int board_usb_cleanup(int index, enum usb_init_type init);

/*
 * If CONFIG_USB_CABLE_CHECK is set then this function
 * should be defined in board file.
 *
 * @return 1 if cable is connected and 0 otherwise.
 */
#ifdef CONFIG_USB_CABLE_CHECK
int usb_cable_connected(void);
#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)

#define usb_pipe_ep_index(pipe)	\
		usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
				((usb_pipeendpoint(pipe) * 2) - \
				 (usb_pipein(pipe) ? 0 : 1))

/*************************************************************************
 * 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);
int usb_alloc_device(struct usb_device *dev);

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