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