kernel/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 /* standard device layouts supported by this driver */
  26 enum qcserial_layouts {
  27         QCSERIAL_G2K = 0,       /* Gobi 2000 */
  28         QCSERIAL_G1K = 1,       /* Gobi 1000 */
  29         QCSERIAL_SWI = 2,       /* Sierra Wireless */
  30         QCSERIAL_HWI = 3,       /* Huawei */
  31 };
  32
  33 #define DEVICE_G1K(v, p) \
  34         USB_DEVICE(v, p), .driver_info = QCSERIAL_G1K
  35 #define DEVICE_SWI(v, p) \
  36         USB_DEVICE(v, p), .driver_info = QCSERIAL_SWI
  37 #define DEVICE_HWI(v, p) \
  38         USB_DEVICE(v, p), .driver_info = QCSERIAL_HWI
  39
  40 static const struct usb_device_id id_table[] = {
  41         /* Gobi 1000 devices */
  42         {DEVICE_G1K(0x05c6, 0x9211)},   /* Acer Gobi QDL device */
  43         {DEVICE_G1K(0x05c6, 0x9212)},   /* Acer Gobi Modem Device */
  44         {DEVICE_G1K(0x03f0, 0x1f1d)},   /* HP un2400 Gobi Modem Device */
  45         {DEVICE_G1K(0x03f0, 0x201d)},   /* HP un2400 Gobi QDL Device */
  46         {DEVICE_G1K(0x04da, 0x250d)},   /* Panasonic Gobi Modem device */
  47         {DEVICE_G1K(0x04da, 0x250c)},   /* Panasonic Gobi QDL device */
  48         {DEVICE_G1K(0x413c, 0x8172)},   /* Dell Gobi Modem device */
  49         {DEVICE_G1K(0x413c, 0x8171)},   /* Dell Gobi QDL device */
  50         {DEVICE_G1K(0x1410, 0xa001)},   /* Novatel/Verizon USB-1000 */
  51         {DEVICE_G1K(0x1410, 0xa002)},   /* Novatel Gobi Modem device */
  52         {DEVICE_G1K(0x1410, 0xa003)},   /* Novatel Gobi Modem device */
  53         {DEVICE_G1K(0x1410, 0xa004)},   /* Novatel Gobi Modem device */
  54         {DEVICE_G1K(0x1410, 0xa005)},   /* Novatel Gobi Modem device */
  55         {DEVICE_G1K(0x1410, 0xa006)},   /* Novatel Gobi Modem device */
  56         {DEVICE_G1K(0x1410, 0xa007)},   /* Novatel Gobi Modem device */
  57         {DEVICE_G1K(0x1410, 0xa008)},   /* Novatel Gobi QDL device */
  58         {DEVICE_G1K(0x0b05, 0x1776)},   /* Asus Gobi Modem device */
  59         {DEVICE_G1K(0x0b05, 0x1774)},   /* Asus Gobi QDL device */
  60         {DEVICE_G1K(0x19d2, 0xfff3)},   /* ONDA Gobi Modem device */
  61         {DEVICE_G1K(0x19d2, 0xfff2)},   /* ONDA Gobi QDL device */
  62         {DEVICE_G1K(0x1557, 0x0a80)},   /* OQO Gobi QDL device */
  63         {DEVICE_G1K(0x05c6, 0x9001)},   /* Generic Gobi Modem device */
  64         {DEVICE_G1K(0x05c6, 0x9002)},   /* Generic Gobi Modem device */
  65         {DEVICE_G1K(0x05c6, 0x9202)},   /* Generic Gobi Modem device */
  66         {DEVICE_G1K(0x05c6, 0x9203)},   /* Generic Gobi Modem device */
  67         {DEVICE_G1K(0x05c6, 0x9222)},   /* Generic Gobi Modem device */
  68         {DEVICE_G1K(0x05c6, 0x9008)},   /* Generic Gobi QDL device */
  69         {DEVICE_G1K(0x05c6, 0x9009)},   /* Generic Gobi Modem device */
  70         {DEVICE_G1K(0x05c6, 0x9201)},   /* Generic Gobi QDL device */
  71         {DEVICE_G1K(0x05c6, 0x9221)},   /* Generic Gobi QDL device */
  72         {DEVICE_G1K(0x05c6, 0x9231)},   /* Generic Gobi QDL device */
  73         {DEVICE_G1K(0x1f45, 0x0001)},   /* Unknown Gobi QDL device */
  74         {DEVICE_G1K(0x1bc7, 0x900e)},   /* Telit Gobi QDL device */
  75
  76         /* Gobi 2000 devices */
  77         {USB_DEVICE(0x1410, 0xa010)},   /* Novatel Gobi 2000 QDL device */
  78         {USB_DEVICE(0x1410, 0xa011)},   /* Novatel Gobi 2000 QDL device */
  79         {USB_DEVICE(0x1410, 0xa012)},   /* Novatel Gobi 2000 QDL device */
  80         {USB_DEVICE(0x1410, 0xa013)},   /* Novatel Gobi 2000 QDL device */
  81         {USB_DEVICE(0x1410, 0xa014)},   /* Novatel Gobi 2000 QDL device */
  82         {USB_DEVICE(0x413c, 0x8185)},   /* Dell Gobi 2000 QDL device (N0218, VU936) */
  83         {USB_DEVICE(0x413c, 0x8186)},   /* Dell Gobi 2000 Modem device (N0218, VU936) */
  84         {USB_DEVICE(0x05c6, 0x9208)},   /* Generic Gobi 2000 QDL device */
  85         {USB_DEVICE(0x05c6, 0x920b)},   /* Generic Gobi 2000 Modem device */
  86         {USB_DEVICE(0x05c6, 0x9224)},   /* Sony Gobi 2000 QDL device (N0279, VU730) */
  87         {USB_DEVICE(0x05c6, 0x9225)},   /* Sony Gobi 2000 Modem device (N0279, VU730) */
  88         {USB_DEVICE(0x05c6, 0x9244)},   /* Samsung Gobi 2000 QDL device (VL176) */
  89         {USB_DEVICE(0x05c6, 0x9245)},   /* Samsung Gobi 2000 Modem device (VL176) */
  90         {USB_DEVICE(0x03f0, 0x241d)},   /* HP Gobi 2000 QDL device (VP412) */
  91         {USB_DEVICE(0x03f0, 0x251d)},   /* HP Gobi 2000 Modem device (VP412) */
  92         {USB_DEVICE(0x05c6, 0x9214)},   /* Acer Gobi 2000 QDL device (VP413) */
  93         {USB_DEVICE(0x05c6, 0x9215)},   /* Acer Gobi 2000 Modem device (VP413) */
  94         {USB_DEVICE(0x05c6, 0x9264)},   /* Asus Gobi 2000 QDL device (VR305) */
  95         {USB_DEVICE(0x05c6, 0x9265)},   /* Asus Gobi 2000 Modem device (VR305) */
  96         {USB_DEVICE(0x05c6, 0x9234)},   /* Top Global Gobi 2000 QDL device (VR306) */
  97         {USB_DEVICE(0x05c6, 0x9235)},   /* Top Global Gobi 2000 Modem device (VR306) */
  98         {USB_DEVICE(0x05c6, 0x9274)},   /* iRex Technologies Gobi 2000 QDL device (VR307) */
  99         {USB_DEVICE(0x05c6, 0x9275)},   /* iRex Technologies Gobi 2000 Modem device (VR307) */
 100         {USB_DEVICE(0x1199, 0x9000)},   /* Sierra Wireless Gobi 2000 QDL device (VT773) */
 101         {USB_DEVICE(0x1199, 0x9001)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 102         {USB_DEVICE(0x1199, 0x9002)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 103         {USB_DEVICE(0x1199, 0x9003)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 104         {USB_DEVICE(0x1199, 0x9004)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 105         {USB_DEVICE(0x1199, 0x9005)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 106         {USB_DEVICE(0x1199, 0x9006)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 107         {USB_DEVICE(0x1199, 0x9007)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 108         {USB_DEVICE(0x1199, 0x9008)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 109         {USB_DEVICE(0x1199, 0x9009)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 110         {USB_DEVICE(0x1199, 0x900a)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
 111         {USB_DEVICE(0x1199, 0x9011)},   /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
 112         {USB_DEVICE(0x16d8, 0x8001)},   /* CMDTech Gobi 2000 QDL device (VU922) */
 113         {USB_DEVICE(0x16d8, 0x8002)},   /* CMDTech Gobi 2000 Modem device (VU922) */
 114         {USB_DEVICE(0x05c6, 0x9204)},   /* Gobi 2000 QDL device */
 115         {USB_DEVICE(0x05c6, 0x9205)},   /* Gobi 2000 Modem device */
 116
 117         /* Gobi 3000 devices */
 118         {USB_DEVICE(0x03f0, 0x371d)},   /* HP un2430 Gobi 3000 QDL */
 119         {USB_DEVICE(0x05c6, 0x920c)},   /* Gobi 3000 QDL */
 120         {USB_DEVICE(0x05c6, 0x920d)},   /* Gobi 3000 Composite */
 121         {USB_DEVICE(0x1410, 0xa020)},   /* Novatel Gobi 3000 QDL */
 122         {USB_DEVICE(0x1410, 0xa021)},   /* Novatel Gobi 3000 Composite */
 123         {USB_DEVICE(0x413c, 0x8193)},   /* Dell Gobi 3000 QDL */
 124         {USB_DEVICE(0x413c, 0x8194)},   /* Dell Gobi 3000 Composite */
 125         {USB_DEVICE(0x1199, 0x68a4)},   /* Sierra Wireless QDL */
 126         {USB_DEVICE(0x1199, 0x68a5)},   /* Sierra Wireless Modem */
 127         {USB_DEVICE(0x1199, 0x68a8)},   /* Sierra Wireless QDL */
 128         {USB_DEVICE(0x1199, 0x68a9)},   /* Sierra Wireless Modem */
 129         {USB_DEVICE(0x1199, 0x9010)},   /* Sierra Wireless Gobi 3000 QDL */
 130         {USB_DEVICE(0x1199, 0x9012)},   /* Sierra Wireless Gobi 3000 QDL */
 131         {USB_DEVICE(0x1199, 0x9013)},   /* Sierra Wireless Gobi 3000 Modem device (MC8355) */
 132         {USB_DEVICE(0x1199, 0x9014)},   /* Sierra Wireless Gobi 3000 QDL */
 133         {USB_DEVICE(0x1199, 0x9015)},   /* Sierra Wireless Gobi 3000 Modem device */
 134         {USB_DEVICE(0x1199, 0x9018)},   /* Sierra Wireless Gobi 3000 QDL */
 135         {USB_DEVICE(0x1199, 0x9019)},   /* Sierra Wireless Gobi 3000 Modem device */
 136         {USB_DEVICE(0x1199, 0x901b)},   /* Sierra Wireless MC7770 */
 137         {USB_DEVICE(0x12D1, 0x14F0)},   /* Sony Gobi 3000 QDL */
 138         {USB_DEVICE(0x12D1, 0x14F1)},   /* Sony Gobi 3000 Composite */
 139         {USB_DEVICE(0x0AF0, 0x8120)},   /* Option GTM681W */
 140
 141         /* non-Gobi Sierra Wireless devices */
 142         {DEVICE_SWI(0x0f3d, 0x68a2)},   /* Sierra Wireless MC7700 */
 143         {DEVICE_SWI(0x114f, 0x68a2)},   /* Sierra Wireless MC7750 */
 144         {DEVICE_SWI(0x1199, 0x68a2)},   /* Sierra Wireless MC7710 */
 145         {DEVICE_SWI(0x1199, 0x901c)},   /* Sierra Wireless EM7700 */
 146         {DEVICE_SWI(0x1199, 0x901f)},   /* Sierra Wireless EM7355 */
 147         {DEVICE_SWI(0x1199, 0x9040)},   /* Sierra Wireless Modem */
 148         {DEVICE_SWI(0x1199, 0x9041)},   /* Sierra Wireless MC7305/MC7355 */
 149         {DEVICE_SWI(0x1199, 0x9051)},   /* Netgear AirCard 340U */
 150         {DEVICE_SWI(0x1199, 0x9053)},   /* Sierra Wireless Modem */
 151         {DEVICE_SWI(0x1199, 0x9054)},   /* Sierra Wireless Modem */
 152         {DEVICE_SWI(0x1199, 0x9055)},   /* Netgear AirCard 341U */
 153         {DEVICE_SWI(0x1199, 0x9056)},   /* Sierra Wireless Modem */
 154         {DEVICE_SWI(0x1199, 0x9060)},   /* Sierra Wireless Modem */
 155         {DEVICE_SWI(0x1199, 0x9061)},   /* Sierra Wireless Modem */
 156         {DEVICE_SWI(0x413c, 0x81a2)},   /* Dell Wireless 5806 Gobi(TM) 4G LTE Mobile Broadband Card */
 157         {DEVICE_SWI(0x413c, 0x81a3)},   /* Dell Wireless 5570 HSPA+ (42Mbps) Mobile Broadband Card */
 158         {DEVICE_SWI(0x413c, 0x81a4)},   /* Dell Wireless 5570e HSPA+ (42Mbps) Mobile Broadband Card */
 159         {DEVICE_SWI(0x413c, 0x81a8)},   /* Dell Wireless 5808 Gobi(TM) 4G LTE Mobile Broadband Card */
 160         {DEVICE_SWI(0x413c, 0x81a9)},   /* Dell Wireless 5808e Gobi(TM) 4G LTE Mobile Broadband Card */
 161
 162         /* Huawei devices */
 163         {DEVICE_HWI(0x03f0, 0x581d)},   /* HP lt4112 LTE/HSPA+ Gobi 4G Modem (Huawei me906e) */
 164
 165         { }                             /* Terminating entry */
 166 };
 167 MODULE_DEVICE_TABLE(usb, id_table);
 168
 169 static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
 170 {
 171         struct usb_host_interface *intf = serial->interface->cur_altsetting;
 172         struct device *dev = &serial->dev->dev;
 173         int retval = -ENODEV;
 174         __u8 nintf;
 175         __u8 ifnum;
 176         int altsetting = -1;
 177
 178         nintf = serial->dev->actconfig->desc.bNumInterfaces;
 179         dev_dbg(dev, "Num Interfaces = %d\n", nintf);
 180         ifnum = intf->desc.bInterfaceNumber;
 181         dev_dbg(dev, "This Interface = %d\n", ifnum);
 182
 183         if (nintf == 1) {
 184                 /* QDL mode */
 185                 /* Gobi 2000 has a single altsetting, older ones have two */
 186                 if (serial->interface->num_altsetting == 2)
 187                         intf = &serial->interface->altsetting[1];
 188                 else if (serial->interface->num_altsetting > 2)
 189                         goto done;
 190
 191                 if (intf->desc.bNumEndpoints == 2 &&
 192                     usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
 193                     usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
 194                         dev_dbg(dev, "QDL port found\n");
 195
 196                         if (serial->interface->num_altsetting == 1)
 197                                 retval = 0; /* Success */
 198                         else
 199                                 altsetting = 1;
 200                 }
 201                 goto done;
 202
 203         }
 204
 205         /* default to enabling interface */
 206         altsetting = 0;
 207
 208         /*
 209          * Composite mode; don't bind to the QMI/net interface as that
 210          * gets handled by other drivers.
 211          */
 212
 213         switch (id->driver_info) {
 214         case QCSERIAL_G1K:
 215                 /*
 216                  * Gobi 1K USB layout:
 217                  * 0: DM/DIAG (use libqcdm from ModemManager for communication)
 218                  * 1: serial port (doesn't respond)
 219                  * 2: AT-capable modem port
 220                  * 3: QMI/net
 221                  */
 222                 if (nintf < 3 || nintf > 4) {
 223                         dev_err(dev, "unknown number of interfaces: %d\n", nintf);
 224                         altsetting = -1;
 225                         goto done;
 226                 }
 227
 228                 if (ifnum == 0) {
 229                         dev_dbg(dev, "Gobi 1K DM/DIAG interface found\n");
 230                         altsetting = 1;
 231                 } else if (ifnum == 2)
 232                         dev_dbg(dev, "Modem port found\n");
 233                 else
 234                         altsetting = -1;
 235                 break;
 236         case QCSERIAL_G2K:
 237                 /*
 238                  * Gobi 2K+ USB layout:
 239                  * 0: QMI/net
 240                  * 1: DM/DIAG (use libqcdm from ModemManager for communication)
 241                  * 2: AT-capable modem port
 242                  * 3: NMEA
 243                  */
 244                 if (nintf < 3 || nintf > 4) {
 245                         dev_err(dev, "unknown number of interfaces: %d\n", nintf);
 246                         altsetting = -1;
 247                         goto done;
 248                 }
 249
 250                 switch (ifnum) {
 251                 case 0:
 252                         /* Don't claim the QMI/net interface */
 253                         altsetting = -1;
 254                         break;
 255                 case 1:
 256                         dev_dbg(dev, "Gobi 2K+ DM/DIAG interface found\n");
 257                         break;
 258                 case 2:
 259                         dev_dbg(dev, "Modem port found\n");
 260                         break;
 261                 case 3:
 262                         /*
 263                          * NMEA (serial line 9600 8N1)
 264                          * # echo "\$GPS_START" > /dev/ttyUSBx
 265                          * # echo "\$GPS_STOP"  > /dev/ttyUSBx
 266                          */
 267                         dev_dbg(dev, "Gobi 2K+ NMEA GPS interface found\n");
 268                         break;
 269                 }
 270                 break;
 271         case QCSERIAL_SWI:
 272                 /*
 273                  * Sierra Wireless layout:
 274                  * 0: DM/DIAG (use libqcdm from ModemManager for communication)
 275                  * 2: NMEA
 276                  * 3: AT-capable modem port
 277                  * 8: QMI/net
 278                  */
 279                 switch (ifnum) {
 280                 case 0:
 281                         dev_dbg(dev, "DM/DIAG interface found\n");
 282                         break;
 283                 case 2:
 284                         dev_dbg(dev, "NMEA GPS interface found\n");
 285                         break;
 286                 case 3:
 287                         dev_dbg(dev, "Modem port found\n");
 288                         break;
 289                 default:
 290                         /* don't claim any unsupported interface */
 291                         altsetting = -1;
 292                         break;
 293                 }
 294                 break;
 295         case QCSERIAL_HWI:
 296                 /*
 297                  * Huawei layout:
 298                  * 0: AT-capable modem port
 299                  * 1: DM/DIAG
 300                  * 2: AT-capable modem port
 301                  * 3: CCID-compatible PCSC interface
 302                  * 4: QMI/net
 303                  * 5: NMEA
 304                  */
 305                 switch (ifnum) {
 306                 case 0:
 307                 case 2:
 308                         dev_dbg(dev, "Modem port found\n");
 309                         break;
 310                 case 1:
 311                         dev_dbg(dev, "DM/DIAG interface found\n");
 312                         break;
 313                 case 5:
 314                         dev_dbg(dev, "NMEA GPS interface found\n");
 315                         break;
 316                 default:
 317                         /* don't claim any unsupported interface */
 318                         altsetting = -1;
 319                         break;
 320                 }
 321                 break;
 322         default:
 323                 dev_err(dev, "unsupported device layout type: %lu\n",
 324                         id->driver_info);
 325                 break;
 326         }
 327
 328 done:
 329         if (altsetting >= 0) {
 330                 retval = usb_set_interface(serial->dev, ifnum, altsetting);
 331                 if (retval < 0) {
 332                         dev_err(dev,
 333                                 "Could not set interface, error %d\n",
 334                                 retval);
 335                         retval = -ENODEV;
 336                 }
 337         }
 338
 339         return retval;
 340 }
 341
 342 static int qc_attach(struct usb_serial *serial)
 343 {
 344         struct usb_wwan_intf_private *data;
 345
 346         data = kzalloc(sizeof(*data), GFP_KERNEL);
 347         if (!data)
 348                 return -ENOMEM;
 349
 350         spin_lock_init(&data->susp_lock);
 351
 352         usb_set_serial_data(serial, data);
 353
 354         return 0;
 355 }
 356
 357 static void qc_release(struct usb_serial *serial)
 358 {
 359         struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
 360
 361         usb_set_serial_data(serial, NULL);
 362         kfree(priv);
 363 }
 364
 365 static struct usb_serial_driver qcdevice = {
 366         .driver = {
 367                 .owner     = THIS_MODULE,
 368                 .name      = "qcserial",
 369         },
 370         .description         = "Qualcomm USB modem",
 371         .id_table            = id_table,
 372         .num_ports           = 1,
 373         .probe               = qcprobe,
 374         .open                = usb_wwan_open,
 375         .close               = usb_wwan_close,
 376         .write               = usb_wwan_write,
 377         .write_room          = usb_wwan_write_room,
 378         .chars_in_buffer     = usb_wwan_chars_in_buffer,
 379         .attach              = qc_attach,
 380         .release             = qc_release,
 381         .port_probe          = usb_wwan_port_probe,
 382         .port_remove         = usb_wwan_port_remove,
 383 #ifdef CONFIG_PM
 384         .suspend             = usb_wwan_suspend,
 385         .resume              = usb_wwan_resume,
 386 #endif
 387 };
 388
 389 static struct usb_serial_driver * const serial_drivers[] = {
 390         &qcdevice, NULL
 391 };
 392
 393 module_usb_serial_driver(serial_drivers, id_table);
 394
 395 MODULE_AUTHOR(DRIVER_AUTHOR);
 396 MODULE_DESCRIPTION(DRIVER_DESC);
 397 MODULE_LICENSE("GPL v2");