1 /* 2 USB Driver for Sierra Wireless 3 4 Copyright (C) 2006, 2007, 2008 Kevin Lloyd <klloyd@sierrawireless.com>, 5 6 Copyright (C) 2008, 2009 Elina Pasheva, Matthew Safar, Rory Filer 7 <linux@sierrawireless.com> 8 9 IMPORTANT DISCLAIMER: This driver is not commercially supported by 10 Sierra Wireless. Use at your own risk. 11 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. 15 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> 18 */ 19 /* Uncomment to log function calls */ 20 /* #define DEBUG */ 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" 24 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> 34 35 #define SWIMS_USB_REQUEST_SetPower 0x00 36 #define SWIMS_USB_REQUEST_SetNmea 0x07 37 38 #define N_IN_URB_HM 8 39 #define N_OUT_URB_HM 64 40 #define N_IN_URB 4 41 #define N_OUT_URB 4 42 #define IN_BUFLEN 4096 43 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 */ 48 49 static int debug; 50 static int nmea; 51 52 /* Used in interface blacklisting */ 53 struct sierra_iface_info { 54 const u32 infolen; /* number of interface numbers on blacklist */ 55 const u8 *ifaceinfo; /* pointer to the array holding the numbers */ 56 }; 57 58 struct sierra_intf_private { 59 spinlock_t susp_lock; 60 unsigned int suspended:1; 61 int in_flight; 62 }; 63 64 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState) 65 { 66 int result; 67 dev_dbg(&udev->dev, "%s\n", __func__); 68 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 69 SWIMS_USB_REQUEST_SetPower, /* __u8 request */ 70 USB_TYPE_VENDOR, /* __u8 request type */ 71 swiState, /* __u16 value */ 72 0, /* __u16 index */ 73 NULL, /* void *data */ 74 0, /* __u16 size */ 75 USB_CTRL_SET_TIMEOUT); /* int timeout */ 76 return result; 77 } 78 79 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable) 80 { 81 int result; 82 dev_dbg(&udev->dev, "%s\n", __func__); 83 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 84 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */ 85 USB_TYPE_VENDOR, /* __u8 request type */ 86 enable, /* __u16 value */ 87 0x0000, /* __u16 index */ 88 NULL, /* void *data */ 89 0, /* __u16 size */ 90 USB_CTRL_SET_TIMEOUT); /* int timeout */ 91 return result; 92 } 93 94 static int sierra_calc_num_ports(struct usb_serial *serial) 95 { 96 int num_ports = 0; 97 u8 ifnum, numendpoints; 98 99 dev_dbg(&serial->dev->dev, "%s\n", __func__); 100 101 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber; 102 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints; 103 104 /* Dummy interface present on some SKUs should be ignored */ 105 if (ifnum == 0x99) 106 num_ports = 0; 107 else if (numendpoints <= 3) 108 num_ports = 1; 109 else 110 num_ports = (numendpoints-1)/2; 111 return num_ports; 112 } 113 114 static int is_blacklisted(const u8 ifnum, 115 const struct sierra_iface_info *blacklist) 116 { 117 const u8 *info; 118 int i; 119 120 if (blacklist) { 121 info = blacklist->ifaceinfo; 122 123 for (i = 0; i < blacklist->infolen; i++) { 124 if (info[i] == ifnum) 125 return 1; 126 } 127 } 128 return 0; 129 } 130 131 static int is_himemory(const u8 ifnum, 132 const struct sierra_iface_info *himemorylist) 133 { 134 const u8 *info; 135 int i; 136 137 if (himemorylist) { 138 info = himemorylist->ifaceinfo; 139 140 for (i=0; i < himemorylist->infolen; i++) { 141 if (info[i] == ifnum) 142 return 1; 143 } 144 } 145 return 0; 146 } 147 148 static int sierra_calc_interface(struct usb_serial *serial) 149 { 150 int interface; 151 struct usb_interface *p_interface; 152 struct usb_host_interface *p_host_interface; 153 dev_dbg(&serial->dev->dev, "%s\n", __func__); 154 155 /* Get the interface structure pointer from the serial struct */ 156 p_interface = serial->interface; 157 158 /* Get a pointer to the host interface structure */ 159 p_host_interface = p_interface->cur_altsetting; 160 161 /* read the interface descriptor for this active altsetting 162 * to find out the interface number we are on 163 */ 164 interface = p_host_interface->desc.bInterfaceNumber; 165 166 return interface; 167 } 168 169 static int sierra_probe(struct usb_serial *serial, 170 const struct usb_device_id *id) 171 { 172 int result = 0; 173 struct usb_device *udev; 174 struct sierra_intf_private *data; 175 u8 ifnum; 176 177 udev = serial->dev; 178 dev_dbg(&udev->dev, "%s\n", __func__); 179 180 ifnum = sierra_calc_interface(serial); 181 /* 182 * If this interface supports more than 1 alternate 183 * select the 2nd one 184 */ 185 if (serial->interface->num_altsetting == 2) { 186 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n", 187 ifnum); 188 /* We know the alternate setting is 1 for the MC8785 */ 189 usb_set_interface(udev, ifnum, 1); 190 } 191 192 /* ifnum could have changed - by calling usb_set_interface */ 193 ifnum = sierra_calc_interface(serial); 194 195 if (is_blacklisted(ifnum, 196 (struct sierra_iface_info *)id->driver_info)) { 197 dev_dbg(&serial->dev->dev, 198 "Ignoring blacklisted interface #%d\n", ifnum); 199 return -ENODEV; 200 } 201 202 data = serial->private = kzalloc(sizeof(struct sierra_intf_private), GFP_KERNEL); 203 if (!data) 204 return -ENOMEM; 205 spin_lock_init(&data->susp_lock); 206 207 return result; 208 } 209 210 /* interfaces with higher memory requirements */ 211 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 }; 212 static const struct sierra_iface_info typeA_interface_list = { 213 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces), 214 .ifaceinfo = hi_memory_typeA_ifaces, 215 }; 216 217 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 }; 218 static const struct sierra_iface_info typeB_interface_list = { 219 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces), 220 .ifaceinfo = hi_memory_typeB_ifaces, 221 }; 222 223 /* 'blacklist' of interfaces not served by this driver */ 224 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 }; 225 static const struct sierra_iface_info direct_ip_interface_blacklist = { 226 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces), 227 .ifaceinfo = direct_ip_non_serial_ifaces, 228 }; 229 230 static const struct usb_device_id id_table[] = { 231 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */ 232 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */ 233 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */ 234 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */ 235 236 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */ 237 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */ 238 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */ 239 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */ 240 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */ 241 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */ 242 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */ 243 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */ 244 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */ 245 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */ 246 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */ 247 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */ 248 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */ 249 /* Sierra Wireless C597 */ 250 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) }, 251 /* Sierra Wireless T598 */ 252 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) }, 253 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */ 254 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */ 255 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */ 256 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */ 257 258 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */ 259 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */ 260 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */ 261 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */ 262 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */ 263 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */ 264 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */ 265 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */ 266 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */ 267 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */ 268 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */ 269 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */ 270 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */ 271 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */ 272 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */ 273 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */ 274 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */ 275 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */ 276 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */ 277 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */ 278 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */ 279 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */ 280 { USB_DEVICE(0x1199, 0x683C) }, 281 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */ 282 /* Sierra Wireless MC8790, MC8791, MC8792 */ 283 { USB_DEVICE(0x1199, 0x683E) }, 284 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */ 285 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */ 286 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */ 287 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */ 288 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */ 289 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */ 290 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */ 291 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */ 292 /* Sierra Wireless C885 */ 293 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)}, 294 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */ 295 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)}, 296 /* Sierra Wireless C22/C33 */ 297 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)}, 298 /* Sierra Wireless HSPA Non-Composite Device */ 299 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)}, 300 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */ 301 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */ 302 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist 303 }, 304 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */ 305 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist 306 }, 307 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */ 308 309 { } 310 }; 311 MODULE_DEVICE_TABLE(usb, id_table); 312 313 314 struct sierra_port_private { 315 spinlock_t lock; /* lock the structure */ 316 int outstanding_urbs; /* number of out urbs in flight */ 317 struct usb_anchor active; 318 struct usb_anchor delayed; 319 320 int num_out_urbs; 321 int num_in_urbs; 322 /* Input endpoints and buffers for this port */ 323 struct urb *in_urbs[N_IN_URB_HM]; 324 325 /* Settings for the port */ 326 int rts_state; /* Handshaking pins (outputs) */ 327 int dtr_state; 328 int cts_state; /* Handshaking pins (inputs) */ 329 int dsr_state; 330 int dcd_state; 331 int ri_state; 332 unsigned int opened:1; 333 }; 334 335 static int sierra_send_setup(struct usb_serial_port *port) 336 { 337 struct usb_serial *serial = port->serial; 338 struct sierra_port_private *portdata; 339 __u16 interface = 0; 340 int val = 0; 341 int do_send = 0; 342 int retval; 343 344 dev_dbg(&port->dev, "%s\n", __func__); 345 346 portdata = usb_get_serial_port_data(port); 347 348 if (portdata->dtr_state) 349 val |= 0x01; 350 if (portdata->rts_state) 351 val |= 0x02; 352 353 /* If composite device then properly report interface */ 354 if (serial->num_ports == 1) { 355 interface = sierra_calc_interface(serial); 356 /* Control message is sent only to interfaces with 357 * interrupt_in endpoints 358 */ 359 if (port->interrupt_in_urb) { 360 /* send control message */ 361 do_send = 1; 362 } 363 } 364 365 /* Otherwise the need to do non-composite mapping */ 366 else { 367 if (port->bulk_out_endpointAddress == 2) 368 interface = 0; 369 else if (port->bulk_out_endpointAddress == 4) 370 interface = 1; 371 else if (port->bulk_out_endpointAddress == 5) 372 interface = 2; 373 374 do_send = 1; 375 } 376 if (!do_send) 377 return 0; 378 379 usb_autopm_get_interface(serial->interface); 380 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0), 381 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT); 382 usb_autopm_put_interface(serial->interface); 383 384 return retval; 385 } 386 387 static void sierra_set_termios(struct tty_struct *tty, 388 struct usb_serial_port *port, struct ktermios *old_termios) 389 { 390 dev_dbg(&port->dev, "%s\n", __func__); 391 tty_termios_copy_hw(tty->termios, old_termios); 392 sierra_send_setup(port); 393 } 394 395 static int sierra_tiocmget(struct tty_struct *tty, struct file *file) 396 { 397 struct usb_serial_port *port = tty->driver_data; 398 unsigned int value; 399 struct sierra_port_private *portdata; 400 401 dev_dbg(&port->dev, "%s\n", __func__); 402 portdata = usb_get_serial_port_data(port); 403 404 value = ((portdata->rts_state) ? TIOCM_RTS : 0) | 405 ((portdata->dtr_state) ? TIOCM_DTR : 0) | 406 ((portdata->cts_state) ? TIOCM_CTS : 0) | 407 ((portdata->dsr_state) ? TIOCM_DSR : 0) | 408 ((portdata->dcd_state) ? TIOCM_CAR : 0) | 409 ((portdata->ri_state) ? TIOCM_RNG : 0); 410 411 return value; 412 } 413 414 static int sierra_tiocmset(struct tty_struct *tty, struct file *file, 415 unsigned int set, unsigned int clear) 416 { 417 struct usb_serial_port *port = tty->driver_data; 418 struct sierra_port_private *portdata; 419 420 portdata = usb_get_serial_port_data(port); 421 422 if (set & TIOCM_RTS) 423 portdata->rts_state = 1; 424 if (set & TIOCM_DTR) 425 portdata->dtr_state = 1; 426 427 if (clear & TIOCM_RTS) 428 portdata->rts_state = 0; 429 if (clear & TIOCM_DTR) 430 portdata->dtr_state = 0; 431 return sierra_send_setup(port); 432 } 433 434 static void sierra_release_urb(struct urb *urb) 435 { 436 struct usb_serial_port *port; 437 if (urb) { 438 port = urb->context; 439 dev_dbg(&port->dev, "%s: %p\n", __func__, urb); 440 kfree(urb->transfer_buffer); 441 usb_free_urb(urb); 442 } 443 } 444 445 static void sierra_outdat_callback(struct urb *urb) 446 { 447 struct usb_serial_port *port = urb->context; 448 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 449 struct sierra_intf_private *intfdata; 450 int status = urb->status; 451 452 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number); 453 intfdata = port->serial->private; 454 455 /* free up the transfer buffer, as usb_free_urb() does not do this */ 456 kfree(urb->transfer_buffer); 457 usb_autopm_put_interface_async(port->serial->interface); 458 if (status) 459 dev_dbg(&port->dev, "%s - nonzero write bulk status " 460 "received: %d\n", __func__, status); 461 462 spin_lock(&portdata->lock); 463 --portdata->outstanding_urbs; 464 spin_unlock(&portdata->lock); 465 spin_lock(&intfdata->susp_lock); 466 --intfdata->in_flight; 467 spin_unlock(&intfdata->susp_lock); 468 469 usb_serial_port_softint(port); 470 } 471 472 /* Write */ 473 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port, 474 const unsigned char *buf, int count) 475 { 476 struct sierra_port_private *portdata; 477 struct sierra_intf_private *intfdata; 478 struct usb_serial *serial = port->serial; 479 unsigned long flags; 480 unsigned char *buffer; 481 struct urb *urb; 482 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER); 483 int retval = 0; 484 485 /* verify that we actually have some data to write */ 486 if (count == 0) 487 return 0; 488 489 portdata = usb_get_serial_port_data(port); 490 intfdata = serial->private; 491 492 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize); 493 spin_lock_irqsave(&portdata->lock, flags); 494 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__, 495 portdata->outstanding_urbs); 496 if (portdata->outstanding_urbs > portdata->num_out_urbs) { 497 spin_unlock_irqrestore(&portdata->lock, flags); 498 dev_dbg(&port->dev, "%s - write limit hit\n", __func__); 499 return 0; 500 } 501 portdata->outstanding_urbs++; 502 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__, 503 portdata->outstanding_urbs); 504 spin_unlock_irqrestore(&portdata->lock, flags); 505 506 retval = usb_autopm_get_interface_async(serial->interface); 507 if (retval < 0) { 508 spin_lock_irqsave(&portdata->lock, flags); 509 portdata->outstanding_urbs--; 510 spin_unlock_irqrestore(&portdata->lock, flags); 511 goto error_simple; 512 } 513 514 buffer = kmalloc(writesize, GFP_ATOMIC); 515 if (!buffer) { 516 dev_err(&port->dev, "out of memory\n"); 517 retval = -ENOMEM; 518 goto error_no_buffer; 519 } 520 521 urb = usb_alloc_urb(0, GFP_ATOMIC); 522 if (!urb) { 523 dev_err(&port->dev, "no more free urbs\n"); 524 retval = -ENOMEM; 525 goto error_no_urb; 526 } 527 528 memcpy(buffer, buf, writesize); 529 530 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer); 531 532 usb_fill_bulk_urb(urb, serial->dev, 533 usb_sndbulkpipe(serial->dev, 534 port->bulk_out_endpointAddress), 535 buffer, writesize, sierra_outdat_callback, port); 536 537 /* Handle the need to send a zero length packet */ 538 urb->transfer_flags |= URB_ZERO_PACKET; 539 540 spin_lock_irqsave(&intfdata->susp_lock, flags); 541 542 if (intfdata->suspended) { 543 usb_anchor_urb(urb, &portdata->delayed); 544 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 545 goto skip_power; 546 } else { 547 usb_anchor_urb(urb, &portdata->active); 548 } 549 /* send it down the pipe */ 550 retval = usb_submit_urb(urb, GFP_ATOMIC); 551 if (retval) { 552 usb_unanchor_urb(urb); 553 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 554 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed " 555 "with status = %d\n", __func__, retval); 556 goto error; 557 } else { 558 intfdata->in_flight++; 559 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 560 } 561 562 skip_power: 563 /* we are done with this urb, so let the host driver 564 * really free it when it is finished with it */ 565 usb_free_urb(urb); 566 567 return writesize; 568 error: 569 usb_free_urb(urb); 570 error_no_urb: 571 kfree(buffer); 572 error_no_buffer: 573 spin_lock_irqsave(&portdata->lock, flags); 574 --portdata->outstanding_urbs; 575 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__, 576 portdata->outstanding_urbs); 577 spin_unlock_irqrestore(&portdata->lock, flags); 578 usb_autopm_put_interface_async(serial->interface); 579 error_simple: 580 return retval; 581 } 582 583 static void sierra_indat_callback(struct urb *urb) 584 { 585 int err; 586 int endpoint; 587 struct usb_serial_port *port; 588 struct tty_struct *tty; 589 unsigned char *data = urb->transfer_buffer; 590 int status = urb->status; 591 592 endpoint = usb_pipeendpoint(urb->pipe); 593 port = urb->context; 594 595 dev_dbg(&port->dev, "%s: %p\n", __func__, urb); 596 597 if (status) { 598 dev_dbg(&port->dev, "%s: nonzero status: %d on" 599 " endpoint %02x\n", __func__, status, endpoint); 600 } else { 601 if (urb->actual_length) { 602 tty = tty_port_tty_get(&port->port); 603 if (tty) { 604 tty_insert_flip_string(tty, data, 605 urb->actual_length); 606 tty_flip_buffer_push(tty); 607 608 tty_kref_put(tty); 609 usb_serial_debug_data(debug, &port->dev, 610 __func__, urb->actual_length, data); 611 } 612 } else { 613 dev_dbg(&port->dev, "%s: empty read urb" 614 " received\n", __func__); 615 } 616 } 617 618 /* Resubmit urb so we continue receiving */ 619 if (status != -ESHUTDOWN && status != -EPERM) { 620 usb_mark_last_busy(port->serial->dev); 621 err = usb_submit_urb(urb, GFP_ATOMIC); 622 if (err && err != -EPERM) 623 dev_err(&port->dev, "resubmit read urb failed." 624 "(%d)\n", err); 625 } 626 } 627 628 static void sierra_instat_callback(struct urb *urb) 629 { 630 int err; 631 int status = urb->status; 632 struct usb_serial_port *port = urb->context; 633 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 634 struct usb_serial *serial = port->serial; 635 636 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__, 637 urb, port, portdata); 638 639 if (status == 0) { 640 struct usb_ctrlrequest *req_pkt = 641 (struct usb_ctrlrequest *)urb->transfer_buffer; 642 643 if (!req_pkt) { 644 dev_dbg(&port->dev, "%s: NULL req_pkt\n", 645 __func__); 646 return; 647 } 648 if ((req_pkt->bRequestType == 0xA1) && 649 (req_pkt->bRequest == 0x20)) { 650 int old_dcd_state; 651 unsigned char signals = *((unsigned char *) 652 urb->transfer_buffer + 653 sizeof(struct usb_ctrlrequest)); 654 struct tty_struct *tty; 655 656 dev_dbg(&port->dev, "%s: signal x%x\n", __func__, 657 signals); 658 659 old_dcd_state = portdata->dcd_state; 660 portdata->cts_state = 1; 661 portdata->dcd_state = ((signals & 0x01) ? 1 : 0); 662 portdata->dsr_state = ((signals & 0x02) ? 1 : 0); 663 portdata->ri_state = ((signals & 0x08) ? 1 : 0); 664 665 tty = tty_port_tty_get(&port->port); 666 if (tty && !C_CLOCAL(tty) && 667 old_dcd_state && !portdata->dcd_state) 668 tty_hangup(tty); 669 tty_kref_put(tty); 670 } else { 671 dev_dbg(&port->dev, "%s: type %x req %x\n", 672 __func__, req_pkt->bRequestType, 673 req_pkt->bRequest); 674 } 675 } else 676 dev_dbg(&port->dev, "%s: error %d\n", __func__, status); 677 678 /* Resubmit urb so we continue receiving IRQ data */ 679 if (status != -ESHUTDOWN && status != -ENOENT) { 680 usb_mark_last_busy(serial->dev); 681 urb->dev = serial->dev; 682 err = usb_submit_urb(urb, GFP_ATOMIC); 683 if (err && err != -EPERM) 684 dev_err(&port->dev, "%s: resubmit intr urb " 685 "failed. (%d)\n", __func__, err); 686 } 687 } 688 689 static int sierra_write_room(struct tty_struct *tty) 690 { 691 struct usb_serial_port *port = tty->driver_data; 692 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 693 unsigned long flags; 694 695 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number); 696 697 /* try to give a good number back based on if we have any free urbs at 698 * this point in time */ 699 spin_lock_irqsave(&portdata->lock, flags); 700 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) { 701 spin_unlock_irqrestore(&portdata->lock, flags); 702 dev_dbg(&port->dev, "%s - write limit hit\n", __func__); 703 return 0; 704 } 705 spin_unlock_irqrestore(&portdata->lock, flags); 706 707 return 2048; 708 } 709 710 static void sierra_stop_rx_urbs(struct usb_serial_port *port) 711 { 712 int i; 713 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 714 715 for (i = 0; i < portdata->num_in_urbs; i++) 716 usb_kill_urb(portdata->in_urbs[i]); 717 718 usb_kill_urb(port->interrupt_in_urb); 719 } 720 721 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags) 722 { 723 int ok_cnt; 724 int err = -EINVAL; 725 int i; 726 struct urb *urb; 727 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 728 729 ok_cnt = 0; 730 for (i = 0; i < portdata->num_in_urbs; i++) { 731 urb = portdata->in_urbs[i]; 732 if (!urb) 733 continue; 734 err = usb_submit_urb(urb, mem_flags); 735 if (err) { 736 dev_err(&port->dev, "%s: submit urb failed: %d\n", 737 __func__, err); 738 } else { 739 ok_cnt++; 740 } 741 } 742 743 if (ok_cnt && port->interrupt_in_urb) { 744 err = usb_submit_urb(port->interrupt_in_urb, mem_flags); 745 if (err) { 746 dev_err(&port->dev, "%s: submit intr urb failed: %d\n", 747 __func__, err); 748 } 749 } 750 751 if (ok_cnt > 0) /* at least one rx urb submitted */ 752 return 0; 753 else 754 return err; 755 } 756 757 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint, 758 int dir, void *ctx, int len, 759 gfp_t mem_flags, 760 usb_complete_t callback) 761 { 762 struct urb *urb; 763 u8 *buf; 764 765 if (endpoint == -1) 766 return NULL; 767 768 urb = usb_alloc_urb(0, mem_flags); 769 if (urb == NULL) { 770 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n", 771 __func__, endpoint); 772 return NULL; 773 } 774 775 buf = kmalloc(len, mem_flags); 776 if (buf) { 777 /* Fill URB using supplied data */ 778 usb_fill_bulk_urb(urb, serial->dev, 779 usb_sndbulkpipe(serial->dev, endpoint) | dir, 780 buf, len, callback, ctx); 781 782 /* debug */ 783 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__, 784 dir == USB_DIR_IN ? 'i' : 'o', urb, buf); 785 } else { 786 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__, 787 dir == USB_DIR_IN ? 'i' : 'o', urb, buf); 788 789 sierra_release_urb(urb); 790 urb = NULL; 791 } 792 793 return urb; 794 } 795 796 static void sierra_close(struct usb_serial_port *port) 797 { 798 int i; 799 struct usb_serial *serial = port->serial; 800 struct sierra_port_private *portdata; 801 struct sierra_intf_private *intfdata = port->serial->private; 802 803 804 dev_dbg(&port->dev, "%s\n", __func__); 805 portdata = usb_get_serial_port_data(port); 806 807 portdata->rts_state = 0; 808 portdata->dtr_state = 0; 809 810 if (serial->dev) { 811 mutex_lock(&serial->disc_mutex); 812 if (!serial->disconnected) { 813 serial->interface->needs_remote_wakeup = 0; 814 usb_autopm_get_interface(serial->interface); 815 sierra_send_setup(port); 816 } 817 mutex_unlock(&serial->disc_mutex); 818 spin_lock_irq(&intfdata->susp_lock); 819 portdata->opened = 0; 820 spin_unlock_irq(&intfdata->susp_lock); 821 822 823 /* Stop reading urbs */ 824 sierra_stop_rx_urbs(port); 825 /* .. and release them */ 826 for (i = 0; i < portdata->num_in_urbs; i++) { 827 sierra_release_urb(portdata->in_urbs[i]); 828 portdata->in_urbs[i] = NULL; 829 } 830 } 831 } 832 833 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port) 834 { 835 struct sierra_port_private *portdata; 836 struct usb_serial *serial = port->serial; 837 struct sierra_intf_private *intfdata = serial->private; 838 int i; 839 int err; 840 int endpoint; 841 struct urb *urb; 842 843 portdata = usb_get_serial_port_data(port); 844 845 dev_dbg(&port->dev, "%s\n", __func__); 846 847 /* Set some sane defaults */ 848 portdata->rts_state = 1; 849 portdata->dtr_state = 1; 850 851 852 endpoint = port->bulk_in_endpointAddress; 853 for (i = 0; i < portdata->num_in_urbs; i++) { 854 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port, 855 IN_BUFLEN, GFP_KERNEL, 856 sierra_indat_callback); 857 portdata->in_urbs[i] = urb; 858 } 859 /* clear halt condition */ 860 usb_clear_halt(serial->dev, 861 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN); 862 863 err = sierra_submit_rx_urbs(port, GFP_KERNEL); 864 if (err) { 865 /* get rid of everything as in close */ 866 sierra_close(port); 867 /* restore balance for autopm */ 868 usb_autopm_put_interface(serial->interface); 869 return err; 870 } 871 sierra_send_setup(port); 872 873 serial->interface->needs_remote_wakeup = 1; 874 spin_lock_irq(&intfdata->susp_lock); 875 portdata->opened = 1; 876 spin_unlock_irq(&intfdata->susp_lock); 877 usb_autopm_put_interface(serial->interface); 878 879 return 0; 880 } 881 882 883 static void sierra_dtr_rts(struct usb_serial_port *port, int on) 884 { 885 struct usb_serial *serial = port->serial; 886 struct sierra_port_private *portdata; 887 888 portdata = usb_get_serial_port_data(port); 889 portdata->rts_state = on; 890 portdata->dtr_state = on; 891 892 if (serial->dev) { 893 mutex_lock(&serial->disc_mutex); 894 if (!serial->disconnected) 895 sierra_send_setup(port); 896 mutex_unlock(&serial->disc_mutex); 897 } 898 } 899 900 static int sierra_startup(struct usb_serial *serial) 901 { 902 struct usb_serial_port *port; 903 struct sierra_port_private *portdata; 904 struct sierra_iface_info *himemoryp = NULL; 905 int i; 906 u8 ifnum; 907 908 dev_dbg(&serial->dev->dev, "%s\n", __func__); 909 910 /* Set Device mode to D0 */ 911 sierra_set_power_state(serial->dev, 0x0000); 912 913 /* Check NMEA and set */ 914 if (nmea) 915 sierra_vsc_set_nmea(serial->dev, 1); 916 917 /* Now setup per port private data */ 918 for (i = 0; i < serial->num_ports; i++) { 919 port = serial->port[i]; 920 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL); 921 if (!portdata) { 922 dev_dbg(&port->dev, "%s: kmalloc for " 923 "sierra_port_private (%d) failed!\n", 924 __func__, i); 925 return -ENOMEM; 926 } 927 spin_lock_init(&portdata->lock); 928 init_usb_anchor(&portdata->active); 929 init_usb_anchor(&portdata->delayed); 930 ifnum = i; 931 /* Assume low memory requirements */ 932 portdata->num_out_urbs = N_OUT_URB; 933 portdata->num_in_urbs = N_IN_URB; 934 935 /* Determine actual memory requirements */ 936 if (serial->num_ports == 1) { 937 /* Get interface number for composite device */ 938 ifnum = sierra_calc_interface(serial); 939 himemoryp = 940 (struct sierra_iface_info *)&typeB_interface_list; 941 if (is_himemory(ifnum, himemoryp)) { 942 portdata->num_out_urbs = N_OUT_URB_HM; 943 portdata->num_in_urbs = N_IN_URB_HM; 944 } 945 } 946 else { 947 himemoryp = 948 (struct sierra_iface_info *)&typeA_interface_list; 949 if (is_himemory(i, himemoryp)) { 950 portdata->num_out_urbs = N_OUT_URB_HM; 951 portdata->num_in_urbs = N_IN_URB_HM; 952 } 953 } 954 dev_dbg(&serial->dev->dev, 955 "Memory usage (urbs) interface #%d, in=%d, out=%d\n", 956 ifnum,portdata->num_in_urbs, portdata->num_out_urbs ); 957 /* Set the port private data pointer */ 958 usb_set_serial_port_data(port, portdata); 959 } 960 961 return 0; 962 } 963 964 static void sierra_release(struct usb_serial *serial) 965 { 966 int i; 967 struct usb_serial_port *port; 968 struct sierra_port_private *portdata; 969 970 dev_dbg(&serial->dev->dev, "%s\n", __func__); 971 972 for (i = 0; i < serial->num_ports; ++i) { 973 port = serial->port[i]; 974 if (!port) 975 continue; 976 portdata = usb_get_serial_port_data(port); 977 if (!portdata) 978 continue; 979 kfree(portdata); 980 } 981 } 982 983 #ifdef CONFIG_PM 984 static void stop_read_write_urbs(struct usb_serial *serial) 985 { 986 int i; 987 struct usb_serial_port *port; 988 struct sierra_port_private *portdata; 989 990 /* Stop reading/writing urbs */ 991 for (i = 0; i < serial->num_ports; ++i) { 992 port = serial->port[i]; 993 portdata = usb_get_serial_port_data(port); 994 sierra_stop_rx_urbs(port); 995 usb_kill_anchored_urbs(&portdata->active); 996 } 997 } 998 999 static int sierra_suspend(struct usb_serial *serial, pm_message_t message) 1000 { 1001 struct sierra_intf_private *intfdata; 1002 int b; 1003 1004 if (message.event & PM_EVENT_AUTO) { 1005 intfdata = serial->private; 1006 spin_lock_irq(&intfdata->susp_lock); 1007 b = intfdata->in_flight; 1008 1009 if (b) { 1010 spin_unlock_irq(&intfdata->susp_lock); 1011 return -EBUSY; 1012 } else { 1013 intfdata->suspended = 1; 1014 spin_unlock_irq(&intfdata->susp_lock); 1015 } 1016 } 1017 stop_read_write_urbs(serial); 1018 1019 return 0; 1020 } 1021 1022 static int sierra_resume(struct usb_serial *serial) 1023 { 1024 struct usb_serial_port *port; 1025 struct sierra_intf_private *intfdata = serial->private; 1026 struct sierra_port_private *portdata; 1027 struct urb *urb; 1028 int ec = 0; 1029 int i, err; 1030 1031 spin_lock_irq(&intfdata->susp_lock); 1032 for (i = 0; i < serial->num_ports; i++) { 1033 port = serial->port[i]; 1034 portdata = usb_get_serial_port_data(port); 1035 1036 while ((urb = usb_get_from_anchor(&portdata->delayed))) { 1037 usb_anchor_urb(urb, &portdata->active); 1038 intfdata->in_flight++; 1039 err = usb_submit_urb(urb, GFP_ATOMIC); 1040 if (err < 0) { 1041 intfdata->in_flight--; 1042 usb_unanchor_urb(urb); 1043 usb_scuttle_anchored_urbs(&portdata->delayed); 1044 break; 1045 } 1046 } 1047 1048 if (portdata->opened) { 1049 err = sierra_submit_rx_urbs(port, GFP_ATOMIC); 1050 if (err) 1051 ec++; 1052 } 1053 } 1054 intfdata->suspended = 0; 1055 spin_unlock_irq(&intfdata->susp_lock); 1056 1057 return ec ? -EIO : 0; 1058 } 1059 1060 static int sierra_reset_resume(struct usb_interface *intf) 1061 { 1062 struct usb_serial *serial = usb_get_intfdata(intf); 1063 dev_err(&serial->dev->dev, "%s\n", __func__); 1064 return usb_serial_resume(intf); 1065 } 1066 #else 1067 #define sierra_suspend NULL 1068 #define sierra_resume NULL 1069 #define sierra_reset_resume NULL 1070 #endif 1071 1072 static struct usb_driver sierra_driver = { 1073 .name = "sierra", 1074 .probe = usb_serial_probe, 1075 .disconnect = usb_serial_disconnect, 1076 .suspend = usb_serial_suspend, 1077 .resume = usb_serial_resume, 1078 .reset_resume = sierra_reset_resume, 1079 .id_table = id_table, 1080 .no_dynamic_id = 1, 1081 .supports_autosuspend = 1, 1082 }; 1083 1084 static struct usb_serial_driver sierra_device = { 1085 .driver = { 1086 .owner = THIS_MODULE, 1087 .name = "sierra", 1088 }, 1089 .description = "Sierra USB modem", 1090 .id_table = id_table, 1091 .usb_driver = &sierra_driver, 1092 .calc_num_ports = sierra_calc_num_ports, 1093 .probe = sierra_probe, 1094 .open = sierra_open, 1095 .close = sierra_close, 1096 .dtr_rts = sierra_dtr_rts, 1097 .write = sierra_write, 1098 .write_room = sierra_write_room, 1099 .set_termios = sierra_set_termios, 1100 .tiocmget = sierra_tiocmget, 1101 .tiocmset = sierra_tiocmset, 1102 .attach = sierra_startup, 1103 .release = sierra_release, 1104 .suspend = sierra_suspend, 1105 .resume = sierra_resume, 1106 .read_int_callback = sierra_instat_callback, 1107 }; 1108 1109 /* Functions used by new usb-serial code. */ 1110 static int __init sierra_init(void) 1111 { 1112 int retval; 1113 retval = usb_serial_register(&sierra_device); 1114 if (retval) 1115 goto failed_device_register; 1116 1117 1118 retval = usb_register(&sierra_driver); 1119 if (retval) 1120 goto failed_driver_register; 1121 1122 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":" 1123 DRIVER_DESC "\n"); 1124 1125 return 0; 1126 1127 failed_driver_register: 1128 usb_serial_deregister(&sierra_device); 1129 failed_device_register: 1130 return retval; 1131 } 1132 1133 static void __exit sierra_exit(void) 1134 { 1135 usb_deregister(&sierra_driver); 1136 usb_serial_deregister(&sierra_device); 1137 } 1138 1139 module_init(sierra_init); 1140 module_exit(sierra_exit); 1141 1142 MODULE_AUTHOR(DRIVER_AUTHOR); 1143 MODULE_DESCRIPTION(DRIVER_DESC); 1144 MODULE_VERSION(DRIVER_VERSION); 1145 MODULE_LICENSE("GPL"); 1146 1147 module_param(nmea, bool, S_IRUGO | S_IWUSR); 1148 MODULE_PARM_DESC(nmea, "NMEA streaming"); 1149 1150 module_param(debug, bool, S_IRUGO | S_IWUSR); 1151 MODULE_PARM_DESC(debug, "Debug messages"); 1152