• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Fintek F81232 USB to serial adaptor driver
4  * Fintek F81532A/534A/535/536 USB to 2/4/8/12 serial adaptor driver
5  *
6  * Copyright (C) 2012 Greg Kroah-Hartman (gregkh@linuxfoundation.org)
7  * Copyright (C) 2012 Linux Foundation
8  */
9 
10 #include <linux/kernel.h>
11 #include <linux/errno.h>
12 #include <linux/slab.h>
13 #include <linux/tty.h>
14 #include <linux/tty_driver.h>
15 #include <linux/tty_flip.h>
16 #include <linux/serial.h>
17 #include <linux/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/mutex.h>
20 #include <linux/uaccess.h>
21 #include <linux/usb.h>
22 #include <linux/usb/serial.h>
23 #include <linux/serial_reg.h>
24 
25 #define F81232_ID		\
26 	{ USB_DEVICE(0x1934, 0x0706) }	/* 1 port UART device */
27 
28 #define F81534A_SERIES_ID	\
29 	{ USB_DEVICE(0x2c42, 0x1602) },	/* In-Box 2 port UART device */	\
30 	{ USB_DEVICE(0x2c42, 0x1604) },	/* In-Box 4 port UART device */	\
31 	{ USB_DEVICE(0x2c42, 0x1605) },	/* In-Box 8 port UART device */	\
32 	{ USB_DEVICE(0x2c42, 0x1606) },	/* In-Box 12 port UART device */ \
33 	{ USB_DEVICE(0x2c42, 0x1608) },	/* Non-Flash type */ \
34 	{ USB_DEVICE(0x2c42, 0x1632) },	/* 2 port UART device */ \
35 	{ USB_DEVICE(0x2c42, 0x1634) },	/* 4 port UART device */ \
36 	{ USB_DEVICE(0x2c42, 0x1635) },	/* 8 port UART device */ \
37 	{ USB_DEVICE(0x2c42, 0x1636) }	/* 12 port UART device */
38 
39 #define F81534A_CTRL_ID		\
40 	{ USB_DEVICE(0x2c42, 0x16f8) }	/* Global control device */
41 
42 static const struct usb_device_id f81232_id_table[] = {
43 	F81232_ID,
44 	{ }					/* Terminating entry */
45 };
46 
47 static const struct usb_device_id f81534a_id_table[] = {
48 	F81534A_SERIES_ID,
49 	{ }					/* Terminating entry */
50 };
51 
52 static const struct usb_device_id f81534a_ctrl_id_table[] = {
53 	F81534A_CTRL_ID,
54 	{ }					/* Terminating entry */
55 };
56 
57 static const struct usb_device_id combined_id_table[] = {
58 	F81232_ID,
59 	F81534A_SERIES_ID,
60 	F81534A_CTRL_ID,
61 	{ }					/* Terminating entry */
62 };
63 MODULE_DEVICE_TABLE(usb, combined_id_table);
64 
65 /* Maximum baudrate for F81232 */
66 #define F81232_MAX_BAUDRATE		1500000
67 #define F81232_DEF_BAUDRATE		9600
68 
69 /* USB Control EP parameter */
70 #define F81232_REGISTER_REQUEST		0xa0
71 #define F81232_GET_REGISTER		0xc0
72 #define F81232_SET_REGISTER		0x40
73 #define F81534A_ACCESS_REG_RETRY	2
74 
75 #define SERIAL_BASE_ADDRESS		0x0120
76 #define RECEIVE_BUFFER_REGISTER		(0x00 + SERIAL_BASE_ADDRESS)
77 #define INTERRUPT_ENABLE_REGISTER	(0x01 + SERIAL_BASE_ADDRESS)
78 #define FIFO_CONTROL_REGISTER		(0x02 + SERIAL_BASE_ADDRESS)
79 #define LINE_CONTROL_REGISTER		(0x03 + SERIAL_BASE_ADDRESS)
80 #define MODEM_CONTROL_REGISTER		(0x04 + SERIAL_BASE_ADDRESS)
81 #define LINE_STATUS_REGISTER		(0x05 + SERIAL_BASE_ADDRESS)
82 #define MODEM_STATUS_REGISTER		(0x06 + SERIAL_BASE_ADDRESS)
83 
84 /*
85  * F81232 Clock registers (106h)
86  *
87  * Bit1-0:	Clock source selector
88  *			00: 1.846MHz.
89  *			01: 18.46MHz.
90  *			10: 24MHz.
91  *			11: 14.77MHz.
92  */
93 #define F81232_CLK_REGISTER		0x106
94 #define F81232_CLK_1_846_MHZ		0
95 #define F81232_CLK_18_46_MHZ		BIT(0)
96 #define F81232_CLK_24_MHZ		BIT(1)
97 #define F81232_CLK_14_77_MHZ		(BIT(1) | BIT(0))
98 #define F81232_CLK_MASK			GENMASK(1, 0)
99 
100 #define F81534A_MODE_REG		0x107
101 #define F81534A_TRIGGER_MASK		GENMASK(3, 2)
102 #define F81534A_TRIGGER_MULTIPLE_4X	BIT(3)
103 #define F81534A_FIFO_128BYTE		(BIT(1) | BIT(0))
104 
105 /* Serial port self GPIO control, 2bytes [control&output data][input data] */
106 #define F81534A_GPIO_REG		0x10e
107 #define F81534A_GPIO_MODE2_DIR		BIT(6) /* 1: input, 0: output */
108 #define F81534A_GPIO_MODE1_DIR		BIT(5)
109 #define F81534A_GPIO_MODE0_DIR		BIT(4)
110 #define F81534A_GPIO_MODE2_OUTPUT	BIT(2)
111 #define F81534A_GPIO_MODE1_OUTPUT	BIT(1)
112 #define F81534A_GPIO_MODE0_OUTPUT	BIT(0)
113 
114 #define F81534A_CTRL_CMD_ENABLE_PORT	0x116
115 
116 struct f81232_private {
117 	struct mutex lock;
118 	u8 modem_control;
119 	u8 modem_status;
120 	u8 shadow_lcr;
121 	speed_t baud_base;
122 	struct work_struct lsr_work;
123 	struct work_struct interrupt_work;
124 	struct usb_serial_port *port;
125 };
126 
127 static u32 const baudrate_table[] = { 115200, 921600, 1152000, 1500000 };
128 static u8 const clock_table[] = { F81232_CLK_1_846_MHZ, F81232_CLK_14_77_MHZ,
129 				F81232_CLK_18_46_MHZ, F81232_CLK_24_MHZ };
130 
calc_baud_divisor(speed_t baudrate,speed_t clockrate)131 static int calc_baud_divisor(speed_t baudrate, speed_t clockrate)
132 {
133 	return DIV_ROUND_CLOSEST(clockrate, baudrate);
134 }
135 
f81232_get_register(struct usb_serial_port * port,u16 reg,u8 * val)136 static int f81232_get_register(struct usb_serial_port *port, u16 reg, u8 *val)
137 {
138 	int status;
139 	u8 *tmp;
140 	struct usb_device *dev = port->serial->dev;
141 
142 	tmp = kmalloc(sizeof(*val), GFP_KERNEL);
143 	if (!tmp)
144 		return -ENOMEM;
145 
146 	status = usb_control_msg(dev,
147 				usb_rcvctrlpipe(dev, 0),
148 				F81232_REGISTER_REQUEST,
149 				F81232_GET_REGISTER,
150 				reg,
151 				0,
152 				tmp,
153 				sizeof(*val),
154 				USB_CTRL_GET_TIMEOUT);
155 	if (status != sizeof(*val)) {
156 		dev_err(&port->dev, "%s failed status: %d\n", __func__, status);
157 
158 		if (status < 0)
159 			status = usb_translate_errors(status);
160 		else
161 			status = -EIO;
162 	} else {
163 		status = 0;
164 		*val = *tmp;
165 	}
166 
167 	kfree(tmp);
168 	return status;
169 }
170 
f81232_set_register(struct usb_serial_port * port,u16 reg,u8 val)171 static int f81232_set_register(struct usb_serial_port *port, u16 reg, u8 val)
172 {
173 	int status;
174 	u8 *tmp;
175 	struct usb_device *dev = port->serial->dev;
176 
177 	tmp = kmalloc(sizeof(val), GFP_KERNEL);
178 	if (!tmp)
179 		return -ENOMEM;
180 
181 	*tmp = val;
182 
183 	status = usb_control_msg(dev,
184 				usb_sndctrlpipe(dev, 0),
185 				F81232_REGISTER_REQUEST,
186 				F81232_SET_REGISTER,
187 				reg,
188 				0,
189 				tmp,
190 				sizeof(val),
191 				USB_CTRL_SET_TIMEOUT);
192 	if (status < 0) {
193 		dev_err(&port->dev, "%s failed status: %d\n", __func__, status);
194 		status = usb_translate_errors(status);
195 	} else {
196 		status = 0;
197 	}
198 
199 	kfree(tmp);
200 	return status;
201 }
202 
f81232_set_mask_register(struct usb_serial_port * port,u16 reg,u8 mask,u8 val)203 static int f81232_set_mask_register(struct usb_serial_port *port, u16 reg,
204 					u8 mask, u8 val)
205 {
206 	int status;
207 	u8 tmp;
208 
209 	status = f81232_get_register(port, reg, &tmp);
210 	if (status)
211 		return status;
212 
213 	tmp = (tmp & ~mask) | (val & mask);
214 
215 	return f81232_set_register(port, reg, tmp);
216 }
217 
f81232_read_msr(struct usb_serial_port * port)218 static void f81232_read_msr(struct usb_serial_port *port)
219 {
220 	int status;
221 	u8 current_msr;
222 	struct tty_struct *tty;
223 	struct f81232_private *priv = usb_get_serial_port_data(port);
224 
225 	mutex_lock(&priv->lock);
226 	status = f81232_get_register(port, MODEM_STATUS_REGISTER,
227 			&current_msr);
228 	if (status) {
229 		dev_err(&port->dev, "%s fail, status: %d\n", __func__, status);
230 		mutex_unlock(&priv->lock);
231 		return;
232 	}
233 
234 	if (!(current_msr & UART_MSR_ANY_DELTA)) {
235 		mutex_unlock(&priv->lock);
236 		return;
237 	}
238 
239 	priv->modem_status = current_msr;
240 
241 	if (current_msr & UART_MSR_DCTS)
242 		port->icount.cts++;
243 	if (current_msr & UART_MSR_DDSR)
244 		port->icount.dsr++;
245 	if (current_msr & UART_MSR_TERI)
246 		port->icount.rng++;
247 	if (current_msr & UART_MSR_DDCD) {
248 		port->icount.dcd++;
249 		tty = tty_port_tty_get(&port->port);
250 		if (tty) {
251 			usb_serial_handle_dcd_change(port, tty,
252 					current_msr & UART_MSR_DCD);
253 
254 			tty_kref_put(tty);
255 		}
256 	}
257 
258 	wake_up_interruptible(&port->port.delta_msr_wait);
259 	mutex_unlock(&priv->lock);
260 }
261 
f81232_set_mctrl(struct usb_serial_port * port,unsigned int set,unsigned int clear)262 static int f81232_set_mctrl(struct usb_serial_port *port,
263 					   unsigned int set, unsigned int clear)
264 {
265 	u8 val;
266 	int status;
267 	struct f81232_private *priv = usb_get_serial_port_data(port);
268 
269 	if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0)
270 		return 0;	/* no change */
271 
272 	/* 'set' takes precedence over 'clear' */
273 	clear &= ~set;
274 
275 	/* force enable interrupt with OUT2 */
276 	mutex_lock(&priv->lock);
277 	val = UART_MCR_OUT2 | priv->modem_control;
278 
279 	if (clear & TIOCM_DTR)
280 		val &= ~UART_MCR_DTR;
281 
282 	if (clear & TIOCM_RTS)
283 		val &= ~UART_MCR_RTS;
284 
285 	if (set & TIOCM_DTR)
286 		val |= UART_MCR_DTR;
287 
288 	if (set & TIOCM_RTS)
289 		val |= UART_MCR_RTS;
290 
291 	dev_dbg(&port->dev, "%s new:%02x old:%02x\n", __func__,
292 			val, priv->modem_control);
293 
294 	status = f81232_set_register(port, MODEM_CONTROL_REGISTER, val);
295 	if (status) {
296 		dev_err(&port->dev, "%s set MCR status < 0\n", __func__);
297 		mutex_unlock(&priv->lock);
298 		return status;
299 	}
300 
301 	priv->modem_control = val;
302 	mutex_unlock(&priv->lock);
303 
304 	return 0;
305 }
306 
f81232_update_line_status(struct usb_serial_port * port,unsigned char * data,size_t actual_length)307 static void f81232_update_line_status(struct usb_serial_port *port,
308 				      unsigned char *data,
309 				      size_t actual_length)
310 {
311 	struct f81232_private *priv = usb_get_serial_port_data(port);
312 
313 	if (!actual_length)
314 		return;
315 
316 	switch (data[0] & 0x07) {
317 	case 0x00: /* msr change */
318 		dev_dbg(&port->dev, "IIR: MSR Change: %02x\n", data[0]);
319 		schedule_work(&priv->interrupt_work);
320 		break;
321 	case 0x02: /* tx-empty */
322 		break;
323 	case 0x04: /* rx data available */
324 		break;
325 	case 0x06: /* lsr change */
326 		/* we can forget it. the LSR will read from bulk-in */
327 		dev_dbg(&port->dev, "IIR: LSR Change: %02x\n", data[0]);
328 		break;
329 	}
330 }
331 
f81232_read_int_callback(struct urb * urb)332 static void f81232_read_int_callback(struct urb *urb)
333 {
334 	struct usb_serial_port *port =  urb->context;
335 	unsigned char *data = urb->transfer_buffer;
336 	unsigned int actual_length = urb->actual_length;
337 	int status = urb->status;
338 	int retval;
339 
340 	switch (status) {
341 	case 0:
342 		/* success */
343 		break;
344 	case -ECONNRESET:
345 	case -ENOENT:
346 	case -ESHUTDOWN:
347 		/* this urb is terminated, clean up */
348 		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
349 			__func__, status);
350 		return;
351 	default:
352 		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
353 			__func__, status);
354 		goto exit;
355 	}
356 
357 	usb_serial_debug_data(&port->dev, __func__,
358 			      urb->actual_length, urb->transfer_buffer);
359 
360 	f81232_update_line_status(port, data, actual_length);
361 
362 exit:
363 	retval = usb_submit_urb(urb, GFP_ATOMIC);
364 	if (retval)
365 		dev_err(&urb->dev->dev,
366 			"%s - usb_submit_urb failed with result %d\n",
367 			__func__, retval);
368 }
369 
f81232_handle_lsr(struct usb_serial_port * port,u8 lsr)370 static char f81232_handle_lsr(struct usb_serial_port *port, u8 lsr)
371 {
372 	struct f81232_private *priv = usb_get_serial_port_data(port);
373 	char tty_flag = TTY_NORMAL;
374 
375 	if (!(lsr & UART_LSR_BRK_ERROR_BITS))
376 		return tty_flag;
377 
378 	if (lsr & UART_LSR_BI) {
379 		tty_flag = TTY_BREAK;
380 		port->icount.brk++;
381 		usb_serial_handle_break(port);
382 	} else if (lsr & UART_LSR_PE) {
383 		tty_flag = TTY_PARITY;
384 		port->icount.parity++;
385 	} else if (lsr & UART_LSR_FE) {
386 		tty_flag = TTY_FRAME;
387 		port->icount.frame++;
388 	}
389 
390 	if (lsr & UART_LSR_OE) {
391 		port->icount.overrun++;
392 		schedule_work(&priv->lsr_work);
393 		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
394 	}
395 
396 	return tty_flag;
397 }
398 
f81232_process_read_urb(struct urb * urb)399 static void f81232_process_read_urb(struct urb *urb)
400 {
401 	struct usb_serial_port *port = urb->context;
402 	unsigned char *data = urb->transfer_buffer;
403 	char tty_flag;
404 	unsigned int i;
405 	u8 lsr;
406 
407 	/*
408 	 * When opening the port we get a 1-byte packet with the current LSR,
409 	 * which we discard.
410 	 */
411 	if ((urb->actual_length < 2) || (urb->actual_length % 2))
412 		return;
413 
414 	/* bulk-in data: [LSR(1Byte)+DATA(1Byte)][LSR(1Byte)+DATA(1Byte)]... */
415 
416 	for (i = 0; i < urb->actual_length; i += 2) {
417 		lsr = data[i];
418 		tty_flag = f81232_handle_lsr(port, lsr);
419 
420 		if (port->sysrq) {
421 			if (usb_serial_handle_sysrq_char(port, data[i + 1]))
422 				continue;
423 		}
424 
425 		tty_insert_flip_char(&port->port, data[i + 1], tty_flag);
426 	}
427 
428 	tty_flip_buffer_push(&port->port);
429 }
430 
f81534a_process_read_urb(struct urb * urb)431 static void f81534a_process_read_urb(struct urb *urb)
432 {
433 	struct usb_serial_port *port = urb->context;
434 	unsigned char *data = urb->transfer_buffer;
435 	char tty_flag;
436 	unsigned int i;
437 	u8 lsr;
438 	u8 len;
439 
440 	if (urb->actual_length < 3) {
441 		dev_err(&port->dev, "short message received: %d\n",
442 				urb->actual_length);
443 		return;
444 	}
445 
446 	len = data[0];
447 	if (len != urb->actual_length) {
448 		dev_err(&port->dev, "malformed message received: %d (%d)\n",
449 				urb->actual_length, len);
450 		return;
451 	}
452 
453 	/* bulk-in data: [LEN][Data.....][LSR] */
454 	lsr = data[len - 1];
455 	tty_flag = f81232_handle_lsr(port, lsr);
456 
457 	if (port->sysrq) {
458 		for (i = 1; i < len - 1; ++i) {
459 			if (!usb_serial_handle_sysrq_char(port, data[i])) {
460 				tty_insert_flip_char(&port->port, data[i],
461 						tty_flag);
462 			}
463 		}
464 	} else {
465 		tty_insert_flip_string_fixed_flag(&port->port, &data[1],
466 							tty_flag, len - 2);
467 	}
468 
469 	tty_flip_buffer_push(&port->port);
470 }
471 
f81232_break_ctl(struct tty_struct * tty,int break_state)472 static void f81232_break_ctl(struct tty_struct *tty, int break_state)
473 {
474 	struct usb_serial_port *port = tty->driver_data;
475 	struct f81232_private *priv = usb_get_serial_port_data(port);
476 	int status;
477 
478 	mutex_lock(&priv->lock);
479 
480 	if (break_state)
481 		priv->shadow_lcr |= UART_LCR_SBC;
482 	else
483 		priv->shadow_lcr &= ~UART_LCR_SBC;
484 
485 	status = f81232_set_register(port, LINE_CONTROL_REGISTER,
486 					priv->shadow_lcr);
487 	if (status)
488 		dev_err(&port->dev, "set break failed: %d\n", status);
489 
490 	mutex_unlock(&priv->lock);
491 }
492 
f81232_find_clk(speed_t baudrate)493 static int f81232_find_clk(speed_t baudrate)
494 {
495 	int idx;
496 
497 	for (idx = 0; idx < ARRAY_SIZE(baudrate_table); ++idx) {
498 		if (baudrate <= baudrate_table[idx] &&
499 				baudrate_table[idx] % baudrate == 0)
500 			return idx;
501 	}
502 
503 	return -EINVAL;
504 }
505 
f81232_set_baudrate(struct tty_struct * tty,struct usb_serial_port * port,speed_t baudrate,speed_t old_baudrate)506 static void f81232_set_baudrate(struct tty_struct *tty,
507 				struct usb_serial_port *port, speed_t baudrate,
508 				speed_t old_baudrate)
509 {
510 	struct f81232_private *priv = usb_get_serial_port_data(port);
511 	u8 lcr;
512 	int divisor;
513 	int status = 0;
514 	int i;
515 	int idx;
516 	speed_t baud_list[] = { baudrate, old_baudrate, F81232_DEF_BAUDRATE };
517 
518 	for (i = 0; i < ARRAY_SIZE(baud_list); ++i) {
519 		baudrate = baud_list[i];
520 		if (baudrate == 0) {
521 			tty_encode_baud_rate(tty, 0, 0);
522 			return;
523 		}
524 
525 		idx = f81232_find_clk(baudrate);
526 		if (idx >= 0) {
527 			tty_encode_baud_rate(tty, baudrate, baudrate);
528 			break;
529 		}
530 	}
531 
532 	if (idx < 0)
533 		return;
534 
535 	priv->baud_base = baudrate_table[idx];
536 	divisor = calc_baud_divisor(baudrate, priv->baud_base);
537 
538 	status = f81232_set_mask_register(port, F81232_CLK_REGISTER,
539 			F81232_CLK_MASK, clock_table[idx]);
540 	if (status) {
541 		dev_err(&port->dev, "%s failed to set CLK_REG: %d\n",
542 			__func__, status);
543 		return;
544 	}
545 
546 	status = f81232_get_register(port, LINE_CONTROL_REGISTER,
547 			 &lcr); /* get LCR */
548 	if (status) {
549 		dev_err(&port->dev, "%s failed to get LCR: %d\n",
550 			__func__, status);
551 		return;
552 	}
553 
554 	status = f81232_set_register(port, LINE_CONTROL_REGISTER,
555 			 lcr | UART_LCR_DLAB); /* Enable DLAB */
556 	if (status) {
557 		dev_err(&port->dev, "%s failed to set DLAB: %d\n",
558 			__func__, status);
559 		return;
560 	}
561 
562 	status = f81232_set_register(port, RECEIVE_BUFFER_REGISTER,
563 			 divisor & 0x00ff); /* low */
564 	if (status) {
565 		dev_err(&port->dev, "%s failed to set baudrate MSB: %d\n",
566 			__func__, status);
567 		goto reapply_lcr;
568 	}
569 
570 	status = f81232_set_register(port, INTERRUPT_ENABLE_REGISTER,
571 			 (divisor & 0xff00) >> 8); /* high */
572 	if (status) {
573 		dev_err(&port->dev, "%s failed to set baudrate LSB: %d\n",
574 			__func__, status);
575 	}
576 
577 reapply_lcr:
578 	status = f81232_set_register(port, LINE_CONTROL_REGISTER,
579 			lcr & ~UART_LCR_DLAB);
580 	if (status) {
581 		dev_err(&port->dev, "%s failed to set DLAB: %d\n",
582 			__func__, status);
583 	}
584 }
585 
f81232_port_enable(struct usb_serial_port * port)586 static int f81232_port_enable(struct usb_serial_port *port)
587 {
588 	u8 val;
589 	int status;
590 
591 	/* fifo on, trigger8, clear TX/RX*/
592 	val = UART_FCR_TRIGGER_8 | UART_FCR_ENABLE_FIFO | UART_FCR_CLEAR_RCVR |
593 			UART_FCR_CLEAR_XMIT;
594 
595 	status = f81232_set_register(port, FIFO_CONTROL_REGISTER, val);
596 	if (status) {
597 		dev_err(&port->dev, "%s failed to set FCR: %d\n",
598 			__func__, status);
599 		return status;
600 	}
601 
602 	/* MSR Interrupt only, LSR will read from Bulk-in odd byte */
603 	status = f81232_set_register(port, INTERRUPT_ENABLE_REGISTER,
604 			UART_IER_MSI);
605 	if (status) {
606 		dev_err(&port->dev, "%s failed to set IER: %d\n",
607 			__func__, status);
608 		return status;
609 	}
610 
611 	return 0;
612 }
613 
f81232_port_disable(struct usb_serial_port * port)614 static int f81232_port_disable(struct usb_serial_port *port)
615 {
616 	int status;
617 
618 	status = f81232_set_register(port, INTERRUPT_ENABLE_REGISTER, 0);
619 	if (status) {
620 		dev_err(&port->dev, "%s failed to set IER: %d\n",
621 			__func__, status);
622 		return status;
623 	}
624 
625 	return 0;
626 }
627 
f81232_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)628 static void f81232_set_termios(struct tty_struct *tty,
629 		struct usb_serial_port *port, struct ktermios *old_termios)
630 {
631 	struct f81232_private *priv = usb_get_serial_port_data(port);
632 	u8 new_lcr = 0;
633 	int status = 0;
634 	speed_t baudrate;
635 	speed_t old_baud;
636 
637 	/* Don't change anything if nothing has changed */
638 	if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
639 		return;
640 
641 	if (C_BAUD(tty) == B0)
642 		f81232_set_mctrl(port, 0, TIOCM_DTR | TIOCM_RTS);
643 	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
644 		f81232_set_mctrl(port, TIOCM_DTR | TIOCM_RTS, 0);
645 
646 	baudrate = tty_get_baud_rate(tty);
647 	if (baudrate > 0) {
648 		if (old_termios)
649 			old_baud = tty_termios_baud_rate(old_termios);
650 		else
651 			old_baud = F81232_DEF_BAUDRATE;
652 
653 		f81232_set_baudrate(tty, port, baudrate, old_baud);
654 	}
655 
656 	if (C_PARENB(tty)) {
657 		new_lcr |= UART_LCR_PARITY;
658 
659 		if (!C_PARODD(tty))
660 			new_lcr |= UART_LCR_EPAR;
661 
662 		if (C_CMSPAR(tty))
663 			new_lcr |= UART_LCR_SPAR;
664 	}
665 
666 	if (C_CSTOPB(tty))
667 		new_lcr |= UART_LCR_STOP;
668 
669 	switch (C_CSIZE(tty)) {
670 	case CS5:
671 		new_lcr |= UART_LCR_WLEN5;
672 		break;
673 	case CS6:
674 		new_lcr |= UART_LCR_WLEN6;
675 		break;
676 	case CS7:
677 		new_lcr |= UART_LCR_WLEN7;
678 		break;
679 	default:
680 	case CS8:
681 		new_lcr |= UART_LCR_WLEN8;
682 		break;
683 	}
684 
685 	mutex_lock(&priv->lock);
686 
687 	new_lcr |= (priv->shadow_lcr & UART_LCR_SBC);
688 	status = f81232_set_register(port, LINE_CONTROL_REGISTER, new_lcr);
689 	if (status) {
690 		dev_err(&port->dev, "%s failed to set LCR: %d\n",
691 			__func__, status);
692 	}
693 
694 	priv->shadow_lcr = new_lcr;
695 
696 	mutex_unlock(&priv->lock);
697 }
698 
f81232_tiocmget(struct tty_struct * tty)699 static int f81232_tiocmget(struct tty_struct *tty)
700 {
701 	int r;
702 	struct usb_serial_port *port = tty->driver_data;
703 	struct f81232_private *port_priv = usb_get_serial_port_data(port);
704 	u8 mcr, msr;
705 
706 	/* force get current MSR changed state */
707 	f81232_read_msr(port);
708 
709 	mutex_lock(&port_priv->lock);
710 	mcr = port_priv->modem_control;
711 	msr = port_priv->modem_status;
712 	mutex_unlock(&port_priv->lock);
713 
714 	r = (mcr & UART_MCR_DTR ? TIOCM_DTR : 0) |
715 		(mcr & UART_MCR_RTS ? TIOCM_RTS : 0) |
716 		(msr & UART_MSR_CTS ? TIOCM_CTS : 0) |
717 		(msr & UART_MSR_DCD ? TIOCM_CAR : 0) |
718 		(msr & UART_MSR_RI ? TIOCM_RI : 0) |
719 		(msr & UART_MSR_DSR ? TIOCM_DSR : 0);
720 
721 	return r;
722 }
723 
f81232_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)724 static int f81232_tiocmset(struct tty_struct *tty,
725 			unsigned int set, unsigned int clear)
726 {
727 	struct usb_serial_port *port = tty->driver_data;
728 
729 	return f81232_set_mctrl(port, set, clear);
730 }
731 
f81232_open(struct tty_struct * tty,struct usb_serial_port * port)732 static int f81232_open(struct tty_struct *tty, struct usb_serial_port *port)
733 {
734 	int result;
735 
736 	result = f81232_port_enable(port);
737 	if (result)
738 		return result;
739 
740 	/* Setup termios */
741 	if (tty)
742 		f81232_set_termios(tty, port, NULL);
743 
744 	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
745 	if (result) {
746 		dev_err(&port->dev, "%s - failed submitting interrupt urb,"
747 			" error %d\n", __func__, result);
748 		return result;
749 	}
750 
751 	result = usb_serial_generic_open(tty, port);
752 	if (result) {
753 		usb_kill_urb(port->interrupt_in_urb);
754 		return result;
755 	}
756 
757 	return 0;
758 }
759 
f81534a_open(struct tty_struct * tty,struct usb_serial_port * port)760 static int f81534a_open(struct tty_struct *tty, struct usb_serial_port *port)
761 {
762 	int status;
763 	u8 mask;
764 	u8 val;
765 
766 	val = F81534A_TRIGGER_MULTIPLE_4X | F81534A_FIFO_128BYTE;
767 	mask = F81534A_TRIGGER_MASK | F81534A_FIFO_128BYTE;
768 
769 	status = f81232_set_mask_register(port, F81534A_MODE_REG, mask, val);
770 	if (status) {
771 		dev_err(&port->dev, "failed to set MODE_REG: %d\n", status);
772 		return status;
773 	}
774 
775 	return f81232_open(tty, port);
776 }
777 
f81232_close(struct usb_serial_port * port)778 static void f81232_close(struct usb_serial_port *port)
779 {
780 	struct f81232_private *port_priv = usb_get_serial_port_data(port);
781 
782 	f81232_port_disable(port);
783 	usb_serial_generic_close(port);
784 	usb_kill_urb(port->interrupt_in_urb);
785 	flush_work(&port_priv->interrupt_work);
786 	flush_work(&port_priv->lsr_work);
787 }
788 
f81232_dtr_rts(struct usb_serial_port * port,int on)789 static void f81232_dtr_rts(struct usb_serial_port *port, int on)
790 {
791 	if (on)
792 		f81232_set_mctrl(port, TIOCM_DTR | TIOCM_RTS, 0);
793 	else
794 		f81232_set_mctrl(port, 0, TIOCM_DTR | TIOCM_RTS);
795 }
796 
f81232_tx_empty(struct usb_serial_port * port)797 static bool f81232_tx_empty(struct usb_serial_port *port)
798 {
799 	int status;
800 	u8 tmp;
801 
802 	status = f81232_get_register(port, LINE_STATUS_REGISTER, &tmp);
803 	if (!status) {
804 		if ((tmp & UART_LSR_TEMT) != UART_LSR_TEMT)
805 			return false;
806 	}
807 
808 	return true;
809 }
810 
f81232_carrier_raised(struct usb_serial_port * port)811 static int f81232_carrier_raised(struct usb_serial_port *port)
812 {
813 	u8 msr;
814 	struct f81232_private *priv = usb_get_serial_port_data(port);
815 
816 	mutex_lock(&priv->lock);
817 	msr = priv->modem_status;
818 	mutex_unlock(&priv->lock);
819 
820 	if (msr & UART_MSR_DCD)
821 		return 1;
822 	return 0;
823 }
824 
f81232_get_serial(struct tty_struct * tty,struct serial_struct * ss)825 static void f81232_get_serial(struct tty_struct *tty, struct serial_struct *ss)
826 {
827 	struct usb_serial_port *port = tty->driver_data;
828 	struct f81232_private *priv = usb_get_serial_port_data(port);
829 
830 	ss->baud_base = priv->baud_base;
831 }
832 
f81232_interrupt_work(struct work_struct * work)833 static void  f81232_interrupt_work(struct work_struct *work)
834 {
835 	struct f81232_private *priv =
836 		container_of(work, struct f81232_private, interrupt_work);
837 
838 	f81232_read_msr(priv->port);
839 }
840 
f81232_lsr_worker(struct work_struct * work)841 static void f81232_lsr_worker(struct work_struct *work)
842 {
843 	struct f81232_private *priv;
844 	struct usb_serial_port *port;
845 	int status;
846 	u8 tmp;
847 
848 	priv = container_of(work, struct f81232_private, lsr_work);
849 	port = priv->port;
850 
851 	status = f81232_get_register(port, LINE_STATUS_REGISTER, &tmp);
852 	if (status)
853 		dev_warn(&port->dev, "read LSR failed: %d\n", status);
854 }
855 
f81534a_ctrl_set_register(struct usb_interface * intf,u16 reg,u16 size,void * val)856 static int f81534a_ctrl_set_register(struct usb_interface *intf, u16 reg,
857 					u16 size, void *val)
858 {
859 	struct usb_device *dev = interface_to_usbdev(intf);
860 	int retry = F81534A_ACCESS_REG_RETRY;
861 	int status;
862 	u8 *tmp;
863 
864 	tmp = kmemdup(val, size, GFP_KERNEL);
865 	if (!tmp)
866 		return -ENOMEM;
867 
868 	while (retry--) {
869 		status = usb_control_msg(dev,
870 					usb_sndctrlpipe(dev, 0),
871 					F81232_REGISTER_REQUEST,
872 					F81232_SET_REGISTER,
873 					reg,
874 					0,
875 					tmp,
876 					size,
877 					USB_CTRL_SET_TIMEOUT);
878 		if (status < 0) {
879 			status = usb_translate_errors(status);
880 			if (status == -EIO)
881 				continue;
882 		} else {
883 			status = 0;
884 		}
885 
886 		break;
887 	}
888 
889 	if (status) {
890 		dev_err(&intf->dev, "failed to set register 0x%x: %d\n",
891 				reg, status);
892 	}
893 
894 	kfree(tmp);
895 	return status;
896 }
897 
f81534a_ctrl_enable_all_ports(struct usb_interface * intf,bool en)898 static int f81534a_ctrl_enable_all_ports(struct usb_interface *intf, bool en)
899 {
900 	unsigned char enable[2] = {0};
901 	int status;
902 
903 	/*
904 	 * Enable all available serial ports, define as following:
905 	 * bit 15	: Reset behavior (when HUB got soft reset)
906 	 *			0: maintain all serial port enabled state.
907 	 *			1: disable all serial port.
908 	 * bit 0~11	: Serial port enable bit.
909 	 */
910 	if (en) {
911 		enable[0] = 0xff;
912 		enable[1] = 0x8f;
913 	}
914 
915 	status = f81534a_ctrl_set_register(intf, F81534A_CTRL_CMD_ENABLE_PORT,
916 			sizeof(enable), enable);
917 	if (status)
918 		dev_err(&intf->dev, "failed to enable ports: %d\n", status);
919 
920 	return status;
921 }
922 
f81534a_ctrl_probe(struct usb_interface * intf,const struct usb_device_id * id)923 static int f81534a_ctrl_probe(struct usb_interface *intf,
924 				const struct usb_device_id *id)
925 {
926 	return f81534a_ctrl_enable_all_ports(intf, true);
927 }
928 
f81534a_ctrl_disconnect(struct usb_interface * intf)929 static void f81534a_ctrl_disconnect(struct usb_interface *intf)
930 {
931 	f81534a_ctrl_enable_all_ports(intf, false);
932 }
933 
f81534a_ctrl_resume(struct usb_interface * intf)934 static int f81534a_ctrl_resume(struct usb_interface *intf)
935 {
936 	return f81534a_ctrl_enable_all_ports(intf, true);
937 }
938 
f81232_port_probe(struct usb_serial_port * port)939 static int f81232_port_probe(struct usb_serial_port *port)
940 {
941 	struct f81232_private *priv;
942 
943 	priv = devm_kzalloc(&port->dev, sizeof(*priv), GFP_KERNEL);
944 	if (!priv)
945 		return -ENOMEM;
946 
947 	mutex_init(&priv->lock);
948 	INIT_WORK(&priv->interrupt_work,  f81232_interrupt_work);
949 	INIT_WORK(&priv->lsr_work, f81232_lsr_worker);
950 
951 	usb_set_serial_port_data(port, priv);
952 
953 	priv->port = port;
954 
955 	return 0;
956 }
957 
f81534a_port_probe(struct usb_serial_port * port)958 static int f81534a_port_probe(struct usb_serial_port *port)
959 {
960 	int status;
961 
962 	/* tri-state with pull-high, default RS232 Mode */
963 	status = f81232_set_register(port, F81534A_GPIO_REG,
964 					F81534A_GPIO_MODE2_DIR);
965 	if (status)
966 		return status;
967 
968 	return f81232_port_probe(port);
969 }
970 
f81232_suspend(struct usb_serial * serial,pm_message_t message)971 static int f81232_suspend(struct usb_serial *serial, pm_message_t message)
972 {
973 	struct usb_serial_port *port = serial->port[0];
974 	struct f81232_private *port_priv = usb_get_serial_port_data(port);
975 	int i;
976 
977 	for (i = 0; i < ARRAY_SIZE(port->read_urbs); ++i)
978 		usb_kill_urb(port->read_urbs[i]);
979 
980 	usb_kill_urb(port->interrupt_in_urb);
981 
982 	if (port_priv) {
983 		flush_work(&port_priv->interrupt_work);
984 		flush_work(&port_priv->lsr_work);
985 	}
986 
987 	return 0;
988 }
989 
f81232_resume(struct usb_serial * serial)990 static int f81232_resume(struct usb_serial *serial)
991 {
992 	struct usb_serial_port *port = serial->port[0];
993 	int result;
994 
995 	if (tty_port_initialized(&port->port)) {
996 		result = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
997 		if (result) {
998 			dev_err(&port->dev, "submit interrupt urb failed: %d\n",
999 					result);
1000 			return result;
1001 		}
1002 	}
1003 
1004 	return usb_serial_generic_resume(serial);
1005 }
1006 
1007 static struct usb_serial_driver f81232_device = {
1008 	.driver = {
1009 		.owner =	THIS_MODULE,
1010 		.name =		"f81232",
1011 	},
1012 	.id_table =		f81232_id_table,
1013 	.num_ports =		1,
1014 	.bulk_in_size =		256,
1015 	.bulk_out_size =	256,
1016 	.open =			f81232_open,
1017 	.close =		f81232_close,
1018 	.dtr_rts =		f81232_dtr_rts,
1019 	.carrier_raised =	f81232_carrier_raised,
1020 	.get_serial =		f81232_get_serial,
1021 	.break_ctl =		f81232_break_ctl,
1022 	.set_termios =		f81232_set_termios,
1023 	.tiocmget =		f81232_tiocmget,
1024 	.tiocmset =		f81232_tiocmset,
1025 	.tiocmiwait =		usb_serial_generic_tiocmiwait,
1026 	.tx_empty =		f81232_tx_empty,
1027 	.process_read_urb =	f81232_process_read_urb,
1028 	.read_int_callback =	f81232_read_int_callback,
1029 	.port_probe =		f81232_port_probe,
1030 	.suspend =		f81232_suspend,
1031 	.resume =		f81232_resume,
1032 };
1033 
1034 static struct usb_serial_driver f81534a_device = {
1035 	.driver = {
1036 		.owner =	THIS_MODULE,
1037 		.name =		"f81534a",
1038 	},
1039 	.id_table =		f81534a_id_table,
1040 	.num_ports =		1,
1041 	.open =			f81534a_open,
1042 	.close =		f81232_close,
1043 	.dtr_rts =		f81232_dtr_rts,
1044 	.carrier_raised =	f81232_carrier_raised,
1045 	.get_serial =		f81232_get_serial,
1046 	.break_ctl =		f81232_break_ctl,
1047 	.set_termios =		f81232_set_termios,
1048 	.tiocmget =		f81232_tiocmget,
1049 	.tiocmset =		f81232_tiocmset,
1050 	.tiocmiwait =		usb_serial_generic_tiocmiwait,
1051 	.tx_empty =		f81232_tx_empty,
1052 	.process_read_urb =	f81534a_process_read_urb,
1053 	.read_int_callback =	f81232_read_int_callback,
1054 	.port_probe =		f81534a_port_probe,
1055 	.suspend =		f81232_suspend,
1056 	.resume =		f81232_resume,
1057 };
1058 
1059 static struct usb_serial_driver * const serial_drivers[] = {
1060 	&f81232_device,
1061 	&f81534a_device,
1062 	NULL,
1063 };
1064 
1065 static struct usb_driver f81534a_ctrl_driver = {
1066 	.name =		"f81534a_ctrl",
1067 	.id_table =	f81534a_ctrl_id_table,
1068 	.probe =	f81534a_ctrl_probe,
1069 	.disconnect =	f81534a_ctrl_disconnect,
1070 	.resume =	f81534a_ctrl_resume,
1071 };
1072 
f81232_init(void)1073 static int __init f81232_init(void)
1074 {
1075 	int status;
1076 
1077 	status = usb_register_driver(&f81534a_ctrl_driver, THIS_MODULE,
1078 			KBUILD_MODNAME);
1079 	if (status)
1080 		return status;
1081 
1082 	status = usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME,
1083 			combined_id_table);
1084 	if (status) {
1085 		usb_deregister(&f81534a_ctrl_driver);
1086 		return status;
1087 	}
1088 
1089 	return 0;
1090 }
1091 
f81232_exit(void)1092 static void __exit f81232_exit(void)
1093 {
1094 	usb_serial_deregister_drivers(serial_drivers);
1095 	usb_deregister(&f81534a_ctrl_driver);
1096 }
1097 
1098 module_init(f81232_init);
1099 module_exit(f81232_exit);
1100 
1101 MODULE_DESCRIPTION("Fintek F81232/532A/534A/535/536 USB to serial driver");
1102 MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org>");
1103 MODULE_AUTHOR("Peter Hong <peter_hong@fintek.com.tw>");
1104 MODULE_LICENSE("GPL v2");
1105