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 <asm/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, 0, 0, 0, 0, 0, 0, 0, 0 }
 124
 125 /* Interpretation of modem status lines */
 126 /* These need sorting out by individually connecting pins and checking
 127  * results. FIXME!
 128  * When data is being sent we see 0x30 in the lower byte; this must
 129  * contain DSR and CTS ...
 130  */
 131 #define IPW_DSR                 ((1<<4) | (1<<5))
 132 #define IPW_CTS                 ((1<<5) | (1<<4))
 133
 134 #define IPW_WANTS_TO_SEND       0x30
 135 //#define IPW_DTR                       /* Data Terminal Ready */
 136 //#define IPW_CTS                       /* Clear To Send */
 137 //#define IPW_CD                        /* Carrier Detect */
 138 //#define IPW_DSR                       /* Data Set Ready */
 139 //#define IPW_RxD                       /* Receive pin */
 140
 141 //#define IPW_LE
 142 //#define IPW_RTS
 143 //#define IPW_ST
 144 //#define IPW_SR
 145 //#define IPW_RI                        /* Ring Indicator */
 146
 147 static struct usb_device_id usb_ipw_ids[] = {
 148         { USB_DEVICE(IPW_VID, IPW_PID) },
 149         { },
 150 };
 151
 152 MODULE_DEVICE_TABLE(usb, usb_ipw_ids);
 153
 154 static struct usb_driver usb_ipw_driver = {
 155         .name =         "ipwtty",
 156         .probe =        usb_serial_probe,
 157         .disconnect =   usb_serial_disconnect,
 158         .id_table =     usb_ipw_ids,
 159         .no_dynamic_id =        1,
 160 };
 161
 162 static int debug;
 163
 164 static void ipw_read_bulk_callback(struct urb *urb)
 165 {
 166         struct usb_serial_port *port = urb->context;
 167         unsigned char *data = urb->transfer_buffer;
 168         struct tty_struct *tty;
 169         int result;
 170
 171         dbg("%s - port %d", __FUNCTION__, port->number);
 172
 173         if (urb->status) {
 174                 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
 175                 return;
 176         }
 177
 178         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
 179
 180         tty = port->tty;
 181         if (tty && urb->actual_length) {
 182                 tty_buffer_request_room(tty, urb->actual_length);
 183                 tty_insert_flip_string(tty, data, urb->actual_length);
 184                 tty_flip_buffer_push(tty);
 185         }
 186
 187         /* Continue trying to always read  */
 188         usb_fill_bulk_urb (port->read_urb, port->serial->dev,
 189                            usb_rcvbulkpipe(port->serial->dev,
 190                                            port->bulk_in_endpointAddress),
 191                            port->read_urb->transfer_buffer,
 192                            port->read_urb->transfer_buffer_length,
 193                            ipw_read_bulk_callback, port);
 194         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 195         if (result)
 196                 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
 197         return;
 198 }
 199
 200 static int ipw_open(struct usb_serial_port *port, struct file *filp)
 201 {
 202         struct usb_device *dev = port->serial->dev;
 203         u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
 204         u8 *buf_flow_init;
 205         int result;
 206
 207         dbg("%s", __FUNCTION__);
 208
 209         buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL);
 210         if (!buf_flow_init)
 211                 return -ENOMEM;
 212
 213         if (port->tty)
 214                 port->tty->low_latency = 1;
 215
 216         /* --1: Tell the modem to initialize (we think) From sniffs this is always the
 217          * first thing that gets sent to the modem during opening of the device */
 218         dbg("%s: Sending SIO_INIT (we guess)",__FUNCTION__);
 219         result = usb_control_msg(dev, usb_sndctrlpipe(dev,0),
 220                                  IPW_SIO_INIT,
 221                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 222                                  0,
 223                                  0, /* index */
 224                                  NULL,
 225                                  0,
 226                                  100000);
 227         if (result < 0)
 228                 dev_err(&port->dev, "Init of modem failed (error = %d)", result);
 229
 230         /* reset the bulk pipes */
 231         usb_clear_halt(dev, usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress));
 232         usb_clear_halt(dev, usb_sndbulkpipe(dev, port->bulk_out_endpointAddress));
 233
 234         /*--2: Start reading from the device */
 235         dbg("%s: setting up bulk read callback",__FUNCTION__);
 236         usb_fill_bulk_urb(port->read_urb, dev,
 237                           usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
 238                           port->bulk_in_buffer,
 239                           port->bulk_in_size,
 240                           ipw_read_bulk_callback, port);
 241         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
 242         if (result < 0)
 243                 dbg("%s - usb_submit_urb(read bulk) failed with status %d", __FUNCTION__, result);
 244
 245         /*--3: Tell the modem to open the floodgates on the rx bulk channel */
 246         dbg("%s:asking modem for RxRead (RXBULK_ON)",__FUNCTION__);
 247         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 248                                  IPW_SIO_RXCTL,
 249                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 250                                  IPW_RXBULK_ON,
 251                                  0, /* index */
 252                                  NULL,
 253                                  0,
 254                                  100000);
 255         if (result < 0)
 256                 dev_err(&port->dev, "Enabling bulk RxRead failed (error = %d)", result);
 257
 258         /*--4: setup the initial flowcontrol */
 259         dbg("%s:setting init flowcontrol (%s)",__FUNCTION__,buf_flow_init);
 260         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 261                                  IPW_SIO_HANDFLOW,
 262                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 263                                  0,
 264                                  0,
 265                                  buf_flow_init,
 266                                  0x10,
 267                                  200000);
 268         if (result < 0)
 269                 dev_err(&port->dev, "initial flowcontrol failed (error = %d)", result);
 270
 271
 272         /*--5: raise the dtr */
 273         dbg("%s:raising dtr",__FUNCTION__);
 274         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 275                                  IPW_SIO_SET_PIN,
 276                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 277                                  IPW_PIN_SETDTR,
 278                                  0,
 279                                  NULL,
 280                                  0,
 281                                  200000);
 282         if (result < 0)
 283                 dev_err(&port->dev, "setting dtr failed (error = %d)", result);
 284
 285         /*--6: raise the rts */
 286         dbg("%s:raising rts",__FUNCTION__);
 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, "setting dtr failed (error = %d)", result);
 297
 298         kfree(buf_flow_init);
 299         return 0;
 300 }
 301
 302 static void ipw_close(struct usb_serial_port *port, struct file * filp)
 303 {
 304         struct usb_device *dev = port->serial->dev;
 305         int result;
 306
 307         if (tty_hung_up_p(filp)) {
 308                 dbg("%s: tty_hung_up_p ...", __FUNCTION__);
 309                 return;
 310         }
 311
 312         /*--1: drop the dtr */
 313         dbg("%s:dropping dtr",__FUNCTION__);
 314         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 315                                  IPW_SIO_SET_PIN,
 316                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 317                                  IPW_PIN_CLRDTR,
 318                                  0,
 319                                  NULL,
 320                                  0,
 321                                  200000);
 322         if (result < 0)
 323                 dev_err(&port->dev, "dropping dtr failed (error = %d)", result);
 324
 325         /*--2: drop the rts */
 326         dbg("%s:dropping rts",__FUNCTION__);
 327         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 328                                  IPW_SIO_SET_PIN, USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 329                                  IPW_PIN_CLRRTS,
 330                                  0,
 331                                  NULL,
 332                                  0,
 333                                  200000);
 334         if (result < 0)
 335                 dev_err(&port->dev, "dropping rts failed (error = %d)", result);
 336
 337
 338         /*--3: purge */
 339         dbg("%s:sending purge",__FUNCTION__);
 340         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 341                                  IPW_SIO_PURGE, USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 342                                  0x03,
 343                                  0,
 344                                  NULL,
 345                                  0,
 346                                  200000);
 347         if (result < 0)
 348                 dev_err(&port->dev, "purge failed (error = %d)", result);
 349
 350
 351         /* send RXBULK_off (tell modem to stop transmitting bulk data on rx chan) */
 352         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 353                                  IPW_SIO_RXCTL,
 354                                  USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
 355                                  IPW_RXBULK_OFF,
 356                                  0, /* index */
 357                                  NULL,
 358                                  0,
 359                                  100000);
 360
 361         if (result < 0)
 362                 dev_err(&port->dev, "Disabling bulk RxRead failed (error = %d)", result);
 363
 364         /* shutdown any in-flight urbs that we know about */
 365         usb_kill_urb(port->read_urb);
 366         usb_kill_urb(port->write_urb);
 367 }
 368
 369 static void ipw_write_bulk_callback(struct urb *urb)
 370 {
 371         struct usb_serial_port *port = urb->context;
 372
 373         dbg("%s", __FUNCTION__);
 374
 375         port->write_urb_busy = 0;
 376
 377         if (urb->status)
 378                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
 379
 380         usb_serial_port_softint(port);
 381 }
 382
 383 static int ipw_write(struct usb_serial_port *port, const unsigned char *buf, int count)
 384 {
 385         struct usb_device *dev = port->serial->dev;
 386         int ret;
 387
 388         dbg("%s: TOP: count=%d, in_interrupt=%ld", __FUNCTION__,
 389                 count, in_interrupt() );
 390
 391         if (count == 0) {
 392                 dbg("%s - write request of 0 bytes", __FUNCTION__);
 393                 return 0;
 394         }
 395
 396         spin_lock_bh(&port->lock);
 397         if (port->write_urb_busy) {
 398                 spin_unlock_bh(&port->lock);
 399                 dbg("%s - already writing", __FUNCTION__);
 400                 return 0;
 401         }
 402         port->write_urb_busy = 1;
 403         spin_unlock_bh(&port->lock);
 404
 405         count = min(count, port->bulk_out_size);
 406         memcpy(port->bulk_out_buffer, buf, count);
 407
 408         dbg("%s count now:%d", __FUNCTION__, count);
 409
 410         usb_fill_bulk_urb(port->write_urb, dev,
 411                           usb_sndbulkpipe(dev, port->bulk_out_endpointAddress),
 412                           port->write_urb->transfer_buffer,
 413                           count,
 414                           ipw_write_bulk_callback,
 415                           port);
 416
 417         ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 418         if (ret != 0) {
 419                 port->write_urb_busy = 0;
 420                 dbg("%s - usb_submit_urb(write bulk) failed with error = %d", __FUNCTION__, ret);
 421                 return ret;
 422         }
 423
 424         dbg("%s returning %d", __FUNCTION__, count);
 425         return count;
 426 }
 427
 428 static int ipw_probe(struct usb_serial_port *port)
 429 {
 430         return 0;
 431 }
 432
 433 static int ipw_disconnect(struct usb_serial_port *port)
 434 {
 435         usb_set_serial_port_data(port, NULL);
 436         return 0;
 437 }
 438
 439 static struct usb_serial_driver ipw_device = {
 440         .driver = {
 441                 .owner =        THIS_MODULE,
 442                 .name =         "ipw",
 443         },
 444         .description =          "IPWireless converter",
 445         .id_table =             usb_ipw_ids,
 446         .num_interrupt_in =     NUM_DONT_CARE,
 447         .num_bulk_in =          1,
 448         .num_bulk_out =         1,
 449         .num_ports =            1,
 450         .open =                 ipw_open,
 451         .close =                ipw_close,
 452         .port_probe =           ipw_probe,
 453         .port_remove =          ipw_disconnect,
 454         .write =                ipw_write,
 455         .write_bulk_callback =  ipw_write_bulk_callback,
 456         .read_bulk_callback =   ipw_read_bulk_callback,
 457 };
 458
 459
 460
 461 static int usb_ipw_init(void)
 462 {
 463         int retval;
 464
 465         retval = usb_serial_register(&ipw_device);
 466         if (retval)
 467                 return retval;
 468         retval = usb_register(&usb_ipw_driver);
 469         if (retval) {
 470                 usb_serial_deregister(&ipw_device);
 471                 return retval;
 472         }
 473         info(DRIVER_DESC " " DRIVER_VERSION);
 474         return 0;
 475 }
 476
 477 static void usb_ipw_exit(void)
 478 {
 479         usb_deregister(&usb_ipw_driver);
 480         usb_serial_deregister(&ipw_device);
 481 }
 482
 483 module_init(usb_ipw_init);
 484 module_exit(usb_ipw_exit);
 485
 486 /* Module information */
 487 MODULE_AUTHOR( DRIVER_AUTHOR );
 488 MODULE_DESCRIPTION( DRIVER_DESC );
 489 MODULE_LICENSE("GPL");
 490
 491 module_param(debug, bool, S_IRUGO | S_IWUSR);
 492 MODULE_PARM_DESC(debug, "Debug enabled or not");