2 USB Driver for Sierra Wireless
4 Copyright (C) 2006, 2007, 2008 Kevin Lloyd <klloyd@sierrawireless.com>,
6 Copyright (C) 2008, 2009 Elina Pasheva, Matthew Safar, Rory Filer
7 <linux@sierrawireless.com>
9 IMPORTANT DISCLAIMER: This driver is not commercially supported by
10 Sierra Wireless. Use at your own risk.
12 This driver is free software; you can redistribute it and/or modify
13 it under the terms of Version 2 of the GNU General Public License as
14 published by the Free Software Foundation.
16 Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
17 Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
19 /* Uncomment to log function calls */
22 #define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
23 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
25 #include <linux/kernel.h>
26 #include <linux/jiffies.h>
27 #include <linux/errno.h>
28 #include <linux/tty.h>
29 #include <linux/slab.h>
30 #include <linux/tty_flip.h>
31 #include <linux/module.h>
32 #include <linux/usb.h>
33 #include <linux/usb/serial.h>
35 #define SWIMS_USB_REQUEST_SetPower 0x00
36 #define SWIMS_USB_REQUEST_SetNmea 0x07
39 #define N_OUT_URB_HM 64
42 #define IN_BUFLEN 4096
44 #define MAX_TRANSFER (PAGE_SIZE - 512)
45 /* MAX_TRANSFER is chosen so that the VM is not stressed by
46 allocations > PAGE_SIZE and the number of packets in a page
47 is an integer 512 is the largest possible packet on EHCI */
51 /* Used in interface blacklisting */
52 struct sierra_iface_info
{
53 const u32 infolen
; /* number of interface numbers on blacklist */
54 const u8
*ifaceinfo
; /* pointer to the array holding the numbers */
57 struct sierra_intf_private
{
59 unsigned int suspended
:1;
61 unsigned int open_ports
;
64 static int sierra_set_power_state(struct usb_device
*udev
, __u16 swiState
)
66 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
67 SWIMS_USB_REQUEST_SetPower
, /* __u8 request */
68 USB_TYPE_VENDOR
, /* __u8 request type */
69 swiState
, /* __u16 value */
71 NULL
, /* void *data */
73 USB_CTRL_SET_TIMEOUT
); /* int timeout */
76 static int sierra_vsc_set_nmea(struct usb_device
*udev
, __u16 enable
)
78 return usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
79 SWIMS_USB_REQUEST_SetNmea
, /* __u8 request */
80 USB_TYPE_VENDOR
, /* __u8 request type */
81 enable
, /* __u16 value */
82 0x0000, /* __u16 index */
83 NULL
, /* void *data */
85 USB_CTRL_SET_TIMEOUT
); /* int timeout */
88 static int sierra_calc_num_ports(struct usb_serial
*serial
)
91 u8 ifnum
, numendpoints
;
93 ifnum
= serial
->interface
->cur_altsetting
->desc
.bInterfaceNumber
;
94 numendpoints
= serial
->interface
->cur_altsetting
->desc
.bNumEndpoints
;
96 /* Dummy interface present on some SKUs should be ignored */
99 else if (numendpoints
<= 3)
102 num_ports
= (numendpoints
-1)/2;
106 static int is_blacklisted(const u8 ifnum
,
107 const struct sierra_iface_info
*blacklist
)
113 info
= blacklist
->ifaceinfo
;
115 for (i
= 0; i
< blacklist
->infolen
; i
++) {
116 if (info
[i
] == ifnum
)
123 static int is_himemory(const u8 ifnum
,
124 const struct sierra_iface_info
*himemorylist
)
130 info
= himemorylist
->ifaceinfo
;
132 for (i
=0; i
< himemorylist
->infolen
; i
++) {
133 if (info
[i
] == ifnum
)
140 static int sierra_calc_interface(struct usb_serial
*serial
)
143 struct usb_interface
*p_interface
;
144 struct usb_host_interface
*p_host_interface
;
146 /* Get the interface structure pointer from the serial struct */
147 p_interface
= serial
->interface
;
149 /* Get a pointer to the host interface structure */
150 p_host_interface
= p_interface
->cur_altsetting
;
152 /* read the interface descriptor for this active altsetting
153 * to find out the interface number we are on
155 interface
= p_host_interface
->desc
.bInterfaceNumber
;
160 static int sierra_probe(struct usb_serial
*serial
,
161 const struct usb_device_id
*id
)
164 struct usb_device
*udev
;
168 ifnum
= sierra_calc_interface(serial
);
171 * If this interface supports more than 1 alternate
174 if (serial
->interface
->num_altsetting
== 2) {
175 dev_dbg(&udev
->dev
, "Selecting alt setting for interface %d\n",
177 /* We know the alternate setting is 1 for the MC8785 */
178 usb_set_interface(udev
, ifnum
, 1);
181 /* ifnum could have changed - by calling usb_set_interface */
182 ifnum
= sierra_calc_interface(serial
);
184 if (is_blacklisted(ifnum
,
185 (struct sierra_iface_info
*)id
->driver_info
)) {
186 dev_dbg(&serial
->dev
->dev
,
187 "Ignoring blacklisted interface #%d\n", ifnum
);
194 /* interfaces with higher memory requirements */
195 static const u8 hi_memory_typeA_ifaces
[] = { 0, 2 };
196 static const struct sierra_iface_info typeA_interface_list
= {
197 .infolen
= ARRAY_SIZE(hi_memory_typeA_ifaces
),
198 .ifaceinfo
= hi_memory_typeA_ifaces
,
201 static const u8 hi_memory_typeB_ifaces
[] = { 3, 4, 5, 6 };
202 static const struct sierra_iface_info typeB_interface_list
= {
203 .infolen
= ARRAY_SIZE(hi_memory_typeB_ifaces
),
204 .ifaceinfo
= hi_memory_typeB_ifaces
,
207 /* 'blacklist' of interfaces not served by this driver */
208 static const u8 direct_ip_non_serial_ifaces
[] = { 7, 8, 9, 10, 11, 19, 20 };
209 static const struct sierra_iface_info direct_ip_interface_blacklist
= {
210 .infolen
= ARRAY_SIZE(direct_ip_non_serial_ifaces
),
211 .ifaceinfo
= direct_ip_non_serial_ifaces
,
214 static const struct usb_device_id id_table
[] = {
215 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
216 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
217 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
218 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
220 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
221 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
222 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
223 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
224 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
225 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
226 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
227 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
228 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
229 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
230 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
231 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
232 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
233 /* Sierra Wireless C597 */
234 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
235 /* Sierra Wireless T598 */
236 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
237 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
238 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
239 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
240 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
242 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
243 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
244 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
245 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
246 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
247 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
248 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
249 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
250 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
251 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
252 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
253 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
254 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
255 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
256 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
257 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
258 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
259 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
260 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
261 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
262 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
263 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
264 { USB_DEVICE(0x1199, 0x683C) },
265 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
266 /* Sierra Wireless MC8790, MC8791, MC8792 */
267 { USB_DEVICE(0x1199, 0x683E) },
268 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
269 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
270 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
271 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
272 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
273 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
274 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
275 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
276 /* Sierra Wireless C885 */
277 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
278 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
279 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
280 /* Sierra Wireless C22/C33 */
281 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
282 /* Sierra Wireless HSPA Non-Composite Device */
283 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
284 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
285 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
286 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
288 /* AT&T Direct IP LTE modems */
289 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
290 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
292 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */
293 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
298 MODULE_DEVICE_TABLE(usb
, id_table
);
301 struct sierra_port_private
{
302 spinlock_t lock
; /* lock the structure */
303 int outstanding_urbs
; /* number of out urbs in flight */
304 struct usb_anchor active
;
305 struct usb_anchor delayed
;
309 /* Input endpoints and buffers for this port */
310 struct urb
*in_urbs
[N_IN_URB_HM
];
312 /* Settings for the port */
313 int rts_state
; /* Handshaking pins (outputs) */
315 int cts_state
; /* Handshaking pins (inputs) */
319 unsigned int opened
:1;
322 static int sierra_send_setup(struct usb_serial_port
*port
)
324 struct usb_serial
*serial
= port
->serial
;
325 struct sierra_port_private
*portdata
;
331 portdata
= usb_get_serial_port_data(port
);
333 if (portdata
->dtr_state
)
335 if (portdata
->rts_state
)
338 /* If composite device then properly report interface */
339 if (serial
->num_ports
== 1) {
340 interface
= sierra_calc_interface(serial
);
341 /* Control message is sent only to interfaces with
342 * interrupt_in endpoints
344 if (port
->interrupt_in_urb
) {
345 /* send control message */
350 /* Otherwise the need to do non-composite mapping */
352 if (port
->bulk_out_endpointAddress
== 2)
354 else if (port
->bulk_out_endpointAddress
== 4)
356 else if (port
->bulk_out_endpointAddress
== 5)
364 retval
= usb_autopm_get_interface(serial
->interface
);
368 retval
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
369 0x22, 0x21, val
, interface
, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
370 usb_autopm_put_interface(serial
->interface
);
375 static void sierra_set_termios(struct tty_struct
*tty
,
376 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
378 tty_termios_copy_hw(&tty
->termios
, old_termios
);
379 sierra_send_setup(port
);
382 static int sierra_tiocmget(struct tty_struct
*tty
)
384 struct usb_serial_port
*port
= tty
->driver_data
;
386 struct sierra_port_private
*portdata
;
388 portdata
= usb_get_serial_port_data(port
);
390 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
391 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
392 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
393 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
394 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
395 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
400 static int sierra_tiocmset(struct tty_struct
*tty
,
401 unsigned int set
, unsigned int clear
)
403 struct usb_serial_port
*port
= tty
->driver_data
;
404 struct sierra_port_private
*portdata
;
406 portdata
= usb_get_serial_port_data(port
);
409 portdata
->rts_state
= 1;
411 portdata
->dtr_state
= 1;
413 if (clear
& TIOCM_RTS
)
414 portdata
->rts_state
= 0;
415 if (clear
& TIOCM_DTR
)
416 portdata
->dtr_state
= 0;
417 return sierra_send_setup(port
);
420 static void sierra_release_urb(struct urb
*urb
)
422 struct usb_serial_port
*port
;
425 kfree(urb
->transfer_buffer
);
430 static void sierra_outdat_callback(struct urb
*urb
)
432 struct usb_serial_port
*port
= urb
->context
;
433 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
434 struct sierra_intf_private
*intfdata
;
435 int status
= urb
->status
;
437 intfdata
= port
->serial
->private;
439 /* free up the transfer buffer, as usb_free_urb() does not do this */
440 kfree(urb
->transfer_buffer
);
441 usb_autopm_put_interface_async(port
->serial
->interface
);
443 dev_dbg(&port
->dev
, "%s - nonzero write bulk status "
444 "received: %d\n", __func__
, status
);
446 spin_lock(&portdata
->lock
);
447 --portdata
->outstanding_urbs
;
448 spin_unlock(&portdata
->lock
);
449 spin_lock(&intfdata
->susp_lock
);
450 --intfdata
->in_flight
;
451 spin_unlock(&intfdata
->susp_lock
);
453 usb_serial_port_softint(port
);
457 static int sierra_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
458 const unsigned char *buf
, int count
)
460 struct sierra_port_private
*portdata
;
461 struct sierra_intf_private
*intfdata
;
462 struct usb_serial
*serial
= port
->serial
;
464 unsigned char *buffer
;
466 size_t writesize
= min((size_t)count
, (size_t)MAX_TRANSFER
);
469 /* verify that we actually have some data to write */
473 portdata
= usb_get_serial_port_data(port
);
474 intfdata
= serial
->private;
476 dev_dbg(&port
->dev
, "%s: write (%zd bytes)\n", __func__
, writesize
);
477 spin_lock_irqsave(&portdata
->lock
, flags
);
478 dev_dbg(&port
->dev
, "%s - outstanding_urbs: %d\n", __func__
,
479 portdata
->outstanding_urbs
);
480 if (portdata
->outstanding_urbs
> portdata
->num_out_urbs
) {
481 spin_unlock_irqrestore(&portdata
->lock
, flags
);
482 dev_dbg(&port
->dev
, "%s - write limit hit\n", __func__
);
485 portdata
->outstanding_urbs
++;
486 dev_dbg(&port
->dev
, "%s - 1, outstanding_urbs: %d\n", __func__
,
487 portdata
->outstanding_urbs
);
488 spin_unlock_irqrestore(&portdata
->lock
, flags
);
490 retval
= usb_autopm_get_interface_async(serial
->interface
);
492 spin_lock_irqsave(&portdata
->lock
, flags
);
493 portdata
->outstanding_urbs
--;
494 spin_unlock_irqrestore(&portdata
->lock
, flags
);
498 buffer
= kmalloc(writesize
, GFP_ATOMIC
);
501 goto error_no_buffer
;
504 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
510 memcpy(buffer
, buf
, writesize
);
512 usb_serial_debug_data(&port
->dev
, __func__
, writesize
, buffer
);
514 usb_fill_bulk_urb(urb
, serial
->dev
,
515 usb_sndbulkpipe(serial
->dev
,
516 port
->bulk_out_endpointAddress
),
517 buffer
, writesize
, sierra_outdat_callback
, port
);
519 /* Handle the need to send a zero length packet */
520 urb
->transfer_flags
|= URB_ZERO_PACKET
;
522 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
524 if (intfdata
->suspended
) {
525 usb_anchor_urb(urb
, &portdata
->delayed
);
526 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
529 usb_anchor_urb(urb
, &portdata
->active
);
531 /* send it down the pipe */
532 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
534 usb_unanchor_urb(urb
);
535 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
536 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed "
537 "with status = %d\n", __func__
, retval
);
540 intfdata
->in_flight
++;
541 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
545 /* we are done with this urb, so let the host driver
546 * really free it when it is finished with it */
555 spin_lock_irqsave(&portdata
->lock
, flags
);
556 --portdata
->outstanding_urbs
;
557 dev_dbg(&port
->dev
, "%s - 2. outstanding_urbs: %d\n", __func__
,
558 portdata
->outstanding_urbs
);
559 spin_unlock_irqrestore(&portdata
->lock
, flags
);
560 usb_autopm_put_interface_async(serial
->interface
);
565 static void sierra_indat_callback(struct urb
*urb
)
569 struct usb_serial_port
*port
;
570 unsigned char *data
= urb
->transfer_buffer
;
571 int status
= urb
->status
;
573 endpoint
= usb_pipeendpoint(urb
->pipe
);
577 dev_dbg(&port
->dev
, "%s: nonzero status: %d on"
578 " endpoint %02x\n", __func__
, status
, endpoint
);
580 if (urb
->actual_length
) {
581 tty_insert_flip_string(&port
->port
, data
,
583 tty_flip_buffer_push(&port
->port
);
585 usb_serial_debug_data(&port
->dev
, __func__
,
586 urb
->actual_length
, data
);
588 dev_dbg(&port
->dev
, "%s: empty read urb"
589 " received\n", __func__
);
593 /* Resubmit urb so we continue receiving */
594 if (status
!= -ESHUTDOWN
&& status
!= -EPERM
) {
595 usb_mark_last_busy(port
->serial
->dev
);
596 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
597 if (err
&& err
!= -EPERM
)
598 dev_err(&port
->dev
, "resubmit read urb failed."
603 static void sierra_instat_callback(struct urb
*urb
)
606 int status
= urb
->status
;
607 struct usb_serial_port
*port
= urb
->context
;
608 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
609 struct usb_serial
*serial
= port
->serial
;
611 dev_dbg(&port
->dev
, "%s: urb %p port %p has data %p\n", __func__
,
612 urb
, port
, portdata
);
615 struct usb_ctrlrequest
*req_pkt
=
616 (struct usb_ctrlrequest
*)urb
->transfer_buffer
;
619 dev_dbg(&port
->dev
, "%s: NULL req_pkt\n",
623 if ((req_pkt
->bRequestType
== 0xA1) &&
624 (req_pkt
->bRequest
== 0x20)) {
626 unsigned char signals
= *((unsigned char *)
627 urb
->transfer_buffer
+
628 sizeof(struct usb_ctrlrequest
));
630 dev_dbg(&port
->dev
, "%s: signal x%x\n", __func__
,
633 old_dcd_state
= portdata
->dcd_state
;
634 portdata
->cts_state
= 1;
635 portdata
->dcd_state
= ((signals
& 0x01) ? 1 : 0);
636 portdata
->dsr_state
= ((signals
& 0x02) ? 1 : 0);
637 portdata
->ri_state
= ((signals
& 0x08) ? 1 : 0);
639 if (old_dcd_state
&& !portdata
->dcd_state
)
640 tty_port_tty_hangup(&port
->port
, true);
642 dev_dbg(&port
->dev
, "%s: type %x req %x\n",
643 __func__
, req_pkt
->bRequestType
,
647 dev_dbg(&port
->dev
, "%s: error %d\n", __func__
, status
);
649 /* Resubmit urb so we continue receiving IRQ data */
650 if (status
!= -ESHUTDOWN
&& status
!= -ENOENT
) {
651 usb_mark_last_busy(serial
->dev
);
652 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
653 if (err
&& err
!= -EPERM
)
654 dev_err(&port
->dev
, "%s: resubmit intr urb "
655 "failed. (%d)\n", __func__
, err
);
659 static int sierra_write_room(struct tty_struct
*tty
)
661 struct usb_serial_port
*port
= tty
->driver_data
;
662 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
665 /* try to give a good number back based on if we have any free urbs at
666 * this point in time */
667 spin_lock_irqsave(&portdata
->lock
, flags
);
668 if (portdata
->outstanding_urbs
> (portdata
->num_out_urbs
* 2) / 3) {
669 spin_unlock_irqrestore(&portdata
->lock
, flags
);
670 dev_dbg(&port
->dev
, "%s - write limit hit\n", __func__
);
673 spin_unlock_irqrestore(&portdata
->lock
, flags
);
678 static int sierra_chars_in_buffer(struct tty_struct
*tty
)
680 struct usb_serial_port
*port
= tty
->driver_data
;
681 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
685 /* NOTE: This overcounts somewhat. */
686 spin_lock_irqsave(&portdata
->lock
, flags
);
687 chars
= portdata
->outstanding_urbs
* MAX_TRANSFER
;
688 spin_unlock_irqrestore(&portdata
->lock
, flags
);
690 dev_dbg(&port
->dev
, "%s - %d\n", __func__
, chars
);
695 static void sierra_stop_rx_urbs(struct usb_serial_port
*port
)
698 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
700 for (i
= 0; i
< portdata
->num_in_urbs
; i
++)
701 usb_kill_urb(portdata
->in_urbs
[i
]);
703 usb_kill_urb(port
->interrupt_in_urb
);
706 static int sierra_submit_rx_urbs(struct usb_serial_port
*port
, gfp_t mem_flags
)
712 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
715 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
716 urb
= portdata
->in_urbs
[i
];
719 err
= usb_submit_urb(urb
, mem_flags
);
721 dev_err(&port
->dev
, "%s: submit urb failed: %d\n",
728 if (ok_cnt
&& port
->interrupt_in_urb
) {
729 err
= usb_submit_urb(port
->interrupt_in_urb
, mem_flags
);
731 dev_err(&port
->dev
, "%s: submit intr urb failed: %d\n",
736 if (ok_cnt
> 0) /* at least one rx urb submitted */
742 static struct urb
*sierra_setup_urb(struct usb_serial
*serial
, int endpoint
,
743 int dir
, void *ctx
, int len
,
745 usb_complete_t callback
)
753 urb
= usb_alloc_urb(0, mem_flags
);
757 buf
= kmalloc(len
, mem_flags
);
759 /* Fill URB using supplied data */
760 usb_fill_bulk_urb(urb
, serial
->dev
,
761 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
762 buf
, len
, callback
, ctx
);
764 dev_dbg(&serial
->dev
->dev
, "%s %c u : %p d:%p\n", __func__
,
765 dir
== USB_DIR_IN
? 'i' : 'o', urb
, buf
);
767 sierra_release_urb(urb
);
774 static void sierra_close(struct usb_serial_port
*port
)
777 struct usb_serial
*serial
= port
->serial
;
778 struct sierra_port_private
*portdata
;
779 struct sierra_intf_private
*intfdata
= port
->serial
->private;
782 portdata
= usb_get_serial_port_data(port
);
784 portdata
->rts_state
= 0;
785 portdata
->dtr_state
= 0;
787 mutex_lock(&serial
->disc_mutex
);
788 if (!serial
->disconnected
) {
789 /* odd error handling due to pm counters */
790 if (!usb_autopm_get_interface(serial
->interface
))
791 sierra_send_setup(port
);
793 usb_autopm_get_interface_no_resume(serial
->interface
);
796 mutex_unlock(&serial
->disc_mutex
);
797 spin_lock_irq(&intfdata
->susp_lock
);
798 portdata
->opened
= 0;
799 if (--intfdata
->open_ports
== 0)
800 serial
->interface
->needs_remote_wakeup
= 0;
801 spin_unlock_irq(&intfdata
->susp_lock
);
804 urb
= usb_get_from_anchor(&portdata
->delayed
);
807 kfree(urb
->transfer_buffer
);
809 usb_autopm_put_interface_async(serial
->interface
);
810 spin_lock(&portdata
->lock
);
811 portdata
->outstanding_urbs
--;
812 spin_unlock(&portdata
->lock
);
815 sierra_stop_rx_urbs(port
);
816 usb_kill_anchored_urbs(&portdata
->active
);
818 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
819 sierra_release_urb(portdata
->in_urbs
[i
]);
820 portdata
->in_urbs
[i
] = NULL
;
824 static int sierra_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
826 struct sierra_port_private
*portdata
;
827 struct usb_serial
*serial
= port
->serial
;
828 struct sierra_intf_private
*intfdata
= serial
->private;
834 portdata
= usb_get_serial_port_data(port
);
836 /* Set some sane defaults */
837 portdata
->rts_state
= 1;
838 portdata
->dtr_state
= 1;
841 endpoint
= port
->bulk_in_endpointAddress
;
842 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
843 urb
= sierra_setup_urb(serial
, endpoint
, USB_DIR_IN
, port
,
844 IN_BUFLEN
, GFP_KERNEL
,
845 sierra_indat_callback
);
846 portdata
->in_urbs
[i
] = urb
;
848 /* clear halt condition */
849 usb_clear_halt(serial
->dev
,
850 usb_sndbulkpipe(serial
->dev
, endpoint
) | USB_DIR_IN
);
852 err
= sierra_submit_rx_urbs(port
, GFP_KERNEL
);
856 sierra_send_setup(port
);
858 spin_lock_irq(&intfdata
->susp_lock
);
859 portdata
->opened
= 1;
860 if (++intfdata
->open_ports
== 1)
861 serial
->interface
->needs_remote_wakeup
= 1;
862 spin_unlock_irq(&intfdata
->susp_lock
);
863 usb_autopm_put_interface(serial
->interface
);
868 sierra_stop_rx_urbs(port
);
870 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
871 sierra_release_urb(portdata
->in_urbs
[i
]);
872 portdata
->in_urbs
[i
] = NULL
;
879 static void sierra_dtr_rts(struct usb_serial_port
*port
, int on
)
881 struct sierra_port_private
*portdata
;
883 portdata
= usb_get_serial_port_data(port
);
884 portdata
->rts_state
= on
;
885 portdata
->dtr_state
= on
;
887 sierra_send_setup(port
);
890 static int sierra_startup(struct usb_serial
*serial
)
892 struct sierra_intf_private
*intfdata
;
894 intfdata
= kzalloc(sizeof(*intfdata
), GFP_KERNEL
);
898 spin_lock_init(&intfdata
->susp_lock
);
900 usb_set_serial_data(serial
, intfdata
);
902 /* Set Device mode to D0 */
903 sierra_set_power_state(serial
->dev
, 0x0000);
905 /* Check NMEA and set */
907 sierra_vsc_set_nmea(serial
->dev
, 1);
912 static void sierra_release(struct usb_serial
*serial
)
914 struct sierra_intf_private
*intfdata
;
916 intfdata
= usb_get_serial_data(serial
);
920 static int sierra_port_probe(struct usb_serial_port
*port
)
922 struct usb_serial
*serial
= port
->serial
;
923 struct sierra_port_private
*portdata
;
924 const struct sierra_iface_info
*himemoryp
;
927 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
931 spin_lock_init(&portdata
->lock
);
932 init_usb_anchor(&portdata
->active
);
933 init_usb_anchor(&portdata
->delayed
);
935 /* Assume low memory requirements */
936 portdata
->num_out_urbs
= N_OUT_URB
;
937 portdata
->num_in_urbs
= N_IN_URB
;
939 /* Determine actual memory requirements */
940 if (serial
->num_ports
== 1) {
941 /* Get interface number for composite device */
942 ifnum
= sierra_calc_interface(serial
);
943 himemoryp
= &typeB_interface_list
;
945 /* This is really the usb-serial port number of the interface
946 * rather than the interface number.
948 ifnum
= port
->port_number
;
949 himemoryp
= &typeA_interface_list
;
952 if (is_himemory(ifnum
, himemoryp
)) {
953 portdata
->num_out_urbs
= N_OUT_URB_HM
;
954 portdata
->num_in_urbs
= N_IN_URB_HM
;
958 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
959 ifnum
, portdata
->num_in_urbs
, portdata
->num_out_urbs
);
961 usb_set_serial_port_data(port
, portdata
);
966 static int sierra_port_remove(struct usb_serial_port
*port
)
968 struct sierra_port_private
*portdata
;
970 portdata
= usb_get_serial_port_data(port
);
971 usb_set_serial_port_data(port
, NULL
);
978 static void stop_read_write_urbs(struct usb_serial
*serial
)
981 struct usb_serial_port
*port
;
982 struct sierra_port_private
*portdata
;
984 /* Stop reading/writing urbs */
985 for (i
= 0; i
< serial
->num_ports
; ++i
) {
986 port
= serial
->port
[i
];
987 portdata
= usb_get_serial_port_data(port
);
990 sierra_stop_rx_urbs(port
);
991 usb_kill_anchored_urbs(&portdata
->active
);
995 static int sierra_suspend(struct usb_serial
*serial
, pm_message_t message
)
997 struct sierra_intf_private
*intfdata
;
1000 if (PMSG_IS_AUTO(message
)) {
1001 intfdata
= serial
->private;
1002 spin_lock_irq(&intfdata
->susp_lock
);
1003 b
= intfdata
->in_flight
;
1006 spin_unlock_irq(&intfdata
->susp_lock
);
1009 intfdata
->suspended
= 1;
1010 spin_unlock_irq(&intfdata
->susp_lock
);
1013 stop_read_write_urbs(serial
);
1018 static int sierra_resume(struct usb_serial
*serial
)
1020 struct usb_serial_port
*port
;
1021 struct sierra_intf_private
*intfdata
= serial
->private;
1022 struct sierra_port_private
*portdata
;
1027 spin_lock_irq(&intfdata
->susp_lock
);
1028 for (i
= 0; i
< serial
->num_ports
; i
++) {
1029 port
= serial
->port
[i
];
1030 portdata
= usb_get_serial_port_data(port
);
1035 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
1036 usb_anchor_urb(urb
, &portdata
->active
);
1037 intfdata
->in_flight
++;
1038 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
1041 "%s - submit urb failed: %d",
1044 intfdata
->in_flight
--;
1045 usb_unanchor_urb(urb
);
1046 kfree(urb
->transfer_buffer
);
1048 spin_lock(&portdata
->lock
);
1049 portdata
->outstanding_urbs
--;
1050 spin_unlock(&portdata
->lock
);
1055 if (portdata
->opened
) {
1056 err
= sierra_submit_rx_urbs(port
, GFP_ATOMIC
);
1061 intfdata
->suspended
= 0;
1062 spin_unlock_irq(&intfdata
->susp_lock
);
1064 return ec
? -EIO
: 0;
1068 #define sierra_suspend NULL
1069 #define sierra_resume NULL
1072 static struct usb_serial_driver sierra_device
= {
1074 .owner
= THIS_MODULE
,
1077 .description
= "Sierra USB modem",
1078 .id_table
= id_table
,
1079 .calc_num_ports
= sierra_calc_num_ports
,
1080 .probe
= sierra_probe
,
1081 .open
= sierra_open
,
1082 .close
= sierra_close
,
1083 .dtr_rts
= sierra_dtr_rts
,
1084 .write
= sierra_write
,
1085 .write_room
= sierra_write_room
,
1086 .chars_in_buffer
= sierra_chars_in_buffer
,
1087 .set_termios
= sierra_set_termios
,
1088 .tiocmget
= sierra_tiocmget
,
1089 .tiocmset
= sierra_tiocmset
,
1090 .attach
= sierra_startup
,
1091 .release
= sierra_release
,
1092 .port_probe
= sierra_port_probe
,
1093 .port_remove
= sierra_port_remove
,
1094 .suspend
= sierra_suspend
,
1095 .resume
= sierra_resume
,
1096 .read_int_callback
= sierra_instat_callback
,
1099 static struct usb_serial_driver
* const serial_drivers
[] = {
1100 &sierra_device
, NULL
1103 module_usb_serial_driver(serial_drivers
, id_table
);
1105 MODULE_AUTHOR(DRIVER_AUTHOR
);
1106 MODULE_DESCRIPTION(DRIVER_DESC
);
1107 MODULE_LICENSE("GPL");
1109 module_param(nmea
, bool, S_IRUGO
| S_IWUSR
);
1110 MODULE_PARM_DESC(nmea
, "NMEA streaming");