drivers/usb/serial/mct_u232.c

   1 /*
   2  * MCT (Magic Control Technology Corp.) USB RS232 Converter Driver
   3  *
   4  *   Copyright (C) 2000 Wolfgang Grandegger (wolfgang@ces.ch)
   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  * This program is largely derived from the Belkin USB Serial Adapter Driver
  12  * (see belkin_sa.[ch]). All of the information about the device was acquired
  13  * by using SniffUSB on Windows98. For technical details see mct_u232.h.
  14  *
  15  * William G. Greathouse and Greg Kroah-Hartman provided great help on how to
  16  * do the reverse engineering and how to write a USB serial device driver.
  17  *
  18  * TO BE DONE, TO BE CHECKED:
  19  *   DTR/RTS signal handling may be incomplete or incorrect. I have mainly
  20  *   implemented what I have seen with SniffUSB or found in belkin_sa.c.
  21  *   For further TODOs check also belkin_sa.c.
  22  *
  23  * TEST STATUS:
  24  *   Basic tests have been performed with minicom/zmodem transfers and
  25  *   modem dialing under Linux 2.4.0-test10 (for me it works fine).
  26  *
  27  * 04-Nov-2003 Bill Marr <marr at flex dot com>
  28  *   - Mimic Windows driver by sending 2 USB 'device request' messages
  29  *     following normal 'baud rate change' message.  This allows data to be
  30  *     transmitted to RS-232 devices which don't assert the 'CTS' signal.
  31  *
  32  * 10-Nov-2001 Wolfgang Grandegger
  33  *   - Fixed an endianess problem with the baudrate selection for PowerPC.
  34  *
  35  * 06-Dec-2001 Martin Hamilton <martinh@gnu.org>
  36  *   - Added support for the Belkin F5U109 DB9 adaptor
  37  *
  38  * 30-May-2001 Greg Kroah-Hartman
  39  *   - switched from using spinlock to a semaphore, which fixes lots of
  40  *     problems.
  41  *
  42  * 04-May-2001 Stelian Pop
  43  *   - Set the maximum bulk output size for Sitecom U232-P25 model to 16 bytes
  44  *     instead of the device reported 32 (using 32 bytes causes many data
  45  *     loss, Windows driver uses 16 too).
  46  *
  47  * 02-May-2001 Stelian Pop
  48  *   - Fixed the baud calculation for Sitecom U232-P25 model
  49  *
  50  * 08-Apr-2001 gb
  51  *   - Identify version on module load.
  52  *
  53  * 06-Jan-2001 Cornel Ciocirlan
  54  *   - Added support for Sitecom U232-P25 model (Product Id 0x0230)
  55  *   - Added support for D-Link DU-H3SP USB BAY (Product Id 0x0200)
  56  *
  57  * 29-Nov-2000 Greg Kroah-Hartman
  58  *   - Added device id table to fit with 2.4.0-test11 structure.
  59  *   - took out DEAL_WITH_TWO_INT_IN_ENDPOINTS #define as it's not needed
  60  *     (lots of things will change if/when the usb-serial core changes to
  61  *     handle these issues.
  62  *
  63  * 27-Nov-2000 Wolfgang Grandegge
  64  *   A version for kernel 2.4.0-test10 released to the Linux community
  65  *   (via linux-usb-devel).
  66  */
  67
  68 #include <linux/kernel.h>
  69 #include <linux/errno.h>
  70 #include <linux/init.h>
  71 #include <linux/slab.h>
  72 #include <linux/tty.h>
  73 #include <linux/tty_driver.h>
  74 #include <linux/tty_flip.h>
  75 #include <linux/module.h>
  76 #include <linux/spinlock.h>
  77 #include <linux/uaccess.h>
  78 #include <asm/unaligned.h>
  79 #include <linux/usb.h>
  80 #include <linux/usb/serial.h>
  81 #include <linux/serial.h>
  82 #include <linux/ioctl.h>
  83 #include "mct_u232.h"
  84
  85 /*
  86  * Version Information
  87  */
  88 #define DRIVER_VERSION "z2.1"           /* Linux in-kernel version */
  89 #define DRIVER_AUTHOR "Wolfgang Grandegger <wolfgang@ces.ch>"
  90 #define DRIVER_DESC "Magic Control Technology USB-RS232 converter driver"
  91
  92 static int debug;
  93
  94 /*
  95  * Function prototypes
  96  */
  97 static int  mct_u232_startup(struct usb_serial *serial);
  98 static void mct_u232_release(struct usb_serial *serial);
  99 static int  mct_u232_open(struct tty_struct *tty, struct usb_serial_port *port);
 100 static void mct_u232_close(struct usb_serial_port *port);
 101 static void mct_u232_dtr_rts(struct usb_serial_port *port, int on);
 102 static void mct_u232_read_int_callback(struct urb *urb);
 103 static void mct_u232_set_termios(struct tty_struct *tty,
 104                         struct usb_serial_port *port, struct ktermios *old);
 105 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state);
 106 static int  mct_u232_tiocmget(struct tty_struct *tty);
 107 static int  mct_u232_tiocmset(struct tty_struct *tty,
 108                         unsigned int set, unsigned int clear);
 109 static int  mct_u232_ioctl(struct tty_struct *tty,
 110                         unsigned int cmd, unsigned long arg);
 111 static int  mct_u232_get_icount(struct tty_struct *tty,
 112                         struct serial_icounter_struct *icount);
 113 static void mct_u232_throttle(struct tty_struct *tty);
 114 static void mct_u232_unthrottle(struct tty_struct *tty);
 115
 116
 117 /*
 118  * All of the device info needed for the MCT USB-RS232 converter.
 119  */
 120 static const struct usb_device_id id_table_combined[] = {
 121         { USB_DEVICE(MCT_U232_VID, MCT_U232_PID) },
 122         { USB_DEVICE(MCT_U232_VID, MCT_U232_SITECOM_PID) },
 123         { USB_DEVICE(MCT_U232_VID, MCT_U232_DU_H3SP_PID) },
 124         { USB_DEVICE(MCT_U232_BELKIN_F5U109_VID, MCT_U232_BELKIN_F5U109_PID) },
 125         { }             /* Terminating entry */
 126 };
 127
 128 MODULE_DEVICE_TABLE(usb, id_table_combined);
 129
 130 static struct usb_driver mct_u232_driver = {
 131         .name =         "mct_u232",
 132         .probe =        usb_serial_probe,
 133         .disconnect =   usb_serial_disconnect,
 134         .id_table =     id_table_combined,
 135         .no_dynamic_id =        1,
 136 };
 137
 138 static struct usb_serial_driver mct_u232_device = {
 139         .driver = {
 140                 .owner =        THIS_MODULE,
 141                 .name =         "mct_u232",
 142         },
 143         .description =       "MCT U232",
 144         .usb_driver =        &mct_u232_driver,
 145         .id_table =          id_table_combined,
 146         .num_ports =         1,
 147         .open =              mct_u232_open,
 148         .close =             mct_u232_close,
 149         .dtr_rts =           mct_u232_dtr_rts,
 150         .throttle =          mct_u232_throttle,
 151         .unthrottle =        mct_u232_unthrottle,
 152         .read_int_callback = mct_u232_read_int_callback,
 153         .set_termios =       mct_u232_set_termios,
 154         .break_ctl =         mct_u232_break_ctl,
 155         .tiocmget =          mct_u232_tiocmget,
 156         .tiocmset =          mct_u232_tiocmset,
 157         .attach =            mct_u232_startup,
 158         .release =           mct_u232_release,
 159         .ioctl =             mct_u232_ioctl,
 160         .get_icount =        mct_u232_get_icount,
 161 };
 162
 163 struct mct_u232_private {
 164         spinlock_t lock;
 165         unsigned int         control_state; /* Modem Line Setting (TIOCM) */
 166         unsigned char        last_lcr;      /* Line Control Register */
 167         unsigned char        last_lsr;      /* Line Status Register */
 168         unsigned char        last_msr;      /* Modem Status Register */
 169         unsigned int         rx_flags;      /* Throttling flags */
 170         struct async_icount  icount;
 171         wait_queue_head_t    msr_wait;  /* for handling sleeping while waiting
 172                                                 for msr change to happen */
 173 };
 174
 175 #define THROTTLED               0x01
 176
 177 /*
 178  * Handle vendor specific USB requests
 179  */
 180
 181 #define WDR_TIMEOUT 5000 /* default urb timeout */
 182
 183 /*
 184  * Later day 2.6.0-test kernels have new baud rates like B230400 which
 185  * we do not know how to support. We ignore them for the moment.
 186  */
 187 static int mct_u232_calculate_baud_rate(struct usb_serial *serial,
 188                                         speed_t value, speed_t *result)
 189 {
 190         *result = value;
 191
 192         if (le16_to_cpu(serial->dev->descriptor.idProduct) == MCT_U232_SITECOM_PID
 193                 || le16_to_cpu(serial->dev->descriptor.idProduct) == MCT_U232_BELKIN_F5U109_PID) {
 194                 switch (value) {
 195                 case 300:
 196                         return 0x01;
 197                 case 600:
 198                         return 0x02; /* this one not tested */
 199                 case 1200:
 200                         return 0x03;
 201                 case 2400:
 202                         return 0x04;
 203                 case 4800:
 204                         return 0x06;
 205                 case 9600:
 206                         return 0x08;
 207                 case 19200:
 208                         return 0x09;
 209                 case 38400:
 210                         return 0x0a;
 211                 case 57600:
 212                         return 0x0b;
 213                 case 115200:
 214                         return 0x0c;
 215                 default:
 216                         *result = 9600;
 217                         return 0x08;
 218                 }
 219         } else {
 220                 /* FIXME: Can we use any divider - should we do
 221                    divider = 115200/value;
 222                    real baud = 115200/divider */
 223                 switch (value) {
 224                 case 300: break;
 225                 case 600: break;
 226                 case 1200: break;
 227                 case 2400: break;
 228                 case 4800: break;
 229                 case 9600: break;
 230                 case 19200: break;
 231                 case 38400: break;
 232                 case 57600: break;
 233                 case 115200: break;
 234                 default:
 235                         value = 9600;
 236                         *result = 9600;
 237                 }
 238                 return 115200/value;
 239         }
 240 }
 241
 242 static int mct_u232_set_baud_rate(struct tty_struct *tty,
 243         struct usb_serial *serial, struct usb_serial_port *port, speed_t value)
 244 {
 245         unsigned int divisor;
 246         int rc;
 247         unsigned char *buf;
 248         unsigned char cts_enable_byte = 0;
 249         speed_t speed;
 250
 251         buf = kmalloc(MCT_U232_MAX_SIZE, GFP_KERNEL);
 252         if (buf == NULL)
 253                 return -ENOMEM;
 254
 255         divisor = mct_u232_calculate_baud_rate(serial, value, &speed);
 256         put_unaligned_le32(cpu_to_le32(divisor), buf);
 257         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 258                                 MCT_U232_SET_BAUD_RATE_REQUEST,
 259                                 MCT_U232_SET_REQUEST_TYPE,
 260                                 0, 0, buf, MCT_U232_SET_BAUD_RATE_SIZE,
 261                                 WDR_TIMEOUT);
 262         if (rc < 0)     /*FIXME: What value speed results */
 263                 dev_err(&port->dev, "Set BAUD RATE %d failed (error = %d)\n",
 264                         value, rc);
 265         else
 266                 tty_encode_baud_rate(tty, speed, speed);
 267         dbg("set_baud_rate: value: 0x%x, divisor: 0x%x", value, divisor);
 268
 269         /* Mimic the MCT-supplied Windows driver (version 1.21P.0104), which
 270            always sends two extra USB 'device request' messages after the
 271            'baud rate change' message.  The actual functionality of the
 272            request codes in these messages is not fully understood but these
 273            particular codes are never seen in any operation besides a baud
 274            rate change.  Both of these messages send a single byte of data.
 275            In the first message, the value of this byte is always zero.
 276
 277            The second message has been determined experimentally to control
 278            whether data will be transmitted to a device which is not asserting
 279            the 'CTS' signal.  If the second message's data byte is zero, data
 280            will be transmitted even if 'CTS' is not asserted (i.e. no hardware
 281            flow control).  if the second message's data byte is nonzero (a
 282            value of 1 is used by this driver), data will not be transmitted to
 283            a device which is not asserting 'CTS'.
 284         */
 285
 286         buf[0] = 0;
 287         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 288                                 MCT_U232_SET_UNKNOWN1_REQUEST,
 289                                 MCT_U232_SET_REQUEST_TYPE,
 290                                 0, 0, buf, MCT_U232_SET_UNKNOWN1_SIZE,
 291                                 WDR_TIMEOUT);
 292         if (rc < 0)
 293                 dev_err(&port->dev, "Sending USB device request code %d "
 294                         "failed (error = %d)\n", MCT_U232_SET_UNKNOWN1_REQUEST,
 295                         rc);
 296
 297         if (port && C_CRTSCTS(tty))
 298            cts_enable_byte = 1;
 299
 300         dbg("set_baud_rate: send second control message, data = %02X",
 301                                                         cts_enable_byte);
 302         buf[0] = cts_enable_byte;
 303         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 304                         MCT_U232_SET_CTS_REQUEST,
 305                         MCT_U232_SET_REQUEST_TYPE,
 306                         0, 0, buf, MCT_U232_SET_CTS_SIZE,
 307                         WDR_TIMEOUT);
 308         if (rc < 0)
 309                 dev_err(&port->dev, "Sending USB device request code %d "
 310                         "failed (error = %d)\n", MCT_U232_SET_CTS_REQUEST, rc);
 311
 312         kfree(buf);
 313         return rc;
 314 } /* mct_u232_set_baud_rate */
 315
 316 static int mct_u232_set_line_ctrl(struct usb_serial *serial, unsigned char lcr)
 317 {
 318         int rc;
 319         unsigned char *buf;
 320
 321         buf = kmalloc(MCT_U232_MAX_SIZE, GFP_KERNEL);
 322         if (buf == NULL)
 323                 return -ENOMEM;
 324
 325         buf[0] = lcr;
 326         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 327                         MCT_U232_SET_LINE_CTRL_REQUEST,
 328                         MCT_U232_SET_REQUEST_TYPE,
 329                         0, 0, buf, MCT_U232_SET_LINE_CTRL_SIZE,
 330                         WDR_TIMEOUT);
 331         if (rc < 0)
 332                 dev_err(&serial->dev->dev,
 333                         "Set LINE CTRL 0x%x failed (error = %d)\n", lcr, rc);
 334         dbg("set_line_ctrl: 0x%x", lcr);
 335         kfree(buf);
 336         return rc;
 337 } /* mct_u232_set_line_ctrl */
 338
 339 static int mct_u232_set_modem_ctrl(struct usb_serial *serial,
 340                                    unsigned int control_state)
 341 {
 342         int rc;
 343         unsigned char mcr;
 344         unsigned char *buf;
 345
 346         buf = kmalloc(MCT_U232_MAX_SIZE, GFP_KERNEL);
 347         if (buf == NULL)
 348                 return -ENOMEM;
 349
 350         mcr = MCT_U232_MCR_NONE;
 351         if (control_state & TIOCM_DTR)
 352                 mcr |= MCT_U232_MCR_DTR;
 353         if (control_state & TIOCM_RTS)
 354                 mcr |= MCT_U232_MCR_RTS;
 355
 356         buf[0] = mcr;
 357         rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 358                         MCT_U232_SET_MODEM_CTRL_REQUEST,
 359                         MCT_U232_SET_REQUEST_TYPE,
 360                         0, 0, buf, MCT_U232_SET_MODEM_CTRL_SIZE,
 361                         WDR_TIMEOUT);
 362         kfree(buf);
 363
 364         dbg("set_modem_ctrl: state=0x%x ==> mcr=0x%x", control_state, mcr);
 365
 366         if (rc < 0) {
 367                 dev_err(&serial->dev->dev,
 368                         "Set MODEM CTRL 0x%x failed (error = %d)\n", mcr, rc);
 369                 return rc;
 370         }
 371         return 0;
 372 } /* mct_u232_set_modem_ctrl */
 373
 374 static int mct_u232_get_modem_stat(struct usb_serial *serial,
 375                                                 unsigned char *msr)
 376 {
 377         int rc;
 378         unsigned char *buf;
 379
 380         buf = kmalloc(MCT_U232_MAX_SIZE, GFP_KERNEL);
 381         if (buf == NULL) {
 382                 *msr = 0;
 383                 return -ENOMEM;
 384         }
 385         rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 386                         MCT_U232_GET_MODEM_STAT_REQUEST,
 387                         MCT_U232_GET_REQUEST_TYPE,
 388                         0, 0, buf, MCT_U232_GET_MODEM_STAT_SIZE,
 389                         WDR_TIMEOUT);
 390         if (rc < 0) {
 391                 dev_err(&serial->dev->dev,
 392                         "Get MODEM STATus failed (error = %d)\n", rc);
 393                 *msr = 0;
 394         } else {
 395                 *msr = buf[0];
 396         }
 397         dbg("get_modem_stat: 0x%x", *msr);
 398         kfree(buf);
 399         return rc;
 400 } /* mct_u232_get_modem_stat */
 401
 402 static void mct_u232_msr_to_icount(struct async_icount *icount,
 403                                                 unsigned char msr)
 404 {
 405         /* Translate Control Line states */
 406         if (msr & MCT_U232_MSR_DDSR)
 407                 icount->dsr++;
 408         if (msr & MCT_U232_MSR_DCTS)
 409                 icount->cts++;
 410         if (msr & MCT_U232_MSR_DRI)
 411                 icount->rng++;
 412         if (msr & MCT_U232_MSR_DCD)
 413                 icount->dcd++;
 414 } /* mct_u232_msr_to_icount */
 415
 416 static void mct_u232_msr_to_state(unsigned int *control_state,
 417                                                 unsigned char msr)
 418 {
 419         /* Translate Control Line states */
 420         if (msr & MCT_U232_MSR_DSR)
 421                 *control_state |=  TIOCM_DSR;
 422         else
 423                 *control_state &= ~TIOCM_DSR;
 424         if (msr & MCT_U232_MSR_CTS)
 425                 *control_state |=  TIOCM_CTS;
 426         else
 427                 *control_state &= ~TIOCM_CTS;
 428         if (msr & MCT_U232_MSR_RI)
 429                 *control_state |=  TIOCM_RI;
 430         else
 431                 *control_state &= ~TIOCM_RI;
 432         if (msr & MCT_U232_MSR_CD)
 433                 *control_state |=  TIOCM_CD;
 434         else
 435                 *control_state &= ~TIOCM_CD;
 436         dbg("msr_to_state: msr=0x%x ==> state=0x%x", msr, *control_state);
 437 } /* mct_u232_msr_to_state */
 438
 439 /*
 440  * Driver's tty interface functions
 441  */
 442
 443 static int mct_u232_startup(struct usb_serial *serial)
 444 {
 445         struct mct_u232_private *priv;
 446         struct usb_serial_port *port, *rport;
 447
 448         priv = kzalloc(sizeof(struct mct_u232_private), GFP_KERNEL);
 449         if (!priv)
 450                 return -ENOMEM;
 451         spin_lock_init(&priv->lock);
 452         init_waitqueue_head(&priv->msr_wait);
 453         usb_set_serial_port_data(serial->port[0], priv);
 454
 455         init_waitqueue_head(&serial->port[0]->write_wait);
 456
 457         /* Puh, that's dirty */
 458         port = serial->port[0];
 459         rport = serial->port[1];
 460         /* No unlinking, it wasn't submitted yet. */
 461         usb_free_urb(port->read_urb);
 462         port->read_urb = rport->interrupt_in_urb;
 463         rport->interrupt_in_urb = NULL;
 464         port->read_urb->context = port;
 465
 466         return 0;
 467 } /* mct_u232_startup */
 468
 469
 470 static void mct_u232_release(struct usb_serial *serial)
 471 {
 472         struct mct_u232_private *priv;
 473         int i;
 474
 475         dbg("%s", __func__);
 476
 477         for (i = 0; i < serial->num_ports; ++i) {
 478                 /* My special items, the standard routines free my urbs */
 479                 priv = usb_get_serial_port_data(serial->port[i]);
 480                 kfree(priv);
 481         }
 482 } /* mct_u232_release */
 483
 484 static int  mct_u232_open(struct tty_struct *tty, struct usb_serial_port *port)
 485 {
 486         struct usb_serial *serial = port->serial;
 487         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 488         int retval = 0;
 489         unsigned int control_state;
 490         unsigned long flags;
 491         unsigned char last_lcr;
 492         unsigned char last_msr;
 493
 494         dbg("%s port %d", __func__, port->number);
 495
 496         /* Compensate for a hardware bug: although the Sitecom U232-P25
 497          * device reports a maximum output packet size of 32 bytes,
 498          * it seems to be able to accept only 16 bytes (and that's what
 499          * SniffUSB says too...)
 500          */
 501         if (le16_to_cpu(serial->dev->descriptor.idProduct)
 502                                                 == MCT_U232_SITECOM_PID)
 503                 port->bulk_out_size = 16;
 504
 505         /* Do a defined restart: the normal serial device seems to
 506          * always turn on DTR and RTS here, so do the same. I'm not
 507          * sure if this is really necessary. But it should not harm
 508          * either.
 509          */
 510         spin_lock_irqsave(&priv->lock, flags);
 511         if (tty && (tty->termios->c_cflag & CBAUD))
 512                 priv->control_state = TIOCM_DTR | TIOCM_RTS;
 513         else
 514                 priv->control_state = 0;
 515
 516         priv->last_lcr = (MCT_U232_DATA_BITS_8 |
 517                           MCT_U232_PARITY_NONE |
 518                           MCT_U232_STOP_BITS_1);
 519         control_state = priv->control_state;
 520         last_lcr = priv->last_lcr;
 521         spin_unlock_irqrestore(&priv->lock, flags);
 522         mct_u232_set_modem_ctrl(serial, control_state);
 523         mct_u232_set_line_ctrl(serial, last_lcr);
 524
 525         /* Read modem status and update control state */
 526         mct_u232_get_modem_stat(serial, &last_msr);
 527         spin_lock_irqsave(&priv->lock, flags);
 528         priv->last_msr = last_msr;
 529         mct_u232_msr_to_state(&priv->control_state, priv->last_msr);
 530         spin_unlock_irqrestore(&priv->lock, flags);
 531
 532         port->read_urb->dev = port->serial->dev;
 533         retval = usb_submit_urb(port->read_urb, GFP_KERNEL);
 534         if (retval) {
 535                 dev_err(&port->dev,
 536                         "usb_submit_urb(read bulk) failed pipe 0x%x err %d\n",
 537                         port->read_urb->pipe, retval);
 538                 goto error;
 539         }
 540
 541         port->interrupt_in_urb->dev = port->serial->dev;
 542         retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 543         if (retval) {
 544                 usb_kill_urb(port->read_urb);
 545                 dev_err(&port->dev,
 546                         "usb_submit_urb(read int) failed pipe 0x%x err %d",
 547                         port->interrupt_in_urb->pipe, retval);
 548                 goto error;
 549         }
 550         return 0;
 551
 552 error:
 553         return retval;
 554 } /* mct_u232_open */
 555
 556 static void mct_u232_dtr_rts(struct usb_serial_port *port, int on)
 557 {
 558         unsigned int control_state;
 559         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 560
 561         mutex_lock(&port->serial->disc_mutex);
 562         if (!port->serial->disconnected) {
 563                 /* drop DTR and RTS */
 564                 spin_lock_irq(&priv->lock);
 565                 if (on)
 566                         priv->control_state |= TIOCM_DTR | TIOCM_RTS;
 567                 else
 568                         priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
 569                 control_state = priv->control_state;
 570                 spin_unlock_irq(&priv->lock);
 571                 mct_u232_set_modem_ctrl(port->serial, control_state);
 572         }
 573         mutex_unlock(&port->serial->disc_mutex);
 574 }
 575
 576 static void mct_u232_close(struct usb_serial_port *port)
 577 {
 578         dbg("%s port %d", __func__, port->number);
 579
 580         if (port->serial->dev) {
 581                 /* shutdown our urbs */
 582                 usb_kill_urb(port->write_urb);
 583                 usb_kill_urb(port->read_urb);
 584                 usb_kill_urb(port->interrupt_in_urb);
 585         }
 586 } /* mct_u232_close */
 587
 588
 589 static void mct_u232_read_int_callback(struct urb *urb)
 590 {
 591         struct usb_serial_port *port = urb->context;
 592         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 593         struct usb_serial *serial = port->serial;
 594         struct tty_struct *tty;
 595         unsigned char *data = urb->transfer_buffer;
 596         int retval;
 597         int status = urb->status;
 598         unsigned long flags;
 599
 600         switch (status) {
 601         case 0:
 602                 /* success */
 603                 break;
 604         case -ECONNRESET:
 605         case -ENOENT:
 606         case -ESHUTDOWN:
 607                 /* this urb is terminated, clean up */
 608                 dbg("%s - urb shutting down with status: %d",
 609                     __func__, status);
 610                 return;
 611         default:
 612                 dbg("%s - nonzero urb status received: %d",
 613                     __func__, status);
 614                 goto exit;
 615         }
 616
 617         if (!serial) {
 618                 dbg("%s - bad serial pointer, exiting", __func__);
 619                 return;
 620         }
 621
 622         dbg("%s - port %d", __func__, port->number);
 623         usb_serial_debug_data(debug, &port->dev, __func__,
 624                                         urb->actual_length, data);
 625
 626         /*
 627          * Work-a-round: handle the 'usual' bulk-in pipe here
 628          */
 629         if (urb->transfer_buffer_length > 2) {
 630                 if (urb->actual_length) {
 631                         tty = tty_port_tty_get(&port->port);
 632                         if (tty) {
 633                                 tty_insert_flip_string(tty, data,
 634                                                 urb->actual_length);
 635                                 tty_flip_buffer_push(tty);
 636                         }
 637                         tty_kref_put(tty);
 638                 }
 639                 goto exit;
 640         }
 641
 642         /*
 643          * The interrupt-in pipe signals exceptional conditions (modem line
 644          * signal changes and errors). data[0] holds MSR, data[1] holds LSR.
 645          */
 646         spin_lock_irqsave(&priv->lock, flags);
 647         priv->last_msr = data[MCT_U232_MSR_INDEX];
 648
 649         /* Record Control Line states */
 650         mct_u232_msr_to_state(&priv->control_state, priv->last_msr);
 651
 652         mct_u232_msr_to_icount(&priv->icount, priv->last_msr);
 653
 654 #if 0
 655         /* Not yet handled. See belkin_sa.c for further information */
 656         /* Now to report any errors */
 657         priv->last_lsr = data[MCT_U232_LSR_INDEX];
 658         /*
 659          * fill in the flip buffer here, but I do not know the relation
 660          * to the current/next receive buffer or characters.  I need
 661          * to look in to this before committing any code.
 662          */
 663         if (priv->last_lsr & MCT_U232_LSR_ERR) {
 664                 tty = tty_port_tty_get(&port->port);
 665                 /* Overrun Error */
 666                 if (priv->last_lsr & MCT_U232_LSR_OE) {
 667                 }
 668                 /* Parity Error */
 669                 if (priv->last_lsr & MCT_U232_LSR_PE) {
 670                 }
 671                 /* Framing Error */
 672                 if (priv->last_lsr & MCT_U232_LSR_FE) {
 673                 }
 674                 /* Break Indicator */
 675                 if (priv->last_lsr & MCT_U232_LSR_BI) {
 676                 }
 677                 tty_kref_put(tty);
 678         }
 679 #endif
 680         wake_up_interruptible(&priv->msr_wait);
 681         spin_unlock_irqrestore(&priv->lock, flags);
 682 exit:
 683         retval = usb_submit_urb(urb, GFP_ATOMIC);
 684         if (retval)
 685                 dev_err(&port->dev,
 686                         "%s - usb_submit_urb failed with result %d\n",
 687                         __func__, retval);
 688 } /* mct_u232_read_int_callback */
 689
 690 static void mct_u232_set_termios(struct tty_struct *tty,
 691                                  struct usb_serial_port *port,
 692                                  struct ktermios *old_termios)
 693 {
 694         struct usb_serial *serial = port->serial;
 695         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 696         struct ktermios *termios = tty->termios;
 697         unsigned int cflag = termios->c_cflag;
 698         unsigned int old_cflag = old_termios->c_cflag;
 699         unsigned long flags;
 700         unsigned int control_state;
 701         unsigned char last_lcr;
 702
 703         /* get a local copy of the current port settings */
 704         spin_lock_irqsave(&priv->lock, flags);
 705         control_state = priv->control_state;
 706         spin_unlock_irqrestore(&priv->lock, flags);
 707         last_lcr = 0;
 708
 709         /*
 710          * Update baud rate.
 711          * Do not attempt to cache old rates and skip settings,
 712          * disconnects screw such tricks up completely.
 713          * Premature optimization is the root of all evil.
 714          */
 715
 716         /* reassert DTR and RTS on transition from B0 */
 717         if ((old_cflag & CBAUD) == B0) {
 718                 dbg("%s: baud was B0", __func__);
 719                 control_state |= TIOCM_DTR | TIOCM_RTS;
 720                 mct_u232_set_modem_ctrl(serial, control_state);
 721         }
 722
 723         mct_u232_set_baud_rate(tty, serial, port, tty_get_baud_rate(tty));
 724
 725         if ((cflag & CBAUD) == B0) {
 726                 dbg("%s: baud is B0", __func__);
 727                 /* Drop RTS and DTR */
 728                 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
 729                 mct_u232_set_modem_ctrl(serial, control_state);
 730         }
 731
 732         /*
 733          * Update line control register (LCR)
 734          */
 735
 736         /* set the parity */
 737         if (cflag & PARENB)
 738                 last_lcr |= (cflag & PARODD) ?
 739                         MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
 740         else
 741                 last_lcr |= MCT_U232_PARITY_NONE;
 742
 743         /* set the number of data bits */
 744         switch (cflag & CSIZE) {
 745         case CS5:
 746                 last_lcr |= MCT_U232_DATA_BITS_5; break;
 747         case CS6:
 748                 last_lcr |= MCT_U232_DATA_BITS_6; break;
 749         case CS7:
 750                 last_lcr |= MCT_U232_DATA_BITS_7; break;
 751         case CS8:
 752                 last_lcr |= MCT_U232_DATA_BITS_8; break;
 753         default:
 754                 dev_err(&port->dev,
 755                         "CSIZE was not CS5-CS8, using default of 8\n");
 756                 last_lcr |= MCT_U232_DATA_BITS_8;
 757                 break;
 758         }
 759
 760         termios->c_cflag &= ~CMSPAR;
 761
 762         /* set the number of stop bits */
 763         last_lcr |= (cflag & CSTOPB) ?
 764                 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
 765
 766         mct_u232_set_line_ctrl(serial, last_lcr);
 767
 768         /* save off the modified port settings */
 769         spin_lock_irqsave(&priv->lock, flags);
 770         priv->control_state = control_state;
 771         priv->last_lcr = last_lcr;
 772         spin_unlock_irqrestore(&priv->lock, flags);
 773 } /* mct_u232_set_termios */
 774
 775 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
 776 {
 777         struct usb_serial_port *port = tty->driver_data;
 778         struct usb_serial *serial = port->serial;
 779         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 780         unsigned char lcr;
 781         unsigned long flags;
 782
 783         dbg("%sstate=%d", __func__, break_state);
 784
 785         spin_lock_irqsave(&priv->lock, flags);
 786         lcr = priv->last_lcr;
 787
 788         if (break_state)
 789                 lcr |= MCT_U232_SET_BREAK;
 790         spin_unlock_irqrestore(&priv->lock, flags);
 791
 792         mct_u232_set_line_ctrl(serial, lcr);
 793 } /* mct_u232_break_ctl */
 794
 795
 796 static int mct_u232_tiocmget(struct tty_struct *tty)
 797 {
 798         struct usb_serial_port *port = tty->driver_data;
 799         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 800         unsigned int control_state;
 801         unsigned long flags;
 802
 803         dbg("%s", __func__);
 804
 805         spin_lock_irqsave(&priv->lock, flags);
 806         control_state = priv->control_state;
 807         spin_unlock_irqrestore(&priv->lock, flags);
 808
 809         return control_state;
 810 }
 811
 812 static int mct_u232_tiocmset(struct tty_struct *tty,
 813                               unsigned int set, unsigned int clear)
 814 {
 815         struct usb_serial_port *port = tty->driver_data;
 816         struct usb_serial *serial = port->serial;
 817         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 818         unsigned int control_state;
 819         unsigned long flags;
 820
 821         dbg("%s", __func__);
 822
 823         spin_lock_irqsave(&priv->lock, flags);
 824         control_state = priv->control_state;
 825
 826         if (set & TIOCM_RTS)
 827                 control_state |= TIOCM_RTS;
 828         if (set & TIOCM_DTR)
 829                 control_state |= TIOCM_DTR;
 830         if (clear & TIOCM_RTS)
 831                 control_state &= ~TIOCM_RTS;
 832         if (clear & TIOCM_DTR)
 833                 control_state &= ~TIOCM_DTR;
 834
 835         priv->control_state = control_state;
 836         spin_unlock_irqrestore(&priv->lock, flags);
 837         return mct_u232_set_modem_ctrl(serial, control_state);
 838 }
 839
 840 static void mct_u232_throttle(struct tty_struct *tty)
 841 {
 842         struct usb_serial_port *port = tty->driver_data;
 843         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 844         unsigned int control_state;
 845
 846         dbg("%s - port %d", __func__, port->number);
 847
 848         spin_lock_irq(&priv->lock);
 849         priv->rx_flags |= THROTTLED;
 850         if (C_CRTSCTS(tty)) {
 851                 priv->control_state &= ~TIOCM_RTS;
 852                 control_state = priv->control_state;
 853                 spin_unlock_irq(&priv->lock);
 854                 (void) mct_u232_set_modem_ctrl(port->serial, control_state);
 855         } else {
 856                 spin_unlock_irq(&priv->lock);
 857         }
 858 }
 859
 860 static void mct_u232_unthrottle(struct tty_struct *tty)
 861 {
 862         struct usb_serial_port *port = tty->driver_data;
 863         struct mct_u232_private *priv = usb_get_serial_port_data(port);
 864         unsigned int control_state;
 865
 866         dbg("%s - port %d", __func__, port->number);
 867
 868         spin_lock_irq(&priv->lock);
 869         if ((priv->rx_flags & THROTTLED) && C_CRTSCTS(tty)) {
 870                 priv->rx_flags &= ~THROTTLED;
 871                 priv->control_state |= TIOCM_RTS;
 872                 control_state = priv->control_state;
 873                 spin_unlock_irq(&priv->lock);
 874                 (void) mct_u232_set_modem_ctrl(port->serial, control_state);
 875         } else {
 876                 spin_unlock_irq(&priv->lock);
 877         }
 878 }
 879
 880 static int  mct_u232_ioctl(struct tty_struct *tty,
 881                         unsigned int cmd, unsigned long arg)
 882 {
 883         DEFINE_WAIT(wait);
 884         struct usb_serial_port *port = tty->driver_data;
 885         struct mct_u232_private *mct_u232_port = usb_get_serial_port_data(port);
 886         struct async_icount cnow, cprev;
 887         unsigned long flags;
 888
 889         dbg("%s - port %d, cmd = 0x%x", __func__, port->number, cmd);
 890
 891         switch (cmd) {
 892
 893         case TIOCMIWAIT:
 894
 895                 dbg("%s (%d) TIOCMIWAIT", __func__,  port->number);
 896
 897                 spin_lock_irqsave(&mct_u232_port->lock, flags);
 898                 cprev = mct_u232_port->icount;
 899                 spin_unlock_irqrestore(&mct_u232_port->lock, flags);
 900                 for ( ; ; ) {
 901                         prepare_to_wait(&mct_u232_port->msr_wait,
 902                                         &wait, TASK_INTERRUPTIBLE);
 903                         schedule();
 904                         finish_wait(&mct_u232_port->msr_wait, &wait);
 905                         /* see if a signal did it */
 906                         if (signal_pending(current))
 907                                 return -ERESTARTSYS;
 908                         spin_lock_irqsave(&mct_u232_port->lock, flags);
 909                         cnow = mct_u232_port->icount;
 910                         spin_unlock_irqrestore(&mct_u232_port->lock, flags);
 911                         if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
 912                             cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
 913                                 return -EIO; /* no change => error */
 914                         if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
 915                             ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
 916                             ((arg & TIOCM_CD)  && (cnow.dcd != cprev.dcd)) ||
 917                             ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
 918                                 return 0;
 919                         }
 920                         cprev = cnow;
 921                 }
 922
 923         }
 924         return -ENOIOCTLCMD;
 925 }
 926
 927 static int  mct_u232_get_icount(struct tty_struct *tty,
 928                         struct serial_icounter_struct *icount)
 929 {
 930         struct usb_serial_port *port = tty->driver_data;
 931         struct mct_u232_private *mct_u232_port = usb_get_serial_port_data(port);
 932         struct async_icount *ic = &mct_u232_port->icount;
 933         unsigned long flags;
 934
 935         spin_lock_irqsave(&mct_u232_port->lock, flags);
 936
 937         icount->cts = ic->cts;
 938         icount->dsr = ic->dsr;
 939         icount->rng = ic->rng;
 940         icount->dcd = ic->dcd;
 941         icount->rx = ic->rx;
 942         icount->tx = ic->tx;
 943         icount->frame = ic->frame;
 944         icount->overrun = ic->overrun;
 945         icount->parity = ic->parity;
 946         icount->brk = ic->brk;
 947         icount->buf_overrun = ic->buf_overrun;
 948
 949         spin_unlock_irqrestore(&mct_u232_port->lock, flags);
 950
 951         dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d",
 952                 __func__,  port->number, icount->rx, icount->tx);
 953         return 0;
 954 }
 955
 956 static int __init mct_u232_init(void)
 957 {
 958         int retval;
 959         retval = usb_serial_register(&mct_u232_device);
 960         if (retval)
 961                 goto failed_usb_serial_register;
 962         retval = usb_register(&mct_u232_driver);
 963         if (retval)
 964                 goto failed_usb_register;
 965         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 966                DRIVER_DESC "\n");
 967         return 0;
 968 failed_usb_register:
 969         usb_serial_deregister(&mct_u232_device);
 970 failed_usb_serial_register:
 971         return retval;
 972 }
 973
 974
 975 static void __exit mct_u232_exit(void)
 976 {
 977         usb_deregister(&mct_u232_driver);
 978         usb_serial_deregister(&mct_u232_device);
 979 }
 980
 981 module_init(mct_u232_init);
 982 module_exit(mct_u232_exit);
 983
 984 MODULE_AUTHOR(DRIVER_AUTHOR);
 985 MODULE_DESCRIPTION(DRIVER_DESC);
 986 MODULE_LICENSE("GPL");
 987
 988 module_param(debug, bool, S_IRUGO | S_IWUSR);
 989 MODULE_PARM_DESC(debug, "Debug enabled or not");