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