drivers/usb/serial/qcserial.c

   1 /*
   2  * Qualcomm Serial USB driver
   3  *
   4  *      Copyright (c) 2008 QUALCOMM Incorporated.
   5  *      Copyright (c) 2009 Greg Kroah-Hartman <gregkh@suse.de>
   6  *      Copyright (c) 2009 Novell Inc.
   7  *
   8  *      This program is free software; you can redistribute it and/or
   9  *      modify it under the terms of the GNU General Public License version
  10  *      2 as published by the Free Software Foundation.
  11  *
  12  */
  13
  14 #include <linux/tty.h>
  15 #include <linux/tty_flip.h>
  16 #include <linux/module.h>
  17 #include <linux/usb.h>
  18 #include <linux/usb/serial.h>
  19 #include <linux/slab.h>
  20 #include "usb-wwan.h"
  21
  22 #define DRIVER_AUTHOR "Qualcomm Inc"
  23 #define DRIVER_DESC "Qualcomm USB Serial driver"
  24
  25 static int debug;
  26
  27 #define DEVICE_G1K(v, p) \
  28         USB_DEVICE(v, p), .driver_info = 1
  29
  30 static const struct usb_device_id id_table[] = {
  31         /* Gobi 1000 devices */
  32         {DEVICE_G1K(0x05c6, 0x9211)},   /* Acer Gobi QDL device */
  33         {DEVICE_G1K(0x05c6, 0x9212)},   /* Acer Gobi Modem Device */
  34         {DEVICE_G1K(0x03f0, 0x1f1d)},   /* HP un2400 Gobi Modem Device */
  35         {DEVICE_G1K(0x03f0, 0x201d)},   /* HP un2400 Gobi QDL Device */
  36         {DEVICE_G1K(0x04da, 0x250d)},   /* Panasonic Gobi Modem device */
  37         {DEVICE_G1K(0x04da, 0x250c)},   /* Panasonic Gobi QDL device */
  38         {DEVICE_G1K(0x413c, 0x8172)},   /* Dell Gobi Modem device */
  39         {DEVICE_G1K(0x413c, 0x8171)},   /* Dell Gobi QDL device */
  40         {DEVICE_G1K(0x1410, 0xa001)},   /* Novatel/Verizon USB-1000 */
  41         {DEVICE_G1K(0x1410, 0xa002)},   /* Novatel Gobi Modem device */
  42         {DEVICE_G1K(0x1410, 0xa003)},   /* Novatel Gobi Modem device */
  43         {DEVICE_G1K(0x1410, 0xa004)},   /* Novatel Gobi Modem device */
  44         {DEVICE_G1K(0x1410, 0xa005)},   /* Novatel Gobi Modem device */
  45         {DEVICE_G1K(0x1410, 0xa006)},   /* Novatel Gobi Modem device */
  46         {DEVICE_G1K(0x1410, 0xa007)},   /* Novatel Gobi Modem device */
  47         {DEVICE_G1K(0x1410, 0xa008)},   /* Novatel Gobi QDL device */
  48         {DEVICE_G1K(0x0b05, 0x1776)},   /* Asus Gobi Modem device */
  49         {DEVICE_G1K(0x0b05, 0x1774)},   /* Asus Gobi QDL device */
  50         {DEVICE_G1K(0x19d2, 0xfff3)},   /* ONDA Gobi Modem device */
  51         {DEVICE_G1K(0x19d2, 0xfff2)},   /* ONDA Gobi QDL device */
  52         {DEVICE_G1K(0x1557, 0x0a80)},   /* OQO Gobi QDL device */
  53         {DEVICE_G1K(0x05c6, 0x9001)},   /* Generic Gobi Modem device */
  54         {DEVICE_G1K(0x05c6, 0x9002)},   /* Generic Gobi Modem device */
  55         {DEVICE_G1K(0x05c6, 0x9202)},   /* Generic Gobi Modem device */
  56         {DEVICE_G1K(0x05c6, 0x9203)},   /* Generic Gobi Modem device */
  57         {DEVICE_G1K(0x05c6, 0x9222)},   /* Generic Gobi Modem device */
  58         {DEVICE_G1K(0x05c6, 0x9008)},   /* Generic Gobi QDL device */
  59         {DEVICE_G1K(0x05c6, 0x9009)},   /* Generic Gobi Modem device */
  60         {DEVICE_G1K(0x05c6, 0x9201)},   /* Generic Gobi QDL device */
  61         {DEVICE_G1K(0x05c6, 0x9221)},   /* Generic Gobi QDL device */
  62         {DEVICE_G1K(0x05c6, 0x9231)},   /* Generic Gobi QDL device */
  63         {DEVICE_G1K(0x1f45, 0x0001)},   /* Unknown Gobi QDL device */
  64         {DEVICE_G1K(0x1bc7, 0x900e)},   /* Telit Gobi QDL device */
  65
  66         /* Gobi 2000 devices */
  67         {USB_DEVICE(0x1410, 0xa010)},   /* Novatel Gobi 2000 QDL device */
  68         {USB_DEVICE(0x1410, 0xa011)},   /* Novatel Gobi 2000 QDL device */
  69         {USB_DEVICE(0x1410, 0xa012)},   /* Novatel Gobi 2000 QDL device */
  70         {USB_DEVICE(0x1410, 0xa013)},   /* Novatel Gobi 2000 QDL device */
  71         {USB_DEVICE(0x1410, 0xa014)},   /* Novatel Gobi 2000 QDL device */
  72         {USB_DEVICE(0x413c, 0x8185)},   /* Dell Gobi 2000 QDL device (N0218, VU936) */
  73         {USB_DEVICE(0x413c, 0x8186)},   /* Dell Gobi 2000 Modem device (N0218, VU936) */
  74         {USB_DEVICE(0x05c6, 0x9208)},   /* Generic Gobi 2000 QDL device */
  75         {USB_DEVICE(0x05c6, 0x920b)},   /* Generic Gobi 2000 Modem device */
  76         {USB_DEVICE(0x05c6, 0x9224)},   /* Sony Gobi 2000 QDL device (N0279, VU730) */
  77         {USB_DEVICE(0x05c6, 0x9225)},   /* Sony Gobi 2000 Modem device (N0279, VU730) */
  78         {USB_DEVICE(0x05c6, 0x9244)},   /* Samsung Gobi 2000 QDL device (VL176) */
  79         {USB_DEVICE(0x05c6, 0x9245)},   /* Samsung Gobi 2000 Modem device (VL176) */
  80         {USB_DEVICE(0x03f0, 0x241d)},   /* HP Gobi 2000 QDL device (VP412) */
  81         {USB_DEVICE(0x03f0, 0x251d)},   /* HP Gobi 2000 Modem device (VP412) */
  82         {USB_DEVICE(0x05c6, 0x9214)},   /* Acer Gobi 2000 QDL device (VP413) */
  83         {USB_DEVICE(0x05c6, 0x9215)},   /* Acer Gobi 2000 Modem device (VP413) */
  84         {USB_DEVICE(0x05c6, 0x9264)},   /* Asus Gobi 2000 QDL device (VR305) */
  85         {USB_DEVICE(0x05c6, 0x9265)},   /* Asus Gobi 2000 Modem device (VR305) */
  86         {USB_DEVICE(0x05c6, 0x9234)},   /* Top Global Gobi 2000 QDL device (VR306) */
  87         {USB_DEVICE(0x05c6, 0x9235)},   /* Top Global Gobi 2000 Modem device (VR306) */
  88         {USB_DEVICE(0x05c6, 0x9274)},   /* iRex Technologies Gobi 2000 QDL device (VR307) */
  89         {USB_DEVICE(0x05c6, 0x9275)},   /* iRex Technologies Gobi 2000 Modem device (VR307) */
  90         {USB_DEVICE(0x1199, 0x9000)},   /* Sierra Wireless Gobi 2000 QDL device (VT773) */
  91         {USB_DEVICE(0x1199, 0x9001)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  92         {USB_DEVICE(0x1199, 0x9002)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  93         {USB_DEVICE(0x1199, 0x9003)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  94         {USB_DEVICE(0x1199, 0x9004)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  95         {USB_DEVICE(0x1199, 0x9005)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  96         {USB_DEVICE(0x1199, 0x9006)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  97         {USB_DEVICE(0x1199, 0x9007)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  98         {USB_DEVICE(0x1199, 0x9008)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  99         {USB_DEVICE(0x1199, 0x9009)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 100         {USB_DEVICE(0x1199, 0x900a)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 101         {USB_DEVICE(0x1199, 0x9011)},   /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
 102         {USB_DEVICE(0x16d8, 0x8001)},   /* CMDTech Gobi 2000 QDL device (VU922) */
 103         {USB_DEVICE(0x16d8, 0x8002)},   /* CMDTech Gobi 2000 Modem device (VU922) */
 104         {USB_DEVICE(0x05c6, 0x9204)},   /* Gobi 2000 QDL device */
 105         {USB_DEVICE(0x05c6, 0x9205)},   /* Gobi 2000 Modem device */
 106
 107         /* Gobi 3000 devices */
 108         {USB_DEVICE(0x03f0, 0x371d)},   /* HP un2430 Gobi 3000 QDL */
 109         {USB_DEVICE(0x05c6, 0x920c)},   /* Gobi 3000 QDL */
 110         {USB_DEVICE(0x05c6, 0x920d)},   /* Gobi 3000 Composite */
 111         {USB_DEVICE(0x1410, 0xa020)},   /* Novatel Gobi 3000 QDL */
 112         {USB_DEVICE(0x1410, 0xa021)},   /* Novatel Gobi 3000 Composite */
 113         {USB_DEVICE(0x413c, 0x8193)},   /* Dell Gobi 3000 QDL */
 114         {USB_DEVICE(0x413c, 0x8194)},   /* Dell Gobi 3000 Composite */
 115         {USB_DEVICE(0x1199, 0x9010)},   /* Sierra Wireless Gobi 3000 QDL */
 116         {USB_DEVICE(0x1199, 0x9012)},   /* Sierra Wireless Gobi 3000 QDL */
 117         {USB_DEVICE(0x1199, 0x9013)},   /* Sierra Wireless Gobi 3000 Modem device (MC8355) */
 118         {USB_DEVICE(0x1199, 0x9014)},   /* Sierra Wireless Gobi 3000 QDL */
 119         {USB_DEVICE(0x1199, 0x9015)},   /* Sierra Wireless Gobi 3000 Modem device */
 120         {USB_DEVICE(0x1199, 0x9018)},   /* Sierra Wireless Gobi 3000 QDL */
 121         {USB_DEVICE(0x1199, 0x9019)},   /* Sierra Wireless Gobi 3000 Modem device */
 122         {USB_DEVICE(0x12D1, 0x14F0)},   /* Sony Gobi 3000 QDL */
 123         {USB_DEVICE(0x12D1, 0x14F1)},   /* Sony Gobi 3000 Composite */
 124         {USB_DEVICE(0x0AF0, 0x8120)},   /* Option GTM681W */
 125         { }                             /* Terminating entry */
 126 };
 127 MODULE_DEVICE_TABLE(usb, id_table);
 128
 129 static struct usb_driver qcdriver = {
 130         .name                   = "qcserial",
 131         .probe                  = usb_serial_probe,
 132         .disconnect             = usb_serial_disconnect,
 133         .id_table               = id_table,
 134         .suspend                = usb_serial_suspend,
 135         .resume                 = usb_serial_resume,
 136         .supports_autosuspend   = true,
 137 };
 138
 139 static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
 140 {
 141         struct usb_wwan_intf_private *data;
 142         struct usb_host_interface *intf = serial->interface->cur_altsetting;
 143         int retval = -ENODEV;
 144         __u8 nintf;
 145         __u8 ifnum;
 146         bool is_gobi1k = id->driver_info ? true : false;
 147
 148         dbg("%s", __func__);
 149         dbg("Is Gobi 1000 = %d", is_gobi1k);
 150
 151         nintf = serial->dev->actconfig->desc.bNumInterfaces;
 152         dbg("Num Interfaces = %d", nintf);
 153         ifnum = intf->desc.bInterfaceNumber;
 154         dbg("This Interface = %d", ifnum);
 155
 156         data = kzalloc(sizeof(struct usb_wwan_intf_private),
 157                                          GFP_KERNEL);
 158         if (!data)
 159                 return -ENOMEM;
 160
 161         spin_lock_init(&data->susp_lock);
 162
 163         usb_enable_autosuspend(serial->dev);
 164
 165         switch (nintf) {
 166         case 1:
 167                 /* QDL mode */
 168                 /* Gobi 2000 has a single altsetting, older ones have two */
 169                 if (serial->interface->num_altsetting == 2)
 170                         intf = &serial->interface->altsetting[1];
 171                 else if (serial->interface->num_altsetting > 2)
 172                         break;
 173
 174                 if (intf->desc.bNumEndpoints == 2 &&
 175                     usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
 176                     usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
 177                         dbg("QDL port found");
 178
 179                         if (serial->interface->num_altsetting == 1) {
 180                                 retval = 0; /* Success */
 181                                 break;
 182                         }
 183
 184                         retval = usb_set_interface(serial->dev, ifnum, 1);
 185                         if (retval < 0) {
 186                                 dev_err(&serial->dev->dev,
 187                                         "Could not set interface, error %d\n",
 188                                         retval);
 189                                 retval = -ENODEV;
 190                                 kfree(data);
 191                         }
 192                 }
 193                 break;
 194
 195         case 3:
 196         case 4:
 197                 /* Composite mode; don't bind to the QMI/net interface as that
 198                  * gets handled by other drivers.
 199                  */
 200
 201                 /* Gobi 1K USB layout:
 202                  * 0: serial port (doesn't respond)
 203                  * 1: serial port (doesn't respond)
 204                  * 2: AT-capable modem port
 205                  * 3: QMI/net
 206                  *
 207                  * Gobi 2K+ USB layout:
 208                  * 0: QMI/net
 209                  * 1: DM/DIAG (use libqcdm from ModemManager for communication)
 210                  * 2: AT-capable modem port
 211                  * 3: NMEA
 212                  */
 213
 214                 if (ifnum == 1 && !is_gobi1k) {
 215                         dbg("Gobi 2K+ DM/DIAG interface found");
 216                         retval = usb_set_interface(serial->dev, ifnum, 0);
 217                         if (retval < 0) {
 218                                 dev_err(&serial->dev->dev,
 219                                         "Could not set interface, error %d\n",
 220                                         retval);
 221                                 retval = -ENODEV;
 222                                 kfree(data);
 223                         }
 224                 } else if (ifnum == 2) {
 225                         dbg("Modem port found");
 226                         retval = usb_set_interface(serial->dev, ifnum, 0);
 227                         if (retval < 0) {
 228                                 dev_err(&serial->dev->dev,
 229                                         "Could not set interface, error %d\n",
 230                                         retval);
 231                                 retval = -ENODEV;
 232                                 kfree(data);
 233                         }
 234                 } else if (ifnum==3 && !is_gobi1k) {
 235                         /*
 236                          * NMEA (serial line 9600 8N1)
 237                          * # echo "\$GPS_START" > /dev/ttyUSBx
 238                          * # echo "\$GPS_STOP"  > /dev/ttyUSBx
 239                          */
 240                         dbg("Gobi 2K+ NMEA GPS interface found");
 241                         retval = usb_set_interface(serial->dev, ifnum, 0);
 242                         if (retval < 0) {
 243                                 dev_err(&serial->dev->dev,
 244                                         "Could not set interface, error %d\n",
 245                                         retval);
 246                                 retval = -ENODEV;
 247                                 kfree(data);
 248                         }
 249                 }
 250                 break;
 251
 252         default:
 253                 dev_err(&serial->dev->dev,
 254                         "unknown number of interfaces: %d\n", nintf);
 255                 kfree(data);
 256                 retval = -ENODEV;
 257         }
 258
 259         /* Set serial->private if not returning -ENODEV */
 260         if (retval != -ENODEV)
 261                 usb_set_serial_data(serial, data);
 262         return retval;
 263 }
 264
 265 static void qc_release(struct usb_serial *serial)
 266 {
 267         struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
 268
 269         dbg("%s", __func__);
 270
 271         /* Call usb_wwan release & free the private data allocated in qcprobe */
 272         usb_wwan_release(serial);
 273         usb_set_serial_data(serial, NULL);
 274         kfree(priv);
 275 }
 276
 277 static struct usb_serial_driver qcdevice = {
 278         .driver = {
 279                 .owner     = THIS_MODULE,
 280                 .name      = "qcserial",
 281         },
 282         .description         = "Qualcomm USB modem",
 283         .id_table            = id_table,
 284         .usb_driver          = &qcdriver,
 285         .num_ports           = 1,
 286         .probe               = qcprobe,
 287         .open                = usb_wwan_open,
 288         .close               = usb_wwan_close,
 289         .write               = usb_wwan_write,
 290         .write_room          = usb_wwan_write_room,
 291         .chars_in_buffer     = usb_wwan_chars_in_buffer,
 292         .attach              = usb_wwan_startup,
 293         .disconnect          = usb_wwan_disconnect,
 294         .release             = qc_release,
 295 #ifdef CONFIG_PM
 296         .suspend             = usb_wwan_suspend,
 297         .resume              = usb_wwan_resume,
 298 #endif
 299 };
 300
 301 static int __init qcinit(void)
 302 {
 303         int retval;
 304
 305         retval = usb_serial_register(&qcdevice);
 306         if (retval)
 307                 return retval;
 308
 309         retval = usb_register(&qcdriver);
 310         if (retval) {
 311                 usb_serial_deregister(&qcdevice);
 312                 return retval;
 313         }
 314
 315         return 0;
 316 }
 317
 318 static void __exit qcexit(void)
 319 {
 320         usb_deregister(&qcdriver);
 321         usb_serial_deregister(&qcdevice);
 322 }
 323
 324 module_init(qcinit);
 325 module_exit(qcexit);
 326
 327 MODULE_AUTHOR(DRIVER_AUTHOR);
 328 MODULE_DESCRIPTION(DRIVER_DESC);
 329 MODULE_LICENSE("GPL v2");
 330
 331 module_param(debug, bool, S_IRUGO | S_IWUSR);
 332 MODULE_PARM_DESC(debug, "Debug enabled or not");