drivers/usb/serial/kl5kusb105.c

   1 /*
   2  * KLSI KL5KUSB105 chip RS232 converter driver
   3  *
   4  *   Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
   5  *
   6  *   This program is free software; you can redistribute it and/or modify
   7  *   it under the terms of the GNU General Public License as published by
   8  *   the Free Software Foundation; either version 2 of the License, or
   9  *   (at your option) any later version.
  10  *
  11  * All information about the device was acquired using SniffUSB ans snoopUSB
  12  * on Windows98.
  13  * It was written out of frustration with the PalmConnect USB Serial adapter
  14  * sold by Palm Inc.
  15  * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
  16  * information that was not already available.
  17  *
  18  * It seems that KLSI bought some silicon-design information from ScanLogic,
  19  * whose SL11R processor is at the core of the KL5KUSB chipset from KLSI.
  20  * KLSI has firmware available for their devices; it is probable that the
  21  * firmware differs from that used by KLSI in their products. If you have an
  22  * original KLSI device and can provide some information on it, I would be
  23  * most interested in adding support for it here. If you have any information
  24  * on the protocol used (or find errors in my reverse-engineered stuff), please
  25  * let me know.
  26  *
  27  * The code was only tested with a PalmConnect USB adapter; if you
  28  * are adventurous, try it with any KLSI-based device and let me know how it
  29  * breaks so that I can fix it!
  30  */
  31
  32 /* TODO:
  33  *      check modem line signals
  34  *      implement handshaking or decide that we do not support it
  35  */
  36
  37 /* History:
  38  *   0.3a - implemented pools of write URBs
  39  *   0.3  - alpha version for public testing
  40  *   0.2  - TIOCMGET works, so autopilot(1) can be used!
  41  *   0.1  - can be used to to pilot-xfer -p /dev/ttyUSB0 -l
  42  *
  43  *   The driver skeleton is mainly based on mct_u232.c and various other
  44  *   pieces of code shamelessly copied from the drivers/usb/serial/ directory.
  45  */
  46
  47
  48 #include <linux/config.h>
  49 #include <linux/kernel.h>
  50 #include <linux/errno.h>
  51 #include <linux/init.h>
  52 #include <linux/slab.h>
  53 #include <linux/tty.h>
  54 #include <linux/tty_driver.h>
  55 #include <linux/tty_flip.h>
  56 #include <linux/module.h>
  57 #include <asm/uaccess.h>
  58 #include <linux/usb.h>
  59
  60 #ifdef CONFIG_USB_SERIAL_DEBUG
  61         static int debug = 1;
  62 #else
  63         static int debug;
  64 #endif
  65
  66 #include "usb-serial.h"
  67 #include "kl5kusb105.h"
  68
  69
  70 /*
  71  * Version Information
  72  */
  73 #define DRIVER_VERSION "v0.3a"
  74 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>"
  75 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
  76
  77
  78 /*
  79  * Function prototypes
  80  */
  81 static int  klsi_105_startup             (struct usb_serial *serial);
  82 static void klsi_105_shutdown            (struct usb_serial *serial);
  83 static int  klsi_105_open                (struct usb_serial_port *port,
  84                                           struct file *filp);
  85 static void klsi_105_close               (struct usb_serial_port *port,
  86                                           struct file *filp);
  87 static int  klsi_105_write               (struct usb_serial_port *port,
  88                                           int from_user,
  89                                           const unsigned char *buf,
  90                                           int count);
  91 static void klsi_105_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
  92 static int  klsi_105_chars_in_buffer     (struct usb_serial_port *port);
  93 static int  klsi_105_write_room          (struct usb_serial_port *port);
  94
  95 static void klsi_105_read_bulk_callback  (struct urb *urb, struct pt_regs *regs);
  96 static void klsi_105_set_termios         (struct usb_serial_port *port,
  97                                           struct termios * old);
  98 static int  klsi_105_ioctl               (struct usb_serial_port *port,
  99                                           struct file * file,
 100                                           unsigned int cmd,
 101                                           unsigned long arg);
 102 static void klsi_105_throttle            (struct usb_serial_port *port);
 103 static void klsi_105_unthrottle          (struct usb_serial_port *port);
 104 /*
 105 static void klsi_105_break_ctl           (struct usb_serial_port *port,
 106                                           int break_state );
 107  */
 108 static int  klsi_105_tiocmget            (struct usb_serial_port *port,
 109                                           struct file *file);
 110 static int  klsi_105_tiocmset            (struct usb_serial_port *port,
 111                                           struct file *file, unsigned int set,
 112                                           unsigned int clear);
 113
 114 /*
 115  * All of the device info needed for the KLSI converters.
 116  */
 117 static struct usb_device_id id_table [] = {
 118         { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
 119         { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
 120         { }             /* Terminating entry */
 121 };
 122
 123 MODULE_DEVICE_TABLE (usb, id_table);
 124
 125 static struct usb_driver kl5kusb105d_driver = {
 126         .owner =        THIS_MODULE,
 127         .name =         "kl5kusb105d",
 128         .probe =        usb_serial_probe,
 129         .disconnect =   usb_serial_disconnect,
 130         .id_table =     id_table,
 131 };
 132
 133 static struct usb_serial_device_type kl5kusb105d_device = {
 134         .owner =             THIS_MODULE,
 135         .name =              "KL5KUSB105D / PalmConnect",
 136         .short_name =        "kl5kusb105d",
 137         .id_table =          id_table,
 138         .num_interrupt_in =  1,
 139         .num_bulk_in =       1,
 140         .num_bulk_out =      1,
 141         .num_ports =         1,
 142         .open =              klsi_105_open,
 143         .close =             klsi_105_close,
 144         .write =             klsi_105_write,
 145         .write_bulk_callback = klsi_105_write_bulk_callback,
 146         .chars_in_buffer =   klsi_105_chars_in_buffer,
 147         .write_room =        klsi_105_write_room,
 148         .read_bulk_callback =klsi_105_read_bulk_callback,
 149         .ioctl =             klsi_105_ioctl,
 150         .set_termios =       klsi_105_set_termios,
 151         /*.break_ctl =       klsi_105_break_ctl,*/
 152         .tiocmget =          klsi_105_tiocmget,
 153         .tiocmset =          klsi_105_tiocmset,
 154         .attach =            klsi_105_startup,
 155         .shutdown =          klsi_105_shutdown,
 156         .throttle =          klsi_105_throttle,
 157         .unthrottle =        klsi_105_unthrottle,
 158 };
 159
 160 struct klsi_105_port_settings {
 161         __u8    pktlen;         /* always 5, it seems */
 162         __u8    baudrate;
 163         __u8    databits;
 164         __u8    unknown1;
 165         __u8    unknown2;
 166 } __attribute__ ((packed));
 167
 168 /* we implement a pool of NUM_URBS urbs per usb_serial */
 169 #define NUM_URBS                        1
 170 #define URB_TRANSFER_BUFFER_SIZE        64
 171 struct klsi_105_private {
 172         struct klsi_105_port_settings   cfg;
 173         struct termios                  termios;
 174         unsigned long                   line_state; /* modem line settings */
 175         /* write pool */
 176         struct urb *                    write_urb_pool[NUM_URBS];
 177         spinlock_t                      lock;
 178         unsigned long                   bytes_in;
 179         unsigned long                   bytes_out;
 180 };
 181
 182
 183 /*
 184  * Handle vendor specific USB requests
 185  */
 186
 187
 188 #define KLSI_TIMEOUT     (HZ * 5 ) /* default urb timeout */
 189
 190 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
 191                                       struct klsi_105_port_settings *settings)
 192 {
 193         int rc;
 194
 195         rc = usb_control_msg(port->serial->dev,
 196                              usb_sndctrlpipe(port->serial->dev, 0),
 197                              KL5KUSB105A_SIO_SET_DATA,
 198                              USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
 199                              0, /* value */
 200                              0, /* index */
 201                              settings,
 202                              sizeof(struct klsi_105_port_settings),
 203                              KLSI_TIMEOUT);
 204         if (rc < 0)
 205                 err("Change port settings failed (error = %d)", rc);
 206         info("%s - %d byte block, baudrate %x, databits %d, u1 %d, u2 %d",
 207             __FUNCTION__,
 208             settings->pktlen,
 209             settings->baudrate, settings->databits,
 210             settings->unknown1, settings->unknown2);
 211         return rc;
 212 } /* klsi_105_chg_port_settings */
 213
 214 /* translate a 16-bit status value from the device to linux's TIO bits */
 215 static unsigned long klsi_105_status2linestate(const __u16 status)
 216 {
 217         unsigned long res = 0;
 218
 219         res =   ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
 220               | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
 221               ;
 222
 223         return res;
 224 }
 225 /*
 226  * Read line control via vendor command and return result through
 227  * *line_state_p
 228  */
 229 /* It seems that the status buffer has always only 2 bytes length */
 230 #define KLSI_STATUSBUF_LEN      2
 231 static int klsi_105_get_line_state(struct usb_serial_port *port,
 232                                    unsigned long *line_state_p)
 233 {
 234         int rc;
 235         __u8 status_buf[KLSI_STATUSBUF_LEN] = { -1,-1};
 236         __u16 status;
 237
 238         info("%s - sending SIO Poll request", __FUNCTION__);
 239         rc = usb_control_msg(port->serial->dev,
 240                              usb_rcvctrlpipe(port->serial->dev, 0),
 241                              KL5KUSB105A_SIO_POLL,
 242                              USB_TYPE_VENDOR | USB_DIR_IN,
 243                              0, /* value */
 244                              0, /* index */
 245                              status_buf, KLSI_STATUSBUF_LEN,
 246                              10*HZ
 247                              );
 248         if (rc < 0)
 249                 err("Reading line status failed (error = %d)", rc);
 250         else {
 251                 status = status_buf[0] + (status_buf[1]<<8);
 252
 253                 info("%s - read status %x %x", __FUNCTION__,
 254                      status_buf[0], status_buf[1]);
 255
 256                 *line_state_p = klsi_105_status2linestate(status);
 257         }
 258
 259         return rc;
 260 }
 261
 262
 263 /*
 264  * Driver's tty interface functions
 265  */
 266
 267 static int klsi_105_startup (struct usb_serial *serial)
 268 {
 269         struct klsi_105_private *priv;
 270         int i;
 271
 272         /* check if we support the product id (see keyspan.c)
 273          * FIXME
 274          */
 275
 276         /* allocate the private data structure */
 277         for (i=0; i<serial->num_ports; i++) {
 278                 int j;
 279                 priv = kmalloc(sizeof(struct klsi_105_private),
 280                                                    GFP_KERNEL);
 281                 if (!priv) {
 282                         dbg("%skmalloc for klsi_105_private failed.", __FUNCTION__);
 283                         return -ENOMEM;
 284                 }
 285                 /* set initial values for control structures */
 286                 priv->cfg.pktlen    = 5;
 287                 priv->cfg.baudrate  = kl5kusb105a_sio_b9600;
 288                 priv->cfg.databits  = kl5kusb105a_dtb_8;
 289                 priv->cfg.unknown1  = 0;
 290                 priv->cfg.unknown2  = 1;
 291
 292                 priv->line_state    = 0;
 293
 294                 priv->bytes_in      = 0;
 295                 priv->bytes_out     = 0;
 296                 usb_set_serial_port_data(serial->port[i], priv);
 297
 298                 spin_lock_init (&priv->lock);
 299                 for (j=0; j<NUM_URBS; j++) {
 300                         struct urb* urb = usb_alloc_urb(0, GFP_KERNEL);
 301
 302                         priv->write_urb_pool[j] = urb;
 303                         if (urb == NULL) {
 304                                 err("No more urbs???");
 305                                 continue;
 306                         }
 307
 308                         urb->transfer_buffer = NULL;
 309                         urb->transfer_buffer = kmalloc (URB_TRANSFER_BUFFER_SIZE,
 310                                                         GFP_KERNEL);
 311                         if (!urb->transfer_buffer) {
 312                                 err("%s - out of memory for urb buffers.", __FUNCTION__);
 313                                 continue;
 314                         }
 315                 }
 316
 317                 /* priv->termios is left uninitalized until port opening */
 318                 init_waitqueue_head(&serial->port[i]->write_wait);
 319         }
 320
 321         return (0);
 322 } /* klsi_105_startup */
 323
 324
 325 static void klsi_105_shutdown (struct usb_serial *serial)
 326 {
 327         int i;
 328
 329         dbg("%s", __FUNCTION__);
 330
 331         /* stop reads and writes on all ports */
 332         for (i=0; i < serial->num_ports; ++i) {
 333                 struct klsi_105_private *priv = usb_get_serial_port_data(serial->port[i]);
 334                 unsigned long flags;
 335
 336                 if (priv) {
 337                         /* kill our write urb pool */
 338                         int j;
 339                         struct urb **write_urbs = priv->write_urb_pool;
 340                         spin_lock_irqsave(&priv->lock,flags);
 341
 342                         for (j = 0; j < NUM_URBS; j++) {
 343                                 if (write_urbs[j]) {
 344                                         /* FIXME - uncomment the following
 345                                          * usb_unlink_urb call when the host
 346                                          * controllers get fixed to set
 347                                          * urb->dev = NULL after the urb is
 348                                          * finished.  Otherwise this call
 349                                          * oopses. */
 350                                         /* usb_unlink_urb(write_urbs[j]); */
 351                                         if (write_urbs[j]->transfer_buffer)
 352                                                     kfree(write_urbs[j]->transfer_buffer);
 353                                         usb_free_urb (write_urbs[j]);
 354                                 }
 355                         }
 356
 357                         spin_unlock_irqrestore (&priv->lock, flags);
 358
 359                         kfree(priv);
 360                         usb_set_serial_port_data(serial->port[i], NULL);
 361                 }
 362         }
 363 } /* klsi_105_shutdown */
 364
 365 static int  klsi_105_open (struct usb_serial_port *port, struct file *filp)
 366 {
 367         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 368         int retval = 0;
 369         int rc;
 370         int i;
 371         unsigned long line_state;
 372         struct klsi_105_port_settings cfg;
 373         unsigned long flags;
 374
 375         dbg("%s port %d", __FUNCTION__, port->number);
 376
 377         /* force low_latency on so that our tty_push actually forces
 378          * the data through
 379          * port->tty->low_latency = 1; */
 380
 381         /* Do a defined restart:
 382          * Set up sane default baud rate and send the 'READ_ON'
 383          * vendor command.
 384          * FIXME: set modem line control (how?)
 385          * Then read the modem line control and store values in
 386          * priv->line_state.
 387          */
 388         cfg.pktlen   = 5;
 389         cfg.baudrate = kl5kusb105a_sio_b9600;
 390         cfg.databits = kl5kusb105a_dtb_8;
 391         cfg.unknown1 = 0;
 392         cfg.unknown2 = 1;
 393         klsi_105_chg_port_settings(port, &cfg);
 394
 395         /* set up termios structure */
 396         spin_lock_irqsave (&priv->lock, flags);
 397         priv->termios.c_iflag = port->tty->termios->c_iflag;
 398         priv->termios.c_oflag = port->tty->termios->c_oflag;
 399         priv->termios.c_cflag = port->tty->termios->c_cflag;
 400         priv->termios.c_lflag = port->tty->termios->c_lflag;
 401         for (i=0; i<NCCS; i++)
 402                 priv->termios.c_cc[i] = port->tty->termios->c_cc[i];
 403         priv->cfg.pktlen   = cfg.pktlen;
 404         priv->cfg.baudrate = cfg.baudrate;
 405         priv->cfg.databits = cfg.databits;
 406         priv->cfg.unknown1 = cfg.unknown1;
 407         priv->cfg.unknown2 = cfg.unknown2;
 408         spin_unlock_irqrestore (&priv->lock, flags);
 409
 410         /* READ_ON and urb submission */
 411         usb_fill_bulk_urb(port->read_urb, port->serial->dev,
 412                       usb_rcvbulkpipe(port->serial->dev,
 413                                       port->bulk_in_endpointAddress),
 414                       port->read_urb->transfer_buffer,
 415                       port->read_urb->transfer_buffer_length,
 416                       klsi_105_read_bulk_callback,
 417                       port);
 418
 419         rc = usb_submit_urb(port->read_urb, GFP_KERNEL);
 420         if (rc) {
 421                 err("%s - failed submitting read urb, error %d", __FUNCTION__, rc);
 422                 retval = rc;
 423                 goto exit;
 424         }
 425
 426         rc = usb_control_msg(port->serial->dev,
 427                              usb_sndctrlpipe(port->serial->dev,0),
 428                              KL5KUSB105A_SIO_CONFIGURE,
 429                              USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
 430                              KL5KUSB105A_SIO_CONFIGURE_READ_ON,
 431                              0, /* index */
 432                              NULL,
 433                              0,
 434                              KLSI_TIMEOUT);
 435         if (rc < 0) {
 436                 err("Enabling read failed (error = %d)", rc);
 437                 retval = rc;
 438         } else
 439                 dbg("%s - enabled reading", __FUNCTION__);
 440
 441         rc = klsi_105_get_line_state(port, &line_state);
 442         if (rc >= 0) {
 443                 spin_lock_irqsave (&priv->lock, flags);
 444                 priv->line_state = line_state;
 445                 spin_unlock_irqrestore (&priv->lock, flags);
 446                 dbg("%s - read line state 0x%lx", __FUNCTION__, line_state);
 447                 retval = 0;
 448         } else
 449                 retval = rc;
 450
 451 exit:
 452         return retval;
 453 } /* klsi_105_open */
 454
 455
 456 static void klsi_105_close (struct usb_serial_port *port, struct file *filp)
 457 {
 458         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 459         int rc;
 460
 461         dbg("%s port %d", __FUNCTION__, port->number);
 462
 463         /* send READ_OFF */
 464         rc = usb_control_msg (port->serial->dev,
 465                               usb_sndctrlpipe(port->serial->dev, 0),
 466                               KL5KUSB105A_SIO_CONFIGURE,
 467                               USB_TYPE_VENDOR | USB_DIR_OUT,
 468                               KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
 469                               0, /* index */
 470                               NULL, 0,
 471                               KLSI_TIMEOUT);
 472         if (rc < 0)
 473                     err("Disabling read failed (error = %d)", rc);
 474
 475         /* shutdown our bulk reads and writes */
 476         usb_unlink_urb (port->write_urb);
 477         usb_unlink_urb (port->read_urb);
 478         /* unlink our write pool */
 479         /* FIXME */
 480         /* wgg - do I need this? I think so. */
 481         usb_unlink_urb (port->interrupt_in_urb);
 482         info("kl5kusb105 port stats: %ld bytes in, %ld bytes out", priv->bytes_in, priv->bytes_out);
 483 } /* klsi_105_close */
 484
 485
 486 /* We need to write a complete 64-byte data block and encode the
 487  * number actually sent in the first double-byte, LSB-order. That
 488  * leaves at most 62 bytes of payload.
 489  */
 490 #define KLSI_105_DATA_OFFSET    2   /* in the bulk urb data block */
 491
 492
 493 static int klsi_105_write (struct usb_serial_port *port, int from_user,
 494                            const unsigned char *buf, int count)
 495 {
 496         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 497         int result, size;
 498         int bytes_sent=0;
 499
 500         dbg("%s - port %d", __FUNCTION__, port->number);
 501
 502         while (count > 0) {
 503                 /* try to find a free urb (write 0 bytes if none) */
 504                 struct urb *urb = NULL;
 505                 unsigned long flags;
 506                 int i;
 507                 /* since the pool is per-port we might not need the spin lock !? */
 508                 spin_lock_irqsave (&priv->lock, flags);
 509                 for (i=0; i<NUM_URBS; i++) {
 510                         if (priv->write_urb_pool[i]->status != -EINPROGRESS) {
 511                                 urb = priv->write_urb_pool[i];
 512                                 dbg("%s - using pool URB %d", __FUNCTION__, i);
 513                                 break;
 514                         }
 515                 }
 516                 spin_unlock_irqrestore (&priv->lock, flags);
 517
 518                 if (urb==NULL) {
 519                         dbg("%s - no more free urbs", __FUNCTION__);
 520                         goto exit;
 521                 }
 522
 523                 if (urb->transfer_buffer == NULL) {
 524                         urb->transfer_buffer = kmalloc (URB_TRANSFER_BUFFER_SIZE, GFP_ATOMIC);
 525                         if (urb->transfer_buffer == NULL) {
 526                                 err("%s - no more kernel memory...", __FUNCTION__);
 527                                 goto exit;
 528                         }
 529                 }
 530
 531                 size = min (count, port->bulk_out_size - KLSI_105_DATA_OFFSET);
 532                 size = min (size, URB_TRANSFER_BUFFER_SIZE - KLSI_105_DATA_OFFSET);
 533
 534                 if (from_user) {
 535                         if (copy_from_user(urb->transfer_buffer
 536                                            + KLSI_105_DATA_OFFSET, buf, size)) {
 537                                 return -EFAULT;
 538                         }
 539                 } else {
 540                         memcpy (urb->transfer_buffer + KLSI_105_DATA_OFFSET,
 541                                 buf, size);
 542                 }
 543
 544                 /* write payload size into transfer buffer */
 545                 ((__u8 *)urb->transfer_buffer)[0] = (__u8) (size & 0xFF);
 546                 ((__u8 *)urb->transfer_buffer)[1] = (__u8) ((size & 0xFF00)>>8);
 547
 548                 /* set up our urb */
 549                 usb_fill_bulk_urb(urb, port->serial->dev,
 550                               usb_sndbulkpipe(port->serial->dev,
 551                                               port->bulk_out_endpointAddress),
 552                               urb->transfer_buffer,
 553                               URB_TRANSFER_BUFFER_SIZE,
 554                               klsi_105_write_bulk_callback,
 555                               port);
 556
 557                 /* send the data out the bulk port */
 558                 result = usb_submit_urb(urb, GFP_ATOMIC);
 559                 if (result) {
 560                         err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
 561                         goto exit;
 562                 }
 563                 buf += size;
 564                 bytes_sent += size;
 565                 count -= size;
 566         }
 567 exit:
 568         /* lockless, but it's for debug info only... */
 569         priv->bytes_out+=bytes_sent;
 570
 571         return bytes_sent;      /* that's how much we wrote */
 572 } /* klsi_105_write */
 573
 574 static void klsi_105_write_bulk_callback ( struct urb *urb, struct pt_regs *regs)
 575 {
 576         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
 577
 578         dbg("%s - port %d", __FUNCTION__, port->number);
 579
 580         if (urb->status) {
 581                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__,
 582                     urb->status);
 583                 return;
 584         }
 585
 586         /* from generic_write_bulk_callback */
 587         schedule_work(&port->work);
 588 } /* klsi_105_write_bulk_completion_callback */
 589
 590
 591 /* return number of characters currently in the writing process */
 592 static int klsi_105_chars_in_buffer (struct usb_serial_port *port)
 593 {
 594         int chars = 0;
 595         int i;
 596         unsigned long flags;
 597         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 598
 599         spin_lock_irqsave (&priv->lock, flags);
 600
 601         for (i = 0; i < NUM_URBS; ++i) {
 602                 if (priv->write_urb_pool[i]->status == -EINPROGRESS) {
 603                         chars += URB_TRANSFER_BUFFER_SIZE;
 604                 }
 605         }
 606
 607         spin_unlock_irqrestore (&priv->lock, flags);
 608
 609         dbg("%s - returns %d", __FUNCTION__, chars);
 610         return (chars);
 611 }
 612
 613 static int klsi_105_write_room (struct usb_serial_port *port)
 614 {
 615         unsigned long flags;
 616         int i;
 617         int room = 0;
 618         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 619
 620         spin_lock_irqsave (&priv->lock, flags);
 621         for (i = 0; i < NUM_URBS; ++i) {
 622                 if (priv->write_urb_pool[i]->status != -EINPROGRESS) {
 623                         room += URB_TRANSFER_BUFFER_SIZE;
 624                 }
 625         }
 626
 627         spin_unlock_irqrestore (&priv->lock, flags);
 628
 629         dbg("%s - returns %d", __FUNCTION__, room);
 630         return (room);
 631 }
 632
 633
 634
 635 static void klsi_105_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
 636 {
 637         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
 638         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 639         struct tty_struct *tty;
 640         unsigned char *data = urb->transfer_buffer;
 641         int rc;
 642
 643         dbg("%s - port %d", __FUNCTION__, port->number);
 644
 645         /* The urb might have been killed. */
 646         if (urb->status) {
 647                 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__,
 648                     urb->status);
 649                 return;
 650         }
 651
 652         /* The data received is again preceded by a length double-byte in LSB-
 653          * first order (see klsi_105_write() )
 654          */
 655         if (urb->actual_length == 0) {
 656                 /* empty urbs seem to happen, we ignore them */
 657                 /* dbg("%s - emtpy URB", __FUNCTION__); */
 658                ;
 659         } else if (urb->actual_length <= 2) {
 660                 dbg("%s - size %d URB not understood", __FUNCTION__,
 661                     urb->actual_length);
 662                 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data);
 663         } else {
 664                 int i;
 665                 int bytes_sent = ((__u8 *) data)[0] +
 666                                  ((unsigned int) ((__u8 *) data)[1] << 8);
 667                 tty = port->tty;
 668                 /* we should immediately resubmit the URB, before attempting
 669                  * to pass the data on to the tty layer. But that needs locking
 670                  * against re-entry an then mixed-up data because of
 671                  * intermixed tty_flip_buffer_push()s
 672                  * FIXME
 673                  */
 674                 usb_serial_debug_data (__FILE__, __FUNCTION__,
 675                                        urb->actual_length, data);
 676
 677                 if (bytes_sent + 2 > urb->actual_length) {
 678                         dbg("%s - trying to read more data than available"
 679                             " (%d vs. %d)", __FUNCTION__,
 680                             bytes_sent+2, urb->actual_length);
 681                         /* cap at implied limit */
 682                         bytes_sent = urb->actual_length - 2;
 683                 }
 684
 685                 for (i = 2; i < 2+bytes_sent; i++) {
 686                         /* if we insert more than TTY_FLIPBUF_SIZE characters,
 687                          * we drop them. */
 688                         if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
 689                                 tty_flip_buffer_push(tty);
 690                         }
 691                         /* this doesn't actually push the data through unless
 692                          * tty->low_latency is set */
 693                         tty_insert_flip_char(tty, ((__u8*) data)[i], 0);
 694                 }
 695                 tty_flip_buffer_push(tty);
 696
 697                 /* again lockless, but debug info only */
 698                 priv->bytes_in += bytes_sent;
 699         }
 700         /* Continue trying to always read  */
 701         usb_fill_bulk_urb(port->read_urb, port->serial->dev,
 702                       usb_rcvbulkpipe(port->serial->dev,
 703                                       port->bulk_in_endpointAddress),
 704                       port->read_urb->transfer_buffer,
 705                       port->read_urb->transfer_buffer_length,
 706                       klsi_105_read_bulk_callback,
 707                       port);
 708         rc = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 709         if (rc)
 710                 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, rc);
 711 } /* klsi_105_read_bulk_callback */
 712
 713
 714 static void klsi_105_set_termios (struct usb_serial_port *port,
 715                                   struct termios *old_termios)
 716 {
 717         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 718         unsigned int iflag = port->tty->termios->c_iflag;
 719         unsigned int old_iflag = old_termios->c_iflag;
 720         unsigned int cflag = port->tty->termios->c_cflag;
 721         unsigned int old_cflag = old_termios->c_cflag;
 722         struct klsi_105_port_settings cfg;
 723         unsigned long flags;
 724
 725         /* lock while we are modifying the settings */
 726         spin_lock_irqsave (&priv->lock, flags);
 727
 728         /*
 729          * Update baud rate
 730          */
 731         if( (cflag & CBAUD) != (old_cflag & CBAUD) ) {
 732                 /* reassert DTR and (maybe) RTS on transition from B0 */
 733                 if( (old_cflag & CBAUD) == B0 ) {
 734                         dbg("%s: baud was B0", __FUNCTION__);
 735 #if 0
 736                         priv->control_state |= TIOCM_DTR;
 737                         /* don't set RTS if using hardware flow control */
 738                         if (!(old_cflag & CRTSCTS)) {
 739                                 priv->control_state |= TIOCM_RTS;
 740                         }
 741                         mct_u232_set_modem_ctrl(serial, priv->control_state);
 742 #endif
 743                 }
 744
 745                 switch(cflag & CBAUD) {
 746                 case B0: /* handled below */
 747                         break;
 748                 case B1200: priv->cfg.baudrate = kl5kusb105a_sio_b1200;
 749                         break;
 750                 case B2400: priv->cfg.baudrate = kl5kusb105a_sio_b2400;
 751                         break;
 752                 case B4800: priv->cfg.baudrate = kl5kusb105a_sio_b4800;
 753                         break;
 754                 case B9600: priv->cfg.baudrate = kl5kusb105a_sio_b9600;
 755                         break;
 756                 case B19200: priv->cfg.baudrate = kl5kusb105a_sio_b19200;
 757                         break;
 758                 case B38400: priv->cfg.baudrate = kl5kusb105a_sio_b38400;
 759                         break;
 760                 case B57600: priv->cfg.baudrate = kl5kusb105a_sio_b57600;
 761                         break;
 762                 case B115200: priv->cfg.baudrate = kl5kusb105a_sio_b115200;
 763                         break;
 764                 default:
 765                         err("KLSI USB->Serial converter:"
 766                             " unsupported baudrate request, using default"
 767                             " of 9600");
 768                         priv->cfg.baudrate = kl5kusb105a_sio_b9600;
 769                         break;
 770                 }
 771                 if ((cflag & CBAUD) == B0 ) {
 772                         dbg("%s: baud is B0", __FUNCTION__);
 773                         /* Drop RTS and DTR */
 774                         /* maybe this should be simulated by sending read
 775                          * disable and read enable messages?
 776                          */
 777                         ;
 778 #if 0
 779                         priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
 780                         mct_u232_set_modem_ctrl(serial, priv->control_state);
 781 #endif
 782                 }
 783         }
 784
 785         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 786                 /* set the number of data bits */
 787                 switch (cflag & CSIZE) {
 788                 case CS5:
 789                         dbg("%s - 5 bits/byte not supported", __FUNCTION__);
 790                         return ;
 791                 case CS6:
 792                         dbg("%s - 6 bits/byte not supported", __FUNCTION__);
 793                         return ;
 794                 case CS7:
 795                         priv->cfg.databits = kl5kusb105a_dtb_7;
 796                         break;
 797                 case CS8:
 798                         priv->cfg.databits = kl5kusb105a_dtb_8;
 799                         break;
 800                 default:
 801                         err("CSIZE was not CS5-CS8, using default of 8");
 802                         priv->cfg.databits = kl5kusb105a_dtb_8;
 803                         break;
 804                 }
 805         }
 806
 807         /*
 808          * Update line control register (LCR)
 809          */
 810         if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
 811             || (cflag & CSTOPB) != (old_cflag & CSTOPB) ) {
 812
 813 #if 0
 814                 priv->last_lcr = 0;
 815
 816                 /* set the parity */
 817                 if (cflag & PARENB)
 818                         priv->last_lcr |= (cflag & PARODD) ?
 819                                 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
 820                 else
 821                         priv->last_lcr |= MCT_U232_PARITY_NONE;
 822
 823                 /* set the number of stop bits */
 824                 priv->last_lcr |= (cflag & CSTOPB) ?
 825                         MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
 826
 827                 mct_u232_set_line_ctrl(serial, priv->last_lcr);
 828 #endif
 829                 ;
 830         }
 831
 832         /*
 833          * Set flow control: well, I do not really now how to handle DTR/RTS.
 834          * Just do what we have seen with SniffUSB on Win98.
 835          */
 836         if( (iflag & IXOFF) != (old_iflag & IXOFF)
 837             || (iflag & IXON) != (old_iflag & IXON)
 838             ||  (cflag & CRTSCTS) != (old_cflag & CRTSCTS) ) {
 839
 840                 /* Drop DTR/RTS if no flow control otherwise assert */
 841 #if 0
 842                 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS) )
 843                         priv->control_state |= TIOCM_DTR | TIOCM_RTS;
 844                 else
 845                         priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
 846                 mct_u232_set_modem_ctrl(serial, priv->control_state);
 847 #endif
 848                 ;
 849         }
 850         memcpy (&cfg, &priv->cfg, sizeof(cfg));
 851         spin_unlock_irqrestore (&priv->lock, flags);
 852
 853         /* now commit changes to device */
 854         klsi_105_chg_port_settings(port, &cfg);
 855 } /* klsi_105_set_termios */
 856
 857
 858 #if 0
 859 static void mct_u232_break_ctl( struct usb_serial_port *port, int break_state )
 860 {
 861         struct usb_serial *serial = port->serial;
 862         struct mct_u232_private *priv = (struct mct_u232_private *)port->private;
 863         unsigned char lcr = priv->last_lcr;
 864
 865         dbg("%sstate=%d", __FUNCTION__, break_state);
 866
 867         if (break_state)
 868                 lcr |= MCT_U232_SET_BREAK;
 869
 870         mct_u232_set_line_ctrl(serial, lcr);
 871 } /* mct_u232_break_ctl */
 872 #endif
 873
 874 static int klsi_105_tiocmget (struct usb_serial_port *port, struct file *file)
 875 {
 876         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 877         unsigned long flags;
 878         int rc;
 879         unsigned long line_state;
 880         dbg("%s - request, just guessing", __FUNCTION__);
 881
 882         rc = klsi_105_get_line_state(port, &line_state);
 883         if (rc < 0) {
 884                 err("Reading line control failed (error = %d)", rc);
 885                 /* better return value? EAGAIN? */
 886                 return rc;
 887         }
 888
 889         spin_lock_irqsave (&priv->lock, flags);
 890         priv->line_state = line_state;
 891         spin_unlock_irqrestore (&priv->lock, flags);
 892         dbg("%s - read line state 0x%lx", __FUNCTION__, line_state);
 893         return (int)line_state;
 894 }
 895
 896 static int klsi_105_tiocmset (struct usb_serial_port *port, struct file *file,
 897                               unsigned int set, unsigned int clear)
 898 {
 899         int retval = -EINVAL;
 900
 901         dbg("%s", __FUNCTION__);
 902
 903 /* if this ever gets implemented, it should be done something like this:
 904         struct usb_serial *serial = port->serial;
 905         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 906         unsigned long flags;
 907         int control;
 908
 909         spin_lock_irqsave (&priv->lock, flags);
 910         if (set & TIOCM_RTS)
 911                 priv->control_state |= TIOCM_RTS;
 912         if (set & TIOCM_DTR)
 913                 priv->control_state |= TIOCM_DTR;
 914         if (clear & TIOCM_RTS)
 915                 priv->control_state &= ~TIOCM_RTS;
 916         if (clear & TIOCM_DTR)
 917                 priv->control_state &= ~TIOCM_DTR;
 918         control = priv->control_state;
 919         spin_unlock_irqrestore (&priv->lock, flags);
 920         retval = mct_u232_set_modem_ctrl(serial, control);
 921 */
 922         return retval;
 923 }
 924
 925 static int klsi_105_ioctl (struct usb_serial_port *port, struct file * file,
 926                            unsigned int cmd, unsigned long arg)
 927 {
 928         struct klsi_105_private *priv = usb_get_serial_port_data(port);
 929
 930         dbg("%scmd=0x%x", __FUNCTION__, cmd);
 931
 932         /* Based on code from acm.c and others */
 933         switch (cmd) {
 934         case TIOCMIWAIT:
 935                 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
 936                 /* TODO */
 937                 dbg("%s - TIOCMIWAIT not handled", __FUNCTION__);
 938                 return -ENOIOCTLCMD;
 939
 940         case TIOCGICOUNT:
 941                 /* return count of modemline transitions */
 942                 /* TODO */
 943                 dbg("%s - TIOCGICOUNT not handled", __FUNCTION__);
 944                 return -ENOIOCTLCMD;
 945         case TCGETS: {
 946              /* return current info to caller */
 947              int retval;
 948
 949              dbg("%s - TCGETS data faked/incomplete", __FUNCTION__);
 950
 951              retval = verify_area(VERIFY_WRITE, (void *)arg,
 952                                   sizeof(struct termios));
 953
 954              if (retval)
 955                          return(retval);
 956
 957              if (kernel_termios_to_user_termios((struct termios *)arg,
 958                                                 &priv->termios))
 959                      return -EFAULT;
 960              return(0);
 961              }
 962         case TCSETS: {
 963                 /* set port termios to the one given by the user */
 964                 int retval;
 965
 966                 dbg("%s - TCSETS not handled", __FUNCTION__);
 967
 968                 retval = verify_area(VERIFY_READ, (void *)arg,
 969                                      sizeof(struct termios));
 970
 971                 if (retval)
 972                             return(retval);
 973
 974                 if (user_termios_to_kernel_termios(&priv->termios,
 975                                                   (struct termios *)arg))
 976                         return -EFAULT;
 977                 klsi_105_set_termios(port, &priv->termios);
 978                 return(0);
 979              }
 980         case TCSETSW: {
 981                 /* set port termios and try to wait for completion of last
 982                  * write operation */
 983                 /* We guess here. If there are not too many write urbs
 984                  * outstanding, we lie. */
 985                 /* what is the right way to wait here? schedule() ? */
 986                 /*
 987                 while (klsi_105_chars_in_buffer(port) > (NUM_URBS / 4 ) * URB_TRANSFER_BUFFER_SIZE)
 988                             schedule();
 989                  */
 990                 return -ENOIOCTLCMD;
 991                       }
 992         default:
 993                 dbg("%s: arg not supported - 0x%04x", __FUNCTION__,cmd);
 994                 return(-ENOIOCTLCMD);
 995                 break;
 996         }
 997         return 0;
 998 } /* klsi_105_ioctl */
 999
