blob: 1e7eda61cb17d658d04e63ec1df6bd3a4b3edbdb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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/*
flintman5c2f9732014-08-11 21:52:25 -040051 * MBM, Added Abstract state
52 */
53#define ACM_ABSTRACT_STATE 0x01
54#define ACM_ABS_IDLE 0x01
55#define ACM_ABS_MUX 0x02
56
57#define ACM_COUNTRY_SETTING 0x02
58
59/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * Internal driver structures.
61 */
62
Oliver Neukum884b6002005-04-21 21:28:02 +020063/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -030064 * The only reason to have several buffers is to accommodate assumptions
Oliver Neukum884b6002005-04-21 21:28:02 +020065 * in line disciplines. They ask for empty space amount, receive our URB size,
66 * and proceed to issue several 1-character writes, assuming they will fit.
67 * The very first write takes a complete URB. Fortunately, this only happens
Oliver Neukum86478942006-05-13 22:50:47 +020068 * when processing onlcr, so we only need 2 buffers. These values must be
69 * powers of 2.
Oliver Neukum884b6002005-04-21 21:28:02 +020070 */
David Engrafe4cf3aa2008-03-20 10:01:34 +010071#define ACM_NW 16
Oliver Neukum86478942006-05-13 22:50:47 +020072#define ACM_NR 16
David Kubicek61a87ad2005-11-01 18:51:34 +010073
Oliver Neukum884b6002005-04-21 21:28:02 +020074struct acm_wb {
75 unsigned char *buf;
76 dma_addr_t dmah;
77 int len;
78 int use;
David Engrafe4cf3aa2008-03-20 10:01:34 +010079 struct urb *urb;
80 struct acm *instance;
Oliver Neukum884b6002005-04-21 21:28:02 +020081};
82
David Kubicek61a87ad2005-11-01 18:51:34 +010083struct acm_rb {
David Kubicek61a87ad2005-11-01 18:51:34 +010084 int size;
85 unsigned char *base;
86 dma_addr_t dma;
Johan Hovold088c64f2011-03-25 11:06:02 +010087 int index;
David Kubicek61a87ad2005-11-01 18:51:34 +010088 struct acm *instance;
89};
90
Linus Torvalds1da177e2005-04-16 15:20:36 -070091struct acm {
92 struct usb_device *dev; /* the corresponding usb device */
93 struct usb_interface *control; /* control interface */
94 struct usb_interface *data; /* data interface */
Alan Cox739e0282009-06-11 12:27:50 +010095 struct tty_port port; /* our tty port data */
96 struct urb *ctrlurb; /* urbs */
David Kubicek61a87ad2005-11-01 18:51:34 +010097 u8 *ctrl_buffer; /* buffers of urbs */
98 dma_addr_t ctrl_dma; /* dma handles of buffers */
Oliver Neukumc4cabd22007-02-27 15:28:55 +010099 u8 *country_codes; /* country codes from device */
100 unsigned int country_code_size; /* size of this buffer */
101 unsigned int country_rel_date; /* release date of version */
Oliver Neukum86478942006-05-13 22:50:47 +0200102 struct acm_wb wb[ACM_NW];
Johan Hovold088c64f2011-03-25 11:06:02 +0100103 unsigned long read_urbs_free;
104 struct urb *read_urbs[ACM_NR];
105 struct acm_rb read_buffers[ACM_NR];
Oliver Neukum86478942006-05-13 22:50:47 +0200106 int rx_buflimit;
David Kubicek61a87ad2005-11-01 18:51:34 +0100107 int rx_endpoint;
108 spinlock_t read_lock;
Oliver Neukum884b6002005-04-21 21:28:02 +0200109 int write_used; /* number of non-empty write buffers */
Oliver Neukum11ea8592008-06-20 11:25:57 +0200110 int transmitting;
Oliver Neukum884b6002005-04-21 21:28:02 +0200111 spinlock_t write_lock;
Oliver Neukum1365baf2007-10-12 17:24:28 +0200112 struct mutex mutex;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800113 bool disconnected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 struct usb_cdc_line_coding line; /* bits, stop, parity */
115 struct work_struct work; /* work queue entry for line discipline waking up */
flintman5c2f9732014-08-11 21:52:25 -0400116 unsigned int state; /* MBM, state for comm features */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 unsigned int ctrlin; /* input control lines (DCD, DSR, RI, break, overruns) */
118 unsigned int ctrlout; /* output control lines (DTR, RTS) */
119 unsigned int writesize; /* max packet size for the output bulk endpoint */
120 unsigned int readsize,ctrlsize; /* buffer sizes for freeing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 unsigned int minor; /* acm minor number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 unsigned char clocal; /* termios CLOCAL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 unsigned int ctrl_caps; /* control capabilities from the class specific header */
Oliver Neukum1365baf2007-10-12 17:24:28 +0200124 unsigned int susp_count; /* number of suspended interfaces */
Randy Dunlapfa4dc362010-03-02 14:52:33 -0800125 unsigned int combined_interfaces:1; /* control and data collapsed */
126 unsigned int is_int_ep:1; /* interrupt endpoints contrary to spec used */
Johan Hovold088c64f2011-03-25 11:06:02 +0100127 unsigned int throttled:1; /* actually throttled */
128 unsigned int throttle_req:1; /* throttle requested */
Oliver Neukumcf7fdd52009-08-04 23:52:09 +0200129 u8 bInterval;
flintman5c2f9732014-08-11 21:52:25 -0400130 struct usb_ctrlrequest *irq; /* MBM, added for get_encapsulated_command */
131 struct urb *response;
132 u8 *inbuf;
133 unsigned int bMaxPacketSize0;
flintmand53cff62015-03-04 20:21:21 -0500134 struct acm_wb *delayed_wb; /* write queued for a device about to be woken */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135};
136
137#define CDC_DATA_INTERFACE_TYPE 0x0a
138
139/* constants describing various quirks and errors */
140#define NO_UNION_NORMAL 1
Oliver Neukum86478942006-05-13 22:50:47 +0200141#define SINGLE_RX_URB 2
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +0200142#define NO_CAP_LINE 4
Julian Calabyce126642010-01-05 23:58:20 +1100143#define NOT_A_MODEM 8
Erik Slagterfd5054c2011-05-11 12:06:55 +0200144#define NO_DATA_INTERFACE 16
flintman5c2f9732014-08-11 21:52:25 -0400145#define NOT_REAL_ACM 32