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