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