blob: a1f4e1ead97ff4b6457e885a816b24478382ae27 [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>
Dan Drown3b563b92023-08-05 21:26:13 -050031#include <linux/tty_ldisc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/module.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010033#include <linux/mutex.h>
Alan Cox10077d42009-06-11 12:36:09 +010034#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/usb.h>
David Brownella8c28f22006-06-13 09:57:47 -070036#include <linux/usb/cdc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <asm/byteorder.h>
38#include <asm/unaligned.h>
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020039#include <linux/idr.h>
David Kubicek61a87ad2005-11-01 18:51:34 +010040#include <linux/list.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42#include "cdc-acm.h"
43
David Brownelle5fbab52008-08-06 18:46:10 -070044
Johan Hovold088c64f2011-03-25 11:06:02 +010045#define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
47
48static struct usb_driver acm_driver;
49static struct tty_driver *acm_tty_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020051static DEFINE_IDR(acm_minors);
52static DEFINE_MUTEX(acm_minors_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Jim Paris24cb4502014-10-30 11:04:47 -040054static void acm_tty_set_termios(struct tty_struct *tty,
Ilpo Järvinena8c11c12022-08-16 14:57:39 +030055 const struct ktermios *termios_old);
Jim Paris24cb4502014-10-30 11:04:47 -040056
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080057/*
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020058 * acm_minors accessors
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080059 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080061/*
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020062 * Look up an ACM structure by minor. If found and not disconnected, increment
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080063 * its refcount and return it with its mutex held.
64 */
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020065static struct acm *acm_get_by_minor(unsigned int minor)
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080066{
67 struct acm *acm;
68
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020069 mutex_lock(&acm_minors_lock);
70 acm = idr_find(&acm_minors, minor);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080071 if (acm) {
72 mutex_lock(&acm->mutex);
73 if (acm->disconnected) {
74 mutex_unlock(&acm->mutex);
75 acm = NULL;
76 } else {
77 tty_port_get(&acm->port);
78 mutex_unlock(&acm->mutex);
79 }
80 }
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020081 mutex_unlock(&acm_minors_lock);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080082 return acm;
83}
84
85/*
86 * Try to find an available minor number and if found, associate it with 'acm'.
87 */
88static int acm_alloc_minor(struct acm *acm)
89{
90 int minor;
91
Johan Hovold6cb4f4d2015-05-18 17:34:11 +020092 mutex_lock(&acm_minors_lock);
93 minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
94 mutex_unlock(&acm_minors_lock);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -080095
96 return minor;
97}
98
99/* Release the minor number associated with 'acm'. */
100static void acm_release_minor(struct acm *acm)
101{
Johan Hovold6cb4f4d2015-05-18 17:34:11 +0200102 mutex_lock(&acm_minors_lock);
103 idr_remove(&acm_minors, acm->minor);
104 mutex_unlock(&acm_minors_lock);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800105}
Alan Cox739e0282009-06-11 12:27:50 +0100106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107/*
108 * Functions for ACM control messages.
109 */
110
Alan Cox6e47e062009-06-11 12:37:06 +0100111static int acm_ctrl_msg(struct acm *acm, int request, int value,
112 void *buf, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
Johan Hovoldbae3f4c2014-05-26 19:23:39 +0200114 int retval;
115
116 retval = usb_autopm_get_interface(acm->control);
117 if (retval)
118 return retval;
119
120 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 request, USB_RT_ACM, value,
122 acm->control->altsetting[0].desc.bInterfaceNumber,
Oliver Neukumdf574082022-06-29 15:26:38 +0200123 buf, len, USB_CTRL_SET_TIMEOUT);
Johan Hovoldbae3f4c2014-05-26 19:23:39 +0200124
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100125 dev_dbg(&acm->control->dev,
Ladislav Michl90744af82016-11-18 19:01:22 +0100126 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
127 __func__, request, value, len, retval);
Johan Hovoldbae3f4c2014-05-26 19:23:39 +0200128
129 usb_autopm_put_interface(acm->control);
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 return retval < 0 ? retval : 0;
132}
133
134/* devices aren't required to support these requests.
135 * the cdc acm descriptor tells whether they do...
136 */
Johan Hovold2a8cdfd2014-11-06 18:08:33 +0100137static inline int acm_set_control(struct acm *acm, int control)
138{
139 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
140 return -EOPNOTSUPP;
141
142 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
143 control, NULL, 0);
144}
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146#define acm_set_line(acm, line) \
147 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
148#define acm_send_break(acm, ms) \
149 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
150
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100151static void acm_poison_urbs(struct acm *acm)
Ladislav Michlba8c9312016-11-18 19:07:08 +0100152{
153 int i;
154
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100155 usb_poison_urb(acm->ctrlurb);
Ladislav Michlba8c9312016-11-18 19:07:08 +0100156 for (i = 0; i < ACM_NW; i++)
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100157 usb_poison_urb(acm->wb[i].urb);
Ladislav Michlba8c9312016-11-18 19:07:08 +0100158 for (i = 0; i < acm->rx_buflimit; i++)
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100159 usb_poison_urb(acm->read_urbs[i]);
Ladislav Michlba8c9312016-11-18 19:07:08 +0100160}
161
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100162static void acm_unpoison_urbs(struct acm *acm)
163{
164 int i;
165
166 for (i = 0; i < acm->rx_buflimit; i++)
167 usb_unpoison_urb(acm->read_urbs[i]);
168 for (i = 0; i < ACM_NW; i++)
169 usb_unpoison_urb(acm->wb[i].urb);
170 usb_unpoison_urb(acm->ctrlurb);
171}
172
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174/*
Oliver Neukum884b6002005-04-21 21:28:02 +0200175 * Write buffer management.
176 * All of these assume proper locks taken by the caller.
177 */
178
179static int acm_wb_alloc(struct acm *acm)
180{
181 int i, wbn;
182 struct acm_wb *wb;
183
David Engrafe4cf3aa2008-03-20 10:01:34 +0100184 wbn = 0;
Oliver Neukum884b6002005-04-21 21:28:02 +0200185 i = 0;
186 for (;;) {
187 wb = &acm->wb[wbn];
188 if (!wb->use) {
Oliver Neukum37329032020-09-17 13:02:35 +0200189 wb->use = true;
Dominik Bozekb86b8eb2018-02-15 21:27:48 -0800190 wb->len = 0;
Oliver Neukum884b6002005-04-21 21:28:02 +0200191 return wbn;
192 }
Oliver Neukum86478942006-05-13 22:50:47 +0200193 wbn = (wbn + 1) % ACM_NW;
194 if (++i >= ACM_NW)
Oliver Neukum884b6002005-04-21 21:28:02 +0200195 return -1;
196 }
197}
198
Oliver Neukum884b6002005-04-21 21:28:02 +0200199static int acm_wb_is_avail(struct acm *acm)
200{
201 int i, n;
David Brownelle5fbab52008-08-06 18:46:10 -0700202 unsigned long flags;
Oliver Neukum884b6002005-04-21 21:28:02 +0200203
Oliver Neukum86478942006-05-13 22:50:47 +0200204 n = ACM_NW;
David Brownelle5fbab52008-08-06 18:46:10 -0700205 spin_lock_irqsave(&acm->write_lock, flags);
Alan Cox6e47e062009-06-11 12:37:06 +0100206 for (i = 0; i < ACM_NW; i++)
Oliver Neukum37329032020-09-17 13:02:35 +0200207 if(acm->wb[i].use)
208 n--;
David Brownelle5fbab52008-08-06 18:46:10 -0700209 spin_unlock_irqrestore(&acm->write_lock, flags);
Oliver Neukum884b6002005-04-21 21:28:02 +0200210 return n;
211}
212
Oliver Neukum884b6002005-04-21 21:28:02 +0200213/*
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800214 * Finish write. Caller must hold acm->write_lock
Oliver Neukum884b6002005-04-21 21:28:02 +0200215 */
David Engrafe4cf3aa2008-03-20 10:01:34 +0100216static void acm_write_done(struct acm *acm, struct acm_wb *wb)
Oliver Neukum884b6002005-04-21 21:28:02 +0200217{
Oliver Neukum37329032020-09-17 13:02:35 +0200218 wb->use = false;
Oliver Neukum11ea8592008-06-20 11:25:57 +0200219 acm->transmitting--;
Oliver Neukum97d35f92009-12-16 17:05:57 +0100220 usb_autopm_put_interface_async(acm->control);
Oliver Neukum884b6002005-04-21 21:28:02 +0200221}
222
223/*
224 * Poke write.
Oliver Neukum11ea8592008-06-20 11:25:57 +0200225 *
226 * the caller is responsible for locking
Oliver Neukum884b6002005-04-21 21:28:02 +0200227 */
Oliver Neukum11ea8592008-06-20 11:25:57 +0200228
229static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
230{
231 int rc;
232
233 acm->transmitting++;
234
235 wb->urb->transfer_buffer = wb->buf;
236 wb->urb->transfer_dma = wb->dmah;
237 wb->urb->transfer_buffer_length = wb->len;
238 wb->urb->dev = acm->dev;
239
Alan Cox6e47e062009-06-11 12:37:06 +0100240 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
241 if (rc < 0) {
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100242 if (rc != -EPERM)
243 dev_err(&acm->data->dev,
244 "%s - usb_submit_urb(write bulk) failed: %d\n",
245 __func__, rc);
Oliver Neukum11ea8592008-06-20 11:25:57 +0200246 acm_write_done(acm, wb);
247 }
248 return rc;
249}
250
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100251/*
252 * attributes exported through sysfs
253 */
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100254static ssize_t bmCapabilities_show
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100255(struct device *dev, struct device_attribute *attr, char *buf)
256{
257 struct usb_interface *intf = to_usb_interface(dev);
258 struct acm *acm = usb_get_intfdata(intf);
Oliver Neukum884b6002005-04-21 21:28:02 +0200259
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100260 return sprintf(buf, "%d", acm->ctrl_caps);
261}
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100262static DEVICE_ATTR_RO(bmCapabilities);
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100263
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100264static ssize_t wCountryCodes_show
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100265(struct device *dev, struct device_attribute *attr, char *buf)
266{
267 struct usb_interface *intf = to_usb_interface(dev);
268 struct acm *acm = usb_get_intfdata(intf);
269
270 memcpy(buf, acm->country_codes, acm->country_code_size);
271 return acm->country_code_size;
272}
273
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100274static DEVICE_ATTR_RO(wCountryCodes);
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100275
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100276static ssize_t iCountryCodeRelDate_show
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100277(struct device *dev, struct device_attribute *attr, char *buf)
278{
279 struct usb_interface *intf = to_usb_interface(dev);
280 struct acm *acm = usb_get_intfdata(intf);
281
282 return sprintf(buf, "%d", acm->country_rel_date);
283}
284
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +0100285static DEVICE_ATTR_RO(iCountryCodeRelDate);
Oliver Neukum884b6002005-04-21 21:28:02 +0200286/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 * Interrupt handlers for various ACM device responses
288 */
289
Tobias Herzogea258352017-03-30 22:15:11 +0200290static void acm_process_notification(struct acm *acm, unsigned char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 int newctrl;
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100293 int difference;
Sebastian Andrzej Siewior4685be22018-06-25 00:08:34 +0200294 unsigned long flags;
Tobias Herzogea258352017-03-30 22:15:11 +0200295 struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
296 unsigned char *data = buf + sizeof(struct usb_cdc_notification);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 switch (dr->bNotificationType) {
Alan Cox6e47e062009-06-11 12:37:06 +0100299 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
Ladislav Michl90744af82016-11-18 19:01:22 +0100300 dev_dbg(&acm->control->dev,
301 "%s - network connection: %d\n", __func__, dr->wValue);
Alan Cox6e47e062009-06-11 12:37:06 +0100302 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Alan Cox6e47e062009-06-11 12:37:06 +0100304 case USB_CDC_NOTIFY_SERIAL_STATE:
Tobias Herzog1bb99142017-03-30 22:15:10 +0200305 if (le16_to_cpu(dr->wLength) != 2) {
306 dev_dbg(&acm->control->dev,
307 "%s - malformed serial state\n", __func__);
308 break;
309 }
310
Alan Cox6e47e062009-06-11 12:37:06 +0100311 newctrl = get_unaligned_le16(data);
Tobias Herzog2d6dfd12017-03-30 22:15:12 +0200312 dev_dbg(&acm->control->dev,
313 "%s - serial state: 0x%x\n", __func__, newctrl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Johan Hovold7333c872022-07-25 09:58:38 +0200315 if (!acm->clocal && (acm->ctrlin & ~newctrl & USB_CDC_SERIAL_STATE_DCD)) {
Ladislav Michl90744af82016-11-18 19:01:22 +0100316 dev_dbg(&acm->control->dev,
317 "%s - calling hangup\n", __func__);
Jiri Slabyaa27a092013-03-07 13:12:30 +0100318 tty_port_tty_hangup(&acm->port, false);
Alan Cox6e47e062009-06-11 12:37:06 +0100319 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100321 difference = acm->ctrlin ^ newctrl;
Dan Drownf72ae602023-08-16 20:09:43 -0500322
323 if ((difference & USB_CDC_SERIAL_STATE_DCD) && acm->port.tty) {
324 struct tty_ldisc *ld = tty_ldisc_ref(acm->port.tty);
325 if (ld) {
326 if (ld->ops->dcd_change)
327 ld->ops->dcd_change(acm->port.tty, newctrl & USB_CDC_SERIAL_STATE_DCD);
328 tty_ldisc_deref(ld);
329 }
330 }
331
Sebastian Andrzej Siewior4685be22018-06-25 00:08:34 +0200332 spin_lock_irqsave(&acm->read_lock, flags);
Alan Cox6e47e062009-06-11 12:37:06 +0100333 acm->ctrlin = newctrl;
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100334 acm->oldcount = acm->iocount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Johan Hovold7333c872022-07-25 09:58:38 +0200336 if (difference & USB_CDC_SERIAL_STATE_DSR)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100337 acm->iocount.dsr++;
Dan Drownf72ae602023-08-16 20:09:43 -0500338 if (difference & USB_CDC_SERIAL_STATE_DCD)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100339 acm->iocount.dcd++;
Johan Hovold7333c872022-07-25 09:58:38 +0200340 if (newctrl & USB_CDC_SERIAL_STATE_BREAK) {
Tobias Herzogf976d0e2018-09-22 22:11:11 +0200341 acm->iocount.brk++;
Oliver Neukum08dff272021-03-11 14:37:14 +0100342 tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
343 }
Johan Hovold7333c872022-07-25 09:58:38 +0200344 if (newctrl & USB_CDC_SERIAL_STATE_RING_SIGNAL)
Tobias Herzogf976d0e2018-09-22 22:11:11 +0200345 acm->iocount.rng++;
Johan Hovold7333c872022-07-25 09:58:38 +0200346 if (newctrl & USB_CDC_SERIAL_STATE_FRAMING)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100347 acm->iocount.frame++;
Johan Hovold7333c872022-07-25 09:58:38 +0200348 if (newctrl & USB_CDC_SERIAL_STATE_PARITY)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100349 acm->iocount.parity++;
Johan Hovold7333c872022-07-25 09:58:38 +0200350 if (newctrl & USB_CDC_SERIAL_STATE_OVERRUN)
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100351 acm->iocount.overrun++;
Sebastian Andrzej Siewior4685be22018-06-25 00:08:34 +0200352 spin_unlock_irqrestore(&acm->read_lock, flags);
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100353
Johan Hovold7333c872022-07-25 09:58:38 +0200354 if (newctrl & USB_CDC_SERIAL_STATE_BREAK)
Johan Hovold58fc1da2021-09-29 11:09:37 +0200355 tty_flip_buffer_push(&acm->port);
356
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100357 if (difference)
358 wake_up_all(&acm->wioctl);
359
360 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Alan Cox6e47e062009-06-11 12:37:06 +0100362 default:
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100363 dev_dbg(&acm->control->dev,
Tobias Herzog1bb99142017-03-30 22:15:10 +0200364 "%s - unknown notification %d received: index %d len %d\n",
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100365 __func__,
Tobias Herzog1bb99142017-03-30 22:15:10 +0200366 dr->bNotificationType, dr->wIndex, dr->wLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 }
Tobias Herzogea258352017-03-30 22:15:11 +0200368}
369
370/* control interface reports status changes with "interrupt" transfers */
371static void acm_ctrl_irq(struct urb *urb)
372{
373 struct acm *acm = urb->context;
374 struct usb_cdc_notification *dr = urb->transfer_buffer;
375 unsigned int current_size = urb->actual_length;
376 unsigned int expected_size, copy_size, alloc_size;
377 int retval;
378 int status = urb->status;
379
380 switch (status) {
381 case 0:
382 /* success */
383 break;
384 case -ECONNRESET:
385 case -ENOENT:
386 case -ESHUTDOWN:
387 /* this urb is terminated, clean up */
Tobias Herzogea258352017-03-30 22:15:11 +0200388 dev_dbg(&acm->control->dev,
389 "%s - urb shutting down with status: %d\n",
390 __func__, status);
391 return;
392 default:
393 dev_dbg(&acm->control->dev,
394 "%s - nonzero urb status received: %d\n",
395 __func__, status);
396 goto exit;
397 }
398
399 usb_mark_last_busy(acm->dev);
400
401 if (acm->nb_index)
402 dr = (struct usb_cdc_notification *)acm->notification_buffer;
403
404 /* size = notification-header + (optional) data */
405 expected_size = sizeof(struct usb_cdc_notification) +
406 le16_to_cpu(dr->wLength);
407
408 if (current_size < expected_size) {
409 /* notification is transmitted fragmented, reassemble */
410 if (acm->nb_size < expected_size) {
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700411 u8 *new_buffer;
Tobias Herzogea258352017-03-30 22:15:11 +0200412 alloc_size = roundup_pow_of_two(expected_size);
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700413 /* Final freeing is done on disconnect. */
414 new_buffer = krealloc(acm->notification_buffer,
415 alloc_size, GFP_ATOMIC);
416 if (!new_buffer) {
417 acm->nb_index = 0;
Tobias Herzogea258352017-03-30 22:15:11 +0200418 goto exit;
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700419 }
420
421 acm->notification_buffer = new_buffer;
Tobias Herzogea258352017-03-30 22:15:11 +0200422 acm->nb_size = alloc_size;
Tom Rixf4b9d8a2020-08-01 08:21:54 -0700423 dr = (struct usb_cdc_notification *)acm->notification_buffer;
Tobias Herzogea258352017-03-30 22:15:11 +0200424 }
425
426 copy_size = min(current_size,
427 expected_size - acm->nb_index);
428
429 memcpy(&acm->notification_buffer[acm->nb_index],
430 urb->transfer_buffer, copy_size);
431 acm->nb_index += copy_size;
432 current_size = acm->nb_index;
433 }
434
435 if (current_size >= expected_size) {
436 /* notification complete */
437 acm_process_notification(acm, (unsigned char *)dr);
438 acm->nb_index = 0;
439 }
440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441exit:
Alan Cox6e47e062009-06-11 12:37:06 +0100442 retval = usb_submit_urb(urb, GFP_ATOMIC);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200443 if (retval && retval != -EPERM && retval != -ENODEV)
Ladislav Michl90744af82016-11-18 19:01:22 +0100444 dev_err(&acm->control->dev,
445 "%s - usb_submit_urb failed: %d\n", __func__, retval);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200446 else
447 dev_vdbg(&acm->control->dev,
448 "control resubmission terminated %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449}
450
Johan Hovold088c64f2011-03-25 11:06:02 +0100451static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
Johan Hovold088c64f2011-03-25 11:06:02 +0100453 int res;
Greg Kroah-Hartman185d4052007-07-18 10:58:02 -0700454
Johan Hovold088c64f2011-03-25 11:06:02 +0100455 if (!test_and_clear_bit(index, &acm->read_urbs_free))
456 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Johan Hovold088c64f2011-03-25 11:06:02 +0100458 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
459 if (res) {
Hans de Goedef0386c02018-01-14 16:09:00 +0100460 if (res != -EPERM && res != -ENODEV) {
Johan Hovold088c64f2011-03-25 11:06:02 +0100461 dev_err(&acm->data->dev,
Ladislav Michl90744af82016-11-18 19:01:22 +0100462 "urb %d failed submission with %d\n",
463 index, res);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200464 } else {
465 dev_vdbg(&acm->data->dev, "intended failure %d\n", res);
Johan Hovold088c64f2011-03-25 11:06:02 +0100466 }
467 set_bit(index, &acm->read_urbs_free);
468 return res;
Oliver Neukum46e75072016-09-13 16:44:36 +0200469 } else {
470 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
Johan Hovold088c64f2011-03-25 11:06:02 +0100471 }
472
473 return 0;
474}
475
476static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
477{
478 int res;
479 int i;
480
481 for (i = 0; i < acm->rx_buflimit; ++i) {
482 res = acm_submit_read_urb(acm, i, mem_flags);
483 if (res)
484 return res;
485 }
486
487 return 0;
488}
489
490static void acm_process_read_urb(struct acm *acm, struct urb *urb)
491{
Johan Hovold65a205e2021-09-29 11:09:36 +0200492 unsigned long flags;
493
Johan Hovold088c64f2011-03-25 11:06:02 +0100494 if (!urb->actual_length)
495 return;
496
Johan Hovold65a205e2021-09-29 11:09:36 +0200497 spin_lock_irqsave(&acm->read_lock, flags);
Jiri Slaby05c7cd32013-01-03 15:53:04 +0100498 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
499 urb->actual_length);
Johan Hovold65a205e2021-09-29 11:09:36 +0200500 spin_unlock_irqrestore(&acm->read_lock, flags);
501
Jiri Slaby2e124b42013-01-03 15:53:06 +0100502 tty_flip_buffer_push(&acm->port);
Johan Hovold088c64f2011-03-25 11:06:02 +0100503}
504
505static void acm_read_bulk_callback(struct urb *urb)
506{
507 struct acm_rb *rb = urb->context;
508 struct acm *acm = rb->instance;
Oliver Neukum36e59e02015-03-20 09:24:24 +0100509 int status = urb->status;
Johan Hovold764478f2019-04-25 18:05:39 +0200510 bool stopped = false;
511 bool stalled = false;
Oliver Neukuma4e72792020-04-15 17:13:58 +0200512 bool cooldown = false;
Johan Hovold088c64f2011-03-25 11:06:02 +0100513
Oliver Neukumefbe27b2016-09-13 16:44:37 +0200514 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
Ladislav Michl90744af82016-11-18 19:01:22 +0100515 rb->index, urb->actual_length, status);
Johan Hovold088c64f2011-03-25 11:06:02 +0100516
Ladislav Michl1aba5792016-11-18 19:11:26 +0100517 switch (status) {
518 case 0:
519 usb_mark_last_busy(acm->dev);
520 acm_process_read_urb(acm, urb);
521 break;
522 case -EPIPE:
523 set_bit(EVENT_RX_STALL, &acm->flags);
Johan Hovold764478f2019-04-25 18:05:39 +0200524 stalled = true;
525 break;
Ladislav Michl1aba5792016-11-18 19:11:26 +0100526 case -ENOENT:
527 case -ECONNRESET:
528 case -ESHUTDOWN:
529 dev_dbg(&acm->data->dev,
530 "%s - urb shutting down with status: %d\n",
531 __func__, status);
Johan Hovold764478f2019-04-25 18:05:39 +0200532 stopped = true;
533 break;
Oliver Neukuma4e72792020-04-15 17:13:58 +0200534 case -EOVERFLOW:
535 case -EPROTO:
536 dev_dbg(&acm->data->dev,
537 "%s - cooling babbling device\n", __func__);
538 usb_mark_last_busy(acm->dev);
539 set_bit(rb->index, &acm->urbs_in_error_delay);
Jerome Brunet38203b82020-10-19 19:07:02 +0200540 set_bit(ACM_ERROR_DELAY, &acm->flags);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200541 cooldown = true;
542 break;
Ladislav Michl1aba5792016-11-18 19:11:26 +0100543 default:
544 dev_dbg(&acm->data->dev,
545 "%s - nonzero urb status received: %d\n",
546 __func__, status);
547 break;
Johan Hovold088c64f2011-03-25 11:06:02 +0100548 }
Johan Hovold4a8ee502014-05-26 19:23:49 +0200549
Oliver Neukum36e59e02015-03-20 09:24:24 +0100550 /*
Johan Hovold764478f2019-04-25 18:05:39 +0200551 * Make sure URB processing is done before marking as free to avoid
552 * racing with unthrottle() on another CPU. Matches the barriers
553 * implied by the test_and_clear_bit() in acm_submit_read_urb().
Oliver Neukum36e59e02015-03-20 09:24:24 +0100554 */
555 smp_mb__before_atomic();
Johan Hovold764478f2019-04-25 18:05:39 +0200556 set_bit(rb->index, &acm->read_urbs_free);
557 /*
558 * Make sure URB is marked as free before checking the throttled flag
559 * to avoid racing with unthrottle() on another CPU. Matches the
560 * smp_mb() in unthrottle().
561 */
562 smp_mb__after_atomic();
563
Oliver Neukuma4e72792020-04-15 17:13:58 +0200564 if (stopped || stalled || cooldown) {
Johan Hovold764478f2019-04-25 18:05:39 +0200565 if (stalled)
Jerome Brunet38203b82020-10-19 19:07:02 +0200566 schedule_delayed_work(&acm->dwork, 0);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200567 else if (cooldown)
568 schedule_delayed_work(&acm->dwork, HZ / 2);
Johan Hovold764478f2019-04-25 18:05:39 +0200569 return;
570 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Johan Hovold0f023212019-04-25 18:05:40 +0200572 if (test_bit(ACM_THROTTLED, &acm->flags))
573 return;
574
575 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
578/* data interface wrote those outgoing bytes */
David Howells7d12e782006-10-05 14:55:46 +0100579static void acm_write_bulk(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Ming Leicdc97792008-02-24 18:41:47 +0800581 struct acm_wb *wb = urb->context;
David Brownelle5fbab52008-08-06 18:46:10 -0700582 struct acm *acm = wb->instance;
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800583 unsigned long flags;
Oliver Neukum4132cd02015-03-20 11:41:06 +0100584 int status = urb->status;
Oliver Neukum884b6002005-04-21 21:28:02 +0200585
Oliver Neukum4132cd02015-03-20 11:41:06 +0100586 if (status || (urb->actual_length != urb->transfer_buffer_length))
Oliver Neukumefbe27b2016-09-13 16:44:37 +0200587 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
David Brownelle5fbab52008-08-06 18:46:10 -0700588 urb->actual_length,
589 urb->transfer_buffer_length,
Oliver Neukum4132cd02015-03-20 11:41:06 +0100590 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800592 spin_lock_irqsave(&acm->write_lock, flags);
David Engrafe4cf3aa2008-03-20 10:01:34 +0100593 acm_write_done(acm, wb);
Brandon Philipsad0b65e2008-11-06 11:19:11 -0800594 spin_unlock_irqrestore(&acm->write_lock, flags);
Ladislav Michl1aba5792016-11-18 19:11:26 +0100595 set_bit(EVENT_TTY_WAKEUP, &acm->flags);
Jerome Brunet38203b82020-10-19 19:07:02 +0200596 schedule_delayed_work(&acm->dwork, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
598
David Howellsc4028952006-11-22 14:57:56 +0000599static void acm_softint(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600{
Ladislav Michl1aba5792016-11-18 19:11:26 +0100601 int i;
Jerome Brunet38203b82020-10-19 19:07:02 +0200602 struct acm *acm = container_of(work, struct acm, dwork.work);
David Brownelle5fbab52008-08-06 18:46:10 -0700603
Ladislav Michl1aba5792016-11-18 19:11:26 +0100604 if (test_bit(EVENT_RX_STALL, &acm->flags)) {
Oliver Neukum0afccd72020-04-15 17:13:57 +0200605 smp_mb(); /* against acm_suspend() */
606 if (!acm->susp_count) {
Ladislav Michl1aba5792016-11-18 19:11:26 +0100607 for (i = 0; i < acm->rx_buflimit; i++)
608 usb_kill_urb(acm->read_urbs[i]);
609 usb_clear_halt(acm->dev, acm->in);
610 acm_submit_read_urbs(acm, GFP_KERNEL);
Oliver Neukum0afccd72020-04-15 17:13:57 +0200611 clear_bit(EVENT_RX_STALL, &acm->flags);
Ladislav Michl1aba5792016-11-18 19:11:26 +0100612 }
Ladislav Michl1aba5792016-11-18 19:11:26 +0100613 }
614
Oliver Neukuma4e72792020-04-15 17:13:58 +0200615 if (test_and_clear_bit(ACM_ERROR_DELAY, &acm->flags)) {
Oliver Neukum97fe8092020-05-26 14:44:20 +0200616 for (i = 0; i < acm->rx_buflimit; i++)
Oliver Neukuma4e72792020-04-15 17:13:58 +0200617 if (test_and_clear_bit(i, &acm->urbs_in_error_delay))
Jerome Brunet38203b82020-10-19 19:07:02 +0200618 acm_submit_read_urb(acm, i, GFP_KERNEL);
Oliver Neukuma4e72792020-04-15 17:13:58 +0200619 }
620
Romain Izard93e1c8a2019-03-22 16:53:02 +0100621 if (test_and_clear_bit(EVENT_TTY_WAKEUP, &acm->flags))
Ladislav Michl1aba5792016-11-18 19:11:26 +0100622 tty_port_tty_wakeup(&acm->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623}
624
625/*
626 * TTY handlers
627 */
628
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800629static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
631 struct acm *acm;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800632 int retval;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100633
Johan Hovold6cb4f4d2015-05-18 17:34:11 +0200634 acm = acm_get_by_minor(tty->index);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800635 if (!acm)
636 return -ENODEV;
637
Jiri Slabyf8a8c102012-03-05 14:51:48 +0100638 retval = tty_standard_install(driver, tty);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800639 if (retval)
640 goto error_init_termios;
641
Macpaul Lineafb27f2018-12-19 12:11:03 +0800642 /*
643 * Suppress initial echoing for some devices which might send data
644 * immediately after acm driver has been installed.
645 */
646 if (acm->quirks & DISABLE_ECHO)
647 tty->termios.c_lflag &= ~ECHO;
648
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800649 tty->driver_data = acm;
650
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800651 return 0;
652
653error_init_termios:
654 tty_port_put(&acm->port);
655 return retval;
656}
657
658static int acm_tty_open(struct tty_struct *tty, struct file *filp)
659{
660 struct acm *acm = tty->driver_data;
661
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800662 return tty_port_open(&acm->port, tty, filp);
663}
664
Ilpo Järvinen5701cb82023-01-17 11:03:57 +0200665static void acm_port_dtr_rts(struct tty_port *port, bool active)
Johan Hovold0943d8e2014-05-26 19:23:51 +0200666{
667 struct acm *acm = container_of(port, struct acm, port);
668 int val;
669 int res;
670
Ilpo Järvinen5701cb82023-01-17 11:03:57 +0200671 if (active)
Johan Hovold3fb975e2022-07-25 09:58:37 +0200672 val = USB_CDC_CTRL_DTR | USB_CDC_CTRL_RTS;
Johan Hovold0943d8e2014-05-26 19:23:51 +0200673 else
674 val = 0;
675
676 /* FIXME: add missing ctrlout locking throughout driver */
677 acm->ctrlout = val;
678
679 res = acm_set_control(acm, val);
680 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
Oliver Neukume4c77072021-03-11 14:01:26 +0100681 /* This is broken in too many devices to spam the logs */
682 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
Johan Hovold0943d8e2014-05-26 19:23:51 +0200683}
684
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800685static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
686{
687 struct acm *acm = container_of(port, struct acm, port);
688 int retval = -ENODEV;
Johan Hovolde4c36072014-05-26 19:23:44 +0200689 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Oliver Neukum1365baf72007-10-12 17:24:28 +0200691 mutex_lock(&acm->mutex);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800692 if (acm->disconnected)
693 goto disconnected;
694
695 retval = usb_autopm_get_interface(acm->control);
696 if (retval)
697 goto error_get_interface;
698
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800699 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
700 acm->control->needs_remote_wakeup = 1;
Oliver Neukum1365baf72007-10-12 17:24:28 +0200701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 acm->ctrlurb->dev = acm->dev;
Johan Hovold8727bf62014-05-26 19:23:43 +0200703 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
704 if (retval) {
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100705 dev_err(&acm->control->dev,
706 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800707 goto error_submit_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 }
709
Jim Paris24cb4502014-10-30 11:04:47 -0400710 acm_tty_set_termios(tty, NULL);
711
Otto Meta6c4707f2012-06-06 18:46:21 +0200712 /*
713 * Unthrottle device in case the TTY was closed while throttled.
714 */
Johan Hovold0f023212019-04-25 18:05:40 +0200715 clear_bit(ACM_THROTTLED, &acm->flags);
Otto Meta6c4707f2012-06-06 18:46:21 +0200716
Johan Hovold8727bf62014-05-26 19:23:43 +0200717 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
718 if (retval)
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800719 goto error_submit_read_urbs;
Oliver Neukum2b626dc2010-02-03 17:10:22 +0100720
Johan Hovold703df322014-05-26 19:23:42 +0200721 usb_autopm_put_interface(acm->control);
722
Oliver Neukum1365baf72007-10-12 17:24:28 +0200723 mutex_unlock(&acm->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800725 return 0;
726
727error_submit_read_urbs:
Johan Hovolde4c36072014-05-26 19:23:44 +0200728 for (i = 0; i < acm->rx_buflimit; i++)
729 usb_kill_urb(acm->read_urbs[i]);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800730 usb_kill_urb(acm->ctrlurb);
731error_submit_urb:
Johan Hovold703df322014-05-26 19:23:42 +0200732 usb_autopm_put_interface(acm->control);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800733error_get_interface:
734disconnected:
735 mutex_unlock(&acm->mutex);
Johan Hovold8727bf62014-05-26 19:23:43 +0200736
737 return usb_translate_errors(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738}
739
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800740static void acm_port_destruct(struct tty_port *port)
brian@murphy.dk83ef3442005-06-29 16:53:29 -0700741{
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800742 struct acm *acm = container_of(port, struct acm, port);
743
Johan Hovold91fac072021-09-07 10:23:18 +0200744 if (acm->minor != ACM_MINOR_INVALID)
745 acm_release_minor(acm);
brian@murphy.dk83ef3442005-06-29 16:53:29 -0700746 usb_put_intf(acm->control);
Oliver Neukumc4cabd22007-02-27 15:28:55 +0100747 kfree(acm->country_codes);
brian@murphy.dk83ef3442005-06-29 16:53:29 -0700748 kfree(acm);
749}
750
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800751static void acm_port_shutdown(struct tty_port *port)
Alan Cox10077d42009-06-11 12:36:09 +0100752{
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800753 struct acm *acm = container_of(port, struct acm, port);
Johan Hovold140cb81a2014-05-26 19:23:38 +0200754 struct urb *urb;
755 struct acm_wb *wb;
Johan Hovolddab54c92011-03-22 11:12:21 +0100756
Johan Hovoldb1d42ef2014-05-26 19:23:48 +0200757 /*
758 * Need to grab write_lock to prevent race with resume, but no need to
759 * hold it due to the tty-port initialised flag.
760 */
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100761 acm_poison_urbs(acm);
Johan Hovoldb1d42ef2014-05-26 19:23:48 +0200762 spin_lock_irq(&acm->write_lock);
763 spin_unlock_irq(&acm->write_lock);
764
765 usb_autopm_get_interface_no_resume(acm->control);
766 acm->control->needs_remote_wakeup = 0;
767 usb_autopm_put_interface(acm->control);
768
Johan Hovold89e54e42014-05-26 19:23:47 +0200769 for (;;) {
770 urb = usb_get_from_anchor(&acm->delayed);
771 if (!urb)
772 break;
773 wb = urb->context;
Oliver Neukum37329032020-09-17 13:02:35 +0200774 wb->use = false;
Johan Hovold89e54e42014-05-26 19:23:47 +0200775 usb_autopm_put_interface_async(acm->control);
Alan Cox10077d42009-06-11 12:36:09 +0100776 }
Johan Hovold89e54e42014-05-26 19:23:47 +0200777
Oliver Neukum6069e3e2021-03-11 14:01:25 +0100778 acm_unpoison_urbs(acm);
779
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800780}
781
782static void acm_tty_cleanup(struct tty_struct *tty)
783{
784 struct acm *acm = tty->driver_data;
Oliver Neukumab57f862016-09-07 14:30:01 +0200785
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800786 tty_port_put(&acm->port);
Alan Cox10077d42009-06-11 12:36:09 +0100787}
788
789static void acm_tty_hangup(struct tty_struct *tty)
790{
791 struct acm *acm = tty->driver_data;
Oliver Neukumab57f862016-09-07 14:30:01 +0200792
Alan Cox10077d42009-06-11 12:36:09 +0100793 tty_port_hangup(&acm->port);
Alan Cox10077d42009-06-11 12:36:09 +0100794}
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796static void acm_tty_close(struct tty_struct *tty, struct file *filp)
797{
798 struct acm *acm = tty->driver_data;
Oliver Neukumab57f862016-09-07 14:30:01 +0200799
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800800 tty_port_close(&acm->port, tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801}
802
Jiri Slaby (SUSE)95713962023-08-10 11:15:03 +0200803static ssize_t acm_tty_write(struct tty_struct *tty, const u8 *buf,
804 size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805{
806 struct acm *acm = tty->driver_data;
807 int stat;
Oliver Neukum884b6002005-04-21 21:28:02 +0200808 unsigned long flags;
809 int wbn;
810 struct acm_wb *wb;
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 if (!count)
813 return 0;
814
Jiri Slaby (SUSE)95713962023-08-10 11:15:03 +0200815 dev_vdbg(&acm->data->dev, "%zu bytes from tty layer\n", count);
Johan Hovolda5cc7ef2011-03-22 11:12:15 +0100816
Oliver Neukum884b6002005-04-21 21:28:02 +0200817 spin_lock_irqsave(&acm->write_lock, flags);
Alan Cox6e47e062009-06-11 12:37:06 +0100818 wbn = acm_wb_alloc(acm);
819 if (wbn < 0) {
Oliver Neukum884b6002005-04-21 21:28:02 +0200820 spin_unlock_irqrestore(&acm->write_lock, flags);
Oliver Neukum884b6002005-04-21 21:28:02 +0200821 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
Oliver Neukum884b6002005-04-21 21:28:02 +0200823 wb = &acm->wb[wbn];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700825 if (!acm->dev) {
Oliver Neukum37329032020-09-17 13:02:35 +0200826 wb->use = false;
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700827 spin_unlock_irqrestore(&acm->write_lock, flags);
828 return -ENODEV;
829 }
830
Oliver Neukum884b6002005-04-21 21:28:02 +0200831 count = (count > acm->writesize) ? acm->writesize : count;
Jiri Slaby (SUSE)95713962023-08-10 11:15:03 +0200832 dev_vdbg(&acm->data->dev, "writing %zu bytes\n", count);
Oliver Neukum884b6002005-04-21 21:28:02 +0200833 memcpy(wb->buf, buf, count);
834 wb->len = count;
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700835
Johan Hovold183a4502014-05-26 19:23:41 +0200836 stat = usb_autopm_get_interface_async(acm->control);
837 if (stat) {
Oliver Neukum37329032020-09-17 13:02:35 +0200838 wb->use = false;
Johan Hovold183a4502014-05-26 19:23:41 +0200839 spin_unlock_irqrestore(&acm->write_lock, flags);
840 return stat;
841 }
842
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700843 if (acm->susp_count) {
Johan Hovold140cb81a2014-05-26 19:23:38 +0200844 usb_anchor_urb(wb->urb, &acm->delayed);
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700845 spin_unlock_irqrestore(&acm->write_lock, flags);
Johan Hovold140cb81a2014-05-26 19:23:38 +0200846 return count;
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700847 }
Greg Kroah-Hartman71c2fb02013-06-07 11:42:08 -0700848
849 stat = acm_start_wb(acm, wb);
Oliver Neukum884b6002005-04-21 21:28:02 +0200850 spin_unlock_irqrestore(&acm->write_lock, flags);
851
Alan Cox6e47e062009-06-11 12:37:06 +0100852 if (stat < 0)
Oliver Neukum884b6002005-04-21 21:28:02 +0200853 return stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 return count;
855}
856
Jiri Slaby03b3b1a2021-05-05 11:19:15 +0200857static unsigned int acm_tty_write_room(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858{
859 struct acm *acm = tty->driver_data;
Oliver Neukum884b6002005-04-21 21:28:02 +0200860 /*
861 * Do not let the line discipline to know that we have a reserve,
862 * or it might get too enthusiastic.
863 */
David Brownell934da462008-08-06 18:44:12 -0700864 return acm_wb_is_avail(acm) ? acm->writesize : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865}
866
Simon Arlott09867af2023-08-20 20:13:01 +0100867static void acm_tty_flush_buffer(struct tty_struct *tty)
868{
869 struct acm *acm = tty->driver_data;
870 unsigned long flags;
871 int i;
872
873 spin_lock_irqsave(&acm->write_lock, flags);
874 for (i = 0; i < ACM_NW; i++)
875 if (acm->wb[i].use)
876 usb_unlink_urb(acm->wb[i].urb);
877 spin_unlock_irqrestore(&acm->write_lock, flags);
878}
879
Jiri Slabyfff4ef12021-05-05 11:19:19 +0200880static unsigned int acm_tty_chars_in_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881{
882 struct acm *acm = tty->driver_data;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800883 /*
884 * if the device was unplugged then any remaining characters fell out
885 * of the connector ;)
886 */
887 if (acm->disconnected)
Alan Cox23198fd2009-07-20 16:05:27 +0100888 return 0;
Oliver Neukum884b6002005-04-21 21:28:02 +0200889 /*
890 * This is inaccurate (overcounts), but it works.
891 */
Oliver Neukum86478942006-05-13 22:50:47 +0200892 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893}
894
895static void acm_tty_throttle(struct tty_struct *tty)
896{
897 struct acm *acm = tty->driver_data;
Johan Hovold088c64f2011-03-25 11:06:02 +0100898
Johan Hovold0f023212019-04-25 18:05:40 +0200899 set_bit(ACM_THROTTLED, &acm->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900}
901
902static void acm_tty_unthrottle(struct tty_struct *tty)
903{
904 struct acm *acm = tty->driver_data;
Johan Hovold088c64f2011-03-25 11:06:02 +0100905
Johan Hovold0f023212019-04-25 18:05:40 +0200906 clear_bit(ACM_THROTTLED, &acm->flags);
Johan Hovold088c64f2011-03-25 11:06:02 +0100907
Johan Hovold764478f2019-04-25 18:05:39 +0200908 /* Matches the smp_mb__after_atomic() in acm_read_bulk_callback(). */
909 smp_mb();
910
Johan Hovold0f023212019-04-25 18:05:40 +0200911 acm_submit_read_urbs(acm, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912}
913
Alan Cox9e98966c2008-07-22 11:18:03 +0100914static int acm_tty_break_ctl(struct tty_struct *tty, int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915{
916 struct acm *acm = tty->driver_data;
Alan Cox9e98966c2008-07-22 11:18:03 +0100917 int retval;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -0800918
Alan Cox9e98966c2008-07-22 11:18:03 +0100919 retval = acm_send_break(acm, state ? 0xffff : 0);
920 if (retval < 0)
Ladislav Michl90744af82016-11-18 19:01:22 +0100921 dev_dbg(&acm->control->dev,
922 "%s - send break failed\n", __func__);
Alan Cox9e98966c2008-07-22 11:18:03 +0100923 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}
925
Alan Cox60b33c12011-02-14 16:26:14 +0000926static int acm_tty_tiocmget(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927{
928 struct acm *acm = tty->driver_data;
929
Johan Hovold3fb975e2022-07-25 09:58:37 +0200930 return (acm->ctrlout & USB_CDC_CTRL_DTR ? TIOCM_DTR : 0) |
931 (acm->ctrlout & USB_CDC_CTRL_RTS ? TIOCM_RTS : 0) |
Johan Hovold7333c872022-07-25 09:58:38 +0200932 (acm->ctrlin & USB_CDC_SERIAL_STATE_DSR ? TIOCM_DSR : 0) |
933 (acm->ctrlin & USB_CDC_SERIAL_STATE_RING_SIGNAL ? TIOCM_RI : 0) |
934 (acm->ctrlin & USB_CDC_SERIAL_STATE_DCD ? TIOCM_CD : 0) |
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 TIOCM_CTS;
936}
937
Alan Cox20b9d172011-02-14 16:26:50 +0000938static int acm_tty_tiocmset(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 unsigned int set, unsigned int clear)
940{
941 struct acm *acm = tty->driver_data;
942 unsigned int newctrl;
943
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 newctrl = acm->ctrlout;
Johan Hovold3fb975e2022-07-25 09:58:37 +0200945 set = (set & TIOCM_DTR ? USB_CDC_CTRL_DTR : 0) |
946 (set & TIOCM_RTS ? USB_CDC_CTRL_RTS : 0);
947 clear = (clear & TIOCM_DTR ? USB_CDC_CTRL_DTR : 0) |
948 (clear & TIOCM_RTS ? USB_CDC_CTRL_RTS : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
950 newctrl = (newctrl & ~clear) | set;
951
952 if (acm->ctrlout == newctrl)
953 return 0;
954 return acm_set_control(acm, acm->ctrlout = newctrl);
955}
956
Al Viro99f75a12018-09-11 23:33:40 -0400957static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
Oliver Neukum18c75722012-02-17 17:21:24 -0500958{
Al Viro99f75a12018-09-11 23:33:40 -0400959 struct acm *acm = tty->driver_data;
Oliver Neukum18c75722012-02-17 17:21:24 -0500960
Johan Hovold49696022021-04-08 15:16:02 +0200961 ss->line = acm->minor;
Anthony Mallet633e2b22020-03-12 14:31:00 +0100962 ss->close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
Al Viro99f75a12018-09-11 23:33:40 -0400963 ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600964 ASYNC_CLOSING_WAIT_NONE :
Anthony Mallet633e2b22020-03-12 14:31:00 +0100965 jiffies_to_msecs(acm->port.closing_wait) / 10;
Al Viro99f75a12018-09-11 23:33:40 -0400966 return 0;
Oliver Neukum18c75722012-02-17 17:21:24 -0500967}
968
Al Viro99f75a12018-09-11 23:33:40 -0400969static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600970{
Al Viro99f75a12018-09-11 23:33:40 -0400971 struct acm *acm = tty->driver_data;
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600972 unsigned int closing_wait, close_delay;
973 int retval = 0;
974
Anthony Mallet633e2b22020-03-12 14:31:00 +0100975 close_delay = msecs_to_jiffies(ss->close_delay * 10);
Al Viro99f75a12018-09-11 23:33:40 -0400976 closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
Anthony Mallet633e2b22020-03-12 14:31:00 +0100977 ASYNC_CLOSING_WAIT_NONE :
978 msecs_to_jiffies(ss->closing_wait * 10);
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600979
980 mutex_lock(&acm->port.mutex);
981
Matthias Reichl62d65bd2020-03-27 16:03:50 +0100982 if (!capable(CAP_SYS_ADMIN)) {
Johan Hovold729f7952021-04-08 15:16:00 +0200983 if ((close_delay != acm->port.close_delay) ||
984 (closing_wait != acm->port.closing_wait))
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600985 retval = -EPERM;
Matthias Reichl62d65bd2020-03-27 16:03:50 +0100986 } else {
987 acm->port.close_delay = close_delay;
988 acm->port.closing_wait = closing_wait;
989 }
Dan Williamsba2d8ce2012-11-08 12:47:41 -0600990
991 mutex_unlock(&acm->port.mutex);
992 return retval;
993}
994
Oliver Neukum5a6a62b2013-11-20 11:35:34 +0100995static int wait_serial_change(struct acm *acm, unsigned long arg)
996{
997 int rv = 0;
998 DECLARE_WAITQUEUE(wait, current);
999 struct async_icount old, new;
1000
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001001 do {
1002 spin_lock_irq(&acm->read_lock);
1003 old = acm->oldcount;
1004 new = acm->iocount;
1005 acm->oldcount = new;
1006 spin_unlock_irq(&acm->read_lock);
1007
1008 if ((arg & TIOCM_DSR) &&
1009 old.dsr != new.dsr)
1010 break;
1011 if ((arg & TIOCM_CD) &&
1012 old.dcd != new.dcd)
1013 break;
1014 if ((arg & TIOCM_RI) &&
1015 old.rng != new.rng)
1016 break;
1017
1018 add_wait_queue(&acm->wioctl, &wait);
1019 set_current_state(TASK_INTERRUPTIBLE);
1020 schedule();
1021 remove_wait_queue(&acm->wioctl, &wait);
1022 if (acm->disconnected) {
1023 if (arg & TIOCM_CD)
1024 break;
1025 else
1026 rv = -ENODEV;
1027 } else {
1028 if (signal_pending(current))
1029 rv = -ERESTARTSYS;
1030 }
1031 } while (!rv);
1032
1033
1034
1035 return rv;
1036}
1037
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001038static int acm_tty_get_icount(struct tty_struct *tty,
1039 struct serial_icounter_struct *icount)
Oliver Neukum797ef132013-11-20 11:35:35 +01001040{
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001041 struct acm *acm = tty->driver_data;
Oliver Neukum797ef132013-11-20 11:35:35 +01001042
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001043 icount->dsr = acm->iocount.dsr;
1044 icount->rng = acm->iocount.rng;
1045 icount->dcd = acm->iocount.dcd;
1046 icount->frame = acm->iocount.frame;
1047 icount->overrun = acm->iocount.overrun;
1048 icount->parity = acm->iocount.parity;
1049 icount->brk = acm->iocount.brk;
Oliver Neukum797ef132013-11-20 11:35:35 +01001050
Johan Hovoldbb2d3872016-11-08 13:28:24 +01001051 return 0;
Oliver Neukum797ef132013-11-20 11:35:35 +01001052}
1053
Alan Cox6caa76b2011-02-14 16:27:22 +00001054static int acm_tty_ioctl(struct tty_struct *tty,
Alan Cox6e47e062009-06-11 12:37:06 +01001055 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056{
Oliver Neukum18c75722012-02-17 17:21:24 -05001057 struct acm *acm = tty->driver_data;
1058 int rv = -ENOIOCTLCMD;
1059
1060 switch (cmd) {
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001061 case TIOCMIWAIT:
Oliver Neukum8fdbeb22013-11-20 11:35:36 +01001062 rv = usb_autopm_get_interface(acm->control);
1063 if (rv < 0) {
1064 rv = -EIO;
1065 break;
1066 }
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001067 rv = wait_serial_change(acm, arg);
Oliver Neukum8fdbeb22013-11-20 11:35:36 +01001068 usb_autopm_put_interface(acm->control);
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001069 break;
Oliver Neukum18c75722012-02-17 17:21:24 -05001070 }
1071
1072 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073}
1074
Alan Cox6e47e062009-06-11 12:37:06 +01001075static void acm_tty_set_termios(struct tty_struct *tty,
Ilpo Järvinena8c11c12022-08-16 14:57:39 +03001076 const struct ktermios *termios_old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077{
1078 struct acm *acm = tty->driver_data;
Alan Coxadc8d742012-07-14 15:31:47 +01001079 struct ktermios *termios = &tty->termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 struct usb_cdc_line_coding newline;
1081 int newctrl = acm->ctrlout;
1082
Alan Cox9b80fee2009-09-19 13:13:23 -07001083 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1085 newline.bParityType = termios->c_cflag & PARENB ?
Alan Cox6e47e062009-06-11 12:37:06 +01001086 (termios->c_cflag & PARODD ? 1 : 2) +
1087 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
Jiri Slaby3ec2ff32021-06-10 11:02:47 +02001088 newline.bDataBits = tty_get_char_size(termios->c_cflag);
1089
Alan Cox6e47e062009-06-11 12:37:06 +01001090 /* FIXME: Needs to clear unsupported bits in the termios */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1092
Johan Hovold4473d052014-11-05 18:41:59 +01001093 if (C_BAUD(tty) == B0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 newline.dwDTERate = acm->line.dwDTERate;
Johan Hovold3fb975e2022-07-25 09:58:37 +02001095 newctrl &= ~USB_CDC_CTRL_DTR;
Johan Hovold4473d052014-11-05 18:41:59 +01001096 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
Johan Hovold3fb975e2022-07-25 09:58:37 +02001097 newctrl |= USB_CDC_CTRL_DTR;
Johan Hovold4473d052014-11-05 18:41:59 +01001098 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
1100 if (newctrl != acm->ctrlout)
1101 acm_set_control(acm, acm->ctrlout = newctrl);
1102
1103 if (memcmp(&acm->line, &newline, sizeof newline)) {
1104 memcpy(&acm->line, &newline, sizeof newline);
Johan Hovolda5cc7ef2011-03-22 11:12:15 +01001105 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1106 __func__,
1107 le32_to_cpu(newline.dwDTERate),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 newline.bCharFormat, newline.bParityType,
1109 newline.bDataBits);
1110 acm_set_line(acm, &acm->line);
1111 }
1112}
1113
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001114static const struct tty_port_operations acm_port_ops = {
Johan Hovold0943d8e2014-05-26 19:23:51 +02001115 .dtr_rts = acm_port_dtr_rts,
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001116 .shutdown = acm_port_shutdown,
1117 .activate = acm_port_activate,
1118 .destruct = acm_port_destruct,
1119};
1120
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121/*
1122 * USB probe and disconnect routines.
1123 */
1124
Oliver Neukum830f4022008-06-25 14:17:16 +02001125/* Little helpers: write/read buffers free */
Oliver Neukum884b6002005-04-21 21:28:02 +02001126static void acm_write_buffers_free(struct acm *acm)
1127{
1128 int i;
1129 struct acm_wb *wb;
1130
Alan Cox6e47e062009-06-11 12:37:06 +01001131 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
Ladislav Michle4614602016-11-18 19:06:10 +01001132 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
Oliver Neukum884b6002005-04-21 21:28:02 +02001133}
1134
Oliver Neukum830f4022008-06-25 14:17:16 +02001135static void acm_read_buffers_free(struct acm *acm)
1136{
Johan Hovolddab54c92011-03-22 11:12:21 +01001137 int i;
Oliver Neukum830f4022008-06-25 14:17:16 +02001138
Johan Hovolddab54c92011-03-22 11:12:21 +01001139 for (i = 0; i < acm->rx_buflimit; i++)
Ladislav Michle4614602016-11-18 19:06:10 +01001140 usb_free_coherent(acm->dev, acm->readsize,
Johan Hovold088c64f2011-03-25 11:06:02 +01001141 acm->read_buffers[i].base, acm->read_buffers[i].dma);
Oliver Neukum830f4022008-06-25 14:17:16 +02001142}
1143
Oliver Neukum884b6002005-04-21 21:28:02 +02001144/* Little helper: write buffers allocate */
1145static int acm_write_buffers_alloc(struct acm *acm)
1146{
1147 int i;
1148 struct acm_wb *wb;
1149
Oliver Neukum86478942006-05-13 22:50:47 +02001150 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
Daniel Mack997ea582010-04-12 13:17:25 +02001151 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
Oliver Neukum884b6002005-04-21 21:28:02 +02001152 &wb->dmah);
1153 if (!wb->buf) {
1154 while (i != 0) {
1155 --i;
1156 --wb;
Daniel Mack997ea582010-04-12 13:17:25 +02001157 usb_free_coherent(acm->dev, acm->writesize,
Oliver Neukum884b6002005-04-21 21:28:02 +02001158 wb->buf, wb->dmah);
1159 }
1160 return -ENOMEM;
1161 }
1162 }
1163 return 0;
1164}
1165
Alan Cox10077d42009-06-11 12:36:09 +01001166static int acm_probe(struct usb_interface *intf,
1167 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168{
1169 struct usb_cdc_union_desc *union_header = NULL;
Oliver Neukumcb42b632016-07-14 15:41:34 +02001170 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
David Brownellc6dbf552008-04-13 14:00:44 -07001171 unsigned char *buffer = intf->altsetting->extra;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 int buflen = intf->altsetting->extralen;
1173 struct usb_interface *control_interface;
1174 struct usb_interface *data_interface;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001175 struct usb_endpoint_descriptor *epctrl = NULL;
1176 struct usb_endpoint_descriptor *epread = NULL;
1177 struct usb_endpoint_descriptor *epwrite = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 struct usb_device *usb_dev = interface_to_usbdev(intf);
Oliver Neukumcb42b632016-07-14 15:41:34 +02001179 struct usb_cdc_parsed_header h;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 struct acm *acm;
1181 int minor;
Alan Cox6e47e062009-06-11 12:37:06 +01001182 int ctrlsize, readsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 u8 *buf;
Oliver Neukumcb42b632016-07-14 15:41:34 +02001184 int call_intf_num = -1;
1185 int data_intf_num = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 unsigned long quirks;
Oliver Neukum86478942006-05-13 22:50:47 +02001187 int num_rx_buf;
David Kubicek61a87ad2005-11-01 18:51:34 +01001188 int i;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001189 int combined_interfaces = 0;
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001190 struct device *tty_dev;
1191 int rv = -ENOMEM;
Johan Hovoldf8d84642017-03-17 11:35:48 +01001192 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
Oliver Neukum86478942006-05-13 22:50:47 +02001194 /* normal quirks */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 quirks = (unsigned long)id->driver_info;
Dmitry Torokhov16142652013-02-02 11:02:14 -08001196
1197 if (quirks == IGNORE_DEVICE)
1198 return -ENODEV;
1199
Oliver Neukum7309aa82016-11-02 14:42:52 +01001200 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1201
Oliver Neukum86478942006-05-13 22:50:47 +02001202 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1203
1204 /* handle quirks deadly to normal probing*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 if (quirks == NO_UNION_NORMAL) {
1206 data_interface = usb_ifnum_to_if(usb_dev, 1);
1207 control_interface = usb_ifnum_to_if(usb_dev, 0);
Oliver Neukum8835ba42016-03-15 10:14:04 +01001208 /* we would crash */
1209 if (!data_interface || !control_interface)
1210 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 goto skip_normal_probe;
1212 }
Alan Cox6e47e062009-06-11 12:37:06 +01001213
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 /* normal probing*/
1215 if (!buffer) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001216 dev_err(&intf->dev, "Weird descriptor references\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 return -EINVAL;
1218 }
1219
1220 if (!buflen) {
Toby Gray577045c2010-09-02 10:46:20 +01001221 if (intf->cur_altsetting->endpoint &&
1222 intf->cur_altsetting->endpoint->extralen &&
Alan Cox6e47e062009-06-11 12:37:06 +01001223 intf->cur_altsetting->endpoint->extra) {
1224 dev_dbg(&intf->dev,
1225 "Seeking extra descriptors on endpoint\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 buflen = intf->cur_altsetting->endpoint->extralen;
1227 buffer = intf->cur_altsetting->endpoint->extra;
1228 } else {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001229 dev_err(&intf->dev,
1230 "Zero length descriptor references\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 return -EINVAL;
1232 }
1233 }
1234
Oliver Neukumcb42b632016-07-14 15:41:34 +02001235 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1236 union_header = h.usb_cdc_union_desc;
1237 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1238 if (cmgmd)
1239 call_intf_num = cmgmd->bDataInterface;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240
1241 if (!union_header) {
Johan Hovoldbf1c6742020-09-21 15:59:51 +02001242 if (intf->cur_altsetting->desc.bNumEndpoints == 3) {
1243 dev_dbg(&intf->dev, "No union descriptor, assuming single interface\n");
1244 combined_interfaces = 1;
1245 control_interface = data_interface = intf;
1246 goto look_for_collapsed_interface;
1247 } else if (call_intf_num > 0) {
Alan Cox6e47e062009-06-11 12:37:06 +01001248 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
Johan Hovoldbf1c6742020-09-21 15:59:51 +02001249 data_intf_num = call_intf_num;
1250 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 control_interface = intf;
1252 } else {
Johan Hovoldbf1c6742020-09-21 15:59:51 +02001253 dev_dbg(&intf->dev, "No union descriptor, giving up\n");
1254 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 }
1256 } else {
Johan Hovold960c7332020-09-21 15:59:49 +02001257 int class = -1;
1258
Oliver Neukumcb42b632016-07-14 15:41:34 +02001259 data_intf_num = union_header->bSlaveInterface0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
Oliver Neukumcb42b632016-07-14 15:41:34 +02001261 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
Johan Hovold960c7332020-09-21 15:59:49 +02001262
1263 if (control_interface)
1264 class = control_interface->cur_altsetting->desc.bInterfaceClass;
1265
1266 if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1267 dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1268 combined_interfaces = 1;
1269 control_interface = data_interface = intf;
1270 goto look_for_collapsed_interface;
1271 }
Greg Kroah-Hartman403dff42014-11-07 08:48:15 -08001272 }
1273
1274 if (!control_interface || !data_interface) {
1275 dev_dbg(&intf->dev, "no interfaces\n");
1276 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 }
Alan Cox6e47e062009-06-11 12:37:06 +01001278
Oliver Neukumcb42b632016-07-14 15:41:34 +02001279 if (data_intf_num != call_intf_num)
Alan Cox6e47e062009-06-11 12:37:06 +01001280 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001282 if (control_interface == data_interface) {
1283 /* some broken devices designed for windows work this way */
1284 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1285 combined_interfaces = 1;
1286 /* a popular other OS doesn't use it */
1287 quirks |= NO_CAP_LINE;
1288 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1289 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1290 return -EINVAL;
1291 }
1292look_for_collapsed_interface:
Johan Hovoldf8d84642017-03-17 11:35:48 +01001293 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1294 &epread, &epwrite, &epctrl, NULL);
1295 if (res)
1296 return res;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001297
Johan Hovoldf8d84642017-03-17 11:35:48 +01001298 goto made_compressed_probe;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001299 }
1300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301skip_normal_probe:
1302
1303 /*workaround for switched interfaces */
Johan Hovold319bb4a2020-09-21 15:59:50 +02001304 if (data_interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_CDC_DATA) {
1305 if (control_interface->cur_altsetting->desc.bInterfaceClass == USB_CLASS_CDC_DATA) {
Alan Cox6e47e062009-06-11 12:37:06 +01001306 dev_dbg(&intf->dev,
1307 "Your device has switched interfaces.\n");
Fabian Frederick2cfef792015-05-18 19:59:37 +02001308 swap(control_interface, data_interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 } else {
1310 return -EINVAL;
1311 }
1312 }
Alan Stern74da5d62007-08-02 13:29:10 -04001313
1314 /* Accept probe requests only for the control interface */
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001315 if (!combined_interfaces && intf != control_interface)
Alan Stern74da5d62007-08-02 13:29:10 -04001316 return -ENODEV;
Alan Cox6e47e062009-06-11 12:37:06 +01001317
Sven Schnelle99f347c2012-08-17 21:43:43 +02001318 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1319 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 return -EINVAL;
1321
1322 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1323 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1324 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1325
1326
1327 /* workaround for switched endpoints */
Luiz Fernando N. Capitulino45aea702006-10-26 13:02:48 -03001328 if (!usb_endpoint_dir_in(epread)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 /* descriptors are swapped */
Alan Cox6e47e062009-06-11 12:37:06 +01001330 dev_dbg(&intf->dev,
1331 "The data interface has switched endpoints\n");
Fabian Frederick2cfef792015-05-18 19:59:37 +02001332 swap(epread, epwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 }
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001334made_compressed_probe:
Johan Hovolda5cc7ef2011-03-22 11:12:15 +01001335 dev_dbg(&intf->dev, "interfaces are valid\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
Alan Cox6e47e062009-06-11 12:37:06 +01001337 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
Johan Hovoldf8255ee2021-03-22 16:53:16 +01001338 if (!acm)
Johan Hovold4cde0592021-03-22 16:53:15 +01001339 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Jaejoong Kimcae2bc72018-06-21 17:45:05 +09001341 tty_port_init(&acm->port);
1342 acm->port.ops = &acm_port_ops;
1343
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001344 ctrlsize = usb_endpoint_maxp(epctrl);
1345 readsize = usb_endpoint_maxp(epread) *
Alan Cox6e47e062009-06-11 12:37:06 +01001346 (quirks == SINGLE_RX_URB ? 1 : 2);
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001347 acm->combined_interfaces = combined_interfaces;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07001348 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 acm->control = control_interface;
1350 acm->data = data_interface;
Oliver Neukumc52873e2019-08-08 16:21:19 +02001351
1352 usb_get_intf(acm->control); /* undone in destruct() */
1353
1354 minor = acm_alloc_minor(acm);
Johan Hovold91fac072021-09-07 10:23:18 +02001355 if (minor < 0) {
1356 acm->minor = ACM_MINOR_INVALID;
Johan Hovold4cde0592021-03-22 16:53:15 +01001357 goto err_put_port;
Johan Hovold91fac072021-09-07 10:23:18 +02001358 }
Oliver Neukumc52873e2019-08-08 16:21:19 +02001359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 acm->minor = minor;
1361 acm->dev = usb_dev;
Oliver Neukumcb42b632016-07-14 15:41:34 +02001362 if (h.usb_cdc_acm_descriptor)
1363 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001364 if (quirks & NO_CAP_LINE)
1365 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 acm->ctrlsize = ctrlsize;
1367 acm->readsize = readsize;
Oliver Neukum86478942006-05-13 22:50:47 +02001368 acm->rx_buflimit = num_rx_buf;
Oliver Neukuma4e72792020-04-15 17:13:58 +02001369 INIT_DELAYED_WORK(&acm->dwork, acm_softint);
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001370 init_waitqueue_head(&acm->wioctl);
Oliver Neukum884b6002005-04-21 21:28:02 +02001371 spin_lock_init(&acm->write_lock);
David Kubicek61a87ad2005-11-01 18:51:34 +01001372 spin_lock_init(&acm->read_lock);
Oliver Neukum1365baf72007-10-12 17:24:28 +02001373 mutex_init(&acm->mutex);
Ladislav Michld3053942016-11-18 19:10:19 +01001374 if (usb_endpoint_xfer_int(epread)) {
Oliver Neukumcf7fdd52009-08-04 23:52:09 +02001375 acm->bInterval = epread->bInterval;
Ladislav Michl74bccc92016-11-18 19:09:19 +01001376 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1377 } else {
1378 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1379 }
1380 if (usb_endpoint_xfer_int(epwrite))
1381 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1382 else
1383 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
Johan Hovold140cb81a2014-05-26 19:23:38 +02001384 init_usb_anchor(&acm->delayed);
Johan Hovold2a8cdfd2014-11-06 18:08:33 +01001385 acm->quirks = quirks;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
Daniel Mack997ea582010-04-12 13:17:25 +02001387 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
Oliver Neukum17136d42015-01-28 16:56:24 +01001388 if (!buf)
Johan Hovold4cde0592021-03-22 16:53:15 +01001389 goto err_put_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 acm->ctrl_buffer = buf;
1391
Oliver Neukum17136d42015-01-28 16:56:24 +01001392 if (acm_write_buffers_alloc(acm) < 0)
Johan Hovold4cde0592021-03-22 16:53:15 +01001393 goto err_free_ctrl_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
1395 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
Oliver Neukum17136d42015-01-28 16:56:24 +01001396 if (!acm->ctrlurb)
Johan Hovold4cde0592021-03-22 16:53:15 +01001397 goto err_free_write_buffers;
Oliver Neukum17136d42015-01-28 16:56:24 +01001398
Oliver Neukum86478942006-05-13 22:50:47 +02001399 for (i = 0; i < num_rx_buf; i++) {
Johan Hovold088c64f2011-03-25 11:06:02 +01001400 struct acm_rb *rb = &(acm->read_buffers[i]);
1401 struct urb *urb;
David Kubicek61a87ad2005-11-01 18:51:34 +01001402
Johan Hovold74f5e1b2011-03-22 11:12:23 +01001403 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1404 &rb->dma);
Oliver Neukum17136d42015-01-28 16:56:24 +01001405 if (!rb->base)
Johan Hovold4cde0592021-03-22 16:53:15 +01001406 goto err_free_read_urbs;
Johan Hovold088c64f2011-03-25 11:06:02 +01001407 rb->index = i;
1408 rb->instance = acm;
Johan Hovold74f5e1b2011-03-22 11:12:23 +01001409
Johan Hovold088c64f2011-03-25 11:06:02 +01001410 urb = usb_alloc_urb(0, GFP_KERNEL);
Oliver Neukum17136d42015-01-28 16:56:24 +01001411 if (!urb)
Johan Hovold4cde0592021-03-22 16:53:15 +01001412 goto err_free_read_urbs;
Oliver Neukum17136d42015-01-28 16:56:24 +01001413
Johan Hovold088c64f2011-03-25 11:06:02 +01001414 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1415 urb->transfer_dma = rb->dma;
Ladislav Michld3053942016-11-18 19:10:19 +01001416 if (usb_endpoint_xfer_int(epread))
Ladislav Michl74bccc92016-11-18 19:09:19 +01001417 usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
Johan Hovold088c64f2011-03-25 11:06:02 +01001418 acm->readsize,
1419 acm_read_bulk_callback, rb,
1420 acm->bInterval);
Ladislav Michl74bccc92016-11-18 19:09:19 +01001421 else
1422 usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
Johan Hovold088c64f2011-03-25 11:06:02 +01001423 acm->readsize,
1424 acm_read_bulk_callback, rb);
David Kubicek61a87ad2005-11-01 18:51:34 +01001425
Johan Hovold088c64f2011-03-25 11:06:02 +01001426 acm->read_urbs[i] = urb;
1427 __set_bit(i, &acm->read_urbs_free);
David Kubicek61a87ad2005-11-01 18:51:34 +01001428 }
Alan Cox6e47e062009-06-11 12:37:06 +01001429 for (i = 0; i < ACM_NW; i++) {
David Engrafe4cf3aa2008-03-20 10:01:34 +01001430 struct acm_wb *snd = &(acm->wb[i]);
1431
Alan Cox6e47e062009-06-11 12:37:06 +01001432 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
Johan Hovoldf8255ee2021-03-22 16:53:16 +01001433 if (!snd->urb)
Johan Hovold4cde0592021-03-22 16:53:15 +01001434 goto err_free_write_urbs;
David Engrafe4cf3aa2008-03-20 10:01:34 +01001435
Arseniy Lartsev5186ffe2009-07-01 16:27:26 +04001436 if (usb_endpoint_xfer_int(epwrite))
Ladislav Michl74bccc92016-11-18 19:09:19 +01001437 usb_fill_int_urb(snd->urb, usb_dev, acm->out,
Arseniy Lartsev5186ffe2009-07-01 16:27:26 +04001438 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1439 else
Ladislav Michl74bccc92016-11-18 19:09:19 +01001440 usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
Arseniy Lartsev5186ffe2009-07-01 16:27:26 +04001441 NULL, acm->writesize, acm_write_bulk, snd);
David Engrafe4cf3aa2008-03-20 10:01:34 +01001442 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
Lu Baoluffdb1e32016-01-06 15:10:04 +08001443 if (quirks & SEND_ZERO_PACKET)
1444 snd->urb->transfer_flags |= URB_ZERO_PACKET;
David Engrafe4cf3aa2008-03-20 10:01:34 +01001445 snd->instance = acm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 }
1447
Alan Cox6e47e062009-06-11 12:37:06 +01001448 usb_set_intfdata(intf, acm);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001449
1450 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1451 if (i < 0)
Johan Hovold4cde0592021-03-22 16:53:15 +01001452 goto err_free_write_urbs;
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001453
Oliver Neukumcb42b632016-07-14 15:41:34 +02001454 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1455 struct usb_cdc_country_functional_desc * cfd =
1456 h.usb_cdc_country_functional_desc;
1457
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001458 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1459 if (!acm->country_codes)
1460 goto skip_countries;
1461 acm->country_code_size = cfd->bLength - 4;
Alan Cox6e47e062009-06-11 12:37:06 +01001462 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1463 cfd->bLength - 4);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001464 acm->country_rel_date = cfd->iCountryCodeRelDate;
1465
1466 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1467 if (i < 0) {
1468 kfree(acm->country_codes);
Julia Lawalle7c8e862011-12-23 14:02:55 +01001469 acm->country_codes = NULL;
1470 acm->country_code_size = 0;
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001471 goto skip_countries;
1472 }
1473
Alan Cox6e47e062009-06-11 12:37:06 +01001474 i = device_create_file(&intf->dev,
1475 &dev_attr_iCountryCodeRelDate);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001476 if (i < 0) {
Axel Linc2572b72010-05-31 08:04:47 +08001477 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001478 kfree(acm->country_codes);
Julia Lawalle7c8e862011-12-23 14:02:55 +01001479 acm->country_codes = NULL;
1480 acm->country_code_size = 0;
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001481 goto skip_countries;
1482 }
1483 }
1484
1485skip_countries:
Alan Cox6e47e062009-06-11 12:37:06 +01001486 usb_fill_int_urb(acm->ctrlurb, usb_dev,
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001487 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1488 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1489 /* works around buggy devices */
Felipe Balbid102e782013-07-01 11:23:24 +03001490 epctrl->bInterval ? epctrl->bInterval : 16);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1492 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
Tobias Herzogea258352017-03-30 22:15:11 +02001493 acm->notification_buffer = NULL;
1494 acm->nb_index = 0;
1495 acm->nb_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 acm->line.dwDTERate = cpu_to_le32(9600);
1498 acm->line.bDataBits = 8;
1499 acm_set_line(acm, &acm->line);
1500
Johan Hovold0b2b23c2021-03-22 16:53:17 +01001501 if (!acm->combined_interfaces) {
1502 rv = usb_driver_claim_interface(&acm_driver, data_interface, acm);
1503 if (rv)
1504 goto err_remove_files;
1505 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001507 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
Jiri Slaby734cc172012-08-07 21:47:47 +02001508 &control_interface->dev);
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001509 if (IS_ERR(tty_dev)) {
1510 rv = PTR_ERR(tty_dev);
Johan Hovold4cde0592021-03-22 16:53:15 +01001511 goto err_release_data_interface;
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Alexey Sokolov15bf7222015-06-02 11:49:30 +03001514 if (quirks & CLEAR_HALT_CONDITIONS) {
Ladislav Michl74bccc92016-11-18 19:09:19 +01001515 usb_clear_halt(usb_dev, acm->in);
1516 usb_clear_halt(usb_dev, acm->out);
Alexey Sokolov15bf7222015-06-02 11:49:30 +03001517 }
1518
Johan Hovold79579412021-03-22 16:53:18 +01001519 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1520
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001521 return 0;
Johan Hovold4cde0592021-03-22 16:53:15 +01001522
1523err_release_data_interface:
Johan Hovold4e49bf32021-03-22 16:53:12 +01001524 if (!acm->combined_interfaces) {
1525 /* Clear driver data so that disconnect() returns early. */
1526 usb_set_intfdata(data_interface, NULL);
1527 usb_driver_release_interface(&acm_driver, data_interface);
1528 }
Johan Hovold0b2b23c2021-03-22 16:53:17 +01001529err_remove_files:
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001530 if (acm->country_codes) {
1531 device_remove_file(&acm->control->dev,
1532 &dev_attr_wCountryCodes);
1533 device_remove_file(&acm->control->dev,
1534 &dev_attr_iCountryCodeRelDate);
1535 }
1536 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
Johan Hovold4cde0592021-03-22 16:53:15 +01001537err_free_write_urbs:
David Engrafe4cf3aa2008-03-20 10:01:34 +01001538 for (i = 0; i < ACM_NW; i++)
1539 usb_free_urb(acm->wb[i].urb);
Johan Hovold4cde0592021-03-22 16:53:15 +01001540err_free_read_urbs:
Oliver Neukum86478942006-05-13 22:50:47 +02001541 for (i = 0; i < num_rx_buf; i++)
Johan Hovold088c64f2011-03-25 11:06:02 +01001542 usb_free_urb(acm->read_urbs[i]);
Johan Hovold74f5e1b2011-03-22 11:12:23 +01001543 acm_read_buffers_free(acm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 usb_free_urb(acm->ctrlurb);
Johan Hovold4cde0592021-03-22 16:53:15 +01001545err_free_write_buffers:
Oliver Neukum884b6002005-04-21 21:28:02 +02001546 acm_write_buffers_free(acm);
Johan Hovold4cde0592021-03-22 16:53:15 +01001547err_free_ctrl_buffer:
Jaejoong Kimcae2bc72018-06-21 17:45:05 +09001548 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
Johan Hovold4cde0592021-03-22 16:53:15 +01001549err_put_port:
Jaejoong Kimcae2bc72018-06-21 17:45:05 +09001550 tty_port_put(&acm->port);
Johan Hovold4cde0592021-03-22 16:53:15 +01001551
Alexey Khoroshilovc93d8192013-03-16 01:30:32 +04001552 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553}
1554
1555static void acm_disconnect(struct usb_interface *intf)
1556{
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001557 struct acm *acm = usb_get_intfdata(intf);
Alan Cox10077d42009-06-11 12:36:09 +01001558 struct tty_struct *tty;
Romain Izardf2924d42018-09-20 16:49:04 +02001559 int i;
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001560
David Brownell672c4e12008-08-06 18:41:12 -07001561 /* sibling interface is already cleaning up */
1562 if (!acm)
Oliver Neukum86067eea2006-01-08 12:39:13 +01001563 return;
David Brownell672c4e12008-08-06 18:41:12 -07001564
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001565 acm->disconnected = true;
Oliver Neukum6069e3e2021-03-11 14:01:25 +01001566 /*
1567 * there is a circular dependency. acm_softint() can resubmit
1568 * the URBs in error handling so we need to block any
1569 * submission right away
1570 */
1571 acm_poison_urbs(acm);
1572 mutex_lock(&acm->mutex);
Alan Cox6e47e062009-06-11 12:37:06 +01001573 if (acm->country_codes) {
Alan Stern74da5d62007-08-02 13:29:10 -04001574 device_remove_file(&acm->control->dev,
1575 &dev_attr_wCountryCodes);
1576 device_remove_file(&acm->control->dev,
1577 &dev_attr_iCountryCodeRelDate);
Oliver Neukumc4cabd22007-02-27 15:28:55 +01001578 }
Oliver Neukum5a6a62b2013-11-20 11:35:34 +01001579 wake_up_all(&acm->wioctl);
Alan Stern74da5d62007-08-02 13:29:10 -04001580 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
Oliver Neukum86067eea2006-01-08 12:39:13 +01001581 usb_set_intfdata(acm->control, NULL);
1582 usb_set_intfdata(acm->data, NULL);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001583 mutex_unlock(&acm->mutex);
1584
1585 tty = tty_port_tty_get(&acm->port);
1586 if (tty) {
1587 tty_vhangup(tty);
1588 tty_kref_put(tty);
1589 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Oliver Neukuma4e72792020-04-15 17:13:58 +02001591 cancel_delayed_work_sync(&acm->dwork);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Johan Hovoldcb255052013-03-19 09:21:06 +01001593 tty_unregister_device(acm_tty_driver, acm->minor);
1594
Romain Izardf2924d42018-09-20 16:49:04 +02001595 usb_free_urb(acm->ctrlurb);
1596 for (i = 0; i < ACM_NW; i++)
1597 usb_free_urb(acm->wb[i].urb);
1598 for (i = 0; i < acm->rx_buflimit; i++)
1599 usb_free_urb(acm->read_urbs[i]);
Oliver Neukum884b6002005-04-21 21:28:02 +02001600 acm_write_buffers_free(acm);
Ladislav Michle4614602016-11-18 19:06:10 +01001601 usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
Oliver Neukum830f4022008-06-25 14:17:16 +02001602 acm_read_buffers_free(acm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
Tobias Herzogea258352017-03-30 22:15:11 +02001604 kfree(acm->notification_buffer);
1605
Oliver Neukuma2bfb4a2009-05-16 21:13:19 +02001606 if (!acm->combined_interfaces)
1607 usb_driver_release_interface(&acm_driver, intf == acm->control ?
Oliver Neukum830f4022008-06-25 14:17:16 +02001608 acm->data : acm->control);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001610 tty_port_put(&acm->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611}
1612
Oliver Neukum35758582008-07-01 19:10:08 +02001613#ifdef CONFIG_PM
Oliver Neukum1365baf72007-10-12 17:24:28 +02001614static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1615{
1616 struct acm *acm = usb_get_intfdata(intf);
Oliver Neukum11ea8592008-06-20 11:25:57 +02001617 int cnt;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001618
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001619 spin_lock_irq(&acm->write_lock);
Johan Hovold5a345c22014-05-26 19:23:36 +02001620 if (PMSG_IS_AUTO(message)) {
1621 if (acm->transmitting) {
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001622 spin_unlock_irq(&acm->write_lock);
Johan Hovold5a345c22014-05-26 19:23:36 +02001623 return -EBUSY;
1624 }
1625 }
Oliver Neukum11ea8592008-06-20 11:25:57 +02001626 cnt = acm->susp_count++;
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001627 spin_unlock_irq(&acm->write_lock);
Oliver Neukum11ea8592008-06-20 11:25:57 +02001628
1629 if (cnt)
Oliver Neukum1365baf72007-10-12 17:24:28 +02001630 return 0;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001631
Oliver Neukum6069e3e2021-03-11 14:01:25 +01001632 acm_poison_urbs(acm);
Oliver Neukuma4e72792020-04-15 17:13:58 +02001633 cancel_delayed_work_sync(&acm->dwork);
1634 acm->urbs_in_error_delay = 0;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001635
Oliver Neukum1365baf72007-10-12 17:24:28 +02001636 return 0;
1637}
1638
1639static int acm_resume(struct usb_interface *intf)
1640{
1641 struct acm *acm = usb_get_intfdata(intf);
Johan Hovold140cb81a2014-05-26 19:23:38 +02001642 struct urb *urb;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001643 int rv = 0;
1644
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001645 spin_lock_irq(&acm->write_lock);
Oliver Neukum11ea8592008-06-20 11:25:57 +02001646
Johan Hovolde144ed282014-05-26 19:23:37 +02001647 if (--acm->susp_count)
1648 goto out;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001649
Oliver Neukuma8b3b512021-04-21 09:45:13 +02001650 acm_unpoison_urbs(acm);
1651
Peter Hurleyd41861c2016-04-09 17:53:25 -07001652 if (tty_port_initialized(&acm->port)) {
Johan Hovolde144ed282014-05-26 19:23:37 +02001653 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
Oliver Neukum97d35f92009-12-16 17:05:57 +01001654
Johan Hovold140cb81a2014-05-26 19:23:38 +02001655 for (;;) {
1656 urb = usb_get_from_anchor(&acm->delayed);
1657 if (!urb)
1658 break;
1659
1660 acm_start_wb(acm, urb->context);
Oliver Neukum97d35f92009-12-16 17:05:57 +01001661 }
1662
1663 /*
1664 * delayed error checking because we must
1665 * do the write path at all cost
1666 */
Oliver Neukum1365baf72007-10-12 17:24:28 +02001667 if (rv < 0)
Johan Hovolde144ed282014-05-26 19:23:37 +02001668 goto out;
Oliver Neukum1365baf72007-10-12 17:24:28 +02001669
Johan Hovolde144ed282014-05-26 19:23:37 +02001670 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
Oliver Neukum1365baf72007-10-12 17:24:28 +02001671 }
Johan Hovolde144ed282014-05-26 19:23:37 +02001672out:
Johan Hovoldbbf0cb32014-05-26 19:23:46 +02001673 spin_unlock_irq(&acm->write_lock);
Oliver Neukum1365baf72007-10-12 17:24:28 +02001674
Oliver Neukum1365baf72007-10-12 17:24:28 +02001675 return rv;
1676}
Oliver Neukum35758582008-07-01 19:10:08 +02001677
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001678static int acm_reset_resume(struct usb_interface *intf)
1679{
1680 struct acm *acm = usb_get_intfdata(intf);
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001681
Peter Hurleyd41861c2016-04-09 17:53:25 -07001682 if (tty_port_initialized(&acm->port))
Jiri Slabyaa27a092013-03-07 13:12:30 +01001683 tty_port_tty_hangup(&acm->port, false);
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08001684
Francesco Lavraa91b0c52009-12-08 09:54:11 +01001685 return acm_resume(intf);
1686}
1687
Oliver Neukum35758582008-07-01 19:10:08 +02001688#endif /* CONFIG_PM */
Adrian Taylorc1479a92009-11-19 10:35:33 +00001689
Ladislav Michl1aba5792016-11-18 19:11:26 +01001690static int acm_pre_reset(struct usb_interface *intf)
1691{
1692 struct acm *acm = usb_get_intfdata(intf);
1693
1694 clear_bit(EVENT_RX_STALL, &acm->flags);
Oliver Neukum93979402018-10-04 15:49:06 +02001695 acm->nb_index = 0; /* pending control transfers are lost */
Ladislav Michl1aba5792016-11-18 19:11:26 +01001696
1697 return 0;
1698}
1699
Adrian Taylorc1479a92009-11-19 10:35:33 +00001700#define NOKIA_PCSUITE_ACM_INFO(x) \
1701 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1702 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1703 USB_CDC_ACM_PROTO_VENDOR)
1704
Toby Gray4035e452010-09-01 16:01:19 +01001705#define SAMSUNG_PCSUITE_ACM_INFO(x) \
1706 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1707 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1708 USB_CDC_ACM_PROTO_VENDOR)
1709
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710/*
1711 * USB driver structure.
1712 */
1713
Németh Márton6ef48522010-01-10 15:33:45 +01001714static const struct usb_device_id acm_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 /* quirky and broken devices */
Joakim Tjernlund03894572020-06-05 12:54:18 +02001716 { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1717 .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
Björn Gerhartb20b1612015-02-18 07:19:44 +01001718 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1719 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
David Cluytens3b59d162013-12-03 14:18:57 +01001720 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1721 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1723 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1724 },
Chris Brandt6d853c92020-11-11 08:12:09 -05001725 { USB_DEVICE(0x045b, 0x023c), /* Renesas USB Download mode */
1726 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1727 },
1728 { USB_DEVICE(0x045b, 0x0248), /* Renesas USB Download mode */
1729 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1730 },
1731 { USB_DEVICE(0x045b, 0x024D), /* Renesas USB Download mode */
1732 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1733 },
Andrey Arapovb0e2a702007-07-04 17:11:42 +02001734 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1735 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1736 },
Macpaul Lineafb27f2018-12-19 12:11:03 +08001737 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1738 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1739 },
Andrew Lunn0f9c7b42008-12-23 17:31:23 +01001740 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1741 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1742 },
Masahito Omote8753e652005-07-29 12:17:25 -07001743 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1744 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1745 },
Chris Malley91a9c922006-10-03 10:08:28 +01001746 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1747 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1748 },
Alan Cox7abcf202009-04-06 17:35:01 +01001749 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1750 .driver_info = SINGLE_RX_URB,
1751 },
Oliver Neukum86478942006-05-13 22:50:47 +02001752 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1753 .driver_info = SINGLE_RX_URB, /* firmware bug */
1754 },
Oliver Neukum3dd2ae82006-06-23 09:14:17 +02001755 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1756 .driver_info = SINGLE_RX_URB, /* firmware bug */
1757 },
Oliver Neukumdf1cc782018-01-18 12:13:45 +01001758 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1759 .driver_info = SINGLE_RX_URB,
1760 },
Houston Yaroschoff4a762562018-06-11 12:39:09 +02001761 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1762 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1763 },
Oliver Neukum9be84562007-02-12 08:50:03 +01001764 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1765 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1766 },
Iain McFarlane6149ed52008-05-04 00:13:49 +01001767 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1768 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1769 },
Eric Sandeenc8fd2c32008-08-14 08:25:40 -05001770 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1771 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1772 },
Alan Coxc89c60e2009-01-11 19:53:10 +00001773 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1774 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1775 },
Xiao Kaijiancab98a02009-05-08 00:48:23 +08001776 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1777 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1778 },
Maarten Jacobs63529ea2018-11-19 23:18:49 +00001779 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1780 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1781 },
Johan Hovold2a8cdfd2014-11-06 18:08:33 +01001782 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1783 .driver_info = QUIRK_CONTROL_LINE_STATE, },
Johan Hovoldcf84a692014-10-27 18:34:33 +01001784 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
Nathaniel Quillin30121602016-12-05 06:53:00 -08001785 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
Dmitriy Taychenachev155df652009-02-25 12:36:51 +08001786 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1787 },
Krzysztof Hałasa6abff5d2011-12-12 14:51:00 +01001788 /* Motorola H24 HSPA module: */
1789 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
Michael Ulbricht895d2402014-03-25 10:34:18 +01001790 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1791 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1792 },
1793 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1794 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1795 },
1796 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1797 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1798 },
1799 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1800 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1801 },
1802 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1803 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1804 },
1805 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1806 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1807 },
1808 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1809 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1810 },
Krzysztof Hałasa6abff5d2011-12-12 14:51:00 +01001811
Adam Richterc332b4e2009-02-18 16:17:15 -08001812 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1813 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1814 data interface instead of
1815 communications interface.
1816 Maybe we should define a new
1817 quirk for this. */
1818 },
Jean-Christian de Rivaze7d491a2012-10-10 12:49:02 +00001819 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1820 .driver_info = NO_UNION_NORMAL,
1821 },
Denis N Ladin036915a2012-12-26 18:29:44 +05001822 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1823 .driver_info = NO_UNION_NORMAL,
1824 },
Kir Kolyshkin1f17c502009-05-28 20:33:58 +04001825 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1826 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1827 },
Russ Nelsonc3baa192010-04-21 23:07:03 -04001828 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1829 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1830 },
Johan Hovoldfe855782017-07-12 15:08:39 +02001831 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1832 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1833 },
Maksim Salau765fb2f2017-10-11 11:10:52 +03001834 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1835 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1836 },
Thierry GUIBERTa10bc712022-08-19 10:17:02 +02001837 { USB_DEVICE(0x0c26, 0x0020), /* Icom ICF3400 Serie */
1838 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1839 },
Lubomir Rintel1445cbe2018-07-10 08:28:49 +02001840 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1841 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1842 },
Oliver Neukum9be84562007-02-12 08:50:03 +01001843
Alexey Sokolov15bf7222015-06-02 11:49:30 +03001844 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1845 .driver_info = CLEAR_HALT_CONDITIONS,
1846 },
1847
Adrian Taylorc1479a92009-11-19 10:35:33 +00001848 /* Nokia S60 phones expose two ACM channels. The first is
1849 * a modem and is picked up by the standard AT-command
1850 * information below. The second is 'vendor-specific' but
1851 * is treated as a serial device at the S60 end, so we want
1852 * to expose it on Linux too. */
1853 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1855 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1856 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1859 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1860 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1861 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1862 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1863 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1864 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1865 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1867 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1868 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1869 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1870 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1871 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1873 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1874 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1875 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1876 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1877 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1880 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1881 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1884 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
Adrian Taylorc1479a92009-11-19 10:35:33 +00001885 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1886 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1888 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1890 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1891 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1892 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1893 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1894 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
Przemo Firszt83a4eae2010-06-28 21:29:34 +01001895 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
Toby Gray4035e452010-09-01 16:01:19 +01001896 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1897 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1898 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1899 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1900 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1901 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1902 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1903 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1904 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1905 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
Arvid Ephraim Picciani721d92f2011-01-25 15:58:40 +01001906 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
Toby Gray4061fde2011-06-06 14:52:48 +01001907 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1908 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
Toby Gray4035e452010-09-01 16:01:19 +01001909 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
Adrian Taylorc1479a92009-11-19 10:35:33 +00001910
Denis Pershin65e52f42011-09-04 17:37:21 +07001911 /* Support for Owen devices */
1912 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1913
Adrian Taylorc1479a92009-11-19 10:35:33 +00001914 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1915
Dmitry Torokhov16142652013-02-02 11:02:14 -08001916#if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1917 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1918 .driver_info = IGNORE_DEVICE,
1919 },
1920 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1921 .driver_info = IGNORE_DEVICE,
1922 },
1923#endif
1924
Sean Young6eeb7752020-05-27 11:22:16 +02001925#if IS_ENABLED(CONFIG_IR_TOY)
1926 { USB_DEVICE(0x04d8, 0xfd08),
1927 .driver_info = IGNORE_DEVICE,
1928 },
Sean Young0ffc7652020-12-27 13:45:02 +00001929
1930 { USB_DEVICE(0x04d8, 0xf58b),
1931 .driver_info = IGNORE_DEVICE,
1932 },
Sean Young6eeb7752020-05-27 11:22:16 +02001933#endif
1934
Mauro Carvalho Chehab5f6225a2020-11-22 22:38:22 +05301935#if IS_ENABLED(CONFIG_USB_SERIAL_XR)
Mauro Carvalho Chehab039b81d2021-04-12 11:55:57 +02001936 { USB_DEVICE(0x04e2, 0x1400), .driver_info = IGNORE_DEVICE },
1937 { USB_DEVICE(0x04e2, 0x1401), .driver_info = IGNORE_DEVICE },
1938 { USB_DEVICE(0x04e2, 0x1402), .driver_info = IGNORE_DEVICE },
1939 { USB_DEVICE(0x04e2, 0x1403), .driver_info = IGNORE_DEVICE },
1940 { USB_DEVICE(0x04e2, 0x1410), .driver_info = IGNORE_DEVICE },
1941 { USB_DEVICE(0x04e2, 0x1411), .driver_info = IGNORE_DEVICE },
1942 { USB_DEVICE(0x04e2, 0x1412), .driver_info = IGNORE_DEVICE },
1943 { USB_DEVICE(0x04e2, 0x1414), .driver_info = IGNORE_DEVICE },
1944 { USB_DEVICE(0x04e2, 0x1420), .driver_info = IGNORE_DEVICE },
1945 { USB_DEVICE(0x04e2, 0x1422), .driver_info = IGNORE_DEVICE },
1946 { USB_DEVICE(0x04e2, 0x1424), .driver_info = IGNORE_DEVICE },
Mauro Carvalho Chehab5f6225a2020-11-22 22:38:22 +05301947#endif
1948
Oliver Neukume912e682016-01-18 15:45:18 +01001949 /*Samsung phone in firmware update mode */
1950 { USB_DEVICE(0x04e8, 0x685d),
1951 .driver_info = IGNORE_DEVICE,
1952 },
1953
Jonas Jonssonf33a7f72015-11-22 11:47:17 +01001954 /* Exclude Infineon Flash Loader utility */
1955 { USB_DEVICE(0x058b, 0x0041),
1956 .driver_info = IGNORE_DEVICE,
1957 },
1958
Vincent Mailhola4f88432020-10-03 00:41:51 +09001959 /* Exclude ETAS ES58x */
1960 { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1961 .driver_info = IGNORE_DEVICE,
1962 },
1963 { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1964 .driver_info = IGNORE_DEVICE,
1965 },
1966 { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1967 .driver_info = IGNORE_DEVICE,
1968 },
1969
Daniele Palmas34aabf92018-12-28 16:15:41 +01001970 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1971 .driver_info = SEND_ZERO_PACKET,
1972 },
1973 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1974 .driver_info = SEND_ZERO_PACKET,
1975 },
1976
Yorick de Wid4d8654e2021-02-13 15:49:02 +01001977 /* Exclude Goodix Fingerprint Reader */
1978 { USB_DEVICE(0x27c6, 0x5395),
1979 .driver_info = IGNORE_DEVICE,
1980 },
1981
Hannu Hartikainen48978072021-06-22 17:14:54 +03001982 /* Exclude Heimann Sensor GmbH USB appset demo */
1983 { USB_DEVICE(0x32a7, 0x0000),
1984 .driver_info = IGNORE_DEVICE,
1985 },
1986
Philippe Corbes5b239f02010-08-31 19:31:32 +02001987 /* control interfaces without any protocol set */
1988 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1989 USB_CDC_PROTO_NONE) },
1990
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 /* control interfaces with various AT-command sets */
1992 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1993 USB_CDC_ACM_PROTO_AT_V25TER) },
1994 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1995 USB_CDC_ACM_PROTO_AT_PCCA101) },
1996 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1997 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1998 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1999 USB_CDC_ACM_PROTO_AT_GSM) },
2000 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
Alan Cox6e47e062009-06-11 12:37:06 +01002001 USB_CDC_ACM_PROTO_AT_3G) },
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
2003 USB_CDC_ACM_PROTO_AT_CDMA) },
2004
Lu Baoluffdb1e32016-01-06 15:10:04 +08002005 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
2006 .driver_info = SEND_ZERO_PACKET,
2007 },
2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 { }
2010};
2011
Alan Cox6e47e062009-06-11 12:37:06 +01002012MODULE_DEVICE_TABLE(usb, acm_ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013
2014static struct usb_driver acm_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 .name = "cdc_acm",
2016 .probe = acm_probe,
2017 .disconnect = acm_disconnect,
Oliver Neukum35758582008-07-01 19:10:08 +02002018#ifdef CONFIG_PM
Oliver Neukum1365baf72007-10-12 17:24:28 +02002019 .suspend = acm_suspend,
2020 .resume = acm_resume,
Francesco Lavraa91b0c52009-12-08 09:54:11 +01002021 .reset_resume = acm_reset_resume,
Oliver Neukum35758582008-07-01 19:10:08 +02002022#endif
Ladislav Michl1aba5792016-11-18 19:11:26 +01002023 .pre_reset = acm_pre_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 .id_table = acm_ids,
Oliver Neukum35758582008-07-01 19:10:08 +02002025#ifdef CONFIG_PM
Oliver Neukum1365baf72007-10-12 17:24:28 +02002026 .supports_autosuspend = 1,
Oliver Neukum35758582008-07-01 19:10:08 +02002027#endif
Sarah Sharpe1f12eb2012-04-23 10:08:51 -07002028 .disable_hub_initiated_lpm = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029};
2030
2031/*
2032 * TTY driver structures.
2033 */
2034
Jeff Dikeb68e31d2006-10-02 02:17:18 -07002035static const struct tty_operations acm_ops = {
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08002036 .install = acm_tty_install,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 .open = acm_tty_open,
2038 .close = acm_tty_close,
Havard Skinnemoen7fb57a02011-11-30 13:28:14 -08002039 .cleanup = acm_tty_cleanup,
Alan Cox10077d42009-06-11 12:36:09 +01002040 .hangup = acm_tty_hangup,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 .write = acm_tty_write,
2042 .write_room = acm_tty_write_room,
Simon Arlott09867af2023-08-20 20:13:01 +01002043 .flush_buffer = acm_tty_flush_buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 .ioctl = acm_tty_ioctl,
2045 .throttle = acm_tty_throttle,
2046 .unthrottle = acm_tty_unthrottle,
2047 .chars_in_buffer = acm_tty_chars_in_buffer,
2048 .break_ctl = acm_tty_break_ctl,
2049 .set_termios = acm_tty_set_termios,
2050 .tiocmget = acm_tty_tiocmget,
2051 .tiocmset = acm_tty_tiocmset,
Al Viro99f75a12018-09-11 23:33:40 -04002052 .get_serial = get_serial_info,
2053 .set_serial = set_serial_info,
Johan Hovoldbb2d3872016-11-08 13:28:24 +01002054 .get_icount = acm_tty_get_icount,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055};
2056
2057/*
2058 * Init / exit.
2059 */
2060
2061static int __init acm_init(void)
2062{
2063 int retval;
Jiri Slaby39b7b422021-07-23 09:43:13 +02002064 acm_tty_driver = tty_alloc_driver(ACM_TTY_MINORS, TTY_DRIVER_REAL_RAW |
2065 TTY_DRIVER_DYNAMIC_DEV);
2066 if (IS_ERR(acm_tty_driver))
2067 return PTR_ERR(acm_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 acm_tty_driver->driver_name = "acm",
2069 acm_tty_driver->name = "ttyACM",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 acm_tty_driver->major = ACM_TTY_MAJOR,
2071 acm_tty_driver->minor_start = 0,
2072 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2073 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 acm_tty_driver->init_termios = tty_std_termios;
Alan Cox6e47e062009-06-11 12:37:06 +01002075 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2076 HUPCL | CLOCAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 tty_set_operations(acm_tty_driver, &acm_ops);
2078
2079 retval = tty_register_driver(acm_tty_driver);
2080 if (retval) {
Jiri Slaby9f90a4d2021-07-23 09:43:16 +02002081 tty_driver_kref_put(acm_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 return retval;
2083 }
2084
2085 retval = usb_register(&acm_driver);
2086 if (retval) {
2087 tty_unregister_driver(acm_tty_driver);
Jiri Slaby9f90a4d2021-07-23 09:43:16 +02002088 tty_driver_kref_put(acm_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 return retval;
2090 }
2091
Johan Hovolda2c7b932011-03-22 11:12:18 +01002092 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
2094 return 0;
2095}
2096
2097static void __exit acm_exit(void)
2098{
2099 usb_deregister(&acm_driver);
2100 tty_unregister_driver(acm_tty_driver);
Jiri Slaby9f90a4d2021-07-23 09:43:16 +02002101 tty_driver_kref_put(acm_tty_driver);
Johannes Thumshirn91b72562015-07-08 17:25:42 +02002102 idr_destroy(&acm_minors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103}
2104
2105module_init(acm_init);
2106module_exit(acm_exit);
2107
Alan Cox6e47e062009-06-11 12:37:06 +01002108MODULE_AUTHOR(DRIVER_AUTHOR);
2109MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110MODULE_LICENSE("GPL");
Scott James Remnante766aeb2009-04-06 17:33:18 +01002111MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);