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