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