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 */
21 #define DRIVER_VERSION "v.1.7.16"
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/tty_flip.h>
30 #include <linux/module.h>
31 #include <linux/usb.h>
32 #include <linux/usb/serial.h>
34 #define SWIMS_USB_REQUEST_SetPower 0x00
35 #define SWIMS_USB_REQUEST_SetNmea 0x07
38 #define N_OUT_URB_HM 64
41 #define IN_BUFLEN 4096
43 #define MAX_TRANSFER (PAGE_SIZE - 512)
44 /* MAX_TRANSFER is chosen so that the VM is not stressed by
45 allocations > PAGE_SIZE and the number of packets in a page
46 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;
63 static int sierra_set_power_state(struct usb_device
*udev
, __u16 swiState
)
66 dev_dbg(&udev
->dev
, "%s\n", __func__
);
67 result
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
68 SWIMS_USB_REQUEST_SetPower
, /* __u8 request */
69 USB_TYPE_VENDOR
, /* __u8 request type */
70 swiState
, /* __u16 value */
72 NULL
, /* void *data */
74 USB_CTRL_SET_TIMEOUT
); /* int timeout */
78 static int sierra_vsc_set_nmea(struct usb_device
*udev
, __u16 enable
)
81 dev_dbg(&udev
->dev
, "%s\n", __func__
);
82 result
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
83 SWIMS_USB_REQUEST_SetNmea
, /* __u8 request */
84 USB_TYPE_VENDOR
, /* __u8 request type */
85 enable
, /* __u16 value */
86 0x0000, /* __u16 index */
87 NULL
, /* void *data */
89 USB_CTRL_SET_TIMEOUT
); /* int timeout */
93 static int sierra_calc_num_ports(struct usb_serial
*serial
)
96 u8 ifnum
, numendpoints
;
98 dev_dbg(&serial
->dev
->dev
, "%s\n", __func__
);
100 ifnum
= serial
->interface
->cur_altsetting
->desc
.bInterfaceNumber
;
101 numendpoints
= serial
->interface
->cur_altsetting
->desc
.bNumEndpoints
;
103 /* Dummy interface present on some SKUs should be ignored */
106 else if (numendpoints
<= 3)
109 num_ports
= (numendpoints
-1)/2;
113 static int is_blacklisted(const u8 ifnum
,
114 const struct sierra_iface_info
*blacklist
)
120 info
= blacklist
->ifaceinfo
;
122 for (i
= 0; i
< blacklist
->infolen
; i
++) {
123 if (info
[i
] == ifnum
)
130 static int is_himemory(const u8 ifnum
,
131 const struct sierra_iface_info
*himemorylist
)
137 info
= himemorylist
->ifaceinfo
;
139 for (i
=0; i
< himemorylist
->infolen
; i
++) {
140 if (info
[i
] == ifnum
)
147 static int sierra_calc_interface(struct usb_serial
*serial
)
150 struct usb_interface
*p_interface
;
151 struct usb_host_interface
*p_host_interface
;
152 dev_dbg(&serial
->dev
->dev
, "%s\n", __func__
);
154 /* Get the interface structure pointer from the serial struct */
155 p_interface
= serial
->interface
;
157 /* Get a pointer to the host interface structure */
158 p_host_interface
= p_interface
->cur_altsetting
;
160 /* read the interface descriptor for this active altsetting
161 * to find out the interface number we are on
163 interface
= p_host_interface
->desc
.bInterfaceNumber
;
168 static int sierra_probe(struct usb_serial
*serial
,
169 const struct usb_device_id
*id
)
172 struct usb_device
*udev
;
173 struct sierra_intf_private
*data
;
177 dev_dbg(&udev
->dev
, "%s\n", __func__
);
179 ifnum
= sierra_calc_interface(serial
);
181 * If this interface supports more than 1 alternate
184 if (serial
->interface
->num_altsetting
== 2) {
185 dev_dbg(&udev
->dev
, "Selecting alt setting for interface %d\n",
187 /* We know the alternate setting is 1 for the MC8785 */
188 usb_set_interface(udev
, ifnum
, 1);
191 /* ifnum could have changed - by calling usb_set_interface */
192 ifnum
= sierra_calc_interface(serial
);
194 if (is_blacklisted(ifnum
,
195 (struct sierra_iface_info
*)id
->driver_info
)) {
196 dev_dbg(&serial
->dev
->dev
,
197 "Ignoring blacklisted interface #%d\n", ifnum
);
201 data
= serial
->private = kzalloc(sizeof(struct sierra_intf_private
), GFP_KERNEL
);
204 spin_lock_init(&data
->susp_lock
);
209 /* interfaces with higher memory requirements */
210 static const u8 hi_memory_typeA_ifaces
[] = { 0, 2 };
211 static const struct sierra_iface_info typeA_interface_list
= {
212 .infolen
= ARRAY_SIZE(hi_memory_typeA_ifaces
),
213 .ifaceinfo
= hi_memory_typeA_ifaces
,
216 static const u8 hi_memory_typeB_ifaces
[] = { 3, 4, 5, 6 };
217 static const struct sierra_iface_info typeB_interface_list
= {
218 .infolen
= ARRAY_SIZE(hi_memory_typeB_ifaces
),
219 .ifaceinfo
= hi_memory_typeB_ifaces
,
222 /* 'blacklist' of interfaces not served by this driver */
223 static const u8 direct_ip_non_serial_ifaces
[] = { 7, 8, 9, 10, 11 };
224 static const struct sierra_iface_info direct_ip_interface_blacklist
= {
225 .infolen
= ARRAY_SIZE(direct_ip_non_serial_ifaces
),
226 .ifaceinfo
= direct_ip_non_serial_ifaces
,
229 static struct usb_device_id id_table
[] = {
230 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
231 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
232 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
234 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
235 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
236 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
237 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
238 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
239 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
240 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
241 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
242 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
243 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
244 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
245 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
246 /* Sierra Wireless C597 */
247 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
248 /* Sierra Wireless T598 */
249 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
250 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
251 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
252 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
253 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
255 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
256 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
257 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
258 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
259 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
260 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
261 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
262 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
263 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
264 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
265 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
266 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
267 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
268 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
269 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
270 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
271 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
272 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
273 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
274 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
275 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
276 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
277 { USB_DEVICE(0x1199, 0x683C) },
278 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
279 /* Sierra Wireless MC8790, MC8791, MC8792 */
280 { USB_DEVICE(0x1199, 0x683E) },
281 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
282 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
283 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
284 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
285 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
286 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
287 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
288 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
289 /* Sierra Wireless C885 */
290 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
291 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
292 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
293 /* Sierra Wireless C22/C33 */
294 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
295 /* Sierra Wireless HSPA Non-Composite Device */
296 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
297 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
298 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
299 .driver_info
= (kernel_ulong_t
)&direct_ip_interface_blacklist
301 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
305 MODULE_DEVICE_TABLE(usb
, id_table
);
307 static struct usb_driver sierra_driver
= {
309 .probe
= usb_serial_probe
,
310 .disconnect
= usb_serial_disconnect
,
311 .suspend
= usb_serial_suspend
,
312 .resume
= usb_serial_resume
,
313 .id_table
= id_table
,
315 .supports_autosuspend
= 1,
318 struct sierra_port_private
{
319 spinlock_t lock
; /* lock the structure */
320 int outstanding_urbs
; /* number of out urbs in flight */
321 struct usb_anchor active
;
322 struct usb_anchor delayed
;
326 /* Input endpoints and buffers for this port */
327 struct urb
*in_urbs
[N_IN_URB_HM
];
329 /* Settings for the port */
330 int rts_state
; /* Handshaking pins (outputs) */
332 int cts_state
; /* Handshaking pins (inputs) */
336 unsigned int opened
:1;
339 static int sierra_send_setup(struct usb_serial_port
*port
)
341 struct usb_serial
*serial
= port
->serial
;
342 struct sierra_port_private
*portdata
;
348 dev_dbg(&port
->dev
, "%s\n", __func__
);
350 portdata
= usb_get_serial_port_data(port
);
352 if (portdata
->dtr_state
)
354 if (portdata
->rts_state
)
357 /* If composite device then properly report interface */
358 if (serial
->num_ports
== 1) {
359 interface
= sierra_calc_interface(serial
);
360 /* Control message is sent only to interfaces with
361 * interrupt_in endpoints
363 if (port
->interrupt_in_urb
) {
364 /* send control message */
369 /* Otherwise the need to do non-composite mapping */
371 if (port
->bulk_out_endpointAddress
== 2)
373 else if (port
->bulk_out_endpointAddress
== 4)
375 else if (port
->bulk_out_endpointAddress
== 5)
383 usb_autopm_get_interface(serial
->interface
);
384 retval
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
385 0x22, 0x21, val
, interface
, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
386 usb_autopm_put_interface(serial
->interface
);
391 static void sierra_set_termios(struct tty_struct
*tty
,
392 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
394 dev_dbg(&port
->dev
, "%s\n", __func__
);
395 tty_termios_copy_hw(tty
->termios
, old_termios
);
396 sierra_send_setup(port
);
399 static int sierra_tiocmget(struct tty_struct
*tty
, struct file
*file
)
401 struct usb_serial_port
*port
= tty
->driver_data
;
403 struct sierra_port_private
*portdata
;
405 dev_dbg(&port
->dev
, "%s\n", __func__
);
406 portdata
= usb_get_serial_port_data(port
);
408 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
409 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
410 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
411 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
412 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
413 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
418 static int sierra_tiocmset(struct tty_struct
*tty
, struct file
*file
,
419 unsigned int set
, unsigned int clear
)
421 struct usb_serial_port
*port
= tty
->driver_data
;
422 struct sierra_port_private
*portdata
;
424 portdata
= usb_get_serial_port_data(port
);
427 portdata
->rts_state
= 1;
429 portdata
->dtr_state
= 1;
431 if (clear
& TIOCM_RTS
)
432 portdata
->rts_state
= 0;
433 if (clear
& TIOCM_DTR
)
434 portdata
->dtr_state
= 0;
435 return sierra_send_setup(port
);
438 static void sierra_release_urb(struct urb
*urb
)
440 struct usb_serial_port
*port
;
443 dev_dbg(&port
->dev
, "%s: %p\n", __func__
, urb
);
444 kfree(urb
->transfer_buffer
);
449 static void sierra_outdat_callback(struct urb
*urb
)
451 struct usb_serial_port
*port
= urb
->context
;
452 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
453 struct sierra_intf_private
*intfdata
;
454 int status
= urb
->status
;
456 dev_dbg(&port
->dev
, "%s - port %d\n", __func__
, port
->number
);
457 intfdata
= port
->serial
->private;
459 /* free up the transfer buffer, as usb_free_urb() does not do this */
460 kfree(urb
->transfer_buffer
);
461 usb_autopm_put_interface_async(port
->serial
->interface
);
463 dev_dbg(&port
->dev
, "%s - nonzero write bulk status "
464 "received: %d\n", __func__
, status
);
466 spin_lock(&portdata
->lock
);
467 --portdata
->outstanding_urbs
;
468 spin_unlock(&portdata
->lock
);
469 spin_lock(&intfdata
->susp_lock
);
470 --intfdata
->in_flight
;
471 spin_unlock(&intfdata
->susp_lock
);
473 usb_serial_port_softint(port
);
477 static int sierra_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
478 const unsigned char *buf
, int count
)
480 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
481 struct sierra_intf_private
*intfdata
;
482 struct usb_serial
*serial
= port
->serial
;
484 unsigned char *buffer
;
486 size_t writesize
= min((size_t)count
, (size_t)MAX_TRANSFER
);
489 /* verify that we actually have some data to write */
493 portdata
= usb_get_serial_port_data(port
);
494 intfdata
= serial
->private;
496 dev_dbg(&port
->dev
, "%s: write (%zd bytes)\n", __func__
, writesize
);
497 spin_lock_irqsave(&portdata
->lock
, flags
);
498 dev_dbg(&port
->dev
, "%s - outstanding_urbs: %d\n", __func__
,
499 portdata
->outstanding_urbs
);
500 if (portdata
->outstanding_urbs
> portdata
->num_out_urbs
) {
501 spin_unlock_irqrestore(&portdata
->lock
, flags
);
502 dev_dbg(&port
->dev
, "%s - write limit hit\n", __func__
);
505 portdata
->outstanding_urbs
++;
506 dev_dbg(&port
->dev
, "%s - 1, outstanding_urbs: %d\n", __func__
,
507 portdata
->outstanding_urbs
);
508 spin_unlock_irqrestore(&portdata
->lock
, flags
);
510 retval
= usb_autopm_get_interface_async(serial
->interface
);
512 spin_lock_irqsave(&portdata
->lock
, flags
);
513 portdata
->outstanding_urbs
--;
514 spin_unlock_irqrestore(&portdata
->lock
, flags
);
518 buffer
= kmalloc(writesize
, GFP_ATOMIC
);
520 dev_err(&port
->dev
, "out of memory\n");
522 goto error_no_buffer
;
525 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
527 dev_err(&port
->dev
, "no more free urbs\n");
532 memcpy(buffer
, buf
, writesize
);
534 usb_serial_debug_data(debug
, &port
->dev
, __func__
, writesize
, buffer
);
536 usb_fill_bulk_urb(urb
, serial
->dev
,
537 usb_sndbulkpipe(serial
->dev
,
538 port
->bulk_out_endpointAddress
),
539 buffer
, writesize
, sierra_outdat_callback
, port
);
541 /* Handle the need to send a zero length packet */
542 urb
->transfer_flags
|= URB_ZERO_PACKET
;
544 spin_lock_irqsave(&intfdata
->susp_lock
, flags
);
546 if (intfdata
->suspended
) {
547 usb_anchor_urb(urb
, &portdata
->delayed
);
548 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
551 usb_anchor_urb(urb
, &portdata
->active
);
553 /* send it down the pipe */
554 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
556 usb_unanchor_urb(urb
);
557 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
558 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed "
559 "with status = %d\n", __func__
, retval
);
562 intfdata
->in_flight
++;
563 spin_unlock_irqrestore(&intfdata
->susp_lock
, flags
);
567 /* we are done with this urb, so let the host driver
568 * really free it when it is finished with it */
577 spin_lock_irqsave(&portdata
->lock
, flags
);
578 --portdata
->outstanding_urbs
;
579 dev_dbg(&port
->dev
, "%s - 2. outstanding_urbs: %d\n", __func__
,
580 portdata
->outstanding_urbs
);
581 spin_unlock_irqrestore(&portdata
->lock
, flags
);
582 usb_autopm_put_interface_async(serial
->interface
);
587 static void sierra_indat_callback(struct urb
*urb
)
591 struct usb_serial_port
*port
;
592 struct tty_struct
*tty
;
593 unsigned char *data
= urb
->transfer_buffer
;
594 int status
= urb
->status
;
596 endpoint
= usb_pipeendpoint(urb
->pipe
);
599 dev_dbg(&port
->dev
, "%s: %p\n", __func__
, urb
);
602 dev_dbg(&port
->dev
, "%s: nonzero status: %d on"
603 " endpoint %02x\n", __func__
, status
, endpoint
);
605 if (urb
->actual_length
) {
606 tty
= tty_port_tty_get(&port
->port
);
608 tty_buffer_request_room(tty
, urb
->actual_length
);
609 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
610 tty_flip_buffer_push(tty
);
613 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
614 urb
->actual_length
, data
);
616 dev_dbg(&port
->dev
, "%s: empty read urb"
617 " received\n", __func__
);
621 /* Resubmit urb so we continue receiving */
622 if (port
->port
.count
&& status
!= -ESHUTDOWN
&& status
!= -EPERM
) {
623 usb_mark_last_busy(port
->serial
->dev
);
624 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
626 dev_err(&port
->dev
, "resubmit read urb failed."
633 static void sierra_instat_callback(struct urb
*urb
)
636 int status
= urb
->status
;
637 struct usb_serial_port
*port
= urb
->context
;
638 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
639 struct usb_serial
*serial
= port
->serial
;
641 dev_dbg(&port
->dev
, "%s: urb %p port %p has data %p\n", __func__
,
642 urb
, port
, portdata
);
645 struct usb_ctrlrequest
*req_pkt
=
646 (struct usb_ctrlrequest
*)urb
->transfer_buffer
;
649 dev_dbg(&port
->dev
, "%s: NULL req_pkt\n",
653 if ((req_pkt
->bRequestType
== 0xA1) &&
654 (req_pkt
->bRequest
== 0x20)) {
656 unsigned char signals
= *((unsigned char *)
657 urb
->transfer_buffer
+
658 sizeof(struct usb_ctrlrequest
));
659 struct tty_struct
*tty
;
661 dev_dbg(&port
->dev
, "%s: signal x%x\n", __func__
,
664 old_dcd_state
= portdata
->dcd_state
;
665 portdata
->cts_state
= 1;
666 portdata
->dcd_state
= ((signals
& 0x01) ? 1 : 0);
667 portdata
->dsr_state
= ((signals
& 0x02) ? 1 : 0);
668 portdata
->ri_state
= ((signals
& 0x08) ? 1 : 0);
670 tty
= tty_port_tty_get(&port
->port
);
671 if (tty
&& !C_CLOCAL(tty
) &&
672 old_dcd_state
&& !portdata
->dcd_state
)
676 dev_dbg(&port
->dev
, "%s: type %x req %x\n",
677 __func__
, req_pkt
->bRequestType
,
681 dev_dbg(&port
->dev
, "%s: error %d\n", __func__
, status
);
683 /* Resubmit urb so we continue receiving IRQ data */
684 if (port
->port
.count
&& status
!= -ESHUTDOWN
&& status
!= -ENOENT
) {
685 usb_mark_last_busy(serial
->dev
);
686 urb
->dev
= serial
->dev
;
687 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
689 dev_err(&port
->dev
, "%s: resubmit intr urb "
690 "failed. (%d)\n", __func__
, err
);
694 static int sierra_write_room(struct tty_struct
*tty
)
696 struct usb_serial_port
*port
= tty
->driver_data
;
697 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
700 dev_dbg(&port
->dev
, "%s - port %d\n", __func__
, port
->number
);
702 /* try to give a good number back based on if we have any free urbs at
703 * this point in time */
704 spin_lock_irqsave(&portdata
->lock
, flags
);
705 if (portdata
->outstanding_urbs
> (portdata
->num_out_urbs
* 2) / 3) {
706 spin_unlock_irqrestore(&portdata
->lock
, flags
);
707 dev_dbg(&port
->dev
, "%s - write limit hit\n", __func__
);
710 spin_unlock_irqrestore(&portdata
->lock
, flags
);
715 static void sierra_stop_rx_urbs(struct usb_serial_port
*port
)
718 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
720 for (i
= 0; i
< portdata
->num_in_urbs
; i
++)
721 usb_kill_urb(portdata
->in_urbs
[i
]);
723 usb_kill_urb(port
->interrupt_in_urb
);
726 static int sierra_submit_rx_urbs(struct usb_serial_port
*port
, gfp_t mem_flags
)
732 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
735 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
736 urb
= portdata
->in_urbs
[i
];
739 err
= usb_submit_urb(urb
, mem_flags
);
741 dev_err(&port
->dev
, "%s: submit urb failed: %d\n",
748 if (ok_cnt
&& port
->interrupt_in_urb
) {
749 err
= usb_submit_urb(port
->interrupt_in_urb
, mem_flags
);
751 dev_err(&port
->dev
, "%s: submit intr urb failed: %d\n",
756 if (ok_cnt
> 0) /* at least one rx urb submitted */
762 static struct urb
*sierra_setup_urb(struct usb_serial
*serial
, int endpoint
,
763 int dir
, void *ctx
, int len
,
765 usb_complete_t callback
)
773 urb
= usb_alloc_urb(0, mem_flags
);
775 dev_dbg(&serial
->dev
->dev
, "%s: alloc for endpoint %d failed\n",
780 buf
= kmalloc(len
, mem_flags
);
782 /* Fill URB using supplied data */
783 usb_fill_bulk_urb(urb
, serial
->dev
,
784 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
785 buf
, len
, callback
, ctx
);
788 dev_dbg(&serial
->dev
->dev
, "%s %c u : %p d:%p\n", __func__
,
789 dir
== USB_DIR_IN
? 'i' : 'o', urb
, buf
);
791 dev_dbg(&serial
->dev
->dev
, "%s %c u:%p d:%p\n", __func__
,
792 dir
== USB_DIR_IN
? 'i' : 'o', urb
, buf
);
794 sierra_release_urb(urb
);
801 static void sierra_close(struct usb_serial_port
*port
)
804 struct usb_serial
*serial
= port
->serial
;
805 struct sierra_port_private
*portdata
;
806 struct sierra_intf_private
*intfdata
= port
->serial
->private;
809 dev_dbg(&port
->dev
, "%s\n", __func__
);
810 portdata
= usb_get_serial_port_data(port
);
812 portdata
->rts_state
= 0;
813 portdata
->dtr_state
= 0;
816 mutex_lock(&serial
->disc_mutex
);
817 if (!serial
->disconnected
) {
818 serial
->interface
->needs_remote_wakeup
= 0;
819 usb_autopm_get_interface(serial
->interface
);
820 sierra_send_setup(port
);
822 mutex_unlock(&serial
->disc_mutex
);
823 spin_lock_irq(&intfdata
->susp_lock
);
824 portdata
->opened
= 0;
825 spin_unlock_irq(&intfdata
->susp_lock
);
828 /* Stop reading urbs */
829 sierra_stop_rx_urbs(port
);
830 /* .. and release them */
831 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
832 sierra_release_urb(portdata
->in_urbs
[i
]);
833 portdata
->in_urbs
[i
] = NULL
;
838 static int sierra_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
840 struct sierra_port_private
*portdata
;
841 struct usb_serial
*serial
= port
->serial
;
842 struct sierra_intf_private
*intfdata
= serial
->private;
848 portdata
= usb_get_serial_port_data(port
);
850 dev_dbg(&port
->dev
, "%s\n", __func__
);
852 /* Set some sane defaults */
853 portdata
->rts_state
= 1;
854 portdata
->dtr_state
= 1;
857 endpoint
= port
->bulk_in_endpointAddress
;
858 for (i
= 0; i
< portdata
->num_in_urbs
; i
++) {
859 urb
= sierra_setup_urb(serial
, endpoint
, USB_DIR_IN
, port
,
860 IN_BUFLEN
, GFP_KERNEL
,
861 sierra_indat_callback
);
862 portdata
->in_urbs
[i
] = urb
;
864 /* clear halt condition */
865 usb_clear_halt(serial
->dev
,
866 usb_sndbulkpipe(serial
->dev
, endpoint
) | USB_DIR_IN
);
868 err
= sierra_submit_rx_urbs(port
, GFP_KERNEL
);
870 /* get rid of everything as in close */
872 /* restore balance for autopm */
873 usb_autopm_put_interface(serial
->interface
);
876 sierra_send_setup(port
);
878 serial
->interface
->needs_remote_wakeup
= 1;
879 spin_lock_irq(&intfdata
->susp_lock
);
880 portdata
->opened
= 1;
881 spin_unlock_irq(&intfdata
->susp_lock
);
882 usb_autopm_put_interface(serial
->interface
);
888 static void sierra_dtr_rts(struct usb_serial_port
*port
, int on
)
890 struct usb_serial
*serial
= port
->serial
;
891 struct sierra_port_private
*portdata
;
893 portdata
= usb_get_serial_port_data(port
);
894 portdata
->rts_state
= on
;
895 portdata
->dtr_state
= on
;
898 mutex_lock(&serial
->disc_mutex
);
899 if (!serial
->disconnected
)
900 sierra_send_setup(port
);
901 mutex_unlock(&serial
->disc_mutex
);
905 static int sierra_startup(struct usb_serial
*serial
)
907 struct usb_serial_port
*port
;
908 struct sierra_port_private
*portdata
;
909 struct sierra_iface_info
*himemoryp
= NULL
;
913 dev_dbg(&serial
->dev
->dev
, "%s\n", __func__
);
915 /* Set Device mode to D0 */
916 sierra_set_power_state(serial
->dev
, 0x0000);
918 /* Check NMEA and set */
920 sierra_vsc_set_nmea(serial
->dev
, 1);
922 /* Now setup per port private data */
923 for (i
= 0; i
< serial
->num_ports
; i
++) {
924 port
= serial
->port
[i
];
925 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
927 dev_dbg(&port
->dev
, "%s: kmalloc for "
928 "sierra_port_private (%d) failed!\n",
932 spin_lock_init(&portdata
->lock
);
933 init_usb_anchor(&portdata
->active
);
934 init_usb_anchor(&portdata
->delayed
);
936 /* Assume low memory requirements */
937 portdata
->num_out_urbs
= N_OUT_URB
;
938 portdata
->num_in_urbs
= N_IN_URB
;
940 /* Determine actual memory requirements */
941 if (serial
->num_ports
== 1) {
942 /* Get interface number for composite device */
943 ifnum
= sierra_calc_interface(serial
);
945 (struct sierra_iface_info
*)&typeB_interface_list
;
946 if (is_himemory(ifnum
, himemoryp
)) {
947 portdata
->num_out_urbs
= N_OUT_URB_HM
;
948 portdata
->num_in_urbs
= N_IN_URB_HM
;
953 (struct sierra_iface_info
*)&typeA_interface_list
;
954 if (is_himemory(i
, himemoryp
)) {
955 portdata
->num_out_urbs
= N_OUT_URB_HM
;
956 portdata
->num_in_urbs
= N_IN_URB_HM
;
959 dev_dbg(&serial
->dev
->dev
,
960 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
961 ifnum
,portdata
->num_in_urbs
, portdata
->num_out_urbs
);
962 /* Set the port private data pointer */
963 usb_set_serial_port_data(port
, portdata
);
969 static void sierra_release(struct usb_serial
*serial
)
972 struct usb_serial_port
*port
;
973 struct sierra_port_private
*portdata
;
975 dev_dbg(&serial
->dev
->dev
, "%s\n", __func__
);
977 for (i
= 0; i
< serial
->num_ports
; ++i
) {
978 port
= serial
->port
[i
];
981 portdata
= usb_get_serial_port_data(port
);
989 static void stop_read_write_urbs(struct usb_serial
*serial
)
992 struct usb_serial_port
*port
;
993 struct sierra_port_private
*portdata
;
995 /* Stop reading/writing urbs */
996 for (i
= 0; i
< serial
->num_ports
; ++i
) {
997 port
= serial
->port
[i
];
998 portdata
= usb_get_serial_port_data(port
);
999 sierra_stop_rx_urbs(port
);
1000 usb_kill_anchored_urbs(&portdata
->active
);
1004 static int sierra_suspend(struct usb_serial
*serial
, pm_message_t message
)
1006 struct sierra_intf_private
*intfdata
;
1009 if (message
.event
& PM_EVENT_AUTO
) {
1010 intfdata
= serial
->private;
1011 spin_lock_irq(&intfdata
->susp_lock
);
1012 b
= intfdata
->in_flight
;
1015 spin_unlock_irq(&intfdata
->susp_lock
);
1018 intfdata
->suspended
= 1;
1019 spin_unlock_irq(&intfdata
->susp_lock
);
1022 stop_read_write_urbs(serial
);
1027 static int sierra_resume(struct usb_serial
*serial
)
1029 struct usb_serial_port
*port
;
1030 struct sierra_intf_private
*intfdata
= serial
->private;
1031 struct sierra_port_private
*portdata
;
1036 spin_lock_irq(&intfdata
->susp_lock
);
1037 for (i
= 0; i
< serial
->num_ports
; i
++) {
1038 port
= serial
->port
[i
];
1039 portdata
= usb_get_serial_port_data(port
);
1041 while ((urb
= usb_get_from_anchor(&portdata
->delayed
))) {
1042 usb_anchor_urb(urb
, &portdata
->active
);
1043 intfdata
->in_flight
++;
1044 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
1046 intfdata
->in_flight
--;
1047 usb_unanchor_urb(urb
);
1048 usb_scuttle_anchored_urbs(&portdata
->delayed
);
1053 if (portdata
->opened
) {
1054 err
= sierra_submit_rx_urbs(port
, GFP_ATOMIC
);
1059 intfdata
->suspended
= 0;
1060 spin_unlock_irq(&intfdata
->susp_lock
);
1062 return ec
? -EIO
: 0;
1065 #define sierra_suspend NULL
1066 #define sierra_resume NULL
1069 static struct usb_serial_driver sierra_device
= {
1071 .owner
= THIS_MODULE
,
1074 .description
= "Sierra USB modem",
1075 .id_table
= id_table
,
1076 .usb_driver
= &sierra_driver
,
1077 .calc_num_ports
= sierra_calc_num_ports
,
1078 .probe
= sierra_probe
,
1079 .open
= sierra_open
,
1080 .close
= sierra_close
,
1081 .dtr_rts
= sierra_dtr_rts
,
1082 .write
= sierra_write
,
1083 .write_room
= sierra_write_room
,
1084 .set_termios
= sierra_set_termios
,
1085 .tiocmget
= sierra_tiocmget
,
1086 .tiocmset
= sierra_tiocmset
,
1087 .attach
= sierra_startup
,
1088 .release
= sierra_release
,
1089 .suspend
= sierra_suspend
,
1090 .resume
= sierra_resume
,
1091 .read_int_callback
= sierra_instat_callback
,
1094 /* Functions used by new usb-serial code. */
1095 static int __init
sierra_init(void)
1098 retval
= usb_serial_register(&sierra_device
);
1100 goto failed_device_register
;
1103 retval
= usb_register(&sierra_driver
);
1105 goto failed_driver_register
;
1107 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_VERSION
":"
1112 failed_driver_register
:
1113 usb_serial_deregister(&sierra_device
);
1114 failed_device_register
:
1118 static void __exit
sierra_exit(void)
1120 usb_deregister(&sierra_driver
);
1121 usb_serial_deregister(&sierra_device
);
1124 module_init(sierra_init
);
1125 module_exit(sierra_exit
);
1127 MODULE_AUTHOR(DRIVER_AUTHOR
);
1128 MODULE_DESCRIPTION(DRIVER_DESC
);
1129 MODULE_VERSION(DRIVER_VERSION
);
1130 MODULE_LICENSE("GPL");
1132 module_param(nmea
, bool, S_IRUGO
| S_IWUSR
);
1133 MODULE_PARM_DESC(nmea
, "NMEA streaming");
1135 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1136 MODULE_PARM_DESC(debug
, "Debug messages");