drivers/usb/serial/ch341.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright 2007, Frank A Kingswood <frank@kingswood-consulting.co.uk>
   4  * Copyright 2007, Werner Cornelius <werner@cornelius-consult.de>
   5  * Copyright 2009, Boris Hajduk <boris@hajduk.org>
   6  *
   7  * ch341.c implements a serial port driver for the Winchiphead CH341.
   8  *
   9  * The CH341 device can be used to implement an RS232 asynchronous
  10  * serial port, an IEEE-1284 parallel printer port or a memory-like
  11  * interface. In all cases the CH341 supports an I2C interface as well.
  12  * This driver only supports the asynchronous serial interface.
  13  */
  14
  15 #include <linux/kernel.h>
  16 #include <linux/tty.h>
  17 #include <linux/module.h>
  18 #include <linux/slab.h>
  19 #include <linux/usb.h>
  20 #include <linux/usb/serial.h>
  21 #include <linux/serial.h>
  22 #include <asm/unaligned.h>
  23
  24 #define DEFAULT_BAUD_RATE 9600
  25 #define DEFAULT_TIMEOUT   1000
  26
  27 /* flags for IO-Bits */
  28 #define CH341_BIT_RTS (1 << 6)
  29 #define CH341_BIT_DTR (1 << 5)
  30
  31 /******************************/
  32 /* interrupt pipe definitions */
  33 /******************************/
  34 /* always 4 interrupt bytes */
  35 /* first irq byte normally 0x08 */
  36 /* second irq byte base 0x7d + below */
  37 /* third irq byte base 0x94 + below */
  38 /* fourth irq byte normally 0xee */
  39
  40 /* second interrupt byte */
  41 #define CH341_MULT_STAT 0x04 /* multiple status since last interrupt event */
  42
  43 /* status returned in third interrupt answer byte, inverted in data
  44    from irq */
  45 #define CH341_BIT_CTS 0x01
  46 #define CH341_BIT_DSR 0x02
  47 #define CH341_BIT_RI  0x04
  48 #define CH341_BIT_DCD 0x08
  49 #define CH341_BITS_MODEM_STAT 0x0f /* all bits */
  50
  51 /* Break support - the information used to implement this was gleaned from
  52  * the Net/FreeBSD uchcom.c driver by Takanori Watanabe.  Domo arigato.
  53  */
  54
  55 #define CH341_REQ_READ_VERSION 0x5F
  56 #define CH341_REQ_WRITE_REG    0x9A
  57 #define CH341_REQ_READ_REG     0x95
  58 #define CH341_REQ_SERIAL_INIT  0xA1
  59 #define CH341_REQ_MODEM_CTRL   0xA4
  60
  61 #define CH341_REG_BREAK        0x05
  62 #define CH341_REG_PRESCALER    0x12
  63 #define CH341_REG_DIVISOR      0x13
  64 #define CH341_REG_LCR          0x18
  65 #define CH341_REG_LCR2         0x25
  66
  67 #define CH341_NBREAK_BITS      0x01
  68
  69 #define CH341_LCR_ENABLE_RX    0x80
  70 #define CH341_LCR_ENABLE_TX    0x40
  71 #define CH341_LCR_MARK_SPACE   0x20
  72 #define CH341_LCR_PAR_EVEN     0x10
  73 #define CH341_LCR_ENABLE_PAR   0x08
  74 #define CH341_LCR_STOP_BITS_2  0x04
  75 #define CH341_LCR_CS8          0x03
  76 #define CH341_LCR_CS7          0x02
  77 #define CH341_LCR_CS6          0x01
  78 #define CH341_LCR_CS5          0x00
  79
  80 #define CH341_QUIRK_LIMITED_PRESCALER   BIT(0)
  81 #define CH341_QUIRK_SIMULATE_BREAK      BIT(1)
  82
  83 static const struct usb_device_id id_table[] = {
  84         { USB_DEVICE(0x1a86, 0x5523) },
  85         { USB_DEVICE(0x1a86, 0x7522) },
  86         { USB_DEVICE(0x1a86, 0x7523) },
  87         { USB_DEVICE(0x2184, 0x0057) },
  88         { USB_DEVICE(0x4348, 0x5523) },
  89         { USB_DEVICE(0x9986, 0x7523) },
  90         { },
  91 };
  92 MODULE_DEVICE_TABLE(usb, id_table);
  93
  94 struct ch341_private {
  95         spinlock_t lock; /* access lock */
  96         unsigned baud_rate; /* set baud rate */
  97         u8 mcr;
  98         u8 msr;
  99         u8 lcr;
 100
 101         unsigned long quirks;
 102         u8 version;
 103
 104         unsigned long break_end;
 105 };
 106
 107 static void ch341_set_termios(struct tty_struct *tty,
 108                               struct usb_serial_port *port,
 109                               struct ktermios *old_termios);
 110
 111 static int ch341_control_out(struct usb_device *dev, u8 request,
 112                              u16 value, u16 index)
 113 {
 114         int r;
 115
 116         dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x)\n", __func__,
 117                 request, value, index);
 118
 119         r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
 120                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 121                             value, index, NULL, 0, DEFAULT_TIMEOUT);
 122         if (r < 0)
 123                 dev_err(&dev->dev, "failed to send control message: %d\n", r);
 124
 125         return r;
 126 }
 127
 128 static int ch341_control_in(struct usb_device *dev,
 129                             u8 request, u16 value, u16 index,
 130                             char *buf, unsigned bufsize)
 131 {
 132         int r;
 133
 134         dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x,%u)\n", __func__,
 135                 request, value, index, bufsize);
 136
 137         r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
 138                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
 139                             value, index, buf, bufsize, DEFAULT_TIMEOUT);
 140         if (r < (int)bufsize) {
 141                 if (r >= 0) {
 142                         dev_err(&dev->dev,
 143                                 "short control message received (%d < %u)\n",
 144                                 r, bufsize);
 145                         r = -EIO;
 146                 }
 147
 148                 dev_err(&dev->dev, "failed to receive control message: %d\n",
 149                         r);
 150                 return r;
 151         }
 152
 153         return 0;
 154 }
 155
 156 #define CH341_CLKRATE           48000000
 157 #define CH341_CLK_DIV(ps, fact) (1 << (12 - 3 * (ps) - (fact)))
 158 #define CH341_MIN_RATE(ps)      (CH341_CLKRATE / (CH341_CLK_DIV((ps), 1) * 512))
 159
 160 static const speed_t ch341_min_rates[] = {
 161         CH341_MIN_RATE(0),
 162         CH341_MIN_RATE(1),
 163         CH341_MIN_RATE(2),
 164         CH341_MIN_RATE(3),
 165 };
 166
 167 /* Supported range is 46 to 3000000 bps. */
 168 #define CH341_MIN_BPS   DIV_ROUND_UP(CH341_CLKRATE, CH341_CLK_DIV(0, 0) * 256)
 169 #define CH341_MAX_BPS   (CH341_CLKRATE / (CH341_CLK_DIV(3, 0) * 2))
 170
 171 /*
 172  * The device line speed is given by the following equation:
 173  *
 174  *      baudrate = 48000000 / (2^(12 - 3 * ps - fact) * div), where
 175  *
 176  *              0 <= ps <= 3,
 177  *              0 <= fact <= 1,
 178  *              2 <= div <= 256 if fact = 0, or
 179  *              9 <= div <= 256 if fact = 1
 180  */
 181 static int ch341_get_divisor(struct ch341_private *priv, speed_t speed)
 182 {
 183         unsigned int fact, div, clk_div;
 184         bool force_fact0 = false;
 185         int ps;
 186
 187         /*
 188          * Clamp to supported range, this makes the (ps < 0) and (div < 2)
 189          * sanity checks below redundant.
 190          */
 191         speed = clamp_val(speed, CH341_MIN_BPS, CH341_MAX_BPS);
 192
 193         /*
 194          * Start with highest possible base clock (fact = 1) that will give a
 195          * divisor strictly less than 512.
 196          */
 197         fact = 1;
 198         for (ps = 3; ps >= 0; ps--) {
 199                 if (speed > ch341_min_rates[ps])
 200                         break;
 201         }
 202
 203         if (ps < 0)
 204                 return -EINVAL;
 205
 206         /* Determine corresponding divisor, rounding down. */
 207         clk_div = CH341_CLK_DIV(ps, fact);
 208         div = CH341_CLKRATE / (clk_div * speed);
 209
 210         /* Some devices require a lower base clock if ps < 3. */
 211         if (ps < 3 && (priv->quirks & CH341_QUIRK_LIMITED_PRESCALER))
 212                 force_fact0 = true;
 213
 214         /* Halve base clock (fact = 0) if required. */
 215         if (div < 9 || div > 255 || force_fact0) {
 216                 div /= 2;
 217                 clk_div *= 2;
 218                 fact = 0;
 219         }
 220
 221         if (div < 2)
 222                 return -EINVAL;
 223
 224         /*
 225          * Pick next divisor if resulting rate is closer to the requested one,
 226          * scale up to avoid rounding errors on low rates.
 227          */
 228         if (16 * CH341_CLKRATE / (clk_div * div) - 16 * speed >=
 229                         16 * speed - 16 * CH341_CLKRATE / (clk_div * (div + 1)))
 230                 div++;
 231
 232         /*
 233          * Prefer lower base clock (fact = 0) if even divisor.
 234          *
 235          * Note that this makes the receiver more tolerant to errors.
 236          */
 237         if (fact == 1 && div % 2 == 0) {
 238                 div /= 2;
 239                 fact = 0;
 240         }
 241
 242         return (0x100 - div) << 8 | fact << 2 | ps;
 243 }
 244
 245 static int ch341_set_baudrate_lcr(struct usb_device *dev,
 246                                   struct ch341_private *priv,
 247                                   speed_t baud_rate, u8 lcr)
 248 {
 249         int val;
 250         int r;
 251
 252         if (!baud_rate)
 253                 return -EINVAL;
 254
 255         val = ch341_get_divisor(priv, baud_rate);
 256         if (val < 0)
 257                 return -EINVAL;
 258
 259         /*
 260          * CH341A buffers data until a full endpoint-size packet (32 bytes)
 261          * has been received unless bit 7 is set.
 262          */
 263         val |= BIT(7);
 264
 265         r = ch341_control_out(dev, CH341_REQ_WRITE_REG,
 266                               CH341_REG_DIVISOR << 8 | CH341_REG_PRESCALER,
 267                               val);
 268         if (r)
 269                 return r;
 270
 271         /*
 272          * Chip versions before version 0x30 as read using
 273          * CH341_REQ_READ_VERSION used separate registers for line control
 274          * (stop bits, parity and word length). Version 0x30 and above use
 275          * CH341_REG_LCR only and CH341_REG_LCR2 is always set to zero.
 276          */
 277         if (priv->version < 0x30)
 278                 return 0;
 279
 280         r = ch341_control_out(dev, CH341_REQ_WRITE_REG,
 281                               CH341_REG_LCR2 << 8 | CH341_REG_LCR, lcr);
 282         if (r)
 283                 return r;
 284
 285         return r;
 286 }
 287
 288 static int ch341_set_handshake(struct usb_device *dev, u8 control)
 289 {
 290         return ch341_control_out(dev, CH341_REQ_MODEM_CTRL, ~control, 0);
 291 }
 292
 293 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
 294 {
 295         const unsigned int size = 2;
 296         char *buffer;
 297         int r;
 298         unsigned long flags;
 299
 300         buffer = kmalloc(size, GFP_KERNEL);
 301         if (!buffer)
 302                 return -ENOMEM;
 303
 304         r = ch341_control_in(dev, CH341_REQ_READ_REG, 0x0706, 0, buffer, size);
 305         if (r < 0)
 306                 goto out;
 307
 308         spin_lock_irqsave(&priv->lock, flags);
 309         priv->msr = (~(*buffer)) & CH341_BITS_MODEM_STAT;
 310         spin_unlock_irqrestore(&priv->lock, flags);
 311
 312 out:    kfree(buffer);
 313         return r;
 314 }
 315
 316 /* -------------------------------------------------------------------------- */
 317
 318 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
 319 {
 320         const unsigned int size = 2;
 321         char *buffer;
 322         int r;
 323
 324         buffer = kmalloc(size, GFP_KERNEL);
 325         if (!buffer)
 326                 return -ENOMEM;
 327
 328         /* expect two bytes 0x27 0x00 */
 329         r = ch341_control_in(dev, CH341_REQ_READ_VERSION, 0, 0, buffer, size);
 330         if (r < 0)
 331                 goto out;
 332
 333         priv->version = buffer[0];
 334         dev_dbg(&dev->dev, "Chip version: 0x%02x\n", priv->version);
 335
 336         r = ch341_control_out(dev, CH341_REQ_SERIAL_INIT, 0, 0);
 337         if (r < 0)
 338                 goto out;
 339
 340         r = ch341_set_baudrate_lcr(dev, priv, priv->baud_rate, priv->lcr);
 341         if (r < 0)
 342                 goto out;
 343
 344         r = ch341_set_handshake(dev, priv->mcr);
 345
 346 out:    kfree(buffer);
 347         return r;
 348 }
 349
 350 static int ch341_detect_quirks(struct usb_serial_port *port)
 351 {
 352         struct ch341_private *priv = usb_get_serial_port_data(port);
 353         struct usb_device *udev = port->serial->dev;
 354         const unsigned int size = 2;
 355         unsigned long quirks = 0;
 356         char *buffer;
 357         int r;
 358
 359         buffer = kmalloc(size, GFP_KERNEL);
 360         if (!buffer)
 361                 return -ENOMEM;
 362
 363         /*
 364          * A subset of CH34x devices does not support all features. The
 365          * prescaler is limited and there is no support for sending a RS232
 366          * break condition. A read failure when trying to set up the latter is
 367          * used to detect these devices.
 368          */
 369         r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), CH341_REQ_READ_REG,
 370                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
 371                             CH341_REG_BREAK, 0, buffer, size, DEFAULT_TIMEOUT);
 372         if (r == -EPIPE) {
 373                 dev_info(&port->dev, "break control not supported, using simulated break\n");
 374                 quirks = CH341_QUIRK_LIMITED_PRESCALER | CH341_QUIRK_SIMULATE_BREAK;
 375                 r = 0;
 376                 goto out;
 377         }
 378
 379         if (r != size) {
 380                 if (r >= 0)
 381                         r = -EIO;
 382                 dev_err(&port->dev, "failed to read break control: %d\n", r);
 383                 goto out;
 384         }
 385
 386         r = 0;
 387 out:
 388         kfree(buffer);
 389
 390         if (quirks) {
 391                 dev_dbg(&port->dev, "enabling quirk flags: 0x%02lx\n", quirks);
 392                 priv->quirks |= quirks;
 393         }
 394
 395         return r;
 396 }
 397
 398 static int ch341_port_probe(struct usb_serial_port *port)
 399 {
 400         struct ch341_private *priv;
 401         int r;
 402
 403         priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
 404         if (!priv)
 405                 return -ENOMEM;
 406
 407         spin_lock_init(&priv->lock);
 408         priv->baud_rate = DEFAULT_BAUD_RATE;
 409         /*
 410          * Some CH340 devices appear unable to change the initial LCR
 411          * settings, so set a sane 8N1 default.
 412          */
 413         priv->lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8;
 414
 415         r = ch341_configure(port->serial->dev, priv);
 416         if (r < 0)
 417                 goto error;
 418
 419         usb_set_serial_port_data(port, priv);
 420
 421         r = ch341_detect_quirks(port);
 422         if (r < 0)
 423                 goto error;
 424
 425         return 0;
 426
 427 error:  kfree(priv);
 428         return r;
 429 }
 430
 431 static void ch341_port_remove(struct usb_serial_port *port)
 432 {
 433         struct ch341_private *priv;
 434
 435         priv = usb_get_serial_port_data(port);
 436         kfree(priv);
 437 }
 438
 439 static int ch341_carrier_raised(struct usb_serial_port *port)
 440 {
 441         struct ch341_private *priv = usb_get_serial_port_data(port);
 442         if (priv->msr & CH341_BIT_DCD)
 443                 return 1;
 444         return 0;
 445 }
 446
 447 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
 448 {
 449         struct ch341_private *priv = usb_get_serial_port_data(port);
 450         unsigned long flags;
 451
 452         /* drop DTR and RTS */
 453         spin_lock_irqsave(&priv->lock, flags);
 454         if (on)
 455                 priv->mcr |= CH341_BIT_RTS | CH341_BIT_DTR;
 456         else
 457                 priv->mcr &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
 458         spin_unlock_irqrestore(&priv->lock, flags);
 459         ch341_set_handshake(port->serial->dev, priv->mcr);
 460 }
 461
 462 static void ch341_close(struct usb_serial_port *port)
 463 {
 464         usb_serial_generic_close(port);
 465         usb_kill_urb(port->interrupt_in_urb);
 466 }
 467
 468
 469 /* open this device, set default parameters */
 470 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
 471 {
 472         struct ch341_private *priv = usb_get_serial_port_data(port);
 473         int r;
 474
 475         if (tty)
 476                 ch341_set_termios(tty, port, NULL);
 477
 478         dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__);
 479         r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 480         if (r) {
 481                 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n",
 482                         __func__, r);
 483                 return r;
 484         }
 485
 486         r = ch341_get_status(port->serial->dev, priv);
 487         if (r < 0) {
 488                 dev_err(&port->dev, "failed to read modem status: %d\n", r);
 489                 goto err_kill_interrupt_urb;
 490         }
 491
 492         r = usb_serial_generic_open(tty, port);
 493         if (r)
 494                 goto err_kill_interrupt_urb;
 495
 496         return 0;
 497
 498 err_kill_interrupt_urb:
 499         usb_kill_urb(port->interrupt_in_urb);
 500
 501         return r;
 502 }
 503
 504 /* Old_termios contains the original termios settings and
 505  * tty->termios contains the new setting to be used.
 506  */
 507 static void ch341_set_termios(struct tty_struct *tty,
 508                 struct usb_serial_port *port, struct ktermios *old_termios)
 509 {
 510         struct ch341_private *priv = usb_get_serial_port_data(port);
 511         unsigned baud_rate;
 512         unsigned long flags;
 513         u8 lcr;
 514         int r;
 515
 516         /* redundant changes may cause the chip to lose bytes */
 517         if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
 518                 return;
 519
 520         baud_rate = tty_get_baud_rate(tty);
 521
 522         lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX;
 523
 524         switch (C_CSIZE(tty)) {
 525         case CS5:
 526                 lcr |= CH341_LCR_CS5;
 527                 break;
 528         case CS6:
 529                 lcr |= CH341_LCR_CS6;
 530                 break;
 531         case CS7:
 532                 lcr |= CH341_LCR_CS7;
 533                 break;
 534         case CS8:
 535                 lcr |= CH341_LCR_CS8;
 536                 break;
 537         }
 538
 539         if (C_PARENB(tty)) {
 540                 lcr |= CH341_LCR_ENABLE_PAR;
 541                 if (C_PARODD(tty) == 0)
 542                         lcr |= CH341_LCR_PAR_EVEN;
 543                 if (C_CMSPAR(tty))
 544                         lcr |= CH341_LCR_MARK_SPACE;
 545         }
 546
 547         if (C_CSTOPB(tty))
 548                 lcr |= CH341_LCR_STOP_BITS_2;
 549
 550         if (baud_rate) {
 551                 priv->baud_rate = baud_rate;
 552
 553                 r = ch341_set_baudrate_lcr(port->serial->dev, priv,
 554                                            priv->baud_rate, lcr);
 555                 if (r < 0 && old_termios) {
 556                         priv->baud_rate = tty_termios_baud_rate(old_termios);
 557                         tty_termios_copy_hw(&tty->termios, old_termios);
 558                 } else if (r == 0) {
 559                         priv->lcr = lcr;
 560                 }
 561         }
 562
 563         spin_lock_irqsave(&priv->lock, flags);
 564         if (C_BAUD(tty) == B0)
 565                 priv->mcr &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
 566         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
 567                 priv->mcr |= (CH341_BIT_DTR | CH341_BIT_RTS);
 568         spin_unlock_irqrestore(&priv->lock, flags);
 569
 570         ch341_set_handshake(port->serial->dev, priv->mcr);
 571 }
 572
 573 /*
 574  * A subset of all CH34x devices don't support a real break condition and
 575  * reading CH341_REG_BREAK fails (see also ch341_detect_quirks). This function
 576  * simulates a break condition by lowering the baud rate to the minimum
 577  * supported by the hardware upon enabling the break condition and sending
 578  * a NUL byte.
 579  *
 580  * Incoming data is corrupted while the break condition is being simulated.
 581  *
 582  * Normally the duration of the break condition can be controlled individually
 583  * by userspace using TIOCSBRK and TIOCCBRK or by passing an argument to
 584  * TCSBRKP. Due to how the simulation is implemented the duration can't be
 585  * controlled. The duration is always about (1s / 46bd * 9bit) = 196ms.
 586  */
 587 static void ch341_simulate_break(struct tty_struct *tty, int break_state)
 588 {
 589         struct usb_serial_port *port = tty->driver_data;
 590         struct ch341_private *priv = usb_get_serial_port_data(port);
 591         unsigned long now, delay;
 592         int r;
 593
 594         if (break_state != 0) {
 595                 dev_dbg(&port->dev, "enter break state requested\n");
 596
 597                 r = ch341_set_baudrate_lcr(port->serial->dev, priv,
 598                                 CH341_MIN_BPS,
 599                                 CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8);
 600                 if (r < 0) {
 601                         dev_err(&port->dev,
 602                                 "failed to change baud rate to %u: %d\n",
 603                                 CH341_MIN_BPS, r);
 604                         goto restore;
 605                 }
 606
 607                 r = tty_put_char(tty, '\0');
 608                 if (r < 0) {
 609                         dev_err(&port->dev,
 610                                 "failed to write NUL byte for simulated break condition: %d\n",
 611                                 r);
 612                         goto restore;
 613                 }
 614
 615                 /*
 616                  * Compute expected transmission duration including safety
 617                  * margin. The original baud rate is only restored after the
 618                  * computed point in time.
 619                  *
 620                  * 11 bits = 1 start, 8 data, 1 stop, 1 margin
 621                  */
 622                 priv->break_end = jiffies + (11 * HZ / CH341_MIN_BPS);
 623
 624                 return;
 625         }
 626
 627         dev_dbg(&port->dev, "leave break state requested\n");
 628
 629         now = jiffies;
 630
 631         if (time_before(now, priv->break_end)) {
 632                 /* Wait until NUL byte is written */
 633                 delay = priv->break_end - now;
 634                 dev_dbg(&port->dev,
 635                         "wait %d ms while transmitting NUL byte at %u baud\n",
 636                         jiffies_to_msecs(delay), CH341_MIN_BPS);
 637                 schedule_timeout_interruptible(delay);
 638         }
 639
 640 restore:
 641         /* Restore original baud rate */
 642         r = ch341_set_baudrate_lcr(port->serial->dev, priv, priv->baud_rate,
 643                                    priv->lcr);
 644         if (r < 0)
 645                 dev_err(&port->dev,
 646                         "restoring original baud rate of %u failed: %d\n",
 647                         priv->baud_rate, r);
 648 }
 649
 650 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
 651 {
 652         const uint16_t ch341_break_reg =
 653                         ((uint16_t) CH341_REG_LCR << 8) | CH341_REG_BREAK;
 654         struct usb_serial_port *port = tty->driver_data;
 655         struct ch341_private *priv = usb_get_serial_port_data(port);
 656         int r;
 657         uint16_t reg_contents;
 658         uint8_t *break_reg;
 659
 660         if (priv->quirks & CH341_QUIRK_SIMULATE_BREAK) {
 661                 ch341_simulate_break(tty, break_state);
 662                 return;
 663         }
 664
 665         break_reg = kmalloc(2, GFP_KERNEL);
 666         if (!break_reg)
 667                 return;
 668
 669         r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
 670                         ch341_break_reg, 0, break_reg, 2);
 671         if (r < 0) {
 672                 dev_err(&port->dev, "%s - USB control read error (%d)\n",
 673                                 __func__, r);
 674                 goto out;
 675         }
 676         dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
 677                 __func__, break_reg[0], break_reg[1]);
 678         if (break_state != 0) {
 679                 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
 680                 break_reg[0] &= ~CH341_NBREAK_BITS;
 681                 break_reg[1] &= ~CH341_LCR_ENABLE_TX;
 682         } else {
 683                 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
 684                 break_reg[0] |= CH341_NBREAK_BITS;
 685                 break_reg[1] |= CH341_LCR_ENABLE_TX;
 686         }
 687         dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
 688                 __func__, break_reg[0], break_reg[1]);
 689         reg_contents = get_unaligned_le16(break_reg);
 690         r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
 691                         ch341_break_reg, reg_contents);
 692         if (r < 0)
 693                 dev_err(&port->dev, "%s - USB control write error (%d)\n",
 694                                 __func__, r);
 695 out:
 696         kfree(break_reg);
 697 }
 698
 699 static int ch341_tiocmset(struct tty_struct *tty,
 700                           unsigned int set, unsigned int clear)
 701 {
 702         struct usb_serial_port *port = tty->driver_data;
 703         struct ch341_private *priv = usb_get_serial_port_data(port);
 704         unsigned long flags;
 705         u8 control;
 706
 707         spin_lock_irqsave(&priv->lock, flags);
 708         if (set & TIOCM_RTS)
 709                 priv->mcr |= CH341_BIT_RTS;
 710         if (set & TIOCM_DTR)
 711                 priv->mcr |= CH341_BIT_DTR;
 712         if (clear & TIOCM_RTS)
 713                 priv->mcr &= ~CH341_BIT_RTS;
 714         if (clear & TIOCM_DTR)
 715                 priv->mcr &= ~CH341_BIT_DTR;
 716         control = priv->mcr;
 717         spin_unlock_irqrestore(&priv->lock, flags);
 718
 719         return ch341_set_handshake(port->serial->dev, control);
 720 }
 721
 722 static void ch341_update_status(struct usb_serial_port *port,
 723                                         unsigned char *data, size_t len)
 724 {
 725         struct ch341_private *priv = usb_get_serial_port_data(port);
 726         struct tty_struct *tty;
 727         unsigned long flags;
 728         u8 status;
 729         u8 delta;
 730
 731         if (len < 4)
 732                 return;
 733
 734         status = ~data[2] & CH341_BITS_MODEM_STAT;
 735
 736         spin_lock_irqsave(&priv->lock, flags);
 737         delta = status ^ priv->msr;
 738         priv->msr = status;
 739         spin_unlock_irqrestore(&priv->lock, flags);
 740
 741         if (data[1] & CH341_MULT_STAT)
 742                 dev_dbg(&port->dev, "%s - multiple status change\n", __func__);
 743
 744         if (!delta)
 745                 return;
 746
 747         if (delta & CH341_BIT_CTS)
 748                 port->icount.cts++;
 749         if (delta & CH341_BIT_DSR)
 750                 port->icount.dsr++;
 751         if (delta & CH341_BIT_RI)
 752                 port->icount.rng++;
 753         if (delta & CH341_BIT_DCD) {
 754                 port->icount.dcd++;
 755                 tty = tty_port_tty_get(&port->port);
 756                 if (tty) {
 757                         usb_serial_handle_dcd_change(port, tty,
 758                                                 status & CH341_BIT_DCD);
 759                         tty_kref_put(tty);
 760                 }
 761         }
 762
 763         wake_up_interruptible(&port->port.delta_msr_wait);
 764 }
 765
 766 static void ch341_read_int_callback(struct urb *urb)
 767 {
 768         struct usb_serial_port *port = urb->context;
 769         unsigned char *data = urb->transfer_buffer;
 770         unsigned int len = urb->actual_length;
 771         int status;
 772
 773         switch (urb->status) {
 774         case 0:
 775                 /* success */
 776                 break;
 777         case -ECONNRESET:
 778         case -ENOENT:
 779         case -ESHUTDOWN:
 780                 /* this urb is terminated, clean up */
 781                 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n",
 782                         __func__, urb->status);
 783                 return;
 784         default:
 785                 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n",
 786                         __func__, urb->status);
 787                 goto exit;
 788         }
 789
 790         usb_serial_debug_data(&port->dev, __func__, len, data);
 791         ch341_update_status(port, data, len);
 792 exit:
 793         status = usb_submit_urb(urb, GFP_ATOMIC);
 794         if (status) {
 795                 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n",
 796                         __func__, status);
 797         }
 798 }
 799
 800 static int ch341_tiocmget(struct tty_struct *tty)
 801 {
 802         struct usb_serial_port *port = tty->driver_data;
 803         struct ch341_private *priv = usb_get_serial_port_data(port);
 804         unsigned long flags;
 805         u8 mcr;
 806         u8 status;
 807         unsigned int result;
 808
 809         spin_lock_irqsave(&priv->lock, flags);
 810         mcr = priv->mcr;
 811         status = priv->msr;
 812         spin_unlock_irqrestore(&priv->lock, flags);
 813
 814         result = ((mcr & CH341_BIT_DTR)         ? TIOCM_DTR : 0)
 815                   | ((mcr & CH341_BIT_RTS)      ? TIOCM_RTS : 0)
 816                   | ((status & CH341_BIT_CTS)   ? TIOCM_CTS : 0)
 817                   | ((status & CH341_BIT_DSR)   ? TIOCM_DSR : 0)
 818                   | ((status & CH341_BIT_RI)    ? TIOCM_RI  : 0)
 819                   | ((status & CH341_BIT_DCD)   ? TIOCM_CD  : 0);
 820
 821         dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
 822
 823         return result;
 824 }
 825
 826 static int ch341_reset_resume(struct usb_serial *serial)
 827 {
 828         struct usb_serial_port *port = serial->port[0];
 829         struct ch341_private *priv;
 830         int ret;
 831
 832         priv = usb_get_serial_port_data(port);
 833         if (!priv)
 834                 return 0;
 835
 836         /* reconfigure ch341 serial port after bus-reset */
 837         ch341_configure(serial->dev, priv);
 838
 839         if (tty_port_initialized(&port->port)) {
 840                 ret = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
 841                 if (ret) {
 842                         dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
 843                                 ret);
 844                         return ret;
 845                 }
 846
 847                 ret = ch341_get_status(port->serial->dev, priv);
 848                 if (ret < 0) {
 849                         dev_err(&port->dev, "failed to read modem status: %d\n",
 850                                 ret);
 851                 }
 852         }
 853
 854         return usb_serial_generic_resume(serial);
 855 }
 856
 857 static struct usb_serial_driver ch341_device = {
 858         .driver = {
 859                 .owner  = THIS_MODULE,
 860                 .name   = "ch341-uart",
 861         },
 862         .id_table          = id_table,
 863         .num_ports         = 1,
 864         .open              = ch341_open,
 865         .dtr_rts           = ch341_dtr_rts,
 866         .carrier_raised    = ch341_carrier_raised,
 867         .close             = ch341_close,
 868         .set_termios       = ch341_set_termios,
 869         .break_ctl         = ch341_break_ctl,
 870         .tiocmget          = ch341_tiocmget,
 871         .tiocmset          = ch341_tiocmset,
 872         .tiocmiwait        = usb_serial_generic_tiocmiwait,
 873         .read_int_callback = ch341_read_int_callback,
 874         .port_probe        = ch341_port_probe,
 875         .port_remove       = ch341_port_remove,
 876         .reset_resume      = ch341_reset_resume,
 877 };
 878
 879 static struct usb_serial_driver * const serial_drivers[] = {
 880         &ch341_device, NULL
 881 };
 882
 883 module_usb_serial_driver(serial_drivers, id_table);
 884
 885 MODULE_LICENSE("GPL v2");