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 bool 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 Gobi Modem device */
  41         {DEVICE_G1K(0x1410, 0xa008)},   /* Novatel Gobi QDL device */
  42         {DEVICE_G1K(0x0b05, 0x1776)},   /* Asus Gobi Modem device */
  43         {DEVICE_G1K(0x0b05, 0x1774)},   /* Asus Gobi QDL device */
  44         {DEVICE_G1K(0x19d2, 0xfff3)},   /* ONDA Gobi Modem device */
  45         {DEVICE_G1K(0x19d2, 0xfff2)},   /* ONDA Gobi QDL device */
  46         {DEVICE_G1K(0x1557, 0x0a80)},   /* OQO Gobi QDL device */
  47         {DEVICE_G1K(0x05c6, 0x9001)},   /* Generic Gobi Modem device */
  48         {DEVICE_G1K(0x05c6, 0x9002)},   /* Generic Gobi Modem device */
  49         {DEVICE_G1K(0x05c6, 0x9202)},   /* Generic Gobi Modem device */
  50         {DEVICE_G1K(0x05c6, 0x9203)},   /* Generic Gobi Modem device */
  51         {DEVICE_G1K(0x05c6, 0x9222)},   /* Generic Gobi Modem device */
  52         {DEVICE_G1K(0x05c6, 0x9008)},   /* Generic Gobi QDL device */
  53         {DEVICE_G1K(0x05c6, 0x9009)},   /* Generic Gobi Modem device */
  54         {DEVICE_G1K(0x05c6, 0x9201)},   /* Generic Gobi QDL device */
  55         {DEVICE_G1K(0x05c6, 0x9221)},   /* Generic Gobi QDL device */
  56         {DEVICE_G1K(0x05c6, 0x9231)},   /* Generic Gobi QDL device */
  57         {DEVICE_G1K(0x1f45, 0x0001)},   /* Unknown Gobi QDL device */
  58
  59         /* Gobi 2000 devices */
  60         {USB_DEVICE(0x1410, 0xa010)},   /* Novatel Gobi 2000 QDL device */
  61         {USB_DEVICE(0x1410, 0xa011)},   /* Novatel Gobi 2000 QDL device */
  62         {USB_DEVICE(0x1410, 0xa012)},   /* Novatel Gobi 2000 QDL device */
  63         {USB_DEVICE(0x1410, 0xa013)},   /* Novatel Gobi 2000 QDL device */
  64         {USB_DEVICE(0x1410, 0xa014)},   /* Novatel Gobi 2000 QDL device */
  65         {USB_DEVICE(0x413c, 0x8185)},   /* Dell Gobi 2000 QDL device (N0218, VU936) */
  66         {USB_DEVICE(0x413c, 0x8186)},   /* Dell Gobi 2000 Modem device (N0218, VU936) */
  67         {USB_DEVICE(0x05c6, 0x9208)},   /* Generic Gobi 2000 QDL device */
  68         {USB_DEVICE(0x05c6, 0x920b)},   /* Generic Gobi 2000 Modem device */
  69         {USB_DEVICE(0x05c6, 0x9224)},   /* Sony Gobi 2000 QDL device (N0279, VU730) */
  70         {USB_DEVICE(0x05c6, 0x9225)},   /* Sony Gobi 2000 Modem device (N0279, VU730) */
  71         {USB_DEVICE(0x05c6, 0x9244)},   /* Samsung Gobi 2000 QDL device (VL176) */
  72         {USB_DEVICE(0x05c6, 0x9245)},   /* Samsung Gobi 2000 Modem device (VL176) */
  73         {USB_DEVICE(0x03f0, 0x241d)},   /* HP Gobi 2000 QDL device (VP412) */
  74         {USB_DEVICE(0x03f0, 0x251d)},   /* HP Gobi 2000 Modem device (VP412) */
  75         {USB_DEVICE(0x05c6, 0x9214)},   /* Acer Gobi 2000 QDL device (VP413) */
  76         {USB_DEVICE(0x05c6, 0x9215)},   /* Acer Gobi 2000 Modem device (VP413) */
  77         {USB_DEVICE(0x05c6, 0x9264)},   /* Asus Gobi 2000 QDL device (VR305) */
  78         {USB_DEVICE(0x05c6, 0x9265)},   /* Asus Gobi 2000 Modem device (VR305) */
  79         {USB_DEVICE(0x05c6, 0x9234)},   /* Top Global Gobi 2000 QDL device (VR306) */
  80         {USB_DEVICE(0x05c6, 0x9235)},   /* Top Global Gobi 2000 Modem device (VR306) */
  81         {USB_DEVICE(0x05c6, 0x9274)},   /* iRex Technologies Gobi 2000 QDL device (VR307) */
  82         {USB_DEVICE(0x05c6, 0x9275)},   /* iRex Technologies Gobi 2000 Modem device (VR307) */
  83         {USB_DEVICE(0x1199, 0x9000)},   /* Sierra Wireless Gobi 2000 QDL device (VT773) */
  84         {USB_DEVICE(0x1199, 0x9001)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  85         {USB_DEVICE(0x1199, 0x9002)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  86         {USB_DEVICE(0x1199, 0x9003)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  87         {USB_DEVICE(0x1199, 0x9004)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  88         {USB_DEVICE(0x1199, 0x9005)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  89         {USB_DEVICE(0x1199, 0x9006)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  90         {USB_DEVICE(0x1199, 0x9007)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  91         {USB_DEVICE(0x1199, 0x9008)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  92         {USB_DEVICE(0x1199, 0x9009)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  93         {USB_DEVICE(0x1199, 0x900a)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  94         {USB_DEVICE(0x1199, 0x9011)},   /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
  95         {USB_DEVICE(0x16d8, 0x8001)},   /* CMDTech Gobi 2000 QDL device (VU922) */
  96         {USB_DEVICE(0x16d8, 0x8002)},   /* CMDTech Gobi 2000 Modem device (VU922) */
  97         {USB_DEVICE(0x05c6, 0x9204)},   /* Gobi 2000 QDL device */
  98         {USB_DEVICE(0x05c6, 0x9205)},   /* Gobi 2000 Modem device */
  99
 100         /* Gobi 3000 devices */
 101         {USB_DEVICE(0x03f0, 0x371d)},   /* HP un2430 Gobi 3000 QDL */
 102         {USB_DEVICE(0x05c6, 0x920c)},   /* Gobi 3000 QDL */
 103         {USB_DEVICE(0x05c6, 0x920d)},   /* Gobi 3000 Composite */
 104         {USB_DEVICE(0x1410, 0xa020)},   /* Novatel Gobi 3000 QDL */
 105         {USB_DEVICE(0x1410, 0xa021)},   /* Novatel Gobi 3000 Composite */
 106         {USB_DEVICE(0x413c, 0x8193)},   /* Dell Gobi 3000 QDL */
 107         {USB_DEVICE(0x413c, 0x8194)},   /* Dell Gobi 3000 Composite */
 108         {USB_DEVICE(0x1199, 0x68a4)},   /* Sierra Wireless QDL */
 109         {USB_DEVICE(0x1199, 0x68a5)},   /* Sierra Wireless Modem */
 110         {USB_DEVICE(0x1199, 0x68a8)},   /* Sierra Wireless QDL */
 111         {USB_DEVICE(0x1199, 0x68a9)},   /* Sierra Wireless Modem */
 112         {USB_DEVICE(0x1199, 0x9010)},   /* Sierra Wireless Gobi 3000 QDL */
 113         {USB_DEVICE(0x1199, 0x9012)},   /* Sierra Wireless Gobi 3000 QDL */
 114         {USB_DEVICE(0x1199, 0x9013)},   /* Sierra Wireless Gobi 3000 Modem device (MC8355) */
 115         {USB_DEVICE(0x1199, 0x9014)},   /* Sierra Wireless Gobi 3000 QDL */
 116         {USB_DEVICE(0x1199, 0x9015)},   /* Sierra Wireless Gobi 3000 Modem device */
 117         {USB_DEVICE(0x1199, 0x9018)},   /* Sierra Wireless Gobi 3000 QDL */
 118         {USB_DEVICE(0x1199, 0x9019)},   /* Sierra Wireless Gobi 3000 Modem device */
 119         {USB_DEVICE(0x1199, 0x901b)},   /* Sierra Wireless MC7770 */
 120         {USB_DEVICE(0x12D1, 0x14F0)},   /* Sony Gobi 3000 QDL */
 121         {USB_DEVICE(0x12D1, 0x14F1)},   /* Sony Gobi 3000 Composite */
 122
 123         /* non Gobi Qualcomm serial devices */
 124         {USB_DEVICE_INTERFACE_NUMBER(0x0f3d, 0x68a2, 0)},       /* Sierra Wireless MC7700 Device Management */
 125         {USB_DEVICE_INTERFACE_NUMBER(0x0f3d, 0x68a2, 2)},       /* Sierra Wireless MC7700 NMEA */
 126         {USB_DEVICE_INTERFACE_NUMBER(0x0f3d, 0x68a2, 3)},       /* Sierra Wireless MC7700 Modem */
 127         {USB_DEVICE_INTERFACE_NUMBER(0x114f, 0x68a2, 0)},       /* Sierra Wireless MC7750 Device Management */
 128         {USB_DEVICE_INTERFACE_NUMBER(0x114f, 0x68a2, 2)},       /* Sierra Wireless MC7750 NMEA */
 129         {USB_DEVICE_INTERFACE_NUMBER(0x114f, 0x68a2, 3)},       /* Sierra Wireless MC7750 Modem */
 130         {USB_DEVICE_INTERFACE_NUMBER(0x1199, 0x68a2, 0)},       /* Sierra Wireless MC7710 Device Management */
 131         {USB_DEVICE_INTERFACE_NUMBER(0x1199, 0x68a2, 2)},       /* Sierra Wireless MC7710 NMEA */
 132         {USB_DEVICE_INTERFACE_NUMBER(0x1199, 0x68a2, 3)},       /* Sierra Wireless MC7710 Modem */
 133         {USB_DEVICE_INTERFACE_NUMBER(0x1199, 0x901c, 0)},       /* Sierra Wireless EM7700 Device Management */
 134         {USB_DEVICE_INTERFACE_NUMBER(0x1199, 0x901c, 2)},       /* Sierra Wireless EM7700 NMEA */
 135         {USB_DEVICE_INTERFACE_NUMBER(0x1199, 0x901c, 3)},       /* Sierra Wireless EM7700 Modem */
 136
 137         { }                             /* Terminating entry */
 138 };
 139 MODULE_DEVICE_TABLE(usb, id_table);
 140
 141 static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
 142 {
 143         struct usb_wwan_intf_private *data;
 144         struct usb_host_interface *intf = serial->interface->cur_altsetting;
 145         struct device *dev = &serial->dev->dev;
 146         int retval = -ENODEV;
 147         __u8 nintf;
 148         __u8 ifnum;
 149         bool is_gobi1k = id->driver_info ? true : false;
 150         int altsetting = -1;
 151
 152         dev_dbg(dev, "Is Gobi 1000 = %d\n", is_gobi1k);
 153
 154         nintf = serial->dev->actconfig->desc.bNumInterfaces;
 155         dev_dbg(dev, "Num Interfaces = %d\n", nintf);
 156         ifnum = intf->desc.bInterfaceNumber;
 157         dev_dbg(dev, "This Interface = %d\n", ifnum);
 158
 159         data = kzalloc(sizeof(struct usb_wwan_intf_private),
 160                                          GFP_KERNEL);
 161         if (!data)
 162                 return -ENOMEM;
 163
 164         spin_lock_init(&data->susp_lock);
 165
 166         if (nintf == 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                         goto done;
 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                         dev_dbg(dev, "QDL port found\n");
 178
 179                         if (serial->interface->num_altsetting == 1)
 180                                 retval = 0; /* Success */
 181                         else
 182                                 altsetting = 1;
 183                 }
 184                 goto done;
 185
 186         }
 187
 188         /* allow any number of interfaces when doing direct interface match */
 189         if (id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) {
 190                 dev_dbg(dev, "Generic Qualcomm serial interface found\n");
 191                 altsetting = 0;
 192                 goto done;
 193         }
 194
 195         if (nintf < 3 || nintf > 4) {
 196                 dev_err(dev, "unknown number of interfaces: %d\n", nintf);
 197                 goto done;
 198         }
 199
 200         /* default to enabling interface */
 201         altsetting = 0;
 202         switch (ifnum) {
 203                 /* Composite mode; don't bind to the QMI/net interface as that
 204                  * gets handled by other drivers.
 205                  */
 206
 207                 /* Gobi 1K USB layout:
 208                  * 0: serial port (doesn't respond)
 209                  * 1: serial port (doesn't respond)
 210                  * 2: AT-capable modem port
 211                  * 3: QMI/net
 212                  *
 213                  * Gobi 2K+ USB layout:
 214                  * 0: QMI/net
 215                  * 1: DM/DIAG (use libqcdm from ModemManager for communication)
 216                  * 2: AT-capable modem port
 217                  * 3: NMEA
 218                  */
 219
 220         case 1:
 221                 if (is_gobi1k)
 222                         altsetting = -1;
 223                 else
 224                         dev_dbg(dev, "Gobi 2K+ DM/DIAG interface found\n");
 225                 break;
 226         case 2:
 227                 dev_dbg(dev, "Modem port found\n");
 228                 break;
 229         case 3:
 230                 if (is_gobi1k)
 231                         altsetting = -1;
 232                 else
 233                         /*
 234                          * NMEA (serial line 9600 8N1)
 235                          * # echo "\$GPS_START" > /dev/ttyUSBx
 236                          * # echo "\$GPS_STOP"  > /dev/ttyUSBx
 237                          */
 238                         dev_dbg(dev, "Gobi 2K+ NMEA GPS interface found\n");
 239         }
 240
 241 done:
 242         if (altsetting >= 0) {
 243                 retval = usb_set_interface(serial->dev, ifnum, altsetting);
 244                 if (retval < 0) {
 245                         dev_err(dev,
 246                                 "Could not set interface, error %d\n",
 247                                 retval);
 248                         retval = -ENODEV;
 249                 }
 250         }
 251
 252         /* Set serial->private if not returning error */
 253         if (retval == 0)
 254                 usb_set_serial_data(serial, data);
 255         else
 256                 kfree(data);
 257
 258         return retval;
 259 }
 260
 261 static void qc_release(struct usb_serial *serial)
 262 {
 263         struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
 264
 265         /* Call usb_wwan release & free the private data allocated in qcprobe */
 266         usb_wwan_release(serial);
 267         usb_set_serial_data(serial, NULL);
 268         kfree(priv);
 269 }
 270
 271 static struct usb_serial_driver qcdevice = {
 272         .driver = {
 273                 .owner     = THIS_MODULE,
 274                 .name      = "qcserial",
 275         },
 276         .description         = "Qualcomm USB modem",
 277         .id_table            = id_table,
 278         .num_ports           = 1,
 279         .probe               = qcprobe,
 280         .open                = usb_wwan_open,
 281         .close               = usb_wwan_close,
 282         .write               = usb_wwan_write,
 283         .write_room          = usb_wwan_write_room,
 284         .chars_in_buffer     = usb_wwan_chars_in_buffer,
 285         .attach              = usb_wwan_startup,
 286         .disconnect          = usb_wwan_disconnect,
 287         .release             = qc_release,
 288 #ifdef CONFIG_PM
 289         .suspend             = usb_wwan_suspend,
 290         .resume              = usb_wwan_resume,
 291 #endif
 292 };
 293
 294 static struct usb_serial_driver * const serial_drivers[] = {
 295         &qcdevice, NULL
 296 };
 297
 298 module_usb_serial_driver(serial_drivers, id_table);
 299
 300 MODULE_AUTHOR(DRIVER_AUTHOR);
 301 MODULE_DESCRIPTION(DRIVER_DESC);
 302 MODULE_LICENSE("GPL v2");
 303
 304 module_param(debug, bool, S_IRUGO | S_IWUSR);
 305 MODULE_PARM_DESC(debug, "Debug enabled or not");