drivers/usb/serial/ch341.c

   1 /*
   2  * Copyright 2007, Frank A Kingswood <frank@kingswood-consulting.co.uk>
   3  * Copyright 2007, Werner Cornelius <werner@cornelius-consult.de>
   4  * Copyright 2009, Boris Hajduk <boris@hajduk.org>
   5  *
   6  * ch341.c implements a serial port driver for the Winchiphead CH341.
   7  *
   8  * The CH341 device can be used to implement an RS232 asynchronous
   9  * serial port, an IEEE-1284 parallel printer port or a memory-like
  10  * interface. In all cases the CH341 supports an I2C interface as well.
  11  * This driver only supports the asynchronous serial interface.
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License version
  15  * 2 as published by the Free Software Foundation.
  16  */
  17
  18 #include <linux/kernel.h>
  19 #include <linux/tty.h>
  20 #include <linux/module.h>
  21 #include <linux/slab.h>
  22 #include <linux/usb.h>
  23 #include <linux/usb/serial.h>
  24 #include <linux/serial.h>
  25 #include <asm/unaligned.h>
  26
  27 #define DEFAULT_BAUD_RATE 9600
  28 #define DEFAULT_TIMEOUT   1000
  29
  30 /* flags for IO-Bits */
  31 #define CH341_BIT_RTS (1 << 6)
  32 #define CH341_BIT_DTR (1 << 5)
  33
  34 /******************************/
  35 /* interrupt pipe definitions */
  36 /******************************/
  37 /* always 4 interrupt bytes */
  38 /* first irq byte normally 0x08 */
  39 /* second irq byte base 0x7d + below */
  40 /* third irq byte base 0x94 + below */
  41 /* fourth irq byte normally 0xee */
  42
  43 /* second interrupt byte */
  44 #define CH341_MULT_STAT 0x04 /* multiple status since last interrupt event */
  45
  46 /* status returned in third interrupt answer byte, inverted in data
  47    from irq */
  48 #define CH341_BIT_CTS 0x01
  49 #define CH341_BIT_DSR 0x02
  50 #define CH341_BIT_RI  0x04
  51 #define CH341_BIT_DCD 0x08
  52 #define CH341_BITS_MODEM_STAT 0x0f /* all bits */
  53
  54 /*******************************/
  55 /* baudrate calculation factor */
  56 /*******************************/
  57 #define CH341_BAUDBASE_FACTOR 1532620800
  58 #define CH341_BAUDBASE_DIVMAX 3
  59
  60 /* Break support - the information used to implement this was gleaned from
  61  * the Net/FreeBSD uchcom.c driver by Takanori Watanabe.  Domo arigato.
  62  */
  63
  64 #define CH341_REQ_READ_VERSION 0x5F
  65 #define CH341_REQ_WRITE_REG    0x9A
  66 #define CH341_REQ_READ_REG     0x95
  67 #define CH341_REQ_SERIAL_INIT  0xA1
  68 #define CH341_REQ_MODEM_CTRL   0xA4
  69
  70 #define CH341_REG_BREAK        0x05
  71 #define CH341_REG_LCR          0x18
  72 #define CH341_NBREAK_BITS      0x01
  73
  74 #define CH341_LCR_ENABLE_RX    0x80
  75 #define CH341_LCR_ENABLE_TX    0x40
  76 #define CH341_LCR_MARK_SPACE   0x20
  77 #define CH341_LCR_PAR_EVEN     0x10
  78 #define CH341_LCR_ENABLE_PAR   0x08
  79 #define CH341_LCR_STOP_BITS_2  0x04
  80 #define CH341_LCR_CS8          0x03
  81 #define CH341_LCR_CS7          0x02
  82 #define CH341_LCR_CS6          0x01
  83 #define CH341_LCR_CS5          0x00
  84
  85 static const struct usb_device_id id_table[] = {
  86         { USB_DEVICE(0x4348, 0x5523) },
  87         { USB_DEVICE(0x1a86, 0x7523) },
  88         { USB_DEVICE(0x1a86, 0x5523) },
  89         { },
  90 };
  91 MODULE_DEVICE_TABLE(usb, id_table);
  92
  93 struct ch341_private {
  94         spinlock_t lock; /* access lock */
  95         unsigned baud_rate; /* set baud rate */
  96         u8 line_control; /* set line control value RTS/DTR */
  97         u8 line_status; /* active status of modem control inputs */
  98 };
  99
 100 static void ch341_set_termios(struct tty_struct *tty,
 101                               struct usb_serial_port *port,
 102                               struct ktermios *old_termios);
 103
 104 static int ch341_control_out(struct usb_device *dev, u8 request,
 105                              u16 value, u16 index)
 106 {
 107         int r;
 108
 109         dev_dbg(&dev->dev, "ch341_control_out(%02x,%02x,%04x,%04x)\n",
 110                 USB_DIR_OUT|0x40, (int)request, (int)value, (int)index);
 111
 112         r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
 113                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 114                             value, index, NULL, 0, DEFAULT_TIMEOUT);
 115         if (r < 0)
 116                 dev_err(&dev->dev, "failed to send control message: %d\n", r);
 117
 118         return r;
 119 }
 120
 121 static int ch341_control_in(struct usb_device *dev,
 122                             u8 request, u16 value, u16 index,
 123                             char *buf, unsigned bufsize)
 124 {
 125         int r;
 126
 127         dev_dbg(&dev->dev, "ch341_control_in(%02x,%02x,%04x,%04x,%p,%u)\n",
 128                 USB_DIR_IN|0x40, (int)request, (int)value, (int)index, buf,
 129                 (int)bufsize);
 130
 131         r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
 132                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
 133                             value, index, buf, bufsize, DEFAULT_TIMEOUT);
 134         if (r < (int)bufsize) {
 135                 if (r >= 0) {
 136                         dev_err(&dev->dev,
 137                                 "short control message received (%d < %u)\n",
 138                                 r, bufsize);
 139                         r = -EIO;
 140                 }
 141
 142                 dev_err(&dev->dev, "failed to receive control message: %d\n",
 143                         r);
 144                 return r;
 145         }
 146
 147         return 0;
 148 }
 149
 150 static int ch341_set_baudrate_lcr(struct usb_device *dev,
 151                                   struct ch341_private *priv, u8 lcr)
 152 {
 153         short a;
 154         int r;
 155         unsigned long factor;
 156         short divisor;
 157
 158         if (!priv->baud_rate)
 159                 return -EINVAL;
 160         factor = (CH341_BAUDBASE_FACTOR / priv->baud_rate);
 161         divisor = CH341_BAUDBASE_DIVMAX;
 162
 163         while ((factor > 0xfff0) && divisor) {
 164                 factor >>= 3;
 165                 divisor--;
 166         }
 167
 168         if (factor > 0xfff0)
 169                 return -EINVAL;
 170
 171         factor = 0x10000 - factor;
 172         a = (factor & 0xff00) | divisor;
 173
 174         /*
 175          * CH341A buffers data until a full endpoint-size packet (32 bytes)
 176          * has been received unless bit 7 is set.
 177          */
 178         a |= BIT(7);
 179
 180         r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x1312, a);
 181         if (r)
 182                 return r;
 183
 184         r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x2518, lcr);
 185         if (r)
 186                 return r;
 187
 188         return r;
 189 }
 190
 191 static int ch341_set_handshake(struct usb_device *dev, u8 control)
 192 {
 193         return ch341_control_out(dev, CH341_REQ_MODEM_CTRL, ~control, 0);
 194 }
 195
 196 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
 197 {
 198         const unsigned int size = 2;
 199         char *buffer;
 200         int r;
 201         unsigned long flags;
 202
 203         buffer = kmalloc(size, GFP_KERNEL);
 204         if (!buffer)
 205                 return -ENOMEM;
 206
 207         r = ch341_control_in(dev, CH341_REQ_READ_REG, 0x0706, 0, buffer, size);
 208         if (r < 0)
 209                 goto out;
 210
 211         spin_lock_irqsave(&priv->lock, flags);
 212         priv->line_status = (~(*buffer)) & CH341_BITS_MODEM_STAT;
 213         spin_unlock_irqrestore(&priv->lock, flags);
 214
 215 out:    kfree(buffer);
 216         return r;
 217 }
 218
 219 /* -------------------------------------------------------------------------- */
 220
 221 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
 222 {
 223         const unsigned int size = 2;
 224         char *buffer;
 225         int r;
 226
 227         buffer = kmalloc(size, GFP_KERNEL);
 228         if (!buffer)
 229                 return -ENOMEM;
 230
 231         /* expect two bytes 0x27 0x00 */
 232         r = ch341_control_in(dev, CH341_REQ_READ_VERSION, 0, 0, buffer, size);
 233         if (r < 0)
 234                 goto out;
 235
 236         r = ch341_control_out(dev, CH341_REQ_SERIAL_INIT, 0, 0);
 237         if (r < 0)
 238                 goto out;
 239
 240         /* expect two bytes 0x56 0x00 */
 241         r = ch341_control_in(dev, CH341_REQ_READ_REG, 0x2518, 0, buffer, size);
 242         if (r < 0)
 243                 goto out;
 244
 245         r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x2518, 0x0050);
 246         if (r < 0)
 247                 goto out;
 248
 249         r = ch341_set_baudrate_lcr(dev, priv, 0);
 250         if (r < 0)
 251                 goto out;
 252
 253         r = ch341_set_handshake(dev, priv->line_control);
 254
 255 out:    kfree(buffer);
 256         return r;
 257 }
 258
 259 static int ch341_port_probe(struct usb_serial_port *port)
 260 {
 261         struct ch341_private *priv;
 262         int r;
 263
 264         priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
 265         if (!priv)
 266                 return -ENOMEM;
 267
 268         spin_lock_init(&priv->lock);
 269         priv->baud_rate = DEFAULT_BAUD_RATE;
 270
 271         r = ch341_configure(port->serial->dev, priv);
 272         if (r < 0)
 273                 goto error;
 274
 275         usb_set_serial_port_data(port, priv);
 276         return 0;
 277
 278 error:  kfree(priv);
 279         return r;
 280 }
 281
 282 static int ch341_port_remove(struct usb_serial_port *port)
 283 {
 284         struct ch341_private *priv;
 285
 286         priv = usb_get_serial_port_data(port);
 287         kfree(priv);
 288
 289         return 0;
 290 }
 291
 292 static int ch341_carrier_raised(struct usb_serial_port *port)
 293 {
 294         struct ch341_private *priv = usb_get_serial_port_data(port);
 295         if (priv->line_status & CH341_BIT_DCD)
 296                 return 1;
 297         return 0;
 298 }
 299
 300 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
 301 {
 302         struct ch341_private *priv = usb_get_serial_port_data(port);
 303         unsigned long flags;
 304
 305         /* drop DTR and RTS */
 306         spin_lock_irqsave(&priv->lock, flags);
 307         if (on)
 308                 priv->line_control |= CH341_BIT_RTS | CH341_BIT_DTR;
 309         else
 310                 priv->line_control &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
 311         spin_unlock_irqrestore(&priv->lock, flags);
 312         ch341_set_handshake(port->serial->dev, priv->line_control);
 313 }
 314
 315 static void ch341_close(struct usb_serial_port *port)
 316 {
 317         usb_serial_generic_close(port);
 318         usb_kill_urb(port->interrupt_in_urb);
 319 }
 320
 321
 322 /* open this device, set default parameters */
 323 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
 324 {
 325         struct ch341_private *priv = usb_get_serial_port_data(port);
 326         int r;
 327
 328         if (tty)
 329                 ch341_set_termios(tty, port, NULL);
 330
 331         dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__);
 332         r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 333         if (r) {
 334                 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n",
 335                         __func__, r);
 336                 return r;
 337         }
 338
 339         r = ch341_get_status(port->serial->dev, priv);
 340         if (r < 0) {
 341                 dev_err(&port->dev, "failed to read modem status: %d\n", r);
 342                 goto err_kill_interrupt_urb;
 343         }
 344
 345         r = usb_serial_generic_open(tty, port);
 346         if (r)
 347                 goto err_kill_interrupt_urb;
 348
 349         return 0;
 350
 351 err_kill_interrupt_urb:
 352         usb_kill_urb(port->interrupt_in_urb);
 353
 354         return r;
 355 }
 356
 357 /* Old_termios contains the original termios settings and
 358  * tty->termios contains the new setting to be used.
 359  */
 360 static void ch341_set_termios(struct tty_struct *tty,
 361                 struct usb_serial_port *port, struct ktermios *old_termios)
 362 {
 363         struct ch341_private *priv = usb_get_serial_port_data(port);
 364         unsigned baud_rate;
 365         unsigned long flags;
 366         unsigned char ctrl;
 367         int r;
 368
 369         /* redundant changes may cause the chip to lose bytes */
 370         if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
 371                 return;
 372
 373         baud_rate = tty_get_baud_rate(tty);
 374
 375         ctrl = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8;
 376
 377         if (baud_rate) {
 378                 priv->baud_rate = baud_rate;
 379
 380                 r = ch341_set_baudrate_lcr(port->serial->dev, priv, ctrl);
 381                 if (r < 0 && old_termios) {
 382                         priv->baud_rate = tty_termios_baud_rate(old_termios);
 383                         tty_termios_copy_hw(&tty->termios, old_termios);
 384                 }
 385         }
 386
 387         spin_lock_irqsave(&priv->lock, flags);
 388         if (C_BAUD(tty) == B0)
 389                 priv->line_control &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
 390         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
 391                 priv->line_control |= (CH341_BIT_DTR | CH341_BIT_RTS);
 392         spin_unlock_irqrestore(&priv->lock, flags);
 393
 394         /* Unimplemented:
 395          * (cflag & CSIZE) : data bits [5, 8]
 396          * (cflag & PARENB) : parity {NONE, EVEN, ODD}
 397          * (cflag & CSTOPB) : stop bits [1, 2]
 398          */
 399 }
 400
 401 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
 402 {
 403         const uint16_t ch341_break_reg =
 404                         ((uint16_t) CH341_REG_LCR << 8) | CH341_REG_BREAK;
 405         struct usb_serial_port *port = tty->driver_data;
 406         int r;
 407         uint16_t reg_contents;
 408         uint8_t *break_reg;
 409
 410         break_reg = kmalloc(2, GFP_KERNEL);
 411         if (!break_reg)
 412                 return;
 413
 414         r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
 415                         ch341_break_reg, 0, break_reg, 2);
 416         if (r < 0) {
 417                 dev_err(&port->dev, "%s - USB control read error (%d)\n",
 418                                 __func__, r);
 419                 goto out;
 420         }
 421         dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
 422                 __func__, break_reg[0], break_reg[1]);
 423         if (break_state != 0) {
 424                 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
 425                 break_reg[0] &= ~CH341_NBREAK_BITS;
 426                 break_reg[1] &= ~CH341_LCR_ENABLE_TX;
 427         } else {
 428                 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
 429                 break_reg[0] |= CH341_NBREAK_BITS;
 430                 break_reg[1] |= CH341_LCR_ENABLE_TX;
 431         }
 432         dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
 433                 __func__, break_reg[0], break_reg[1]);
 434         reg_contents = get_unaligned_le16(break_reg);
 435         r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
 436                         ch341_break_reg, reg_contents);
 437         if (r < 0)
 438                 dev_err(&port->dev, "%s - USB control write error (%d)\n",
 439                                 __func__, r);
 440 out:
 441         kfree(break_reg);
 442 }
 443
 444 static int ch341_tiocmset(struct tty_struct *tty,
 445                           unsigned int set, unsigned int clear)
 446 {
 447         struct usb_serial_port *port = tty->driver_data;
 448         struct ch341_private *priv = usb_get_serial_port_data(port);
 449         unsigned long flags;
 450         u8 control;
 451
 452         spin_lock_irqsave(&priv->lock, flags);
 453         if (set & TIOCM_RTS)
 454                 priv->line_control |= CH341_BIT_RTS;
 455         if (set & TIOCM_DTR)
 456                 priv->line_control |= CH341_BIT_DTR;
 457         if (clear & TIOCM_RTS)
 458                 priv->line_control &= ~CH341_BIT_RTS;
 459         if (clear & TIOCM_DTR)
 460                 priv->line_control &= ~CH341_BIT_DTR;
 461         control = priv->line_control;
 462         spin_unlock_irqrestore(&priv->lock, flags);
 463
 464         return ch341_set_handshake(port->serial->dev, control);
 465 }
 466
 467 static void ch341_update_line_status(struct usb_serial_port *port,
 468                                         unsigned char *data, size_t len)
 469 {
 470         struct ch341_private *priv = usb_get_serial_port_data(port);
 471         struct tty_struct *tty;
 472         unsigned long flags;
 473         u8 status;
 474         u8 delta;
 475
 476         if (len < 4)
 477                 return;
 478
 479         status = ~data[2] & CH341_BITS_MODEM_STAT;
 480
 481         spin_lock_irqsave(&priv->lock, flags);
 482         delta = status ^ priv->line_status;
 483         priv->line_status = status;
 484         spin_unlock_irqrestore(&priv->lock, flags);
 485
 486         if (data[1] & CH341_MULT_STAT)
 487                 dev_dbg(&port->dev, "%s - multiple status change\n", __func__);
 488
 489         if (!delta)
 490                 return;
 491
 492         if (delta & CH341_BIT_CTS)
 493                 port->icount.cts++;
 494         if (delta & CH341_BIT_DSR)
 495                 port->icount.dsr++;
 496         if (delta & CH341_BIT_RI)
 497                 port->icount.rng++;
 498         if (delta & CH341_BIT_DCD) {
 499                 port->icount.dcd++;
 500                 tty = tty_port_tty_get(&port->port);
 501                 if (tty) {
 502                         usb_serial_handle_dcd_change(port, tty,
 503                                                 status & CH341_BIT_DCD);
 504                         tty_kref_put(tty);
 505                 }
 506         }
 507
 508         wake_up_interruptible(&port->port.delta_msr_wait);
 509 }
 510
 511 static void ch341_read_int_callback(struct urb *urb)
 512 {
 513         struct usb_serial_port *port = urb->context;
 514         unsigned char *data = urb->transfer_buffer;
 515         unsigned int len = urb->actual_length;
 516         int status;
 517
 518         switch (urb->status) {
 519         case 0:
 520                 /* success */
 521                 break;
 522         case -ECONNRESET:
 523         case -ENOENT:
 524         case -ESHUTDOWN:
 525                 /* this urb is terminated, clean up */
 526                 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n",
 527                         __func__, urb->status);
 528                 return;
 529         default:
 530                 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n",
 531                         __func__, urb->status);
 532                 goto exit;
 533         }
 534
 535         usb_serial_debug_data(&port->dev, __func__, len, data);
 536         ch341_update_line_status(port, data, len);
 537 exit:
 538         status = usb_submit_urb(urb, GFP_ATOMIC);
 539         if (status) {
 540                 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n",
 541                         __func__, status);
 542         }
 543 }
 544
 545 static int ch341_tiocmget(struct tty_struct *tty)
 546 {
 547         struct usb_serial_port *port = tty->driver_data;
 548         struct ch341_private *priv = usb_get_serial_port_data(port);
 549         unsigned long flags;
 550         u8 mcr;
 551         u8 status;
 552         unsigned int result;
 553
 554         spin_lock_irqsave(&priv->lock, flags);
 555         mcr = priv->line_control;
 556         status = priv->line_status;
 557         spin_unlock_irqrestore(&priv->lock, flags);
 558
 559         result = ((mcr & CH341_BIT_DTR)         ? TIOCM_DTR : 0)
 560                   | ((mcr & CH341_BIT_RTS)      ? TIOCM_RTS : 0)
 561                   | ((status & CH341_BIT_CTS)   ? TIOCM_CTS : 0)
 562                   | ((status & CH341_BIT_DSR)   ? TIOCM_DSR : 0)
 563                   | ((status & CH341_BIT_RI)    ? TIOCM_RI  : 0)
 564                   | ((status & CH341_BIT_DCD)   ? TIOCM_CD  : 0);
 565
 566         dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
 567
 568         return result;
 569 }
 570
 571 static int ch341_reset_resume(struct usb_serial *serial)
 572 {
 573         struct usb_serial_port *port = serial->port[0];
 574         struct ch341_private *priv = usb_get_serial_port_data(port);
 575         int ret;
 576
 577         /* reconfigure ch341 serial port after bus-reset */
 578         ch341_configure(serial->dev, priv);
 579
 580         if (port->port.flags & ASYNC_INITIALIZED) {
 581                 ret = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
 582                 if (ret) {
 583                         dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
 584                                 ret);
 585                         return ret;
 586                 }
 587
 588                 ret = ch341_get_status(port->serial->dev, priv);
 589                 if (ret < 0) {
 590                         dev_err(&port->dev, "failed to read modem status: %d\n",
 591                                 ret);
 592                 }
 593         }
 594
 595         return usb_serial_generic_resume(serial);
 596 }
 597
 598 static struct usb_serial_driver ch341_device = {
 599         .driver = {
 600                 .owner  = THIS_MODULE,
 601                 .name   = "ch341-uart",
 602         },
 603         .id_table          = id_table,
 604         .num_ports         = 1,
 605         .open              = ch341_open,
 606         .dtr_rts           = ch341_dtr_rts,
 607         .carrier_raised    = ch341_carrier_raised,
 608         .close             = ch341_close,
 609         .set_termios       = ch341_set_termios,
 610         .break_ctl         = ch341_break_ctl,
 611         .tiocmget          = ch341_tiocmget,
 612         .tiocmset          = ch341_tiocmset,
 613         .tiocmiwait        = usb_serial_generic_tiocmiwait,
 614         .read_int_callback = ch341_read_int_callback,
 615         .port_probe        = ch341_port_probe,
 616         .port_remove       = ch341_port_remove,
 617         .reset_resume      = ch341_reset_resume,
 618 };
 619
 620 static struct usb_serial_driver * const serial_drivers[] = {
 621         &ch341_device, NULL
 622 };
 623
 624 module_usb_serial_driver(serial_drivers, id_table);
 625
 626 MODULE_LICENSE("GPL");