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