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.7"
  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 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
  55 {
  56         int result;
  57         dev_dbg(&udev->dev, "%s\n", __func__);
  58         result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  59                         SWIMS_USB_REQUEST_SetPower,     /* __u8 request      */
  60                         USB_TYPE_VENDOR,                /* __u8 request type */
  61                         swiState,                       /* __u16 value       */
  62                         0,                              /* __u16 index       */
  63                         NULL,                           /* void *data        */
  64                         0,                              /* __u16 size        */
  65                         USB_CTRL_SET_TIMEOUT);          /* int timeout       */
  66         return result;
  67 }
  68
  69 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
  70 {
  71         int result;
  72         dev_dbg(&udev->dev, "%s\n", __func__);
  73         result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  74                         SWIMS_USB_REQUEST_SetNmea,      /* __u8 request      */
  75                         USB_TYPE_VENDOR,                /* __u8 request type */
  76                         enable,                         /* __u16 value       */
  77                         0x0000,                         /* __u16 index       */
  78                         NULL,                           /* void *data        */
  79                         0,                              /* __u16 size        */
  80                         USB_CTRL_SET_TIMEOUT);          /* int timeout       */
  81         return result;
  82 }
  83
  84 static int sierra_calc_num_ports(struct usb_serial *serial)
  85 {
  86         int num_ports = 0;
  87         u8 ifnum, numendpoints;
  88
  89         dev_dbg(&serial->dev->dev, "%s\n", __func__);
  90
  91         ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
  92         numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
  93
  94         /* Dummy interface present on some SKUs should be ignored */
  95         if (ifnum == 0x99)
  96                 num_ports = 0;
  97         else if (numendpoints <= 3)
  98                 num_ports = 1;
  99         else
 100                 num_ports = (numendpoints-1)/2;
 101         return num_ports;
 102 }
 103
 104 static int is_blacklisted(const u8 ifnum,
 105                                 const struct sierra_iface_info *blacklist)
 106 {
 107         const u8  *info;
 108         int i;
 109
 110         if (blacklist) {
 111                 info = blacklist->ifaceinfo;
 112
 113                 for (i = 0; i < blacklist->infolen; i++) {
 114                         if (info[i] == ifnum)
 115                                 return 1;
 116                 }
 117         }
 118         return 0;
 119 }
 120
 121 static int sierra_calc_interface(struct usb_serial *serial)
 122 {
 123         int interface;
 124         struct usb_interface *p_interface;
 125         struct usb_host_interface *p_host_interface;
 126         dev_dbg(&serial->dev->dev, "%s\n", __func__);
 127
 128         /* Get the interface structure pointer from the serial struct */
 129         p_interface = serial->interface;
 130
 131         /* Get a pointer to the host interface structure */
 132         p_host_interface = p_interface->cur_altsetting;
 133
 134         /* read the interface descriptor for this active altsetting
 135          * to find out the interface number we are on
 136         */
 137         interface = p_host_interface->desc.bInterfaceNumber;
 138
 139         return interface;
 140 }
 141
 142 static int sierra_probe(struct usb_serial *serial,
 143                         const struct usb_device_id *id)
 144 {
 145         int result = 0;
 146         struct usb_device *udev;
 147         u8 ifnum;
 148
 149         udev = serial->dev;
 150         dev_dbg(&udev->dev, "%s\n", __func__);
 151
 152         ifnum = sierra_calc_interface(serial);
 153         /*
 154          * If this interface supports more than 1 alternate
 155          * select the 2nd one
 156          */
 157         if (serial->interface->num_altsetting == 2) {
 158                 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
 159                         ifnum);
 160                 /* We know the alternate setting is 1 for the MC8785 */
 161                 usb_set_interface(udev, ifnum, 1);
 162         }
 163
 164         /* ifnum could have changed - by calling usb_set_interface */
 165         ifnum = sierra_calc_interface(serial);
 166
 167         if (is_blacklisted(ifnum,
 168                                 (struct sierra_iface_info *)id->driver_info)) {
 169                 dev_dbg(&serial->dev->dev,
 170                         "Ignoring blacklisted interface #%d\n", ifnum);
 171                 return -ENODEV;
 172         }
 173
 174         return result;
 175 }
 176
 177 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 };
 178 static const struct sierra_iface_info direct_ip_interface_blacklist = {
 179         .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
 180         .ifaceinfo = direct_ip_non_serial_ifaces,
 181 };
 182
 183 static struct usb_device_id id_table [] = {
 184         { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
 185         { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
 186         { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
 187
 188         { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
 189         { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
 190         { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
 191         { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
 192         { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
 193         { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
 194         { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
 195         { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
 196         { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
 197         { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
 198         { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
 199         { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
 200         /* Sierra Wireless C597 */
 201         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
 202         /* Sierra Wireless T598 */
 203         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
 204         { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
 205         { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
 206         { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
 207         { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
 208
 209         { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
 210         { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
 211         { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
 212         { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
 213         { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
 214         { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
 215         { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
 216         { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
 217         { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
 218         { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
 219         { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
 220         { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
 221         { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
 222         { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
 223         { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
 224         { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
 225         { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
 226         { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
 227         { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
 228         { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
 229         { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
 230         /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
 231         { USB_DEVICE(0x1199, 0x683C) },
 232         { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
 233         /* Sierra Wireless MC8790, MC8791, MC8792 */
 234         { USB_DEVICE(0x1199, 0x683E) },
 235         { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
 236         { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
 237         { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
 238         { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
 239         { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
 240         { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
 241         { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
 242         { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
 243         /* Sierra Wireless C885 */
 244         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
 245         /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
 246         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
 247         /* Sierra Wireless C22/C33 */
 248         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
 249         /* Sierra Wireless HSPA Non-Composite Device */
 250         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
 251         { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
 252         { USB_DEVICE(0x1199, 0x68A3),   /* Sierra Wireless Direct IP modems */
 253           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
 254         },
 255
 256         { }
 257 };
 258 MODULE_DEVICE_TABLE(usb, id_table);
 259
 260 static struct usb_driver sierra_driver = {
 261         .name       = "sierra",
 262         .probe      = usb_serial_probe,
 263         .disconnect = usb_serial_disconnect,
 264         .id_table   = id_table,
 265         .no_dynamic_id =        1,
 266 };
 267
 268 struct sierra_port_private {
 269         spinlock_t lock;        /* lock the structure */
 270         int outstanding_urbs;   /* number of out urbs in flight */
 271
 272         /* Input endpoints and buffers for this port */
 273         struct urb *in_urbs[N_IN_URB];
 274
 275         /* Settings for the port */
 276         int rts_state;  /* Handshaking pins (outputs) */
 277         int dtr_state;
 278         int cts_state;  /* Handshaking pins (inputs) */
 279         int dsr_state;
 280         int dcd_state;
 281         int ri_state;
 282 };
 283
 284 static int sierra_send_setup(struct usb_serial_port *port)
 285 {
 286         struct usb_serial *serial = port->serial;
 287         struct sierra_port_private *portdata;
 288         __u16 interface = 0;
 289         int val = 0;
 290
 291         dev_dbg(&port->dev, "%s\n", __func__);
 292
 293         portdata = usb_get_serial_port_data(port);
 294
 295         if (portdata->dtr_state)
 296                 val |= 0x01;
 297         if (portdata->rts_state)
 298                 val |= 0x02;
 299
 300         /* If composite device then properly report interface */
 301         if (serial->num_ports == 1) {
 302                 interface = sierra_calc_interface(serial);
 303                 /* Control message is sent only to interfaces with
 304                  * interrupt_in endpoints
 305                  */
 306                 if (port->interrupt_in_urb) {
 307                         /* send control message */
 308                         return usb_control_msg(serial->dev,
 309                                 usb_rcvctrlpipe(serial->dev, 0),
 310                                 0x22, 0x21, val, interface,
 311                                 NULL, 0, USB_CTRL_SET_TIMEOUT);
 312                 }
 313         }
 314
 315         /* Otherwise the need to do non-composite mapping */
 316         else {
 317                 if (port->bulk_out_endpointAddress == 2)
 318                         interface = 0;
 319                 else if (port->bulk_out_endpointAddress == 4)
 320                         interface = 1;
 321                 else if (port->bulk_out_endpointAddress == 5)
 322                         interface = 2;
 323                 return usb_control_msg(serial->dev,
 324                         usb_rcvctrlpipe(serial->dev, 0),
 325                         0x22, 0x21, val, interface,
 326                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 327         }
 328         return 0;
 329 }
 330
 331 static void sierra_set_termios(struct tty_struct *tty,
 332                 struct usb_serial_port *port, struct ktermios *old_termios)
 333 {
 334         dev_dbg(&port->dev, "%s\n", __func__);
 335         tty_termios_copy_hw(tty->termios, old_termios);
 336         sierra_send_setup(port);
 337 }
 338
 339 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
 340 {
 341         struct usb_serial_port *port = tty->driver_data;
 342         unsigned int value;
 343         struct sierra_port_private *portdata;
 344
 345         dev_dbg(&port->dev, "%s\n", __func__);
 346         portdata = usb_get_serial_port_data(port);
 347
 348         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
 349                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
 350                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
 351                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
 352                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
 353                 ((portdata->ri_state) ? TIOCM_RNG : 0);
 354
 355         return value;
 356 }
 357
 358 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
 359                         unsigned int set, unsigned int clear)
 360 {
 361         struct usb_serial_port *port = tty->driver_data;
 362         struct sierra_port_private *portdata;
 363
 364         portdata = usb_get_serial_port_data(port);
 365
 366         if (set & TIOCM_RTS)
 367                 portdata->rts_state = 1;
 368         if (set & TIOCM_DTR)
 369                 portdata->dtr_state = 1;
 370
 371         if (clear & TIOCM_RTS)
 372                 portdata->rts_state = 0;
 373         if (clear & TIOCM_DTR)
 374                 portdata->dtr_state = 0;
 375         return sierra_send_setup(port);
 376 }
 377
 378 static void sierra_release_urb(struct urb *urb)
 379 {
 380         struct usb_serial_port *port;
 381         if (urb) {
 382                 port =  urb->context;
 383                 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
 384                 kfree(urb->transfer_buffer);
 385                 usb_free_urb(urb);
 386         }
 387 }
 388
 389 static void sierra_outdat_callback(struct urb *urb)
 390 {
 391         struct usb_serial_port *port = urb->context;
 392         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 393         int status = urb->status;
 394         unsigned long flags;
 395
 396         dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
 397
 398         /* free up the transfer buffer, as usb_free_urb() does not do this */
 399         kfree(urb->transfer_buffer);
 400
 401         if (status)
 402                 dev_dbg(&port->dev, "%s - nonzero write bulk status "
 403                     "received: %d\n", __func__, status);
 404
 405         spin_lock_irqsave(&portdata->lock, flags);
 406         --portdata->outstanding_urbs;
 407         spin_unlock_irqrestore(&portdata->lock, flags);
 408
 409         usb_serial_port_softint(port);
 410 }
 411
 412 /* Write */
 413 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
 414                                         const unsigned char *buf, int count)
 415 {
 416         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 417         struct usb_serial *serial = port->serial;
 418         unsigned long flags;
 419         unsigned char *buffer;
 420         struct urb *urb;
 421         size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
 422         int retval = 0;
 423
 424         /* verify that we actually have some data to write */
 425         if (count == 0)
 426                 return 0;
 427
 428         portdata = usb_get_serial_port_data(port);
 429
 430         dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
 431
 432         spin_lock_irqsave(&portdata->lock, flags);
 433         dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
 434                 portdata->outstanding_urbs);
 435         if (portdata->outstanding_urbs > N_OUT_URB) {
 436                 spin_unlock_irqrestore(&portdata->lock, flags);
 437                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
 438                 return 0;
 439         }
 440         portdata->outstanding_urbs++;
 441         dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
 442                 portdata->outstanding_urbs);
 443         spin_unlock_irqrestore(&portdata->lock, flags);
 444
 445         buffer = kmalloc(writesize, GFP_ATOMIC);
 446         if (!buffer) {
 447                 dev_err(&port->dev, "out of memory\n");
 448                 retval = -ENOMEM;
 449                 goto error_no_buffer;
 450         }
 451
 452         urb = usb_alloc_urb(0, GFP_ATOMIC);
 453         if (!urb) {
 454                 dev_err(&port->dev, "no more free urbs\n");
 455                 retval = -ENOMEM;
 456                 goto error_no_urb;
 457         }
 458
 459         memcpy(buffer, buf, writesize);
 460
 461         usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
 462
 463         usb_fill_bulk_urb(urb, serial->dev,
 464                           usb_sndbulkpipe(serial->dev,
 465                                           port->bulk_out_endpointAddress),
 466                           buffer, writesize, sierra_outdat_callback, port);
 467
 468         /* Handle the need to send a zero length packet */
 469         urb->transfer_flags |= URB_ZERO_PACKET;
 470
 471         /* send it down the pipe */
 472         retval = usb_submit_urb(urb, GFP_ATOMIC);
 473         if (retval) {
 474                 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
 475                         "with status = %d\n", __func__, retval);
 476                 goto error;
 477         }
 478
 479         /* we are done with this urb, so let the host driver
 480          * really free it when it is finished with it */
 481         usb_free_urb(urb);
 482
 483         return writesize;
 484 error:
 485         usb_free_urb(urb);
 486 error_no_urb:
 487         kfree(buffer);
 488 error_no_buffer:
 489         spin_lock_irqsave(&portdata->lock, flags);
 490         --portdata->outstanding_urbs;
 491         dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
 492                 portdata->outstanding_urbs);
 493         spin_unlock_irqrestore(&portdata->lock, flags);
 494         return retval;
 495 }
 496
 497 static void sierra_indat_callback(struct urb *urb)
 498 {
 499         int err;
 500         int endpoint;
 501         struct usb_serial_port *port;
 502         struct tty_struct *tty;
 503         unsigned char *data = urb->transfer_buffer;
 504         int status = urb->status;
 505
 506         endpoint = usb_pipeendpoint(urb->pipe);
 507         port = urb->context;
 508
 509         dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
 510
 511         if (status) {
 512                 dev_dbg(&port->dev, "%s: nonzero status: %d on"
 513                         " endpoint %02x\n", __func__, status, endpoint);
 514         } else {
 515                 if (urb->actual_length) {
 516                         tty = tty_port_tty_get(&port->port);
 517
 518                         tty_buffer_request_room(tty, urb->actual_length);
 519                         tty_insert_flip_string(tty, data, urb->actual_length);
 520                         tty_flip_buffer_push(tty);
 521
 522                         tty_kref_put(tty);
 523                         usb_serial_debug_data(debug, &port->dev, __func__,
 524                                 urb->actual_length, data);
 525                 } else {
 526                         dev_dbg(&port->dev, "%s: empty read urb"
 527                                 " received\n", __func__);
 528                 }
 529         }
 530
 531         /* Resubmit urb so we continue receiving */
 532         if (port->port.count && status != -ESHUTDOWN && status != -EPERM) {
 533                 err = usb_submit_urb(urb, GFP_ATOMIC);
 534                 if (err)
 535                         dev_err(&port->dev, "resubmit read urb failed."
 536                                 "(%d)\n", err);
 537         }
 538
 539         return;
 540 }
 541
 542 static void sierra_instat_callback(struct urb *urb)
 543 {
 544         int err;
 545         int status = urb->status;
 546         struct usb_serial_port *port =  urb->context;
 547         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 548         struct usb_serial *serial = port->serial;
 549
 550         dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
 551                 urb, port, portdata);
 552
 553         if (status == 0) {
 554                 struct usb_ctrlrequest *req_pkt =
 555                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
 556
 557                 if (!req_pkt) {
 558                         dev_dbg(&port->dev, "%s: NULL req_pkt\n",
 559                                 __func__);
 560                         return;
 561                 }
 562                 if ((req_pkt->bRequestType == 0xA1) &&
 563                                 (req_pkt->bRequest == 0x20)) {
 564                         int old_dcd_state;
 565                         unsigned char signals = *((unsigned char *)
 566                                         urb->transfer_buffer +
 567                                         sizeof(struct usb_ctrlrequest));
 568                         struct tty_struct *tty;
 569
 570                         dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
 571                                 signals);
 572
 573                         old_dcd_state = portdata->dcd_state;
 574                         portdata->cts_state = 1;
 575                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
 576                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
 577                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
 578
 579                         tty = tty_port_tty_get(&port->port);
 580                         if (tty && !C_CLOCAL(tty) &&
 581                                         old_dcd_state && !portdata->dcd_state)
 582                                 tty_hangup(tty);
 583                         tty_kref_put(tty);
 584                 } else {
 585                         dev_dbg(&port->dev, "%s: type %x req %x\n",
 586                                 __func__, req_pkt->bRequestType,
 587                                 req_pkt->bRequest);
 588                 }
 589         } else
 590                 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
 591
 592         /* Resubmit urb so we continue receiving IRQ data */
 593         if (port->port.count && status != -ESHUTDOWN && status != -ENOENT) {
 594                 urb->dev = serial->dev;
 595                 err = usb_submit_urb(urb, GFP_ATOMIC);
 596                 if (err)
 597                         dev_err(&port->dev, "%s: resubmit intr urb "
 598                                 "failed. (%d)\n", __func__, err);
 599         }
 600 }
 601
 602 static int sierra_write_room(struct tty_struct *tty)
 603 {
 604         struct usb_serial_port *port = tty->driver_data;
 605         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 606         unsigned long flags;
 607
 608         dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
 609
 610         /* try to give a good number back based on if we have any free urbs at
 611          * this point in time */
 612         spin_lock_irqsave(&portdata->lock, flags);
 613         if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
 614                 spin_unlock_irqrestore(&portdata->lock, flags);
 615                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
 616                 return 0;
 617         }
 618         spin_unlock_irqrestore(&portdata->lock, flags);
 619
 620         return 2048;
 621 }
 622
 623 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
 624 {
 625         int i;
 626         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 627
 628         for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++)
 629                 usb_kill_urb(portdata->in_urbs[i]);
 630
 631         usb_kill_urb(port->interrupt_in_urb);
 632 }
 633
 634 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
 635 {
 636         int ok_cnt;
 637         int err = -EINVAL;
 638         int i;
 639         struct urb *urb;
 640         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
 641
 642         ok_cnt = 0;
 643         for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++) {
 644                 urb = portdata->in_urbs[i];
 645                 if (!urb)
 646                         continue;
 647                 err = usb_submit_urb(urb, mem_flags);
 648                 if (err) {
 649                         dev_err(&port->dev, "%s: submit urb failed: %d\n",
 650                                 __func__, err);
 651                 } else {
 652                         ok_cnt++;
 653                 }
 654         }
 655
 656         if (ok_cnt && port->interrupt_in_urb) {
 657                 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
 658                 if (err) {
 659                         dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
 660                                 __func__, err);
 661                 }
 662         }
 663
 664         if (ok_cnt > 0) /* at least one rx urb submitted */
 665                 return 0;
 666         else
 667                 return err;
 668 }
 669
 670 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
 671                                         int dir, void *ctx, int len,
 672                                         gfp_t mem_flags,
 673                                         usb_complete_t callback)
 674 {
 675         struct urb      *urb;
 676         u8              *buf;
 677
 678         if (endpoint == -1)
 679                 return NULL;
 680
 681         urb = usb_alloc_urb(0, mem_flags);
 682         if (urb == NULL) {
 683                 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
 684                         __func__, endpoint);
 685                 return NULL;
 686         }
 687
 688         buf = kmalloc(len, mem_flags);
 689         if (buf) {
 690                 /* Fill URB using supplied data */
 691                 usb_fill_bulk_urb(urb, serial->dev,
 692                         usb_sndbulkpipe(serial->dev, endpoint) | dir,
 693                         buf, len, callback, ctx);
 694
 695                 /* debug */
 696                 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
 697                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
 698         } else {
 699                 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
 700                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
 701
 702                 sierra_release_urb(urb);
 703                 urb = NULL;
 704         }
 705
 706         return urb;
 707 }
 708
 709 static void sierra_close(struct usb_serial_port *port)
 710 {
 711         int i;
 712         struct usb_serial *serial = port->serial;
 713         struct sierra_port_private *portdata;
 714
 715         dev_dbg(&port->dev, "%s\n", __func__);
 716         portdata = usb_get_serial_port_data(port);
 717
 718         portdata->rts_state = 0;
 719         portdata->dtr_state = 0;
 720
 721         if (serial->dev) {
 722                 mutex_lock(&serial->disc_mutex);
 723                 if (!serial->disconnected)
 724                         sierra_send_setup(port);
 725                 mutex_unlock(&serial->disc_mutex);
 726
 727                 /* Stop reading urbs */
 728                 sierra_stop_rx_urbs(port);
 729                 /* .. and release them */
 730                 for (i = 0; i < N_IN_URB; i++) {
 731                         sierra_release_urb(portdata->in_urbs[i]);
 732                         portdata->in_urbs[i] = NULL;
 733                 }
 734         }
 735 }
 736
 737 static int sierra_open(struct tty_struct *tty,
 738                         struct usb_serial_port *port, struct file *filp)
 739 {
 740         struct sierra_port_private *portdata;
 741         struct usb_serial *serial = port->serial;
 742         int i;
 743         int err;
 744         int endpoint;
 745         struct urb *urb;
 746
 747         portdata = usb_get_serial_port_data(port);
 748
 749         dev_dbg(&port->dev, "%s\n", __func__);
 750
 751         /* Set some sane defaults */
 752         portdata->rts_state = 1;
 753         portdata->dtr_state = 1;
 754
 755
 756         endpoint = port->bulk_in_endpointAddress;
 757         for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++) {
 758                 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
 759                                         IN_BUFLEN, GFP_KERNEL,
 760                                         sierra_indat_callback);
 761                 portdata->in_urbs[i] = urb;
 762         }
 763         /* clear halt condition */
 764         usb_clear_halt(serial->dev,
 765                         usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
 766
 767         err = sierra_submit_rx_urbs(port, GFP_KERNEL);
 768         if (err) {
 769                 /* get rid of everything as in close */
 770                 sierra_close(port);
 771                 return err;
 772         }
 773         sierra_send_setup(port);
 774
 775         return 0;
 776 }
 777
 778
 779 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
 780 {
 781         struct usb_serial *serial = port->serial;
 782         struct sierra_port_private *portdata;
 783
 784         portdata = usb_get_serial_port_data(port);
 785         portdata->rts_state = on;
 786         portdata->dtr_state = on;
 787
 788         if (serial->dev) {
 789                 mutex_lock(&serial->disc_mutex);
 790                 if (!serial->disconnected)
 791                         sierra_send_setup(port);
 792                 mutex_unlock(&serial->disc_mutex);
 793         }
 794 }
 795
 796 static int sierra_startup(struct usb_serial *serial)
 797 {
 798         struct usb_serial_port *port;
 799         struct sierra_port_private *portdata;
 800         int i;
 801
 802         dev_dbg(&serial->dev->dev, "%s\n", __func__);
 803
 804         /* Set Device mode to D0 */
 805         sierra_set_power_state(serial->dev, 0x0000);
 806
 807         /* Check NMEA and set */
 808         if (nmea)
 809                 sierra_vsc_set_nmea(serial->dev, 1);
 810
 811         /* Now setup per port private data */
 812         for (i = 0; i < serial->num_ports; i++) {
 813                 port = serial->port[i];
 814                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
 815                 if (!portdata) {
 816                         dev_dbg(&port->dev, "%s: kmalloc for "
 817                                 "sierra_port_private (%d) failed!.\n",
 818                                 __func__, i);
 819                         return -ENOMEM;
 820                 }
 821                 spin_lock_init(&portdata->lock);
 822                 /* Set the port private data pointer */
 823                 usb_set_serial_port_data(port, portdata);
 824         }
 825
 826         return 0;
 827 }
 828
 829 static void sierra_release(struct usb_serial *serial)
 830 {
 831         int i;
 832         struct usb_serial_port *port;
 833         struct sierra_port_private *portdata;
 834
 835         dev_dbg(&serial->dev->dev, "%s\n", __func__);
 836
 837         for (i = 0; i < serial->num_ports; ++i) {
 838                 port = serial->port[i];
 839                 if (!port)
 840                         continue;
 841                 portdata = usb_get_serial_port_data(port);
 842                 if (!portdata)
 843                         continue;
 844                 kfree(portdata);
 845         }
 846 }
 847
 848 static struct usb_serial_driver sierra_device = {
 849         .driver = {
 850                 .owner =        THIS_MODULE,
 851                 .name =         "sierra",
 852         },
 853         .description       = "Sierra USB modem",
 854         .id_table          = id_table,
 855         .usb_driver        = &sierra_driver,
 856         .calc_num_ports    = sierra_calc_num_ports,
 857         .probe             = sierra_probe,
 858         .open              = sierra_open,
 859         .close             = sierra_close,
 860         .dtr_rts           = sierra_dtr_rts,
 861         .write             = sierra_write,
 862         .write_room        = sierra_write_room,
 863         .set_termios       = sierra_set_termios,
 864         .tiocmget          = sierra_tiocmget,
 865         .tiocmset          = sierra_tiocmset,
 866         .attach            = sierra_startup,
 867         .release           = sierra_release,
 868         .read_int_callback = sierra_instat_callback,
 869 };
 870
 871 /* Functions used by new usb-serial code. */
 872 static int __init sierra_init(void)
 873 {
 874         int retval;
 875         retval = usb_serial_register(&sierra_device);
 876         if (retval)
 877                 goto failed_device_register;
 878
 879
 880         retval = usb_register(&sierra_driver);
 881         if (retval)
 882                 goto failed_driver_register;
 883
 884         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 885                DRIVER_DESC "\n");
 886
 887         return 0;
 888
 889 failed_driver_register:
 890         usb_serial_deregister(&sierra_device);
 891 failed_device_register:
 892         return retval;
 893 }
 894
 895 static void __exit sierra_exit(void)
 896 {
 897         usb_deregister(&sierra_driver);
 898         usb_serial_deregister(&sierra_device);
 899 }
 900
 901 module_init(sierra_init);
 902 module_exit(sierra_exit);
 903
 904 MODULE_AUTHOR(DRIVER_AUTHOR);
 905 MODULE_DESCRIPTION(DRIVER_DESC);
 906 MODULE_VERSION(DRIVER_VERSION);
 907 MODULE_LICENSE("GPL");
 908
 909 module_param(nmea, bool, S_IRUGO | S_IWUSR);
 910 MODULE_PARM_DESC(nmea, "NMEA streaming");
 911
 912 module_param(debug, bool, S_IRUGO | S_IWUSR);
 913 MODULE_PARM_DESC(debug, "Debug messages");