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/tty_flip.h> 30 #include <linux/module.h> 31 #include <linux/usb.h> 32 #include <linux/usb/serial.h> 33 34 #define SWIMS_USB_REQUEST_SetPower 0x00 35 #define SWIMS_USB_REQUEST_SetNmea 0x07 36 37 #define N_IN_URB_HM 8 38 #define N_OUT_URB_HM 64 39 #define N_IN_URB 4 40 #define N_OUT_URB 4 41 #define IN_BUFLEN 4096 42 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 */ 47 48 static int debug; 49 static int nmea; 50 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 */ 55 }; 56 57 struct sierra_intf_private { 58 spinlock_t susp_lock; 59 unsigned int suspended:1; 60 int in_flight; 61 }; 62 63 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState) 64 { 65 int result; 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 */ 71 0, /* __u16 index */ 72 NULL, /* void *data */ 73 0, /* __u16 size */ 74 USB_CTRL_SET_TIMEOUT); /* int timeout */ 75 return result; 76 } 77 78 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable) 79 { 80 int result; 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 */ 88 0, /* __u16 size */ 89 USB_CTRL_SET_TIMEOUT); /* int timeout */ 90 return result; 91 } 92 93 static int sierra_calc_num_ports(struct usb_serial *serial) 94 { 95 int num_ports = 0; 96 u8 ifnum, numendpoints; 97 98 dev_dbg(&serial->dev->dev, "%s\n", __func__); 99 100 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber; 101 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints; 102 103 /* Dummy interface present on some SKUs should be ignored */ 104 if (ifnum == 0x99) 105 num_ports = 0; 106 else if (numendpoints <= 3) 107 num_ports = 1; 108 else 109 num_ports = (numendpoints-1)/2; 110 return num_ports; 111 } 112 113 static int is_blacklisted(const u8 ifnum, 114 const struct sierra_iface_info *blacklist) 115 { 116 const u8 *info; 117 int i; 118 119 if (blacklist) { 120 info = blacklist->ifaceinfo; 121 122 for (i = 0; i < blacklist->infolen; i++) { 123 if (info[i] == ifnum) 124 return 1; 125 } 126 } 127 return 0; 128 } 129 130 static int is_himemory(const u8 ifnum, 131 const struct sierra_iface_info *himemorylist) 132 { 133 const u8 *info; 134 int i; 135 136 if (himemorylist) { 137 info = himemorylist->ifaceinfo; 138 139 for (i=0; i < himemorylist->infolen; i++) { 140 if (info[i] == ifnum) 141 return 1; 142 } 143 } 144 return 0; 145 } 146 147 static int sierra_calc_interface(struct usb_serial *serial) 148 { 149 int interface; 150 struct usb_interface *p_interface; 151 struct usb_host_interface *p_host_interface; 152 dev_dbg(&serial->dev->dev, "%s\n", __func__); 153 154 /* Get the interface structure pointer from the serial struct */ 155 p_interface = serial->interface; 156 157 /* Get a pointer to the host interface structure */ 158 p_host_interface = p_interface->cur_altsetting; 159 160 /* read the interface descriptor for this active altsetting 161 * to find out the interface number we are on 162 */ 163 interface = p_host_interface->desc.bInterfaceNumber; 164 165 return interface; 166 } 167 168 static int sierra_probe(struct usb_serial *serial, 169 const struct usb_device_id *id) 170 { 171 int result = 0; 172 struct usb_device *udev; 173 struct sierra_intf_private *data; 174 u8 ifnum; 175 176 udev = serial->dev; 177 dev_dbg(&udev->dev, "%s\n", __func__); 178 179 ifnum = sierra_calc_interface(serial); 180 /* 181 * If this interface supports more than 1 alternate 182 * select the 2nd one 183 */ 184 if (serial->interface->num_altsetting == 2) { 185 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n", 186 ifnum); 187 /* We know the alternate setting is 1 for the MC8785 */ 188 usb_set_interface(udev, ifnum, 1); 189 } 190 191 /* ifnum could have changed - by calling usb_set_interface */ 192 ifnum = sierra_calc_interface(serial); 193 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); 198 return -ENODEV; 199 } 200 201 data = serial->private = kzalloc(sizeof(struct sierra_intf_private), GFP_KERNEL); 202 if (!data) 203 return -ENOMEM; 204 spin_lock_init(&data->susp_lock); 205 206 return result; 207 } 208 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, 214 }; 215 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, 220 }; 221 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, 227 }; 228 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 */ 233 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 */ 254 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 300 }, 301 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */ 302 303 { } 304 }; 305 MODULE_DEVICE_TABLE(usb, id_table); 306 307 static struct usb_driver sierra_driver = { 308 .name = "sierra", 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, 314 .no_dynamic_id = 1, 315 .supports_autosuspend = 1, 316 }; 317 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; 323 324 int num_out_urbs; 325 int num_in_urbs; 326 /* Input endpoints and buffers for this port */ 327 struct urb *in_urbs[N_IN_URB_HM]; 328 329 /* Settings for the port */ 330 int rts_state; /* Handshaking pins (outputs) */ 331 int dtr_state; 332 int cts_state; /* Handshaking pins (inputs) */ 333 int dsr_state; 334 int dcd_state; 335 int ri_state; 336 unsigned int opened:1; 337 }; 338 339 static int sierra_send_setup(struct usb_serial_port *port) 340 { 341 struct usb_serial *serial = port->serial; 342 struct sierra_port_private *portdata; 343 __u16 interface = 0; 344 int val = 0; 345 int do_send = 0; 346 int retval; 347 348 dev_dbg(&port->dev, "%s\n", __func__); 349 350 portdata = usb_get_serial_port_data(port); 351 352 if (portdata->dtr_state) 353 val |= 0x01; 354 if (portdata->rts_state) 355 val |= 0x02; 356 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 362 */ 363 if (port->interrupt_in_urb) { 364 /* send control message */ 365 do_send = 1; 366 } 367 } 368 369 /* Otherwise the need to do non-composite mapping */ 370 else { 371 if (port->bulk_out_endpointAddress == 2) 372 interface = 0; 373 else if (port->bulk_out_endpointAddress == 4) 374 interface = 1; 375 else if (port->bulk_out_endpointAddress == 5) 376 interface = 2; 377 378 do_send = 1; 379 } 380 if (!do_send) 381 return 0; 382 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); 387 388 return retval; 389 } 390 391 static void sierra_set_termios(struct tty_struct *tty, 392 struct usb_serial_port *port, struct ktermios *old_termios) 393 { 394 dev_dbg(&port->dev, "%s\n", __func__); 395 tty_termios_copy_hw(tty->termios, old_termios); 396 sierra_send_setup(port); 397 } 398 399 static int sierra_tiocmget(struct tty_struct *tty, struct file *file) 400 { 401 struct usb_serial_port *port = tty->driver_data; 402 unsigned int value; 403 struct sierra_port_private *portdata; 404 405 dev_dbg(&port->dev, "%s\n", __func__); 406 portdata = usb_get_serial_port_data(port); 407 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); 414 415 return value; 416 } 417 418 static int sierra_tiocmset(struct tty_struct *tty, struct file *file, 419 unsigned int set, unsigned int clear) 420 { 421 struct usb_serial_port *port = tty->driver_data; 422 struct sierra_port_private *portdata; 423 424 portdata = usb_get_serial_port_data(port); 425 426 if (set & TIOCM_RTS) 427 portdata->rts_state = 1; 428 if (set & TIOCM_DTR) 429 portdata->dtr_state = 1; 430 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); 436 } 437 438 static void sierra_release_urb(struct urb *urb) 439 { 440 struct usb_serial_port *port; 441 if (urb) { 442 port = urb->context; 443 dev_dbg(&port->dev, "%s: %p\n", __func__, urb); 444 kfree(urb->transfer_buffer); 445 usb_free_urb(urb); 446 } 447 } 448 449 static void sierra_outdat_callback(struct urb *urb) 450 { 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; 455 456 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number); 457 intfdata = port->serial->private; 458 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); 462 if (status) 463 dev_dbg(&port->dev, "%s - nonzero write bulk status " 464 "received: %d\n", __func__, status); 465 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); 472 473 usb_serial_port_softint(port); 474 } 475 476 /* Write */ 477 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port, 478 const unsigned char *buf, int count) 479 { 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; 483 unsigned long flags; 484 unsigned char *buffer; 485 struct urb *urb; 486 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER); 487 int retval = 0; 488 489 /* verify that we actually have some data to write */ 490 if (count == 0) 491 return 0; 492 493 portdata = usb_get_serial_port_data(port); 494 intfdata = serial->private; 495 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__); 503 return 0; 504 } 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); 509 510 retval = usb_autopm_get_interface_async(serial->interface); 511 if (retval < 0) { 512 spin_lock_irqsave(&portdata->lock, flags); 513 portdata->outstanding_urbs--; 514 spin_unlock_irqrestore(&portdata->lock, flags); 515 goto error_simple; 516 } 517 518 buffer = kmalloc(writesize, GFP_ATOMIC); 519 if (!buffer) { 520 dev_err(&port->dev, "out of memory\n"); 521 retval = -ENOMEM; 522 goto error_no_buffer; 523 } 524 525 urb = usb_alloc_urb(0, GFP_ATOMIC); 526 if (!urb) { 527 dev_err(&port->dev, "no more free urbs\n"); 528 retval = -ENOMEM; 529 goto error_no_urb; 530 } 531 532 memcpy(buffer, buf, writesize); 533 534 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer); 535 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); 540 541 /* Handle the need to send a zero length packet */ 542 urb->transfer_flags |= URB_ZERO_PACKET; 543 544 spin_lock_irqsave(&intfdata->susp_lock, flags); 545 546 if (intfdata->suspended) { 547 usb_anchor_urb(urb, &portdata->delayed); 548 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 549 goto skip_power; 550 } else { 551 usb_anchor_urb(urb, &portdata->active); 552 } 553 /* send it down the pipe */ 554 retval = usb_submit_urb(urb, GFP_ATOMIC); 555 if (retval) { 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); 560 goto error; 561 } else { 562 intfdata->in_flight++; 563 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 564 } 565 566 skip_power: 567 /* we are done with this urb, so let the host driver 568 * really free it when it is finished with it */ 569 usb_free_urb(urb); 570 571 return writesize; 572 error: 573 usb_free_urb(urb); 574 error_no_urb: 575 kfree(buffer); 576 error_no_buffer: 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); 583 error_simple: 584 return retval; 585 } 586 587 static void sierra_indat_callback(struct urb *urb) 588 { 589 int err; 590 int endpoint; 591 struct usb_serial_port *port; 592 struct tty_struct *tty; 593 unsigned char *data = urb->transfer_buffer; 594 int status = urb->status; 595 596 endpoint = usb_pipeendpoint(urb->pipe); 597 port = urb->context; 598 599 dev_dbg(&port->dev, "%s: %p\n", __func__, urb); 600 601 if (status) { 602 dev_dbg(&port->dev, "%s: nonzero status: %d on" 603 " endpoint %02x\n", __func__, status, endpoint); 604 } else { 605 if (urb->actual_length) { 606 tty = tty_port_tty_get(&port->port); 607 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); 611 612 tty_kref_put(tty); 613 usb_serial_debug_data(debug, &port->dev, __func__, 614 urb->actual_length, data); 615 } else { 616 dev_dbg(&port->dev, "%s: empty read urb" 617 " received\n", __func__); 618 } 619 } 620 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); 625 if (err) 626 dev_err(&port->dev, "resubmit read urb failed." 627 "(%d)\n", err); 628 } 629 630 return; 631 } 632 633 static void sierra_instat_callback(struct urb *urb) 634 { 635 int err; 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; 640 641 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__, 642 urb, port, portdata); 643 644 if (status == 0) { 645 struct usb_ctrlrequest *req_pkt = 646 (struct usb_ctrlrequest *)urb->transfer_buffer; 647 648 if (!req_pkt) { 649 dev_dbg(&port->dev, "%s: NULL req_pkt\n", 650 __func__); 651 return; 652 } 653 if ((req_pkt->bRequestType == 0xA1) && 654 (req_pkt->bRequest == 0x20)) { 655 int old_dcd_state; 656 unsigned char signals = *((unsigned char *) 657 urb->transfer_buffer + 658 sizeof(struct usb_ctrlrequest)); 659 struct tty_struct *tty; 660 661 dev_dbg(&port->dev, "%s: signal x%x\n", __func__, 662 signals); 663 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); 669 670 tty = tty_port_tty_get(&port->port); 671 if (tty && !C_CLOCAL(tty) && 672 old_dcd_state && !portdata->dcd_state) 673 tty_hangup(tty); 674 tty_kref_put(tty); 675 } else { 676 dev_dbg(&port->dev, "%s: type %x req %x\n", 677 __func__, req_pkt->bRequestType, 678 req_pkt->bRequest); 679 } 680 } else 681 dev_dbg(&port->dev, "%s: error %d\n", __func__, status); 682 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); 688 if (err) 689 dev_err(&port->dev, "%s: resubmit intr urb " 690 "failed. (%d)\n", __func__, err); 691 } 692 } 693 694 static int sierra_write_room(struct tty_struct *tty) 695 { 696 struct usb_serial_port *port = tty->driver_data; 697 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 698 unsigned long flags; 699 700 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number); 701 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__); 708 return 0; 709 } 710 spin_unlock_irqrestore(&portdata->lock, flags); 711 712 return 2048; 713 } 714 715 static void sierra_stop_rx_urbs(struct usb_serial_port *port) 716 { 717 int i; 718 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 719 720 for (i = 0; i < portdata->num_in_urbs; i++) 721 usb_kill_urb(portdata->in_urbs[i]); 722 723 usb_kill_urb(port->interrupt_in_urb); 724 } 725 726 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags) 727 { 728 int ok_cnt; 729 int err = -EINVAL; 730 int i; 731 struct urb *urb; 732 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 733 734 ok_cnt = 0; 735 for (i = 0; i < portdata->num_in_urbs; i++) { 736 urb = portdata->in_urbs[i]; 737 if (!urb) 738 continue; 739 err = usb_submit_urb(urb, mem_flags); 740 if (err) { 741 dev_err(&port->dev, "%s: submit urb failed: %d\n", 742 __func__, err); 743 } else { 744 ok_cnt++; 745 } 746 } 747 748 if (ok_cnt && port->interrupt_in_urb) { 749 err = usb_submit_urb(port->interrupt_in_urb, mem_flags); 750 if (err) { 751 dev_err(&port->dev, "%s: submit intr urb failed: %d\n", 752 __func__, err); 753 } 754 } 755 756 if (ok_cnt > 0) /* at least one rx urb submitted */ 757 return 0; 758 else 759 return err; 760 } 761 762 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint, 763 int dir, void *ctx, int len, 764 gfp_t mem_flags, 765 usb_complete_t callback) 766 { 767 struct urb *urb; 768 u8 *buf; 769 770 if (endpoint == -1) 771 return NULL; 772 773 urb = usb_alloc_urb(0, mem_flags); 774 if (urb == NULL) { 775 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n", 776 __func__, endpoint); 777 return NULL; 778 } 779 780 buf = kmalloc(len, mem_flags); 781 if (buf) { 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); 786 787 /* debug */ 788 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__, 789 dir == USB_DIR_IN ? 'i' : 'o', urb, buf); 790 } else { 791 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__, 792 dir == USB_DIR_IN ? 'i' : 'o', urb, buf); 793 794 sierra_release_urb(urb); 795 urb = NULL; 796 } 797 798 return urb; 799 } 800 801 static void sierra_close(struct usb_serial_port *port) 802 { 803 int i; 804 struct usb_serial *serial = port->serial; 805 struct sierra_port_private *portdata; 806 struct sierra_intf_private *intfdata = port->serial->private; 807 808 809 dev_dbg(&port->dev, "%s\n", __func__); 810 portdata = usb_get_serial_port_data(port); 811 812 portdata->rts_state = 0; 813 portdata->dtr_state = 0; 814 815 if (serial->dev) { 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); 821 } 822 mutex_unlock(&serial->disc_mutex); 823 spin_lock_irq(&intfdata->susp_lock); 824 portdata->opened = 0; 825 spin_unlock_irq(&intfdata->susp_lock); 826 827 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; 834 } 835 } 836 } 837 838 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port) 839 { 840 struct sierra_port_private *portdata; 841 struct usb_serial *serial = port->serial; 842 struct sierra_intf_private *intfdata = serial->private; 843 int i; 844 int err; 845 int endpoint; 846 struct urb *urb; 847 848 portdata = usb_get_serial_port_data(port); 849 850 dev_dbg(&port->dev, "%s\n", __func__); 851 852 /* Set some sane defaults */ 853 portdata->rts_state = 1; 854 portdata->dtr_state = 1; 855 856 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; 863 } 864 /* clear halt condition */ 865 usb_clear_halt(serial->dev, 866 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN); 867 868 err = sierra_submit_rx_urbs(port, GFP_KERNEL); 869 if (err) { 870 /* get rid of everything as in close */ 871 sierra_close(port); 872 /* restore balance for autopm */ 873 usb_autopm_put_interface(serial->interface); 874 return err; 875 } 876 sierra_send_setup(port); 877 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); 883 884 return 0; 885 } 886 887 888 static void sierra_dtr_rts(struct usb_serial_port *port, int on) 889 { 890 struct usb_serial *serial = port->serial; 891 struct sierra_port_private *portdata; 892 893 portdata = usb_get_serial_port_data(port); 894 portdata->rts_state = on; 895 portdata->dtr_state = on; 896 897 if (serial->dev) { 898 mutex_lock(&serial->disc_mutex); 899 if (!serial->disconnected) 900 sierra_send_setup(port); 901 mutex_unlock(&serial->disc_mutex); 902 } 903 } 904 905 static int sierra_startup(struct usb_serial *serial) 906 { 907 struct usb_serial_port *port; 908 struct sierra_port_private *portdata; 909 struct sierra_iface_info *himemoryp = NULL; 910 int i; 911 u8 ifnum; 912 913 dev_dbg(&serial->dev->dev, "%s\n", __func__); 914 915 /* Set Device mode to D0 */ 916 sierra_set_power_state(serial->dev, 0x0000); 917 918 /* Check NMEA and set */ 919 if (nmea) 920 sierra_vsc_set_nmea(serial->dev, 1); 921 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); 926 if (!portdata) { 927 dev_dbg(&port->dev, "%s: kmalloc for " 928 "sierra_port_private (%d) failed!\n", 929 __func__, i); 930 return -ENOMEM; 931 } 932 spin_lock_init(&portdata->lock); 933 init_usb_anchor(&portdata->active); 934 init_usb_anchor(&portdata->delayed); 935 ifnum = i; 936 /* Assume low memory requirements */ 937 portdata->num_out_urbs = N_OUT_URB; 938 portdata->num_in_urbs = N_IN_URB; 939 940 /* Determine actual memory requirements */ 941 if (serial->num_ports == 1) { 942 /* Get interface number for composite device */ 943 ifnum = sierra_calc_interface(serial); 944 himemoryp = 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; 949 } 950 } 951 else { 952 himemoryp = 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; 957 } 958 } 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); 964 } 965 966 return 0; 967 } 968 969 static void sierra_release(struct usb_serial *serial) 970 { 971 int i; 972 struct usb_serial_port *port; 973 struct sierra_port_private *portdata; 974 975 dev_dbg(&serial->dev->dev, "%s\n", __func__); 976 977 for (i = 0; i < serial->num_ports; ++i) { 978 port = serial->port[i]; 979 if (!port) 980 continue; 981 portdata = usb_get_serial_port_data(port); 982 if (!portdata) 983 continue; 984 kfree(portdata); 985 } 986 } 987 988 #ifdef CONFIG_PM 989 static void stop_read_write_urbs(struct usb_serial *serial) 990 { 991 int i; 992 struct usb_serial_port *port; 993 struct sierra_port_private *portdata; 994 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); 1001 } 1002 } 1003 1004 static int sierra_suspend(struct usb_serial *serial, pm_message_t message) 1005 { 1006 struct sierra_intf_private *intfdata; 1007 int b; 1008 1009 if (message.event & PM_EVENT_AUTO) { 1010 intfdata = serial->private; 1011 spin_lock_irq(&intfdata->susp_lock); 1012 b = intfdata->in_flight; 1013 1014 if (b) { 1015 spin_unlock_irq(&intfdata->susp_lock); 1016 return -EBUSY; 1017 } else { 1018 intfdata->suspended = 1; 1019 spin_unlock_irq(&intfdata->susp_lock); 1020 } 1021 } 1022 stop_read_write_urbs(serial); 1023 1024 return 0; 1025 } 1026 1027 static int sierra_resume(struct usb_serial *serial) 1028 { 1029 struct usb_serial_port *port; 1030 struct sierra_intf_private *intfdata = serial->private; 1031 struct sierra_port_private *portdata; 1032 struct urb *urb; 1033 int ec = 0; 1034 int i, err; 1035 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); 1040 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); 1045 if (err < 0) { 1046 intfdata->in_flight--; 1047 usb_unanchor_urb(urb); 1048 usb_scuttle_anchored_urbs(&portdata->delayed); 1049 break; 1050 } 1051 } 1052 1053 if (portdata->opened) { 1054 err = sierra_submit_rx_urbs(port, GFP_ATOMIC); 1055 if (err) 1056 ec++; 1057 } 1058 } 1059 intfdata->suspended = 0; 1060 spin_unlock_irq(&intfdata->susp_lock); 1061 1062 return ec ? -EIO : 0; 1063 } 1064 #else 1065 #define sierra_suspend NULL 1066 #define sierra_resume NULL 1067 #endif 1068 1069 static struct usb_serial_driver sierra_device = { 1070 .driver = { 1071 .owner = THIS_MODULE, 1072 .name = "sierra", 1073 }, 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, 1092 }; 1093 1094 /* Functions used by new usb-serial code. */ 1095 static int __init sierra_init(void) 1096 { 1097 int retval; 1098 retval = usb_serial_register(&sierra_device); 1099 if (retval) 1100 goto failed_device_register; 1101 1102 1103 retval = usb_register(&sierra_driver); 1104 if (retval) 1105 goto failed_driver_register; 1106 1107 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":" 1108 DRIVER_DESC "\n"); 1109 1110 return 0; 1111 1112 failed_driver_register: 1113 usb_serial_deregister(&sierra_device); 1114 failed_device_register: 1115 return retval; 1116 } 1117 1118 static void __exit sierra_exit(void) 1119 { 1120 usb_deregister(&sierra_driver); 1121 usb_serial_deregister(&sierra_device); 1122 } 1123 1124 module_init(sierra_init); 1125 module_exit(sierra_exit); 1126 1127 MODULE_AUTHOR(DRIVER_AUTHOR); 1128 MODULE_DESCRIPTION(DRIVER_DESC); 1129 MODULE_VERSION(DRIVER_VERSION); 1130 MODULE_LICENSE("GPL"); 1131 1132 module_param(nmea, bool, S_IRUGO | S_IWUSR); 1133 MODULE_PARM_DESC(nmea, "NMEA streaming"); 1134 1135 module_param(debug, bool, S_IRUGO | S_IWUSR); 1136 MODULE_PARM_DESC(debug, "Debug messages"); 1137