1000 static void klsi_105_throttle (struct usb_serial_port *port)
1001 {
1002         dbg("%s - port %d", __FUNCTION__, port->number);
1003         usb_unlink_urb (port->read_urb);
1004 }
1005
1006 static void klsi_105_unthrottle (struct usb_serial_port *port)
1007 {
1008         int result;
1009
1010         dbg("%s - port %d", __FUNCTION__, port->number);
1011
1012         port->read_urb->dev = port->serial->dev;
1013         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1014         if (result)
1015                 err("%s - failed submitting read urb, error %d", __FUNCTION__,
1016                     result);
1017 }
1018
1019
1020
1021 static int __init klsi_105_init (void)
1022 {
1023         int retval;
1024         retval = usb_serial_register(&kl5kusb105d_device);
1025         if (retval)
1026                 goto failed_usb_serial_register;
1027         retval = usb_register(&kl5kusb105d_driver);
1028         if (retval)
1029                 goto failed_usb_register;
1030
1031         info(DRIVER_DESC " " DRIVER_VERSION);
1032         return 0;
1033 failed_usb_register:
1034         usb_serial_deregister(&kl5kusb105d_device);
1035 failed_usb_serial_register:
1036         return retval;
1037 }
1038
1039
1040 static void __exit klsi_105_exit (void)
1041 {
1042         usb_deregister (&kl5kusb105d_driver);
1043         usb_serial_deregister (&kl5kusb105d_device);
1044 }
1045
1046
1047 module_init (klsi_105_init);
1048 module_exit (klsi_105_exit);
1049
1050 MODULE_AUTHOR( DRIVER_AUTHOR );
1051 MODULE_DESCRIPTION( DRIVER_DESC );
1052 MODULE_LICENSE("GPL");
1053
1054
1055 MODULE_PARM(debug, "i");
1056 MODULE_PARM_DESC(debug, "enable extensive debugging messages");
1057 /* FIXME: implement
1058 MODULE_PARM(num_urbs, "i");
1059 MODULE_PARM_DESC(num_urbs, "number of URBs to use in write pool");
1060 */
1061
1062 /* vim: set sts=8 ts=8 sw=8: */