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 /* Sierra Wireless Direct IP modems */
286 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68A3, 0xFF, 0xFF, 0xFF),
287 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
289 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68AA, 0xFF, 0xFF, 0xFF),
290 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
292 { USB_DEVICE(0x1199, 0x68AB) }, /* Sierra Wireless AR8550 */
293 /* AT&T Direct IP LTE modems */
294 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
295 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
297 /* Airprime/Sierra Wireless Direct IP modems */
298 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
299 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
304 MODULE_DEVICE_TABLE(usb
, id_table
);
307 struct sierra_port_private
{
308 spinlock_t lock
; /* lock the structure */
309 int outstanding_urbs
; /* number of out urbs in flight */
310 struct usb_anchor active
;
311 struct usb_anchor delayed
;
315 /* Input endpoints and buffers for this port */
316 struct urb
*in_urbs
[N_IN_URB_HM
];
318 /* Settings for the port */
319 int rts_state
; /* Handshaking pins (outputs) */
321 int cts_state
; /* Handshaking pins (inputs) */
327 static int sierra_send_setup(struct usb_serial_port
*port
)
329 struct usb_serial
*serial
= port
->serial
;
330 struct sierra_port_private
*portdata
;
336 portdata
= usb_get_serial_port_data(port
);
338 if (portdata
->dtr_state
)
340 if (portdata
->rts_state
)
343 /* If composite device then properly report interface */
344 if (serial
->num_ports
== 1) {
345 interface
= sierra_calc_interface(serial
);
346 /* Control message is sent only to interfaces with
347 * interrupt_in endpoints
349 if (port
->interrupt_in_urb
) {
350 /* send control message */
355 /* Otherwise the need to do non-composite mapping */
357 if (port
->bulk_out_endpointAddress
== 2)
359 else if (port
->bulk_out_endpointAddress
== 4)
361 else if (port
->bulk_out_endpointAddress
== 5)
369 retval
= usb_autopm_get_interface(serial
->interface
);
373 retval
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
374 0x22, 0x21, val
, interface
, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
375 usb_autopm_put_interface(serial
->interface
);
380 static int sierra_tiocmget(struct tty_struct
*tty
)
382 struct usb_serial_port
*port
= tty
->driver_data
;
384 struct sierra_port_private
*portdata
;
386 portdata
= usb_get_serial_port_data(port
);
388 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
389 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
390 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
391 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
392 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
393 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
398 static int sierra_tiocmset(struct tty_struct
*tty
,
399 unsigned int set
, unsigned int clear
)
401 struct usb_serial_port
*port
= tty
->driver_data
;
402 struct sierra_port_private
*portdata
;
404 portdata
= usb_get_serial_port_data(port
);
407 portdata
->rts_state
= 1;
409 portdata
->dtr_state
= 1;
411 if (clear
& TIOCM_RTS
)
412 portdata
->rts_state
= 0;
413 if (clear
& TIOCM_DTR
)
414 portdata
->dtr_state
= 0;
415 return sierra_send_setup(port
);
418 static void sierra_release_urb(struct urb
*urb
)
421 kfree(urb
->transfer_buffer
);
426 static void sierra_outdat_callback(struct urb
*urb
)
428 struct usb_serial_port
*port
= urb
->context
;
429 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
430 struct sierra_intf_private
*intfdata
;
431 int status
= urb
->status
;
433 intfdata
= usb_get_serial_data(port
->serial
);
435 /* free up the transfer buffer, as usb_free_urb() does not do this */
436 kfree(urb
->transfer_buffer
);
437 usb_autopm_put_interface_async(port
->serial
->interface
);
439 dev_dbg(&port
->dev
, "%s - nonzero write bulk status "
440 "received: %d\n", __func__
, status
);
442 spin_lock(&portdata
->lock
);
443 --portdata
->outstanding_urbs
;
444 spin_unlock(&portdata
->lock
);
445 spin_lock(&intfdata
->susp_lock
);
446 --intfdata
->in_flight
;
447 spin_unlock(&intfdata
->susp_lock
);
449 usb_serial_port_softint(port
);
453 static int sierra_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
454 const unsigned char *buf
, int count
)
456 struct sierra_port_private
*portdata
;
457 struct sierra_intf_private
*intfdata
;
458 struct usb_serial
*serial
= port
->serial
;
460 unsigned char *buffer
;
462 size_t writesize
= min((size_t)count
, (size_t)MAX_TRANSFER
);
465 /* verify that we actually have some data to write */
469 portdata
= usb_get_serial_port_data(port
);
470 intfdata
= usb_get_serial_data(serial
);
472 dev_dbg(&port
->dev
, "%s: write (%zd bytes)\n", __func__
, writesize
);
473 spin_lock_irqsave(&portdata
->lock
, flags
);
474 dev_dbg(&port
->dev
, "%s - outstanding_urbs: %d\n", __func__
,
475 portdata
->outstanding_urbs
);
476 if (portdata
->outstanding_urbs
> portdata
->num_out_urbs
) {
477 spin_unlock_irqrestore(&portdata
->lock
, flags
);
478 dev_dbg(&port
->dev
, "%s - write limit hit\n", __func__
);
481 portdata
->outstanding_urbs
++;
482 dev_dbg(&port
->dev
, "%s - 1, outstanding_urbs: %d\n", __func__
,
483 portdata
->outstanding_urbs
);
484 spin_unlock_irqrestore(&portdata
->lock
, flags
);
486 retval
= usb_autopm_get_interface_async(serial
->interface
);
488 spin_lock_irqsave(&portdata
->lock
, flags
);
489 portdata
->outstanding_urbs
--;
490 spin_unlock_irqrestore(&portdata
->lock
, flags
);
494 buffer
= kmalloc(writesize
, GFP_ATOMIC
);
497 goto error_no_buffer
;
500 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
506 memcpy(buffer
, buf
, writesize
);
508 usb_serial_debug_data(&port
->dev
, __func__
, writesize
, buffer
);
510 usb_fill_bulk_urb(urb
, serial
->dev
,
511 usb_sndbulkpipe(serial
->dev
,
512 port
->bulk_out_endpointAddress
),
513 buffer
, writesize
, sierra_outdat_callback
, port
);
515 /* Handle the need to send a zero length packet */
516 urb
->transfer_flags
|= URB_ZERO_PACKET
;
518 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
520 if (intfdata
->suspended
) {
521 usb_anchor_urb(urb
, &portdata
->delayed
);
522 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
525 usb_anchor_urb(urb
, &portdata
->active
);
527 /* send it down the pipe */
528 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
530 usb_unanchor_urb(urb
);
531 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
532 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed "
533 "with status = %d\n", __func__
, retval
);
536 intfdata
->in_flight
++;
537 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
541 /* we are done with this urb, so let the host driver
542 * really free it when it is finished with it */
551 spin_lock_irqsave(&portdata
->lock
, flags
);
552 --portdata
->outstanding_urbs
;
553 dev_dbg(&port
->dev
, "%s - 2. outstanding_urbs: %d\n", __func__
,
554 portdata
->outstanding_urbs
);
555 spin_unlock_irqrestore(&portdata
->lock
, flags
);
556 usb_autopm_put_interface_async(serial
->interface
);
561 static void sierra_indat_callback(struct urb
*urb
)
565 struct usb_serial_port
*port
;
566 unsigned char *data
= urb
->transfer_buffer
;
567 int status
= urb
->status
;
569 endpoint
= usb_pipeendpoint(urb
->pipe
);
573 dev_dbg(&port
->dev
, "%s: nonzero status: %d on"
574 " endpoint %02x\n", __func__
, status
, endpoint
);
576 if (urb
->actual_length
) {
577 tty_insert_flip_string(&port
->port
, data
,
579 tty_flip_buffer_push(&port
->port
);
581 usb_serial_debug_data(&port
->dev
, __func__
,
582 urb
->actual_length
, data
);
584 dev_dbg(&port
->dev
, "%s: empty read urb"
585 " received\n", __func__
);
589 /* Resubmit urb so we continue receiving */
590 if (status
!= -ESHUTDOWN
&& status
!= -EPERM
) {
591 usb_mark_last_busy(port
->serial
->dev
);
592 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
593 if (err
&& err
!= -EPERM
)
594 dev_err(&port
->dev
, "resubmit read urb failed."
599 static void sierra_instat_callback(struct urb
*urb
)
602 int status
= urb
->status
;
603 struct usb_serial_port
*port
= urb
->context
;
604 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
605 struct usb_serial
*serial
= port
->serial
;
607 dev_dbg(&port
->dev
, "%s: urb %p port %p has data %p\n", __func__
,
608 urb
, port
, portdata
);
611 struct usb_ctrlrequest
*req_pkt
=
612 (struct usb_ctrlrequest
*)urb
->transfer_buffer
;
615 dev_dbg(&port
->dev
, "%s: NULL req_pkt\n",
619 if ((req_pkt
->bRequestType
== 0xA1) &&
620 (req_pkt
->bRequest
== 0x20)) {
622 unsigned char signals
= *((unsigned char *)
623 urb
->transfer_buffer
+
624 sizeof(struct usb_ctrlrequest
));
626 dev_dbg(&port
->dev
, "%s: signal x%x\n", __func__
,
629 old_dcd_state
= portdata
->dcd_state
;
630 portdata
->cts_state
= 1;
631 portdata
->dcd_state
= ((signals
& 0x01) ? 1 : 0);
632 portdata
->dsr_state
= ((signals
& 0x02) ? 1 : 0);
633 portdata
->ri_state
= ((signals
& 0x08) ? 1 : 0);
635 if (old_dcd_state
&& !portdata
->dcd_state
)
636 tty_port_tty_hangup(&port
->port
, true);
638 dev_dbg(&port
->dev
, "%s: type %x req %x\n",
639 __func__
, req_pkt
->bRequestType
,
643 dev_dbg(&port
->dev
, "%s: error %d\n", __func__
, status
);
645 /* Resubmit urb so we continue receiving IRQ data */
646 if (status
!= -ESHUTDOWN
&& status
!= -ENOENT
) {
647 usb_mark_last_busy(serial
->dev
);
648 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
649 if (err
&& err
!= -EPERM
)
650 dev_err(&port
->dev
, "%s: resubmit intr urb "
651 "failed. (%d)\n", __func__
, err
);
655 static int sierra_write_room(struct tty_struct
*tty
)
657 struct usb_serial_port
*port
= tty
->driver_data
;
658 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
661 /* try to give a good number back based on if we have any free urbs at
662 * this point in time */
663 spin_lock_irqsave(&portdata
->lock
, flags
);
664 if (portdata
->outstanding_urbs
> (portdata
->num_out_urbs
* 2) / 3) {
665 spin_unlock_irqrestore(&portdata
->lock
, flags
);
666 dev_dbg(&port
->dev
, "%s - write limit hit\n", __func__
);
669 spin_unlock_irqrestore(&portdata
->lock
, flags
);
674 static int sierra_chars_in_buffer(struct tty_struct
*tty
)
676 struct usb_serial_port
*port
= tty
->driver_data
;
677 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
681 /* NOTE: This overcounts somewhat. */
682 spin_lock_irqsave(&portdata
->lock
, flags
);
683 chars
= portdata
->outstanding_urbs
* MAX_TRANSFER
;
684 spin_unlock_irqrestore(&portdata
->lock
, flags
);
686 dev_dbg(&port
->dev
, "%s - %d\n", __func__
, chars
);
691 static void sierra_stop_rx_urbs(struct usb_serial_port
*port
)
694 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
696 for (i
= 0; i
< portdata
->num_in_urbs
; i
++)
697 usb_kill_urb(portdata
->in_urbs
[i
]);
699 usb_kill_urb(port
->interrupt_in_urb
);
702 static int sierra_submit_rx_urbs(struct usb_serial_port
*port
, gfp_t mem_flags
)
708 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
711 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
712 urb
= portdata
->in_urbs
[i
];
715 err
= usb_submit_urb(urb
, mem_flags
);
717 dev_err(&port
->dev
, "%s: submit urb failed: %d\n",
724 if (ok_cnt
&& port
->interrupt_in_urb
) {
725 err
= usb_submit_urb(port
->interrupt_in_urb
, mem_flags
);
727 dev_err(&port
->dev
, "%s: submit intr urb failed: %d\n",
732 if (ok_cnt
> 0) /* at least one rx urb submitted */
738 static struct urb
*sierra_setup_urb(struct usb_serial
*serial
, int endpoint
,
739 int dir
, void *ctx
, int len
,
741 usb_complete_t callback
)
746 urb
= usb_alloc_urb(0, mem_flags
);
750 buf
= kmalloc(len
, mem_flags
);
752 /* Fill URB using supplied data */
753 usb_fill_bulk_urb(urb
, serial
->dev
,
754 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
755 buf
, len
, callback
, ctx
);
757 dev_dbg(&serial
->dev
->dev
, "%s %c u : %p d:%p\n", __func__
,
758 dir
== USB_DIR_IN
? 'i' : 'o', urb
, buf
);
760 sierra_release_urb(urb
);
767 static void sierra_close(struct usb_serial_port
*port
)
770 struct usb_serial
*serial
= port
->serial
;
771 struct sierra_port_private
*portdata
;
772 struct sierra_intf_private
*intfdata
= usb_get_serial_data(serial
);
775 portdata
= usb_get_serial_port_data(port
);
778 * Need to take susp_lock to make sure port is not already being
779 * resumed, but no need to hold it due to initialized
781 spin_lock_irq(&intfdata
->susp_lock
);
782 if (--intfdata
->open_ports
== 0)
783 serial
->interface
->needs_remote_wakeup
= 0;
784 spin_unlock_irq(&intfdata
->susp_lock
);
787 urb
= usb_get_from_anchor(&portdata
->delayed
);
790 kfree(urb
->transfer_buffer
);
792 usb_autopm_put_interface_async(serial
->interface
);
793 spin_lock(&portdata
->lock
);
794 portdata
->outstanding_urbs
--;
795 spin_unlock(&portdata
->lock
);
798 sierra_stop_rx_urbs(port
);
799 usb_kill_anchored_urbs(&portdata
->active
);
801 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
802 sierra_release_urb(portdata
->in_urbs
[i
]);
803 portdata
->in_urbs
[i
] = NULL
;
806 usb_autopm_get_interface_no_resume(serial
->interface
);
809 static int sierra_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
811 struct sierra_port_private
*portdata
;
812 struct usb_serial
*serial
= port
->serial
;
813 struct sierra_intf_private
*intfdata
= usb_get_serial_data(serial
);
819 portdata
= usb_get_serial_port_data(port
);
821 endpoint
= port
->bulk_in_endpointAddress
;
822 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
823 urb
= sierra_setup_urb(serial
, endpoint
, USB_DIR_IN
, port
,
824 IN_BUFLEN
, GFP_KERNEL
,
825 sierra_indat_callback
);
826 portdata
->in_urbs
[i
] = urb
;
828 /* clear halt condition */
829 usb_clear_halt(serial
->dev
,
830 usb_sndbulkpipe(serial
->dev
, endpoint
) | USB_DIR_IN
);
832 err
= sierra_submit_rx_urbs(port
, GFP_KERNEL
);
836 spin_lock_irq(&intfdata
->susp_lock
);
837 if (++intfdata
->open_ports
== 1)
838 serial
->interface
->needs_remote_wakeup
= 1;
839 spin_unlock_irq(&intfdata
->susp_lock
);
840 usb_autopm_put_interface(serial
->interface
);
845 sierra_stop_rx_urbs(port
);
847 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
848 sierra_release_urb(portdata
->in_urbs
[i
]);
849 portdata
->in_urbs
[i
] = NULL
;
856 static void sierra_dtr_rts(struct usb_serial_port
*port
, int on
)
858 struct sierra_port_private
*portdata
;
860 portdata
= usb_get_serial_port_data(port
);
861 portdata
->rts_state
= on
;
862 portdata
->dtr_state
= on
;
864 sierra_send_setup(port
);
867 static int sierra_startup(struct usb_serial
*serial
)
869 struct sierra_intf_private
*intfdata
;
871 intfdata
= kzalloc(sizeof(*intfdata
), GFP_KERNEL
);
875 spin_lock_init(&intfdata
->susp_lock
);
877 usb_set_serial_data(serial
, intfdata
);
879 /* Set Device mode to D0 */
880 sierra_set_power_state(serial
->dev
, 0x0000);
882 /* Check NMEA and set */
884 sierra_vsc_set_nmea(serial
->dev
, 1);
889 static void sierra_release(struct usb_serial
*serial
)
891 struct sierra_intf_private
*intfdata
;
893 intfdata
= usb_get_serial_data(serial
);
897 static int sierra_port_probe(struct usb_serial_port
*port
)
899 struct usb_serial
*serial
= port
->serial
;
900 struct sierra_port_private
*portdata
;
901 const struct sierra_iface_info
*himemoryp
;
904 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
908 spin_lock_init(&portdata
->lock
);
909 init_usb_anchor(&portdata
->active
);
910 init_usb_anchor(&portdata
->delayed
);
912 /* Assume low memory requirements */
913 portdata
->num_out_urbs
= N_OUT_URB
;
914 portdata
->num_in_urbs
= N_IN_URB
;
916 /* Determine actual memory requirements */
917 if (serial
->num_ports
== 1) {
918 /* Get interface number for composite device */
919 ifnum
= sierra_calc_interface(serial
);
920 himemoryp
= &typeB_interface_list
;
922 /* This is really the usb-serial port number of the interface
923 * rather than the interface number.
925 ifnum
= port
->port_number
;
926 himemoryp
= &typeA_interface_list
;
929 if (is_himemory(ifnum
, himemoryp
)) {
930 portdata
->num_out_urbs
= N_OUT_URB_HM
;
931 portdata
->num_in_urbs
= N_IN_URB_HM
;
935 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
936 ifnum
, portdata
->num_in_urbs
, portdata
->num_out_urbs
);
938 usb_set_serial_port_data(port
, portdata
);
943 static int sierra_port_remove(struct usb_serial_port
*port
)
945 struct sierra_port_private
*portdata
;
947 portdata
= usb_get_serial_port_data(port
);
948 usb_set_serial_port_data(port
, NULL
);
955 static void stop_read_write_urbs(struct usb_serial
*serial
)
958 struct usb_serial_port
*port
;
959 struct sierra_port_private
*portdata
;
961 /* Stop reading/writing urbs */
962 for (i
= 0; i
< serial
->num_ports
; ++i
) {
963 port
= serial
->port
[i
];
964 portdata
= usb_get_serial_port_data(port
);
967 sierra_stop_rx_urbs(port
);
968 usb_kill_anchored_urbs(&portdata
->active
);
972 static int sierra_suspend(struct usb_serial
*serial
, pm_message_t message
)
974 struct sierra_intf_private
*intfdata
= usb_get_serial_data(serial
);
976 spin_lock_irq(&intfdata
->susp_lock
);
977 if (PMSG_IS_AUTO(message
)) {
978 if (intfdata
->in_flight
) {
979 spin_unlock_irq(&intfdata
->susp_lock
);
983 intfdata
->suspended
= 1;
984 spin_unlock_irq(&intfdata
->susp_lock
);
986 stop_read_write_urbs(serial
);
991 /* Caller must hold susp_lock. */
992 static int sierra_submit_delayed_urbs(struct usb_serial_port
*port
)
994 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
995 struct sierra_intf_private
*intfdata
;
1000 intfdata
= usb_get_serial_data(port
->serial
);
1003 urb
= usb_get_from_anchor(&portdata
->delayed
);
1007 usb_anchor_urb(urb
, &portdata
->active
);
1008 intfdata
->in_flight
++;
1009 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
1011 dev_err(&port
->dev
, "%s - submit urb failed: %d",
1014 intfdata
->in_flight
--;
1015 usb_unanchor_urb(urb
);
1016 kfree(urb
->transfer_buffer
);
1019 spin_lock(&portdata
->lock
);
1020 portdata
->outstanding_urbs
--;
1021 spin_unlock(&portdata
->lock
);
1031 static int sierra_resume(struct usb_serial
*serial
)
1033 struct usb_serial_port
*port
;
1034 struct sierra_intf_private
*intfdata
= usb_get_serial_data(serial
);
1038 spin_lock_irq(&intfdata
->susp_lock
);
1039 for (i
= 0; i
< serial
->num_ports
; i
++) {
1040 port
= serial
->port
[i
];
1042 if (!tty_port_initialized(&port
->port
))
1045 err
= sierra_submit_delayed_urbs(port
);
1049 err
= sierra_submit_rx_urbs(port
, GFP_ATOMIC
);
1053 intfdata
->suspended
= 0;
1054 spin_unlock_irq(&intfdata
->susp_lock
);
1056 return ec
? -EIO
: 0;
1060 #define sierra_suspend NULL
1061 #define sierra_resume NULL
1064 static struct usb_serial_driver sierra_device
= {
1066 .owner
= THIS_MODULE
,
1069 .description
= "Sierra USB modem",
1070 .id_table
= id_table
,
1071 .calc_num_ports
= sierra_calc_num_ports
,
1072 .probe
= sierra_probe
,
1073 .open
= sierra_open
,
1074 .close
= sierra_close
,
1075 .dtr_rts
= sierra_dtr_rts
,
1076 .write
= sierra_write
,
1077 .write_room
= sierra_write_room
,
1078 .chars_in_buffer
= sierra_chars_in_buffer
,
1079 .tiocmget
= sierra_tiocmget
,
1080 .tiocmset
= sierra_tiocmset
,
1081 .attach
= sierra_startup
,
1082 .release
= sierra_release
,
1083 .port_probe
= sierra_port_probe
,
1084 .port_remove
= sierra_port_remove
,
1085 .suspend
= sierra_suspend
,
1086 .resume
= sierra_resume
,
1087 .read_int_callback
= sierra_instat_callback
,
1090 static struct usb_serial_driver
* const serial_drivers
[] = {
1091 &sierra_device
, NULL
1094 module_usb_serial_driver(serial_drivers
, id_table
);
1096 MODULE_AUTHOR(DRIVER_AUTHOR
);
1097 MODULE_DESCRIPTION(DRIVER_DESC
);
1098 MODULE_LICENSE("GPL");
1100 module_param(nmea
, bool, S_IRUGO
| S_IWUSR
);
1101 MODULE_PARM_DESC(nmea
, "NMEA streaming");