drivers/usb/serial/ark3116.c

   1 /*
   2  * Copyright (C) 2009 by Bart Hartgers (bart.hartgers+ark3116@gmail.com)
   3  * Original version:
   4  * Copyright (C) 2006
   5  *   Simon Schulz (ark3116_driver <at> auctionant.de)
   6  *
   7  * ark3116
   8  * - implements a driver for the arkmicro ark3116 chipset (vendor=0x6547,
   9  *   productid=0x0232) (used in a datacable called KQ-U8A)
  10  *
  11  * Supports full modem status lines, break, hardware flow control. Does not
  12  * support software flow control, since I do not know how to enable it in hw.
  13  *
  14  * This driver is a essentially new implementation. I initially dug
  15  * into the old ark3116.c driver and suddenly realized the ark3116 is
  16  * a 16450 with a USB interface glued to it. See comments at the
  17  * bottom of this file.
  18  *
  19  * This program is free software; you can redistribute it and/or modify it
  20  * under the terms of the GNU General Public License as published by the
  21  * Free Software Foundation; either version 2 of the License, or (at your
  22  * option) any later version.
  23  */
  24
  25 #include <linux/kernel.h>
  26 #include <linux/ioctl.h>
  27 #include <linux/tty.h>
  28 #include <linux/slab.h>
  29 #include <linux/tty_flip.h>
  30 #include <linux/module.h>
  31 #include <linux/usb.h>
  32 #include <linux/usb/serial.h>
  33 #include <linux/serial.h>
  34 #include <linux/serial_reg.h>
  35 #include <linux/uaccess.h>
  36 #include <linux/mutex.h>
  37 #include <linux/spinlock.h>
  38
  39 #define DRIVER_AUTHOR "Bart Hartgers <bart.hartgers+ark3116@gmail.com>"
  40 #define DRIVER_DESC "USB ARK3116 serial/IrDA driver"
  41 #define DRIVER_DEV_DESC "ARK3116 RS232/IrDA"
  42 #define DRIVER_NAME "ark3116"
  43
  44 /* usb timeout of 1 second */
  45 #define ARK_TIMEOUT 1000
  46
  47 static const struct usb_device_id id_table[] = {
  48         { USB_DEVICE(0x6547, 0x0232) },
  49         { USB_DEVICE(0x18ec, 0x3118) },         /* USB to IrDA adapter */
  50         { },
  51 };
  52 MODULE_DEVICE_TABLE(usb, id_table);
  53
  54 static int is_irda(struct usb_serial *serial)
  55 {
  56         struct usb_device *dev = serial->dev;
  57         if (le16_to_cpu(dev->descriptor.idVendor) == 0x18ec &&
  58                         le16_to_cpu(dev->descriptor.idProduct) == 0x3118)
  59                 return 1;
  60         return 0;
  61 }
  62
  63 struct ark3116_private {
  64         int                     irda;   /* 1 for irda device */
  65
  66         /* protects hw register updates */
  67         struct mutex            hw_lock;
  68
  69         int                     quot;   /* baudrate divisor */
  70         __u32                   lcr;    /* line control register value */
  71         __u32                   hcr;    /* handshake control register (0x8)
  72                                          * value */
  73         __u32                   mcr;    /* modem control register value */
  74
  75         /* protects the status values below */
  76         spinlock_t              status_lock;
  77         __u32                   msr;    /* modem status register value */
  78         __u32                   lsr;    /* line status register value */
  79 };
  80
  81 static int ark3116_write_reg(struct usb_serial *serial,
  82                              unsigned reg, __u8 val)
  83 {
  84         int result;
  85          /* 0xfe 0x40 are magic values taken from original driver */
  86         result = usb_control_msg(serial->dev,
  87                                  usb_sndctrlpipe(serial->dev, 0),
  88                                  0xfe, 0x40, val, reg,
  89                                  NULL, 0, ARK_TIMEOUT);
  90         return result;
  91 }
  92
  93 static int ark3116_read_reg(struct usb_serial *serial,
  94                             unsigned reg, unsigned char *buf)
  95 {
  96         int result;
  97         /* 0xfe 0xc0 are magic values taken from original driver */
  98         result = usb_control_msg(serial->dev,
  99                                  usb_rcvctrlpipe(serial->dev, 0),
 100                                  0xfe, 0xc0, 0, reg,
 101                                  buf, 1, ARK_TIMEOUT);
 102         if (result < 0)
 103                 return result;
 104         else
 105                 return buf[0];
 106 }
 107
 108 static inline int calc_divisor(int bps)
 109 {
 110         /* Original ark3116 made some exceptions in rounding here
 111          * because windows did the same. Assume that is not really
 112          * necessary.
 113          * Crystal is 12MHz, probably because of USB, but we divide by 4?
 114          */
 115         return (12000000 + 2*bps) / (4*bps);
 116 }
 117
 118 static int ark3116_attach(struct usb_serial *serial)
 119 {
 120         /* make sure we have our end-points */
 121         if ((serial->num_bulk_in == 0) ||
 122             (serial->num_bulk_out == 0) ||
 123             (serial->num_interrupt_in == 0)) {
 124                 dev_err(&serial->dev->dev,
 125                         "%s - missing endpoint - "
 126                         "bulk in: %d, bulk out: %d, int in %d\n",
 127                         KBUILD_MODNAME,
 128                         serial->num_bulk_in,
 129                         serial->num_bulk_out,
 130                         serial->num_interrupt_in);
 131                 return -EINVAL;
 132         }
 133
 134         return 0;
 135 }
 136
 137 static int ark3116_port_probe(struct usb_serial_port *port)
 138 {
 139         struct usb_serial *serial = port->serial;
 140         struct ark3116_private *priv;
 141
 142         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 143         if (!priv)
 144                 return -ENOMEM;
 145
 146         mutex_init(&priv->hw_lock);
 147         spin_lock_init(&priv->status_lock);
 148
 149         priv->irda = is_irda(serial);
 150
 151         usb_set_serial_port_data(port, priv);
 152
 153         /* setup the hardware */
 154         ark3116_write_reg(serial, UART_IER, 0);
 155         /* disable DMA */
 156         ark3116_write_reg(serial, UART_FCR, 0);
 157         /* handshake control */
 158         priv->hcr = 0;
 159         ark3116_write_reg(serial, 0x8     , 0);
 160         /* modem control */
 161         priv->mcr = 0;
 162         ark3116_write_reg(serial, UART_MCR, 0);
 163
 164         if (!(priv->irda)) {
 165                 ark3116_write_reg(serial, 0xb , 0);
 166         } else {
 167                 ark3116_write_reg(serial, 0xb , 1);
 168                 ark3116_write_reg(serial, 0xc , 0);
 169                 ark3116_write_reg(serial, 0xd , 0x41);
 170                 ark3116_write_reg(serial, 0xa , 1);
 171         }
 172
 173         /* setup baudrate */
 174         ark3116_write_reg(serial, UART_LCR, UART_LCR_DLAB);
 175
 176         /* setup for 9600 8N1 */
 177         priv->quot = calc_divisor(9600);
 178         ark3116_write_reg(serial, UART_DLL, priv->quot & 0xff);
 179         ark3116_write_reg(serial, UART_DLM, (priv->quot>>8) & 0xff);
 180
 181         priv->lcr = UART_LCR_WLEN8;
 182         ark3116_write_reg(serial, UART_LCR, UART_LCR_WLEN8);
 183
 184         ark3116_write_reg(serial, 0xe, 0);
 185
 186         if (priv->irda)
 187                 ark3116_write_reg(serial, 0x9, 0);
 188
 189         dev_info(&serial->dev->dev,
 190                 "%s using %s mode\n",
 191                 KBUILD_MODNAME,
 192                 priv->irda ? "IrDA" : "RS232");
 193         return 0;
 194 }
 195
 196 static int ark3116_port_remove(struct usb_serial_port *port)
 197 {
 198         struct ark3116_private *priv = usb_get_serial_port_data(port);
 199
 200         /* device is closed, so URBs and DMA should be down */
 201         mutex_destroy(&priv->hw_lock);
 202         kfree(priv);
 203
 204         return 0;
 205 }
 206
 207 static void ark3116_init_termios(struct tty_struct *tty)
 208 {
 209         struct ktermios *termios = &tty->termios;
 210         *termios = tty_std_termios;
 211         termios->c_cflag = B9600 | CS8
 212                                       | CREAD | HUPCL | CLOCAL;
 213         termios->c_ispeed = 9600;
 214         termios->c_ospeed = 9600;
 215 }
 216
 217 static void ark3116_set_termios(struct tty_struct *tty,
 218                                 struct usb_serial_port *port,
 219                                 struct ktermios *old_termios)
 220 {
 221         struct usb_serial *serial = port->serial;
 222         struct ark3116_private *priv = usb_get_serial_port_data(port);
 223         struct ktermios *termios = &tty->termios;
 224         unsigned int cflag = termios->c_cflag;
 225         int bps = tty_get_baud_rate(tty);
 226         int quot;
 227         __u8 lcr, hcr, eval;
 228
 229         /* set data bit count */
 230         switch (cflag & CSIZE) {
 231         case CS5:
 232                 lcr = UART_LCR_WLEN5;
 233                 break;
 234         case CS6:
 235                 lcr = UART_LCR_WLEN6;
 236                 break;
 237         case CS7:
 238                 lcr = UART_LCR_WLEN7;
 239                 break;
 240         default:
 241         case CS8:
 242                 lcr = UART_LCR_WLEN8;
 243                 break;
 244         }
 245         if (cflag & CSTOPB)
 246                 lcr |= UART_LCR_STOP;
 247         if (cflag & PARENB)
 248                 lcr |= UART_LCR_PARITY;
 249         if (!(cflag & PARODD))
 250                 lcr |= UART_LCR_EPAR;
 251 #ifdef CMSPAR
 252         if (cflag & CMSPAR)
 253                 lcr |= UART_LCR_SPAR;
 254 #endif
 255         /* handshake control */
 256         hcr = (cflag & CRTSCTS) ? 0x03 : 0x00;
 257
 258         /* calc baudrate */
 259         dev_dbg(&port->dev, "%s - setting bps to %d\n", __func__, bps);
 260         eval = 0;
 261         switch (bps) {
 262         case 0:
 263                 quot = calc_divisor(9600);
 264                 break;
 265         default:
 266                 if ((bps < 75) || (bps > 3000000))
 267                         bps = 9600;
 268                 quot = calc_divisor(bps);
 269                 break;
 270         case 460800:
 271                 eval = 1;
 272                 quot = calc_divisor(bps);
 273                 break;
 274         case 921600:
 275                 eval = 2;
 276                 quot = calc_divisor(bps);
 277                 break;
 278         }
 279
 280         /* Update state: synchronize */
 281         mutex_lock(&priv->hw_lock);
 282
 283         /* keep old LCR_SBC bit */
 284         lcr |= (priv->lcr & UART_LCR_SBC);
 285
 286         dev_dbg(&port->dev, "%s - setting hcr:0x%02x,lcr:0x%02x,quot:%d\n",
 287                 __func__, hcr, lcr, quot);
 288
 289         /* handshake control */
 290         if (priv->hcr != hcr) {
 291                 priv->hcr = hcr;
 292                 ark3116_write_reg(serial, 0x8, hcr);
 293         }
 294
 295         /* baudrate */
 296         if (priv->quot != quot) {
 297                 priv->quot = quot;
 298                 priv->lcr = lcr; /* need to write lcr anyway */
 299
 300                 /* disable DMA since transmit/receive is
 301                  * shadowed by UART_DLL
 302                  */
 303                 ark3116_write_reg(serial, UART_FCR, 0);
 304
 305                 ark3116_write_reg(serial, UART_LCR,
 306                                   lcr|UART_LCR_DLAB);
 307                 ark3116_write_reg(serial, UART_DLL, quot & 0xff);
 308                 ark3116_write_reg(serial, UART_DLM, (quot>>8) & 0xff);
 309
 310                 /* restore lcr */
 311                 ark3116_write_reg(serial, UART_LCR, lcr);
 312                 /* magic baudrate thingy: not sure what it does,
 313                  * but windows does this as well.
 314                  */
 315                 ark3116_write_reg(serial, 0xe, eval);
 316
 317                 /* enable DMA */
 318                 ark3116_write_reg(serial, UART_FCR, UART_FCR_DMA_SELECT);
 319         } else if (priv->lcr != lcr) {
 320                 priv->lcr = lcr;
 321                 ark3116_write_reg(serial, UART_LCR, lcr);
 322         }
 323
 324         mutex_unlock(&priv->hw_lock);
 325
 326         /* check for software flow control */
 327         if (I_IXOFF(tty) || I_IXON(tty)) {
 328                 dev_warn(&serial->dev->dev,
 329                          "%s: don't know how to do software flow control\n",
 330                          KBUILD_MODNAME);
 331         }
 332
 333         /* Don't rewrite B0 */
 334         if (tty_termios_baud_rate(termios))
 335                 tty_termios_encode_baud_rate(termios, bps, bps);
 336 }
 337
 338 static void ark3116_close(struct usb_serial_port *port)
 339 {
 340         struct usb_serial *serial = port->serial;
 341
 342         /* disable DMA */
 343         ark3116_write_reg(serial, UART_FCR, 0);
 344
 345         /* deactivate interrupts */
 346         ark3116_write_reg(serial, UART_IER, 0);
 347
 348         usb_serial_generic_close(port);
 349         if (serial->num_interrupt_in)
 350                 usb_kill_urb(port->interrupt_in_urb);
 351 }
 352
 353 static int ark3116_open(struct tty_struct *tty, struct usb_serial_port *port)
 354 {
 355         struct ark3116_private *priv = usb_get_serial_port_data(port);
 356         struct usb_serial *serial = port->serial;
 357         unsigned char *buf;
 358         int result;
 359
 360         buf = kmalloc(1, GFP_KERNEL);
 361         if (buf == NULL)
 362                 return -ENOMEM;
 363
 364         result = usb_serial_generic_open(tty, port);
 365         if (result) {
 366                 dev_dbg(&port->dev,
 367                         "%s - usb_serial_generic_open failed: %d\n",
 368                         __func__, result);
 369                 goto err_free;
 370         }
 371
 372         /* remove any data still left: also clears error state */
 373         ark3116_read_reg(serial, UART_RX, buf);
 374
 375         /* read modem status */
 376         result = ark3116_read_reg(serial, UART_MSR, buf);
 377         if (result < 0)
 378                 goto err_close;
 379         priv->msr = *buf;
 380
 381         /* read line status */
 382         result = ark3116_read_reg(serial, UART_LSR, buf);
 383         if (result < 0)
 384                 goto err_close;
 385         priv->lsr = *buf;
 386
 387         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 388         if (result) {
 389                 dev_err(&port->dev, "submit irq_in urb failed %d\n",
 390                         result);
 391                 goto err_close;
 392         }
 393
 394         /* activate interrupts */
 395         ark3116_write_reg(port->serial, UART_IER, UART_IER_MSI|UART_IER_RLSI);
 396
 397         /* enable DMA */
 398         ark3116_write_reg(port->serial, UART_FCR, UART_FCR_DMA_SELECT);
 399
 400         /* setup termios */
 401         if (tty)
 402                 ark3116_set_termios(tty, port, NULL);
 403
 404         kfree(buf);
 405
 406         return 0;
 407
 408 err_close:
 409         usb_serial_generic_close(port);
 410 err_free:
 411         kfree(buf);
 412
 413         return result;
 414 }
 415
 416 static int ark3116_ioctl(struct tty_struct *tty,
 417                          unsigned int cmd, unsigned long arg)
 418 {
 419         struct usb_serial_port *port = tty->driver_data;
 420         struct serial_struct serstruct;
 421         void __user *user_arg = (void __user *)arg;
 422
 423         switch (cmd) {
 424         case TIOCGSERIAL:
 425                 /* XXX: Some of these values are probably wrong. */
 426                 memset(&serstruct, 0, sizeof(serstruct));
 427                 serstruct.type = PORT_16654;
 428                 serstruct.line = port->minor;
 429                 serstruct.port = port->port_number;
 430                 serstruct.custom_divisor = 0;
 431                 serstruct.baud_base = 460800;
 432
 433                 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
 434                         return -EFAULT;
 435
 436                 return 0;
 437         case TIOCSSERIAL:
 438                 if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
 439                         return -EFAULT;
 440                 return 0;
 441         }
 442
 443         return -ENOIOCTLCMD;
 444 }
 445
 446 static int ark3116_tiocmget(struct tty_struct *tty)
 447 {
 448         struct usb_serial_port *port = tty->driver_data;
 449         struct ark3116_private *priv = usb_get_serial_port_data(port);
 450         __u32 status;
 451         __u32 ctrl;
 452         unsigned long flags;
 453
 454         mutex_lock(&priv->hw_lock);
 455         ctrl = priv->mcr;
 456         mutex_unlock(&priv->hw_lock);
 457
 458         spin_lock_irqsave(&priv->status_lock, flags);
 459         status = priv->msr;
 460         spin_unlock_irqrestore(&priv->status_lock, flags);
 461
 462         return  (status & UART_MSR_DSR  ? TIOCM_DSR  : 0) |
 463                 (status & UART_MSR_CTS  ? TIOCM_CTS  : 0) |
 464                 (status & UART_MSR_RI   ? TIOCM_RI   : 0) |
 465                 (status & UART_MSR_DCD  ? TIOCM_CD   : 0) |
 466                 (ctrl   & UART_MCR_DTR  ? TIOCM_DTR  : 0) |
 467                 (ctrl   & UART_MCR_RTS  ? TIOCM_RTS  : 0) |
 468                 (ctrl   & UART_MCR_OUT1 ? TIOCM_OUT1 : 0) |
 469                 (ctrl   & UART_MCR_OUT2 ? TIOCM_OUT2 : 0);
 470 }
 471
 472 static int ark3116_tiocmset(struct tty_struct *tty,
 473                         unsigned set, unsigned clr)
 474 {
 475         struct usb_serial_port *port = tty->driver_data;
 476         struct ark3116_private *priv = usb_get_serial_port_data(port);
 477
 478         /* we need to take the mutex here, to make sure that the value
 479          * in priv->mcr is actually the one that is in the hardware
 480          */
 481
 482         mutex_lock(&priv->hw_lock);
 483
 484         if (set & TIOCM_RTS)
 485                 priv->mcr |= UART_MCR_RTS;
 486         if (set & TIOCM_DTR)
 487                 priv->mcr |= UART_MCR_DTR;
 488         if (set & TIOCM_OUT1)
 489                 priv->mcr |= UART_MCR_OUT1;
 490         if (set & TIOCM_OUT2)
 491                 priv->mcr |= UART_MCR_OUT2;
 492         if (clr & TIOCM_RTS)
 493                 priv->mcr &= ~UART_MCR_RTS;
 494         if (clr & TIOCM_DTR)
 495                 priv->mcr &= ~UART_MCR_DTR;
 496         if (clr & TIOCM_OUT1)
 497                 priv->mcr &= ~UART_MCR_OUT1;
 498         if (clr & TIOCM_OUT2)
 499                 priv->mcr &= ~UART_MCR_OUT2;
 500
 501         ark3116_write_reg(port->serial, UART_MCR, priv->mcr);
 502
 503         mutex_unlock(&priv->hw_lock);
 504
 505         return 0;
 506 }
 507
 508 static void ark3116_break_ctl(struct tty_struct *tty, int break_state)
 509 {
 510         struct usb_serial_port *port = tty->driver_data;
 511         struct ark3116_private *priv = usb_get_serial_port_data(port);
 512
 513         /* LCR is also used for other things: protect access */
 514         mutex_lock(&priv->hw_lock);
 515
 516         if (break_state)
 517                 priv->lcr |= UART_LCR_SBC;
 518         else
 519                 priv->lcr &= ~UART_LCR_SBC;
 520
 521         ark3116_write_reg(port->serial, UART_LCR, priv->lcr);
 522
 523         mutex_unlock(&priv->hw_lock);
 524 }
 525
 526 static void ark3116_update_msr(struct usb_serial_port *port, __u8 msr)
 527 {
 528         struct ark3116_private *priv = usb_get_serial_port_data(port);
 529         unsigned long flags;
 530
 531         spin_lock_irqsave(&priv->status_lock, flags);
 532         priv->msr = msr;
 533         spin_unlock_irqrestore(&priv->status_lock, flags);
 534
 535         if (msr & UART_MSR_ANY_DELTA) {
 536                 /* update input line counters */
 537                 if (msr & UART_MSR_DCTS)
 538                         port->icount.cts++;
 539                 if (msr & UART_MSR_DDSR)
 540                         port->icount.dsr++;
 541                 if (msr & UART_MSR_DDCD)
 542                         port->icount.dcd++;
 543                 if (msr & UART_MSR_TERI)
 544                         port->icount.rng++;
 545                 wake_up_interruptible(&port->port.delta_msr_wait);
 546         }
 547 }
 548
 549 static void ark3116_update_lsr(struct usb_serial_port *port, __u8 lsr)
 550 {
 551         struct ark3116_private *priv = usb_get_serial_port_data(port);
 552         unsigned long flags;
 553
 554         spin_lock_irqsave(&priv->status_lock, flags);
 555         /* combine bits */
 556         priv->lsr |= lsr;
 557         spin_unlock_irqrestore(&priv->status_lock, flags);
 558
 559         if (lsr&UART_LSR_BRK_ERROR_BITS) {
 560                 if (lsr & UART_LSR_BI)
 561                         port->icount.brk++;
 562                 if (lsr & UART_LSR_FE)
 563                         port->icount.frame++;
 564                 if (lsr & UART_LSR_PE)
 565                         port->icount.parity++;
 566                 if (lsr & UART_LSR_OE)
 567                         port->icount.overrun++;
 568         }
 569 }
 570
 571 static void ark3116_read_int_callback(struct urb *urb)
 572 {
 573         struct usb_serial_port *port = urb->context;
 574         int status = urb->status;
 575         const __u8 *data = urb->transfer_buffer;
 576         int result;
 577
 578         switch (status) {
 579         case -ECONNRESET:
 580         case -ENOENT:
 581         case -ESHUTDOWN:
 582                 /* this urb is terminated, clean up */
 583                 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
 584                         __func__, status);
 585                 return;
 586         default:
 587                 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
 588                         __func__, status);
 589                 break;
 590         case 0: /* success */
 591                 /* discovered this by trail and error... */
 592                 if ((urb->actual_length == 4) && (data[0] == 0xe8)) {
 593                         const __u8 id = data[1]&UART_IIR_ID;
 594                         dev_dbg(&port->dev, "%s: iir=%02x\n", __func__, data[1]);
 595                         if (id == UART_IIR_MSI) {
 596                                 dev_dbg(&port->dev, "%s: msr=%02x\n",
 597                                         __func__, data[3]);
 598                                 ark3116_update_msr(port, data[3]);
 599                                 break;
 600                         } else if (id == UART_IIR_RLSI) {
 601                                 dev_dbg(&port->dev, "%s: lsr=%02x\n",
 602                                         __func__, data[2]);
 603                                 ark3116_update_lsr(port, data[2]);
 604                                 break;
 605                         }
 606                 }
 607                 /*
 608                  * Not sure what this data meant...
 609                  */
 610                 usb_serial_debug_data(&port->dev, __func__,
 611                                       urb->actual_length,
 612                                       urb->transfer_buffer);
 613                 break;
 614         }
 615
 616         result = usb_submit_urb(urb, GFP_ATOMIC);
 617         if (result)
 618                 dev_err(&urb->dev->dev,
 619                         "%s - Error %d submitting interrupt urb\n",
 620                         __func__, result);
 621 }
 622
 623
 624 /* Data comes in via the bulk (data) URB, errors/interrupts via the int URB.
 625  * This means that we cannot be sure which data byte has an associated error
 626  * condition, so we report an error for all data in the next bulk read.
 627  *
 628  * Actually, there might even be a window between the bulk data leaving the
 629  * ark and reading/resetting the lsr in the read_bulk_callback where an
 630  * interrupt for the next data block could come in.
 631  * Without somekind of ordering on the ark, we would have to report the
 632  * error for the next block of data as well...
 633  * For now, let's pretend this can't happen.
 634  */
 635 static void ark3116_process_read_urb(struct urb *urb)
 636 {
 637         struct usb_serial_port *port = urb->context;
 638         struct ark3116_private *priv = usb_get_serial_port_data(port);
 639         unsigned char *data = urb->transfer_buffer;
 640         char tty_flag = TTY_NORMAL;
 641         unsigned long flags;
 642         __u32 lsr;
 643
 644         /* update line status */
 645         spin_lock_irqsave(&priv->status_lock, flags);
 646         lsr = priv->lsr;
 647         priv->lsr &= ~UART_LSR_BRK_ERROR_BITS;
 648         spin_unlock_irqrestore(&priv->status_lock, flags);
 649
 650         if (!urb->actual_length)
 651                 return;
 652
 653         if (lsr & UART_LSR_BRK_ERROR_BITS) {
 654                 if (lsr & UART_LSR_BI)
 655                         tty_flag = TTY_BREAK;
 656                 else if (lsr & UART_LSR_PE)
 657                         tty_flag = TTY_PARITY;
 658                 else if (lsr & UART_LSR_FE)
 659                         tty_flag = TTY_FRAME;
 660
 661                 /* overrun is special, not associated with a char */
 662                 if (lsr & UART_LSR_OE)
 663                         tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
 664         }
 665         tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
 666                                                         urb->actual_length);
 667         tty_flip_buffer_push(&port->port);
 668 }
 669
 670 static struct usb_serial_driver ark3116_device = {
 671         .driver = {
 672                 .owner =        THIS_MODULE,
 673                 .name =         "ark3116",
 674         },
 675         .id_table =             id_table,
 676         .num_ports =            1,
 677         .attach =               ark3116_attach,
 678         .port_probe =           ark3116_port_probe,
 679         .port_remove =          ark3116_port_remove,
 680         .set_termios =          ark3116_set_termios,
 681         .init_termios =         ark3116_init_termios,
 682         .ioctl =                ark3116_ioctl,
 683         .tiocmget =             ark3116_tiocmget,
 684         .tiocmset =             ark3116_tiocmset,
 685         .tiocmiwait =           usb_serial_generic_tiocmiwait,
 686         .get_icount =           usb_serial_generic_get_icount,
 687         .open =                 ark3116_open,
 688         .close =                ark3116_close,
 689         .break_ctl =            ark3116_break_ctl,
 690         .read_int_callback =    ark3116_read_int_callback,
 691         .process_read_urb =     ark3116_process_read_urb,
 692 };
 693
 694 static struct usb_serial_driver * const serial_drivers[] = {
 695         &ark3116_device, NULL
 696 };
 697
 698 module_usb_serial_driver(serial_drivers, id_table);
 699
 700 MODULE_LICENSE("GPL");
 701
 702 MODULE_AUTHOR(DRIVER_AUTHOR);
 703 MODULE_DESCRIPTION(DRIVER_DESC);
 704
 705 /*
 706  * The following describes what I learned from studying the old
 707  * ark3116.c driver, disassembling the windows driver, and some lucky
 708  * guesses. Since I do not have any datasheet or other
 709  * documentation, inaccuracies are almost guaranteed.
 710  *
 711  * Some specs for the ARK3116 can be found here:
 712  * http://web.archive.org/web/20060318000438/
 713  *   www.arkmicro.com/en/products/view.php?id=10
 714  * On that page, 2 GPIO pins are mentioned: I assume these are the
 715  * OUT1 and OUT2 pins of the UART, so I added support for those
 716  * through the MCR. Since the pins are not available on my hardware,
 717  * I could not verify this.
 718  * Also, it states there is "on-chip hardware flow control". I have
 719  * discovered how to enable that. Unfortunately, I do not know how to
 720  * enable XON/XOFF (software) flow control, which would need support
 721  * from the chip as well to work. Because of the wording on the web
 722  * page there is a real possibility the chip simply does not support
 723  * software flow control.
 724  *
 725  * I got my ark3116 as part of a mobile phone adapter cable. On the
 726  * PCB, the following numbered contacts are present:
 727  *
 728  *  1:- +5V
 729  *  2:o DTR
 730  *  3:i RX
 731  *  4:i DCD
 732  *  5:o RTS
 733  *  6:o TX
 734  *  7:i RI
 735  *  8:i DSR
 736  * 10:- 0V
 737  * 11:i CTS
 738  *
 739  * On my chip, all signals seem to be 3.3V, but 5V tolerant. But that
 740  * may be different for the one you have ;-).
 741  *
 742  * The windows driver limits the registers to 0-F, so I assume there
 743  * are actually 16 present on the device.
 744  *
 745  * On an UART interrupt, 4 bytes of data come in on the interrupt
 746  * endpoint. The bytes are 0xe8 IIR LSR MSR.
 747  *
 748  * The baudrate seems to be generated from the 12MHz crystal, using
 749  * 4-times subsampling. So quot=12e6/(4*baud). Also see description
 750  * of register E.
 751  *
 752  * Registers 0-7:
 753  * These seem to be the same as for a regular 16450. The FCR is set
 754  * to UART_FCR_DMA_SELECT (0x8), I guess to enable transfers between
 755  * the UART and the USB bridge/DMA engine.
 756  *
 757  * Register 8:
 758  * By trial and error, I found out that bit 0 enables hardware CTS,
 759  * stopping TX when CTS is +5V. Bit 1 does the same for RTS, making
 760  * RTS +5V when the 3116 cannot transfer the data to the USB bus
 761  * (verified by disabling the reading URB). Note that as far as I can
 762  * tell, the windows driver does NOT use this, so there might be some
 763  * hardware bug or something.
 764  *
 765  * According to a patch provided here
 766  * (http://lkml.org/lkml/2009/7/26/56), the ARK3116 can also be used
 767  * as an IrDA dongle. Since I do not have such a thing, I could not
 768  * investigate that aspect. However, I can speculate ;-).
 769  *
 770  * - IrDA encodes data differently than RS232. Most likely, one of
 771  *   the bits in registers 9..E enables the IR ENDEC (encoder/decoder).
 772  * - Depending on the IR transceiver, the input and output need to be
 773  *   inverted, so there are probably bits for that as well.
 774  * - IrDA is half-duplex, so there should be a bit for selecting that.
 775  *
 776  * This still leaves at least two registers unaccounted for. Perhaps
 777  * The chip can do XON/XOFF or CRC in HW?
 778  *
 779  * Register 9:
 780  * Set to 0x00 for IrDA, when the baudrate is initialised.
 781  *
 782  * Register A:
 783  * Set to 0x01 for IrDA, at init.
 784  *
 785  * Register B:
 786  * Set to 0x01 for IrDA, 0x00 for RS232, at init.
 787  *
 788  * Register C:
 789  * Set to 00 for IrDA, at init.
 790  *
 791  * Register D:
 792  * Set to 0x41 for IrDA, at init.
 793  *
 794  * Register E:
 795  * Somekind of baudrate override. The windows driver seems to set
 796  * this to 0x00 for normal baudrates, 0x01 for 460800, 0x02 for 921600.
 797  * Since 460800 and 921600 cannot be obtained by dividing 3MHz by an integer,
 798  * it could be somekind of subdivisor thingy.
 799  * However,it does not seem to do anything: selecting 921600 (divisor 3,
 800  * reg E=2), still gets 1 MHz. I also checked if registers 9, C or F would
 801  * work, but they don't.
 802  *
 803  * Register F: unknown
 804  */