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