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 priv->line_control = CH341_BIT_RTS | CH341_BIT_DTR; 257 258 r = ch341_configure(port->serial->dev, priv); 259 if (r < 0) 260 goto error; 261 262 usb_set_serial_port_data(port, priv); 263 return 0; 264 265 error: kfree(priv); 266 return r; 267 } 268 269 static int ch341_port_remove(struct usb_serial_port *port) 270 { 271 struct ch341_private *priv; 272 273 priv = usb_get_serial_port_data(port); 274 kfree(priv); 275 276 return 0; 277 } 278 279 static int ch341_carrier_raised(struct usb_serial_port *port) 280 { 281 struct ch341_private *priv = usb_get_serial_port_data(port); 282 if (priv->line_status & CH341_BIT_DCD) 283 return 1; 284 return 0; 285 } 286 287 static void ch341_dtr_rts(struct usb_serial_port *port, int on) 288 { 289 struct ch341_private *priv = usb_get_serial_port_data(port); 290 unsigned long flags; 291 292 /* drop DTR and RTS */ 293 spin_lock_irqsave(&priv->lock, flags); 294 if (on) 295 priv->line_control |= CH341_BIT_RTS | CH341_BIT_DTR; 296 else 297 priv->line_control &= ~(CH341_BIT_RTS | CH341_BIT_DTR); 298 spin_unlock_irqrestore(&priv->lock, flags); 299 ch341_set_handshake(port->serial->dev, priv->line_control); 300 } 301 302 static void ch341_close(struct usb_serial_port *port) 303 { 304 usb_serial_generic_close(port); 305 usb_kill_urb(port->interrupt_in_urb); 306 } 307 308 309 /* open this device, set default parameters */ 310 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port) 311 { 312 struct usb_serial *serial = port->serial; 313 struct ch341_private *priv = usb_get_serial_port_data(port); 314 int r; 315 316 r = ch341_configure(serial->dev, priv); 317 if (r) 318 goto out; 319 320 if (tty) 321 ch341_set_termios(tty, port, NULL); 322 323 dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__); 324 r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); 325 if (r) { 326 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n", 327 __func__, r); 328 ch341_close(port); 329 goto out; 330 } 331 332 r = usb_serial_generic_open(tty, port); 333 334 out: return r; 335 } 336 337 /* Old_termios contains the original termios settings and 338 * tty->termios contains the new setting to be used. 339 */ 340 static void ch341_set_termios(struct tty_struct *tty, 341 struct usb_serial_port *port, struct ktermios *old_termios) 342 { 343 struct ch341_private *priv = usb_get_serial_port_data(port); 344 unsigned baud_rate; 345 unsigned long flags; 346 347 baud_rate = tty_get_baud_rate(tty); 348 349 priv->baud_rate = baud_rate; 350 351 if (baud_rate) { 352 spin_lock_irqsave(&priv->lock, flags); 353 priv->line_control |= (CH341_BIT_DTR | CH341_BIT_RTS); 354 spin_unlock_irqrestore(&priv->lock, flags); 355 ch341_set_baudrate(port->serial->dev, priv); 356 } else { 357 spin_lock_irqsave(&priv->lock, flags); 358 priv->line_control &= ~(CH341_BIT_DTR | CH341_BIT_RTS); 359 spin_unlock_irqrestore(&priv->lock, flags); 360 } 361 362 ch341_set_handshake(port->serial->dev, priv->line_control); 363 364 /* Unimplemented: 365 * (cflag & CSIZE) : data bits [5, 8] 366 * (cflag & PARENB) : parity {NONE, EVEN, ODD} 367 * (cflag & CSTOPB) : stop bits [1, 2] 368 */ 369 } 370 371 static void ch341_break_ctl(struct tty_struct *tty, int break_state) 372 { 373 const uint16_t ch341_break_reg = 374 CH341_REG_BREAK1 | ((uint16_t) CH341_REG_BREAK2 << 8); 375 struct usb_serial_port *port = tty->driver_data; 376 int r; 377 uint16_t reg_contents; 378 uint8_t *break_reg; 379 380 break_reg = kmalloc(2, GFP_KERNEL); 381 if (!break_reg) 382 return; 383 384 r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG, 385 ch341_break_reg, 0, break_reg, 2); 386 if (r < 0) { 387 dev_err(&port->dev, "%s - USB control read error (%d)\n", 388 __func__, r); 389 goto out; 390 } 391 dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n", 392 __func__, break_reg[0], break_reg[1]); 393 if (break_state != 0) { 394 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__); 395 break_reg[0] &= ~CH341_NBREAK_BITS_REG1; 396 break_reg[1] &= ~CH341_NBREAK_BITS_REG2; 397 } else { 398 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__); 399 break_reg[0] |= CH341_NBREAK_BITS_REG1; 400 break_reg[1] |= CH341_NBREAK_BITS_REG2; 401 } 402 dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n", 403 __func__, break_reg[0], break_reg[1]); 404 reg_contents = get_unaligned_le16(break_reg); 405 r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG, 406 ch341_break_reg, reg_contents); 407 if (r < 0) 408 dev_err(&port->dev, "%s - USB control write error (%d)\n", 409 __func__, r); 410 out: 411 kfree(break_reg); 412 } 413 414 static int ch341_tiocmset(struct tty_struct *tty, 415 unsigned int set, unsigned int clear) 416 { 417 struct usb_serial_port *port = tty->driver_data; 418 struct ch341_private *priv = usb_get_serial_port_data(port); 419 unsigned long flags; 420 u8 control; 421 422 spin_lock_irqsave(&priv->lock, flags); 423 if (set & TIOCM_RTS) 424 priv->line_control |= CH341_BIT_RTS; 425 if (set & TIOCM_DTR) 426 priv->line_control |= CH341_BIT_DTR; 427 if (clear & TIOCM_RTS) 428 priv->line_control &= ~CH341_BIT_RTS; 429 if (clear & TIOCM_DTR) 430 priv->line_control &= ~CH341_BIT_DTR; 431 control = priv->line_control; 432 spin_unlock_irqrestore(&priv->lock, flags); 433 434 return ch341_set_handshake(port->serial->dev, control); 435 } 436 437 static void ch341_update_line_status(struct usb_serial_port *port, 438 unsigned char *data, size_t len) 439 { 440 struct ch341_private *priv = usb_get_serial_port_data(port); 441 struct tty_struct *tty; 442 unsigned long flags; 443 u8 status; 444 u8 delta; 445 446 if (len < 4) 447 return; 448 449 status = ~data[2] & CH341_BITS_MODEM_STAT; 450 451 spin_lock_irqsave(&priv->lock, flags); 452 delta = status ^ priv->line_status; 453 priv->line_status = status; 454 spin_unlock_irqrestore(&priv->lock, flags); 455 456 if (data[1] & CH341_MULT_STAT) 457 dev_dbg(&port->dev, "%s - multiple status change\n", __func__); 458 459 if (!delta) 460 return; 461 462 if (delta & CH341_BIT_CTS) 463 port->icount.cts++; 464 if (delta & CH341_BIT_DSR) 465 port->icount.dsr++; 466 if (delta & CH341_BIT_RI) 467 port->icount.rng++; 468 if (delta & CH341_BIT_DCD) { 469 port->icount.dcd++; 470 tty = tty_port_tty_get(&port->port); 471 if (tty) { 472 usb_serial_handle_dcd_change(port, tty, 473 status & CH341_BIT_DCD); 474 tty_kref_put(tty); 475 } 476 } 477 478 wake_up_interruptible(&port->port.delta_msr_wait); 479 } 480 481 static void ch341_read_int_callback(struct urb *urb) 482 { 483 struct usb_serial_port *port = urb->context; 484 unsigned char *data = urb->transfer_buffer; 485 unsigned int len = urb->actual_length; 486 int status; 487 488 switch (urb->status) { 489 case 0: 490 /* success */ 491 break; 492 case -ECONNRESET: 493 case -ENOENT: 494 case -ESHUTDOWN: 495 /* this urb is terminated, clean up */ 496 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n", 497 __func__, urb->status); 498 return; 499 default: 500 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n", 501 __func__, urb->status); 502 goto exit; 503 } 504 505 usb_serial_debug_data(&port->dev, __func__, len, data); 506 ch341_update_line_status(port, data, len); 507 exit: 508 status = usb_submit_urb(urb, GFP_ATOMIC); 509 if (status) { 510 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n", 511 __func__, status); 512 } 513 } 514 515 static int ch341_tiocmget(struct tty_struct *tty) 516 { 517 struct usb_serial_port *port = tty->driver_data; 518 struct ch341_private *priv = usb_get_serial_port_data(port); 519 unsigned long flags; 520 u8 mcr; 521 u8 status; 522 unsigned int result; 523 524 spin_lock_irqsave(&priv->lock, flags); 525 mcr = priv->line_control; 526 status = priv->line_status; 527 spin_unlock_irqrestore(&priv->lock, flags); 528 529 result = ((mcr & CH341_BIT_DTR) ? TIOCM_DTR : 0) 530 | ((mcr & CH341_BIT_RTS) ? TIOCM_RTS : 0) 531 | ((status & CH341_BIT_CTS) ? TIOCM_CTS : 0) 532 | ((status & CH341_BIT_DSR) ? TIOCM_DSR : 0) 533 | ((status & CH341_BIT_RI) ? TIOCM_RI : 0) 534 | ((status & CH341_BIT_DCD) ? TIOCM_CD : 0); 535 536 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result); 537 538 return result; 539 } 540 541 static int ch341_reset_resume(struct usb_serial *serial) 542 { 543 struct ch341_private *priv; 544 545 priv = usb_get_serial_port_data(serial->port[0]); 546 547 /* reconfigure ch341 serial port after bus-reset */ 548 ch341_configure(serial->dev, priv); 549 550 return 0; 551 } 552 553 static struct usb_serial_driver ch341_device = { 554 .driver = { 555 .owner = THIS_MODULE, 556 .name = "ch341-uart", 557 }, 558 .id_table = id_table, 559 .num_ports = 1, 560 .open = ch341_open, 561 .dtr_rts = ch341_dtr_rts, 562 .carrier_raised = ch341_carrier_raised, 563 .close = ch341_close, 564 .set_termios = ch341_set_termios, 565 .break_ctl = ch341_break_ctl, 566 .tiocmget = ch341_tiocmget, 567 .tiocmset = ch341_tiocmset, 568 .tiocmiwait = usb_serial_generic_tiocmiwait, 569 .read_int_callback = ch341_read_int_callback, 570 .port_probe = ch341_port_probe, 571 .port_remove = ch341_port_remove, 572 .reset_resume = ch341_reset_resume, 573 }; 574 575 static struct usb_serial_driver * const serial_drivers[] = { 576 &ch341_device, NULL 577 }; 578 579 module_usb_serial_driver(serial_drivers, id_table); 580 581 MODULE_LICENSE("GPL"); 582