sierra.c revision 90ab5ee94171b3e28de6bb42ee30b527014e0be7
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 49static bool debug; 50static bool nmea; 51 52/* Used in interface blacklisting */ 53struct 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 58struct sierra_intf_private { 59 spinlock_t susp_lock; 60 unsigned int suspended:1; 61 int in_flight; 62}; 63 64static 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 79static 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 94static 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 114static 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 131static 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 148static 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 169static 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 */ 211static const u8 hi_memory_typeA_ifaces[] = { 0, 2 }; 212static const struct sierra_iface_info typeA_interface_list = { 213 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces), 214 .ifaceinfo = hi_memory_typeA_ifaces, 215}; 216 217static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 }; 218static 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 */ 224static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 }; 225static 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 230static 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(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */ 305 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist 306 }, 307 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */ 308 309 { } 310}; 311MODULE_DEVICE_TABLE(usb, id_table); 312 313 314struct sierra_port_private { 315 spinlock_t lock; /* lock the structure */ 316 int outstanding_urbs; /* number of out urbs in flight */ 317 struct usb_anchor active; 318 struct usb_anchor delayed; 319 320 int num_out_urbs; 321 int num_in_urbs; 322 /* Input endpoints and buffers for this port */ 323 struct urb *in_urbs[N_IN_URB_HM]; 324 325 /* Settings for the port */ 326 int rts_state; /* Handshaking pins (outputs) */ 327 int dtr_state; 328 int cts_state; /* Handshaking pins (inputs) */ 329 int dsr_state; 330 int dcd_state; 331 int ri_state; 332 unsigned int opened:1; 333}; 334 335static int sierra_send_setup(struct usb_serial_port *port) 336{ 337 struct usb_serial *serial = port->serial; 338 struct sierra_port_private *portdata; 339 __u16 interface = 0; 340 int val = 0; 341 int do_send = 0; 342 int retval; 343 344 dev_dbg(&port->dev, "%s\n", __func__); 345 346 portdata = usb_get_serial_port_data(port); 347 348 if (portdata->dtr_state) 349 val |= 0x01; 350 if (portdata->rts_state) 351 val |= 0x02; 352 353 /* If composite device then properly report interface */ 354 if (serial->num_ports == 1) { 355 interface = sierra_calc_interface(serial); 356 /* Control message is sent only to interfaces with 357 * interrupt_in endpoints 358 */ 359 if (port->interrupt_in_urb) { 360 /* send control message */ 361 do_send = 1; 362 } 363 } 364 365 /* Otherwise the need to do non-composite mapping */ 366 else { 367 if (port->bulk_out_endpointAddress == 2) 368 interface = 0; 369 else if (port->bulk_out_endpointAddress == 4) 370 interface = 1; 371 else if (port->bulk_out_endpointAddress == 5) 372 interface = 2; 373 374 do_send = 1; 375 } 376 if (!do_send) 377 return 0; 378 379 retval = usb_autopm_get_interface(serial->interface); 380 if (retval < 0) 381 return retval; 382 383 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0), 384 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT); 385 usb_autopm_put_interface(serial->interface); 386 387 return retval; 388} 389 390static void sierra_set_termios(struct tty_struct *tty, 391 struct usb_serial_port *port, struct ktermios *old_termios) 392{ 393 dev_dbg(&port->dev, "%s\n", __func__); 394 tty_termios_copy_hw(tty->termios, old_termios); 395 sierra_send_setup(port); 396} 397 398static int sierra_tiocmget(struct tty_struct *tty) 399{ 400 struct usb_serial_port *port = tty->driver_data; 401 unsigned int value; 402 struct sierra_port_private *portdata; 403 404 dev_dbg(&port->dev, "%s\n", __func__); 405 portdata = usb_get_serial_port_data(port); 406 407 value = ((portdata->rts_state) ? TIOCM_RTS : 0) | 408 ((portdata->dtr_state) ? TIOCM_DTR : 0) | 409 ((portdata->cts_state) ? TIOCM_CTS : 0) | 410 ((portdata->dsr_state) ? TIOCM_DSR : 0) | 411 ((portdata->dcd_state) ? TIOCM_CAR : 0) | 412 ((portdata->ri_state) ? TIOCM_RNG : 0); 413 414 return value; 415} 416 417static int sierra_tiocmset(struct tty_struct *tty, 418 unsigned int set, unsigned int clear) 419{ 420 struct usb_serial_port *port = tty->driver_data; 421 struct sierra_port_private *portdata; 422 423 portdata = usb_get_serial_port_data(port); 424 425 if (set & TIOCM_RTS) 426 portdata->rts_state = 1; 427 if (set & TIOCM_DTR) 428 portdata->dtr_state = 1; 429 430 if (clear & TIOCM_RTS) 431 portdata->rts_state = 0; 432 if (clear & TIOCM_DTR) 433 portdata->dtr_state = 0; 434 return sierra_send_setup(port); 435} 436 437static void sierra_release_urb(struct urb *urb) 438{ 439 struct usb_serial_port *port; 440 if (urb) { 441 port = urb->context; 442 dev_dbg(&port->dev, "%s: %p\n", __func__, urb); 443 kfree(urb->transfer_buffer); 444 usb_free_urb(urb); 445 } 446} 447 448static void sierra_outdat_callback(struct urb *urb) 449{ 450 struct usb_serial_port *port = urb->context; 451 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 452 struct sierra_intf_private *intfdata; 453 int status = urb->status; 454 455 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number); 456 intfdata = port->serial->private; 457 458 /* free up the transfer buffer, as usb_free_urb() does not do this */ 459 kfree(urb->transfer_buffer); 460 usb_autopm_put_interface_async(port->serial->interface); 461 if (status) 462 dev_dbg(&port->dev, "%s - nonzero write bulk status " 463 "received: %d\n", __func__, status); 464 465 spin_lock(&portdata->lock); 466 --portdata->outstanding_urbs; 467 spin_unlock(&portdata->lock); 468 spin_lock(&intfdata->susp_lock); 469 --intfdata->in_flight; 470 spin_unlock(&intfdata->susp_lock); 471 472 usb_serial_port_softint(port); 473} 474 475/* Write */ 476static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port, 477 const unsigned char *buf, int count) 478{ 479 struct sierra_port_private *portdata; 480 struct sierra_intf_private *intfdata; 481 struct usb_serial *serial = port->serial; 482 unsigned long flags; 483 unsigned char *buffer; 484 struct urb *urb; 485 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER); 486 int retval = 0; 487 488 /* verify that we actually have some data to write */ 489 if (count == 0) 490 return 0; 491 492 portdata = usb_get_serial_port_data(port); 493 intfdata = serial->private; 494 495 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize); 496 spin_lock_irqsave(&portdata->lock, flags); 497 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__, 498 portdata->outstanding_urbs); 499 if (portdata->outstanding_urbs > portdata->num_out_urbs) { 500 spin_unlock_irqrestore(&portdata->lock, flags); 501 dev_dbg(&port->dev, "%s - write limit hit\n", __func__); 502 return 0; 503 } 504 portdata->outstanding_urbs++; 505 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__, 506 portdata->outstanding_urbs); 507 spin_unlock_irqrestore(&portdata->lock, flags); 508 509 retval = usb_autopm_get_interface_async(serial->interface); 510 if (retval < 0) { 511 spin_lock_irqsave(&portdata->lock, flags); 512 portdata->outstanding_urbs--; 513 spin_unlock_irqrestore(&portdata->lock, flags); 514 goto error_simple; 515 } 516 517 buffer = kmalloc(writesize, GFP_ATOMIC); 518 if (!buffer) { 519 dev_err(&port->dev, "out of memory\n"); 520 retval = -ENOMEM; 521 goto error_no_buffer; 522 } 523 524 urb = usb_alloc_urb(0, GFP_ATOMIC); 525 if (!urb) { 526 dev_err(&port->dev, "no more free urbs\n"); 527 retval = -ENOMEM; 528 goto error_no_urb; 529 } 530 531 memcpy(buffer, buf, writesize); 532 533 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer); 534 535 usb_fill_bulk_urb(urb, serial->dev, 536 usb_sndbulkpipe(serial->dev, 537 port->bulk_out_endpointAddress), 538 buffer, writesize, sierra_outdat_callback, port); 539 540 /* Handle the need to send a zero length packet */ 541 urb->transfer_flags |= URB_ZERO_PACKET; 542 543 spin_lock_irqsave(&intfdata->susp_lock, flags); 544 545 if (intfdata->suspended) { 546 usb_anchor_urb(urb, &portdata->delayed); 547 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 548 goto skip_power; 549 } else { 550 usb_anchor_urb(urb, &portdata->active); 551 } 552 /* send it down the pipe */ 553 retval = usb_submit_urb(urb, GFP_ATOMIC); 554 if (retval) { 555 usb_unanchor_urb(urb); 556 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 557 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed " 558 "with status = %d\n", __func__, retval); 559 goto error; 560 } else { 561 intfdata->in_flight++; 562 spin_unlock_irqrestore(&intfdata->susp_lock, flags); 563 } 564 565skip_power: 566 /* we are done with this urb, so let the host driver 567 * really free it when it is finished with it */ 568 usb_free_urb(urb); 569 570 return writesize; 571error: 572 usb_free_urb(urb); 573error_no_urb: 574 kfree(buffer); 575error_no_buffer: 576 spin_lock_irqsave(&portdata->lock, flags); 577 --portdata->outstanding_urbs; 578 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__, 579 portdata->outstanding_urbs); 580 spin_unlock_irqrestore(&portdata->lock, flags); 581 usb_autopm_put_interface_async(serial->interface); 582error_simple: 583 return retval; 584} 585 586static void sierra_indat_callback(struct urb *urb) 587{ 588 int err; 589 int endpoint; 590 struct usb_serial_port *port; 591 struct tty_struct *tty; 592 unsigned char *data = urb->transfer_buffer; 593 int status = urb->status; 594 595 endpoint = usb_pipeendpoint(urb->pipe); 596 port = urb->context; 597 598 dev_dbg(&port->dev, "%s: %p\n", __func__, urb); 599 600 if (status) { 601 dev_dbg(&port->dev, "%s: nonzero status: %d on" 602 " endpoint %02x\n", __func__, status, endpoint); 603 } else { 604 if (urb->actual_length) { 605 tty = tty_port_tty_get(&port->port); 606 if (tty) { 607 tty_insert_flip_string(tty, data, 608 urb->actual_length); 609 tty_flip_buffer_push(tty); 610 611 tty_kref_put(tty); 612 usb_serial_debug_data(debug, &port->dev, 613 __func__, urb->actual_length, data); 614 } 615 } else { 616 dev_dbg(&port->dev, "%s: empty read urb" 617 " received\n", __func__); 618 } 619 } 620 621 /* Resubmit urb so we continue receiving */ 622 if (status != -ESHUTDOWN && status != -EPERM) { 623 usb_mark_last_busy(port->serial->dev); 624 err = usb_submit_urb(urb, GFP_ATOMIC); 625 if (err && err != -EPERM) 626 dev_err(&port->dev, "resubmit read urb failed." 627 "(%d)\n", err); 628 } 629} 630 631static void sierra_instat_callback(struct urb *urb) 632{ 633 int err; 634 int status = urb->status; 635 struct usb_serial_port *port = urb->context; 636 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 637 struct usb_serial *serial = port->serial; 638 639 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__, 640 urb, port, portdata); 641 642 if (status == 0) { 643 struct usb_ctrlrequest *req_pkt = 644 (struct usb_ctrlrequest *)urb->transfer_buffer; 645 646 if (!req_pkt) { 647 dev_dbg(&port->dev, "%s: NULL req_pkt\n", 648 __func__); 649 return; 650 } 651 if ((req_pkt->bRequestType == 0xA1) && 652 (req_pkt->bRequest == 0x20)) { 653 int old_dcd_state; 654 unsigned char signals = *((unsigned char *) 655 urb->transfer_buffer + 656 sizeof(struct usb_ctrlrequest)); 657 struct tty_struct *tty; 658 659 dev_dbg(&port->dev, "%s: signal x%x\n", __func__, 660 signals); 661 662 old_dcd_state = portdata->dcd_state; 663 portdata->cts_state = 1; 664 portdata->dcd_state = ((signals & 0x01) ? 1 : 0); 665 portdata->dsr_state = ((signals & 0x02) ? 1 : 0); 666 portdata->ri_state = ((signals & 0x08) ? 1 : 0); 667 668 tty = tty_port_tty_get(&port->port); 669 if (tty && !C_CLOCAL(tty) && 670 old_dcd_state && !portdata->dcd_state) 671 tty_hangup(tty); 672 tty_kref_put(tty); 673 } else { 674 dev_dbg(&port->dev, "%s: type %x req %x\n", 675 __func__, req_pkt->bRequestType, 676 req_pkt->bRequest); 677 } 678 } else 679 dev_dbg(&port->dev, "%s: error %d\n", __func__, status); 680 681 /* Resubmit urb so we continue receiving IRQ data */ 682 if (status != -ESHUTDOWN && status != -ENOENT) { 683 usb_mark_last_busy(serial->dev); 684 err = usb_submit_urb(urb, GFP_ATOMIC); 685 if (err && err != -EPERM) 686 dev_err(&port->dev, "%s: resubmit intr urb " 687 "failed. (%d)\n", __func__, err); 688 } 689} 690 691static int sierra_write_room(struct tty_struct *tty) 692{ 693 struct usb_serial_port *port = tty->driver_data; 694 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 695 unsigned long flags; 696 697 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number); 698 699 /* try to give a good number back based on if we have any free urbs at 700 * this point in time */ 701 spin_lock_irqsave(&portdata->lock, flags); 702 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) { 703 spin_unlock_irqrestore(&portdata->lock, flags); 704 dev_dbg(&port->dev, "%s - write limit hit\n", __func__); 705 return 0; 706 } 707 spin_unlock_irqrestore(&portdata->lock, flags); 708 709 return 2048; 710} 711 712static void sierra_stop_rx_urbs(struct usb_serial_port *port) 713{ 714 int i; 715 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 716 717 for (i = 0; i < portdata->num_in_urbs; i++) 718 usb_kill_urb(portdata->in_urbs[i]); 719 720 usb_kill_urb(port->interrupt_in_urb); 721} 722 723static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags) 724{ 725 int ok_cnt; 726 int err = -EINVAL; 727 int i; 728 struct urb *urb; 729 struct sierra_port_private *portdata = usb_get_serial_port_data(port); 730 731 ok_cnt = 0; 732 for (i = 0; i < portdata->num_in_urbs; i++) { 733 urb = portdata->in_urbs[i]; 734 if (!urb) 735 continue; 736 err = usb_submit_urb(urb, mem_flags); 737 if (err) { 738 dev_err(&port->dev, "%s: submit urb failed: %d\n", 739 __func__, err); 740 } else { 741 ok_cnt++; 742 } 743 } 744 745 if (ok_cnt && port->interrupt_in_urb) { 746 err = usb_submit_urb(port->interrupt_in_urb, mem_flags); 747 if (err) { 748 dev_err(&port->dev, "%s: submit intr urb failed: %d\n", 749 __func__, err); 750 } 751 } 752 753 if (ok_cnt > 0) /* at least one rx urb submitted */ 754 return 0; 755 else 756 return err; 757} 758 759static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint, 760 int dir, void *ctx, int len, 761 gfp_t mem_flags, 762 usb_complete_t callback) 763{ 764 struct urb *urb; 765 u8 *buf; 766 767 if (endpoint == -1) 768 return NULL; 769 770 urb = usb_alloc_urb(0, mem_flags); 771 if (urb == NULL) { 772 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n", 773 __func__, endpoint); 774 return NULL; 775 } 776 777 buf = kmalloc(len, mem_flags); 778 if (buf) { 779 /* Fill URB using supplied data */ 780 usb_fill_bulk_urb(urb, serial->dev, 781 usb_sndbulkpipe(serial->dev, endpoint) | dir, 782 buf, len, callback, ctx); 783 784 /* debug */ 785 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__, 786 dir == USB_DIR_IN ? 'i' : 'o', urb, buf); 787 } else { 788 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__, 789 dir == USB_DIR_IN ? 'i' : 'o', urb, buf); 790 791 sierra_release_urb(urb); 792 urb = NULL; 793 } 794 795 return urb; 796} 797 798static void sierra_close(struct usb_serial_port *port) 799{ 800 int i; 801 struct usb_serial *serial = port->serial; 802 struct sierra_port_private *portdata; 803 struct sierra_intf_private *intfdata = port->serial->private; 804 805 806 dev_dbg(&port->dev, "%s\n", __func__); 807 portdata = usb_get_serial_port_data(port); 808 809 portdata->rts_state = 0; 810 portdata->dtr_state = 0; 811 812 if (serial->dev) { 813 mutex_lock(&serial->disc_mutex); 814 if (!serial->disconnected) { 815 serial->interface->needs_remote_wakeup = 0; 816 /* odd error handling due to pm counters */ 817 if (!usb_autopm_get_interface(serial->interface)) 818 sierra_send_setup(port); 819 else 820 usb_autopm_get_interface_no_resume(serial->interface); 821 822 } 823 mutex_unlock(&serial->disc_mutex); 824 spin_lock_irq(&intfdata->susp_lock); 825 portdata->opened = 0; 826 spin_unlock_irq(&intfdata->susp_lock); 827 828 829 /* Stop reading urbs */ 830 sierra_stop_rx_urbs(port); 831 /* .. and release them */ 832 for (i = 0; i < portdata->num_in_urbs; i++) { 833 sierra_release_urb(portdata->in_urbs[i]); 834 portdata->in_urbs[i] = NULL; 835 } 836 } 837} 838 839static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port) 840{ 841 struct sierra_port_private *portdata; 842 struct usb_serial *serial = port->serial; 843 struct sierra_intf_private *intfdata = serial->private; 844 int i; 845 int err; 846 int endpoint; 847 struct urb *urb; 848 849 portdata = usb_get_serial_port_data(port); 850 851 dev_dbg(&port->dev, "%s\n", __func__); 852 853 /* Set some sane defaults */ 854 portdata->rts_state = 1; 855 portdata->dtr_state = 1; 856 857 858 endpoint = port->bulk_in_endpointAddress; 859 for (i = 0; i < portdata->num_in_urbs; i++) { 860 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port, 861 IN_BUFLEN, GFP_KERNEL, 862 sierra_indat_callback); 863 portdata->in_urbs[i] = urb; 864 } 865 /* clear halt condition */ 866 usb_clear_halt(serial->dev, 867 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN); 868 869 err = sierra_submit_rx_urbs(port, GFP_KERNEL); 870 if (err) { 871 /* get rid of everything as in close */ 872 sierra_close(port); 873 /* restore balance for autopm */ 874 if (!serial->disconnected) 875 usb_autopm_put_interface(serial->interface); 876 return err; 877 } 878 sierra_send_setup(port); 879 880 serial->interface->needs_remote_wakeup = 1; 881 spin_lock_irq(&intfdata->susp_lock); 882 portdata->opened = 1; 883 spin_unlock_irq(&intfdata->susp_lock); 884 usb_autopm_put_interface(serial->interface); 885 886 return 0; 887} 888 889 890static void sierra_dtr_rts(struct usb_serial_port *port, int on) 891{ 892 struct usb_serial *serial = port->serial; 893 struct sierra_port_private *portdata; 894 895 portdata = usb_get_serial_port_data(port); 896 portdata->rts_state = on; 897 portdata->dtr_state = on; 898 899 if (serial->dev) { 900 mutex_lock(&serial->disc_mutex); 901 if (!serial->disconnected) 902 sierra_send_setup(port); 903 mutex_unlock(&serial->disc_mutex); 904 } 905} 906 907static int sierra_startup(struct usb_serial *serial) 908{ 909 struct usb_serial_port *port; 910 struct sierra_port_private *portdata; 911 struct sierra_iface_info *himemoryp = NULL; 912 int i; 913 u8 ifnum; 914 915 dev_dbg(&serial->dev->dev, "%s\n", __func__); 916 917 /* Set Device mode to D0 */ 918 sierra_set_power_state(serial->dev, 0x0000); 919 920 /* Check NMEA and set */ 921 if (nmea) 922 sierra_vsc_set_nmea(serial->dev, 1); 923 924 /* Now setup per port private data */ 925 for (i = 0; i < serial->num_ports; i++) { 926 port = serial->port[i]; 927 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL); 928 if (!portdata) { 929 dev_dbg(&port->dev, "%s: kmalloc for " 930 "sierra_port_private (%d) failed!\n", 931 __func__, i); 932 return -ENOMEM; 933 } 934 spin_lock_init(&portdata->lock); 935 init_usb_anchor(&portdata->active); 936 init_usb_anchor(&portdata->delayed); 937 ifnum = i; 938 /* Assume low memory requirements */ 939 portdata->num_out_urbs = N_OUT_URB; 940 portdata->num_in_urbs = N_IN_URB; 941 942 /* Determine actual memory requirements */ 943 if (serial->num_ports == 1) { 944 /* Get interface number for composite device */ 945 ifnum = sierra_calc_interface(serial); 946 himemoryp = 947 (struct sierra_iface_info *)&typeB_interface_list; 948 if (is_himemory(ifnum, himemoryp)) { 949 portdata->num_out_urbs = N_OUT_URB_HM; 950 portdata->num_in_urbs = N_IN_URB_HM; 951 } 952 } 953 else { 954 himemoryp = 955 (struct sierra_iface_info *)&typeA_interface_list; 956 if (is_himemory(i, himemoryp)) { 957 portdata->num_out_urbs = N_OUT_URB_HM; 958 portdata->num_in_urbs = N_IN_URB_HM; 959 } 960 } 961 dev_dbg(&serial->dev->dev, 962 "Memory usage (urbs) interface #%d, in=%d, out=%d\n", 963 ifnum,portdata->num_in_urbs, portdata->num_out_urbs ); 964 /* Set the port private data pointer */ 965 usb_set_serial_port_data(port, portdata); 966 } 967 968 return 0; 969} 970 971static void sierra_release(struct usb_serial *serial) 972{ 973 int i; 974 struct usb_serial_port *port; 975 struct sierra_port_private *portdata; 976 977 dev_dbg(&serial->dev->dev, "%s\n", __func__); 978 979 for (i = 0; i < serial->num_ports; ++i) { 980 port = serial->port[i]; 981 if (!port) 982 continue; 983 portdata = usb_get_serial_port_data(port); 984 if (!portdata) 985 continue; 986 kfree(portdata); 987 } 988} 989 990#ifdef CONFIG_PM 991static void stop_read_write_urbs(struct usb_serial *serial) 992{ 993 int i; 994 struct usb_serial_port *port; 995 struct sierra_port_private *portdata; 996 997 /* Stop reading/writing urbs */ 998 for (i = 0; i < serial->num_ports; ++i) { 999 port = serial->port[i]; 1000 portdata = usb_get_serial_port_data(port); 1001 sierra_stop_rx_urbs(port); 1002 usb_kill_anchored_urbs(&portdata->active); 1003 } 1004} 1005 1006static int sierra_suspend(struct usb_serial *serial, pm_message_t message) 1007{ 1008 struct sierra_intf_private *intfdata; 1009 int b; 1010 1011 if (PMSG_IS_AUTO(message)) { 1012 intfdata = serial->private; 1013 spin_lock_irq(&intfdata->susp_lock); 1014 b = intfdata->in_flight; 1015 1016 if (b) { 1017 spin_unlock_irq(&intfdata->susp_lock); 1018 return -EBUSY; 1019 } else { 1020 intfdata->suspended = 1; 1021 spin_unlock_irq(&intfdata->susp_lock); 1022 } 1023 } 1024 stop_read_write_urbs(serial); 1025 1026 return 0; 1027} 1028 1029static int sierra_resume(struct usb_serial *serial) 1030{ 1031 struct usb_serial_port *port; 1032 struct sierra_intf_private *intfdata = serial->private; 1033 struct sierra_port_private *portdata; 1034 struct urb *urb; 1035 int ec = 0; 1036 int i, err; 1037 1038 spin_lock_irq(&intfdata->susp_lock); 1039 for (i = 0; i < serial->num_ports; i++) { 1040 port = serial->port[i]; 1041 portdata = usb_get_serial_port_data(port); 1042 1043 while ((urb = usb_get_from_anchor(&portdata->delayed))) { 1044 usb_anchor_urb(urb, &portdata->active); 1045 intfdata->in_flight++; 1046 err = usb_submit_urb(urb, GFP_ATOMIC); 1047 if (err < 0) { 1048 intfdata->in_flight--; 1049 usb_unanchor_urb(urb); 1050 usb_scuttle_anchored_urbs(&portdata->delayed); 1051 break; 1052 } 1053 } 1054 1055 if (portdata->opened) { 1056 err = sierra_submit_rx_urbs(port, GFP_ATOMIC); 1057 if (err) 1058 ec++; 1059 } 1060 } 1061 intfdata->suspended = 0; 1062 spin_unlock_irq(&intfdata->susp_lock); 1063 1064 return ec ? -EIO : 0; 1065} 1066 1067static int sierra_reset_resume(struct usb_interface *intf) 1068{ 1069 struct usb_serial *serial = usb_get_intfdata(intf); 1070 dev_err(&serial->dev->dev, "%s\n", __func__); 1071 return usb_serial_resume(intf); 1072} 1073#else 1074#define sierra_suspend NULL 1075#define sierra_resume NULL 1076#define sierra_reset_resume NULL 1077#endif 1078 1079static struct usb_driver sierra_driver = { 1080 .name = "sierra", 1081 .probe = usb_serial_probe, 1082 .disconnect = usb_serial_disconnect, 1083 .suspend = usb_serial_suspend, 1084 .resume = usb_serial_resume, 1085 .reset_resume = sierra_reset_resume, 1086 .id_table = id_table, 1087 .no_dynamic_id = 1, 1088 .supports_autosuspend = 1, 1089}; 1090 1091static struct usb_serial_driver sierra_device = { 1092 .driver = { 1093 .owner = THIS_MODULE, 1094 .name = "sierra", 1095 }, 1096 .description = "Sierra USB modem", 1097 .id_table = id_table, 1098 .usb_driver = &sierra_driver, 1099 .calc_num_ports = sierra_calc_num_ports, 1100 .probe = sierra_probe, 1101 .open = sierra_open, 1102 .close = sierra_close, 1103 .dtr_rts = sierra_dtr_rts, 1104 .write = sierra_write, 1105 .write_room = sierra_write_room, 1106 .set_termios = sierra_set_termios, 1107 .tiocmget = sierra_tiocmget, 1108 .tiocmset = sierra_tiocmset, 1109 .attach = sierra_startup, 1110 .release = sierra_release, 1111 .suspend = sierra_suspend, 1112 .resume = sierra_resume, 1113 .read_int_callback = sierra_instat_callback, 1114}; 1115 1116/* Functions used by new usb-serial code. */ 1117static int __init sierra_init(void) 1118{ 1119 int retval; 1120 retval = usb_serial_register(&sierra_device); 1121 if (retval) 1122 goto failed_device_register; 1123 1124 1125 retval = usb_register(&sierra_driver); 1126 if (retval) 1127 goto failed_driver_register; 1128 1129 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":" 1130 DRIVER_DESC "\n"); 1131 1132 return 0; 1133 1134failed_driver_register: 1135 usb_serial_deregister(&sierra_device); 1136failed_device_register: 1137 return retval; 1138} 1139 1140static void __exit sierra_exit(void) 1141{ 1142 usb_deregister(&sierra_driver); 1143 usb_serial_deregister(&sierra_device); 1144} 1145 1146module_init(sierra_init); 1147module_exit(sierra_exit); 1148 1149MODULE_AUTHOR(DRIVER_AUTHOR); 1150MODULE_DESCRIPTION(DRIVER_DESC); 1151MODULE_VERSION(DRIVER_VERSION); 1152MODULE_LICENSE("GPL"); 1153 1154module_param(nmea, bool, S_IRUGO | S_IWUSR); 1155MODULE_PARM_DESC(nmea, "NMEA streaming"); 1156 1157module_param(debug, bool, S_IRUGO | S_IWUSR); 1158MODULE_PARM_DESC(debug, "Debug messages"); 1159