drivers/usb/serial/sierra.c

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