2 USB Driver for Sierra Wireless
4 Copyright (C) 2006, 2007 Kevin Lloyd <linux@sierrawireless.com>
6 IMPORTANT DISCLAIMER: This driver is not commercially supported by
7 Sierra Wireless. Use at your own risk.
9 This driver is free software; you can redistribute it and/or modify
10 it under the terms of Version 2 of the GNU General Public License as
11 published by the Free Software Foundation.
13 Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
14 Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
17 #define DRIVER_VERSION "v.1.2.4b"
18 #define DRIVER_AUTHOR "Kevin Lloyd <linux@sierrawireless.com>"
19 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
21 #include <linux/kernel.h>
22 #include <linux/jiffies.h>
23 #include <linux/errno.h>
24 #include <linux/tty.h>
25 #include <linux/tty_flip.h>
26 #include <linux/module.h>
27 #include <linux/usb.h>
28 #include <linux/usb/serial.h>
30 #define SWIMS_USB_REQUEST_SetMode 0x0B
31 #define SWIMS_USB_REQUEST_TYPE_SetMode 0x40
32 #define SWIMS_USB_INDEX_SetMode 0x0000
33 #define SWIMS_SET_MODE_Modem 0x0001
35 /* per port private data */
38 #define IN_BUFLEN 4096
48 int sierra_set_power_state(struct usb_device
*udev
, __u16 swiState
)
51 dev_dbg(&udev
->dev
, "%s", "SET POWER STATE");
52 result
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
53 0x00, /* __u8 request */
54 0x40, /* __u8 request type */
55 swiState
, /* __u16 value */
57 NULL
, /* void *data */
59 USB_CTRL_SET_TIMEOUT
); /* int timeout */
63 int sierra_set_ms_mode(struct usb_device
*udev
, __u16 eSocMode
)
66 dev_dbg(&udev
->dev
, "%s", "DEVICE MODE SWITCH");
67 result
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
68 SWIMS_USB_REQUEST_SetMode
, /* __u8 request */
69 SWIMS_USB_REQUEST_TYPE_SetMode
, /* __u8 request type */
70 eSocMode
, /* __u16 value */
71 SWIMS_USB_INDEX_SetMode
, /* __u16 index */
72 NULL
, /* void *data */
74 USB_CTRL_SET_TIMEOUT
); /* int timeout */
78 int sierra_probe(struct usb_interface
*iface
, const struct usb_device_id
*id
)
81 struct usb_device
*udev
;
83 udev
= usb_get_dev(interface_to_usbdev(iface
));
85 /* Check if in installer mode */
86 if (id
->driver_info
== DEVICE_INSTALLER
) {
87 dev_dbg(&udev
->dev
, "%s", "FOUND DEVICE(SW)\n");
88 result
= sierra_set_ms_mode(udev
, SWIMS_SET_MODE_Modem
);
89 /*We do not want to bind to the device when in installer mode*/
93 return usb_serial_probe(iface
, id
);
96 static struct usb_device_id id_table
[] = {
97 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
98 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
99 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
100 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
101 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
102 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless AirCard 595U */
103 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
104 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
105 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
106 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
107 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
108 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
110 { USB_DEVICE(0x1199, 0x0112), .driver_info
= DEVICE_1_PORT
}, /* Sierra Wireless AirCard 580 */
111 { USB_DEVICE(0x0F3D, 0x0112), .driver_info
= DEVICE_1_PORT
}, /* Airprime/Sierra PC 5220 */
113 { USB_DEVICE(0x1199, 0x0FFF), .driver_info
= DEVICE_INSTALLER
},
116 MODULE_DEVICE_TABLE(usb
, id_table
);
118 static struct usb_device_id id_table_1port
[] = {
119 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
120 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
124 static struct usb_device_id id_table_3port
[] = {
126 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
127 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
128 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
129 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
130 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
131 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless AirCard 595U */
132 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
134 /* GSM/UMTS Devices */
135 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
136 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
137 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
138 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
139 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
143 static struct usb_driver sierra_driver
= {
145 .probe
= sierra_probe
,
146 .disconnect
= usb_serial_disconnect
,
147 .id_table
= id_table
,
152 struct sierra_port_private
{
153 spinlock_t lock
; /* lock the structure */
154 int outstanding_urbs
; /* number of out urbs in flight */
156 /* Input endpoints and buffer for this port */
157 struct urb
*in_urbs
[N_IN_URB
];
158 char in_buffer
[N_IN_URB
][IN_BUFLEN
];
160 /* Settings for the port */
161 int rts_state
; /* Handshaking pins (outputs) */
163 int cts_state
; /* Handshaking pins (inputs) */
169 static int sierra_send_setup(struct usb_serial_port
*port
)
171 struct usb_serial
*serial
= port
->serial
;
172 struct sierra_port_private
*portdata
;
174 dbg("%s", __FUNCTION__
);
176 portdata
= usb_get_serial_port_data(port
);
180 if (portdata
->dtr_state
)
182 if (portdata
->rts_state
)
185 return usb_control_msg(serial
->dev
,
186 usb_rcvctrlpipe(serial
->dev
, 0),
187 0x22,0x21,val
,0,NULL
,0,USB_CTRL_SET_TIMEOUT
);
193 static void sierra_rx_throttle(struct usb_serial_port
*port
)
195 dbg("%s", __FUNCTION__
);
198 static void sierra_rx_unthrottle(struct usb_serial_port
*port
)
200 dbg("%s", __FUNCTION__
);
203 static void sierra_break_ctl(struct usb_serial_port
*port
, int break_state
)
205 /* Unfortunately, I don't know how to send a break */
206 dbg("%s", __FUNCTION__
);
209 static void sierra_set_termios(struct usb_serial_port
*port
,
210 struct ktermios
*old_termios
)
212 dbg("%s", __FUNCTION__
);
214 sierra_send_setup(port
);
217 static int sierra_tiocmget(struct usb_serial_port
*port
, struct file
*file
)
220 struct sierra_port_private
*portdata
;
222 portdata
= usb_get_serial_port_data(port
);
224 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
225 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
226 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
227 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
228 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
229 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
234 static int sierra_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
235 unsigned int set
, unsigned int clear
)
237 struct sierra_port_private
*portdata
;
239 portdata
= usb_get_serial_port_data(port
);
242 portdata
->rts_state
= 1;
244 portdata
->dtr_state
= 1;
246 if (clear
& TIOCM_RTS
)
247 portdata
->rts_state
= 0;
248 if (clear
& TIOCM_DTR
)
249 portdata
->dtr_state
= 0;
250 return sierra_send_setup(port
);
253 static int sierra_ioctl(struct usb_serial_port
*port
, struct file
*file
,
254 unsigned int cmd
, unsigned long arg
)
259 static void sierra_outdat_callback(struct urb
*urb
)
261 struct usb_serial_port
*port
= urb
->context
;
262 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
263 int status
= urb
->status
;
266 dbg("%s - port %d", __FUNCTION__
, port
->number
);
268 /* free up the transfer buffer, as usb_free_urb() does not do this */
269 kfree(urb
->transfer_buffer
);
272 dbg("%s - nonzero write bulk status received: %d",
273 __FUNCTION__
, status
);
275 spin_lock_irqsave(&portdata
->lock
, flags
);
276 --portdata
->outstanding_urbs
;
277 spin_unlock_irqrestore(&portdata
->lock
, flags
);
279 usb_serial_port_softint(port
);
283 static int sierra_write(struct usb_serial_port
*port
,
284 const unsigned char *buf
, int count
)
286 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
287 struct usb_serial
*serial
= port
->serial
;
289 unsigned char *buffer
;
293 portdata
= usb_get_serial_port_data(port
);
295 dbg("%s: write (%d chars)", __FUNCTION__
, count
);
297 spin_lock_irqsave(&portdata
->lock
, flags
);
298 if (portdata
->outstanding_urbs
> N_OUT_URB
) {
299 spin_unlock_irqrestore(&portdata
->lock
, flags
);
300 dbg("%s - write limit hit\n", __FUNCTION__
);
303 portdata
->outstanding_urbs
++;
304 spin_unlock_irqrestore(&portdata
->lock
, flags
);
306 buffer
= kmalloc(count
, GFP_ATOMIC
);
308 dev_err(&port
->dev
, "out of memory\n");
310 goto error_no_buffer
;
313 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
315 dev_err(&port
->dev
, "no more free urbs\n");
320 memcpy(buffer
, buf
, count
);
322 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
, buffer
);
324 usb_fill_bulk_urb(urb
, serial
->dev
,
325 usb_sndbulkpipe(serial
->dev
,
326 port
->bulk_out_endpointAddress
),
327 buffer
, count
, sierra_outdat_callback
, port
);
329 /* send it down the pipe */
330 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
332 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed "
333 "with status = %d\n", __FUNCTION__
, status
);
338 /* we are done with this urb, so let the host driver
339 * really free it when it is finished with it */
348 spin_lock_irqsave(&portdata
->lock
, flags
);
349 --portdata
->outstanding_urbs
;
350 spin_unlock_irqrestore(&portdata
->lock
, flags
);
354 static void sierra_indat_callback(struct urb
*urb
)
358 struct usb_serial_port
*port
;
359 struct tty_struct
*tty
;
360 unsigned char *data
= urb
->transfer_buffer
;
361 int status
= urb
->status
;
363 dbg("%s: %p", __FUNCTION__
, urb
);
365 endpoint
= usb_pipeendpoint(urb
->pipe
);
366 port
= (struct usb_serial_port
*) urb
->context
;
369 dbg("%s: nonzero status: %d on endpoint %02x.",
370 __FUNCTION__
, status
, endpoint
);
373 if (urb
->actual_length
) {
374 tty_buffer_request_room(tty
, urb
->actual_length
);
375 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
376 tty_flip_buffer_push(tty
);
378 dbg("%s: empty read urb received", __FUNCTION__
);
381 /* Resubmit urb so we continue receiving */
382 if (port
->open_count
&& status
!= -ESHUTDOWN
) {
383 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
385 dev_err(&port
->dev
, "resubmit read urb failed."
392 static void sierra_instat_callback(struct urb
*urb
)
395 int status
= urb
->status
;
396 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
397 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
398 struct usb_serial
*serial
= port
->serial
;
400 dbg("%s", __FUNCTION__
);
401 dbg("%s: urb %p port %p has data %p", __FUNCTION__
,urb
,port
,portdata
);
404 struct usb_ctrlrequest
*req_pkt
=
405 (struct usb_ctrlrequest
*)urb
->transfer_buffer
;
408 dbg("%s: NULL req_pkt\n", __FUNCTION__
);
411 if ((req_pkt
->bRequestType
== 0xA1) &&
412 (req_pkt
->bRequest
== 0x20)) {
414 unsigned char signals
= *((unsigned char *)
415 urb
->transfer_buffer
+
416 sizeof(struct usb_ctrlrequest
));
418 dbg("%s: signal x%x", __FUNCTION__
, signals
);
420 old_dcd_state
= portdata
->dcd_state
;
421 portdata
->cts_state
= 1;
422 portdata
->dcd_state
= ((signals
& 0x01) ? 1 : 0);
423 portdata
->dsr_state
= ((signals
& 0x02) ? 1 : 0);
424 portdata
->ri_state
= ((signals
& 0x08) ? 1 : 0);
426 if (port
->tty
&& !C_CLOCAL(port
->tty
) &&
427 old_dcd_state
&& !portdata
->dcd_state
)
428 tty_hangup(port
->tty
);
430 dbg("%s: type %x req %x", __FUNCTION__
,
431 req_pkt
->bRequestType
,req_pkt
->bRequest
);
434 dbg("%s: error %d", __FUNCTION__
, status
);
436 /* Resubmit urb so we continue receiving IRQ data */
437 if (status
!= -ESHUTDOWN
) {
438 urb
->dev
= serial
->dev
;
439 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
441 dbg("%s: resubmit intr urb failed. (%d)",
446 static int sierra_write_room(struct usb_serial_port
*port
)
448 struct sierra_port_private
*portdata
= usb_get_serial_port_data(port
);
451 dbg("%s - port %d", __FUNCTION__
, port
->number
);
453 /* try to give a good number back based on if we have any free urbs at
454 * this point in time */
455 spin_lock_irqsave(&portdata
->lock
, flags
);
456 if (portdata
->outstanding_urbs
> N_OUT_URB
* 2 / 3) {
457 spin_unlock_irqrestore(&portdata
->lock
, flags
);
458 dbg("%s - write limit hit\n", __FUNCTION__
);
461 spin_unlock_irqrestore(&portdata
->lock
, flags
);
466 static int sierra_chars_in_buffer(struct usb_serial_port
*port
)
468 dbg("%s - port %d", __FUNCTION__
, port
->number
);
471 * We can't really account for how much data we
472 * have sent out, but hasn't made it through to the
473 * device as we can't see the backend here, so just
474 * tell the tty layer that everything is flushed.
479 static int sierra_open(struct usb_serial_port
*port
, struct file
*filp
)
481 struct sierra_port_private
*portdata
;
482 struct usb_serial
*serial
= port
->serial
;
487 portdata
= usb_get_serial_port_data(port
);
489 dbg("%s", __FUNCTION__
);
491 /* Set some sane defaults */
492 portdata
->rts_state
= 1;
493 portdata
->dtr_state
= 1;
495 /* Reset low level data toggle and start reading from endpoints */
496 for (i
= 0; i
< N_IN_URB
; i
++) {
497 urb
= portdata
->in_urbs
[i
];
500 if (urb
->dev
!= serial
->dev
) {
501 dbg("%s: dev %p != %p", __FUNCTION__
,
502 urb
->dev
, serial
->dev
);
507 * make sure endpoint data toggle is synchronized with the
510 usb_clear_halt(urb
->dev
, urb
->pipe
);
512 result
= usb_submit_urb(urb
, GFP_KERNEL
);
514 dev_err(&port
->dev
, "submit urb %d failed (%d) %d",
515 i
, result
, urb
->transfer_buffer_length
);
519 port
->tty
->low_latency
= 1;
521 sierra_send_setup(port
);
523 /* start up the interrupt endpoint if we have one */
524 if (port
->interrupt_in_urb
) {
525 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
527 dev_err(&port
->dev
, "submit irq_in urb failed %d",
533 static void sierra_close(struct usb_serial_port
*port
, struct file
*filp
)
536 struct usb_serial
*serial
= port
->serial
;
537 struct sierra_port_private
*portdata
;
539 dbg("%s", __FUNCTION__
);
540 portdata
= usb_get_serial_port_data(port
);
542 portdata
->rts_state
= 0;
543 portdata
->dtr_state
= 0;
546 sierra_send_setup(port
);
548 /* Stop reading/writing urbs */
549 for (i
= 0; i
< N_IN_URB
; i
++)
550 usb_kill_urb(portdata
->in_urbs
[i
]);
553 usb_kill_urb(port
->interrupt_in_urb
);
558 static int sierra_startup(struct usb_serial
*serial
)
560 struct usb_serial_port
*port
;
561 struct sierra_port_private
*portdata
;
566 dbg("%s", __FUNCTION__
);
568 /*Set Device mode to D0 */
569 sierra_set_power_state(serial
->dev
, 0x0000);
571 /* Now setup per port private data */
572 for (i
= 0; i
< serial
->num_ports
; i
++) {
573 port
= serial
->port
[i
];
574 portdata
= kzalloc(sizeof(*portdata
), GFP_KERNEL
);
576 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
580 spin_lock_init(&portdata
->lock
);
582 usb_set_serial_port_data(port
, portdata
);
584 /* initialize the in urbs */
585 for (j
= 0; j
< N_IN_URB
; ++j
) {
586 urb
= usb_alloc_urb(0, GFP_KERNEL
);
588 dbg("%s: alloc for in port failed.",
592 /* Fill URB using supplied data. */
593 usb_fill_bulk_urb(urb
, serial
->dev
,
594 usb_rcvbulkpipe(serial
->dev
,
595 port
->bulk_in_endpointAddress
),
596 portdata
->in_buffer
[j
], IN_BUFLEN
,
597 sierra_indat_callback
, port
);
598 portdata
->in_urbs
[j
] = urb
;
605 static void sierra_shutdown(struct usb_serial
*serial
)
608 struct usb_serial_port
*port
;
609 struct sierra_port_private
*portdata
;
611 dbg("%s", __FUNCTION__
);
613 for (i
= 0; i
< serial
->num_ports
; ++i
) {
614 port
= serial
->port
[i
];
617 portdata
= usb_get_serial_port_data(port
);
621 for (j
= 0; j
< N_IN_URB
; j
++) {
622 usb_kill_urb(portdata
->in_urbs
[j
]);
623 usb_free_urb(portdata
->in_urbs
[j
]);
624 portdata
->in_urbs
[j
] = NULL
;
627 usb_set_serial_port_data(port
, NULL
);
631 static struct usb_serial_driver sierra_1port_device
= {
633 .owner
= THIS_MODULE
,
636 .description
= "Sierra USB modem (1 port)",
637 .id_table
= id_table_1port
,
638 .usb_driver
= &sierra_driver
,
639 .num_interrupt_in
= NUM_DONT_CARE
,
644 .close
= sierra_close
,
645 .write
= sierra_write
,
646 .write_room
= sierra_write_room
,
647 .chars_in_buffer
= sierra_chars_in_buffer
,
648 .throttle
= sierra_rx_throttle
,
649 .unthrottle
= sierra_rx_unthrottle
,
650 .ioctl
= sierra_ioctl
,
651 .set_termios
= sierra_set_termios
,
652 .break_ctl
= sierra_break_ctl
,
653 .tiocmget
= sierra_tiocmget
,
654 .tiocmset
= sierra_tiocmset
,
655 .attach
= sierra_startup
,
656 .shutdown
= sierra_shutdown
,
657 .read_int_callback
= sierra_instat_callback
,
660 static struct usb_serial_driver sierra_3port_device
= {
662 .owner
= THIS_MODULE
,
665 .description
= "Sierra USB modem (3 port)",
666 .id_table
= id_table_3port
,
667 .usb_driver
= &sierra_driver
,
668 .num_interrupt_in
= NUM_DONT_CARE
,
673 .close
= sierra_close
,
674 .write
= sierra_write
,
675 .write_room
= sierra_write_room
,
676 .chars_in_buffer
= sierra_chars_in_buffer
,
677 .throttle
= sierra_rx_throttle
,
678 .unthrottle
= sierra_rx_unthrottle
,
679 .ioctl
= sierra_ioctl
,
680 .set_termios
= sierra_set_termios
,
681 .break_ctl
= sierra_break_ctl
,
682 .tiocmget
= sierra_tiocmget
,
683 .tiocmset
= sierra_tiocmset
,
684 .attach
= sierra_startup
,
685 .shutdown
= sierra_shutdown
,
686 .read_int_callback
= sierra_instat_callback
,
689 /* Functions used by new usb-serial code. */
690 static int __init
sierra_init(void)
693 retval
= usb_serial_register(&sierra_1port_device
);
695 goto failed_1port_device_register
;
696 retval
= usb_serial_register(&sierra_3port_device
);
698 goto failed_3port_device_register
;
701 retval
= usb_register(&sierra_driver
);
703 goto failed_driver_register
;
705 info(DRIVER_DESC
": " DRIVER_VERSION
);
709 failed_driver_register
:
710 usb_serial_deregister(&sierra_3port_device
);
711 failed_3port_device_register
:
712 usb_serial_deregister(&sierra_1port_device
);
713 failed_1port_device_register
:
717 static void __exit
sierra_exit(void)
719 usb_deregister (&sierra_driver
);
720 usb_serial_deregister(&sierra_1port_device
);
721 usb_serial_deregister(&sierra_3port_device
);
724 module_init(sierra_init
);
725 module_exit(sierra_exit
);
727 MODULE_AUTHOR(DRIVER_AUTHOR
);
728 MODULE_DESCRIPTION(DRIVER_DESC
);
729 MODULE_VERSION(DRIVER_VERSION
);
730 MODULE_LICENSE("GPL");
732 #ifdef CONFIG_USB_DEBUG
733 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
734 MODULE_PARM_DESC(debug
, "Debug messages");