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