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