drivers/usb/serial/ipw.c

   1 /*
   2  * IPWireless 3G UMTS TDD Modem driver (USB connected)
   3  *
   4  *   Copyright (C) 2004 Roelf Diedericks <roelfd@inet.co.za>
   5  *   Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   6  *
   7  *   This program is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License as published by
   9  *   the Free Software Foundation; either version 2 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  * All information about the device was acquired using SnoopyPro
  13  * on MSFT's O/S, and examing the MSFT drivers' debug output
  14  * (insanely left _on_ in the enduser version)
  15  *
  16  * It was written out of frustration with the IPWireless USB modem
  17  * supplied by Axity3G/Sentech South Africa not supporting
  18  * Linux whatsoever.
  19  *
  20  * Nobody provided any proprietary information that was not already
  21  * available for this device.
  22  *
  23  * The modem adheres to the "3GPP TS  27.007 AT command set for 3G
  24  * User Equipment (UE)" standard, available from
  25  * http://www.3gpp.org/ftp/Specs/html-info/27007.htm
  26  *
  27  * The code was only tested the IPWireless handheld modem distributed
  28  * in South Africa by Sentech.
  29  *
  30  * It may work for Woosh Inc in .nz too, as it appears they use the
  31  * same kit.
  32  *
  33  * There is still some work to be done in terms of handling
  34  * DCD, DTR, RTS, CTS which are currently faked.
  35  * It's good enough for PPP at this point. It's based off all kinds of
  36  * code found in usb/serial and usb/class
  37  */
  38
  39 #include <linux/kernel.h>
  40 #include <linux/errno.h>
  41 #include <linux/init.h>
  42 #include <linux/slab.h>
  43 #include <linux/tty.h>
  44 #include <linux/tty_flip.h>
  45 #include <linux/module.h>
  46 #include <linux/spinlock.h>
  47 #include <linux/usb.h>
  48 #include <linux/usb/serial.h>
  49 #include <linux/uaccess.h>
  50 #include "usb-wwan.h"
  51
  52 /*
  53  * Version Information
  54  */
  55 #define DRIVER_VERSION  "v0.4"
  56 #define DRIVER_AUTHOR   "Roelf Diedericks"
  57 #define DRIVER_DESC     "IPWireless tty driver"
  58
  59 #define IPW_TTY_MAJOR   240     /* real device node major id, experimental range */
  60 #define IPW_TTY_MINORS  256     /* we support 256 devices, dunno why, it'd be insane :) */
  61
  62 #define USB_IPW_MAGIC   0x6d02  /* magic number for ipw struct */
  63
  64
  65 /* Message sizes */
  66 #define EVENT_BUFFER_SIZE       0xFF
  67 #define CHAR2INT16(c1, c0)      (((u32)((c1) & 0xff) << 8) + (u32)((c0) & 0xff))
  68
  69 /* vendor/product pairs that are known work with this driver*/
  70 #define IPW_VID         0x0bc3
  71 #define IPW_PID         0x0001
  72
  73
  74 /* Vendor commands: */
  75
  76 /* baud rates */
  77 enum {
  78         ipw_sio_b256000 = 0x000e,
  79         ipw_sio_b128000 = 0x001d,
  80         ipw_sio_b115200 = 0x0020,
  81         ipw_sio_b57600  = 0x0040,
  82         ipw_sio_b56000  = 0x0042,
  83         ipw_sio_b38400  = 0x0060,
  84         ipw_sio_b19200  = 0x00c0,
  85         ipw_sio_b14400  = 0x0100,
  86         ipw_sio_b9600   = 0x0180,
  87         ipw_sio_b4800   = 0x0300,
  88         ipw_sio_b2400   = 0x0600,
  89         ipw_sio_b1200   = 0x0c00,
  90         ipw_sio_b600    = 0x1800
  91 };
  92
  93 /* data bits */
  94 #define ipw_dtb_7               0x700
  95 #define ipw_dtb_8               0x810   /* ok so the define is misleading, I know, but forces 8,n,1 */
  96                                         /* I mean, is there a point to any other setting these days? :) */
  97
  98 /* usb control request types : */
  99 #define IPW_SIO_RXCTL           0x00    /* control bulk rx channel transmissions, value=1/0 (on/off) */
 100 #define IPW_SIO_SET_BAUD        0x01    /* set baud, value=requested ipw_sio_bxxxx */
 101 #define IPW_SIO_SET_LINE        0x03    /* set databits, parity. value=ipw_dtb_x */
 102 #define IPW_SIO_SET_PIN         0x03    /* set/clear dtr/rts value=ipw_pin_xxx */
 103 #define IPW_SIO_POLL            0x08    /* get serial port status byte, call with value=0 */
 104 #define IPW_SIO_INIT            0x11    /* initializes ? value=0 (appears as first thing todo on open) */
 105 #define IPW_SIO_PURGE           0x12    /* purge all transmissions?, call with value=numchar_to_purge */
 106 #define IPW_SIO_HANDFLOW        0x13    /* set xon/xoff limits value=0, and a buffer of 0x10 bytes */
 107 #define IPW_SIO_SETCHARS        0x13    /* set the flowcontrol special chars, value=0, buf=6 bytes, */
 108                                         /* last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13 */
 109
 110 /* values used for request IPW_SIO_SET_PIN */
 111 #define IPW_PIN_SETDTR          0x101
 112 #define IPW_PIN_SETRTS          0x202
 113 #define IPW_PIN_CLRDTR          0x100
 114 #define IPW_PIN_CLRRTS          0x200 /* unconfirmed */
 115
 116 /* values used for request IPW_SIO_RXCTL */
 117 #define IPW_RXBULK_ON           1
 118 #define IPW_RXBULK_OFF          0
 119
 120 /* various 16 byte hardcoded transferbuffers used by flow control */
 121 #define IPW_BYTES_FLOWINIT      { 0x01, 0, 0, 0, 0x40, 0, 0, 0, \
 122                                         0, 0, 0, 0, 0, 0, 0, 0 }
 123
 124 /* Interpretation of modem status lines */
 125 /* These need sorting out by individually connecting pins and checking
 126  * results. FIXME!
 127  * When data is being sent we see 0x30 in the lower byte; this must
 128  * contain DSR and CTS ...
 129  */
 130 #define IPW_DSR                 ((1<<4) | (1<<5))
 131 #define IPW_CTS                 ((1<<5) | (1<<4))
 132
 133 #define IPW_WANTS_TO_SEND       0x30
 134
 135 static const struct usb_device_id id_table[] = {
 136         { USB_DEVICE(IPW_VID, IPW_PID) },
 137         { },
 138 };
 139 MODULE_DEVICE_TABLE(usb, id_table);
 140
 141 static bool debug;
 142
 143 static int ipw_open(struct tty_struct *tty, struct usb_serial_port *port)
 144 {
 145         struct usb_device *dev = port->serial->dev;
 146         u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
 147         u8 *buf_flow_init;
 148         int result;
 149
 150         buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL);
 151         if (!buf_flow_init)
 152                 return -ENOMEM;
 153
 154         /* --1: Tell the modem to initialize (we think) From sniffs this is
 155          *      always the first thing that gets sent to the modem during
 156          *      opening of the device */
 157         dbg("%s: Sending SIO_INIT (we guess)", __func__);
 158         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 159                          IPW_SIO_INIT,
 160                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 161                          0,
 162                          0, /* index */
 163                          NULL,
 164                          0,
 165                          100000);
 166         if (result < 0)
 167                 dev_err(&port->dev,
 168                         "Init of modem failed (error = %d)\n", result);
 169
 170         /* reset the bulk pipes */
 171         usb_clear_halt(dev,
 172                         usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress));
 173         usb_clear_halt(dev,
 174                         usb_sndbulkpipe(dev, port->bulk_out_endpointAddress));
 175
 176         /*--2: Start reading from the device */
 177         dbg("%s: setting up bulk read callback", __func__);
 178         usb_wwan_open(tty, port);
 179
 180         /*--3: Tell the modem to open the floodgates on the rx bulk channel */
 181         dbg("%s:asking modem for RxRead (RXBULK_ON)", __func__);
 182         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 183                          IPW_SIO_RXCTL,
 184                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 185                          IPW_RXBULK_ON,
 186                          0, /* index */
 187                          NULL,
 188                          0,
 189                          100000);
 190         if (result < 0)
 191                 dev_err(&port->dev,
 192                         "Enabling bulk RxRead failed (error = %d)\n", result);
 193
 194         /*--4: setup the initial flowcontrol */
 195         dbg("%s:setting init flowcontrol (%s)", __func__, buf_flow_init);
 196         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 197                          IPW_SIO_HANDFLOW,
 198                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 199                          0,
 200                          0,
 201                          buf_flow_init,
 202                          0x10,
 203                          200000);
 204         if (result < 0)
 205                 dev_err(&port->dev,
 206                         "initial flowcontrol failed (error = %d)\n", result);
 207
 208         kfree(buf_flow_init);
 209         return 0;
 210 }
 211
 212 /* fake probe - only to allocate data structures */
 213 static int ipw_probe(struct usb_serial *serial, const struct usb_device_id *id)
 214 {
 215         struct usb_wwan_intf_private *data;
 216
 217         data = kzalloc(sizeof(struct usb_wwan_intf_private), GFP_KERNEL);
 218         if (!data)
 219                 return -ENOMEM;
 220
 221         spin_lock_init(&data->susp_lock);
 222         usb_set_serial_data(serial, data);
 223         return 0;
 224 }
 225
 226 static void ipw_release(struct usb_serial *serial)
 227 {
 228         struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
 229
 230         usb_set_serial_data(serial, NULL);
 231         kfree(data);
 232 }
 233
 234 static void ipw_dtr_rts(struct usb_serial_port *port, int on)
 235 {
 236         struct usb_device *dev = port->serial->dev;
 237         int result;
 238
 239         dbg("%s: on = %d", __func__, on);
 240
 241         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 242                          IPW_SIO_SET_PIN,
 243                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 244                          on ? IPW_PIN_SETDTR : IPW_PIN_CLRDTR,
 245                          0,
 246                          NULL,
 247                          0,
 248                          200000);
 249         if (result < 0)
 250                 dev_err(&port->dev, "setting dtr failed (error = %d)\n",
 251                                                                 result);
 252
 253         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 254                          IPW_SIO_SET_PIN, USB_TYPE_VENDOR |
 255                                         USB_RECIP_INTERFACE | USB_DIR_OUT,
 256                          on ? IPW_PIN_SETRTS : IPW_PIN_CLRRTS,
 257                          0,
 258                          NULL,
 259                          0,
 260                          200000);
 261         if (result < 0)
 262                 dev_err(&port->dev, "setting rts failed (error = %d)\n",
 263                                                                 result);
 264 }
 265
 266 static void ipw_close(struct usb_serial_port *port)
 267 {
 268         struct usb_device *dev = port->serial->dev;
 269         int result;
 270
 271         /*--3: purge */
 272         dbg("%s:sending purge", __func__);
 273         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 274                          IPW_SIO_PURGE, USB_TYPE_VENDOR |
 275                                         USB_RECIP_INTERFACE | USB_DIR_OUT,
 276                          0x03,
 277                          0,
 278                          NULL,
 279                          0,
 280                          200000);
 281         if (result < 0)
 282                 dev_err(&port->dev, "purge failed (error = %d)\n", result);
 283
 284
 285         /* send RXBULK_off (tell modem to stop transmitting bulk data on
 286            rx chan) */
 287         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 288                          IPW_SIO_RXCTL,
 289                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 290                          IPW_RXBULK_OFF,
 291                          0, /* index */
 292                          NULL,
 293                          0,
 294                          100000);
 295
 296         if (result < 0)
 297                 dev_err(&port->dev,
 298                         "Disabling bulk RxRead failed (error = %d)\n", result);
 299
 300         usb_wwan_close(port);
 301 }
 302
 303 static struct usb_serial_driver ipw_device = {
 304         .driver = {
 305                 .owner =        THIS_MODULE,
 306                 .name =         "ipw",
 307         },
 308         .description =          "IPWireless converter",
 309         .id_table =             id_table,
 310         .num_ports =            1,
 311         .open =                 ipw_open,
 312         .close =                ipw_close,
 313         .probe =                ipw_probe,
 314         .attach =               usb_wwan_startup,
 315         .release =              ipw_release,
 316         .port_remove =          usb_wwan_port_remove,
 317         .dtr_rts =              ipw_dtr_rts,
 318         .write =                usb_wwan_write,
 319 };
 320
 321 static struct usb_serial_driver * const serial_drivers[] = {
 322         &ipw_device, NULL
 323 };
 324
 325 module_usb_serial_driver(serial_drivers, id_table);
 326
 327 /* Module information */
 328 MODULE_AUTHOR(DRIVER_AUTHOR);
 329 MODULE_DESCRIPTION(DRIVER_DESC);
 330 MODULE_LICENSE("GPL");
 331
 332 module_param(debug, bool, S_IRUGO | S_IWUSR);
 333 MODULE_PARM_DESC(debug, "Debug enabled or not");