Loading...
1/*
2 * cdc-acm.c
3 *
4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
11 *
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
13 *
14 * Sponsored by SuSE
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 */
30
31#undef DEBUG
32#undef VERBOSE_DEBUG
33
34#include <linux/kernel.h>
35#include <linux/errno.h>
36#include <linux/init.h>
37#include <linux/slab.h>
38#include <linux/tty.h>
39#include <linux/serial.h>
40#include <linux/tty_driver.h>
41#include <linux/tty_flip.h>
42#include <linux/module.h>
43#include <linux/mutex.h>
44#include <linux/uaccess.h>
45#include <linux/usb.h>
46#include <linux/usb/cdc.h>
47#include <asm/byteorder.h>
48#include <asm/unaligned.h>
49#include <linux/list.h>
50
51#include "cdc-acm.h"
52
53
54#define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55#define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
56
57static struct usb_driver acm_driver;
58static struct tty_driver *acm_tty_driver;
59static struct acm *acm_table[ACM_TTY_MINORS];
60
61static DEFINE_MUTEX(open_mutex);
62
63#define ACM_READY(acm) (acm && acm->dev && acm->port.count)
64
65static const struct tty_port_operations acm_port_ops = {
66};
67
68/*
69 * Functions for ACM control messages.
70 */
71
72static int acm_ctrl_msg(struct acm *acm, int request, int value,
73 void *buf, int len)
74{
75 int retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
76 request, USB_RT_ACM, value,
77 acm->control->altsetting[0].desc.bInterfaceNumber,
78 buf, len, 5000);
79 dev_dbg(&acm->control->dev,
80 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
81 __func__, request, value, len, retval);
82 return retval < 0 ? retval : 0;
83}
84
85/* devices aren't required to support these requests.
86 * the cdc acm descriptor tells whether they do...
87 */
88#define acm_set_control(acm, control) \
89 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
90#define acm_set_line(acm, line) \
91 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
92#define acm_send_break(acm, ms) \
93 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
94
95/*
96 * Write buffer management.
97 * All of these assume proper locks taken by the caller.
98 */
99
100static int acm_wb_alloc(struct acm *acm)
101{
102 int i, wbn;
103 struct acm_wb *wb;
104
105 wbn = 0;
106 i = 0;
107 for (;;) {
108 wb = &acm->wb[wbn];
109 if (!wb->use) {
110 wb->use = 1;
111 return wbn;
112 }
113 wbn = (wbn + 1) % ACM_NW;
114 if (++i >= ACM_NW)
115 return -1;
116 }
117}
118
119static int acm_wb_is_avail(struct acm *acm)
120{
121 int i, n;
122 unsigned long flags;
123
124 n = ACM_NW;
125 spin_lock_irqsave(&acm->write_lock, flags);
126 for (i = 0; i < ACM_NW; i++)
127 n -= acm->wb[i].use;
128 spin_unlock_irqrestore(&acm->write_lock, flags);
129 return n;
130}
131
132/*
133 * Finish write. Caller must hold acm->write_lock
134 */
135static void acm_write_done(struct acm *acm, struct acm_wb *wb)
136{
137 wb->use = 0;
138 acm->transmitting--;
139 usb_autopm_put_interface_async(acm->control);
140}
141
142/*
143 * Poke write.
144 *
145 * the caller is responsible for locking
146 */
147
148static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
149{
150 int rc;
151
152 acm->transmitting++;
153
154 wb->urb->transfer_buffer = wb->buf;
155 wb->urb->transfer_dma = wb->dmah;
156 wb->urb->transfer_buffer_length = wb->len;
157 wb->urb->dev = acm->dev;
158
159 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
160 if (rc < 0) {
161 dev_err(&acm->data->dev,
162 "%s - usb_submit_urb(write bulk) failed: %d\n",
163 __func__, rc);
164 acm_write_done(acm, wb);
165 }
166 return rc;
167}
168
169static int acm_write_start(struct acm *acm, int wbn)
170{
171 unsigned long flags;
172 struct acm_wb *wb = &acm->wb[wbn];
173 int rc;
174
175 spin_lock_irqsave(&acm->write_lock, flags);
176 if (!acm->dev) {
177 wb->use = 0;
178 spin_unlock_irqrestore(&acm->write_lock, flags);
179 return -ENODEV;
180 }
181
182 dev_vdbg(&acm->data->dev, "%s - susp_count %d\n", __func__,
183 acm->susp_count);
184 usb_autopm_get_interface_async(acm->control);
185 if (acm->susp_count) {
186 if (!acm->delayed_wb)
187 acm->delayed_wb = wb;
188 else
189 usb_autopm_put_interface_async(acm->control);
190 spin_unlock_irqrestore(&acm->write_lock, flags);
191 return 0; /* A white lie */
192 }
193 usb_mark_last_busy(acm->dev);
194
195 rc = acm_start_wb(acm, wb);
196 spin_unlock_irqrestore(&acm->write_lock, flags);
197
198 return rc;
199
200}
201/*
202 * attributes exported through sysfs
203 */
204static ssize_t show_caps
205(struct device *dev, struct device_attribute *attr, char *buf)
206{
207 struct usb_interface *intf = to_usb_interface(dev);
208 struct acm *acm = usb_get_intfdata(intf);
209
210 return sprintf(buf, "%d", acm->ctrl_caps);
211}
212static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
213
214static ssize_t show_country_codes
215(struct device *dev, struct device_attribute *attr, char *buf)
216{
217 struct usb_interface *intf = to_usb_interface(dev);
218 struct acm *acm = usb_get_intfdata(intf);
219
220 memcpy(buf, acm->country_codes, acm->country_code_size);
221 return acm->country_code_size;
222}
223
224static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
225
226static ssize_t show_country_rel_date
227(struct device *dev, struct device_attribute *attr, char *buf)
228{
229 struct usb_interface *intf = to_usb_interface(dev);
230 struct acm *acm = usb_get_intfdata(intf);
231
232 return sprintf(buf, "%d", acm->country_rel_date);
233}
234
235static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
236/*
237 * Interrupt handlers for various ACM device responses
238 */
239
240/* control interface reports status changes with "interrupt" transfers */
241static void acm_ctrl_irq(struct urb *urb)
242{
243 struct acm *acm = urb->context;
244 struct usb_cdc_notification *dr = urb->transfer_buffer;
245 struct tty_struct *tty;
246 unsigned char *data;
247 int newctrl;
248 int retval;
249 int status = urb->status;
250
251 switch (status) {
252 case 0:
253 /* success */
254 break;
255 case -ECONNRESET:
256 case -ENOENT:
257 case -ESHUTDOWN:
258 /* this urb is terminated, clean up */
259 dev_dbg(&acm->control->dev,
260 "%s - urb shutting down with status: %d\n",
261 __func__, status);
262 return;
263 default:
264 dev_dbg(&acm->control->dev,
265 "%s - nonzero urb status received: %d\n",
266 __func__, status);
267 goto exit;
268 }
269
270 if (!ACM_READY(acm))
271 goto exit;
272
273 usb_mark_last_busy(acm->dev);
274
275 data = (unsigned char *)(dr + 1);
276 switch (dr->bNotificationType) {
277 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
278 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
279 __func__, dr->wValue);
280 break;
281
282 case USB_CDC_NOTIFY_SERIAL_STATE:
283 tty = tty_port_tty_get(&acm->port);
284 newctrl = get_unaligned_le16(data);
285
286 if (tty) {
287 if (!acm->clocal &&
288 (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
289 dev_dbg(&acm->control->dev,
290 "%s - calling hangup\n", __func__);
291 tty_hangup(tty);
292 }
293 tty_kref_put(tty);
294 }
295
296 acm->ctrlin = newctrl;
297
298 dev_dbg(&acm->control->dev,
299 "%s - input control lines: dcd%c dsr%c break%c "
300 "ring%c framing%c parity%c overrun%c\n",
301 __func__,
302 acm->ctrlin & ACM_CTRL_DCD ? '+' : '-',
303 acm->ctrlin & ACM_CTRL_DSR ? '+' : '-',
304 acm->ctrlin & ACM_CTRL_BRK ? '+' : '-',
305 acm->ctrlin & ACM_CTRL_RI ? '+' : '-',
306 acm->ctrlin & ACM_CTRL_FRAMING ? '+' : '-',
307 acm->ctrlin & ACM_CTRL_PARITY ? '+' : '-',
308 acm->ctrlin & ACM_CTRL_OVERRUN ? '+' : '-');
309 break;
310
311 default:
312 dev_dbg(&acm->control->dev,
313 "%s - unknown notification %d received: index %d "
314 "len %d data0 %d data1 %d\n",
315 __func__,
316 dr->bNotificationType, dr->wIndex,
317 dr->wLength, data[0], data[1]);
318 break;
319 }
320exit:
321 retval = usb_submit_urb(urb, GFP_ATOMIC);
322 if (retval)
323 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
324 __func__, retval);
325}
326
327static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
328{
329 int res;
330
331 if (!test_and_clear_bit(index, &acm->read_urbs_free))
332 return 0;
333
334 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
335
336 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
337 if (res) {
338 if (res != -EPERM) {
339 dev_err(&acm->data->dev,
340 "%s - usb_submit_urb failed: %d\n",
341 __func__, res);
342 }
343 set_bit(index, &acm->read_urbs_free);
344 return res;
345 }
346
347 return 0;
348}
349
350static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
351{
352 int res;
353 int i;
354
355 for (i = 0; i < acm->rx_buflimit; ++i) {
356 res = acm_submit_read_urb(acm, i, mem_flags);
357 if (res)
358 return res;
359 }
360
361 return 0;
362}
363
364static void acm_process_read_urb(struct acm *acm, struct urb *urb)
365{
366 struct tty_struct *tty;
367
368 if (!urb->actual_length)
369 return;
370
371 tty = tty_port_tty_get(&acm->port);
372 if (!tty)
373 return;
374
375 tty_insert_flip_string(tty, urb->transfer_buffer, urb->actual_length);
376 tty_flip_buffer_push(tty);
377
378 tty_kref_put(tty);
379}
380
381static void acm_read_bulk_callback(struct urb *urb)
382{
383 struct acm_rb *rb = urb->context;
384 struct acm *acm = rb->instance;
385 unsigned long flags;
386
387 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
388 rb->index, urb->actual_length);
389 set_bit(rb->index, &acm->read_urbs_free);
390
391 if (!acm->dev) {
392 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
393 return;
394 }
395 usb_mark_last_busy(acm->dev);
396
397 if (urb->status) {
398 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
399 __func__, urb->status);
400 return;
401 }
402 acm_process_read_urb(acm, urb);
403
404 /* throttle device if requested by tty */
405 spin_lock_irqsave(&acm->read_lock, flags);
406 acm->throttled = acm->throttle_req;
407 if (!acm->throttled && !acm->susp_count) {
408 spin_unlock_irqrestore(&acm->read_lock, flags);
409 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
410 } else {
411 spin_unlock_irqrestore(&acm->read_lock, flags);
412 }
413}
414
415/* data interface wrote those outgoing bytes */
416static void acm_write_bulk(struct urb *urb)
417{
418 struct acm_wb *wb = urb->context;
419 struct acm *acm = wb->instance;
420 unsigned long flags;
421
422 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
423 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
424 __func__,
425 urb->actual_length,
426 urb->transfer_buffer_length,
427 urb->status);
428
429 spin_lock_irqsave(&acm->write_lock, flags);
430 acm_write_done(acm, wb);
431 spin_unlock_irqrestore(&acm->write_lock, flags);
432 if (ACM_READY(acm))
433 schedule_work(&acm->work);
434}
435
436static void acm_softint(struct work_struct *work)
437{
438 struct acm *acm = container_of(work, struct acm, work);
439 struct tty_struct *tty;
440
441 dev_vdbg(&acm->data->dev, "%s\n", __func__);
442
443 if (!ACM_READY(acm))
444 return;
445 tty = tty_port_tty_get(&acm->port);
446 if (!tty)
447 return;
448 tty_wakeup(tty);
449 tty_kref_put(tty);
450}
451
452/*
453 * TTY handlers
454 */
455
456static int acm_tty_open(struct tty_struct *tty, struct file *filp)
457{
458 struct acm *acm;
459 int rv = -ENODEV;
460
461 mutex_lock(&open_mutex);
462
463 acm = acm_table[tty->index];
464 if (!acm || !acm->dev)
465 goto out;
466 else
467 rv = 0;
468
469 dev_dbg(&acm->control->dev, "%s\n", __func__);
470
471 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
472
473 tty->driver_data = acm;
474 tty_port_tty_set(&acm->port, tty);
475
476 if (usb_autopm_get_interface(acm->control) < 0)
477 goto early_bail;
478 else
479 acm->control->needs_remote_wakeup = 1;
480
481 mutex_lock(&acm->mutex);
482 if (acm->port.count++) {
483 mutex_unlock(&acm->mutex);
484 usb_autopm_put_interface(acm->control);
485 goto out;
486 }
487
488 acm->ctrlurb->dev = acm->dev;
489 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
490 dev_err(&acm->control->dev,
491 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
492 goto bail_out;
493 }
494
495 if (0 > acm_set_control(acm, acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS) &&
496 (acm->ctrl_caps & USB_CDC_CAP_LINE))
497 goto bail_out;
498
499 usb_autopm_put_interface(acm->control);
500
501 if (acm_submit_read_urbs(acm, GFP_KERNEL))
502 goto bail_out;
503
504 set_bit(ASYNCB_INITIALIZED, &acm->port.flags);
505 rv = tty_port_block_til_ready(&acm->port, tty, filp);
506
507 mutex_unlock(&acm->mutex);
508out:
509 mutex_unlock(&open_mutex);
510 return rv;
511
512bail_out:
513 acm->port.count--;
514 mutex_unlock(&acm->mutex);
515 usb_autopm_put_interface(acm->control);
516early_bail:
517 mutex_unlock(&open_mutex);
518 tty_port_tty_set(&acm->port, NULL);
519 return -EIO;
520}
521
522static void acm_tty_unregister(struct acm *acm)
523{
524 int i;
525
526 tty_unregister_device(acm_tty_driver, acm->minor);
527 usb_put_intf(acm->control);
528 acm_table[acm->minor] = NULL;
529 usb_free_urb(acm->ctrlurb);
530 for (i = 0; i < ACM_NW; i++)
531 usb_free_urb(acm->wb[i].urb);
532 for (i = 0; i < acm->rx_buflimit; i++)
533 usb_free_urb(acm->read_urbs[i]);
534 kfree(acm->country_codes);
535 kfree(acm);
536}
537
538static void acm_port_down(struct acm *acm)
539{
540 int i;
541
542 mutex_lock(&open_mutex);
543 if (acm->dev) {
544 usb_autopm_get_interface(acm->control);
545 acm_set_control(acm, acm->ctrlout = 0);
546 usb_kill_urb(acm->ctrlurb);
547 for (i = 0; i < ACM_NW; i++)
548 usb_kill_urb(acm->wb[i].urb);
549 for (i = 0; i < acm->rx_buflimit; i++)
550 usb_kill_urb(acm->read_urbs[i]);
551 acm->control->needs_remote_wakeup = 0;
552 usb_autopm_put_interface(acm->control);
553 }
554 mutex_unlock(&open_mutex);
555}
556
557static void acm_tty_hangup(struct tty_struct *tty)
558{
559 struct acm *acm = tty->driver_data;
560 tty_port_hangup(&acm->port);
561 acm_port_down(acm);
562}
563
564static void acm_tty_close(struct tty_struct *tty, struct file *filp)
565{
566 struct acm *acm = tty->driver_data;
567
568 /* Perform the closing process and see if we need to do the hardware
569 shutdown */
570 if (!acm)
571 return;
572 if (tty_port_close_start(&acm->port, tty, filp) == 0) {
573 mutex_lock(&open_mutex);
574 if (!acm->dev) {
575 tty_port_tty_set(&acm->port, NULL);
576 acm_tty_unregister(acm);
577 tty->driver_data = NULL;
578 }
579 mutex_unlock(&open_mutex);
580 return;
581 }
582 acm_port_down(acm);
583 tty_port_close_end(&acm->port, tty);
584 tty_port_tty_set(&acm->port, NULL);
585}
586
587static int acm_tty_write(struct tty_struct *tty,
588 const unsigned char *buf, int count)
589{
590 struct acm *acm = tty->driver_data;
591 int stat;
592 unsigned long flags;
593 int wbn;
594 struct acm_wb *wb;
595
596 if (!ACM_READY(acm))
597 return -EINVAL;
598 if (!count)
599 return 0;
600
601 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
602
603 spin_lock_irqsave(&acm->write_lock, flags);
604 wbn = acm_wb_alloc(acm);
605 if (wbn < 0) {
606 spin_unlock_irqrestore(&acm->write_lock, flags);
607 return 0;
608 }
609 wb = &acm->wb[wbn];
610
611 count = (count > acm->writesize) ? acm->writesize : count;
612 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
613 memcpy(wb->buf, buf, count);
614 wb->len = count;
615 spin_unlock_irqrestore(&acm->write_lock, flags);
616
617 stat = acm_write_start(acm, wbn);
618 if (stat < 0)
619 return stat;
620 return count;
621}
622
623static int acm_tty_write_room(struct tty_struct *tty)
624{
625 struct acm *acm = tty->driver_data;
626 if (!ACM_READY(acm))
627 return -EINVAL;
628 /*
629 * Do not let the line discipline to know that we have a reserve,
630 * or it might get too enthusiastic.
631 */
632 return acm_wb_is_avail(acm) ? acm->writesize : 0;
633}
634
635static int acm_tty_chars_in_buffer(struct tty_struct *tty)
636{
637 struct acm *acm = tty->driver_data;
638 if (!ACM_READY(acm))
639 return 0;
640 /*
641 * This is inaccurate (overcounts), but it works.
642 */
643 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
644}
645
646static void acm_tty_throttle(struct tty_struct *tty)
647{
648 struct acm *acm = tty->driver_data;
649
650 if (!ACM_READY(acm))
651 return;
652
653 spin_lock_irq(&acm->read_lock);
654 acm->throttle_req = 1;
655 spin_unlock_irq(&acm->read_lock);
656}
657
658static void acm_tty_unthrottle(struct tty_struct *tty)
659{
660 struct acm *acm = tty->driver_data;
661 unsigned int was_throttled;
662
663 if (!ACM_READY(acm))
664 return;
665
666 spin_lock_irq(&acm->read_lock);
667 was_throttled = acm->throttled;
668 acm->throttled = 0;
669 acm->throttle_req = 0;
670 spin_unlock_irq(&acm->read_lock);
671
672 if (was_throttled)
673 acm_submit_read_urbs(acm, GFP_KERNEL);
674}
675
676static int acm_tty_break_ctl(struct tty_struct *tty, int state)
677{
678 struct acm *acm = tty->driver_data;
679 int retval;
680 if (!ACM_READY(acm))
681 return -EINVAL;
682 retval = acm_send_break(acm, state ? 0xffff : 0);
683 if (retval < 0)
684 dev_dbg(&acm->control->dev, "%s - send break failed\n",
685 __func__);
686 return retval;
687}
688
689static int acm_tty_tiocmget(struct tty_struct *tty)
690{
691 struct acm *acm = tty->driver_data;
692
693 if (!ACM_READY(acm))
694 return -EINVAL;
695
696 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
697 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
698 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
699 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
700 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
701 TIOCM_CTS;
702}
703
704static int acm_tty_tiocmset(struct tty_struct *tty,
705 unsigned int set, unsigned int clear)
706{
707 struct acm *acm = tty->driver_data;
708 unsigned int newctrl;
709
710 if (!ACM_READY(acm))
711 return -EINVAL;
712
713 newctrl = acm->ctrlout;
714 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
715 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
716 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
717 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
718
719 newctrl = (newctrl & ~clear) | set;
720
721 if (acm->ctrlout == newctrl)
722 return 0;
723 return acm_set_control(acm, acm->ctrlout = newctrl);
724}
725
726static int acm_tty_ioctl(struct tty_struct *tty,
727 unsigned int cmd, unsigned long arg)
728{
729 struct acm *acm = tty->driver_data;
730
731 if (!ACM_READY(acm))
732 return -EINVAL;
733
734 return -ENOIOCTLCMD;
735}
736
737static const __u32 acm_tty_speed[] = {
738 0, 50, 75, 110, 134, 150, 200, 300, 600,
739 1200, 1800, 2400, 4800, 9600, 19200, 38400,
740 57600, 115200, 230400, 460800, 500000, 576000,
741 921600, 1000000, 1152000, 1500000, 2000000,
742 2500000, 3000000, 3500000, 4000000
743};
744
745static const __u8 acm_tty_size[] = {
746 5, 6, 7, 8
747};
748
749static void acm_tty_set_termios(struct tty_struct *tty,
750 struct ktermios *termios_old)
751{
752 struct acm *acm = tty->driver_data;
753 struct ktermios *termios = tty->termios;
754 struct usb_cdc_line_coding newline;
755 int newctrl = acm->ctrlout;
756
757 if (!ACM_READY(acm))
758 return;
759
760 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
761 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
762 newline.bParityType = termios->c_cflag & PARENB ?
763 (termios->c_cflag & PARODD ? 1 : 2) +
764 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
765 newline.bDataBits = acm_tty_size[(termios->c_cflag & CSIZE) >> 4];
766 /* FIXME: Needs to clear unsupported bits in the termios */
767 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
768
769 if (!newline.dwDTERate) {
770 newline.dwDTERate = acm->line.dwDTERate;
771 newctrl &= ~ACM_CTRL_DTR;
772 } else
773 newctrl |= ACM_CTRL_DTR;
774
775 if (newctrl != acm->ctrlout)
776 acm_set_control(acm, acm->ctrlout = newctrl);
777
778 if (memcmp(&acm->line, &newline, sizeof newline)) {
779 memcpy(&acm->line, &newline, sizeof newline);
780 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
781 __func__,
782 le32_to_cpu(newline.dwDTERate),
783 newline.bCharFormat, newline.bParityType,
784 newline.bDataBits);
785 acm_set_line(acm, &acm->line);
786 }
787}
788
789/*
790 * USB probe and disconnect routines.
791 */
792
793/* Little helpers: write/read buffers free */
794static void acm_write_buffers_free(struct acm *acm)
795{
796 int i;
797 struct acm_wb *wb;
798 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
799
800 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
801 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
802}
803
804static void acm_read_buffers_free(struct acm *acm)
805{
806 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
807 int i;
808
809 for (i = 0; i < acm->rx_buflimit; i++)
810 usb_free_coherent(usb_dev, acm->readsize,
811 acm->read_buffers[i].base, acm->read_buffers[i].dma);
812}
813
814/* Little helper: write buffers allocate */
815static int acm_write_buffers_alloc(struct acm *acm)
816{
817 int i;
818 struct acm_wb *wb;
819
820 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
821 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
822 &wb->dmah);
823 if (!wb->buf) {
824 while (i != 0) {
825 --i;
826 --wb;
827 usb_free_coherent(acm->dev, acm->writesize,
828 wb->buf, wb->dmah);
829 }
830 return -ENOMEM;
831 }
832 }
833 return 0;
834}
835
836static int acm_probe(struct usb_interface *intf,
837 const struct usb_device_id *id)
838{
839 struct usb_cdc_union_desc *union_header = NULL;
840 struct usb_cdc_country_functional_desc *cfd = NULL;
841 unsigned char *buffer = intf->altsetting->extra;
842 int buflen = intf->altsetting->extralen;
843 struct usb_interface *control_interface;
844 struct usb_interface *data_interface;
845 struct usb_endpoint_descriptor *epctrl = NULL;
846 struct usb_endpoint_descriptor *epread = NULL;
847 struct usb_endpoint_descriptor *epwrite = NULL;
848 struct usb_device *usb_dev = interface_to_usbdev(intf);
849 struct acm *acm;
850 int minor;
851 int ctrlsize, readsize;
852 u8 *buf;
853 u8 ac_management_function = 0;
854 u8 call_management_function = 0;
855 int call_interface_num = -1;
856 int data_interface_num = -1;
857 unsigned long quirks;
858 int num_rx_buf;
859 int i;
860 int combined_interfaces = 0;
861
862 /* normal quirks */
863 quirks = (unsigned long)id->driver_info;
864 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
865
866 /* handle quirks deadly to normal probing*/
867 if (quirks == NO_UNION_NORMAL) {
868 data_interface = usb_ifnum_to_if(usb_dev, 1);
869 control_interface = usb_ifnum_to_if(usb_dev, 0);
870 goto skip_normal_probe;
871 }
872
873 /* normal probing*/
874 if (!buffer) {
875 dev_err(&intf->dev, "Weird descriptor references\n");
876 return -EINVAL;
877 }
878
879 if (!buflen) {
880 if (intf->cur_altsetting->endpoint &&
881 intf->cur_altsetting->endpoint->extralen &&
882 intf->cur_altsetting->endpoint->extra) {
883 dev_dbg(&intf->dev,
884 "Seeking extra descriptors on endpoint\n");
885 buflen = intf->cur_altsetting->endpoint->extralen;
886 buffer = intf->cur_altsetting->endpoint->extra;
887 } else {
888 dev_err(&intf->dev,
889 "Zero length descriptor references\n");
890 return -EINVAL;
891 }
892 }
893
894 while (buflen > 0) {
895 if (buffer[1] != USB_DT_CS_INTERFACE) {
896 dev_err(&intf->dev, "skipping garbage\n");
897 goto next_desc;
898 }
899
900 switch (buffer[2]) {
901 case USB_CDC_UNION_TYPE: /* we've found it */
902 if (union_header) {
903 dev_err(&intf->dev, "More than one "
904 "union descriptor, skipping ...\n");
905 goto next_desc;
906 }
907 union_header = (struct usb_cdc_union_desc *)buffer;
908 break;
909 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
910 cfd = (struct usb_cdc_country_functional_desc *)buffer;
911 break;
912 case USB_CDC_HEADER_TYPE: /* maybe check version */
913 break; /* for now we ignore it */
914 case USB_CDC_ACM_TYPE:
915 ac_management_function = buffer[3];
916 break;
917 case USB_CDC_CALL_MANAGEMENT_TYPE:
918 call_management_function = buffer[3];
919 call_interface_num = buffer[4];
920 if ( (quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
921 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
922 break;
923 default:
924 /* there are LOTS more CDC descriptors that
925 * could legitimately be found here.
926 */
927 dev_dbg(&intf->dev, "Ignoring descriptor: "
928 "type %02x, length %d\n",
929 buffer[2], buffer[0]);
930 break;
931 }
932next_desc:
933 buflen -= buffer[0];
934 buffer += buffer[0];
935 }
936
937 if (!union_header) {
938 if (call_interface_num > 0) {
939 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
940 /* quirks for Droids MuIn LCD */
941 if (quirks & NO_DATA_INTERFACE)
942 data_interface = usb_ifnum_to_if(usb_dev, 0);
943 else
944 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
945 control_interface = intf;
946 } else {
947 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
948 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
949 return -ENODEV;
950 } else {
951 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
952 combined_interfaces = 1;
953 control_interface = data_interface = intf;
954 goto look_for_collapsed_interface;
955 }
956 }
957 } else {
958 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
959 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
960 if (!control_interface || !data_interface) {
961 dev_dbg(&intf->dev, "no interfaces\n");
962 return -ENODEV;
963 }
964 }
965
966 if (data_interface_num != call_interface_num)
967 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
968
969 if (control_interface == data_interface) {
970 /* some broken devices designed for windows work this way */
971 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
972 combined_interfaces = 1;
973 /* a popular other OS doesn't use it */
974 quirks |= NO_CAP_LINE;
975 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
976 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
977 return -EINVAL;
978 }
979look_for_collapsed_interface:
980 for (i = 0; i < 3; i++) {
981 struct usb_endpoint_descriptor *ep;
982 ep = &data_interface->cur_altsetting->endpoint[i].desc;
983
984 if (usb_endpoint_is_int_in(ep))
985 epctrl = ep;
986 else if (usb_endpoint_is_bulk_out(ep))
987 epwrite = ep;
988 else if (usb_endpoint_is_bulk_in(ep))
989 epread = ep;
990 else
991 return -EINVAL;
992 }
993 if (!epctrl || !epread || !epwrite)
994 return -ENODEV;
995 else
996 goto made_compressed_probe;
997 }
998
999skip_normal_probe:
1000
1001 /*workaround for switched interfaces */
1002 if (data_interface->cur_altsetting->desc.bInterfaceClass
1003 != CDC_DATA_INTERFACE_TYPE) {
1004 if (control_interface->cur_altsetting->desc.bInterfaceClass
1005 == CDC_DATA_INTERFACE_TYPE) {
1006 struct usb_interface *t;
1007 dev_dbg(&intf->dev,
1008 "Your device has switched interfaces.\n");
1009 t = control_interface;
1010 control_interface = data_interface;
1011 data_interface = t;
1012 } else {
1013 return -EINVAL;
1014 }
1015 }
1016
1017 /* Accept probe requests only for the control interface */
1018 if (!combined_interfaces && intf != control_interface)
1019 return -ENODEV;
1020
1021 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1022 /* valid in this context */
1023 dev_dbg(&intf->dev, "The data interface isn't available\n");
1024 return -EBUSY;
1025 }
1026
1027
1028 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2)
1029 return -EINVAL;
1030
1031 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1032 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1033 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1034
1035
1036 /* workaround for switched endpoints */
1037 if (!usb_endpoint_dir_in(epread)) {
1038 /* descriptors are swapped */
1039 struct usb_endpoint_descriptor *t;
1040 dev_dbg(&intf->dev,
1041 "The data interface has switched endpoints\n");
1042 t = epread;
1043 epread = epwrite;
1044 epwrite = t;
1045 }
1046made_compressed_probe:
1047 dev_dbg(&intf->dev, "interfaces are valid\n");
1048 for (minor = 0; minor < ACM_TTY_MINORS && acm_table[minor]; minor++);
1049
1050 if (minor == ACM_TTY_MINORS) {
1051 dev_err(&intf->dev, "no more free acm devices\n");
1052 return -ENODEV;
1053 }
1054
1055 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1056 if (acm == NULL) {
1057 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1058 goto alloc_fail;
1059 }
1060
1061 ctrlsize = le16_to_cpu(epctrl->wMaxPacketSize);
1062 readsize = le16_to_cpu(epread->wMaxPacketSize) *
1063 (quirks == SINGLE_RX_URB ? 1 : 2);
1064 acm->combined_interfaces = combined_interfaces;
1065 acm->writesize = le16_to_cpu(epwrite->wMaxPacketSize) * 20;
1066 acm->control = control_interface;
1067 acm->data = data_interface;
1068 acm->minor = minor;
1069 acm->dev = usb_dev;
1070 acm->ctrl_caps = ac_management_function;
1071 if (quirks & NO_CAP_LINE)
1072 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1073 acm->ctrlsize = ctrlsize;
1074 acm->readsize = readsize;
1075 acm->rx_buflimit = num_rx_buf;
1076 INIT_WORK(&acm->work, acm_softint);
1077 spin_lock_init(&acm->write_lock);
1078 spin_lock_init(&acm->read_lock);
1079 mutex_init(&acm->mutex);
1080 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1081 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1082 if (acm->is_int_ep)
1083 acm->bInterval = epread->bInterval;
1084 tty_port_init(&acm->port);
1085 acm->port.ops = &acm_port_ops;
1086
1087 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1088 if (!buf) {
1089 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1090 goto alloc_fail2;
1091 }
1092 acm->ctrl_buffer = buf;
1093
1094 if (acm_write_buffers_alloc(acm) < 0) {
1095 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1096 goto alloc_fail4;
1097 }
1098
1099 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1100 if (!acm->ctrlurb) {
1101 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1102 goto alloc_fail5;
1103 }
1104 for (i = 0; i < num_rx_buf; i++) {
1105 struct acm_rb *rb = &(acm->read_buffers[i]);
1106 struct urb *urb;
1107
1108 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1109 &rb->dma);
1110 if (!rb->base) {
1111 dev_err(&intf->dev, "out of memory "
1112 "(read bufs usb_alloc_coherent)\n");
1113 goto alloc_fail6;
1114 }
1115 rb->index = i;
1116 rb->instance = acm;
1117
1118 urb = usb_alloc_urb(0, GFP_KERNEL);
1119 if (!urb) {
1120 dev_err(&intf->dev,
1121 "out of memory (read urbs usb_alloc_urb)\n");
1122 goto alloc_fail6;
1123 }
1124 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1125 urb->transfer_dma = rb->dma;
1126 if (acm->is_int_ep) {
1127 usb_fill_int_urb(urb, acm->dev,
1128 acm->rx_endpoint,
1129 rb->base,
1130 acm->readsize,
1131 acm_read_bulk_callback, rb,
1132 acm->bInterval);
1133 } else {
1134 usb_fill_bulk_urb(urb, acm->dev,
1135 acm->rx_endpoint,
1136 rb->base,
1137 acm->readsize,
1138 acm_read_bulk_callback, rb);
1139 }
1140
1141 acm->read_urbs[i] = urb;
1142 __set_bit(i, &acm->read_urbs_free);
1143 }
1144 for (i = 0; i < ACM_NW; i++) {
1145 struct acm_wb *snd = &(acm->wb[i]);
1146
1147 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1148 if (snd->urb == NULL) {
1149 dev_err(&intf->dev,
1150 "out of memory (write urbs usb_alloc_urb)\n");
1151 goto alloc_fail7;
1152 }
1153
1154 if (usb_endpoint_xfer_int(epwrite))
1155 usb_fill_int_urb(snd->urb, usb_dev,
1156 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1157 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1158 else
1159 usb_fill_bulk_urb(snd->urb, usb_dev,
1160 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1161 NULL, acm->writesize, acm_write_bulk, snd);
1162 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1163 snd->instance = acm;
1164 }
1165
1166 usb_set_intfdata(intf, acm);
1167
1168 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1169 if (i < 0)
1170 goto alloc_fail7;
1171
1172 if (cfd) { /* export the country data */
1173 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1174 if (!acm->country_codes)
1175 goto skip_countries;
1176 acm->country_code_size = cfd->bLength - 4;
1177 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1178 cfd->bLength - 4);
1179 acm->country_rel_date = cfd->iCountryCodeRelDate;
1180
1181 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1182 if (i < 0) {
1183 kfree(acm->country_codes);
1184 goto skip_countries;
1185 }
1186
1187 i = device_create_file(&intf->dev,
1188 &dev_attr_iCountryCodeRelDate);
1189 if (i < 0) {
1190 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1191 kfree(acm->country_codes);
1192 goto skip_countries;
1193 }
1194 }
1195
1196skip_countries:
1197 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1198 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1199 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1200 /* works around buggy devices */
1201 epctrl->bInterval ? epctrl->bInterval : 0xff);
1202 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1203 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1204
1205 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1206
1207 acm_set_control(acm, acm->ctrlout);
1208
1209 acm->line.dwDTERate = cpu_to_le32(9600);
1210 acm->line.bDataBits = 8;
1211 acm_set_line(acm, &acm->line);
1212
1213 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1214 usb_set_intfdata(data_interface, acm);
1215
1216 usb_get_intf(control_interface);
1217 tty_register_device(acm_tty_driver, minor, &control_interface->dev);
1218
1219 acm_table[minor] = acm;
1220
1221 return 0;
1222alloc_fail7:
1223 for (i = 0; i < ACM_NW; i++)
1224 usb_free_urb(acm->wb[i].urb);
1225alloc_fail6:
1226 for (i = 0; i < num_rx_buf; i++)
1227 usb_free_urb(acm->read_urbs[i]);
1228 acm_read_buffers_free(acm);
1229 usb_free_urb(acm->ctrlurb);
1230alloc_fail5:
1231 acm_write_buffers_free(acm);
1232alloc_fail4:
1233 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1234alloc_fail2:
1235 kfree(acm);
1236alloc_fail:
1237 return -ENOMEM;
1238}
1239
1240static void stop_data_traffic(struct acm *acm)
1241{
1242 int i;
1243
1244 dev_dbg(&acm->control->dev, "%s\n", __func__);
1245
1246 usb_kill_urb(acm->ctrlurb);
1247 for (i = 0; i < ACM_NW; i++)
1248 usb_kill_urb(acm->wb[i].urb);
1249 for (i = 0; i < acm->rx_buflimit; i++)
1250 usb_kill_urb(acm->read_urbs[i]);
1251
1252 cancel_work_sync(&acm->work);
1253}
1254
1255static void acm_disconnect(struct usb_interface *intf)
1256{
1257 struct acm *acm = usb_get_intfdata(intf);
1258 struct usb_device *usb_dev = interface_to_usbdev(intf);
1259 struct tty_struct *tty;
1260
1261 /* sibling interface is already cleaning up */
1262 if (!acm)
1263 return;
1264
1265 mutex_lock(&open_mutex);
1266 if (acm->country_codes) {
1267 device_remove_file(&acm->control->dev,
1268 &dev_attr_wCountryCodes);
1269 device_remove_file(&acm->control->dev,
1270 &dev_attr_iCountryCodeRelDate);
1271 }
1272 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1273 acm->dev = NULL;
1274 usb_set_intfdata(acm->control, NULL);
1275 usb_set_intfdata(acm->data, NULL);
1276
1277 stop_data_traffic(acm);
1278
1279 acm_write_buffers_free(acm);
1280 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer,
1281 acm->ctrl_dma);
1282 acm_read_buffers_free(acm);
1283
1284 if (!acm->combined_interfaces)
1285 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1286 acm->data : acm->control);
1287
1288 if (acm->port.count == 0) {
1289 acm_tty_unregister(acm);
1290 mutex_unlock(&open_mutex);
1291 return;
1292 }
1293
1294 mutex_unlock(&open_mutex);
1295 tty = tty_port_tty_get(&acm->port);
1296 if (tty) {
1297 tty_hangup(tty);
1298 tty_kref_put(tty);
1299 }
1300}
1301
1302#ifdef CONFIG_PM
1303static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1304{
1305 struct acm *acm = usb_get_intfdata(intf);
1306 int cnt;
1307
1308 if (message.event & PM_EVENT_AUTO) {
1309 int b;
1310
1311 spin_lock_irq(&acm->write_lock);
1312 b = acm->transmitting;
1313 spin_unlock_irq(&acm->write_lock);
1314 if (b)
1315 return -EBUSY;
1316 }
1317
1318 spin_lock_irq(&acm->read_lock);
1319 spin_lock(&acm->write_lock);
1320 cnt = acm->susp_count++;
1321 spin_unlock(&acm->write_lock);
1322 spin_unlock_irq(&acm->read_lock);
1323
1324 if (cnt)
1325 return 0;
1326 /*
1327 we treat opened interfaces differently,
1328 we must guard against open
1329 */
1330 mutex_lock(&acm->mutex);
1331
1332 if (acm->port.count)
1333 stop_data_traffic(acm);
1334
1335 mutex_unlock(&acm->mutex);
1336 return 0;
1337}
1338
1339static int acm_resume(struct usb_interface *intf)
1340{
1341 struct acm *acm = usb_get_intfdata(intf);
1342 struct acm_wb *wb;
1343 int rv = 0;
1344 int cnt;
1345
1346 spin_lock_irq(&acm->read_lock);
1347 acm->susp_count -= 1;
1348 cnt = acm->susp_count;
1349 spin_unlock_irq(&acm->read_lock);
1350
1351 if (cnt)
1352 return 0;
1353
1354 mutex_lock(&acm->mutex);
1355 if (acm->port.count) {
1356 rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
1357
1358 spin_lock_irq(&acm->write_lock);
1359 if (acm->delayed_wb) {
1360 wb = acm->delayed_wb;
1361 acm->delayed_wb = NULL;
1362 spin_unlock_irq(&acm->write_lock);
1363 acm_start_wb(acm, wb);
1364 } else {
1365 spin_unlock_irq(&acm->write_lock);
1366 }
1367
1368 /*
1369 * delayed error checking because we must
1370 * do the write path at all cost
1371 */
1372 if (rv < 0)
1373 goto err_out;
1374
1375 rv = acm_submit_read_urbs(acm, GFP_NOIO);
1376 }
1377
1378err_out:
1379 mutex_unlock(&acm->mutex);
1380 return rv;
1381}
1382
1383static int acm_reset_resume(struct usb_interface *intf)
1384{
1385 struct acm *acm = usb_get_intfdata(intf);
1386 struct tty_struct *tty;
1387
1388 mutex_lock(&acm->mutex);
1389 if (acm->port.count) {
1390 tty = tty_port_tty_get(&acm->port);
1391 if (tty) {
1392 tty_hangup(tty);
1393 tty_kref_put(tty);
1394 }
1395 }
1396 mutex_unlock(&acm->mutex);
1397 return acm_resume(intf);
1398}
1399
1400#endif /* CONFIG_PM */
1401
1402#define NOKIA_PCSUITE_ACM_INFO(x) \
1403 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1404 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1405 USB_CDC_ACM_PROTO_VENDOR)
1406
1407#define SAMSUNG_PCSUITE_ACM_INFO(x) \
1408 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1409 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1410 USB_CDC_ACM_PROTO_VENDOR)
1411
1412/*
1413 * USB driver structure.
1414 */
1415
1416static const struct usb_device_id acm_ids[] = {
1417 /* quirky and broken devices */
1418 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1419 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1420 },
1421 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1422 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1423 },
1424 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1425 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1426 },
1427 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1428 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1429 },
1430 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1431 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1432 },
1433 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1434 .driver_info = SINGLE_RX_URB,
1435 },
1436 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1437 .driver_info = SINGLE_RX_URB, /* firmware bug */
1438 },
1439 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1440 .driver_info = SINGLE_RX_URB, /* firmware bug */
1441 },
1442 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1443 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1444 },
1445 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1446 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1447 },
1448 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1449 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1450 },
1451 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1452 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1453 },
1454 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1455 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1456 },
1457 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1458 },
1459 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1460 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1461 data interface instead of
1462 communications interface.
1463 Maybe we should define a new
1464 quirk for this. */
1465 },
1466 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1467 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1468 },
1469 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1470 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1471 },
1472
1473 /* Nokia S60 phones expose two ACM channels. The first is
1474 * a modem and is picked up by the standard AT-command
1475 * information below. The second is 'vendor-specific' but
1476 * is treated as a serial device at the S60 end, so we want
1477 * to expose it on Linux too. */
1478 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1479 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1480 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1481 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1482 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1483 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1484 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1485 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1486 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1487 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1488 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1489 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1490 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1491 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1492 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1493 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1494 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1495 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1496 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1497 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1498 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1499 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1500 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1501 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1502 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1503 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1504 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1505 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1506 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1507 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1508 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1509 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1510 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1511 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1512 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1513 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1514 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1515 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1516 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1517 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1518 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1519 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1520 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1521 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1522 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1523 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1524 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1525 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1526 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1527 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1528 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1529 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1530 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1531 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1532 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1533 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1534 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1535 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1536
1537 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1538
1539 /* Support Lego NXT using pbLua firmware */
1540 { USB_DEVICE(0x0694, 0xff00),
1541 .driver_info = NOT_A_MODEM,
1542 },
1543
1544 /* Support for Droids MuIn LCD */
1545 { USB_DEVICE(0x04d8, 0x000b),
1546 .driver_info = NO_DATA_INTERFACE,
1547 },
1548
1549 /* control interfaces without any protocol set */
1550 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1551 USB_CDC_PROTO_NONE) },
1552
1553 /* control interfaces with various AT-command sets */
1554 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1555 USB_CDC_ACM_PROTO_AT_V25TER) },
1556 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1557 USB_CDC_ACM_PROTO_AT_PCCA101) },
1558 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1559 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1560 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1561 USB_CDC_ACM_PROTO_AT_GSM) },
1562 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1563 USB_CDC_ACM_PROTO_AT_3G) },
1564 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1565 USB_CDC_ACM_PROTO_AT_CDMA) },
1566
1567 { }
1568};
1569
1570MODULE_DEVICE_TABLE(usb, acm_ids);
1571
1572static struct usb_driver acm_driver = {
1573 .name = "cdc_acm",
1574 .probe = acm_probe,
1575 .disconnect = acm_disconnect,
1576#ifdef CONFIG_PM
1577 .suspend = acm_suspend,
1578 .resume = acm_resume,
1579 .reset_resume = acm_reset_resume,
1580#endif
1581 .id_table = acm_ids,
1582#ifdef CONFIG_PM
1583 .supports_autosuspend = 1,
1584#endif
1585};
1586
1587/*
1588 * TTY driver structures.
1589 */
1590
1591static const struct tty_operations acm_ops = {
1592 .open = acm_tty_open,
1593 .close = acm_tty_close,
1594 .hangup = acm_tty_hangup,
1595 .write = acm_tty_write,
1596 .write_room = acm_tty_write_room,
1597 .ioctl = acm_tty_ioctl,
1598 .throttle = acm_tty_throttle,
1599 .unthrottle = acm_tty_unthrottle,
1600 .chars_in_buffer = acm_tty_chars_in_buffer,
1601 .break_ctl = acm_tty_break_ctl,
1602 .set_termios = acm_tty_set_termios,
1603 .tiocmget = acm_tty_tiocmget,
1604 .tiocmset = acm_tty_tiocmset,
1605};
1606
1607/*
1608 * Init / exit.
1609 */
1610
1611static int __init acm_init(void)
1612{
1613 int retval;
1614 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1615 if (!acm_tty_driver)
1616 return -ENOMEM;
1617 acm_tty_driver->owner = THIS_MODULE,
1618 acm_tty_driver->driver_name = "acm",
1619 acm_tty_driver->name = "ttyACM",
1620 acm_tty_driver->major = ACM_TTY_MAJOR,
1621 acm_tty_driver->minor_start = 0,
1622 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1623 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1624 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1625 acm_tty_driver->init_termios = tty_std_termios;
1626 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1627 HUPCL | CLOCAL;
1628 tty_set_operations(acm_tty_driver, &acm_ops);
1629
1630 retval = tty_register_driver(acm_tty_driver);
1631 if (retval) {
1632 put_tty_driver(acm_tty_driver);
1633 return retval;
1634 }
1635
1636 retval = usb_register(&acm_driver);
1637 if (retval) {
1638 tty_unregister_driver(acm_tty_driver);
1639 put_tty_driver(acm_tty_driver);
1640 return retval;
1641 }
1642
1643 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1644
1645 return 0;
1646}
1647
1648static void __exit acm_exit(void)
1649{
1650 usb_deregister(&acm_driver);
1651 tty_unregister_driver(acm_tty_driver);
1652 put_tty_driver(acm_tty_driver);
1653}
1654
1655module_init(acm_init);
1656module_exit(acm_exit);
1657
1658MODULE_AUTHOR(DRIVER_AUTHOR);
1659MODULE_DESCRIPTION(DRIVER_DESC);
1660MODULE_LICENSE("GPL");
1661MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * cdc-acm.c
4 *
5 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
6 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
7 * 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>
10 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
11 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 *
13 * USB Abstract Control Model driver for USB modems and ISDN adapters
14 *
15 * Sponsored by SuSE
16 */
17
18#undef DEBUG
19#undef VERBOSE_DEBUG
20
21#include <linux/kernel.h>
22#include <linux/sched/signal.h>
23#include <linux/errno.h>
24#include <linux/init.h>
25#include <linux/slab.h>
26#include <linux/log2.h>
27#include <linux/tty.h>
28#include <linux/serial.h>
29#include <linux/tty_driver.h>
30#include <linux/tty_flip.h>
31#include <linux/module.h>
32#include <linux/mutex.h>
33#include <linux/uaccess.h>
34#include <linux/usb.h>
35#include <linux/usb/cdc.h>
36#include <asm/byteorder.h>
37#include <asm/unaligned.h>
38#include <linux/idr.h>
39#include <linux/list.h>
40
41#include "cdc-acm.h"
42
43
44#define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
45#define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
46
47static struct usb_driver acm_driver;
48static struct tty_driver *acm_tty_driver;
49
50static DEFINE_IDR(acm_minors);
51static DEFINE_MUTEX(acm_minors_lock);
52
53static void acm_tty_set_termios(struct tty_struct *tty,
54 struct ktermios *termios_old);
55
56/*
57 * acm_minors accessors
58 */
59
60/*
61 * Look up an ACM structure by minor. If found and not disconnected, increment
62 * its refcount and return it with its mutex held.
63 */
64static struct acm *acm_get_by_minor(unsigned int minor)
65{
66 struct acm *acm;
67
68 mutex_lock(&acm_minors_lock);
69 acm = idr_find(&acm_minors, minor);
70 if (acm) {
71 mutex_lock(&acm->mutex);
72 if (acm->disconnected) {
73 mutex_unlock(&acm->mutex);
74 acm = NULL;
75 } else {
76 tty_port_get(&acm->port);
77 mutex_unlock(&acm->mutex);
78 }
79 }
80 mutex_unlock(&acm_minors_lock);
81 return acm;
82}
83
84/*
85 * Try to find an available minor number and if found, associate it with 'acm'.
86 */
87static int acm_alloc_minor(struct acm *acm)
88{
89 int minor;
90
91 mutex_lock(&acm_minors_lock);
92 minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
93 mutex_unlock(&acm_minors_lock);
94
95 return minor;
96}
97
98/* Release the minor number associated with 'acm'. */
99static void acm_release_minor(struct acm *acm)
100{
101 mutex_lock(&acm_minors_lock);
102 idr_remove(&acm_minors, acm->minor);
103 mutex_unlock(&acm_minors_lock);
104}
105
106/*
107 * Functions for ACM control messages.
108 */
109
110static int acm_ctrl_msg(struct acm *acm, int request, int value,
111 void *buf, int len)
112{
113 int retval;
114
115 retval = usb_autopm_get_interface(acm->control);
116 if (retval)
117 return retval;
118
119 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
120 request, USB_RT_ACM, value,
121 acm->control->altsetting[0].desc.bInterfaceNumber,
122 buf, len, 5000);
123
124 dev_dbg(&acm->control->dev,
125 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126 __func__, request, value, len, retval);
127
128 usb_autopm_put_interface(acm->control);
129
130 return retval < 0 ? retval : 0;
131}
132
133/* devices aren't required to support these requests.
134 * the cdc acm descriptor tells whether they do...
135 */
136static inline int acm_set_control(struct acm *acm, int control)
137{
138 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
139 return -EOPNOTSUPP;
140
141 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
142 control, NULL, 0);
143}
144
145#define acm_set_line(acm, line) \
146 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
147#define acm_send_break(acm, ms) \
148 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
149
150static void acm_kill_urbs(struct acm *acm)
151{
152 int i;
153
154 usb_kill_urb(acm->ctrlurb);
155 for (i = 0; i < ACM_NW; i++)
156 usb_kill_urb(acm->wb[i].urb);
157 for (i = 0; i < acm->rx_buflimit; i++)
158 usb_kill_urb(acm->read_urbs[i]);
159}
160
161/*
162 * Write buffer management.
163 * All of these assume proper locks taken by the caller.
164 */
165
166static int acm_wb_alloc(struct acm *acm)
167{
168 int i, wbn;
169 struct acm_wb *wb;
170
171 wbn = 0;
172 i = 0;
173 for (;;) {
174 wb = &acm->wb[wbn];
175 if (!wb->use) {
176 wb->use = 1;
177 wb->len = 0;
178 return wbn;
179 }
180 wbn = (wbn + 1) % ACM_NW;
181 if (++i >= ACM_NW)
182 return -1;
183 }
184}
185
186static int acm_wb_is_avail(struct acm *acm)
187{
188 int i, n;
189 unsigned long flags;
190
191 n = ACM_NW;
192 spin_lock_irqsave(&acm->write_lock, flags);
193 for (i = 0; i < ACM_NW; i++)
194 n -= acm->wb[i].use;
195 spin_unlock_irqrestore(&acm->write_lock, flags);
196 return n;
197}
198
199/*
200 * Finish write. Caller must hold acm->write_lock
201 */
202static void acm_write_done(struct acm *acm, struct acm_wb *wb)
203{
204 wb->use = 0;
205 acm->transmitting--;
206 usb_autopm_put_interface_async(acm->control);
207}
208
209/*
210 * Poke write.
211 *
212 * the caller is responsible for locking
213 */
214
215static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
216{
217 int rc;
218
219 acm->transmitting++;
220
221 wb->urb->transfer_buffer = wb->buf;
222 wb->urb->transfer_dma = wb->dmah;
223 wb->urb->transfer_buffer_length = wb->len;
224 wb->urb->dev = acm->dev;
225
226 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
227 if (rc < 0) {
228 dev_err(&acm->data->dev,
229 "%s - usb_submit_urb(write bulk) failed: %d\n",
230 __func__, rc);
231 acm_write_done(acm, wb);
232 }
233 return rc;
234}
235
236/*
237 * attributes exported through sysfs
238 */
239static ssize_t bmCapabilities_show
240(struct device *dev, struct device_attribute *attr, char *buf)
241{
242 struct usb_interface *intf = to_usb_interface(dev);
243 struct acm *acm = usb_get_intfdata(intf);
244
245 return sprintf(buf, "%d", acm->ctrl_caps);
246}
247static DEVICE_ATTR_RO(bmCapabilities);
248
249static ssize_t wCountryCodes_show
250(struct device *dev, struct device_attribute *attr, char *buf)
251{
252 struct usb_interface *intf = to_usb_interface(dev);
253 struct acm *acm = usb_get_intfdata(intf);
254
255 memcpy(buf, acm->country_codes, acm->country_code_size);
256 return acm->country_code_size;
257}
258
259static DEVICE_ATTR_RO(wCountryCodes);
260
261static ssize_t iCountryCodeRelDate_show
262(struct device *dev, struct device_attribute *attr, char *buf)
263{
264 struct usb_interface *intf = to_usb_interface(dev);
265 struct acm *acm = usb_get_intfdata(intf);
266
267 return sprintf(buf, "%d", acm->country_rel_date);
268}
269
270static DEVICE_ATTR_RO(iCountryCodeRelDate);
271/*
272 * Interrupt handlers for various ACM device responses
273 */
274
275static void acm_process_notification(struct acm *acm, unsigned char *buf)
276{
277 int newctrl;
278 int difference;
279 struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
280 unsigned char *data = buf + sizeof(struct usb_cdc_notification);
281
282 switch (dr->bNotificationType) {
283 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
284 dev_dbg(&acm->control->dev,
285 "%s - network connection: %d\n", __func__, dr->wValue);
286 break;
287
288 case USB_CDC_NOTIFY_SERIAL_STATE:
289 if (le16_to_cpu(dr->wLength) != 2) {
290 dev_dbg(&acm->control->dev,
291 "%s - malformed serial state\n", __func__);
292 break;
293 }
294
295 newctrl = get_unaligned_le16(data);
296 dev_dbg(&acm->control->dev,
297 "%s - serial state: 0x%x\n", __func__, newctrl);
298
299 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
300 dev_dbg(&acm->control->dev,
301 "%s - calling hangup\n", __func__);
302 tty_port_tty_hangup(&acm->port, false);
303 }
304
305 difference = acm->ctrlin ^ newctrl;
306 spin_lock(&acm->read_lock);
307 acm->ctrlin = newctrl;
308 acm->oldcount = acm->iocount;
309
310 if (difference & ACM_CTRL_DSR)
311 acm->iocount.dsr++;
312 if (difference & ACM_CTRL_BRK)
313 acm->iocount.brk++;
314 if (difference & ACM_CTRL_RI)
315 acm->iocount.rng++;
316 if (difference & ACM_CTRL_DCD)
317 acm->iocount.dcd++;
318 if (difference & ACM_CTRL_FRAMING)
319 acm->iocount.frame++;
320 if (difference & ACM_CTRL_PARITY)
321 acm->iocount.parity++;
322 if (difference & ACM_CTRL_OVERRUN)
323 acm->iocount.overrun++;
324 spin_unlock(&acm->read_lock);
325
326 if (difference)
327 wake_up_all(&acm->wioctl);
328
329 break;
330
331 default:
332 dev_dbg(&acm->control->dev,
333 "%s - unknown notification %d received: index %d len %d\n",
334 __func__,
335 dr->bNotificationType, dr->wIndex, dr->wLength);
336 }
337}
338
339/* control interface reports status changes with "interrupt" transfers */
340static void acm_ctrl_irq(struct urb *urb)
341{
342 struct acm *acm = urb->context;
343 struct usb_cdc_notification *dr = urb->transfer_buffer;
344 unsigned int current_size = urb->actual_length;
345 unsigned int expected_size, copy_size, alloc_size;
346 int retval;
347 int status = urb->status;
348
349 switch (status) {
350 case 0:
351 /* success */
352 break;
353 case -ECONNRESET:
354 case -ENOENT:
355 case -ESHUTDOWN:
356 /* this urb is terminated, clean up */
357 acm->nb_index = 0;
358 dev_dbg(&acm->control->dev,
359 "%s - urb shutting down with status: %d\n",
360 __func__, status);
361 return;
362 default:
363 dev_dbg(&acm->control->dev,
364 "%s - nonzero urb status received: %d\n",
365 __func__, status);
366 goto exit;
367 }
368
369 usb_mark_last_busy(acm->dev);
370
371 if (acm->nb_index)
372 dr = (struct usb_cdc_notification *)acm->notification_buffer;
373
374 /* size = notification-header + (optional) data */
375 expected_size = sizeof(struct usb_cdc_notification) +
376 le16_to_cpu(dr->wLength);
377
378 if (current_size < expected_size) {
379 /* notification is transmitted fragmented, reassemble */
380 if (acm->nb_size < expected_size) {
381 if (acm->nb_size) {
382 kfree(acm->notification_buffer);
383 acm->nb_size = 0;
384 }
385 alloc_size = roundup_pow_of_two(expected_size);
386 /*
387 * kmalloc ensures a valid notification_buffer after a
388 * use of kfree in case the previous allocation was too
389 * small. Final freeing is done on disconnect.
390 */
391 acm->notification_buffer =
392 kmalloc(alloc_size, GFP_ATOMIC);
393 if (!acm->notification_buffer)
394 goto exit;
395 acm->nb_size = alloc_size;
396 }
397
398 copy_size = min(current_size,
399 expected_size - acm->nb_index);
400
401 memcpy(&acm->notification_buffer[acm->nb_index],
402 urb->transfer_buffer, copy_size);
403 acm->nb_index += copy_size;
404 current_size = acm->nb_index;
405 }
406
407 if (current_size >= expected_size) {
408 /* notification complete */
409 acm_process_notification(acm, (unsigned char *)dr);
410 acm->nb_index = 0;
411 }
412
413exit:
414 retval = usb_submit_urb(urb, GFP_ATOMIC);
415 if (retval && retval != -EPERM)
416 dev_err(&acm->control->dev,
417 "%s - usb_submit_urb failed: %d\n", __func__, retval);
418}
419
420static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
421{
422 int res;
423
424 if (!test_and_clear_bit(index, &acm->read_urbs_free))
425 return 0;
426
427 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
428 if (res) {
429 if (res != -EPERM && res != -ENODEV) {
430 dev_err(&acm->data->dev,
431 "urb %d failed submission with %d\n",
432 index, res);
433 }
434 set_bit(index, &acm->read_urbs_free);
435 return res;
436 } else {
437 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
438 }
439
440 return 0;
441}
442
443static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
444{
445 int res;
446 int i;
447
448 for (i = 0; i < acm->rx_buflimit; ++i) {
449 res = acm_submit_read_urb(acm, i, mem_flags);
450 if (res)
451 return res;
452 }
453
454 return 0;
455}
456
457static void acm_process_read_urb(struct acm *acm, struct urb *urb)
458{
459 if (!urb->actual_length)
460 return;
461
462 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
463 urb->actual_length);
464 tty_flip_buffer_push(&acm->port);
465}
466
467static void acm_read_bulk_callback(struct urb *urb)
468{
469 struct acm_rb *rb = urb->context;
470 struct acm *acm = rb->instance;
471 unsigned long flags;
472 int status = urb->status;
473
474 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
475 rb->index, urb->actual_length, status);
476
477 set_bit(rb->index, &acm->read_urbs_free);
478
479 if (!acm->dev) {
480 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
481 return;
482 }
483
484 switch (status) {
485 case 0:
486 usb_mark_last_busy(acm->dev);
487 acm_process_read_urb(acm, urb);
488 break;
489 case -EPIPE:
490 set_bit(EVENT_RX_STALL, &acm->flags);
491 schedule_work(&acm->work);
492 return;
493 case -ENOENT:
494 case -ECONNRESET:
495 case -ESHUTDOWN:
496 dev_dbg(&acm->data->dev,
497 "%s - urb shutting down with status: %d\n",
498 __func__, status);
499 return;
500 default:
501 dev_dbg(&acm->data->dev,
502 "%s - nonzero urb status received: %d\n",
503 __func__, status);
504 break;
505 }
506
507 /*
508 * Unthrottle may run on another CPU which needs to see events
509 * in the same order. Submission has an implict barrier
510 */
511 smp_mb__before_atomic();
512
513 /* throttle device if requested by tty */
514 spin_lock_irqsave(&acm->read_lock, flags);
515 acm->throttled = acm->throttle_req;
516 if (!acm->throttled) {
517 spin_unlock_irqrestore(&acm->read_lock, flags);
518 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
519 } else {
520 spin_unlock_irqrestore(&acm->read_lock, flags);
521 }
522}
523
524/* data interface wrote those outgoing bytes */
525static void acm_write_bulk(struct urb *urb)
526{
527 struct acm_wb *wb = urb->context;
528 struct acm *acm = wb->instance;
529 unsigned long flags;
530 int status = urb->status;
531
532 if (status || (urb->actual_length != urb->transfer_buffer_length))
533 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
534 urb->actual_length,
535 urb->transfer_buffer_length,
536 status);
537
538 spin_lock_irqsave(&acm->write_lock, flags);
539 acm_write_done(acm, wb);
540 spin_unlock_irqrestore(&acm->write_lock, flags);
541 set_bit(EVENT_TTY_WAKEUP, &acm->flags);
542 schedule_work(&acm->work);
543}
544
545static void acm_softint(struct work_struct *work)
546{
547 int i;
548 struct acm *acm = container_of(work, struct acm, work);
549
550 if (test_bit(EVENT_RX_STALL, &acm->flags)) {
551 if (!(usb_autopm_get_interface(acm->data))) {
552 for (i = 0; i < acm->rx_buflimit; i++)
553 usb_kill_urb(acm->read_urbs[i]);
554 usb_clear_halt(acm->dev, acm->in);
555 acm_submit_read_urbs(acm, GFP_KERNEL);
556 usb_autopm_put_interface(acm->data);
557 }
558 clear_bit(EVENT_RX_STALL, &acm->flags);
559 }
560
561 if (test_bit(EVENT_TTY_WAKEUP, &acm->flags)) {
562 tty_port_tty_wakeup(&acm->port);
563 clear_bit(EVENT_TTY_WAKEUP, &acm->flags);
564 }
565}
566
567/*
568 * TTY handlers
569 */
570
571static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
572{
573 struct acm *acm;
574 int retval;
575
576 acm = acm_get_by_minor(tty->index);
577 if (!acm)
578 return -ENODEV;
579
580 retval = tty_standard_install(driver, tty);
581 if (retval)
582 goto error_init_termios;
583
584 tty->driver_data = acm;
585
586 return 0;
587
588error_init_termios:
589 tty_port_put(&acm->port);
590 return retval;
591}
592
593static int acm_tty_open(struct tty_struct *tty, struct file *filp)
594{
595 struct acm *acm = tty->driver_data;
596
597 return tty_port_open(&acm->port, tty, filp);
598}
599
600static void acm_port_dtr_rts(struct tty_port *port, int raise)
601{
602 struct acm *acm = container_of(port, struct acm, port);
603 int val;
604 int res;
605
606 if (raise)
607 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
608 else
609 val = 0;
610
611 /* FIXME: add missing ctrlout locking throughout driver */
612 acm->ctrlout = val;
613
614 res = acm_set_control(acm, val);
615 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
616 dev_err(&acm->control->dev, "failed to set dtr/rts\n");
617}
618
619static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
620{
621 struct acm *acm = container_of(port, struct acm, port);
622 int retval = -ENODEV;
623 int i;
624
625 mutex_lock(&acm->mutex);
626 if (acm->disconnected)
627 goto disconnected;
628
629 retval = usb_autopm_get_interface(acm->control);
630 if (retval)
631 goto error_get_interface;
632
633 /*
634 * FIXME: Why do we need this? Allocating 64K of physically contiguous
635 * memory is really nasty...
636 */
637 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
638 acm->control->needs_remote_wakeup = 1;
639
640 acm->ctrlurb->dev = acm->dev;
641 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
642 if (retval) {
643 dev_err(&acm->control->dev,
644 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
645 goto error_submit_urb;
646 }
647
648 acm_tty_set_termios(tty, NULL);
649
650 /*
651 * Unthrottle device in case the TTY was closed while throttled.
652 */
653 spin_lock_irq(&acm->read_lock);
654 acm->throttled = 0;
655 acm->throttle_req = 0;
656 spin_unlock_irq(&acm->read_lock);
657
658 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
659 if (retval)
660 goto error_submit_read_urbs;
661
662 usb_autopm_put_interface(acm->control);
663
664 mutex_unlock(&acm->mutex);
665
666 return 0;
667
668error_submit_read_urbs:
669 for (i = 0; i < acm->rx_buflimit; i++)
670 usb_kill_urb(acm->read_urbs[i]);
671 usb_kill_urb(acm->ctrlurb);
672error_submit_urb:
673 usb_autopm_put_interface(acm->control);
674error_get_interface:
675disconnected:
676 mutex_unlock(&acm->mutex);
677
678 return usb_translate_errors(retval);
679}
680
681static void acm_port_destruct(struct tty_port *port)
682{
683 struct acm *acm = container_of(port, struct acm, port);
684
685 acm_release_minor(acm);
686 usb_put_intf(acm->control);
687 kfree(acm->country_codes);
688 kfree(acm);
689}
690
691static void acm_port_shutdown(struct tty_port *port)
692{
693 struct acm *acm = container_of(port, struct acm, port);
694 struct urb *urb;
695 struct acm_wb *wb;
696
697 /*
698 * Need to grab write_lock to prevent race with resume, but no need to
699 * hold it due to the tty-port initialised flag.
700 */
701 spin_lock_irq(&acm->write_lock);
702 spin_unlock_irq(&acm->write_lock);
703
704 usb_autopm_get_interface_no_resume(acm->control);
705 acm->control->needs_remote_wakeup = 0;
706 usb_autopm_put_interface(acm->control);
707
708 for (;;) {
709 urb = usb_get_from_anchor(&acm->delayed);
710 if (!urb)
711 break;
712 wb = urb->context;
713 wb->use = 0;
714 usb_autopm_put_interface_async(acm->control);
715 }
716
717 acm_kill_urbs(acm);
718}
719
720static void acm_tty_cleanup(struct tty_struct *tty)
721{
722 struct acm *acm = tty->driver_data;
723
724 tty_port_put(&acm->port);
725}
726
727static void acm_tty_hangup(struct tty_struct *tty)
728{
729 struct acm *acm = tty->driver_data;
730
731 tty_port_hangup(&acm->port);
732}
733
734static void acm_tty_close(struct tty_struct *tty, struct file *filp)
735{
736 struct acm *acm = tty->driver_data;
737
738 tty_port_close(&acm->port, tty, filp);
739}
740
741static int acm_tty_write(struct tty_struct *tty,
742 const unsigned char *buf, int count)
743{
744 struct acm *acm = tty->driver_data;
745 int stat;
746 unsigned long flags;
747 int wbn;
748 struct acm_wb *wb;
749
750 if (!count)
751 return 0;
752
753 dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
754
755 spin_lock_irqsave(&acm->write_lock, flags);
756 wbn = acm_wb_alloc(acm);
757 if (wbn < 0) {
758 spin_unlock_irqrestore(&acm->write_lock, flags);
759 return 0;
760 }
761 wb = &acm->wb[wbn];
762
763 if (!acm->dev) {
764 wb->use = 0;
765 spin_unlock_irqrestore(&acm->write_lock, flags);
766 return -ENODEV;
767 }
768
769 count = (count > acm->writesize) ? acm->writesize : count;
770 dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
771 memcpy(wb->buf, buf, count);
772 wb->len = count;
773
774 stat = usb_autopm_get_interface_async(acm->control);
775 if (stat) {
776 wb->use = 0;
777 spin_unlock_irqrestore(&acm->write_lock, flags);
778 return stat;
779 }
780
781 if (acm->susp_count) {
782 if (acm->putbuffer) {
783 /* now to preserve order */
784 usb_anchor_urb(acm->putbuffer->urb, &acm->delayed);
785 acm->putbuffer = NULL;
786 }
787 usb_anchor_urb(wb->urb, &acm->delayed);
788 spin_unlock_irqrestore(&acm->write_lock, flags);
789 return count;
790 } else {
791 if (acm->putbuffer) {
792 /* at this point there is no good way to handle errors */
793 acm_start_wb(acm, acm->putbuffer);
794 acm->putbuffer = NULL;
795 }
796 }
797
798 stat = acm_start_wb(acm, wb);
799 spin_unlock_irqrestore(&acm->write_lock, flags);
800
801 if (stat < 0)
802 return stat;
803 return count;
804}
805
806static void acm_tty_flush_chars(struct tty_struct *tty)
807{
808 struct acm *acm = tty->driver_data;
809 struct acm_wb *cur;
810 int err;
811 unsigned long flags;
812
813 spin_lock_irqsave(&acm->write_lock, flags);
814
815 cur = acm->putbuffer;
816 if (!cur) /* nothing to do */
817 goto out;
818
819 acm->putbuffer = NULL;
820 err = usb_autopm_get_interface_async(acm->control);
821 if (err < 0) {
822 cur->use = 0;
823 acm->putbuffer = cur;
824 goto out;
825 }
826
827 if (acm->susp_count)
828 usb_anchor_urb(cur->urb, &acm->delayed);
829 else
830 acm_start_wb(acm, cur);
831out:
832 spin_unlock_irqrestore(&acm->write_lock, flags);
833 return;
834}
835
836static int acm_tty_put_char(struct tty_struct *tty, unsigned char ch)
837{
838 struct acm *acm = tty->driver_data;
839 struct acm_wb *cur;
840 int wbn;
841 unsigned long flags;
842
843overflow:
844 cur = acm->putbuffer;
845 if (!cur) {
846 spin_lock_irqsave(&acm->write_lock, flags);
847 wbn = acm_wb_alloc(acm);
848 if (wbn >= 0) {
849 cur = &acm->wb[wbn];
850 acm->putbuffer = cur;
851 }
852 spin_unlock_irqrestore(&acm->write_lock, flags);
853 if (!cur)
854 return 0;
855 }
856
857 if (cur->len == acm->writesize) {
858 acm_tty_flush_chars(tty);
859 goto overflow;
860 }
861
862 cur->buf[cur->len++] = ch;
863 return 1;
864}
865
866static int acm_tty_write_room(struct tty_struct *tty)
867{
868 struct acm *acm = tty->driver_data;
869 /*
870 * Do not let the line discipline to know that we have a reserve,
871 * or it might get too enthusiastic.
872 */
873 return acm_wb_is_avail(acm) ? acm->writesize : 0;
874}
875
876static int acm_tty_chars_in_buffer(struct tty_struct *tty)
877{
878 struct acm *acm = tty->driver_data;
879 /*
880 * if the device was unplugged then any remaining characters fell out
881 * of the connector ;)
882 */
883 if (acm->disconnected)
884 return 0;
885 /*
886 * This is inaccurate (overcounts), but it works.
887 */
888 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
889}
890
891static void acm_tty_throttle(struct tty_struct *tty)
892{
893 struct acm *acm = tty->driver_data;
894
895 spin_lock_irq(&acm->read_lock);
896 acm->throttle_req = 1;
897 spin_unlock_irq(&acm->read_lock);
898}
899
900static void acm_tty_unthrottle(struct tty_struct *tty)
901{
902 struct acm *acm = tty->driver_data;
903 unsigned int was_throttled;
904
905 spin_lock_irq(&acm->read_lock);
906 was_throttled = acm->throttled;
907 acm->throttled = 0;
908 acm->throttle_req = 0;
909 spin_unlock_irq(&acm->read_lock);
910
911 if (was_throttled)
912 acm_submit_read_urbs(acm, GFP_KERNEL);
913}
914
915static int acm_tty_break_ctl(struct tty_struct *tty, int state)
916{
917 struct acm *acm = tty->driver_data;
918 int retval;
919
920 retval = acm_send_break(acm, state ? 0xffff : 0);
921 if (retval < 0)
922 dev_dbg(&acm->control->dev,
923 "%s - send break failed\n", __func__);
924 return retval;
925}
926
927static int acm_tty_tiocmget(struct tty_struct *tty)
928{
929 struct acm *acm = tty->driver_data;
930
931 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
932 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
933 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
934 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
935 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
936 TIOCM_CTS;
937}
938
939static int acm_tty_tiocmset(struct tty_struct *tty,
940 unsigned int set, unsigned int clear)
941{
942 struct acm *acm = tty->driver_data;
943 unsigned int newctrl;
944
945 newctrl = acm->ctrlout;
946 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
947 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
948 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
949 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
950
951 newctrl = (newctrl & ~clear) | set;
952
953 if (acm->ctrlout == newctrl)
954 return 0;
955 return acm_set_control(acm, acm->ctrlout = newctrl);
956}
957
958static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
959{
960 struct serial_struct tmp;
961
962 memset(&tmp, 0, sizeof(tmp));
963 tmp.xmit_fifo_size = acm->writesize;
964 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
965 tmp.close_delay = acm->port.close_delay / 10;
966 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
967 ASYNC_CLOSING_WAIT_NONE :
968 acm->port.closing_wait / 10;
969
970 if (copy_to_user(info, &tmp, sizeof(tmp)))
971 return -EFAULT;
972 else
973 return 0;
974}
975
976static int set_serial_info(struct acm *acm,
977 struct serial_struct __user *newinfo)
978{
979 struct serial_struct new_serial;
980 unsigned int closing_wait, close_delay;
981 int retval = 0;
982
983 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
984 return -EFAULT;
985
986 close_delay = new_serial.close_delay * 10;
987 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
988 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
989
990 mutex_lock(&acm->port.mutex);
991
992 if (!capable(CAP_SYS_ADMIN)) {
993 if ((close_delay != acm->port.close_delay) ||
994 (closing_wait != acm->port.closing_wait))
995 retval = -EPERM;
996 else
997 retval = -EOPNOTSUPP;
998 } else {
999 acm->port.close_delay = close_delay;
1000 acm->port.closing_wait = closing_wait;
1001 }
1002
1003 mutex_unlock(&acm->port.mutex);
1004 return retval;
1005}
1006
1007static int wait_serial_change(struct acm *acm, unsigned long arg)
1008{
1009 int rv = 0;
1010 DECLARE_WAITQUEUE(wait, current);
1011 struct async_icount old, new;
1012
1013 do {
1014 spin_lock_irq(&acm->read_lock);
1015 old = acm->oldcount;
1016 new = acm->iocount;
1017 acm->oldcount = new;
1018 spin_unlock_irq(&acm->read_lock);
1019
1020 if ((arg & TIOCM_DSR) &&
1021 old.dsr != new.dsr)
1022 break;
1023 if ((arg & TIOCM_CD) &&
1024 old.dcd != new.dcd)
1025 break;
1026 if ((arg & TIOCM_RI) &&
1027 old.rng != new.rng)
1028 break;
1029
1030 add_wait_queue(&acm->wioctl, &wait);
1031 set_current_state(TASK_INTERRUPTIBLE);
1032 schedule();
1033 remove_wait_queue(&acm->wioctl, &wait);
1034 if (acm->disconnected) {
1035 if (arg & TIOCM_CD)
1036 break;
1037 else
1038 rv = -ENODEV;
1039 } else {
1040 if (signal_pending(current))
1041 rv = -ERESTARTSYS;
1042 }
1043 } while (!rv);
1044
1045
1046
1047 return rv;
1048}
1049
1050static int acm_tty_get_icount(struct tty_struct *tty,
1051 struct serial_icounter_struct *icount)
1052{
1053 struct acm *acm = tty->driver_data;
1054
1055 icount->dsr = acm->iocount.dsr;
1056 icount->rng = acm->iocount.rng;
1057 icount->dcd = acm->iocount.dcd;
1058 icount->frame = acm->iocount.frame;
1059 icount->overrun = acm->iocount.overrun;
1060 icount->parity = acm->iocount.parity;
1061 icount->brk = acm->iocount.brk;
1062
1063 return 0;
1064}
1065
1066static int acm_tty_ioctl(struct tty_struct *tty,
1067 unsigned int cmd, unsigned long arg)
1068{
1069 struct acm *acm = tty->driver_data;
1070 int rv = -ENOIOCTLCMD;
1071
1072 switch (cmd) {
1073 case TIOCGSERIAL: /* gets serial port data */
1074 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
1075 break;
1076 case TIOCSSERIAL:
1077 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
1078 break;
1079 case TIOCMIWAIT:
1080 rv = usb_autopm_get_interface(acm->control);
1081 if (rv < 0) {
1082 rv = -EIO;
1083 break;
1084 }
1085 rv = wait_serial_change(acm, arg);
1086 usb_autopm_put_interface(acm->control);
1087 break;
1088 }
1089
1090 return rv;
1091}
1092
1093static void acm_tty_set_termios(struct tty_struct *tty,
1094 struct ktermios *termios_old)
1095{
1096 struct acm *acm = tty->driver_data;
1097 struct ktermios *termios = &tty->termios;
1098 struct usb_cdc_line_coding newline;
1099 int newctrl = acm->ctrlout;
1100
1101 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1102 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1103 newline.bParityType = termios->c_cflag & PARENB ?
1104 (termios->c_cflag & PARODD ? 1 : 2) +
1105 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1106 switch (termios->c_cflag & CSIZE) {
1107 case CS5:
1108 newline.bDataBits = 5;
1109 break;
1110 case CS6:
1111 newline.bDataBits = 6;
1112 break;
1113 case CS7:
1114 newline.bDataBits = 7;
1115 break;
1116 case CS8:
1117 default:
1118 newline.bDataBits = 8;
1119 break;
1120 }
1121 /* FIXME: Needs to clear unsupported bits in the termios */
1122 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1123
1124 if (C_BAUD(tty) == B0) {
1125 newline.dwDTERate = acm->line.dwDTERate;
1126 newctrl &= ~ACM_CTRL_DTR;
1127 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1128 newctrl |= ACM_CTRL_DTR;
1129 }
1130
1131 if (newctrl != acm->ctrlout)
1132 acm_set_control(acm, acm->ctrlout = newctrl);
1133
1134 if (memcmp(&acm->line, &newline, sizeof newline)) {
1135 memcpy(&acm->line, &newline, sizeof newline);
1136 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1137 __func__,
1138 le32_to_cpu(newline.dwDTERate),
1139 newline.bCharFormat, newline.bParityType,
1140 newline.bDataBits);
1141 acm_set_line(acm, &acm->line);
1142 }
1143}
1144
1145static const struct tty_port_operations acm_port_ops = {
1146 .dtr_rts = acm_port_dtr_rts,
1147 .shutdown = acm_port_shutdown,
1148 .activate = acm_port_activate,
1149 .destruct = acm_port_destruct,
1150};
1151
1152/*
1153 * USB probe and disconnect routines.
1154 */
1155
1156/* Little helpers: write/read buffers free */
1157static void acm_write_buffers_free(struct acm *acm)
1158{
1159 int i;
1160 struct acm_wb *wb;
1161
1162 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1163 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1164}
1165
1166static void acm_read_buffers_free(struct acm *acm)
1167{
1168 int i;
1169
1170 for (i = 0; i < acm->rx_buflimit; i++)
1171 usb_free_coherent(acm->dev, acm->readsize,
1172 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1173}
1174
1175/* Little helper: write buffers allocate */
1176static int acm_write_buffers_alloc(struct acm *acm)
1177{
1178 int i;
1179 struct acm_wb *wb;
1180
1181 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1182 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1183 &wb->dmah);
1184 if (!wb->buf) {
1185 while (i != 0) {
1186 --i;
1187 --wb;
1188 usb_free_coherent(acm->dev, acm->writesize,
1189 wb->buf, wb->dmah);
1190 }
1191 return -ENOMEM;
1192 }
1193 }
1194 return 0;
1195}
1196
1197static int acm_probe(struct usb_interface *intf,
1198 const struct usb_device_id *id)
1199{
1200 struct usb_cdc_union_desc *union_header = NULL;
1201 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1202 unsigned char *buffer = intf->altsetting->extra;
1203 int buflen = intf->altsetting->extralen;
1204 struct usb_interface *control_interface;
1205 struct usb_interface *data_interface;
1206 struct usb_endpoint_descriptor *epctrl = NULL;
1207 struct usb_endpoint_descriptor *epread = NULL;
1208 struct usb_endpoint_descriptor *epwrite = NULL;
1209 struct usb_device *usb_dev = interface_to_usbdev(intf);
1210 struct usb_cdc_parsed_header h;
1211 struct acm *acm;
1212 int minor;
1213 int ctrlsize, readsize;
1214 u8 *buf;
1215 int call_intf_num = -1;
1216 int data_intf_num = -1;
1217 unsigned long quirks;
1218 int num_rx_buf;
1219 int i;
1220 int combined_interfaces = 0;
1221 struct device *tty_dev;
1222 int rv = -ENOMEM;
1223 int res;
1224
1225 /* normal quirks */
1226 quirks = (unsigned long)id->driver_info;
1227
1228 if (quirks == IGNORE_DEVICE)
1229 return -ENODEV;
1230
1231 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1232
1233 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1234
1235 /* handle quirks deadly to normal probing*/
1236 if (quirks == NO_UNION_NORMAL) {
1237 data_interface = usb_ifnum_to_if(usb_dev, 1);
1238 control_interface = usb_ifnum_to_if(usb_dev, 0);
1239 /* we would crash */
1240 if (!data_interface || !control_interface)
1241 return -ENODEV;
1242 goto skip_normal_probe;
1243 }
1244
1245 /* normal probing*/
1246 if (!buffer) {
1247 dev_err(&intf->dev, "Weird descriptor references\n");
1248 return -EINVAL;
1249 }
1250
1251 if (!intf->cur_altsetting)
1252 return -EINVAL;
1253
1254 if (!buflen) {
1255 if (intf->cur_altsetting->endpoint &&
1256 intf->cur_altsetting->endpoint->extralen &&
1257 intf->cur_altsetting->endpoint->extra) {
1258 dev_dbg(&intf->dev,
1259 "Seeking extra descriptors on endpoint\n");
1260 buflen = intf->cur_altsetting->endpoint->extralen;
1261 buffer = intf->cur_altsetting->endpoint->extra;
1262 } else {
1263 dev_err(&intf->dev,
1264 "Zero length descriptor references\n");
1265 return -EINVAL;
1266 }
1267 }
1268
1269 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1270 union_header = h.usb_cdc_union_desc;
1271 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1272 if (cmgmd)
1273 call_intf_num = cmgmd->bDataInterface;
1274
1275 if (!union_header) {
1276 if (call_intf_num > 0) {
1277 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1278 /* quirks for Droids MuIn LCD */
1279 if (quirks & NO_DATA_INTERFACE) {
1280 data_interface = usb_ifnum_to_if(usb_dev, 0);
1281 } else {
1282 data_intf_num = call_intf_num;
1283 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1284 }
1285 control_interface = intf;
1286 } else {
1287 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1288 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1289 return -ENODEV;
1290 } else {
1291 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1292 combined_interfaces = 1;
1293 control_interface = data_interface = intf;
1294 goto look_for_collapsed_interface;
1295 }
1296 }
1297 } else {
1298 data_intf_num = union_header->bSlaveInterface0;
1299 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1300 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1301 }
1302
1303 if (!control_interface || !data_interface) {
1304 dev_dbg(&intf->dev, "no interfaces\n");
1305 return -ENODEV;
1306 }
1307 if (!data_interface->cur_altsetting || !control_interface->cur_altsetting)
1308 return -ENODEV;
1309
1310 if (data_intf_num != call_intf_num)
1311 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1312
1313 if (control_interface == data_interface) {
1314 /* some broken devices designed for windows work this way */
1315 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1316 combined_interfaces = 1;
1317 /* a popular other OS doesn't use it */
1318 quirks |= NO_CAP_LINE;
1319 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1320 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1321 return -EINVAL;
1322 }
1323look_for_collapsed_interface:
1324 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1325 &epread, &epwrite, &epctrl, NULL);
1326 if (res)
1327 return res;
1328
1329 goto made_compressed_probe;
1330 }
1331
1332skip_normal_probe:
1333
1334 /*workaround for switched interfaces */
1335 if (data_interface->cur_altsetting->desc.bInterfaceClass
1336 != CDC_DATA_INTERFACE_TYPE) {
1337 if (control_interface->cur_altsetting->desc.bInterfaceClass
1338 == CDC_DATA_INTERFACE_TYPE) {
1339 dev_dbg(&intf->dev,
1340 "Your device has switched interfaces.\n");
1341 swap(control_interface, data_interface);
1342 } else {
1343 return -EINVAL;
1344 }
1345 }
1346
1347 /* Accept probe requests only for the control interface */
1348 if (!combined_interfaces && intf != control_interface)
1349 return -ENODEV;
1350
1351 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1352 /* valid in this context */
1353 dev_dbg(&intf->dev, "The data interface isn't available\n");
1354 return -EBUSY;
1355 }
1356
1357
1358 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1359 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1360 return -EINVAL;
1361
1362 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1363 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1364 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1365
1366
1367 /* workaround for switched endpoints */
1368 if (!usb_endpoint_dir_in(epread)) {
1369 /* descriptors are swapped */
1370 dev_dbg(&intf->dev,
1371 "The data interface has switched endpoints\n");
1372 swap(epread, epwrite);
1373 }
1374made_compressed_probe:
1375 dev_dbg(&intf->dev, "interfaces are valid\n");
1376
1377 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1378 if (acm == NULL)
1379 goto alloc_fail;
1380
1381 minor = acm_alloc_minor(acm);
1382 if (minor < 0)
1383 goto alloc_fail1;
1384
1385 ctrlsize = usb_endpoint_maxp(epctrl);
1386 readsize = usb_endpoint_maxp(epread) *
1387 (quirks == SINGLE_RX_URB ? 1 : 2);
1388 acm->combined_interfaces = combined_interfaces;
1389 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1390 acm->control = control_interface;
1391 acm->data = data_interface;
1392 acm->minor = minor;
1393 acm->dev = usb_dev;
1394 if (h.usb_cdc_acm_descriptor)
1395 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1396 if (quirks & NO_CAP_LINE)
1397 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1398 acm->ctrlsize = ctrlsize;
1399 acm->readsize = readsize;
1400 acm->rx_buflimit = num_rx_buf;
1401 INIT_WORK(&acm->work, acm_softint);
1402 init_waitqueue_head(&acm->wioctl);
1403 spin_lock_init(&acm->write_lock);
1404 spin_lock_init(&acm->read_lock);
1405 mutex_init(&acm->mutex);
1406 if (usb_endpoint_xfer_int(epread)) {
1407 acm->bInterval = epread->bInterval;
1408 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1409 } else {
1410 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1411 }
1412 if (usb_endpoint_xfer_int(epwrite))
1413 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1414 else
1415 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1416 tty_port_init(&acm->port);
1417 acm->port.ops = &acm_port_ops;
1418 init_usb_anchor(&acm->delayed);
1419 acm->quirks = quirks;
1420
1421 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1422 if (!buf)
1423 goto alloc_fail2;
1424 acm->ctrl_buffer = buf;
1425
1426 if (acm_write_buffers_alloc(acm) < 0)
1427 goto alloc_fail4;
1428
1429 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1430 if (!acm->ctrlurb)
1431 goto alloc_fail5;
1432
1433 for (i = 0; i < num_rx_buf; i++) {
1434 struct acm_rb *rb = &(acm->read_buffers[i]);
1435 struct urb *urb;
1436
1437 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1438 &rb->dma);
1439 if (!rb->base)
1440 goto alloc_fail6;
1441 rb->index = i;
1442 rb->instance = acm;
1443
1444 urb = usb_alloc_urb(0, GFP_KERNEL);
1445 if (!urb)
1446 goto alloc_fail6;
1447
1448 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1449 urb->transfer_dma = rb->dma;
1450 if (usb_endpoint_xfer_int(epread))
1451 usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1452 acm->readsize,
1453 acm_read_bulk_callback, rb,
1454 acm->bInterval);
1455 else
1456 usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1457 acm->readsize,
1458 acm_read_bulk_callback, rb);
1459
1460 acm->read_urbs[i] = urb;
1461 __set_bit(i, &acm->read_urbs_free);
1462 }
1463 for (i = 0; i < ACM_NW; i++) {
1464 struct acm_wb *snd = &(acm->wb[i]);
1465
1466 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1467 if (snd->urb == NULL)
1468 goto alloc_fail7;
1469
1470 if (usb_endpoint_xfer_int(epwrite))
1471 usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1472 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1473 else
1474 usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1475 NULL, acm->writesize, acm_write_bulk, snd);
1476 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1477 if (quirks & SEND_ZERO_PACKET)
1478 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1479 snd->instance = acm;
1480 }
1481
1482 usb_set_intfdata(intf, acm);
1483
1484 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1485 if (i < 0)
1486 goto alloc_fail7;
1487
1488 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1489 struct usb_cdc_country_functional_desc * cfd =
1490 h.usb_cdc_country_functional_desc;
1491
1492 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1493 if (!acm->country_codes)
1494 goto skip_countries;
1495 acm->country_code_size = cfd->bLength - 4;
1496 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1497 cfd->bLength - 4);
1498 acm->country_rel_date = cfd->iCountryCodeRelDate;
1499
1500 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1501 if (i < 0) {
1502 kfree(acm->country_codes);
1503 acm->country_codes = NULL;
1504 acm->country_code_size = 0;
1505 goto skip_countries;
1506 }
1507
1508 i = device_create_file(&intf->dev,
1509 &dev_attr_iCountryCodeRelDate);
1510 if (i < 0) {
1511 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1512 kfree(acm->country_codes);
1513 acm->country_codes = NULL;
1514 acm->country_code_size = 0;
1515 goto skip_countries;
1516 }
1517 }
1518
1519skip_countries:
1520 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1521 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1522 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1523 /* works around buggy devices */
1524 epctrl->bInterval ? epctrl->bInterval : 16);
1525 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1526 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1527 acm->notification_buffer = NULL;
1528 acm->nb_index = 0;
1529 acm->nb_size = 0;
1530
1531 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1532
1533 acm->line.dwDTERate = cpu_to_le32(9600);
1534 acm->line.bDataBits = 8;
1535 acm_set_line(acm, &acm->line);
1536
1537 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1538 usb_set_intfdata(data_interface, acm);
1539
1540 usb_get_intf(control_interface);
1541 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1542 &control_interface->dev);
1543 if (IS_ERR(tty_dev)) {
1544 rv = PTR_ERR(tty_dev);
1545 goto alloc_fail8;
1546 }
1547
1548 if (quirks & CLEAR_HALT_CONDITIONS) {
1549 usb_clear_halt(usb_dev, acm->in);
1550 usb_clear_halt(usb_dev, acm->out);
1551 }
1552
1553 return 0;
1554alloc_fail8:
1555 if (acm->country_codes) {
1556 device_remove_file(&acm->control->dev,
1557 &dev_attr_wCountryCodes);
1558 device_remove_file(&acm->control->dev,
1559 &dev_attr_iCountryCodeRelDate);
1560 kfree(acm->country_codes);
1561 }
1562 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1563alloc_fail7:
1564 usb_set_intfdata(intf, NULL);
1565 for (i = 0; i < ACM_NW; i++)
1566 usb_free_urb(acm->wb[i].urb);
1567alloc_fail6:
1568 for (i = 0; i < num_rx_buf; i++)
1569 usb_free_urb(acm->read_urbs[i]);
1570 acm_read_buffers_free(acm);
1571 usb_free_urb(acm->ctrlurb);
1572alloc_fail5:
1573 acm_write_buffers_free(acm);
1574alloc_fail4:
1575 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1576alloc_fail2:
1577 acm_release_minor(acm);
1578alloc_fail1:
1579 kfree(acm);
1580alloc_fail:
1581 return rv;
1582}
1583
1584static void acm_disconnect(struct usb_interface *intf)
1585{
1586 struct acm *acm = usb_get_intfdata(intf);
1587 struct tty_struct *tty;
1588
1589 /* sibling interface is already cleaning up */
1590 if (!acm)
1591 return;
1592
1593 mutex_lock(&acm->mutex);
1594 acm->disconnected = true;
1595 if (acm->country_codes) {
1596 device_remove_file(&acm->control->dev,
1597 &dev_attr_wCountryCodes);
1598 device_remove_file(&acm->control->dev,
1599 &dev_attr_iCountryCodeRelDate);
1600 }
1601 wake_up_all(&acm->wioctl);
1602 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1603 usb_set_intfdata(acm->control, NULL);
1604 usb_set_intfdata(acm->data, NULL);
1605 mutex_unlock(&acm->mutex);
1606
1607 tty = tty_port_tty_get(&acm->port);
1608 if (tty) {
1609 tty_vhangup(tty);
1610 tty_kref_put(tty);
1611 }
1612
1613 acm_kill_urbs(acm);
1614 cancel_work_sync(&acm->work);
1615
1616 tty_unregister_device(acm_tty_driver, acm->minor);
1617
1618 acm_write_buffers_free(acm);
1619 usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1620 acm_read_buffers_free(acm);
1621
1622 kfree(acm->notification_buffer);
1623
1624 if (!acm->combined_interfaces)
1625 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1626 acm->data : acm->control);
1627
1628 tty_port_put(&acm->port);
1629}
1630
1631#ifdef CONFIG_PM
1632static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1633{
1634 struct acm *acm = usb_get_intfdata(intf);
1635 int cnt;
1636
1637 spin_lock_irq(&acm->write_lock);
1638 if (PMSG_IS_AUTO(message)) {
1639 if (acm->transmitting) {
1640 spin_unlock_irq(&acm->write_lock);
1641 return -EBUSY;
1642 }
1643 }
1644 cnt = acm->susp_count++;
1645 spin_unlock_irq(&acm->write_lock);
1646
1647 if (cnt)
1648 return 0;
1649
1650 acm_kill_urbs(acm);
1651 cancel_work_sync(&acm->work);
1652
1653 return 0;
1654}
1655
1656static int acm_resume(struct usb_interface *intf)
1657{
1658 struct acm *acm = usb_get_intfdata(intf);
1659 struct urb *urb;
1660 int rv = 0;
1661
1662 spin_lock_irq(&acm->write_lock);
1663
1664 if (--acm->susp_count)
1665 goto out;
1666
1667 if (tty_port_initialized(&acm->port)) {
1668 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1669
1670 for (;;) {
1671 urb = usb_get_from_anchor(&acm->delayed);
1672 if (!urb)
1673 break;
1674
1675 acm_start_wb(acm, urb->context);
1676 }
1677
1678 /*
1679 * delayed error checking because we must
1680 * do the write path at all cost
1681 */
1682 if (rv < 0)
1683 goto out;
1684
1685 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1686 }
1687out:
1688 spin_unlock_irq(&acm->write_lock);
1689
1690 return rv;
1691}
1692
1693static int acm_reset_resume(struct usb_interface *intf)
1694{
1695 struct acm *acm = usb_get_intfdata(intf);
1696
1697 if (tty_port_initialized(&acm->port))
1698 tty_port_tty_hangup(&acm->port, false);
1699
1700 return acm_resume(intf);
1701}
1702
1703#endif /* CONFIG_PM */
1704
1705static int acm_pre_reset(struct usb_interface *intf)
1706{
1707 struct acm *acm = usb_get_intfdata(intf);
1708
1709 clear_bit(EVENT_RX_STALL, &acm->flags);
1710
1711 return 0;
1712}
1713
1714#define NOKIA_PCSUITE_ACM_INFO(x) \
1715 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1716 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1717 USB_CDC_ACM_PROTO_VENDOR)
1718
1719#define SAMSUNG_PCSUITE_ACM_INFO(x) \
1720 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1721 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1722 USB_CDC_ACM_PROTO_VENDOR)
1723
1724/*
1725 * USB driver structure.
1726 */
1727
1728static const struct usb_device_id acm_ids[] = {
1729 /* quirky and broken devices */
1730 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1731 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1732 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1733 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1734 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1735 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1736 },
1737 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1738 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1739 },
1740 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1741 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1742 },
1743 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1744 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1745 },
1746 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1747 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1748 },
1749 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1750 .driver_info = SINGLE_RX_URB,
1751 },
1752 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1753 .driver_info = SINGLE_RX_URB, /* firmware bug */
1754 },
1755 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1756 .driver_info = SINGLE_RX_URB, /* firmware bug */
1757 },
1758 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1759 .driver_info = SINGLE_RX_URB,
1760 },
1761 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1762 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1763 },
1764 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1765 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1766 },
1767 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1768 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1769 },
1770 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1771 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1772 },
1773 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1774 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1775 },
1776 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1777 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1778 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1779 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1780 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1781 },
1782 /* Motorola H24 HSPA module: */
1783 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1784 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1785 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1786 },
1787 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1788 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1789 },
1790 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1791 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1792 },
1793 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1794 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1795 },
1796 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1797 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1798 },
1799 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1800 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1801 },
1802 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1803 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1804 },
1805
1806 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1807 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1808 data interface instead of
1809 communications interface.
1810 Maybe we should define a new
1811 quirk for this. */
1812 },
1813 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1814 .driver_info = NO_UNION_NORMAL,
1815 },
1816 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1817 .driver_info = NO_UNION_NORMAL,
1818 },
1819 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1820 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1821 },
1822 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1823 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1824 },
1825 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1826 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1827 },
1828 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1829 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1830 },
1831
1832 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1833 .driver_info = CLEAR_HALT_CONDITIONS,
1834 },
1835
1836 /* Nokia S60 phones expose two ACM channels. The first is
1837 * a modem and is picked up by the standard AT-command
1838 * information below. The second is 'vendor-specific' but
1839 * is treated as a serial device at the S60 end, so we want
1840 * to expose it on Linux too. */
1841 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1842 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1843 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1847 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1849 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1856 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1859 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1860 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1861 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1862 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1863 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1864 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1865 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1867 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1868 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1869 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1870 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1871 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1873 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1874 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1876 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1877 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1880 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1881 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1883 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1885 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1886 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1888 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1890 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1891 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1892 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1893 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1894 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1895 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1896 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1897 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1898 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1899
1900 /* Support for Owen devices */
1901 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1902
1903 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1904
1905 /* Support for Droids MuIn LCD */
1906 { USB_DEVICE(0x04d8, 0x000b),
1907 .driver_info = NO_DATA_INTERFACE,
1908 },
1909
1910#if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1911 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1912 .driver_info = IGNORE_DEVICE,
1913 },
1914 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1915 .driver_info = IGNORE_DEVICE,
1916 },
1917#endif
1918
1919 /*Samsung phone in firmware update mode */
1920 { USB_DEVICE(0x04e8, 0x685d),
1921 .driver_info = IGNORE_DEVICE,
1922 },
1923
1924 /* Exclude Infineon Flash Loader utility */
1925 { USB_DEVICE(0x058b, 0x0041),
1926 .driver_info = IGNORE_DEVICE,
1927 },
1928
1929 /* control interfaces without any protocol set */
1930 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1931 USB_CDC_PROTO_NONE) },
1932
1933 /* control interfaces with various AT-command sets */
1934 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1935 USB_CDC_ACM_PROTO_AT_V25TER) },
1936 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1937 USB_CDC_ACM_PROTO_AT_PCCA101) },
1938 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1939 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1940 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1941 USB_CDC_ACM_PROTO_AT_GSM) },
1942 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1943 USB_CDC_ACM_PROTO_AT_3G) },
1944 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1945 USB_CDC_ACM_PROTO_AT_CDMA) },
1946
1947 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1948 .driver_info = SEND_ZERO_PACKET,
1949 },
1950
1951 { }
1952};
1953
1954MODULE_DEVICE_TABLE(usb, acm_ids);
1955
1956static struct usb_driver acm_driver = {
1957 .name = "cdc_acm",
1958 .probe = acm_probe,
1959 .disconnect = acm_disconnect,
1960#ifdef CONFIG_PM
1961 .suspend = acm_suspend,
1962 .resume = acm_resume,
1963 .reset_resume = acm_reset_resume,
1964#endif
1965 .pre_reset = acm_pre_reset,
1966 .id_table = acm_ids,
1967#ifdef CONFIG_PM
1968 .supports_autosuspend = 1,
1969#endif
1970 .disable_hub_initiated_lpm = 1,
1971};
1972
1973/*
1974 * TTY driver structures.
1975 */
1976
1977static const struct tty_operations acm_ops = {
1978 .install = acm_tty_install,
1979 .open = acm_tty_open,
1980 .close = acm_tty_close,
1981 .cleanup = acm_tty_cleanup,
1982 .hangup = acm_tty_hangup,
1983 .write = acm_tty_write,
1984 .put_char = acm_tty_put_char,
1985 .flush_chars = acm_tty_flush_chars,
1986 .write_room = acm_tty_write_room,
1987 .ioctl = acm_tty_ioctl,
1988 .throttle = acm_tty_throttle,
1989 .unthrottle = acm_tty_unthrottle,
1990 .chars_in_buffer = acm_tty_chars_in_buffer,
1991 .break_ctl = acm_tty_break_ctl,
1992 .set_termios = acm_tty_set_termios,
1993 .tiocmget = acm_tty_tiocmget,
1994 .tiocmset = acm_tty_tiocmset,
1995 .get_icount = acm_tty_get_icount,
1996};
1997
1998/*
1999 * Init / exit.
2000 */
2001
2002static int __init acm_init(void)
2003{
2004 int retval;
2005 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
2006 if (!acm_tty_driver)
2007 return -ENOMEM;
2008 acm_tty_driver->driver_name = "acm",
2009 acm_tty_driver->name = "ttyACM",
2010 acm_tty_driver->major = ACM_TTY_MAJOR,
2011 acm_tty_driver->minor_start = 0,
2012 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2013 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2014 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2015 acm_tty_driver->init_termios = tty_std_termios;
2016 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2017 HUPCL | CLOCAL;
2018 tty_set_operations(acm_tty_driver, &acm_ops);
2019
2020 retval = tty_register_driver(acm_tty_driver);
2021 if (retval) {
2022 put_tty_driver(acm_tty_driver);
2023 return retval;
2024 }
2025
2026 retval = usb_register(&acm_driver);
2027 if (retval) {
2028 tty_unregister_driver(acm_tty_driver);
2029 put_tty_driver(acm_tty_driver);
2030 return retval;
2031 }
2032
2033 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2034
2035 return 0;
2036}
2037
2038static void __exit acm_exit(void)
2039{
2040 usb_deregister(&acm_driver);
2041 tty_unregister_driver(acm_tty_driver);
2042 put_tty_driver(acm_tty_driver);
2043 idr_destroy(&acm_minors);
2044}
2045
2046module_init(acm_init);
2047module_exit(acm_exit);
2048
2049MODULE_AUTHOR(DRIVER_AUTHOR);
2050MODULE_DESCRIPTION(DRIVER_DESC);
2051MODULE_LICENSE("GPL");
2052MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);