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