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