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
  40 #include <linux/kernel.h>
  41 #include <linux/errno.h>
  42 #include <linux/init.h>
  43 #include <linux/slab.h>
  44 #include <linux/tty.h>
  45 #include <linux/tty_flip.h>
  46 #include <linux/module.h>
  47 #include <linux/spinlock.h>
  48 #include <linux/usb.h>
  49 #include <linux/usb/serial.h>
  50 #include <linux/uaccess.h>
  51
  52 /*
  53  * Version Information
  54  */
  55 #define DRIVER_VERSION  "v0.3"
  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 #define NUM_BULK_URBS           24
  69 #define NUM_CONTROL_URBS        16
  70
  71 /* vendor/product pairs that are known work with this driver*/
  72 #define IPW_VID         0x0bc3
  73 #define IPW_PID         0x0001
  74
  75
  76 /* Vendor commands: */
  77
  78 /* baud rates */
  79 enum {
  80         ipw_sio_b256000 = 0x000e,
  81         ipw_sio_b128000 = 0x001d,
  82         ipw_sio_b115200 = 0x0020,
  83         ipw_sio_b57600  = 0x0040,
  84         ipw_sio_b56000  = 0x0042,
  85         ipw_sio_b38400  = 0x0060,
  86         ipw_sio_b19200  = 0x00c0,
  87         ipw_sio_b14400  = 0x0100,
  88         ipw_sio_b9600   = 0x0180,
  89         ipw_sio_b4800   = 0x0300,
  90         ipw_sio_b2400   = 0x0600,
  91         ipw_sio_b1200   = 0x0c00,
  92         ipw_sio_b600    = 0x1800
  93 };
  94
  95 /* data bits */
  96 #define ipw_dtb_7               0x700
  97 #define ipw_dtb_8               0x810   /* ok so the define is misleading, I know, but forces 8,n,1 */
  98                                         /* I mean, is there a point to any other setting these days? :) */
  99
 100 /* usb control request types : */
 101 #define IPW_SIO_RXCTL           0x00    /* control bulk rx channel transmissions, value=1/0 (on/off) */
 102 #define IPW_SIO_SET_BAUD        0x01    /* set baud, value=requested ipw_sio_bxxxx */
 103 #define IPW_SIO_SET_LINE        0x03    /* set databits, parity. value=ipw_dtb_x */
 104 #define IPW_SIO_SET_PIN         0x03    /* set/clear dtr/rts value=ipw_pin_xxx */
 105 #define IPW_SIO_POLL            0x08    /* get serial port status byte, call with value=0 */
 106 #define IPW_SIO_INIT            0x11    /* initializes ? value=0 (appears as first thing todo on open) */
 107 #define IPW_SIO_PURGE           0x12    /* purge all transmissions?, call with value=numchar_to_purge */
 108 #define IPW_SIO_HANDFLOW        0x13    /* set xon/xoff limits value=0, and a buffer of 0x10 bytes */
 109 #define IPW_SIO_SETCHARS        0x13    /* set the flowcontrol special chars, value=0, buf=6 bytes, */
 110                                         /* last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13 */
 111
 112 /* values used for request IPW_SIO_SET_PIN */
 113 #define IPW_PIN_SETDTR          0x101
 114 #define IPW_PIN_SETRTS          0x202
 115 #define IPW_PIN_CLRDTR          0x100
 116 #define IPW_PIN_CLRRTS          0x200 /* unconfirmed */
 117
 118 /* values used for request IPW_SIO_RXCTL */
 119 #define IPW_RXBULK_ON           1
 120 #define IPW_RXBULK_OFF          0
 121
 122 /* various 16 byte hardcoded transferbuffers used by flow control */
 123 #define IPW_BYTES_FLOWINIT      { 0x01, 0, 0, 0, 0x40, 0, 0, 0, \
 124                                         0, 0, 0, 0, 0, 0, 0, 0 }
 125
 126 /* Interpretation of modem status lines */
 127 /* These need sorting out by individually connecting pins and checking
 128  * results. FIXME!
 129  * When data is being sent we see 0x30 in the lower byte; this must
 130  * contain DSR and CTS ...
 131  */
 132 #define IPW_DSR                 ((1<<4) | (1<<5))
 133 #define IPW_CTS                 ((1<<5) | (1<<4))
 134
 135 #define IPW_WANTS_TO_SEND       0x30
 136
 137 static const struct usb_device_id usb_ipw_ids[] = {
 138         { USB_DEVICE(IPW_VID, IPW_PID) },
 139         { },
 140 };
 141
 142 MODULE_DEVICE_TABLE(usb, usb_ipw_ids);
 143
 144 static struct usb_driver usb_ipw_driver = {
 145         .name =         "ipwtty",
 146         .probe =        usb_serial_probe,
 147         .disconnect =   usb_serial_disconnect,
 148         .id_table =     usb_ipw_ids,
 149         .no_dynamic_id =        1,
 150 };
 151
 152 static int debug;
 153
 154 static void ipw_read_bulk_callback(struct urb *urb)
 155 {
 156         struct usb_serial_port *port = urb->context;
 157         unsigned char *data = urb->transfer_buffer;
 158         struct tty_struct *tty;
 159         int result;
 160         int status = urb->status;
 161
 162         dbg("%s - port %d", __func__, port->number);
 163
 164         if (status) {
 165                 dbg("%s - nonzero read bulk status received: %d",
 166                     __func__, status);
 167                 return;
 168         }
 169
 170         usb_serial_debug_data(debug, &port->dev, __func__,
 171                                         urb->actual_length, data);
 172
 173         tty = tty_port_tty_get(&port->port);
 174         if (tty && urb->actual_length) {
 175                 tty_insert_flip_string(tty, data, urb->actual_length);
 176                 tty_flip_buffer_push(tty);
 177         }
 178         tty_kref_put(tty);
 179
 180         /* Continue trying to always read  */
 181         usb_fill_bulk_urb(port->read_urb, port->serial->dev,
 182                           usb_rcvbulkpipe(port->serial->dev,
 183                                            port->bulk_in_endpointAddress),
 184                           port->read_urb->transfer_buffer,
 185                           port->read_urb->transfer_buffer_length,
 186                           ipw_read_bulk_callback, port);
 187         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 188         if (result)
 189                 dev_err(&port->dev,
 190                         "%s - failed resubmitting read urb, error %d\n",
 191                                                         __func__, result);
 192         return;
 193 }
 194
 195 static int ipw_open(struct tty_struct *tty, struct usb_serial_port *port)
 196 {
 197         struct usb_device *dev = port->serial->dev;
 198         u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
 199         u8 *buf_flow_init;
 200         int result;
 201
 202         dbg("%s", __func__);
 203
 204         buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL);
 205         if (!buf_flow_init)
 206                 return -ENOMEM;
 207
 208         /* --1: Tell the modem to initialize (we think) From sniffs this is
 209          *      always the first thing that gets sent to the modem during
 210          *      opening of the device */
 211         dbg("%s: Sending SIO_INIT (we guess)", __func__);
 212         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 213                          IPW_SIO_INIT,
 214                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 215                          0,
 216                          0, /* index */
 217                          NULL,
 218                          0,
 219                          100000);
 220         if (result < 0)
 221                 dev_err(&port->dev,
 222                         "Init of modem failed (error = %d)\n", result);
 223
 224         /* reset the bulk pipes */
 225         usb_clear_halt(dev,
 226                         usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress));
 227         usb_clear_halt(dev,
 228                         usb_sndbulkpipe(dev, port->bulk_out_endpointAddress));
 229
 230         /*--2: Start reading from the device */
 231         dbg("%s: setting up bulk read callback", __func__);
 232         usb_fill_bulk_urb(port->read_urb, dev,
 233                           usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
 234                           port->bulk_in_buffer,
 235                           port->bulk_in_size,
 236                           ipw_read_bulk_callback, port);
 237         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
 238         if (result < 0)
 239                 dbg("%s - usb_submit_urb(read bulk) failed with status %d",
 240                                                         __func__, result);
 241
 242         /*--3: Tell the modem to open the floodgates on the rx bulk channel */
 243         dbg("%s:asking modem for RxRead (RXBULK_ON)", __func__);
 244         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 245                          IPW_SIO_RXCTL,
 246                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 247                          IPW_RXBULK_ON,
 248                          0, /* index */
 249                          NULL,
 250                          0,
 251                          100000);
 252         if (result < 0)
 253                 dev_err(&port->dev,
 254                         "Enabling bulk RxRead failed (error = %d)\n", result);
 255
 256         /*--4: setup the initial flowcontrol */
 257         dbg("%s:setting init flowcontrol (%s)", __func__, buf_flow_init);
 258         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 259                          IPW_SIO_HANDFLOW,
 260                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 261                          0,
 262                          0,
 263                          buf_flow_init,
 264                          0x10,
 265                          200000);
 266         if (result < 0)
 267                 dev_err(&port->dev,
 268                         "initial flowcontrol failed (error = %d)\n", result);
 269
 270
 271         /*--5: raise the dtr */
 272         dbg("%s:raising dtr", __func__);
 273         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 274                          IPW_SIO_SET_PIN,
 275                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 276                          IPW_PIN_SETDTR,
 277                          0,
 278                          NULL,
 279                          0,
 280                          200000);
 281         if (result < 0)
 282                 dev_err(&port->dev,
 283                                 "setting dtr failed (error = %d)\n", result);
 284
 285         /*--6: raise the rts */
 286         dbg("%s:raising rts", __func__);
 287         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 288                          IPW_SIO_SET_PIN,
 289                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 290                          IPW_PIN_SETRTS,
 291                          0,
 292                          NULL,
 293                          0,
 294                          200000);
 295         if (result < 0)
 296                 dev_err(&port->dev,
 297                                 "setting dtr failed (error = %d)\n", result);
 298
 299         kfree(buf_flow_init);
 300         return 0;
 301 }
 302
 303 static void ipw_dtr_rts(struct usb_serial_port *port, int on)
 304 {
 305         struct usb_device *dev = port->serial->dev;
 306         int result;
 307
 308         /*--1: drop the dtr */
 309         dbg("%s:dropping dtr", __func__);
 310         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 311                          IPW_SIO_SET_PIN,
 312                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 313                          on ? IPW_PIN_SETDTR : IPW_PIN_CLRDTR,
 314                          0,
 315                          NULL,
 316                          0,
 317                          200000);
 318         if (result < 0)
 319                 dev_err(&port->dev, "dropping dtr failed (error = %d)\n",
 320                                                                 result);
 321
 322         /*--2: drop the rts */
 323         dbg("%s:dropping rts", __func__);
 324         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 325                          IPW_SIO_SET_PIN, USB_TYPE_VENDOR |
 326                                         USB_RECIP_INTERFACE | USB_DIR_OUT,
 327                          on ? IPW_PIN_SETRTS : IPW_PIN_CLRRTS,
 328                          0,
 329                          NULL,
 330                          0,
 331                          200000);
 332         if (result < 0)
 333                 dev_err(&port->dev,
 334                                 "dropping rts failed (error = %d)\n", result);
 335 }
 336
 337 static void ipw_close(struct usb_serial_port *port)
 338 {
 339         struct usb_device *dev = port->serial->dev;
 340         int result;
 341
 342         /*--3: purge */
 343         dbg("%s:sending purge", __func__);
 344         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 345                          IPW_SIO_PURGE, USB_TYPE_VENDOR |
 346                                         USB_RECIP_INTERFACE | USB_DIR_OUT,
 347                          0x03,
 348                          0,
 349                          NULL,
 350                          0,
 351                          200000);
 352         if (result < 0)
 353                 dev_err(&port->dev, "purge failed (error = %d)\n", result);
 354
 355
 356         /* send RXBULK_off (tell modem to stop transmitting bulk data on
 357            rx chan) */
 358         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 359                          IPW_SIO_RXCTL,
 360                          USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 361                          IPW_RXBULK_OFF,
 362                          0, /* index */
 363                          NULL,
 364                          0,
 365                          100000);
 366
 367         if (result < 0)
 368                 dev_err(&port->dev,
 369                         "Disabling bulk RxRead failed (error = %d)\n", result);
 370
 371         /* shutdown any in-flight urbs that we know about */
 372         usb_kill_urb(port->read_urb);
 373         usb_kill_urb(port->write_urb);
 374 }
 375
 376 static void ipw_write_bulk_callback(struct urb *urb)
 377 {
 378         struct usb_serial_port *port = urb->context;
 379         int status = urb->status;
 380
 381         dbg("%s", __func__);
 382
 383         port->write_urb_busy = 0;
 384
 385         if (status)
 386                 dbg("%s - nonzero write bulk status received: %d",
 387                     __func__, status);
 388
 389         usb_serial_port_softint(port);
 390 }
 391
 392 static int ipw_write(struct tty_struct *tty, struct usb_serial_port *port,
 393                                         const unsigned char *buf, int count)
 394 {
 395         struct usb_device *dev = port->serial->dev;
 396         int ret;
 397
 398         dbg("%s: TOP: count=%d, in_interrupt=%ld", __func__,
 399                 count, in_interrupt());
 400
 401         if (count == 0) {
 402                 dbg("%s - write request of 0 bytes", __func__);
 403                 return 0;
 404         }
 405
 406         spin_lock_bh(&port->lock);
 407         if (port->write_urb_busy) {
 408                 spin_unlock_bh(&port->lock);
 409                 dbg("%s - already writing", __func__);
 410                 return 0;
 411         }
 412         port->write_urb_busy = 1;
 413         spin_unlock_bh(&port->lock);
 414
 415         count = min(count, port->bulk_out_size);
 416         memcpy(port->bulk_out_buffer, buf, count);
 417
 418         dbg("%s count now:%d", __func__, count);
 419
 420         usb_fill_bulk_urb(port->write_urb, dev,
 421                           usb_sndbulkpipe(dev, port->bulk_out_endpointAddress),
 422                           port->write_urb->transfer_buffer,
 423                           count,
 424                           ipw_write_bulk_callback,
 425                           port);
 426
 427         ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 428         if (ret != 0) {
 429                 port->write_urb_busy = 0;
 430                 dbg("%s - usb_submit_urb(write bulk) failed with error = %d",
 431                                                                 __func__, ret);
 432                 return ret;
 433         }
 434
 435         dbg("%s returning %d", __func__, count);
 436         return count;
 437 }
 438
 439 static int ipw_probe(struct usb_serial_port *port)
 440 {
 441         return 0;
 442 }
 443
 444 static int ipw_disconnect(struct usb_serial_port *port)
 445 {
 446         usb_set_serial_port_data(port, NULL);
 447         return 0;
 448 }
 449
 450 static struct usb_serial_driver ipw_device = {
 451         .driver = {
 452                 .owner =        THIS_MODULE,
 453                 .name =         "ipw",
 454         },
 455         .description =          "IPWireless converter",
 456         .usb_driver =           &usb_ipw_driver,
 457         .id_table =             usb_ipw_ids,
 458         .num_ports =            1,
 459         .open =                 ipw_open,
 460         .close =                ipw_close,
 461         .dtr_rts =              ipw_dtr_rts,
 462         .port_probe =           ipw_probe,
 463         .port_remove =          ipw_disconnect,
 464         .write =                ipw_write,
 465         .write_bulk_callback =  ipw_write_bulk_callback,
 466         .read_bulk_callback =   ipw_read_bulk_callback,
 467 };
 468
 469
 470
 471 static int __init usb_ipw_init(void)
 472 {
 473         int retval;
 474
 475         retval = usb_serial_register(&ipw_device);
 476         if (retval)
 477                 return retval;
 478         retval = usb_register(&usb_ipw_driver);
 479         if (retval) {
 480                 usb_serial_deregister(&ipw_device);
 481                 return retval;
 482         }
 483         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 484                DRIVER_DESC "\n");
 485         return 0;
 486 }
 487
 488 static void __exit usb_ipw_exit(void)
 489 {
 490         usb_deregister(&usb_ipw_driver);
 491         usb_serial_deregister(&ipw_device);
 492 }
 493
 494 module_init(usb_ipw_init);
 495 module_exit(usb_ipw_exit);
 496
 497 /* Module information */
 498 MODULE_AUTHOR(DRIVER_AUTHOR);
 499 MODULE_DESCRIPTION(DRIVER_DESC);
 500 MODULE_LICENSE("GPL");
 501
 502 module_param(debug, bool, S_IRUGO | S_IWUSR);
 503 MODULE_PARM_DESC(debug, "Debug enabled or not");