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