[mirror_ubuntu-zesty-kernel.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		256

/*
 * 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 accommodate 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 {
	int			size;
	unsigned char		*base;
	dma_addr_t		dma;
	int			index;
	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];
	unsigned long read_urbs_free;
	struct urb *read_urbs[ACM_NR];
	struct acm_rb read_buffers[ACM_NR];
	int rx_buflimit;
	int rx_endpoint;
	spinlock_t read_lock;
	int write_used;					/* number of non-empty write buffers */
	int transmitting;
	spinlock_t write_lock;
	struct mutex mutex;
	bool disconnected;
	struct usb_cdc_line_coding line;		/* bits, stop, parity */
	struct work_struct work;			/* work queue entry for line discipline waking up */
	unsigned int ctrlin;				/* input control lines (DCD, DSR, RI, break, overruns) */
	unsigned int ctrlout;				/* output control lines (DTR, RTS) */
	struct async_icount iocount;			/* counters for control line changes */
	struct async_icount oldcount;			/* for comparison of counter */
	wait_queue_head_t wioctl;			/* for ioctl */
	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 clocal;				/* termios CLOCAL */
	unsigned int ctrl_caps;				/* control capabilities from the class specific header */
	unsigned int susp_count;			/* number of suspended interfaces */
	unsigned int combined_interfaces:1;		/* control and data collapsed */
	unsigned int is_int_ep:1;			/* interrupt endpoints contrary to spec used */
	unsigned int throttled:1;			/* actually throttled */
	unsigned int throttle_req:1;			/* throttle requested */
	u8 bInterval;
	struct usb_anchor delayed;			/* writes queued for a device about to be woken */
	unsigned long quirks;
};

#define CDC_DATA_INTERFACE_TYPE	0x0a

/* constants describing various quirks and errors */
#define NO_UNION_NORMAL			BIT(0)
#define SINGLE_RX_URB			BIT(1)
#define NO_CAP_LINE			BIT(2)
#define NO_DATA_INTERFACE		BIT(4)
#define IGNORE_DEVICE			BIT(5)
#define QUIRK_CONTROL_LINE_STATE	BIT(6)
#define CLEAR_HALT_CONDITIONS		BIT(7)
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
65c35dd5	22	#define ACM_TTY_MINORS 256
1da177e4 LT	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	54	/*
25985edc	55	* The only reason to have several buffers is to accommodate assumptions
884b600f ON	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	74	struct acm_rb {
61a87adf DK	75	int size;
	76	unsigned char *base;
	77	dma_addr_t dma;
088c64f8	78	int index;
61a87adf DK	79	struct acm *instance;
	80	};
	81
1da177e4 LT	82	struct acm {
	83	struct usb_device dev; / the corresponding usb device */
	84	struct usb_interface control; / control interface */
	85	struct usb_interface data; / data interface */
739e0285 AC	86	struct tty_port port; /* our tty port data */
739e0285 AC	87	struct urb ctrlurb; / urbs */
61a87adf DK	88	u8 ctrl_buffer; / buffers of urbs */
61a87adf DK	89	dma_addr_t ctrl_dma; /* dma handles of buffers */
c4cabd28 ON	90	u8 country_codes; / country codes from device */
	91	unsigned int country_code_size; /* size of this buffer */
	92	unsigned int country_rel_date; /* release date of version */
86478944	93	struct acm_wb wb[ACM_NW];
088c64f8 JH	94	unsigned long read_urbs_free;
	95	struct urb *read_urbs[ACM_NR];
	96	struct acm_rb read_buffers[ACM_NR];
86478944	97	int rx_buflimit;
61a87adf DK	98	int rx_endpoint;
61a87adf DK	99	spinlock_t read_lock;
884b600f	100	int write_used; /* number of non-empty write buffers */
11ea859d	101	int transmitting;
884b600f	102	spinlock_t write_lock;
1365baf7	103	struct mutex mutex;
7fb57a01	104	bool disconnected;
1da177e4 LT	105	struct usb_cdc_line_coding line; /* bits, stop, parity */
1da177e4 LT	106	struct work_struct work; /* work queue entry for line discipline waking up */
1da177e4 LT	107	unsigned int ctrlin; /* input control lines (DCD, DSR, RI, break, overruns) */
1da177e4 LT	108	unsigned int ctrlout; /* output control lines (DTR, RTS) */
5a6a62bd ON	109	struct async_icount iocount; /* counters for control line changes */
	110	struct async_icount oldcount; /* for comparison of counter */
	111	wait_queue_head_t wioctl; /* for ioctl */
1da177e4 LT	112	unsigned int writesize; /* max packet size for the output bulk endpoint */
1da177e4 LT	113	unsigned int readsize,ctrlsize; /* buffer sizes for freeing */
1da177e4	114	unsigned int minor; /* acm minor number */
1da177e4	115	unsigned char clocal; /* termios CLOCAL */
1da177e4	116	unsigned int ctrl_caps; /* control capabilities from the class specific header */
1365baf7	117	unsigned int susp_count; /* number of suspended interfaces */
fa4dc364 RD	118	unsigned int combined_interfaces:1; /* control and data collapsed */
fa4dc364 RD	119	unsigned int is_int_ep:1; /* interrupt endpoints contrary to spec used */
088c64f8 JH	120	unsigned int throttled:1; /* actually throttled */
088c64f8 JH	121	unsigned int throttle_req:1; /* throttle requested */
cf7fdd57	122	u8 bInterval;
140cb81a	123	struct usb_anchor delayed; /* writes queued for a device about to be woken */
2a8cdfde	124	unsigned long quirks;
1da177e4 LT	125	};
	126
	127	#define CDC_DATA_INTERFACE_TYPE 0x0a
	128
	129	/* constants describing various quirks and errors */
d1b78100 ON	130	#define NO_UNION_NORMAL BIT(0)
	131	#define SINGLE_RX_URB BIT(1)
	132	#define NO_CAP_LINE BIT(2)
d1b78100 ON	133	#define NO_DATA_INTERFACE BIT(4)
d1b78100 ON	134	#define IGNORE_DEVICE BIT(5)
2a8cdfde	135	#define QUIRK_CONTROL_LINE_STATE BIT(6)
15bf722e	136	#define CLEAR_HALT_CONDITIONS BIT(7)