Return to sl811.h CVS log

Up to [Development] / linux-2.4-xfs / drivers / usb / host

Initial Import 2.4.24pre2

#ifndef __LINUX_SL811_H
#define __LINUX_SL811_H

//#define SL811_DEBUG

#ifdef SL811_DEBUG
	#define PDEBUG(level, fmt, args...) \
		if (debug >= (level)) info("[%s:%d] " fmt, \
		__PRETTY_FUNCTION__, __LINE__ , ## args)
#else
	#define PDEBUG(level, fmt, args...) do {} while(0)
#endif

//#define SL811_TIMEOUT
		
/* Sl811 host control register */
#define	SL811_CTRL_A		0x00
#define	SL811_ADDR_A		0x01
#define	SL811_LEN_A		0x02
#define	SL811_STS_A		0x03	/* read	*/
#define	SL811_PIDEP_A		0x03	/* write */
#define	SL811_CNT_A		0x04	/* read	*/
#define	SL811_DEV_A		0x04	/* write */
#define	SL811_CTRL1		0x05
#define	SL811_INTR		0x06
#define	SL811_CTRL_B		0x08
#define	SL811_ADDR_B		0x09
#define	SL811_LEN_B		0x0A
#define	SL811_STS_B		0x0B	/* read	*/
#define	SL811_PIDEP_B		0x0B	/* write */
#define	SL811_CNT_B		0x0C	/* read	*/
#define	SL811_DEV_B		0x0C	/* write */
#define	SL811_INTRSTS		0x0D	/* write clears	bitwise	*/
#define	SL811_HWREV		0x0E	/* read	*/
#define	SL811_SOFLOW		0x0E	/* write */
#define	SL811_SOFCNTDIV		0x0F	/* read	*/
#define	SL811_CTRL2		0x0F	/* write */

/* USB control register bits (addr 0x00 and addr 0x08) */
#define	SL811_USB_CTRL_ARM	0x01
#define	SL811_USB_CTRL_ENABLE	0x02
#define	SL811_USB_CTRL_DIR_OUT	0x04
#define	SL811_USB_CTRL_ISO	0x10
#define	SL811_USB_CTRL_SOF	0x20
#define	SL811_USB_CTRL_TOGGLE_1	0x40
#define	SL811_USB_CTRL_PREAMBLE	0x80

/* USB status register bits (addr 0x03 and addr 0x0B) */
#define	SL811_USB_STS_ACK	0x01
#define	SL811_USB_STS_ERROR	0x02
#define	SL811_USB_STS_TIMEOUT	0x04
#define	SL811_USB_STS_TOGGLE_1	0x08
#define	SL811_USB_STS_SETUP	0x10
#define	SL811_USB_STS_OVERFLOW	0x20
#define	SL811_USB_STS_NAK	0x40
#define	SL811_USB_STS_STALL	0x80

/* Control register 1 bits (addr 0x05) */
#define	SL811_CTRL1_SOF		0x01
#define	SL811_CTRL1_RESET	0x08
#define	SL811_CTRL1_JKSTATE	0x10
#define	SL811_CTRL1_SPEED_LOW	0x20
#define	SL811_CTRL1_SUSPEND	0x40

/* Interrut enable (addr 0x06) and interrupt status register bits (addr 0x0D) */
#define	SL811_INTR_DONE_A	0x01
#define	SL811_INTR_DONE_B	0x02
#define	SL811_INTR_SOF		0x10
#define	SL811_INTR_INSRMV	0x20
#define	SL811_INTR_DETECT	0x40
#define	SL811_INTR_NOTPRESENT	0x40
#define	SL811_INTR_SPEED_FULL	0x80    /* only in status reg */

/* HW rev and SOF lo register bits (addr 0x0E) */
#define	SL811_HWR_HWREV		0xF0

/* SOF counter and control reg 2 (addr 0x0F) */
#define	SL811_CTL2_SOFHI	0x3F
#define	SL811_CTL2_DSWAP	0x40
#define	SL811_CTL2_HOST		0x80

/* Set up for 1-ms SOF time. */
#define SL811_12M_LOW		0xE0
#define SL811_12M_HI		0x2E

#define SL811_DATA_START	0x10
#define SL811_DATA_LIMIT	240


/* Requests: bRequest << 8 | bmRequestType */
#define RH_GET_STATUS           0x0080
#define RH_CLEAR_FEATURE        0x0100
#define RH_SET_FEATURE          0x0300
#define RH_SET_ADDRESS		0x0500
#define RH_GET_DESCRIPTOR	0x0680
#define RH_SET_DESCRIPTOR       0x0700
#define RH_GET_CONFIGURATION	0x0880
#define RH_SET_CONFIGURATION	0x0900
#define RH_GET_STATE            0x0280
#define RH_GET_INTERFACE        0x0A80
#define RH_SET_INTERFACE        0x0B00
#define RH_SYNC_FRAME           0x0C80


#define PIDEP(pid, ep) (((pid) & 0x0f) << 4 | (ep))

/* Virtual Root HUB */
struct virt_root_hub {
	int devnum; 			/* Address of Root Hub endpoint */ 
	void *urb;			/* interrupt URB of root hub */
	int send;			/* active flag */
	int interval;			/* intervall of roothub interrupt transfers */
	struct timer_list rh_int_timer; /* intervall timer for rh interrupt EP */
};

struct sl811_td {
	/* hardware */
	__u8 ctrl;			/* control register */
	
	/* write */			
	__u8 addr;			/* base adrress register */
	__u8 len;			/* base length register */
	__u8 pidep;			/* PId and endpoint register */
	__u8 dev;			/* device address register */
	
	/* read */
	__u8 status;			/* status register */
	__u8 left;			/* transfer count register */
	
	/* software */
	__u8 errcnt;			/* error count, begin with 3 */
	__u8 done;			/* is this td tranfer done */
	__u8 *buf;			/* point to data buffer for tranfer */
	int bustime;			/* the bus time need by this td */
	int td_status;			/* the status of this td */
	int nakcnt;			/* number of naks */
	struct urb *urb;			/* the urb this td belongs to */
	struct list_head td_list;	/* link to a list of the urb */
};

struct sl811_urb_priv {
	struct urb *urb;			/* the urb this priv beloings to */
	struct list_head td_list;	/* list of all the td of this urb */
	struct sl811_td *cur_td;		/* current td is in processing or it will be */
	struct sl811_td *first_td;		/* the first td of this urb */
	struct sl811_td *last_td;		/* the last td of this urb */
	int interval;			/* the query time value for intr urb */
	int unlink;			/* is the this urb unlinked */
	unsigned long inserttime;	/* the time when insert to list */
};

struct sl811_hc {
	spinlock_t hc_lock;		/* Lock for this structure */
	
	int irq;			/* IRQ number this hc use */
	int addr_io;			/* I/O address line address */
	int data_io;			/* I/O data line address */
	struct virt_root_hub rh;		/* root hub */
	struct usb_port_status rh_status;/* root hub port status */
	struct list_head urb_list[6];	/* set of urbs, the order is iso,intr,ctrl,bulk,inactive intr, wait */
	struct list_head *cur_list;	/* the current list is in process */
	wait_queue_head_t waitq;	/* deletion of URBs and devices needs a waitqueue */
	struct sl811_td *cur_td;		/* point to the td is in process */
	struct list_head hc_hcd_list;	/* list of all hci_hcd */
	struct usb_bus *bus;    	/* our bus */
	int active_urbs;		/* total number of active usbs */
	int frame_number;		/* the current frame number, we do't use it, any one need it? */
};

#define iso_list 	urb_list[0]	/* set of isoc urbs */
#define intr_list	urb_list[1]	/* ordered (tree) set of int urbs */
#define ctrl_list	urb_list[2]	/* set of ctrl urbs */
#define bulk_list	urb_list[3]	/* set of bulk urbs */
#define idle_intr_list	urb_list[4]	/* set of intr urbs in its idle time*/
#define wait_list	urb_list[5]	/* set of wait urbs */

#endif