[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / usb / class / cdc-acm.h

/*
 *
 * Includes for cdc-acm.c
 *
 * Mainly take from usbnet's cdc-ether part
 *
 */

/*
 * CMSPAR, some architectures can't have space and mark parity.
 */

#ifndef CMSPAR
#define CMSPAR			0
#endif

/*
 * Major and minor numbers.
 */

#define ACM_TTY_MAJOR		166
#define ACM_TTY_MINORS		32

/*
 * Requests.
 */

#define USB_RT_ACM		(USB_TYPE_CLASS | USB_RECIP_INTERFACE)

/*
 * Output control lines.
 */

#define ACM_CTRL_DTR		0x01
#define ACM_CTRL_RTS		0x02

/*
 * Input control lines and line errors.
 */

#define ACM_CTRL_DCD		0x01
#define ACM_CTRL_DSR		0x02
#define ACM_CTRL_BRK		0x04
#define ACM_CTRL_RI		0x08

#define ACM_CTRL_FRAMING	0x10
#define ACM_CTRL_PARITY		0x20
#define ACM_CTRL_OVERRUN	0x40

/*
 * Internal driver structures.
 */

/*
 * The only reason to have several buffers is to accomodate assumptions
 * in line disciplines. They ask for empty space amount, receive our URB size,
 * and proceed to issue several 1-character writes, assuming they will fit.
 * The very first write takes a complete URB. Fortunately, this only happens
 * when processing onlcr, so we only need 2 buffers. These values must be
 * powers of 2.
 */
#define ACM_NW  16
#define ACM_NR  16

struct acm_wb {
	unsigned char *buf;
	dma_addr_t dmah;
	int len;
	int use;
	struct urb		*urb;
	struct acm		*instance;
};

struct acm_rb {
	struct list_head	list;
	int			size;
	unsigned char		*base;
	dma_addr_t		dma;
};

struct acm_ru {
	struct list_head	list;
	struct acm_rb		*buffer;
	struct urb		*urb;
	struct acm		*instance;
};

struct acm {
	struct usb_device *dev;				/* the corresponding usb device */
	struct usb_interface *control;			/* control interface */
	struct usb_interface *data;			/* data interface */
	struct tty_port port;			 	/* our tty port data */
	struct urb *ctrlurb;				/* urbs */
	u8 *ctrl_buffer;				/* buffers of urbs */
	dma_addr_t ctrl_dma;				/* dma handles of buffers */
	u8 *country_codes;				/* country codes from device */
	unsigned int country_code_size;			/* size of this buffer */
	unsigned int country_rel_date;			/* release date of version */
	struct acm_wb wb[ACM_NW];
	struct acm_ru ru[ACM_NR];
	struct acm_rb rb[ACM_NR];
	int rx_buflimit;
	int rx_endpoint;
	spinlock_t read_lock;
	struct list_head spare_read_urbs;
	struct list_head spare_read_bufs;
	struct list_head filled_read_bufs;
	int write_used;					/* number of non-empty write buffers */
	int processing;
	int transmitting;
	spinlock_t write_lock;
	struct mutex mutex;
	struct usb_cdc_line_coding line;		/* bits, stop, parity */
	struct work_struct work;			/* work queue entry for line discipline waking up */
	wait_queue_head_t drain_wait;			/* close processing */
	struct tasklet_struct urb_task;                 /* rx processing */
	spinlock_t throttle_lock;			/* synchronize throtteling and read callback */
	unsigned int ctrlin;				/* input control lines (DCD, DSR, RI, break, overruns) */
	unsigned int ctrlout;				/* output control lines (DTR, RTS) */
	unsigned int writesize;				/* max packet size for the output bulk endpoint */
	unsigned int readsize,ctrlsize;			/* buffer sizes for freeing */
	unsigned int minor;				/* acm minor number */
	unsigned char throttle;				/* throttled by tty layer */
	unsigned char clocal;				/* termios CLOCAL */
	unsigned int ctrl_caps;				/* control capabilities from the class specific header */
	unsigned int susp_count;			/* number of suspended interfaces */
	int combined_interfaces:1;			/* control and data collapsed */
	int is_int_ep:1;				/* interrupt endpoints contrary to spec used */
	u8 bInterval;
	struct acm_wb *delayed_wb;			/* write queued for a device about to be woken */
};

#define CDC_DATA_INTERFACE_TYPE	0x0a

/* constants describing various quirks and errors */
#define NO_UNION_NORMAL			1
#define SINGLE_RX_URB			2
#define NO_CAP_LINE			4
Commit	Line	Data
1da177e4 LT	1	/*
	2	*
	3	* Includes for cdc-acm.c
	4	*
	5	* Mainly take from usbnet's cdc-ether part
	6	*
	7	*/
	8
	9	/*
	10	* CMSPAR, some architectures can't have space and mark parity.
	11	*/
	12
	13	#ifndef CMSPAR
	14	#define CMSPAR 0
	15	#endif
	16
	17	/*
	18	* Major and minor numbers.
	19	*/
	20
	21	#define ACM_TTY_MAJOR 166
	22	#define ACM_TTY_MINORS 32
	23
	24	/*
	25	* Requests.
	26	*/
	27
	28	#define USB_RT_ACM (USB_TYPE_CLASS \| USB_RECIP_INTERFACE)
	29
	30	/*
	31	* Output control lines.
	32	*/
	33
	34	#define ACM_CTRL_DTR 0x01
	35	#define ACM_CTRL_RTS 0x02
	36
	37	/*
	38	* Input control lines and line errors.
	39	*/
	40
	41	#define ACM_CTRL_DCD 0x01
	42	#define ACM_CTRL_DSR 0x02
	43	#define ACM_CTRL_BRK 0x04
	44	#define ACM_CTRL_RI 0x08
	45
	46	#define ACM_CTRL_FRAMING 0x10
	47	#define ACM_CTRL_PARITY 0x20
	48	#define ACM_CTRL_OVERRUN 0x40
	49
	50	/*
	51	* Internal driver structures.
	52	*/
	53
884b600f ON	54	/*
	55	* The only reason to have several buffers is to accomodate assumptions
	56	* in line disciplines. They ask for empty space amount, receive our URB size,
	57	* and proceed to issue several 1-character writes, assuming they will fit.
	58	* The very first write takes a complete URB. Fortunately, this only happens
86478944 ON	59	* when processing onlcr, so we only need 2 buffers. These values must be
86478944 ON	60	* powers of 2.
884b600f	61	*/
e4cf3aa8	62	#define ACM_NW 16
86478944	63	#define ACM_NR 16
61a87adf	64
884b600f ON	65	struct acm_wb {
	66	unsigned char *buf;
	67	dma_addr_t dmah;
	68	int len;
	69	int use;
e4cf3aa8 DE	70	struct urb *urb;
e4cf3aa8 DE	71	struct acm *instance;
884b600f ON	72	};
884b600f ON	73
61a87adf DK	74	struct acm_rb {
	75	struct list_head list;
	76	int size;
	77	unsigned char *base;
	78	dma_addr_t dma;
	79	};
	80
	81	struct acm_ru {
	82	struct list_head list;
	83	struct acm_rb *buffer;
	84	struct urb *urb;
	85	struct acm *instance;
	86	};
	87
1da177e4 LT	88	struct acm {
	89	struct usb_device dev; / the corresponding usb device */
	90	struct usb_interface control; / control interface */
	91	struct usb_interface data; / data interface */
739e0285 AC	92	struct tty_port port; /* our tty port data */
739e0285 AC	93	struct urb ctrlurb; / urbs */
61a87adf DK	94	u8 ctrl_buffer; / buffers of urbs */
61a87adf DK	95	dma_addr_t ctrl_dma; /* dma handles of buffers */
c4cabd28 ON	96	u8 country_codes; / country codes from device */
	97	unsigned int country_code_size; /* size of this buffer */
	98	unsigned int country_rel_date; /* release date of version */
86478944 ON	99	struct acm_wb wb[ACM_NW];
	100	struct acm_ru ru[ACM_NR];
	101	struct acm_rb rb[ACM_NR];
	102	int rx_buflimit;
61a87adf DK	103	int rx_endpoint;
	104	spinlock_t read_lock;
	105	struct list_head spare_read_urbs;
	106	struct list_head spare_read_bufs;
	107	struct list_head filled_read_bufs;
884b600f	108	int write_used; /* number of non-empty write buffers */
11ea859d ON	109	int processing;
11ea859d ON	110	int transmitting;
884b600f	111	spinlock_t write_lock;
1365baf7	112	struct mutex mutex;
1da177e4 LT	113	struct usb_cdc_line_coding line; /* bits, stop, parity */
1da177e4 LT	114	struct work_struct work; /* work queue entry for line discipline waking up */
e5fbab51	115	wait_queue_head_t drain_wait; /* close processing */
61a87adf	116	struct tasklet_struct urb_task; /* rx processing */
1da177e4 LT	117	spinlock_t throttle_lock; /* synchronize throtteling and read callback */
	118	unsigned int ctrlin; /* input control lines (DCD, DSR, RI, break, overruns) */
	119	unsigned int ctrlout; /* output control lines (DTR, RTS) */
	120	unsigned int writesize; /* max packet size for the output bulk endpoint */
	121	unsigned int readsize,ctrlsize; /* buffer sizes for freeing */
1da177e4 LT	122	unsigned int minor; /* acm minor number */
	123	unsigned char throttle; /* throttled by tty layer */
	124	unsigned char clocal; /* termios CLOCAL */
1da177e4	125	unsigned int ctrl_caps; /* control capabilities from the class specific header */
1365baf7	126	unsigned int susp_count; /* number of suspended interfaces */
a2bfb4a3	127	int combined_interfaces:1; /* control and data collapsed */
cf7fdd57 ON	128	int is_int_ep:1; /* interrupt endpoints contrary to spec used */
cf7fdd57 ON	129	u8 bInterval;
11ea859d	130	struct acm_wb delayed_wb; / write queued for a device about to be woken */
1da177e4 LT	131	};
	132
	133	#define CDC_DATA_INTERFACE_TYPE 0x0a
	134
	135	/* constants describing various quirks and errors */
	136	#define NO_UNION_NORMAL 1
86478944	137	#define SINGLE_RX_URB 2
a2bfb4a3	138	#define NO_CAP_LINE 4