[thirdparty/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
 *
 */

/*
 * Major and minor numbers.
 */

#define ACM_TTY_MAJOR		166
#define ACM_TTY_MINORS		256

#define ACM_MINOR_INVALID	ACM_TTY_MINORS

/*
 * Requests.
 */

#define USB_RT_ACM		(USB_TYPE_CLASS | USB_RECIP_INTERFACE)

/*
 * 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 {
	u8 *buf;
	dma_addr_t dmah;
	unsigned int len;
	struct urb		*urb;
	struct acm		*instance;
	bool use;
};

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];
	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
#		define ACM_THROTTLED	2
#		define ACM_ERROR_DELAY	3
	unsigned long urbs_in_error_delay;		/* these need to be restarted after a delay */
	struct usb_cdc_line_coding line;		/* bits, stop, parity */
	struct delayed_work dwork;		        /* work queue entry for various purposes */
	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 */
	u8 bInterval;
	struct usb_anchor delayed;			/* writes queued for a device about to be woken */
	unsigned long quirks;
};

/* 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 IGNORE_DEVICE			BIT(3)
#define QUIRK_CONTROL_LINE_STATE	BIT(4)
#define CLEAR_HALT_CONDITIONS		BIT(5)
#define SEND_ZERO_PACKET		BIT(6)
#define DISABLE_ECHO			BIT(7)
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
1da177e4 LT	10	/*
	11	* Major and minor numbers.
	12	*/
	13
	14	#define ACM_TTY_MAJOR 166
65c35dd5	15	#define ACM_TTY_MINORS 256
1da177e4	16
91fac074 JH	17	#define ACM_MINOR_INVALID ACM_TTY_MINORS
91fac074 JH	18
1da177e4 LT	19	/*
	20	* Requests.
	21	*/
	22
	23	#define USB_RT_ACM (USB_TYPE_CLASS \| USB_RECIP_INTERFACE)
	24
1da177e4 LT	25	/*
	26	* Internal driver structures.
	27	*/
	28
884b600f	29	/*
25985edc	30	* The only reason to have several buffers is to accommodate assumptions
884b600f ON	31	* in line disciplines. They ask for empty space amount, receive our URB size,
	32	* and proceed to issue several 1-character writes, assuming they will fit.
	33	* The very first write takes a complete URB. Fortunately, this only happens
86478944 ON	34	* when processing onlcr, so we only need 2 buffers. These values must be
86478944 ON	35	* powers of 2.
884b600f	36	*/
e4cf3aa8	37	#define ACM_NW 16
86478944	38	#define ACM_NR 16
61a87adf	39
884b600f	40	struct acm_wb {
37329036	41	u8 *buf;
884b600f	42	dma_addr_t dmah;
37329036	43	unsigned int len;
e4cf3aa8 DE	44	struct urb *urb;
e4cf3aa8 DE	45	struct acm *instance;
37329036	46	bool use;
884b600f ON	47	};
884b600f ON	48
61a87adf	49	struct acm_rb {
61a87adf DK	50	int size;
	51	unsigned char *base;
	52	dma_addr_t dma;
088c64f8	53	int index;
61a87adf DK	54	struct acm *instance;
	55	};
	56
1da177e4 LT	57	struct acm {
	58	struct usb_device dev; / the corresponding usb device */
	59	struct usb_interface control; / control interface */
	60	struct usb_interface data; / data interface */
74bccc9b	61	unsigned in, out; /* i/o pipes */
739e0285 AC	62	struct tty_port port; /* our tty port data */
739e0285 AC	63	struct urb ctrlurb; / urbs */
61a87adf DK	64	u8 ctrl_buffer; / buffers of urbs */
61a87adf DK	65	dma_addr_t ctrl_dma; /* dma handles of buffers */
c4cabd28 ON	66	u8 country_codes; / country codes from device */
	67	unsigned int country_code_size; /* size of this buffer */
	68	unsigned int country_rel_date; /* release date of version */
86478944	69	struct acm_wb wb[ACM_NW];
088c64f8 JH	70	unsigned long read_urbs_free;
	71	struct urb *read_urbs[ACM_NR];
	72	struct acm_rb read_buffers[ACM_NR];
86478944	73	int rx_buflimit;
61a87adf	74	spinlock_t read_lock;
ea258352 TH	75	u8 notification_buffer; / to reassemble fragmented notifications */
	76	unsigned int nb_index;
	77	unsigned int nb_size;
11ea859d	78	int transmitting;
884b600f	79	spinlock_t write_lock;
1365baf7	80	struct mutex mutex;
7fb57a01	81	bool disconnected;
1aba579f LM	82	unsigned long flags;
	83	# define EVENT_TTY_WAKEUP 0
	84	# define EVENT_RX_STALL 1
0f02321e	85	# define ACM_THROTTLED 2
a4e7279c ON	86	# define ACM_ERROR_DELAY 3
a4e7279c ON	87	unsigned long urbs_in_error_delay; /* these need to be restarted after a delay */
1da177e4	88	struct usb_cdc_line_coding line; /* bits, stop, parity */
38203b83	89	struct delayed_work dwork; /* work queue entry for various purposes */
1da177e4 LT	90	unsigned int ctrlin; /* input control lines (DCD, DSR, RI, break, overruns) */
1da177e4 LT	91	unsigned int ctrlout; /* output control lines (DTR, RTS) */
5a6a62bd ON	92	struct async_icount iocount; /* counters for control line changes */
	93	struct async_icount oldcount; /* for comparison of counter */
	94	wait_queue_head_t wioctl; /* for ioctl */
1da177e4 LT	95	unsigned int writesize; /* max packet size for the output bulk endpoint */
1da177e4 LT	96	unsigned int readsize,ctrlsize; /* buffer sizes for freeing */
1da177e4	97	unsigned int minor; /* acm minor number */
1da177e4	98	unsigned char clocal; /* termios CLOCAL */
1da177e4	99	unsigned int ctrl_caps; /* control capabilities from the class specific header */
1365baf7	100	unsigned int susp_count; /* number of suspended interfaces */
fa4dc364	101	unsigned int combined_interfaces:1; /* control and data collapsed */
cf7fdd57	102	u8 bInterval;
140cb81a	103	struct usb_anchor delayed; /* writes queued for a device about to be woken */
2a8cdfde	104	unsigned long quirks;
1da177e4 LT	105	};
1da177e4 LT	106
1da177e4	107	/* constants describing various quirks and errors */
d1b78100 ON	108	#define NO_UNION_NORMAL BIT(0)
	109	#define SINGLE_RX_URB BIT(1)
	110	#define NO_CAP_LINE BIT(2)
bf1c6744 JH	111	#define IGNORE_DEVICE BIT(3)
	112	#define QUIRK_CONTROL_LINE_STATE BIT(4)
	113	#define CLEAR_HALT_CONDITIONS BIT(5)
	114	#define SEND_ZERO_PACKET BIT(6)
	115	#define DISABLE_ECHO BIT(7)