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