LXR linux/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 */
  26enum 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
  40static 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(0x03f0, 0x4e1d)},   /* HP lt4111 LTE/EV-DO/HSPA+ Gobi 4G Module */
 143        {DEVICE_SWI(0x0f3d, 0x68a2)},   /* Sierra Wireless MC7700 */
 144        {DEVICE_SWI(0x114f, 0x68a2)},   /* Sierra Wireless MC7750 */
 145        {DEVICE_SWI(0x1199, 0x68a2)},   /* Sierra Wireless MC7710 */
 146        {DEVICE_SWI(0x1199, 0x901c)},   /* Sierra Wireless EM7700 */
 147        {DEVICE_SWI(0x1199, 0x901f)},   /* Sierra Wireless EM7355 */
 148        {DEVICE_SWI(0x1199, 0x9040)},   /* Sierra Wireless Modem */
 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        {DEVICE_SWI(0x413c, 0x81b1)},   /* Dell Wireless 5809e Gobi(TM) 4G LTE Mobile Broadband Card */
 162
 163        /* Huawei devices */
 164        {DEVICE_HWI(0x03f0, 0x581d)},   /* HP lt4112 LTE/HSPA+ Gobi 4G Modem (Huawei me906e) */
 165
 166        { }                             /* Terminating entry */
 167};
 168MODULE_DEVICE_TABLE(usb, id_table);
 169
 170static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
 171{
 172        struct usb_host_interface *intf = serial->interface->cur_altsetting;
 173        struct device *dev = &serial->dev->dev;
 174        int retval = -ENODEV;
 175        __u8 nintf;
 176        __u8 ifnum;
 177        int altsetting = -1;
 178
 179        nintf = serial->dev->actconfig->desc.bNumInterfaces;
 180        dev_dbg(dev, "Num Interfaces = %d\n", nintf);
 181        ifnum = intf->desc.bInterfaceNumber;
 182        dev_dbg(dev, "This Interface = %d\n", ifnum);
 183
 184        if (nintf == 1) {
 185                /* QDL mode */
 186                /* Gobi 2000 has a single altsetting, older ones have two */
 187                if (serial->interface->num_altsetting == 2)
 188                        intf = &serial->interface->altsetting[1];
 189                else if (serial->interface->num_altsetting > 2)
 190                        goto done;
 191
 192                if (intf->desc.bNumEndpoints == 2 &&
 193                    usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
 194                    usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
 195                        dev_dbg(dev, "QDL port found\n");
 196
 197                        if (serial->interface->num_altsetting == 1)
 198                                retval = 0; /* Success */
 199                        else
 200                                altsetting = 1;
 201                }
 202                goto done;
 203
 204        }
 205
 206        /* default to enabling interface */
 207        altsetting = 0;
 208
 209        /*
 210         * Composite mode; don't bind to the QMI/net interface as that
 211         * gets handled by other drivers.
 212         */
 213
 214        switch (id->driver_info) {
 215        case QCSERIAL_G1K:
 216                /*
 217                 * Gobi 1K USB layout:
 218                 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
 219                 * 1: serial port (doesn't respond)
 220                 * 2: AT-capable modem port
 221                 * 3: QMI/net
 222                 */
 223                if (nintf < 3 || nintf > 4) {
 224                        dev_err(dev, "unknown number of interfaces: %d\n", nintf);
 225                        altsetting = -1;
 226                        goto done;
 227                }
 228
 229                if (ifnum == 0) {
 230                        dev_dbg(dev, "Gobi 1K DM/DIAG interface found\n");
 231                        altsetting = 1;
 232                } else if (ifnum == 2)
 233                        dev_dbg(dev, "Modem port found\n");
 234                else
 235                        altsetting = -1;
 236                break;
 237        case QCSERIAL_G2K:
 238                /*
 239                 * Gobi 2K+ USB layout:
 240                 * 0: QMI/net
 241                 * 1: DM/DIAG (use libqcdm from ModemManager for communication)
 242                 * 2: AT-capable modem port
 243                 * 3: NMEA
 244                 */
 245                if (nintf < 3 || nintf > 4) {
 246                        dev_err(dev, "unknown number of interfaces: %d\n", nintf);
 247                        altsetting = -1;
 248                        goto done;
 249                }
 250
 251                switch (ifnum) {
 252                case 0:
 253                        /* Don't claim the QMI/net interface */
 254                        altsetting = -1;
 255                        break;
 256                case 1:
 257                        dev_dbg(dev, "Gobi 2K+ DM/DIAG interface found\n");
 258                        break;
 259                case 2:
 260                        dev_dbg(dev, "Modem port found\n");
 261                        break;
 262                case 3:
 263                        /*
 264                         * NMEA (serial line 9600 8N1)
 265                         * # echo "\$GPS_START" > /dev/ttyUSBx
 266                         * # echo "\$GPS_STOP"  > /dev/ttyUSBx
 267                         */
 268                        dev_dbg(dev, "Gobi 2K+ NMEA GPS interface found\n");
 269                        break;
 270                }
 271                break;
 272        case QCSERIAL_SWI:
 273                /*
 274                 * Sierra Wireless layout:
 275                 * 0: DM/DIAG (use libqcdm from ModemManager for communication)
 276                 * 2: NMEA
 277                 * 3: AT-capable modem port
 278                 * 8: QMI/net
 279                 */
 280                switch (ifnum) {
 281                case 0:
 282                        dev_dbg(dev, "DM/DIAG interface found\n");
 283                        break;
 284                case 2:
 285                        dev_dbg(dev, "NMEA GPS interface found\n");
 286                        break;
 287                case 3:
 288                        dev_dbg(dev, "Modem port found\n");
 289                        break;
 290                default:
 291                        /* don't claim any unsupported interface */
 292                        altsetting = -1;
 293                        break;
 294                }
 295                break;
 296        case QCSERIAL_HWI:
 297                /*
 298                 * Huawei layout:
 299                 * 0: AT-capable modem port
 300                 * 1: DM/DIAG
 301                 * 2: AT-capable modem port
 302                 * 3: CCID-compatible PCSC interface
 303                 * 4: QMI/net
 304                 * 5: NMEA
 305                 */
 306                switch (ifnum) {
 307                case 0:
 308                case 2:
 309                        dev_dbg(dev, "Modem port found\n");
 310                        break;
 311                case 1:
 312                        dev_dbg(dev, "DM/DIAG interface found\n");
 313                        break;
 314                case 5:
 315                        dev_dbg(dev, "NMEA GPS interface found\n");
 316                        break;
 317                default:
 318                        /* don't claim any unsupported interface */
 319                        altsetting = -1;
 320                        break;
 321                }
 322                break;
 323        default:
 324                dev_err(dev, "unsupported device layout type: %lu\n",
 325                        id->driver_info);
 326                break;
 327        }
 328
 329done:
 330        if (altsetting >= 0) {
 331                retval = usb_set_interface(serial->dev, ifnum, altsetting);
 332                if (retval < 0) {
 333                        dev_err(dev,
 334                                "Could not set interface, error %d\n",
 335                                retval);
 336                        retval = -ENODEV;
 337                }
 338        }
 339
 340        return retval;
 341}
 342
 343static int qc_attach(struct usb_serial *serial)
 344{
 345        struct usb_wwan_intf_private *data;
 346
 347        data = kzalloc(sizeof(*data), GFP_KERNEL);
 348        if (!data)
 349                return -ENOMEM;
 350
 351        spin_lock_init(&data->susp_lock);
 352
 353        usb_set_serial_data(serial, data);
 354
 355        return 0;
 356}
 357
 358static void qc_release(struct usb_serial *serial)
 359{
 360        struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
 361
 362        usb_set_serial_data(serial, NULL);
 363        kfree(priv);
 364}
 365
 366static struct usb_serial_driver qcdevice = {
 367        .driver = {
 368                .owner     = THIS_MODULE,
 369                .name      = "qcserial",
 370        },
 371        .description         = "Qualcomm USB modem",
 372        .id_table            = id_table,
 373        .num_ports           = 1,
 374        .probe               = qcprobe,
 375        .open                = usb_wwan_open,
 376        .close               = usb_wwan_close,
 377        .write               = usb_wwan_write,
 378        .write_room          = usb_wwan_write_room,
 379        .chars_in_buffer     = usb_wwan_chars_in_buffer,
 380        .attach              = qc_attach,
 381        .release             = qc_release,
 382        .port_probe          = usb_wwan_port_probe,
 383        .port_remove         = usb_wwan_port_remove,
 384#ifdef CONFIG_PM
 385        .suspend             = usb_wwan_suspend,
 386        .resume              = usb_wwan_resume,
 387#endif
 388};
 389
 390static struct usb_serial_driver * const serial_drivers[] = {
 391        &qcdevice, NULL
 392};
 393
 394module_usb_serial_driver(serial_drivers, id_table);
 395
 396MODULE_AUTHOR(DRIVER_AUTHOR);
 397MODULE_DESCRIPTION(DRIVER_DESC);
 398MODULE_LICENSE("GPL v2");
 399