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