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