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_WRITE_REG    0x9A
  65 #define CH341_REQ_READ_REG     0x95
  66 #define CH341_REG_BREAK1       0x05
  67 #define CH341_REG_BREAK2       0x18
  68 #define CH341_NBREAK_BITS_REG1 0x01
  69 #define CH341_NBREAK_BITS_REG2 0x40
  70
  71
  72 static const struct usb_device_id id_table[] = {
  73         { USB_DEVICE(0x4348, 0x5523) },
  74         { USB_DEVICE(0x1a86, 0x7523) },
  75         { USB_DEVICE(0x1a86, 0x5523) },
  76         { },
  77 };
  78 MODULE_DEVICE_TABLE(usb, id_table);
  79
  80 struct ch341_private {
  81         spinlock_t lock; /* access lock */
  82         unsigned baud_rate; /* set baud rate */
  83         u8 line_control; /* set line control value RTS/DTR */
  84         u8 line_status; /* active status of modem control inputs */
  85 };
  86
  87 static void ch341_set_termios(struct tty_struct *tty,
  88                               struct usb_serial_port *port,
  89                               struct ktermios *old_termios);
  90
  91 static int ch341_control_out(struct usb_device *dev, u8 request,
  92                              u16 value, u16 index)
  93 {
  94         int r;
  95
  96         dev_dbg(&dev->dev, "ch341_control_out(%02x,%02x,%04x,%04x)\n",
  97                 USB_DIR_OUT|0x40, (int)request, (int)value, (int)index);
  98
  99         r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
 100                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 101                             value, index, NULL, 0, DEFAULT_TIMEOUT);
 102
 103         return r;
 104 }
 105
 106 static int ch341_control_in(struct usb_device *dev,
 107                             u8 request, u16 value, u16 index,
 108                             char *buf, unsigned bufsize)
 109 {
 110         int r;
 111
 112         dev_dbg(&dev->dev, "ch341_control_in(%02x,%02x,%04x,%04x,%p,%u)\n",
 113                 USB_DIR_IN|0x40, (int)request, (int)value, (int)index, buf,
 114                 (int)bufsize);
 115
 116         r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
 117                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
 118                             value, index, buf, bufsize, DEFAULT_TIMEOUT);
 119         return r;
 120 }
 121
 122 static int ch341_set_baudrate(struct usb_device *dev,
 123                               struct ch341_private *priv)
 124 {
 125         short a, b;
 126         int r;
 127         unsigned long factor;
 128         short divisor;
 129
 130         if (!priv->baud_rate)
 131                 return -EINVAL;
 132         factor = (CH341_BAUDBASE_FACTOR / priv->baud_rate);
 133         divisor = CH341_BAUDBASE_DIVMAX;
 134
 135         while ((factor > 0xfff0) && divisor) {
 136                 factor >>= 3;
 137                 divisor--;
 138         }
 139
 140         if (factor > 0xfff0)
 141                 return -EINVAL;
 142
 143         factor = 0x10000 - factor;
 144         a = (factor & 0xff00) | divisor;
 145         b = factor & 0xff;
 146
 147         r = ch341_control_out(dev, 0x9a, 0x1312, a);
 148         if (!r)
 149                 r = ch341_control_out(dev, 0x9a, 0x0f2c, b);
 150
 151         return r;
 152 }
 153
 154 static int ch341_set_handshake(struct usb_device *dev, u8 control)
 155 {
 156         return ch341_control_out(dev, 0xa4, ~control, 0);
 157 }
 158
 159 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
 160 {
 161         char *buffer;
 162         int r;
 163         const unsigned size = 8;
 164         unsigned long flags;
 165
 166         buffer = kmalloc(size, GFP_KERNEL);
 167         if (!buffer)
 168                 return -ENOMEM;
 169
 170         r = ch341_control_in(dev, 0x95, 0x0706, 0, buffer, size);
 171         if (r < 0)
 172                 goto out;
 173
 174         /* setup the private status if available */
 175         if (r == 2) {
 176                 r = 0;
 177                 spin_lock_irqsave(&priv->lock, flags);
 178                 priv->line_status = (~(*buffer)) & CH341_BITS_MODEM_STAT;
 179                 spin_unlock_irqrestore(&priv->lock, flags);
 180         } else
 181                 r = -EPROTO;
 182
 183 out:    kfree(buffer);
 184         return r;
 185 }
 186
 187 /* -------------------------------------------------------------------------- */
 188
 189 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
 190 {
 191         char *buffer;
 192         int r;
 193         const unsigned size = 8;
 194
 195         buffer = kmalloc(size, GFP_KERNEL);
 196         if (!buffer)
 197                 return -ENOMEM;
 198
 199         /* expect two bytes 0x27 0x00 */
 200         r = ch341_control_in(dev, 0x5f, 0, 0, buffer, size);
 201         if (r < 0)
 202                 goto out;
 203
 204         r = ch341_control_out(dev, 0xa1, 0, 0);
 205         if (r < 0)
 206                 goto out;
 207
 208         r = ch341_set_baudrate(dev, priv);
 209         if (r < 0)
 210                 goto out;
 211
 212         /* expect two bytes 0x56 0x00 */
 213         r = ch341_control_in(dev, 0x95, 0x2518, 0, buffer, size);
 214         if (r < 0)
 215                 goto out;
 216
 217         r = ch341_control_out(dev, 0x9a, 0x2518, 0x0050);
 218         if (r < 0)
 219                 goto out;
 220
 221         /* expect 0xff 0xee */
 222         r = ch341_get_status(dev, priv);
 223         if (r < 0)
 224                 goto out;
 225
 226         r = ch341_control_out(dev, 0xa1, 0x501f, 0xd90a);
 227         if (r < 0)
 228                 goto out;
 229
 230         r = ch341_set_baudrate(dev, priv);
 231         if (r < 0)
 232                 goto out;
 233
 234         r = ch341_set_handshake(dev, priv->line_control);
 235         if (r < 0)
 236                 goto out;
 237
 238         /* expect 0x9f 0xee */
 239         r = ch341_get_status(dev, priv);
 240
 241 out:    kfree(buffer);
 242         return r;
 243 }
 244
 245 static int ch341_port_probe(struct usb_serial_port *port)
 246 {
 247         struct ch341_private *priv;
 248         int r;
 249
 250         priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
 251         if (!priv)
 252                 return -ENOMEM;
 253
 254         spin_lock_init(&priv->lock);
 255         priv->baud_rate = DEFAULT_BAUD_RATE;
 256
 257         r = ch341_configure(port->serial->dev, priv);
 258         if (r < 0)
 259                 goto error;
 260
 261         usb_set_serial_port_data(port, priv);
 262         return 0;
 263
 264 error:  kfree(priv);
 265         return r;
 266 }
 267
 268 static int ch341_port_remove(struct usb_serial_port *port)
 269 {
 270         struct ch341_private *priv;
 271
 272         priv = usb_get_serial_port_data(port);
 273         kfree(priv);
 274
 275         return 0;
 276 }
 277
 278 static int ch341_carrier_raised(struct usb_serial_port *port)
 279 {
 280         struct ch341_private *priv = usb_get_serial_port_data(port);
 281         if (priv->line_status & CH341_BIT_DCD)
 282                 return 1;
 283         return 0;
 284 }
 285
 286 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
 287 {
 288         struct ch341_private *priv = usb_get_serial_port_data(port);
 289         unsigned long flags;
 290
 291         /* drop DTR and RTS */
 292         spin_lock_irqsave(&priv->lock, flags);
 293         if (on)
 294                 priv->line_control |= CH341_BIT_RTS | CH341_BIT_DTR;
 295         else
 296                 priv->line_control &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
 297         spin_unlock_irqrestore(&priv->lock, flags);
 298         ch341_set_handshake(port->serial->dev, priv->line_control);
 299 }
 300
 301 static void ch341_close(struct usb_serial_port *port)
 302 {
 303         usb_serial_generic_close(port);
 304         usb_kill_urb(port->interrupt_in_urb);
 305 }
 306
 307
 308 /* open this device, set default parameters */
 309 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
 310 {
 311         struct usb_serial *serial = port->serial;
 312         struct ch341_private *priv = usb_get_serial_port_data(port);
 313         int r;
 314
 315         r = ch341_configure(serial->dev, priv);
 316         if (r)
 317                 goto out;
 318
 319         if (tty)
 320                 ch341_set_termios(tty, port, NULL);
 321
 322         dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__);
 323         r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 324         if (r) {
 325                 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n",
 326                         __func__, r);
 327                 goto out;
 328         }
 329
 330         r = usb_serial_generic_open(tty, port);
 331
 332 out:    return r;
 333 }
 334
 335 /* Old_termios contains the original termios settings and
 336  * tty->termios contains the new setting to be used.
 337  */
 338 static void ch341_set_termios(struct tty_struct *tty,
 339                 struct usb_serial_port *port, struct ktermios *old_termios)
 340 {
 341         struct ch341_private *priv = usb_get_serial_port_data(port);
 342         unsigned baud_rate;
 343         unsigned long flags;
 344
 345         baud_rate = tty_get_baud_rate(tty);
 346
 347         priv->baud_rate = baud_rate;
 348
 349         if (baud_rate) {
 350                 spin_lock_irqsave(&priv->lock, flags);
 351                 priv->line_control |= (CH341_BIT_DTR | CH341_BIT_RTS);
 352                 spin_unlock_irqrestore(&priv->lock, flags);
 353                 ch341_set_baudrate(port->serial->dev, priv);
 354         } else {
 355                 spin_lock_irqsave(&priv->lock, flags);
 356                 priv->line_control &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
 357                 spin_unlock_irqrestore(&priv->lock, flags);
 358         }
 359
 360         ch341_set_handshake(port->serial->dev, priv->line_control);
 361
 362         /* Unimplemented:
 363          * (cflag & CSIZE) : data bits [5, 8]
 364          * (cflag & PARENB) : parity {NONE, EVEN, ODD}
 365          * (cflag & CSTOPB) : stop bits [1, 2]
 366          */
 367 }
 368
 369 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
 370 {
 371         const uint16_t ch341_break_reg =
 372                 CH341_REG_BREAK1 | ((uint16_t) CH341_REG_BREAK2 << 8);
 373         struct usb_serial_port *port = tty->driver_data;
 374         int r;
 375         uint16_t reg_contents;
 376         uint8_t *break_reg;
 377
 378         break_reg = kmalloc(2, GFP_KERNEL);
 379         if (!break_reg)
 380                 return;
 381
 382         r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
 383                         ch341_break_reg, 0, break_reg, 2);
 384         if (r < 0) {
 385                 dev_err(&port->dev, "%s - USB control read error (%d)\n",
 386                                 __func__, r);
 387                 goto out;
 388         }
 389         dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
 390                 __func__, break_reg[0], break_reg[1]);
 391         if (break_state != 0) {
 392                 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
 393                 break_reg[0] &= ~CH341_NBREAK_BITS_REG1;
 394                 break_reg[1] &= ~CH341_NBREAK_BITS_REG2;
 395         } else {
 396                 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
 397                 break_reg[0] |= CH341_NBREAK_BITS_REG1;
 398                 break_reg[1] |= CH341_NBREAK_BITS_REG2;
 399         }
 400         dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
 401                 __func__, break_reg[0], break_reg[1]);
 402         reg_contents = get_unaligned_le16(break_reg);
 403         r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
 404                         ch341_break_reg, reg_contents);
 405         if (r < 0)
 406                 dev_err(&port->dev, "%s - USB control write error (%d)\n",
 407                                 __func__, r);
 408 out:
 409         kfree(break_reg);
 410 }
 411
 412 static int ch341_tiocmset(struct tty_struct *tty,
 413                           unsigned int set, unsigned int clear)
 414 {
 415         struct usb_serial_port *port = tty->driver_data;
 416         struct ch341_private *priv = usb_get_serial_port_data(port);
 417         unsigned long flags;
 418         u8 control;
 419
 420         spin_lock_irqsave(&priv->lock, flags);
 421         if (set & TIOCM_RTS)
 422                 priv->line_control |= CH341_BIT_RTS;
 423         if (set & TIOCM_DTR)
 424                 priv->line_control |= CH341_BIT_DTR;
 425         if (clear & TIOCM_RTS)
 426                 priv->line_control &= ~CH341_BIT_RTS;
 427         if (clear & TIOCM_DTR)
 428                 priv->line_control &= ~CH341_BIT_DTR;
 429         control = priv->line_control;
 430         spin_unlock_irqrestore(&priv->lock, flags);
 431
 432         return ch341_set_handshake(port->serial->dev, control);
 433 }
 434
 435 static void ch341_update_line_status(struct usb_serial_port *port,
 436                                         unsigned char *data, size_t len)
 437 {
 438         struct ch341_private *priv = usb_get_serial_port_data(port);
 439         struct tty_struct *tty;
 440         unsigned long flags;
 441         u8 status;
 442         u8 delta;
 443
 444         if (len < 4)
 445                 return;
 446
 447         status = ~data[2] & CH341_BITS_MODEM_STAT;
 448
 449         spin_lock_irqsave(&priv->lock, flags);
 450         delta = status ^ priv->line_status;
 451         priv->line_status = status;
 452         spin_unlock_irqrestore(&priv->lock, flags);
 453
 454         if (data[1] & CH341_MULT_STAT)
 455                 dev_dbg(&port->dev, "%s - multiple status change\n", __func__);
 456
 457         if (!delta)
 458                 return;
 459
 460         if (delta & CH341_BIT_CTS)
 461                 port->icount.cts++;
 462         if (delta & CH341_BIT_DSR)
 463                 port->icount.dsr++;
 464         if (delta & CH341_BIT_RI)
 465                 port->icount.rng++;
 466         if (delta & CH341_BIT_DCD) {
 467                 port->icount.dcd++;
 468                 tty = tty_port_tty_get(&port->port);
 469                 if (tty) {
 470                         usb_serial_handle_dcd_change(port, tty,
 471                                                 status & CH341_BIT_DCD);
 472                         tty_kref_put(tty);
 473                 }
 474         }
 475
 476         wake_up_interruptible(&port->port.delta_msr_wait);
 477 }
 478
 479 static void ch341_read_int_callback(struct urb *urb)
 480 {
 481         struct usb_serial_port *port = urb->context;
 482         unsigned char *data = urb->transfer_buffer;
 483         unsigned int len = urb->actual_length;
 484         int status;
 485
 486         switch (urb->status) {
 487         case 0:
 488                 /* success */
 489                 break;
 490         case -ECONNRESET:
 491         case -ENOENT:
 492         case -ESHUTDOWN:
 493                 /* this urb is terminated, clean up */
 494                 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n",
 495                         __func__, urb->status);
 496                 return;
 497         default:
 498                 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n",
 499                         __func__, urb->status);
 500                 goto exit;
 501         }
 502
 503         usb_serial_debug_data(&port->dev, __func__, len, data);
 504         ch341_update_line_status(port, data, len);
 505 exit:
 506         status = usb_submit_urb(urb, GFP_ATOMIC);
 507         if (status) {
 508                 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n",
 509                         __func__, status);
 510         }
 511 }
 512
 513 static int ch341_tiocmget(struct tty_struct *tty)
 514 {
 515         struct usb_serial_port *port = tty->driver_data;
 516         struct ch341_private *priv = usb_get_serial_port_data(port);
 517         unsigned long flags;
 518         u8 mcr;
 519         u8 status;
 520         unsigned int result;
 521
 522         spin_lock_irqsave(&priv->lock, flags);
 523         mcr = priv->line_control;
 524         status = priv->line_status;
 525         spin_unlock_irqrestore(&priv->lock, flags);
 526
 527         result = ((mcr & CH341_BIT_DTR)         ? TIOCM_DTR : 0)
 528                   | ((mcr & CH341_BIT_RTS)      ? TIOCM_RTS : 0)
 529                   | ((status & CH341_BIT_CTS)   ? TIOCM_CTS : 0)
 530                   | ((status & CH341_BIT_DSR)   ? TIOCM_DSR : 0)
 531                   | ((status & CH341_BIT_RI)    ? TIOCM_RI  : 0)
 532                   | ((status & CH341_BIT_DCD)   ? TIOCM_CD  : 0);
 533
 534         dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
 535
 536         return result;
 537 }
 538
 539 static int ch341_reset_resume(struct usb_serial *serial)
 540 {
 541         struct ch341_private *priv;
 542
 543         priv = usb_get_serial_port_data(serial->port[0]);
 544
 545         /* reconfigure ch341 serial port after bus-reset */
 546         ch341_configure(serial->dev, priv);
 547
 548         return 0;
 549 }
 550
 551 static struct usb_serial_driver ch341_device = {
 552         .driver = {
 553                 .owner  = THIS_MODULE,
 554                 .name   = "ch341-uart",
 555         },
 556         .id_table          = id_table,
 557         .num_ports         = 1,
 558         .open              = ch341_open,
 559         .dtr_rts           = ch341_dtr_rts,
 560         .carrier_raised    = ch341_carrier_raised,
 561         .close             = ch341_close,
 562         .set_termios       = ch341_set_termios,
 563         .break_ctl         = ch341_break_ctl,
 564         .tiocmget          = ch341_tiocmget,
 565         .tiocmset          = ch341_tiocmset,
 566         .tiocmiwait        = usb_serial_generic_tiocmiwait,
 567         .read_int_callback = ch341_read_int_callback,
 568         .port_probe        = ch341_port_probe,
 569         .port_remove       = ch341_port_remove,
 570         .reset_resume      = ch341_reset_resume,
 571 };
 572
 573 static struct usb_serial_driver * const serial_drivers[] = {
 574         &ch341_device, NULL
 575 };
 576
 577 module_usb_serial_driver(serial_drivers, id_table);
 578
 579 MODULE_LICENSE("GPL");