blob: b3ce7338cb6b3513e3b130049e9d376017f1dba6 [file] [log] [blame]
Greg Kroah-Hartman5fd54ac2017-11-03 11:28:30 +01001// SPDX-License-Identifier: GPL-2.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * cdc-acm.c
4 *
5 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
8 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
9 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
David Kubicek61a87ad2005-11-01 18:51:34 +010010 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
Johan Hovold088c64f2011-03-25 11:06:02 +010011 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * USB Abstract Control Model driver for USB modems and ISDN adapters
14 *
15 * Sponsored by SuSE
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 */
17
18#undef DEBUG
David Brownelle5fbab52008-08-06 18:46:10 -070019#undef VERBOSE_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/kernel.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010022#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/errno.h>
24#include <linux/init.h>
25#include <linux/slab.h>
Tobias Herzogea258352017-03-30 22:15:11 +020026#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/tty.h>
Oliver Neukum7af25b42009-09-08 23:51:28 +020028#include <linux/serial.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/tty_driver.h>
30#include <linux/tty_flip.h>
31#include <linux/module.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010032#include <linux/mutex.h>
Alan Cox10077d42009-06-11 12:36:09 +010033#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070035#include <linux/usb/cdc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/byteorder.h>
37#include <asm/unaligned.h>
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020038#include <linux/idr.h>
David Kubicek61a87ad2005-11-01 18:51:34 +010039#include <linux/list.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41#include "cdc-acm.h"
42
David Brownelle5fbab52008-08-06 18:46:10 -070043
Johan Hovold088c64f2011-03-25 11:06:02 +010044#define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
46
47static struct usb_driver acm_driver;
48static struct tty_driver *acm_tty_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020050static DEFINE_IDR(acm_minors);
51static DEFINE_MUTEX(acm_minors_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Jim Paris24cb4502014-10-30 11:04:47 -040053static void acm_tty_set_termios(struct tty_struct *tty,
54 struct ktermios *termios_old);
55
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080056/*
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020057 * acm_minors accessors
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080058 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080060/*
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020061 * Look up an ACM structure by minor. If found and not disconnected, increment
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080062 * its refcount and return it with its mutex held.
63 */
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020064static struct acm *acm_get_by_minor(unsigned int minor)
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080065{
66 struct acm *acm;
67
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020068 mutex_lock(&acm_minors_lock);
69 acm = idr_find(&acm_minors, minor);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080070 if (acm) {
71 mutex_lock(&acm->mutex);
72 if (acm->disconnected) {
73 mutex_unlock(&acm->mutex);
74 acm = NULL;
75 } else {
76 tty_port_get(&acm->port);
77 mutex_unlock(&acm->mutex);
78 }
79 }
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020080 mutex_unlock(&acm_minors_lock);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080081 return acm;
82}
83
84/*
85 * Try to find an available minor number and if found, associate it with 'acm'.
86 */
87static int acm_alloc_minor(struct acm *acm)
88{
89 int minor;
90
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020091 mutex_lock(&acm_minors_lock);
92 minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
93 mutex_unlock(&acm_minors_lock);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080094
95 return minor;
96}
97
98/* Release the minor number associated with 'acm'. */
99static void acm_release_minor(struct acm *acm)
100{
Johan Hovold6cb4f4d2015-05-18 17:34:11 +0200101 mutex_lock(&acm_minors_lock);
102 idr_remove(&acm_minors, acm->minor);
103 mutex_unlock(&acm_minors_lock);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800104}
Alan Cox739e0282009-06-11 12:27:50 +0100105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106/*
107 * Functions for ACM control messages.
108 */
109
Alan Cox6e47e062009-06-11 12:37:06 +0100110static int acm_ctrl_msg(struct acm *acm, int request, int value,
111 void *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112{
Johan Hovoldbae3f4c2014-05-26 19:23:39 +0200113 int retval;
114
115 retval = usb_autopm_get_interface(acm->control);
116 if (retval)
117 return retval;
118
119 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 request, USB_RT_ACM, value,
121 acm->control->altsetting[0].desc.bInterfaceNumber,
122 buf, len, 5000);
Johan Hovoldbae3f4c2014-05-26 19:23:39 +0200123
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100124 dev_dbg(&acm->control->dev,
Ladislav Michl90744af82016-11-18 19:01:22 +0100125 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126 __func__, request, value, len, retval);
Johan Hovoldbae3f4c2014-05-26 19:23:39 +0200127
128 usb_autopm_put_interface(acm->control);
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 return retval < 0 ? retval : 0;
131}
132
133/* devices aren't required to support these requests.
134 * the cdc acm descriptor tells whether they do...
135 */
Johan Hovold2a8cdfd2014-11-06 18:08:33 +0100136static inline int acm_set_control(struct acm *acm, int control)
137{
138 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
139 return -EOPNOTSUPP;
140
141 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
142 control, NULL, 0);
143}
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145#define acm_set_line(acm, line) \
146 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
147#define acm_send_break(acm, ms) \
148 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
149
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100150static void acm_poison_urbs(struct acm *acm)
Ladislav Michlba8c9312016-11-18 19:07:08 +0100151{
152 int i;
153
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100154 usb_poison_urb(acm->ctrlurb);
Ladislav Michlba8c9312016-11-18 19:07:08 +0100155 for (i = 0; i < ACM_NW; i++)
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100156 usb_poison_urb(acm->wb[i].urb);
Ladislav Michlba8c9312016-11-18 19:07:08 +0100157 for (i = 0; i < acm->rx_buflimit; i++)
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100158 usb_poison_urb(acm->read_urbs[i]);
Ladislav Michlba8c9312016-11-18 19:07:08 +0100159}
160
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100161static void acm_unpoison_urbs(struct acm *acm)
162{
163 int i;
164
165 for (i = 0; i < acm->rx_buflimit; i++)
166 usb_unpoison_urb(acm->read_urbs[i]);
167 for (i = 0; i < ACM_NW; i++)
168 usb_unpoison_urb(acm->wb[i].urb);
169 usb_unpoison_urb(acm->ctrlurb);
170}
171
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/*
Oliver Neukum884b6002005-04-21 21:28:02 +0200174 * Write buffer management.
175 * All of these assume proper locks taken by the caller.
176 */
177
178static int acm_wb_alloc(struct acm *acm)
179{
180 int i, wbn;
181 struct acm_wb *wb;
182
David Engrafe4cf3aa2008-03-20 10:01:34 +0100183 wbn = 0;
Oliver Neukum884b6002005-04-21 21:28:02 +0200184 i = 0;
185 for (;;) {
186 wb = &acm->wb[wbn];
187 if (!wb->use) {
Oliver Neukum37329032020-09-17 13:02:35 +0200188 wb->use = true;
Dominik Bozekb86b8eb2018-02-15 21:27:48 -0800189 wb->len = 0;
Oliver Neukum884b6002005-04-21 21:28:02 +0200190 return wbn;
191 }
Oliver Neukum86478942006-05-13 22:50:47 +0200192 wbn = (wbn + 1) % ACM_NW;
193 if (++i >= ACM_NW)
Oliver Neukum884b6002005-04-21 21:28:02 +0200194 return -1;
195 }
196}
197
Oliver Neukum884b6002005-04-21 21:28:02 +0200198static int acm_wb_is_avail(struct acm *acm)
199{
200 int i, n;
David Brownelle5fbab52008-08-06 18:46:10 -0700201 unsigned long flags;
Oliver Neukum884b6002005-04-21 21:28:02 +0200202
Oliver Neukum86478942006-05-13 22:50:47 +0200203 n = ACM_NW;
David Brownelle5fbab52008-08-06 18:46:10 -0700204 spin_lock_irqsave(&acm->write_lock, flags);
Alan Cox6e47e062009-06-11 12:37:06 +0100205 for (i = 0; i < ACM_NW; i++)
Oliver Neukum37329032020-09-17 13:02:35 +0200206 if(acm->wb[i].use)
207 n--;
David Brownelle5fbab52008-08-06 18:46:10 -0700208 spin_unlock_irqrestore(&acm->write_lock, flags);
Oliver Neukum884b6002005-04-21 21:28:02 +0200209 return n;
210}
211
Oliver Neukum884b6002005-04-21 21:28:02 +0200212/*
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800213 * Finish write. Caller must hold acm->write_lock
Oliver Neukum884b6002005-04-21 21:28:02 +0200214 */
David Engrafe4cf3aa2008-03-20 10:01:34 +0100215static void acm_write_done(struct acm *acm, struct acm_wb *wb)
Oliver Neukum884b6002005-04-21 21:28:02 +0200216{
Oliver Neukum37329032020-09-17 13:02:35 +0200217 wb->use = false;
Oliver Neukum11ea8592008-06-20 11:25:57 +0200218 acm->transmitting--;
Oliver Neukum97d35f92009-12-16 17:05:57 +0100219 usb_autopm_put_interface_async(acm->control);
Oliver Neukum884b6002005-04-21 21:28:02 +0200220}
221
222/*
223 * Poke write.
Oliver Neukum11ea8592008-06-20 11:25:57 +0200224 *
225 * the caller is responsible for locking
Oliver Neukum884b6002005-04-21 21:28:02 +0200226 */
Oliver Neukum11ea8592008-06-20 11:25:57 +0200227
228static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
229{
230 int rc;
231
232 acm->transmitting++;
233
234 wb->urb->transfer_buffer = wb->buf;
235 wb->urb->transfer_dma = wb->dmah;
236 wb->urb->transfer_buffer_length = wb->len;
237 wb->urb->dev = acm->dev;
238
Alan Cox6e47e062009-06-11 12:37:06 +0100239 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
240 if (rc < 0) {
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100241 if (rc != -EPERM)
242 dev_err(&acm->data->dev,
243 "%s - usb_submit_urb(write bulk) failed: %d\n",
244 __func__, rc);
Oliver Neukum11ea8592008-06-20 11:25:57 +0200245 acm_write_done(acm, wb);
246 }
247 return rc;
248}
249
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100250/*
251 * attributes exported through sysfs
252 */
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100253static ssize_t bmCapabilities_show
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100254(struct device *dev, struct device_attribute *attr, char *buf)
255{
256 struct usb_interface *intf = to_usb_interface(dev);
257 struct acm *acm = usb_get_intfdata(intf);
Oliver Neukum884b6002005-04-21 21:28:02 +0200258
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100259 return sprintf(buf, "%d", acm->ctrl_caps);
260}
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100261static DEVICE_ATTR_RO(bmCapabilities);
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100262
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100263static ssize_t wCountryCodes_show
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100264(struct device *dev, struct device_attribute *attr, char *buf)
265{
266 struct usb_interface *intf = to_usb_interface(dev);
267 struct acm *acm = usb_get_intfdata(intf);
268
269 memcpy(buf, acm->country_codes, acm->country_code_size);
270 return acm->country_code_size;
271}
272
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100273static DEVICE_ATTR_RO(wCountryCodes);
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100274
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100275static ssize_t iCountryCodeRelDate_show
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100276(struct device *dev, struct device_attribute *attr, char *buf)
277{
278 struct usb_interface *intf = to_usb_interface(dev);
279 struct acm *acm = usb_get_intfdata(intf);
280
281 return sprintf(buf, "%d", acm->country_rel_date);
282}
283
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100284static DEVICE_ATTR_RO(iCountryCodeRelDate);
Oliver Neukum884b6002005-04-21 21:28:02 +0200285/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 * Interrupt handlers for various ACM device responses
287 */
288
Tobias Herzogea258352017-03-30 22:15:11 +0200289static void acm_process_notification(struct acm *acm, unsigned char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 int newctrl;
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100292 int difference;
Sebastian Andrzej Siewior4685be22018-06-25 00:08:34 +0200293 unsigned long flags;
Tobias Herzogea258352017-03-30 22:15:11 +0200294 struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
295 unsigned char *data = buf + sizeof(struct usb_cdc_notification);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 switch (dr->bNotificationType) {
Alan Cox6e47e062009-06-11 12:37:06 +0100298 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Ladislav Michl90744af82016-11-18 19:01:22 +0100299 dev_dbg(&acm->control->dev,
300 "%s - network connection: %d\n", __func__, dr->wValue);
Alan Cox6e47e062009-06-11 12:37:06 +0100301 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Alan Cox6e47e062009-06-11 12:37:06 +0100303 case USB_CDC_NOTIFY_SERIAL_STATE:
Tobias Herzog1bb99142017-03-30 22:15:10 +0200304 if (le16_to_cpu(dr->wLength) != 2) {
305 dev_dbg(&acm->control->dev,
306 "%s - malformed serial state\n", __func__);
307 break;
308 }
309
Alan Cox6e47e062009-06-11 12:37:06 +0100310 newctrl = get_unaligned_le16(data);
Tobias Herzog2d6dfd12017-03-30 22:15:12 +0200311 dev_dbg(&acm->control->dev,
312 "%s - serial state: 0x%x\n", __func__, newctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Jiri Slabyaa27a092013-03-07 13:12:30 +0100314 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
Ladislav Michl90744af82016-11-18 19:01:22 +0100315 dev_dbg(&acm->control->dev,
316 "%s - calling hangup\n", __func__);
Jiri Slabyaa27a092013-03-07 13:12:30 +0100317 tty_port_tty_hangup(&acm->port, false);
Alan Cox6e47e062009-06-11 12:37:06 +0100318 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100320 difference = acm->ctrlin ^ newctrl;
Sebastian Andrzej Siewior4685be22018-06-25 00:08:34 +0200321 spin_lock_irqsave(&acm->read_lock, flags);
Alan Cox6e47e062009-06-11 12:37:06 +0100322 acm->ctrlin = newctrl;
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100323 acm->oldcount = acm->iocount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100325 if (difference & ACM_CTRL_DSR)
326 acm->iocount.dsr++;
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100327 if (difference & ACM_CTRL_DCD)
328 acm->iocount.dcd++;
Oliver Neukum08dff272021-03-11 14:37:14 +0100329 if (newctrl & ACM_CTRL_BRK) {
Tobias Herzogf976d0e2018-09-22 22:11:11 +0200330 acm->iocount.brk++;
Oliver Neukum08dff272021-03-11 14:37:14 +0100331 tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
332 }
Tobias Herzogf976d0e2018-09-22 22:11:11 +0200333 if (newctrl & ACM_CTRL_RI)
334 acm->iocount.rng++;
335 if (newctrl & ACM_CTRL_FRAMING)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100336 acm->iocount.frame++;
Tobias Herzogf976d0e2018-09-22 22:11:11 +0200337 if (newctrl & ACM_CTRL_PARITY)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100338 acm->iocount.parity++;
Tobias Herzogf976d0e2018-09-22 22:11:11 +0200339 if (newctrl & ACM_CTRL_OVERRUN)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100340 acm->iocount.overrun++;
Sebastian Andrzej Siewior4685be22018-06-25 00:08:34 +0200341 spin_unlock_irqrestore(&acm->read_lock, flags);
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100342
Johan Hovold58fc1da2021-09-29 11:09:37 +0200343 if (newctrl & ACM_CTRL_BRK)
344 tty_flip_buffer_push(&acm->port);
345
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100346 if (difference)
347 wake_up_all(&acm->wioctl);
348
349 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Alan Cox6e47e062009-06-11 12:37:06 +0100351 default:
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100352 dev_dbg(&acm->control->dev,
Tobias Herzog1bb99142017-03-30 22:15:10 +0200353 "%s - unknown notification %d received: index %d len %d\n",
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100354 __func__,
Tobias Herzog1bb99142017-03-30 22:15:10 +0200355 dr->bNotificationType, dr->wIndex, dr->wLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
Tobias Herzogea258352017-03-30 22:15:11 +0200357}
358
359/* control interface reports status changes with "interrupt" transfers */
360static void acm_ctrl_irq(struct urb *urb)
361{
362 struct acm *acm = urb->context;
363 struct usb_cdc_notification *dr = urb->transfer_buffer;
364 unsigned int current_size = urb->actual_length;
365 unsigned int expected_size, copy_size, alloc_size;
366 int retval;
367 int status = urb->status;
368
369 switch (status) {
370 case 0:
371 /* success */
372 break;
373 case -ECONNRESET:
374 case -ENOENT:
375 case -ESHUTDOWN:
376 /* this urb is terminated, clean up */
Tobias Herzogea258352017-03-30 22:15:11 +0200377 dev_dbg(&acm->control->dev,
378 "%s - urb shutting down with status: %d\n",
379 __func__, status);
380 return;
381 default:
382 dev_dbg(&acm->control->dev,
383 "%s - nonzero urb status received: %d\n",
384 __func__, status);
385 goto exit;
386 }
387
388 usb_mark_last_busy(acm->dev);
389
390 if (acm->nb_index)
391 dr = (struct usb_cdc_notification *)acm->notification_buffer;
392
393 /* size = notification-header + (optional) data */
394 expected_size = sizeof(struct usb_cdc_notification) +
395 le16_to_cpu(dr->wLength);
396
397 if (current_size < expected_size) {
398 /* notification is transmitted fragmented, reassemble */
399 if (acm->nb_size < expected_size) {
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700400 u8 *new_buffer;
Tobias Herzogea258352017-03-30 22:15:11 +0200401 alloc_size = roundup_pow_of_two(expected_size);
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700402 /* Final freeing is done on disconnect. */
403 new_buffer = krealloc(acm->notification_buffer,
404 alloc_size, GFP_ATOMIC);
405 if (!new_buffer) {
406 acm->nb_index = 0;
Tobias Herzogea258352017-03-30 22:15:11 +0200407 goto exit;
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700408 }
409
410 acm->notification_buffer = new_buffer;
Tobias Herzogea258352017-03-30 22:15:11 +0200411 acm->nb_size = alloc_size;
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700412 dr = (struct usb_cdc_notification *)acm->notification_buffer;
Tobias Herzogea258352017-03-30 22:15:11 +0200413 }
414
415 copy_size = min(current_size,
416 expected_size - acm->nb_index);
417
418 memcpy(&acm->notification_buffer[acm->nb_index],
419 urb->transfer_buffer, copy_size);
420 acm->nb_index += copy_size;
421 current_size = acm->nb_index;
422 }
423
424 if (current_size >= expected_size) {
425 /* notification complete */
426 acm_process_notification(acm, (unsigned char *)dr);
427 acm->nb_index = 0;
428 }
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430exit:
Alan Cox6e47e062009-06-11 12:37:06 +0100431 retval = usb_submit_urb(urb, GFP_ATOMIC);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200432 if (retval && retval != -EPERM && retval != -ENODEV)
Ladislav Michl90744af82016-11-18 19:01:22 +0100433 dev_err(&acm->control->dev,
434 "%s - usb_submit_urb failed: %d\n", __func__, retval);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200435 else
436 dev_vdbg(&acm->control->dev,
437 "control resubmission terminated %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438}
439
Johan Hovold088c64f2011-03-25 11:06:02 +0100440static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
Johan Hovold088c64f2011-03-25 11:06:02 +0100442 int res;
Greg Kroah-Hartman185d4052007-07-18 10:58:02 -0700443
Johan Hovold088c64f2011-03-25 11:06:02 +0100444 if (!test_and_clear_bit(index, &acm->read_urbs_free))
445 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Johan Hovold088c64f2011-03-25 11:06:02 +0100447 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
448 if (res) {
Hans de Goedef0386c02018-01-14 16:09:00 +0100449 if (res != -EPERM && res != -ENODEV) {
Johan Hovold088c64f2011-03-25 11:06:02 +0100450 dev_err(&acm->data->dev,
Ladislav Michl90744af82016-11-18 19:01:22 +0100451 "urb %d failed submission with %d\n",
452 index, res);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200453 } else {
454 dev_vdbg(&acm->data->dev, "intended failure %d\n", res);
Johan Hovold088c64f2011-03-25 11:06:02 +0100455 }
456 set_bit(index, &acm->read_urbs_free);
457 return res;
Oliver Neukum46e75072016-09-13 16:44:36 +0200458 } else {
459 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
Johan Hovold088c64f2011-03-25 11:06:02 +0100460 }
461
462 return 0;
463}
464
465static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
466{
467 int res;
468 int i;
469
470 for (i = 0; i < acm->rx_buflimit; ++i) {
471 res = acm_submit_read_urb(acm, i, mem_flags);
472 if (res)
473 return res;
474 }
475
476 return 0;
477}
478
479static void acm_process_read_urb(struct acm *acm, struct urb *urb)
480{
Johan Hovold65a205e2021-09-29 11:09:36 +0200481 unsigned long flags;
482
Johan Hovold088c64f2011-03-25 11:06:02 +0100483 if (!urb->actual_length)
484 return;
485
Johan Hovold65a205e2021-09-29 11:09:36 +0200486 spin_lock_irqsave(&acm->read_lock, flags);
Jiri Slaby05c7cd32013-01-03 15:53:04 +0100487 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
488 urb->actual_length);
Johan Hovold65a205e2021-09-29 11:09:36 +0200489 spin_unlock_irqrestore(&acm->read_lock, flags);
490
Jiri Slaby2e124b42013-01-03 15:53:06 +0100491 tty_flip_buffer_push(&acm->port);
Johan Hovold088c64f2011-03-25 11:06:02 +0100492}
493
494static void acm_read_bulk_callback(struct urb *urb)
495{
496 struct acm_rb *rb = urb->context;
497 struct acm *acm = rb->instance;
Oliver Neukum36e59e02015-03-20 09:24:24 +0100498 int status = urb->status;
Johan Hovold764478f2019-04-25 18:05:39 +0200499 bool stopped = false;
500 bool stalled = false;
Oliver Neukuma4e72792020-04-15 17:13:58 +0200501 bool cooldown = false;
Johan Hovold088c64f2011-03-25 11:06:02 +0100502
Oliver Neukumefbe27b2016-09-13 16:44:37 +0200503 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
Ladislav Michl90744af82016-11-18 19:01:22 +0100504 rb->index, urb->actual_length, status);
Johan Hovold088c64f2011-03-25 11:06:02 +0100505
Ladislav Michl1aba5792016-11-18 19:11:26 +0100506 switch (status) {
507 case 0:
508 usb_mark_last_busy(acm->dev);
509 acm_process_read_urb(acm, urb);
510 break;
511 case -EPIPE:
512 set_bit(EVENT_RX_STALL, &acm->flags);
Johan Hovold764478f2019-04-25 18:05:39 +0200513 stalled = true;
514 break;
Ladislav Michl1aba5792016-11-18 19:11:26 +0100515 case -ENOENT:
516 case -ECONNRESET:
517 case -ESHUTDOWN:
518 dev_dbg(&acm->data->dev,
519 "%s - urb shutting down with status: %d\n",
520 __func__, status);
Johan Hovold764478f2019-04-25 18:05:39 +0200521 stopped = true;
522 break;
Oliver Neukuma4e72792020-04-15 17:13:58 +0200523 case -EOVERFLOW:
524 case -EPROTO:
525 dev_dbg(&acm->data->dev,
526 "%s - cooling babbling device\n", __func__);
527 usb_mark_last_busy(acm->dev);
528 set_bit(rb->index, &acm->urbs_in_error_delay);
Jerome Brunet38203b82020-10-19 19:07:02 +0200529 set_bit(ACM_ERROR_DELAY, &acm->flags);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200530 cooldown = true;
531 break;
Ladislav Michl1aba5792016-11-18 19:11:26 +0100532 default:
533 dev_dbg(&acm->data->dev,
534 "%s - nonzero urb status received: %d\n",
535 __func__, status);
536 break;
Johan Hovold088c64f2011-03-25 11:06:02 +0100537 }
Johan Hovold4a8ee502014-05-26 19:23:49 +0200538
Oliver Neukum36e59e02015-03-20 09:24:24 +0100539 /*
Johan Hovold764478f2019-04-25 18:05:39 +0200540 * Make sure URB processing is done before marking as free to avoid
541 * racing with unthrottle() on another CPU. Matches the barriers
542 * implied by the test_and_clear_bit() in acm_submit_read_urb().
Oliver Neukum36e59e02015-03-20 09:24:24 +0100543 */
544 smp_mb__before_atomic();
Johan Hovold764478f2019-04-25 18:05:39 +0200545 set_bit(rb->index, &acm->read_urbs_free);
546 /*
547 * Make sure URB is marked as free before checking the throttled flag
548 * to avoid racing with unthrottle() on another CPU. Matches the
549 * smp_mb() in unthrottle().
550 */
551 smp_mb__after_atomic();
552
Oliver Neukuma4e72792020-04-15 17:13:58 +0200553 if (stopped || stalled || cooldown) {
Johan Hovold764478f2019-04-25 18:05:39 +0200554 if (stalled)
Jerome Brunet38203b82020-10-19 19:07:02 +0200555 schedule_delayed_work(&acm->dwork, 0);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200556 else if (cooldown)
557 schedule_delayed_work(&acm->dwork, HZ / 2);
Johan Hovold764478f2019-04-25 18:05:39 +0200558 return;
559 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Johan Hovold0f023212019-04-25 18:05:40 +0200561 if (test_bit(ACM_THROTTLED, &acm->flags))
562 return;
563
564 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
567/* data interface wrote those outgoing bytes */
David Howells7d12e782006-10-05 14:55:46 +0100568static void acm_write_bulk(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
Ming Leicdc97792008-02-24 18:41:47 +0800570 struct acm_wb *wb = urb->context;
David Brownelle5fbab52008-08-06 18:46:10 -0700571 struct acm *acm = wb->instance;
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800572 unsigned long flags;
Oliver Neukum4132cd02015-03-20 11:41:06 +0100573 int status = urb->status;
Oliver Neukum884b6002005-04-21 21:28:02 +0200574
Oliver Neukum4132cd02015-03-20 11:41:06 +0100575 if (status || (urb->actual_length != urb->transfer_buffer_length))
Oliver Neukumefbe27b2016-09-13 16:44:37 +0200576 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
David Brownelle5fbab52008-08-06 18:46:10 -0700577 urb->actual_length,
578 urb->transfer_buffer_length,
Oliver Neukum4132cd02015-03-20 11:41:06 +0100579 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800581 spin_lock_irqsave(&acm->write_lock, flags);
David Engrafe4cf3aa2008-03-20 10:01:34 +0100582 acm_write_done(acm, wb);
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800583 spin_unlock_irqrestore(&acm->write_lock, flags);
Ladislav Michl1aba5792016-11-18 19:11:26 +0100584 set_bit(EVENT_TTY_WAKEUP, &acm->flags);
Jerome Brunet38203b82020-10-19 19:07:02 +0200585 schedule_delayed_work(&acm->dwork, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586}
587
David Howellsc4028952006-11-22 14:57:56 +0000588static void acm_softint(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Ladislav Michl1aba5792016-11-18 19:11:26 +0100590 int i;
Jerome Brunet38203b82020-10-19 19:07:02 +0200591 struct acm *acm = container_of(work, struct acm, dwork.work);
David Brownelle5fbab52008-08-06 18:46:10 -0700592
Ladislav Michl1aba5792016-11-18 19:11:26 +0100593 if (test_bit(EVENT_RX_STALL, &acm->flags)) {
Oliver Neukum0afccd72020-04-15 17:13:57 +0200594 smp_mb(); /* against acm_suspend() */
595 if (!acm->susp_count) {
Ladislav Michl1aba5792016-11-18 19:11:26 +0100596 for (i = 0; i < acm->rx_buflimit; i++)
597 usb_kill_urb(acm->read_urbs[i]);
598 usb_clear_halt(acm->dev, acm->in);
599 acm_submit_read_urbs(acm, GFP_KERNEL);
Oliver Neukum0afccd72020-04-15 17:13:57 +0200600 clear_bit(EVENT_RX_STALL, &acm->flags);
Ladislav Michl1aba5792016-11-18 19:11:26 +0100601 }
Ladislav Michl1aba5792016-11-18 19:11:26 +0100602 }
603
Oliver Neukuma4e72792020-04-15 17:13:58 +0200604 if (test_and_clear_bit(ACM_ERROR_DELAY, &acm->flags)) {
Oliver Neukum97fe8092020-05-26 14:44:20 +0200605 for (i = 0; i < acm->rx_buflimit; i++)
Oliver Neukuma4e72792020-04-15 17:13:58 +0200606 if (test_and_clear_bit(i, &acm->urbs_in_error_delay))
Jerome Brunet38203b82020-10-19 19:07:02 +0200607 acm_submit_read_urb(acm, i, GFP_KERNEL);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200608 }
609
Romain Izard93e1c8a2019-03-22 16:53:02 +0100610 if (test_and_clear_bit(EVENT_TTY_WAKEUP, &acm->flags))
Ladislav Michl1aba5792016-11-18 19:11:26 +0100611 tty_port_tty_wakeup(&acm->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
613
614/*
615 * TTY handlers
616 */
617
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800618static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
620 struct acm *acm;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800621 int retval;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100622
Johan Hovold6cb4f4d2015-05-18 17:34:11 +0200623 acm = acm_get_by_minor(tty->index);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800624 if (!acm)
625 return -ENODEV;
626
Jiri Slabyf8a8c102012-03-05 14:51:48 +0100627 retval = tty_standard_install(driver, tty);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800628 if (retval)
629 goto error_init_termios;
630
Macpaul Lineafb27f2018-12-19 12:11:03 +0800631 /*
632 * Suppress initial echoing for some devices which might send data
633 * immediately after acm driver has been installed.
634 */
635 if (acm->quirks & DISABLE_ECHO)
636 tty->termios.c_lflag &= ~ECHO;
637
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800638 tty->driver_data = acm;
639
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800640 return 0;
641
642error_init_termios:
643 tty_port_put(&acm->port);
644 return retval;
645}
646
647static int acm_tty_open(struct tty_struct *tty, struct file *filp)
648{
649 struct acm *acm = tty->driver_data;
650
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800651 return tty_port_open(&acm->port, tty, filp);
652}
653
Johan Hovold0943d8e2014-05-26 19:23:51 +0200654static void acm_port_dtr_rts(struct tty_port *port, int raise)
655{
656 struct acm *acm = container_of(port, struct acm, port);
657 int val;
658 int res;
659
660 if (raise)
661 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
662 else
663 val = 0;
664
665 /* FIXME: add missing ctrlout locking throughout driver */
666 acm->ctrlout = val;
667
668 res = acm_set_control(acm, val);
669 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
Oliver Neukume4c77072021-03-11 14:01:26 +0100670 /* This is broken in too many devices to spam the logs */
671 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
Johan Hovold0943d8e2014-05-26 19:23:51 +0200672}
673
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800674static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
675{
676 struct acm *acm = container_of(port, struct acm, port);
677 int retval = -ENODEV;
Johan Hovolde4c36072014-05-26 19:23:44 +0200678 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Oliver Neukum1365baf72007-10-12 17:24:28 +0200680 mutex_lock(&acm->mutex);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800681 if (acm->disconnected)
682 goto disconnected;
683
684 retval = usb_autopm_get_interface(acm->control);
685 if (retval)
686 goto error_get_interface;
687
688 /*
689 * FIXME: Why do we need this? Allocating 64K of physically contiguous
690 * memory is really nasty...
691 */
692 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
693 acm->control->needs_remote_wakeup = 1;
Oliver Neukum1365baf72007-10-12 17:24:28 +0200694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 acm->ctrlurb->dev = acm->dev;
Johan Hovold8727bf62014-05-26 19:23:43 +0200696 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
697 if (retval) {
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100698 dev_err(&acm->control->dev,
699 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800700 goto error_submit_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 }
702
Jim Paris24cb4502014-10-30 11:04:47 -0400703 acm_tty_set_termios(tty, NULL);
704
Otto Meta6c4707f2012-06-06 18:46:21 +0200705 /*
706 * Unthrottle device in case the TTY was closed while throttled.
707 */
Johan Hovold0f023212019-04-25 18:05:40 +0200708 clear_bit(ACM_THROTTLED, &acm->flags);
Otto Meta6c4707f2012-06-06 18:46:21 +0200709
Johan Hovold8727bf62014-05-26 19:23:43 +0200710 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
711 if (retval)
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800712 goto error_submit_read_urbs;
Oliver Neukum2b626dc2010-02-03 17:10:22 +0100713
Johan Hovold703df322014-05-26 19:23:42 +0200714 usb_autopm_put_interface(acm->control);
715
Oliver Neukum1365baf72007-10-12 17:24:28 +0200716 mutex_unlock(&acm->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800718 return 0;
719
720error_submit_read_urbs:
Johan Hovolde4c36072014-05-26 19:23:44 +0200721 for (i = 0; i < acm->rx_buflimit; i++)
722 usb_kill_urb(acm->read_urbs[i]);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800723 usb_kill_urb(acm->ctrlurb);
724error_submit_urb:
Johan Hovold703df322014-05-26 19:23:42 +0200725 usb_autopm_put_interface(acm->control);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800726error_get_interface:
727disconnected:
728 mutex_unlock(&acm->mutex);
Johan Hovold8727bf62014-05-26 19:23:43 +0200729
730 return usb_translate_errors(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731}
732
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800733static void acm_port_destruct(struct tty_port *port)
brian@murphy.dk83ef3442005-06-29 16:53:29 -0700734{
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800735 struct acm *acm = container_of(port, struct acm, port);
736
Johan Hovold91fac072021-09-07 10:23:18 +0200737 if (acm->minor != ACM_MINOR_INVALID)
738 acm_release_minor(acm);
brian@murphy.dk83ef3442005-06-29 16:53:29 -0700739 usb_put_intf(acm->control);
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100740 kfree(acm->country_codes);
brian@murphy.dk83ef3442005-06-29 16:53:29 -0700741 kfree(acm);
742}
743
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800744static void acm_port_shutdown(struct tty_port *port)
Alan Cox10077d42009-06-11 12:36:09 +0100745{
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800746 struct acm *acm = container_of(port, struct acm, port);
Johan Hovold140cb812014-05-26 19:23:38 +0200747 struct urb *urb;
748 struct acm_wb *wb;
Johan Hovolddab54c92011-03-22 11:12:21 +0100749
Johan Hovoldb1d42ef2014-05-26 19:23:48 +0200750 /*
751 * Need to grab write_lock to prevent race with resume, but no need to
752 * hold it due to the tty-port initialised flag.
753 */
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100754 acm_poison_urbs(acm);
Johan Hovoldb1d42ef2014-05-26 19:23:48 +0200755 spin_lock_irq(&acm->write_lock);
756 spin_unlock_irq(&acm->write_lock);
757
758 usb_autopm_get_interface_no_resume(acm->control);
759 acm->control->needs_remote_wakeup = 0;
760 usb_autopm_put_interface(acm->control);
761
Johan Hovold89e54e42014-05-26 19:23:47 +0200762 for (;;) {
763 urb = usb_get_from_anchor(&acm->delayed);
764 if (!urb)
765 break;
766 wb = urb->context;
Oliver Neukum37329032020-09-17 13:02:35 +0200767 wb->use = false;
Johan Hovold89e54e42014-05-26 19:23:47 +0200768 usb_autopm_put_interface_async(acm->control);
Alan Cox10077d42009-06-11 12:36:09 +0100769 }
Johan Hovold89e54e42014-05-26 19:23:47 +0200770
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100771 acm_unpoison_urbs(acm);
772
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800773}
774
775static void acm_tty_cleanup(struct tty_struct *tty)
776{
777 struct acm *acm = tty->driver_data;
Oliver Neukumab57f862016-09-07 14:30:01 +0200778
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800779 tty_port_put(&acm->port);
Alan Cox10077d42009-06-11 12:36:09 +0100780}
781
782static void acm_tty_hangup(struct tty_struct *tty)
783{
784 struct acm *acm = tty->driver_data;
Oliver Neukumab57f862016-09-07 14:30:01 +0200785
Alan Cox10077d42009-06-11 12:36:09 +0100786 tty_port_hangup(&acm->port);
Alan Cox10077d42009-06-11 12:36:09 +0100787}
788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789static void acm_tty_close(struct tty_struct *tty, struct file *filp)
790{
791 struct acm *acm = tty->driver_data;
Oliver Neukumab57f862016-09-07 14:30:01 +0200792
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800793 tty_port_close(&acm->port, tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794}
795
Alan Cox6e47e062009-06-11 12:37:06 +0100796static int acm_tty_write(struct tty_struct *tty,
797 const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
799 struct acm *acm = tty->driver_data;
800 int stat;
Oliver Neukum884b6002005-04-21 21:28:02 +0200801 unsigned long flags;
802 int wbn;
803 struct acm_wb *wb;
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 if (!count)
806 return 0;
807
Oliver Neukumefbe27b2016-09-13 16:44:37 +0200808 dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100809
Oliver Neukum884b6002005-04-21 21:28:02 +0200810 spin_lock_irqsave(&acm->write_lock, flags);
Alan Cox6e47e062009-06-11 12:37:06 +0100811 wbn = acm_wb_alloc(acm);
812 if (wbn < 0) {
Oliver Neukum884b6002005-04-21 21:28:02 +0200813 spin_unlock_irqrestore(&acm->write_lock, flags);
Oliver Neukum884b6002005-04-21 21:28:02 +0200814 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 }
Oliver Neukum884b6002005-04-21 21:28:02 +0200816 wb = &acm->wb[wbn];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700818 if (!acm->dev) {
Oliver Neukum37329032020-09-17 13:02:35 +0200819 wb->use = false;
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700820 spin_unlock_irqrestore(&acm->write_lock, flags);
821 return -ENODEV;
822 }
823
Oliver Neukum884b6002005-04-21 21:28:02 +0200824 count = (count > acm->writesize) ? acm->writesize : count;
Oliver Neukumefbe27b2016-09-13 16:44:37 +0200825 dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
Oliver Neukum884b6002005-04-21 21:28:02 +0200826 memcpy(wb->buf, buf, count);
827 wb->len = count;
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700828
Johan Hovold183a4502014-05-26 19:23:41 +0200829 stat = usb_autopm_get_interface_async(acm->control);
830 if (stat) {
Oliver Neukum37329032020-09-17 13:02:35 +0200831 wb->use = false;
Johan Hovold183a4502014-05-26 19:23:41 +0200832 spin_unlock_irqrestore(&acm->write_lock, flags);
833 return stat;
834 }
835
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700836 if (acm->susp_count) {
Johan Hovold140cb812014-05-26 19:23:38 +0200837 usb_anchor_urb(wb->urb, &acm->delayed);
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700838 spin_unlock_irqrestore(&acm->write_lock, flags);
Johan Hovold140cb812014-05-26 19:23:38 +0200839 return count;
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700840 }
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700841
842 stat = acm_start_wb(acm, wb);
Oliver Neukum884b6002005-04-21 21:28:02 +0200843 spin_unlock_irqrestore(&acm->write_lock, flags);
844
Alan Cox6e47e062009-06-11 12:37:06 +0100845 if (stat < 0)
Oliver Neukum884b6002005-04-21 21:28:02 +0200846 return stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 return count;
848}
849
Jiri Slaby03b3b1a2021-05-05 11:19:15 +0200850static unsigned int acm_tty_write_room(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
852 struct acm *acm = tty->driver_data;
Oliver Neukum884b6002005-04-21 21:28:02 +0200853 /*
854 * Do not let the line discipline to know that we have a reserve,
855 * or it might get too enthusiastic.
856 */
David Brownell934da462008-08-06 18:44:12 -0700857 return acm_wb_is_avail(acm) ? acm->writesize : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858}
859
Jiri Slabyfff4ef12021-05-05 11:19:19 +0200860static unsigned int acm_tty_chars_in_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861{
862 struct acm *acm = tty->driver_data;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800863 /*
864 * if the device was unplugged then any remaining characters fell out
865 * of the connector ;)
866 */
867 if (acm->disconnected)
Alan Cox23198fd2009-07-20 16:05:27 +0100868 return 0;
Oliver Neukum884b6002005-04-21 21:28:02 +0200869 /*
870 * This is inaccurate (overcounts), but it works.
871 */
Oliver Neukum86478942006-05-13 22:50:47 +0200872 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873}
874
875static void acm_tty_throttle(struct tty_struct *tty)
876{
877 struct acm *acm = tty->driver_data;
Johan Hovold088c64f2011-03-25 11:06:02 +0100878
Johan Hovold0f023212019-04-25 18:05:40 +0200879 set_bit(ACM_THROTTLED, &acm->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880}
881
882static void acm_tty_unthrottle(struct tty_struct *tty)
883{
884 struct acm *acm = tty->driver_data;
Johan Hovold088c64f2011-03-25 11:06:02 +0100885
Johan Hovold0f023212019-04-25 18:05:40 +0200886 clear_bit(ACM_THROTTLED, &acm->flags);
Johan Hovold088c64f2011-03-25 11:06:02 +0100887
Johan Hovold764478f2019-04-25 18:05:39 +0200888 /* Matches the smp_mb__after_atomic() in acm_read_bulk_callback(). */
889 smp_mb();
890
Johan Hovold0f023212019-04-25 18:05:40 +0200891 acm_submit_read_urbs(acm, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892}
893
Alan Cox9e98966c2008-07-22 11:18:03 +0100894static int acm_tty_break_ctl(struct tty_struct *tty, int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895{
896 struct acm *acm = tty->driver_data;
Alan Cox9e98966c2008-07-22 11:18:03 +0100897 int retval;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800898
Alan Cox9e98966c2008-07-22 11:18:03 +0100899 retval = acm_send_break(acm, state ? 0xffff : 0);
900 if (retval < 0)
Ladislav Michl90744af82016-11-18 19:01:22 +0100901 dev_dbg(&acm->control->dev,
902 "%s - send break failed\n", __func__);
Alan Cox9e98966c2008-07-22 11:18:03 +0100903 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904}
905
Alan Cox60b33c12011-02-14 16:26:14 +0000906static int acm_tty_tiocmget(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907{
908 struct acm *acm = tty->driver_data;
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
911 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
912 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
913 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
914 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
915 TIOCM_CTS;
916}
917
Alan Cox20b9d172011-02-14 16:26:50 +0000918static int acm_tty_tiocmset(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 unsigned int set, unsigned int clear)
920{
921 struct acm *acm = tty->driver_data;
922 unsigned int newctrl;
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 newctrl = acm->ctrlout;
Alan Cox6e47e062009-06-11 12:37:06 +0100925 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
926 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
927 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
928 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
930 newctrl = (newctrl & ~clear) | set;
931
932 if (acm->ctrlout == newctrl)
933 return 0;
934 return acm_set_control(acm, acm->ctrlout = newctrl);
935}
936
Al Viro99f75a12018-09-11 23:33:40 -0400937static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
Oliver Neukum18c75722012-02-17 17:21:24 -0500938{
Al Viro99f75a12018-09-11 23:33:40 -0400939 struct acm *acm = tty->driver_data;
Oliver Neukum18c75722012-02-17 17:21:24 -0500940
Johan Hovold49696022021-04-08 15:16:02 +0200941 ss->line = acm->minor;
Anthony Mallet633e2b22020-03-12 14:31:00 +0100942 ss->close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
Al Viro99f75a12018-09-11 23:33:40 -0400943 ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600944 ASYNC_CLOSING_WAIT_NONE :
Anthony Mallet633e2b22020-03-12 14:31:00 +0100945 jiffies_to_msecs(acm->port.closing_wait) / 10;
Al Viro99f75a12018-09-11 23:33:40 -0400946 return 0;
Oliver Neukum18c75722012-02-17 17:21:24 -0500947}
948
Al Viro99f75a12018-09-11 23:33:40 -0400949static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600950{
Al Viro99f75a12018-09-11 23:33:40 -0400951 struct acm *acm = tty->driver_data;
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600952 unsigned int closing_wait, close_delay;
953 int retval = 0;
954
Anthony Mallet633e2b22020-03-12 14:31:00 +0100955 close_delay = msecs_to_jiffies(ss->close_delay * 10);
Al Viro99f75a12018-09-11 23:33:40 -0400956 closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
Anthony Mallet633e2b22020-03-12 14:31:00 +0100957 ASYNC_CLOSING_WAIT_NONE :
958 msecs_to_jiffies(ss->closing_wait * 10);
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600959
960 mutex_lock(&acm->port.mutex);
961
Matthias Reichl62d65bd2020-03-27 16:03:50 +0100962 if (!capable(CAP_SYS_ADMIN)) {
Johan Hovold729f7952021-04-08 15:16:00 +0200963 if ((close_delay != acm->port.close_delay) ||
964 (closing_wait != acm->port.closing_wait))
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600965 retval = -EPERM;
Matthias Reichl62d65bd2020-03-27 16:03:50 +0100966 } else {
967 acm->port.close_delay = close_delay;
968 acm->port.closing_wait = closing_wait;
969 }
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600970
971 mutex_unlock(&acm->port.mutex);
972 return retval;
973}
974
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100975static int wait_serial_change(struct acm *acm, unsigned long arg)
976{
977 int rv = 0;
978 DECLARE_WAITQUEUE(wait, current);
979 struct async_icount old, new;
980
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100981 do {
982 spin_lock_irq(&acm->read_lock);
983 old = acm->oldcount;
984 new = acm->iocount;
985 acm->oldcount = new;
986 spin_unlock_irq(&acm->read_lock);
987
988 if ((arg & TIOCM_DSR) &&
989 old.dsr != new.dsr)
990 break;
991 if ((arg & TIOCM_CD) &&
992 old.dcd != new.dcd)
993 break;
994 if ((arg & TIOCM_RI) &&
995 old.rng != new.rng)
996 break;
997
998 add_wait_queue(&acm->wioctl, &wait);
999 set_current_state(TASK_INTERRUPTIBLE);
1000 schedule();
1001 remove_wait_queue(&acm->wioctl, &wait);
1002 if (acm->disconnected) {
1003 if (arg & TIOCM_CD)
1004 break;
1005 else
1006 rv = -ENODEV;
1007 } else {
1008 if (signal_pending(current))
1009 rv = -ERESTARTSYS;
1010 }
1011 } while (!rv);
1012
1013
1014
1015 return rv;
1016}
1017
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001018static int acm_tty_get_icount(struct tty_struct *tty,
1019 struct serial_icounter_struct *icount)
Oliver Neukum797ef132013-11-20 11:35:35 +01001020{
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001021 struct acm *acm = tty->driver_data;
Oliver Neukum797ef132013-11-20 11:35:35 +01001022
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001023 icount->dsr = acm->iocount.dsr;
1024 icount->rng = acm->iocount.rng;
1025 icount->dcd = acm->iocount.dcd;
1026 icount->frame = acm->iocount.frame;
1027 icount->overrun = acm->iocount.overrun;
1028 icount->parity = acm->iocount.parity;
1029 icount->brk = acm->iocount.brk;
Oliver Neukum797ef132013-11-20 11:35:35 +01001030
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001031 return 0;
Oliver Neukum797ef132013-11-20 11:35:35 +01001032}
1033
Alan Cox6caa76b2011-02-14 16:27:22 +00001034static int acm_tty_ioctl(struct tty_struct *tty,
Alan Cox6e47e062009-06-11 12:37:06 +01001035 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036{
Oliver Neukum18c75722012-02-17 17:21:24 -05001037 struct acm *acm = tty->driver_data;
1038 int rv = -ENOIOCTLCMD;
1039
1040 switch (cmd) {
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001041 case TIOCMIWAIT:
Oliver Neukum8fdbeb22013-11-20 11:35:36 +01001042 rv = usb_autopm_get_interface(acm->control);
1043 if (rv < 0) {
1044 rv = -EIO;
1045 break;
1046 }
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001047 rv = wait_serial_change(acm, arg);
Oliver Neukum8fdbeb22013-11-20 11:35:36 +01001048 usb_autopm_put_interface(acm->control);
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001049 break;
Oliver Neukum18c75722012-02-17 17:21:24 -05001050 }
1051
1052 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053}
1054
Alan Cox6e47e062009-06-11 12:37:06 +01001055static void acm_tty_set_termios(struct tty_struct *tty,
1056 struct ktermios *termios_old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057{
1058 struct acm *acm = tty->driver_data;
Alan Coxadc8d742012-07-14 15:31:47 +01001059 struct ktermios *termios = &tty->termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 struct usb_cdc_line_coding newline;
1061 int newctrl = acm->ctrlout;
1062
Alan Cox9b80fee2009-09-19 13:13:23 -07001063 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1065 newline.bParityType = termios->c_cflag & PARENB ?
Alan Cox6e47e062009-06-11 12:37:06 +01001066 (termios->c_cflag & PARODD ? 1 : 2) +
1067 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
Jiri Slaby3ec2ff32021-06-10 11:02:47 +02001068 newline.bDataBits = tty_get_char_size(termios->c_cflag);
1069
Alan Cox6e47e062009-06-11 12:37:06 +01001070 /* FIXME: Needs to clear unsupported bits in the termios */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1072
Johan Hovold4473d052014-11-05 18:41:59 +01001073 if (C_BAUD(tty) == B0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 newline.dwDTERate = acm->line.dwDTERate;
1075 newctrl &= ~ACM_CTRL_DTR;
Johan Hovold4473d052014-11-05 18:41:59 +01001076 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
Alan Cox6e47e062009-06-11 12:37:06 +01001077 newctrl |= ACM_CTRL_DTR;
Johan Hovold4473d052014-11-05 18:41:59 +01001078 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
1080 if (newctrl != acm->ctrlout)
1081 acm_set_control(acm, acm->ctrlout = newctrl);
1082
1083 if (memcmp(&acm->line, &newline, sizeof newline)) {
1084 memcpy(&acm->line, &newline, sizeof newline);
Johan Hovolda5cc7ef2011-03-22 11:12:15 +01001085 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1086 __func__,
1087 le32_to_cpu(newline.dwDTERate),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 newline.bCharFormat, newline.bParityType,
1089 newline.bDataBits);
1090 acm_set_line(acm, &acm->line);
1091 }
1092}
1093
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001094static const struct tty_port_operations acm_port_ops = {
Johan Hovold0943d8e2014-05-26 19:23:51 +02001095 .dtr_rts = acm_port_dtr_rts,
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001096 .shutdown = acm_port_shutdown,
1097 .activate = acm_port_activate,
1098 .destruct = acm_port_destruct,
1099};
1100
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101/*
1102 * USB probe and disconnect routines.
1103 */
1104
Oliver Neukum830f4022008-06-25 14:17:16 +02001105/* Little helpers: write/read buffers free */
Oliver Neukum884b6002005-04-21 21:28:02 +02001106static void acm_write_buffers_free(struct acm *acm)
1107{
1108 int i;
1109 struct acm_wb *wb;
1110
Alan Cox6e47e062009-06-11 12:37:06 +01001111 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
Ladislav Michle4614602016-11-18 19:06:10 +01001112 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
Oliver Neukum884b6002005-04-21 21:28:02 +02001113}
1114
Oliver Neukum830f4022008-06-25 14:17:16 +02001115static void acm_read_buffers_free(struct acm *acm)
1116{
Johan Hovolddab54c92011-03-22 11:12:21 +01001117 int i;
Oliver Neukum830f4022008-06-25 14:17:16 +02001118
Johan Hovolddab54c92011-03-22 11:12:21 +01001119 for (i = 0; i < acm->rx_buflimit; i++)
Ladislav Michle4614602016-11-18 19:06:10 +01001120 usb_free_coherent(acm->dev, acm->readsize,
Johan Hovold088c64f2011-03-25 11:06:02 +01001121 acm->read_buffers[i].base, acm->read_buffers[i].dma);
Oliver Neukum830f4022008-06-25 14:17:16 +02001122}
1123
Oliver Neukum884b6002005-04-21 21:28:02 +02001124/* Little helper: write buffers allocate */
1125static int acm_write_buffers_alloc(struct acm *acm)
1126{
1127 int i;
1128 struct acm_wb *wb;
1129
Oliver Neukum86478942006-05-13 22:50:47 +02001130 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
Daniel Mack997ea582010-04-12 13:17:25 +02001131 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
Oliver Neukum884b6002005-04-21 21:28:02 +02001132 &wb->dmah);
1133 if (!wb->buf) {
1134 while (i != 0) {
1135 --i;
1136 --wb;
Daniel Mack997ea582010-04-12 13:17:25 +02001137 usb_free_coherent(acm->dev, acm->writesize,
Oliver Neukum884b6002005-04-21 21:28:02 +02001138 wb->buf, wb->dmah);
1139 }
1140 return -ENOMEM;
1141 }
1142 }
1143 return 0;
1144}
1145
Alan Cox10077d42009-06-11 12:36:09 +01001146static int acm_probe(struct usb_interface *intf,
1147 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148{
1149 struct usb_cdc_union_desc *union_header = NULL;
Oliver Neukumcb42b632016-07-14 15:41:34 +02001150 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
David Brownellc6dbf552008-04-13 14:00:44 -07001151 unsigned char *buffer = intf->altsetting->extra;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 int buflen = intf->altsetting->extralen;
1153 struct usb_interface *control_interface;
1154 struct usb_interface *data_interface;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001155 struct usb_endpoint_descriptor *epctrl = NULL;
1156 struct usb_endpoint_descriptor *epread = NULL;
1157 struct usb_endpoint_descriptor *epwrite = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 struct usb_device *usb_dev = interface_to_usbdev(intf);
Oliver Neukumcb42b632016-07-14 15:41:34 +02001159 struct usb_cdc_parsed_header h;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 struct acm *acm;
1161 int minor;
Alan Cox6e47e062009-06-11 12:37:06 +01001162 int ctrlsize, readsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 u8 *buf;
Oliver Neukumcb42b632016-07-14 15:41:34 +02001164 int call_intf_num = -1;
1165 int data_intf_num = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 unsigned long quirks;
Oliver Neukum86478942006-05-13 22:50:47 +02001167 int num_rx_buf;
David Kubicek61a87ad2005-11-01 18:51:34 +01001168 int i;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001169 int combined_interfaces = 0;
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001170 struct device *tty_dev;
1171 int rv = -ENOMEM;
Johan Hovoldf8d84642017-03-17 11:35:48 +01001172 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
Oliver Neukum86478942006-05-13 22:50:47 +02001174 /* normal quirks */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 quirks = (unsigned long)id->driver_info;
Dmitry Torokhov16142652013-02-02 11:02:14 -08001176
1177 if (quirks == IGNORE_DEVICE)
1178 return -ENODEV;
1179
Oliver Neukum7309aa82016-11-02 14:42:52 +01001180 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1181
Oliver Neukum86478942006-05-13 22:50:47 +02001182 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1183
1184 /* handle quirks deadly to normal probing*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 if (quirks == NO_UNION_NORMAL) {
1186 data_interface = usb_ifnum_to_if(usb_dev, 1);
1187 control_interface = usb_ifnum_to_if(usb_dev, 0);
Oliver Neukum8835ba42016-03-15 10:14:04 +01001188 /* we would crash */
1189 if (!data_interface || !control_interface)
1190 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 goto skip_normal_probe;
1192 }
Alan Cox6e47e062009-06-11 12:37:06 +01001193
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 /* normal probing*/
1195 if (!buffer) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001196 dev_err(&intf->dev, "Weird descriptor references\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 return -EINVAL;
1198 }
1199
1200 if (!buflen) {
Toby Gray577045c2010-09-02 10:46:20 +01001201 if (intf->cur_altsetting->endpoint &&
1202 intf->cur_altsetting->endpoint->extralen &&
Alan Cox6e47e062009-06-11 12:37:06 +01001203 intf->cur_altsetting->endpoint->extra) {
1204 dev_dbg(&intf->dev,
1205 "Seeking extra descriptors on endpoint\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 buflen = intf->cur_altsetting->endpoint->extralen;
1207 buffer = intf->cur_altsetting->endpoint->extra;
1208 } else {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001209 dev_err(&intf->dev,
1210 "Zero length descriptor references\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 return -EINVAL;
1212 }
1213 }
1214
Oliver Neukumcb42b632016-07-14 15:41:34 +02001215 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1216 union_header = h.usb_cdc_union_desc;
1217 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1218 if (cmgmd)
1219 call_intf_num = cmgmd->bDataInterface;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221 if (!union_header) {
Johan Hovoldbf1c6742020-09-21 15:59:51 +02001222 if (intf->cur_altsetting->desc.bNumEndpoints == 3) {
1223 dev_dbg(&intf->dev, "No union descriptor, assuming single interface\n");
1224 combined_interfaces = 1;
1225 control_interface = data_interface = intf;
1226 goto look_for_collapsed_interface;
1227 } else if (call_intf_num > 0) {
Alan Cox6e47e062009-06-11 12:37:06 +01001228 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
Johan Hovoldbf1c6742020-09-21 15:59:51 +02001229 data_intf_num = call_intf_num;
1230 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 control_interface = intf;
1232 } else {
Johan Hovoldbf1c6742020-09-21 15:59:51 +02001233 dev_dbg(&intf->dev, "No union descriptor, giving up\n");
1234 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 }
1236 } else {
Johan Hovold960c7332020-09-21 15:59:49 +02001237 int class = -1;
1238
Oliver Neukumcb42b632016-07-14 15:41:34 +02001239 data_intf_num = union_header->bSlaveInterface0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
Oliver Neukumcb42b632016-07-14 15:41:34 +02001241 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
Johan Hovold960c7332020-09-21 15:59:49 +02001242
1243 if (control_interface)
1244 class = control_interface->cur_altsetting->desc.bInterfaceClass;
1245
1246 if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1247 dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1248 combined_interfaces = 1;
1249 control_interface = data_interface = intf;
1250 goto look_for_collapsed_interface;
1251 }
Greg Kroah-Hartman403dff42014-11-07 08:48:15 -08001252 }
1253
1254 if (!control_interface || !data_interface) {
1255 dev_dbg(&intf->dev, "no interfaces\n");
1256 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 }
Alan Cox6e47e062009-06-11 12:37:06 +01001258
Oliver Neukumcb42b632016-07-14 15:41:34 +02001259 if (data_intf_num != call_intf_num)
Alan Cox6e47e062009-06-11 12:37:06 +01001260 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001262 if (control_interface == data_interface) {
1263 /* some broken devices designed for windows work this way */
1264 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1265 combined_interfaces = 1;
1266 /* a popular other OS doesn't use it */
1267 quirks |= NO_CAP_LINE;
1268 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1269 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1270 return -EINVAL;
1271 }
1272look_for_collapsed_interface:
Johan Hovoldf8d84642017-03-17 11:35:48 +01001273 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1274 &epread, &epwrite, &epctrl, NULL);
1275 if (res)
1276 return res;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001277
Johan Hovoldf8d84642017-03-17 11:35:48 +01001278 goto made_compressed_probe;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001279 }
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281skip_normal_probe:
1282
1283 /*workaround for switched interfaces */
Johan Hovold319bb4a2020-09-21 15:59:50 +02001284 if (data_interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_CDC_DATA) {
1285 if (control_interface->cur_altsetting->desc.bInterfaceClass == USB_CLASS_CDC_DATA) {
Alan Cox6e47e062009-06-11 12:37:06 +01001286 dev_dbg(&intf->dev,
1287 "Your device has switched interfaces.\n");
Fabian Frederick2cfef792015-05-18 19:59:37 +02001288 swap(control_interface, data_interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 } else {
1290 return -EINVAL;
1291 }
1292 }
Alan Stern74da5d62007-08-02 13:29:10 -04001293
1294 /* Accept probe requests only for the control interface */
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001295 if (!combined_interfaces && intf != control_interface)
Alan Stern74da5d62007-08-02 13:29:10 -04001296 return -ENODEV;
Alan Cox6e47e062009-06-11 12:37:06 +01001297
Sven Schnelle99f347c2012-08-17 21:43:43 +02001298 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1299 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 return -EINVAL;
1301
1302 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1303 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1304 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1305
1306
1307 /* workaround for switched endpoints */
Luiz Fernando N. Capitulino45aea702006-10-26 13:02:48 -03001308 if (!usb_endpoint_dir_in(epread)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 /* descriptors are swapped */
Alan Cox6e47e062009-06-11 12:37:06 +01001310 dev_dbg(&intf->dev,
1311 "The data interface has switched endpoints\n");
Fabian Frederick2cfef792015-05-18 19:59:37 +02001312 swap(epread, epwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 }
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001314made_compressed_probe:
Johan Hovolda5cc7ef2011-03-22 11:12:15 +01001315 dev_dbg(&intf->dev, "interfaces are valid\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
Alan Cox6e47e062009-06-11 12:37:06 +01001317 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
Johan Hovoldf8255ee2021-03-22 16:53:16 +01001318 if (!acm)
Johan Hovold4cde0592021-03-22 16:53:15 +01001319 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Jaejoong Kimcae2bc72018-06-21 17:45:05 +09001321 tty_port_init(&acm->port);
1322 acm->port.ops = &acm_port_ops;
1323
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001324 ctrlsize = usb_endpoint_maxp(epctrl);
1325 readsize = usb_endpoint_maxp(epread) *
Alan Cox6e47e062009-06-11 12:37:06 +01001326 (quirks == SINGLE_RX_URB ? 1 : 2);
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001327 acm->combined_interfaces = combined_interfaces;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001328 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 acm->control = control_interface;
1330 acm->data = data_interface;
Oliver Neukumc52873e2019-08-08 16:21:19 +02001331
1332 usb_get_intf(acm->control); /* undone in destruct() */
1333
1334 minor = acm_alloc_minor(acm);
Johan Hovold91fac072021-09-07 10:23:18 +02001335 if (minor < 0) {
1336 acm->minor = ACM_MINOR_INVALID;
Johan Hovold4cde0592021-03-22 16:53:15 +01001337 goto err_put_port;
Johan Hovold91fac072021-09-07 10:23:18 +02001338 }
Oliver Neukumc52873e2019-08-08 16:21:19 +02001339
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 acm->minor = minor;
1341 acm->dev = usb_dev;
Oliver Neukumcb42b632016-07-14 15:41:34 +02001342 if (h.usb_cdc_acm_descriptor)
1343 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001344 if (quirks & NO_CAP_LINE)
1345 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 acm->ctrlsize = ctrlsize;
1347 acm->readsize = readsize;
Oliver Neukum86478942006-05-13 22:50:47 +02001348 acm->rx_buflimit = num_rx_buf;
Oliver Neukuma4e72792020-04-15 17:13:58 +02001349 INIT_DELAYED_WORK(&acm->dwork, acm_softint);
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001350 init_waitqueue_head(&acm->wioctl);
Oliver Neukum884b6002005-04-21 21:28:02 +02001351 spin_lock_init(&acm->write_lock);
David Kubicek61a87ad2005-11-01 18:51:34 +01001352 spin_lock_init(&acm->read_lock);
Oliver Neukum1365baf72007-10-12 17:24:28 +02001353 mutex_init(&acm->mutex);
Ladislav Michld3053942016-11-18 19:10:19 +01001354 if (usb_endpoint_xfer_int(epread)) {
Oliver Neukumcf7fdd52009-08-04 23:52:09 +02001355 acm->bInterval = epread->bInterval;
Ladislav Michl74bccc92016-11-18 19:09:19 +01001356 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1357 } else {
1358 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1359 }
1360 if (usb_endpoint_xfer_int(epwrite))
1361 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1362 else
1363 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
Johan Hovold140cb812014-05-26 19:23:38 +02001364 init_usb_anchor(&acm->delayed);
Johan Hovold2a8cdfd2014-11-06 18:08:33 +01001365 acm->quirks = quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
Daniel Mack997ea582010-04-12 13:17:25 +02001367 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
Oliver Neukum17136d42015-01-28 16:56:24 +01001368 if (!buf)
Johan Hovold4cde0592021-03-22 16:53:15 +01001369 goto err_put_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 acm->ctrl_buffer = buf;
1371
Oliver Neukum17136d42015-01-28 16:56:24 +01001372 if (acm_write_buffers_alloc(acm) < 0)
Johan Hovold4cde0592021-03-22 16:53:15 +01001373 goto err_free_ctrl_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
1375 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
Oliver Neukum17136d42015-01-28 16:56:24 +01001376 if (!acm->ctrlurb)
Johan Hovold4cde0592021-03-22 16:53:15 +01001377 goto err_free_write_buffers;
Oliver Neukum17136d42015-01-28 16:56:24 +01001378
Oliver Neukum86478942006-05-13 22:50:47 +02001379 for (i = 0; i < num_rx_buf; i++) {
Johan Hovold088c64f2011-03-25 11:06:02 +01001380 struct acm_rb *rb = &(acm->read_buffers[i]);
1381 struct urb *urb;
David Kubicek61a87ad2005-11-01 18:51:34 +01001382
Johan Hovold74f5e1b2011-03-22 11:12:23 +01001383 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1384 &rb->dma);
Oliver Neukum17136d42015-01-28 16:56:24 +01001385 if (!rb->base)
Johan Hovold4cde0592021-03-22 16:53:15 +01001386 goto err_free_read_urbs;
Johan Hovold088c64f2011-03-25 11:06:02 +01001387 rb->index = i;
1388 rb->instance = acm;
Johan Hovold74f5e1b2011-03-22 11:12:23 +01001389
Johan Hovold088c64f2011-03-25 11:06:02 +01001390 urb = usb_alloc_urb(0, GFP_KERNEL);
Oliver Neukum17136d42015-01-28 16:56:24 +01001391 if (!urb)
Johan Hovold4cde0592021-03-22 16:53:15 +01001392 goto err_free_read_urbs;
Oliver Neukum17136d42015-01-28 16:56:24 +01001393
Johan Hovold088c64f2011-03-25 11:06:02 +01001394 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1395 urb->transfer_dma = rb->dma;
Ladislav Michld3053942016-11-18 19:10:19 +01001396 if (usb_endpoint_xfer_int(epread))
Ladislav Michl74bccc92016-11-18 19:09:19 +01001397 usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
Johan Hovold088c64f2011-03-25 11:06:02 +01001398 acm->readsize,
1399 acm_read_bulk_callback, rb,
1400 acm->bInterval);
Ladislav Michl74bccc92016-11-18 19:09:19 +01001401 else
1402 usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
Johan Hovold088c64f2011-03-25 11:06:02 +01001403 acm->readsize,
1404 acm_read_bulk_callback, rb);
David Kubicek61a87ad2005-11-01 18:51:34 +01001405
Johan Hovold088c64f2011-03-25 11:06:02 +01001406 acm->read_urbs[i] = urb;
1407 __set_bit(i, &acm->read_urbs_free);
David Kubicek61a87ad2005-11-01 18:51:34 +01001408 }
Alan Cox6e47e062009-06-11 12:37:06 +01001409 for (i = 0; i < ACM_NW; i++) {
David Engrafe4cf3aa2008-03-20 10:01:34 +01001410 struct acm_wb *snd = &(acm->wb[i]);
1411
Alan Cox6e47e062009-06-11 12:37:06 +01001412 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
Johan Hovoldf8255ee2021-03-22 16:53:16 +01001413 if (!snd->urb)
Johan Hovold4cde0592021-03-22 16:53:15 +01001414 goto err_free_write_urbs;
David Engrafe4cf3aa2008-03-20 10:01:34 +01001415
Arseniy Lartsev5186ffe2009-07-01 16:27:26 +04001416 if (usb_endpoint_xfer_int(epwrite))
Ladislav Michl74bccc92016-11-18 19:09:19 +01001417 usb_fill_int_urb(snd->urb, usb_dev, acm->out,
Arseniy Lartsev5186ffe2009-07-01 16:27:26 +04001418 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1419 else
Ladislav Michl74bccc92016-11-18 19:09:19 +01001420 usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
Arseniy Lartsev5186ffe2009-07-01 16:27:26 +04001421 NULL, acm->writesize, acm_write_bulk, snd);
David Engrafe4cf3aa2008-03-20 10:01:34 +01001422 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Lu Baoluffdb1e32016-01-06 15:10:04 +08001423 if (quirks & SEND_ZERO_PACKET)
1424 snd->urb->transfer_flags |= URB_ZERO_PACKET;
David Engrafe4cf3aa2008-03-20 10:01:34 +01001425 snd->instance = acm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 }
1427
Alan Cox6e47e062009-06-11 12:37:06 +01001428 usb_set_intfdata(intf, acm);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001429
1430 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1431 if (i < 0)
Johan Hovold4cde0592021-03-22 16:53:15 +01001432 goto err_free_write_urbs;
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001433
Oliver Neukumcb42b632016-07-14 15:41:34 +02001434 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1435 struct usb_cdc_country_functional_desc * cfd =
1436 h.usb_cdc_country_functional_desc;
1437
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001438 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1439 if (!acm->country_codes)
1440 goto skip_countries;
1441 acm->country_code_size = cfd->bLength - 4;
Alan Cox6e47e062009-06-11 12:37:06 +01001442 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1443 cfd->bLength - 4);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001444 acm->country_rel_date = cfd->iCountryCodeRelDate;
1445
1446 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1447 if (i < 0) {
1448 kfree(acm->country_codes);
Julia Lawalle7c8e862011-12-23 14:02:55 +01001449 acm->country_codes = NULL;
1450 acm->country_code_size = 0;
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001451 goto skip_countries;
1452 }
1453
Alan Cox6e47e062009-06-11 12:37:06 +01001454 i = device_create_file(&intf->dev,
1455 &dev_attr_iCountryCodeRelDate);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001456 if (i < 0) {
Axel Linc2572b72010-05-31 08:04:47 +08001457 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001458 kfree(acm->country_codes);
Julia Lawalle7c8e862011-12-23 14:02:55 +01001459 acm->country_codes = NULL;
1460 acm->country_code_size = 0;
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001461 goto skip_countries;
1462 }
1463 }
1464
1465skip_countries:
Alan Cox6e47e062009-06-11 12:37:06 +01001466 usb_fill_int_urb(acm->ctrlurb, usb_dev,
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001467 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1468 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1469 /* works around buggy devices */
Felipe Balbid102e782013-07-01 11:23:24 +03001470 epctrl->bInterval ? epctrl->bInterval : 16);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1472 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
Tobias Herzogea258352017-03-30 22:15:11 +02001473 acm->notification_buffer = NULL;
1474 acm->nb_index = 0;
1475 acm->nb_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 acm->line.dwDTERate = cpu_to_le32(9600);
1478 acm->line.bDataBits = 8;
1479 acm_set_line(acm, &acm->line);
1480
Johan Hovold0b2b23c2021-03-22 16:53:17 +01001481 if (!acm->combined_interfaces) {
1482 rv = usb_driver_claim_interface(&acm_driver, data_interface, acm);
1483 if (rv)
1484 goto err_remove_files;
1485 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001487 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
Jiri Slaby734cc172012-08-07 21:47:47 +02001488 &control_interface->dev);
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001489 if (IS_ERR(tty_dev)) {
1490 rv = PTR_ERR(tty_dev);
Johan Hovold4cde0592021-03-22 16:53:15 +01001491 goto err_release_data_interface;
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001492 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Alexey Sokolov15bf7222015-06-02 11:49:30 +03001494 if (quirks & CLEAR_HALT_CONDITIONS) {
Ladislav Michl74bccc92016-11-18 19:09:19 +01001495 usb_clear_halt(usb_dev, acm->in);
1496 usb_clear_halt(usb_dev, acm->out);
Alexey Sokolov15bf7222015-06-02 11:49:30 +03001497 }
1498
Johan Hovold79579412021-03-22 16:53:18 +01001499 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1500
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001501 return 0;
Johan Hovold4cde0592021-03-22 16:53:15 +01001502
1503err_release_data_interface:
Johan Hovold4e49bf32021-03-22 16:53:12 +01001504 if (!acm->combined_interfaces) {
1505 /* Clear driver data so that disconnect() returns early. */
1506 usb_set_intfdata(data_interface, NULL);
1507 usb_driver_release_interface(&acm_driver, data_interface);
1508 }
Johan Hovold0b2b23c2021-03-22 16:53:17 +01001509err_remove_files:
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001510 if (acm->country_codes) {
1511 device_remove_file(&acm->control->dev,
1512 &dev_attr_wCountryCodes);
1513 device_remove_file(&acm->control->dev,
1514 &dev_attr_iCountryCodeRelDate);
1515 }
1516 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
Johan Hovold4cde0592021-03-22 16:53:15 +01001517err_free_write_urbs:
David Engrafe4cf3aa2008-03-20 10:01:34 +01001518 for (i = 0; i < ACM_NW; i++)
1519 usb_free_urb(acm->wb[i].urb);
Johan Hovold4cde0592021-03-22 16:53:15 +01001520err_free_read_urbs:
Oliver Neukum86478942006-05-13 22:50:47 +02001521 for (i = 0; i < num_rx_buf; i++)
Johan Hovold088c64f2011-03-25 11:06:02 +01001522 usb_free_urb(acm->read_urbs[i]);
Johan Hovold74f5e1b2011-03-22 11:12:23 +01001523 acm_read_buffers_free(acm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 usb_free_urb(acm->ctrlurb);
Johan Hovold4cde0592021-03-22 16:53:15 +01001525err_free_write_buffers:
Oliver Neukum884b6002005-04-21 21:28:02 +02001526 acm_write_buffers_free(acm);
Johan Hovold4cde0592021-03-22 16:53:15 +01001527err_free_ctrl_buffer:
Jaejoong Kimcae2bc72018-06-21 17:45:05 +09001528 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
Johan Hovold4cde0592021-03-22 16:53:15 +01001529err_put_port:
Jaejoong Kimcae2bc72018-06-21 17:45:05 +09001530 tty_port_put(&acm->port);
Johan Hovold4cde0592021-03-22 16:53:15 +01001531
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001532 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533}
1534
1535static void acm_disconnect(struct usb_interface *intf)
1536{
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001537 struct acm *acm = usb_get_intfdata(intf);
Alan Cox10077d42009-06-11 12:36:09 +01001538 struct tty_struct *tty;
Romain Izardf2924d42018-09-20 16:49:04 +02001539 int i;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001540
David Brownell672c4e12008-08-06 18:41:12 -07001541 /* sibling interface is already cleaning up */
1542 if (!acm)
Oliver Neukum86067eea2006-01-08 12:39:13 +01001543 return;
David Brownell672c4e12008-08-06 18:41:12 -07001544
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001545 acm->disconnected = true;
Oliver Neukum6069e3e2021-03-11 14:01:25 +01001546 /*
1547 * there is a circular dependency. acm_softint() can resubmit
1548 * the URBs in error handling so we need to block any
1549 * submission right away
1550 */
1551 acm_poison_urbs(acm);
1552 mutex_lock(&acm->mutex);
Alan Cox6e47e062009-06-11 12:37:06 +01001553 if (acm->country_codes) {
Alan Stern74da5d62007-08-02 13:29:10 -04001554 device_remove_file(&acm->control->dev,
1555 &dev_attr_wCountryCodes);
1556 device_remove_file(&acm->control->dev,
1557 &dev_attr_iCountryCodeRelDate);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001558 }
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001559 wake_up_all(&acm->wioctl);
Alan Stern74da5d62007-08-02 13:29:10 -04001560 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
Oliver Neukum86067eea2006-01-08 12:39:13 +01001561 usb_set_intfdata(acm->control, NULL);
1562 usb_set_intfdata(acm->data, NULL);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001563 mutex_unlock(&acm->mutex);
1564
1565 tty = tty_port_tty_get(&acm->port);
1566 if (tty) {
1567 tty_vhangup(tty);
1568 tty_kref_put(tty);
1569 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Oliver Neukuma4e72792020-04-15 17:13:58 +02001571 cancel_delayed_work_sync(&acm->dwork);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Johan Hovoldcb255052013-03-19 09:21:06 +01001573 tty_unregister_device(acm_tty_driver, acm->minor);
1574
Romain Izardf2924d42018-09-20 16:49:04 +02001575 usb_free_urb(acm->ctrlurb);
1576 for (i = 0; i < ACM_NW; i++)
1577 usb_free_urb(acm->wb[i].urb);
1578 for (i = 0; i < acm->rx_buflimit; i++)
1579 usb_free_urb(acm->read_urbs[i]);
Oliver Neukum884b6002005-04-21 21:28:02 +02001580 acm_write_buffers_free(acm);
Ladislav Michle4614602016-11-18 19:06:10 +01001581 usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
Oliver Neukum830f4022008-06-25 14:17:16 +02001582 acm_read_buffers_free(acm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Tobias Herzogea258352017-03-30 22:15:11 +02001584 kfree(acm->notification_buffer);
1585
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001586 if (!acm->combined_interfaces)
1587 usb_driver_release_interface(&acm_driver, intf == acm->control ?
Oliver Neukum830f4022008-06-25 14:17:16 +02001588 acm->data : acm->control);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001590 tty_port_put(&acm->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591}
1592
Oliver Neukum35758582008-07-01 19:10:08 +02001593#ifdef CONFIG_PM
Oliver Neukum1365baf72007-10-12 17:24:28 +02001594static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1595{
1596 struct acm *acm = usb_get_intfdata(intf);
Oliver Neukum11ea8592008-06-20 11:25:57 +02001597 int cnt;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001598
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001599 spin_lock_irq(&acm->write_lock);
Johan Hovold5a345c22014-05-26 19:23:36 +02001600 if (PMSG_IS_AUTO(message)) {
1601 if (acm->transmitting) {
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001602 spin_unlock_irq(&acm->write_lock);
Johan Hovold5a345c22014-05-26 19:23:36 +02001603 return -EBUSY;
1604 }
1605 }
Oliver Neukum11ea8592008-06-20 11:25:57 +02001606 cnt = acm->susp_count++;
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001607 spin_unlock_irq(&acm->write_lock);
Oliver Neukum11ea8592008-06-20 11:25:57 +02001608
1609 if (cnt)
Oliver Neukum1365baf72007-10-12 17:24:28 +02001610 return 0;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001611
Oliver Neukum6069e3e2021-03-11 14:01:25 +01001612 acm_poison_urbs(acm);
Oliver Neukuma4e72792020-04-15 17:13:58 +02001613 cancel_delayed_work_sync(&acm->dwork);
1614 acm->urbs_in_error_delay = 0;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001615
Oliver Neukum1365baf72007-10-12 17:24:28 +02001616 return 0;
1617}
1618
1619static int acm_resume(struct usb_interface *intf)
1620{
1621 struct acm *acm = usb_get_intfdata(intf);
Johan Hovold140cb812014-05-26 19:23:38 +02001622 struct urb *urb;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001623 int rv = 0;
1624
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001625 spin_lock_irq(&acm->write_lock);
Oliver Neukum11ea8592008-06-20 11:25:57 +02001626
Johan Hovolde144ed282014-05-26 19:23:37 +02001627 if (--acm->susp_count)
1628 goto out;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001629
Oliver Neukuma8b3b512021-04-21 09:45:13 +02001630 acm_unpoison_urbs(acm);
1631
Peter Hurleyd41861c2016-04-09 17:53:25 -07001632 if (tty_port_initialized(&acm->port)) {
Johan Hovolde144ed282014-05-26 19:23:37 +02001633 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
Oliver Neukum97d35f92009-12-16 17:05:57 +01001634
Johan Hovold140cb812014-05-26 19:23:38 +02001635 for (;;) {
1636 urb = usb_get_from_anchor(&acm->delayed);
1637 if (!urb)
1638 break;
1639
1640 acm_start_wb(acm, urb->context);
Oliver Neukum97d35f92009-12-16 17:05:57 +01001641 }
1642
1643 /*
1644 * delayed error checking because we must
1645 * do the write path at all cost
1646 */
Oliver Neukum1365baf72007-10-12 17:24:28 +02001647 if (rv < 0)
Johan Hovolde144ed282014-05-26 19:23:37 +02001648 goto out;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001649
Johan Hovolde144ed282014-05-26 19:23:37 +02001650 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
Oliver Neukum1365baf72007-10-12 17:24:28 +02001651 }
Johan Hovolde144ed282014-05-26 19:23:37 +02001652out:
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001653 spin_unlock_irq(&acm->write_lock);
Oliver Neukum1365baf72007-10-12 17:24:28 +02001654
Oliver Neukum1365baf72007-10-12 17:24:28 +02001655 return rv;
1656}
Oliver Neukum35758582008-07-01 19:10:08 +02001657
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001658static int acm_reset_resume(struct usb_interface *intf)
1659{
1660 struct acm *acm = usb_get_intfdata(intf);
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001661
Peter Hurleyd41861c2016-04-09 17:53:25 -07001662 if (tty_port_initialized(&acm->port))
Jiri Slabyaa27a092013-03-07 13:12:30 +01001663 tty_port_tty_hangup(&acm->port, false);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001664
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001665 return acm_resume(intf);
1666}
1667
Oliver Neukum35758582008-07-01 19:10:08 +02001668#endif /* CONFIG_PM */
Adrian Taylorc1479a92009-11-19 10:35:33 +00001669
Ladislav Michl1aba5792016-11-18 19:11:26 +01001670static int acm_pre_reset(struct usb_interface *intf)
1671{
1672 struct acm *acm = usb_get_intfdata(intf);
1673
1674 clear_bit(EVENT_RX_STALL, &acm->flags);
Oliver Neukum93979402018-10-04 15:49:06 +02001675 acm->nb_index = 0; /* pending control transfers are lost */
Ladislav Michl1aba5792016-11-18 19:11:26 +01001676
1677 return 0;
1678}
1679
Adrian Taylorc1479a92009-11-19 10:35:33 +00001680#define NOKIA_PCSUITE_ACM_INFO(x) \
1681 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1682 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1683 USB_CDC_ACM_PROTO_VENDOR)
1684
Toby Gray4035e452010-09-01 16:01:19 +01001685#define SAMSUNG_PCSUITE_ACM_INFO(x) \
1686 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1687 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1688 USB_CDC_ACM_PROTO_VENDOR)
1689
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690/*
1691 * USB driver structure.
1692 */
1693
Németh Márton6ef48522010-01-10 15:33:45 +01001694static const struct usb_device_id acm_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 /* quirky and broken devices */
Joakim Tjernlund03894572020-06-05 12:54:18 +02001696 { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1697 .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
Björn Gerhartb20b1612015-02-18 07:19:44 +01001698 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1699 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
David Cluytens3b59d162013-12-03 14:18:57 +01001700 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1701 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1703 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1704 },
Chris Brandt6d853c92020-11-11 08:12:09 -05001705 { USB_DEVICE(0x045b, 0x023c), /* Renesas USB Download mode */
1706 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1707 },
1708 { USB_DEVICE(0x045b, 0x0248), /* Renesas USB Download mode */
1709 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1710 },
1711 { USB_DEVICE(0x045b, 0x024D), /* Renesas USB Download mode */
1712 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1713 },
Andrey Arapovb0e2a702007-07-04 17:11:42 +02001714 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1715 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1716 },
Macpaul Lineafb27f2018-12-19 12:11:03 +08001717 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1718 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1719 },
Andrew Lunn0f9c7b42008-12-23 17:31:23 +01001720 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1721 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1722 },
Masahito Omote8753e652005-07-29 12:17:25 -07001723 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1724 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1725 },
Chris Malley91a9c922006-10-03 10:08:28 +01001726 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1727 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1728 },
Alan Cox7abcf202009-04-06 17:35:01 +01001729 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1730 .driver_info = SINGLE_RX_URB,
1731 },
Oliver Neukum86478942006-05-13 22:50:47 +02001732 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1733 .driver_info = SINGLE_RX_URB, /* firmware bug */
1734 },
Oliver Neukum3dd2ae82006-06-23 09:14:17 +02001735 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1736 .driver_info = SINGLE_RX_URB, /* firmware bug */
1737 },
Oliver Neukumdf1cc782018-01-18 12:13:45 +01001738 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1739 .driver_info = SINGLE_RX_URB,
1740 },
Houston Yaroschoff4a762562018-06-11 12:39:09 +02001741 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1742 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1743 },
Oliver Neukum9be84562007-02-12 08:50:03 +01001744 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1745 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1746 },
Iain McFarlane6149ed52008-05-04 00:13:49 +01001747 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1748 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1749 },
Eric Sandeenc8fd2c32008-08-14 08:25:40 -05001750 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1751 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1752 },
Alan Coxc89c60e2009-01-11 19:53:10 +00001753 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1754 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1755 },
Xiao Kaijiancab98a02009-05-08 00:48:23 +08001756 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1757 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1758 },
Maarten Jacobs63529ea2018-11-19 23:18:49 +00001759 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1760 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1761 },
Johan Hovold2a8cdfd2014-11-06 18:08:33 +01001762 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1763 .driver_info = QUIRK_CONTROL_LINE_STATE, },
Johan Hovoldcf84a692014-10-27 18:34:33 +01001764 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
Nathaniel Quillin30121602016-12-05 06:53:00 -08001765 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
Dmitriy Taychenachev155df652009-02-25 12:36:51 +08001766 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1767 },
Krzysztof Hałasa6abff5d2011-12-12 14:51:00 +01001768 /* Motorola H24 HSPA module: */
1769 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
Michael Ulbricht895d2402014-03-25 10:34:18 +01001770 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1771 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1772 },
1773 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1774 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1775 },
1776 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1777 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1778 },
1779 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1780 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1781 },
1782 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1783 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1784 },
1785 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1786 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1787 },
1788 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1789 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1790 },
Krzysztof Hałasa6abff5d2011-12-12 14:51:00 +01001791
Adam Richterc332b4e2009-02-18 16:17:15 -08001792 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1793 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1794 data interface instead of
1795 communications interface.
1796 Maybe we should define a new
1797 quirk for this. */
1798 },
Jean-Christian de Rivaze7d491a2012-10-10 12:49:02 +00001799 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1800 .driver_info = NO_UNION_NORMAL,
1801 },
Denis N Ladin036915a2012-12-26 18:29:44 +05001802 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1803 .driver_info = NO_UNION_NORMAL,
1804 },
Kir Kolyshkin1f17c502009-05-28 20:33:58 +04001805 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1806 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1807 },
Russ Nelsonc3baa192010-04-21 23:07:03 -04001808 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1809 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1810 },
Johan Hovoldfe855782017-07-12 15:08:39 +02001811 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1812 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1813 },
Maksim Salau765fb2f2017-10-11 11:10:52 +03001814 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1815 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1816 },
Lubomir Rintel1445cbe2018-07-10 08:28:49 +02001817 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1818 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1819 },
Oliver Neukum9be84562007-02-12 08:50:03 +01001820
Alexey Sokolov15bf7222015-06-02 11:49:30 +03001821 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1822 .driver_info = CLEAR_HALT_CONDITIONS,
1823 },
1824
Adrian Taylorc1479a92009-11-19 10:35:33 +00001825 /* Nokia S60 phones expose two ACM channels. The first is
1826 * a modem and is picked up by the standard AT-command
1827 * information below. The second is 'vendor-specific' but
1828 * is treated as a serial device at the S60 end, so we want
1829 * to expose it on Linux too. */
1830 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1831 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1832 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1833 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1834 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1836 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1837 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1838 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1839 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1840 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1841 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1842 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1843 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1845 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1847 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1848 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1849 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1850 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1851 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1852 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1853 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1856 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1859 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1860 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1861 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
Adrian Taylorc1479a92009-11-19 10:35:33 +00001862 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1863 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1864 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1865 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1867 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1868 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1869 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1870 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1871 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
Przemo Firszt83a4eae2010-06-28 21:29:34 +01001872 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
Toby Gray4035e452010-09-01 16:01:19 +01001873 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1874 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1876 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1877 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1880 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1881 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1882 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
Arvid Ephraim Picciani721d92f2011-01-25 15:58:40 +01001883 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
Toby Gray4061fde2011-06-06 14:52:48 +01001884 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1885 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
Toby Gray4035e452010-09-01 16:01:19 +01001886 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
Adrian Taylorc1479a92009-11-19 10:35:33 +00001887
Denis Pershin65e52f42011-09-04 17:37:21 +07001888 /* Support for Owen devices */
1889 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1890
Adrian Taylorc1479a92009-11-19 10:35:33 +00001891 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1892
Dmitry Torokhov16142652013-02-02 11:02:14 -08001893#if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1894 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1895 .driver_info = IGNORE_DEVICE,
1896 },
1897 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1898 .driver_info = IGNORE_DEVICE,
1899 },
1900#endif
1901
Sean Young6eeb7752020-05-27 11:22:16 +02001902#if IS_ENABLED(CONFIG_IR_TOY)
1903 { USB_DEVICE(0x04d8, 0xfd08),
1904 .driver_info = IGNORE_DEVICE,
1905 },
Sean Young0ffc7652020-12-27 13:45:02 +00001906
1907 { USB_DEVICE(0x04d8, 0xf58b),
1908 .driver_info = IGNORE_DEVICE,
1909 },
Sean Young6eeb7752020-05-27 11:22:16 +02001910#endif
1911
Mauro Carvalho Chehab5f6225a2020-11-22 22:38:22 +05301912#if IS_ENABLED(CONFIG_USB_SERIAL_XR)
Mauro Carvalho Chehab039b81d2021-04-12 11:55:57 +02001913 { USB_DEVICE(0x04e2, 0x1400), .driver_info = IGNORE_DEVICE },
1914 { USB_DEVICE(0x04e2, 0x1401), .driver_info = IGNORE_DEVICE },
1915 { USB_DEVICE(0x04e2, 0x1402), .driver_info = IGNORE_DEVICE },
1916 { USB_DEVICE(0x04e2, 0x1403), .driver_info = IGNORE_DEVICE },
1917 { USB_DEVICE(0x04e2, 0x1410), .driver_info = IGNORE_DEVICE },
1918 { USB_DEVICE(0x04e2, 0x1411), .driver_info = IGNORE_DEVICE },
1919 { USB_DEVICE(0x04e2, 0x1412), .driver_info = IGNORE_DEVICE },
1920 { USB_DEVICE(0x04e2, 0x1414), .driver_info = IGNORE_DEVICE },
1921 { USB_DEVICE(0x04e2, 0x1420), .driver_info = IGNORE_DEVICE },
1922 { USB_DEVICE(0x04e2, 0x1422), .driver_info = IGNORE_DEVICE },
1923 { USB_DEVICE(0x04e2, 0x1424), .driver_info = IGNORE_DEVICE },
Mauro Carvalho Chehab5f6225a2020-11-22 22:38:22 +05301924#endif
1925
Oliver Neukume912e682016-01-18 15:45:18 +01001926 /*Samsung phone in firmware update mode */
1927 { USB_DEVICE(0x04e8, 0x685d),
1928 .driver_info = IGNORE_DEVICE,
1929 },
1930
Jonas Jonssonf33a7f72015-11-22 11:47:17 +01001931 /* Exclude Infineon Flash Loader utility */
1932 { USB_DEVICE(0x058b, 0x0041),
1933 .driver_info = IGNORE_DEVICE,
1934 },
1935
Vincent Mailhola4f88432020-10-03 00:41:51 +09001936 /* Exclude ETAS ES58x */
1937 { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1938 .driver_info = IGNORE_DEVICE,
1939 },
1940 { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1941 .driver_info = IGNORE_DEVICE,
1942 },
1943 { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1944 .driver_info = IGNORE_DEVICE,
1945 },
1946
Daniele Palmas34aabf92018-12-28 16:15:41 +01001947 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1948 .driver_info = SEND_ZERO_PACKET,
1949 },
1950 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1951 .driver_info = SEND_ZERO_PACKET,
1952 },
1953
Yorick de Wid4d8654e2021-02-13 15:49:02 +01001954 /* Exclude Goodix Fingerprint Reader */
1955 { USB_DEVICE(0x27c6, 0x5395),
1956 .driver_info = IGNORE_DEVICE,
1957 },
1958
Hannu Hartikainen48978072021-06-22 17:14:54 +03001959 /* Exclude Heimann Sensor GmbH USB appset demo */
1960 { USB_DEVICE(0x32a7, 0x0000),
1961 .driver_info = IGNORE_DEVICE,
1962 },
1963
Philippe Corbes5b239f02010-08-31 19:31:32 +02001964 /* control interfaces without any protocol set */
1965 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1966 USB_CDC_PROTO_NONE) },
1967
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 /* control interfaces with various AT-command sets */
1969 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1970 USB_CDC_ACM_PROTO_AT_V25TER) },
1971 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1972 USB_CDC_ACM_PROTO_AT_PCCA101) },
1973 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1974 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1975 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1976 USB_CDC_ACM_PROTO_AT_GSM) },
1977 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
Alan Cox6e47e062009-06-11 12:37:06 +01001978 USB_CDC_ACM_PROTO_AT_3G) },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1980 USB_CDC_ACM_PROTO_AT_CDMA) },
1981
Lu Baoluffdb1e32016-01-06 15:10:04 +08001982 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1983 .driver_info = SEND_ZERO_PACKET,
1984 },
1985
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 { }
1987};
1988
Alan Cox6e47e062009-06-11 12:37:06 +01001989MODULE_DEVICE_TABLE(usb, acm_ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
1991static struct usb_driver acm_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 .name = "cdc_acm",
1993 .probe = acm_probe,
1994 .disconnect = acm_disconnect,
Oliver Neukum35758582008-07-01 19:10:08 +02001995#ifdef CONFIG_PM
Oliver Neukum1365baf72007-10-12 17:24:28 +02001996 .suspend = acm_suspend,
1997 .resume = acm_resume,
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001998 .reset_resume = acm_reset_resume,
Oliver Neukum35758582008-07-01 19:10:08 +02001999#endif
Ladislav Michl1aba5792016-11-18 19:11:26 +01002000 .pre_reset = acm_pre_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 .id_table = acm_ids,
Oliver Neukum35758582008-07-01 19:10:08 +02002002#ifdef CONFIG_PM
Oliver Neukum1365baf72007-10-12 17:24:28 +02002003 .supports_autosuspend = 1,
Oliver Neukum35758582008-07-01 19:10:08 +02002004#endif
Sarah Sharpe1f12eb2012-04-23 10:08:51 -07002005 .disable_hub_initiated_lpm = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006};
2007
2008/*
2009 * TTY driver structures.
2010 */
2011
Jeff Dikeb68e31d2006-10-02 02:17:18 -07002012static const struct tty_operations acm_ops = {
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08002013 .install = acm_tty_install,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 .open = acm_tty_open,
2015 .close = acm_tty_close,
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08002016 .cleanup = acm_tty_cleanup,
Alan Cox10077d42009-06-11 12:36:09 +01002017 .hangup = acm_tty_hangup,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 .write = acm_tty_write,
2019 .write_room = acm_tty_write_room,
2020 .ioctl = acm_tty_ioctl,
2021 .throttle = acm_tty_throttle,
2022 .unthrottle = acm_tty_unthrottle,
2023 .chars_in_buffer = acm_tty_chars_in_buffer,
2024 .break_ctl = acm_tty_break_ctl,
2025 .set_termios = acm_tty_set_termios,
2026 .tiocmget = acm_tty_tiocmget,
2027 .tiocmset = acm_tty_tiocmset,
Al Viro99f75a12018-09-11 23:33:40 -04002028 .get_serial = get_serial_info,
2029 .set_serial = set_serial_info,
Johan Hovoldbb2d3872016-11-08 13:28:24 +01002030 .get_icount = acm_tty_get_icount,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031};
2032
2033/*
2034 * Init / exit.
2035 */
2036
2037static int __init acm_init(void)
2038{
2039 int retval;
Jiri Slaby39b7b422021-07-23 09:43:13 +02002040 acm_tty_driver = tty_alloc_driver(ACM_TTY_MINORS, TTY_DRIVER_REAL_RAW |
2041 TTY_DRIVER_DYNAMIC_DEV);
2042 if (IS_ERR(acm_tty_driver))
2043 return PTR_ERR(acm_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 acm_tty_driver->driver_name = "acm",
2045 acm_tty_driver->name = "ttyACM",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 acm_tty_driver->major = ACM_TTY_MAJOR,
2047 acm_tty_driver->minor_start = 0,
2048 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2049 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 acm_tty_driver->init_termios = tty_std_termios;
Alan Cox6e47e062009-06-11 12:37:06 +01002051 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2052 HUPCL | CLOCAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 tty_set_operations(acm_tty_driver, &acm_ops);
2054
2055 retval = tty_register_driver(acm_tty_driver);
2056 if (retval) {
Jiri Slaby9f90a4d2021-07-23 09:43:16 +02002057 tty_driver_kref_put(acm_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 return retval;
2059 }
2060
2061 retval = usb_register(&acm_driver);
2062 if (retval) {
2063 tty_unregister_driver(acm_tty_driver);
Jiri Slaby9f90a4d2021-07-23 09:43:16 +02002064 tty_driver_kref_put(acm_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 return retval;
2066 }
2067
Johan Hovolda2c7b932011-03-22 11:12:18 +01002068 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069
2070 return 0;
2071}
2072
2073static void __exit acm_exit(void)
2074{
2075 usb_deregister(&acm_driver);
2076 tty_unregister_driver(acm_tty_driver);
Jiri Slaby9f90a4d2021-07-23 09:43:16 +02002077 tty_driver_kref_put(acm_tty_driver);
Johannes Thumshirn91b72562015-07-08 17:25:42 +02002078 idr_destroy(&acm_minors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079}
2080
2081module_init(acm_init);
2082module_exit(acm_exit);
2083
Alan Cox6e47e062009-06-11 12:37:06 +01002084MODULE_AUTHOR(DRIVER_AUTHOR);
2085MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086MODULE_LICENSE("GPL");
Scott James Remnante766aeb2009-04-06 17:33:18 +01002087MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);