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