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 static const struct usb_device_id id_table[] = {
  28         {USB_DEVICE(0x05c6, 0x9211)},   /* Acer Gobi QDL device */
  29         {USB_DEVICE(0x05c6, 0x9212)},   /* Acer Gobi Modem Device */
  30         {USB_DEVICE(0x03f0, 0x1f1d)},   /* HP un2400 Gobi Modem Device */
  31         {USB_DEVICE(0x03f0, 0x201d)},   /* HP un2400 Gobi QDL Device */
  32         {USB_DEVICE(0x03f0, 0x371d)},   /* HP un2430 Mobile Broadband Module */
  33         {USB_DEVICE(0x04da, 0x250d)},   /* Panasonic Gobi Modem device */
  34         {USB_DEVICE(0x04da, 0x250c)},   /* Panasonic Gobi QDL device */
  35         {USB_DEVICE(0x413c, 0x8172)},   /* Dell Gobi Modem device */
  36         {USB_DEVICE(0x413c, 0x8171)},   /* Dell Gobi QDL device */
  37         {USB_DEVICE(0x1410, 0xa001)},   /* Novatel Gobi Modem device */
  38         {USB_DEVICE(0x1410, 0xa008)},   /* Novatel Gobi QDL device */
  39         {USB_DEVICE(0x1410, 0xa010)},   /* Novatel Gobi QDL device */
  40         {USB_DEVICE(0x1410, 0xa011)},   /* Novatel Gobi QDL device */
  41         {USB_DEVICE(0x1410, 0xa012)},   /* Novatel Gobi QDL device */
  42         {USB_DEVICE(0x1410, 0xa013)},   /* Novatel Gobi QDL device */
  43         {USB_DEVICE(0x1410, 0xa014)},   /* Novatel Gobi QDL device */
  44         {USB_DEVICE(0x0b05, 0x1776)},   /* Asus Gobi Modem device */
  45         {USB_DEVICE(0x0b05, 0x1774)},   /* Asus Gobi QDL device */
  46         {USB_DEVICE(0x19d2, 0xfff3)},   /* ONDA Gobi Modem device */
  47         {USB_DEVICE(0x19d2, 0xfff2)},   /* ONDA Gobi QDL device */
  48         {USB_DEVICE(0x1557, 0x0a80)},   /* OQO Gobi QDL device */
  49         {USB_DEVICE(0x05c6, 0x9001)},   /* Generic Gobi Modem device */
  50         {USB_DEVICE(0x05c6, 0x9002)},   /* Generic Gobi Modem device */
  51         {USB_DEVICE(0x05c6, 0x9202)},   /* Generic Gobi Modem device */
  52         {USB_DEVICE(0x05c6, 0x9203)},   /* Generic Gobi Modem device */
  53         {USB_DEVICE(0x05c6, 0x9222)},   /* Generic Gobi Modem device */
  54         {USB_DEVICE(0x05c6, 0x9008)},   /* Generic Gobi QDL device */
  55         {USB_DEVICE(0x05c6, 0x9009)},   /* Generic Gobi Modem device */
  56         {USB_DEVICE(0x05c6, 0x9201)},   /* Generic Gobi QDL device */
  57         {USB_DEVICE(0x05c6, 0x9221)},   /* Generic Gobi QDL device */
  58         {USB_DEVICE(0x05c6, 0x9231)},   /* Generic Gobi QDL device */
  59         {USB_DEVICE(0x1f45, 0x0001)},   /* Unknown Gobi QDL device */
  60         {USB_DEVICE(0x413c, 0x8185)},   /* Dell Gobi 2000 QDL device (N0218, VU936) */
  61         {USB_DEVICE(0x413c, 0x8186)},   /* Dell Gobi 2000 Modem device (N0218, VU936) */
  62         {USB_DEVICE(0x05c6, 0x9208)},   /* Generic Gobi 2000 QDL device */
  63         {USB_DEVICE(0x05c6, 0x920b)},   /* Generic Gobi 2000 Modem device */
  64         {USB_DEVICE(0x05c6, 0x9224)},   /* Sony Gobi 2000 QDL device (N0279, VU730) */
  65         {USB_DEVICE(0x05c6, 0x9225)},   /* Sony Gobi 2000 Modem device (N0279, VU730) */
  66         {USB_DEVICE(0x05c6, 0x9244)},   /* Samsung Gobi 2000 QDL device (VL176) */
  67         {USB_DEVICE(0x05c6, 0x9245)},   /* Samsung Gobi 2000 Modem device (VL176) */
  68         {USB_DEVICE(0x03f0, 0x241d)},   /* HP Gobi 2000 QDL device (VP412) */
  69         {USB_DEVICE(0x03f0, 0x251d)},   /* HP Gobi 2000 Modem device (VP412) */
  70         {USB_DEVICE(0x05c6, 0x9214)},   /* Acer Gobi 2000 QDL device (VP413) */
  71         {USB_DEVICE(0x05c6, 0x9215)},   /* Acer Gobi 2000 Modem device (VP413) */
  72         {USB_DEVICE(0x05c6, 0x9264)},   /* Asus Gobi 2000 QDL device (VR305) */
  73         {USB_DEVICE(0x05c6, 0x9265)},   /* Asus Gobi 2000 Modem device (VR305) */
  74         {USB_DEVICE(0x05c6, 0x9234)},   /* Top Global Gobi 2000 QDL device (VR306) */
  75         {USB_DEVICE(0x05c6, 0x9235)},   /* Top Global Gobi 2000 Modem device (VR306) */
  76         {USB_DEVICE(0x05c6, 0x9274)},   /* iRex Technologies Gobi 2000 QDL device (VR307) */
  77         {USB_DEVICE(0x05c6, 0x9275)},   /* iRex Technologies Gobi 2000 Modem device (VR307) */
  78         {USB_DEVICE(0x1199, 0x9000)},   /* Sierra Wireless Gobi 2000 QDL device (VT773) */
  79         {USB_DEVICE(0x1199, 0x9001)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  80         {USB_DEVICE(0x1199, 0x9002)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  81         {USB_DEVICE(0x1199, 0x9003)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  82         {USB_DEVICE(0x1199, 0x9004)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  83         {USB_DEVICE(0x1199, 0x9005)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  84         {USB_DEVICE(0x1199, 0x9006)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  85         {USB_DEVICE(0x1199, 0x9007)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  86         {USB_DEVICE(0x1199, 0x9008)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  87         {USB_DEVICE(0x1199, 0x9009)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  88         {USB_DEVICE(0x1199, 0x900a)},   /* Sierra Wireless Gobi 2000 Modem device (VT773) */
  89         {USB_DEVICE(0x1199, 0x9011)},   /* Sierra Wireless Gobi 2000 Modem device (MC8305) */
  90         {USB_DEVICE(0x16d8, 0x8001)},   /* CMDTech Gobi 2000 QDL device (VU922) */
  91         {USB_DEVICE(0x16d8, 0x8002)},   /* CMDTech Gobi 2000 Modem device (VU922) */
  92         {USB_DEVICE(0x05c6, 0x9204)},   /* Gobi 2000 QDL device */
  93         {USB_DEVICE(0x05c6, 0x9205)},   /* Gobi 2000 Modem device */
  94
  95         {USB_DEVICE(0x05c6, 0x920c)},   /* Gobi 3000 QDL */
  96         {USB_DEVICE(0x05c6, 0x920d)},   /* Gobi 3000 Composite */
  97         {USB_DEVICE(0x1410, 0xa020)},   /* Novatel Gobi 3000 QDL */
  98         {USB_DEVICE(0x1410, 0xa021)},   /* Novatel Gobi 3000 Composite */
  99         {USB_DEVICE(0x413c, 0x8193)},   /* Dell Gobi 3000 QDL */
 100         {USB_DEVICE(0x413c, 0x8194)},   /* Dell Gobi 3000 Composite */
 101         {USB_DEVICE(0x1199, 0x9013)},   /* Sierra Wireless Gobi 3000 Modem device (MC8355) */
 102         {USB_DEVICE(0x12D1, 0x14F0)},   /* Sony Gobi 3000 QDL */
 103         {USB_DEVICE(0x12D1, 0x14F1)},   /* Sony Gobi 3000 Composite */
 104         { }                             /* Terminating entry */
 105 };
 106 MODULE_DEVICE_TABLE(usb, id_table);
 107
 108 static struct usb_driver qcdriver = {
 109         .name                   = "qcserial",
 110         .probe                  = usb_serial_probe,
 111         .disconnect             = usb_serial_disconnect,
 112         .id_table               = id_table,
 113         .suspend                = usb_serial_suspend,
 114         .resume                 = usb_serial_resume,
 115         .supports_autosuspend   = true,
 116 };
 117
 118 static int qcprobe(struct usb_serial *serial, const struct usb_device_id *id)
 119 {
 120         struct usb_wwan_intf_private *data;
 121         struct usb_host_interface *intf = serial->interface->cur_altsetting;
 122         int retval = -ENODEV;
 123         __u8 nintf;
 124         __u8 ifnum;
 125
 126         dbg("%s", __func__);
 127
 128         nintf = serial->dev->actconfig->desc.bNumInterfaces;
 129         dbg("Num Interfaces = %d", nintf);
 130         ifnum = intf->desc.bInterfaceNumber;
 131         dbg("This Interface = %d", ifnum);
 132
 133         data = kzalloc(sizeof(struct usb_wwan_intf_private),
 134                                          GFP_KERNEL);
 135         if (!data)
 136                 return -ENOMEM;
 137
 138         spin_lock_init(&data->susp_lock);
 139
 140         usb_enable_autosuspend(serial->dev);
 141
 142         switch (nintf) {
 143         case 1:
 144                 /* QDL mode */
 145                 /* Gobi 2000 has a single altsetting, older ones have two */
 146                 if (serial->interface->num_altsetting == 2)
 147                         intf = &serial->interface->altsetting[1];
 148                 else if (serial->interface->num_altsetting > 2)
 149                         break;
 150
 151                 if (intf->desc.bNumEndpoints == 2 &&
 152                     usb_endpoint_is_bulk_in(&intf->endpoint[0].desc) &&
 153                     usb_endpoint_is_bulk_out(&intf->endpoint[1].desc)) {
 154                         dbg("QDL port found");
 155
 156                         if (serial->interface->num_altsetting == 1) {
 157                                 retval = 0; /* Success */
 158                                 break;
 159                         }
 160
 161                         retval = usb_set_interface(serial->dev, ifnum, 1);
 162                         if (retval < 0) {
 163                                 dev_err(&serial->dev->dev,
 164                                         "Could not set interface, error %d\n",
 165                                         retval);
 166                                 retval = -ENODEV;
 167                                 kfree(data);
 168                         }
 169                 }
 170                 break;
 171
 172         case 3:
 173         case 4:
 174                 /* Composite mode */
 175                 /* ifnum == 0 is a broadband network adapter */
 176                 if (ifnum == 1) {
 177                         /*
 178                          * Diagnostics Monitor (serial line 9600 8N1)
 179                          * Qualcomm DM protocol
 180                          * use "libqcdm" (ModemManager) for communication
 181                          */
 182                         dbg("Diagnostics Monitor found");
 183                         retval = usb_set_interface(serial->dev, ifnum, 0);
 184                         if (retval < 0) {
 185                                 dev_err(&serial->dev->dev,
 186                                         "Could not set interface, error %d\n",
 187                                         retval);
 188                                 retval = -ENODEV;
 189                                 kfree(data);
 190                         }
 191                 } else if (ifnum == 2) {
 192                         dbg("Modem port found");
 193                         retval = usb_set_interface(serial->dev, ifnum, 0);
 194                         if (retval < 0) {
 195                                 dev_err(&serial->dev->dev,
 196                                         "Could not set interface, error %d\n",
 197                                         retval);
 198                                 retval = -ENODEV;
 199                                 kfree(data);
 200                         }
 201                 } else if (ifnum==3) {
 202                         /*
 203                          * NMEA (serial line 9600 8N1)
 204                          * # echo "\$GPS_START" > /dev/ttyUSBx
 205                          * # echo "\$GPS_STOP"  > /dev/ttyUSBx
 206                          */
 207                         dbg("NMEA GPS interface found");
 208                         retval = usb_set_interface(serial->dev, ifnum, 0);
 209                         if (retval < 0) {
 210                                 dev_err(&serial->dev->dev,
 211                                         "Could not set interface, error %d\n",
 212                                         retval);
 213                                 retval = -ENODEV;
 214                                 kfree(data);
 215                         }
 216                 }
 217                 break;
 218
 219         default:
 220                 dev_err(&serial->dev->dev,
 221                         "unknown number of interfaces: %d\n", nintf);
 222                 kfree(data);
 223                 retval = -ENODEV;
 224         }
 225
 226         /* Set serial->private if not returning -ENODEV */
 227         if (retval != -ENODEV)
 228                 usb_set_serial_data(serial, data);
 229         return retval;
 230 }
 231
 232 static void qc_release(struct usb_serial *serial)
 233 {
 234         struct usb_wwan_intf_private *priv = usb_get_serial_data(serial);
 235
 236         dbg("%s", __func__);
 237
 238         /* Call usb_wwan release & free the private data allocated in qcprobe */
 239         usb_wwan_release(serial);
 240         usb_set_serial_data(serial, NULL);
 241         kfree(priv);
 242 }
 243
 244 static struct usb_serial_driver qcdevice = {
 245         .driver = {
 246                 .owner     = THIS_MODULE,
 247                 .name      = "qcserial",
 248         },
 249         .description         = "Qualcomm USB modem",
 250         .id_table            = id_table,
 251         .usb_driver          = &qcdriver,
 252         .num_ports           = 1,
 253         .probe               = qcprobe,
 254         .open                = usb_wwan_open,
 255         .close               = usb_wwan_close,
 256         .write               = usb_wwan_write,
 257         .write_room          = usb_wwan_write_room,
 258         .chars_in_buffer     = usb_wwan_chars_in_buffer,
 259         .attach              = usb_wwan_startup,
 260         .disconnect          = usb_wwan_disconnect,
 261         .release             = qc_release,
 262 #ifdef CONFIG_PM
 263         .suspend             = usb_wwan_suspend,
 264         .resume              = usb_wwan_resume,
 265 #endif
 266 };
 267
 268 static int __init qcinit(void)
 269 {
 270         int retval;
 271
 272         retval = usb_serial_register(&qcdevice);
 273         if (retval)
 274                 return retval;
 275
 276         retval = usb_register(&qcdriver);
 277         if (retval) {
 278                 usb_serial_deregister(&qcdevice);
 279                 return retval;
 280         }
 281
 282         return 0;
 283 }
 284
 285 static void __exit qcexit(void)
 286 {
 287         usb_deregister(&qcdriver);
 288         usb_serial_deregister(&qcdevice);
 289 }
 290
 291 module_init(qcinit);
 292 module_exit(qcexit);
 293
 294 MODULE_AUTHOR(DRIVER_AUTHOR);
 295 MODULE_DESCRIPTION(DRIVER_DESC);
 296 MODULE_LICENSE("GPL v2");
 297
 298 module_param(debug, bool, S_IRUGO | S_IWUSR);
 299 MODULE_PARM_DESC(debug, "Debug enabled or not");