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