[thirdparty/kernel/linux.git] / drivers / usb / class / cdc-acm.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *
 * 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 */
	unsigned in, out;				/* i/o pipes */
	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];
	struct acm_wb *putbuffer;			/* for acm_tty_put_char() */
	int rx_buflimit;
	spinlock_t read_lock;
	u8 *notification_buffer;			/* to reassemble fragmented notifications */
	unsigned int nb_index;
	unsigned int nb_size;
	int transmitting;
	spinlock_t write_lock;
	struct mutex mutex;
	bool disconnected;
	unsigned long flags;
#		define EVENT_TTY_WAKEUP	0
#		define EVENT_RX_STALL	1
	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 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)
#define SEND_ZERO_PACKET		BIT(8)
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	*
	4	* Includes for cdc-acm.c
	5	*
	6	* Mainly take from usbnet's cdc-ether part
	7	*
	8	*/
	9
	10	/*
	11	* CMSPAR, some architectures can't have space and mark parity.
	12	*/
	13
	14	#ifndef CMSPAR
	15	#define CMSPAR 0
	16	#endif
	17
	18	/*
	19	* Major and minor numbers.
	20	*/
	21
	22	#define ACM_TTY_MAJOR 166
65c35dd5	23	#define ACM_TTY_MINORS 256
1da177e4 LT	24
	25	/*
	26	* Requests.
	27	*/
	28
	29	#define USB_RT_ACM (USB_TYPE_CLASS \| USB_RECIP_INTERFACE)
	30
	31	/*
	32	* Output control lines.
	33	*/
	34
	35	#define ACM_CTRL_DTR 0x01
	36	#define ACM_CTRL_RTS 0x02
	37
	38	/*
	39	* Input control lines and line errors.
	40	*/
	41
	42	#define ACM_CTRL_DCD 0x01
	43	#define ACM_CTRL_DSR 0x02
	44	#define ACM_CTRL_BRK 0x04
	45	#define ACM_CTRL_RI 0x08
	46
	47	#define ACM_CTRL_FRAMING 0x10
	48	#define ACM_CTRL_PARITY 0x20
	49	#define ACM_CTRL_OVERRUN 0x40
	50
	51	/*
	52	* Internal driver structures.
	53	*/
	54
884b600f	55	/*
25985edc	56	* The only reason to have several buffers is to accommodate assumptions
884b600f ON	57	* in line disciplines. They ask for empty space amount, receive our URB size,
	58	* and proceed to issue several 1-character writes, assuming they will fit.
	59	* The very first write takes a complete URB. Fortunately, this only happens
86478944 ON	60	* when processing onlcr, so we only need 2 buffers. These values must be
86478944 ON	61	* powers of 2.
884b600f	62	*/
e4cf3aa8	63	#define ACM_NW 16
86478944	64	#define ACM_NR 16
61a87adf	65
884b600f ON	66	struct acm_wb {
	67	unsigned char *buf;
	68	dma_addr_t dmah;
	69	int len;
	70	int use;
e4cf3aa8 DE	71	struct urb *urb;
e4cf3aa8 DE	72	struct acm *instance;
884b600f ON	73	};
884b600f ON	74
61a87adf	75	struct acm_rb {
61a87adf DK	76	int size;
	77	unsigned char *base;
	78	dma_addr_t dma;
088c64f8	79	int index;
61a87adf DK	80	struct acm *instance;
	81	};
	82
1da177e4 LT	83	struct acm {
	84	struct usb_device dev; / the corresponding usb device */
	85	struct usb_interface control; / control interface */
	86	struct usb_interface data; / data interface */
74bccc9b	87	unsigned in, out; /* i/o pipes */
739e0285 AC	88	struct tty_port port; /* our tty port data */
739e0285 AC	89	struct urb ctrlurb; / urbs */
61a87adf DK	90	u8 ctrl_buffer; / buffers of urbs */
61a87adf DK	91	dma_addr_t ctrl_dma; /* dma handles of buffers */
c4cabd28 ON	92	u8 country_codes; / country codes from device */
	93	unsigned int country_code_size; /* size of this buffer */
	94	unsigned int country_rel_date; /* release date of version */
86478944	95	struct acm_wb wb[ACM_NW];
088c64f8 JH	96	unsigned long read_urbs_free;
	97	struct urb *read_urbs[ACM_NR];
	98	struct acm_rb read_buffers[ACM_NR];
a81cf979	99	struct acm_wb putbuffer; / for acm_tty_put_char() */
86478944	100	int rx_buflimit;
61a87adf	101	spinlock_t read_lock;
ea258352 TH	102	u8 notification_buffer; / to reassemble fragmented notifications */
	103	unsigned int nb_index;
	104	unsigned int nb_size;
11ea859d	105	int transmitting;
884b600f	106	spinlock_t write_lock;
1365baf7	107	struct mutex mutex;
7fb57a01	108	bool disconnected;
1aba579f LM	109	unsigned long flags;
	110	# define EVENT_TTY_WAKEUP 0
	111	# define EVENT_RX_STALL 1
1da177e4 LT	112	struct usb_cdc_line_coding line; /* bits, stop, parity */
1da177e4 LT	113	struct work_struct work; /* work queue entry for line discipline waking up */
1da177e4 LT	114	unsigned int ctrlin; /* input control lines (DCD, DSR, RI, break, overruns) */
1da177e4 LT	115	unsigned int ctrlout; /* output control lines (DTR, RTS) */
5a6a62bd ON	116	struct async_icount iocount; /* counters for control line changes */
	117	struct async_icount oldcount; /* for comparison of counter */
	118	wait_queue_head_t wioctl; /* for ioctl */
1da177e4 LT	119	unsigned int writesize; /* max packet size for the output bulk endpoint */
1da177e4 LT	120	unsigned int readsize,ctrlsize; /* buffer sizes for freeing */
1da177e4	121	unsigned int minor; /* acm minor number */
1da177e4	122	unsigned char clocal; /* termios CLOCAL */
1da177e4	123	unsigned int ctrl_caps; /* control capabilities from the class specific header */
1365baf7	124	unsigned int susp_count; /* number of suspended interfaces */
fa4dc364	125	unsigned int combined_interfaces:1; /* control and data collapsed */
088c64f8 JH	126	unsigned int throttled:1; /* actually throttled */
088c64f8 JH	127	unsigned int throttle_req:1; /* throttle requested */
cf7fdd57	128	u8 bInterval;
140cb81a	129	struct usb_anchor delayed; /* writes queued for a device about to be woken */
2a8cdfde	130	unsigned long quirks;
1da177e4 LT	131	};
	132
	133	#define CDC_DATA_INTERFACE_TYPE 0x0a
	134
	135	/* constants describing various quirks and errors */
d1b78100 ON	136	#define NO_UNION_NORMAL BIT(0)
	137	#define SINGLE_RX_URB BIT(1)
	138	#define NO_CAP_LINE BIT(2)
d1b78100 ON	139	#define NO_DATA_INTERFACE BIT(4)
d1b78100 ON	140	#define IGNORE_DEVICE BIT(5)
2a8cdfde	141	#define QUIRK_CONTROL_LINE_STATE BIT(6)
15bf722e	142	#define CLEAR_HALT_CONDITIONS BIT(7)
ffdb1e36	143	#define SEND_ZERO_PACKET BIT(8)