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