1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * TI 3410/5052 USB Serial Driver
4  *
5  * Copyright (C) 2004 Texas Instruments
6  *
7  * This driver is based on the Linux io_ti driver, which is
8  *   Copyright (C) 2000-2002 Inside Out Networks
9  *   Copyright (C) 2001-2002 Greg Kroah-Hartman
10  *
11  * For questions or problems with this driver, contact Texas Instruments
12  * technical support, or Al Borchers <alborchers@steinerpoint.com>, or
13  * Peter Berger <pberger@brimson.com>.
14  */
15 
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/firmware.h>
19 #include <linux/slab.h>
20 #include <linux/tty.h>
21 #include <linux/tty_driver.h>
22 #include <linux/tty_flip.h>
23 #include <linux/module.h>
24 #include <linux/spinlock.h>
25 #include <linux/ioctl.h>
26 #include <linux/serial.h>
27 #include <linux/kfifo.h>
28 #include <linux/mutex.h>
29 #include <linux/uaccess.h>
30 #include <linux/usb.h>
31 #include <linux/usb/serial.h>
32 
33 /* Configuration ids */
34 #define TI_BOOT_CONFIG			1
35 #define TI_ACTIVE_CONFIG		2
36 
37 /* Vendor and product ids */
38 #define TI_VENDOR_ID			0x0451
39 #define IBM_VENDOR_ID			0x04b3
40 #define TI_3410_PRODUCT_ID		0x3410
41 #define IBM_4543_PRODUCT_ID		0x4543
42 #define IBM_454B_PRODUCT_ID		0x454b
43 #define IBM_454C_PRODUCT_ID		0x454c
44 #define TI_3410_EZ430_ID		0xF430  /* TI ez430 development tool */
45 #define TI_5052_BOOT_PRODUCT_ID		0x5052	/* no EEPROM, no firmware */
46 #define TI_5152_BOOT_PRODUCT_ID		0x5152	/* no EEPROM, no firmware */
47 #define TI_5052_EEPROM_PRODUCT_ID	0x505A	/* EEPROM, no firmware */
48 #define TI_5052_FIRMWARE_PRODUCT_ID	0x505F	/* firmware is running */
49 #define FRI2_PRODUCT_ID			0x5053  /* Fish River Island II */
50 
51 /* Multi-Tech vendor and product ids */
52 #define MTS_VENDOR_ID			0x06E0
53 #define MTS_GSM_NO_FW_PRODUCT_ID	0xF108
54 #define MTS_CDMA_NO_FW_PRODUCT_ID	0xF109
55 #define MTS_CDMA_PRODUCT_ID		0xF110
56 #define MTS_GSM_PRODUCT_ID		0xF111
57 #define MTS_EDGE_PRODUCT_ID		0xF112
58 #define MTS_MT9234MU_PRODUCT_ID		0xF114
59 #define MTS_MT9234ZBA_PRODUCT_ID	0xF115
60 #define MTS_MT9234ZBAOLD_PRODUCT_ID	0x0319
61 
62 /* Abbott Diabetics vendor and product ids */
63 #define ABBOTT_VENDOR_ID		0x1a61
64 #define ABBOTT_STEREO_PLUG_ID		0x3410
65 #define ABBOTT_PRODUCT_ID		ABBOTT_STEREO_PLUG_ID
66 #define ABBOTT_STRIP_PORT_ID		0x3420
67 
68 /* Honeywell vendor and product IDs */
69 #define HONEYWELL_VENDOR_ID		0x10ac
70 #define HONEYWELL_HGI80_PRODUCT_ID	0x0102  /* Honeywell HGI80 */
71 
72 /* Moxa UPORT 11x0 vendor and product IDs */
73 #define MXU1_VENDOR_ID				0x110a
74 #define MXU1_1110_PRODUCT_ID			0x1110
75 #define MXU1_1130_PRODUCT_ID			0x1130
76 #define MXU1_1150_PRODUCT_ID			0x1150
77 #define MXU1_1151_PRODUCT_ID			0x1151
78 #define MXU1_1131_PRODUCT_ID			0x1131
79 
80 /* Commands */
81 #define TI_GET_VERSION			0x01
82 #define TI_GET_PORT_STATUS		0x02
83 #define TI_GET_PORT_DEV_INFO		0x03
84 #define TI_GET_CONFIG			0x04
85 #define TI_SET_CONFIG			0x05
86 #define TI_OPEN_PORT			0x06
87 #define TI_CLOSE_PORT			0x07
88 #define TI_START_PORT			0x08
89 #define TI_STOP_PORT			0x09
90 #define TI_TEST_PORT			0x0A
91 #define TI_PURGE_PORT			0x0B
92 #define TI_RESET_EXT_DEVICE		0x0C
93 #define TI_WRITE_DATA			0x80
94 #define TI_READ_DATA			0x81
95 #define TI_REQ_TYPE_CLASS		0x82
96 
97 /* Module identifiers */
98 #define TI_I2C_PORT			0x01
99 #define TI_IEEE1284_PORT		0x02
100 #define TI_UART1_PORT			0x03
101 #define TI_UART2_PORT			0x04
102 #define TI_RAM_PORT			0x05
103 
104 /* Modem status */
105 #define TI_MSR_DELTA_CTS		0x01
106 #define TI_MSR_DELTA_DSR		0x02
107 #define TI_MSR_DELTA_RI			0x04
108 #define TI_MSR_DELTA_CD			0x08
109 #define TI_MSR_CTS			0x10
110 #define TI_MSR_DSR			0x20
111 #define TI_MSR_RI			0x40
112 #define TI_MSR_CD			0x80
113 #define TI_MSR_DELTA_MASK		0x0F
114 #define TI_MSR_MASK			0xF0
115 
116 /* Line status */
117 #define TI_LSR_OVERRUN_ERROR		0x01
118 #define TI_LSR_PARITY_ERROR		0x02
119 #define TI_LSR_FRAMING_ERROR		0x04
120 #define TI_LSR_BREAK			0x08
121 #define TI_LSR_ERROR			0x0F
122 #define TI_LSR_RX_FULL			0x10
123 #define TI_LSR_TX_EMPTY			0x20
124 
125 /* Line control */
126 #define TI_LCR_BREAK			0x40
127 
128 /* Modem control */
129 #define TI_MCR_LOOP			0x04
130 #define TI_MCR_DTR			0x10
131 #define TI_MCR_RTS			0x20
132 
133 /* Mask settings */
134 #define TI_UART_ENABLE_RTS_IN		0x0001
135 #define TI_UART_DISABLE_RTS		0x0002
136 #define TI_UART_ENABLE_PARITY_CHECKING	0x0008
137 #define TI_UART_ENABLE_DSR_OUT		0x0010
138 #define TI_UART_ENABLE_CTS_OUT		0x0020
139 #define TI_UART_ENABLE_X_OUT		0x0040
140 #define TI_UART_ENABLE_XA_OUT		0x0080
141 #define TI_UART_ENABLE_X_IN		0x0100
142 #define TI_UART_ENABLE_DTR_IN		0x0800
143 #define TI_UART_DISABLE_DTR		0x1000
144 #define TI_UART_ENABLE_MS_INTS		0x2000
145 #define TI_UART_ENABLE_AUTO_START_DMA	0x4000
146 
147 /* Parity */
148 #define TI_UART_NO_PARITY		0x00
149 #define TI_UART_ODD_PARITY		0x01
150 #define TI_UART_EVEN_PARITY		0x02
151 #define TI_UART_MARK_PARITY		0x03
152 #define TI_UART_SPACE_PARITY		0x04
153 
154 /* Stop bits */
155 #define TI_UART_1_STOP_BITS		0x00
156 #define TI_UART_1_5_STOP_BITS		0x01
157 #define TI_UART_2_STOP_BITS		0x02
158 
159 /* Bits per character */
160 #define TI_UART_5_DATA_BITS		0x00
161 #define TI_UART_6_DATA_BITS		0x01
162 #define TI_UART_7_DATA_BITS		0x02
163 #define TI_UART_8_DATA_BITS		0x03
164 
165 /* 232/485 modes */
166 #define TI_UART_232			0x00
167 #define TI_UART_485_RECEIVER_DISABLED	0x01
168 #define TI_UART_485_RECEIVER_ENABLED	0x02
169 
170 /* Pipe transfer mode and timeout */
171 #define TI_PIPE_MODE_CONTINUOUS		0x01
172 #define TI_PIPE_MODE_MASK		0x03
173 #define TI_PIPE_TIMEOUT_MASK		0x7C
174 #define TI_PIPE_TIMEOUT_ENABLE		0x80
175 
176 /* Config struct */
177 struct ti_uart_config {
178 	__be16	wBaudRate;
179 	__be16	wFlags;
180 	u8	bDataBits;
181 	u8	bParity;
182 	u8	bStopBits;
183 	char	cXon;
184 	char	cXoff;
185 	u8	bUartMode;
186 } __packed;
187 
188 /* Get port status */
189 struct ti_port_status {
190 	u8 bCmdCode;
191 	u8 bModuleId;
192 	u8 bErrorCode;
193 	u8 bMSR;
194 	u8 bLSR;
195 } __packed;
196 
197 /* Purge modes */
198 #define TI_PURGE_OUTPUT			0x00
199 #define TI_PURGE_INPUT			0x80
200 
201 /* Read/Write data */
202 #define TI_RW_DATA_ADDR_SFR		0x10
203 #define TI_RW_DATA_ADDR_IDATA		0x20
204 #define TI_RW_DATA_ADDR_XDATA		0x30
205 #define TI_RW_DATA_ADDR_CODE		0x40
206 #define TI_RW_DATA_ADDR_GPIO		0x50
207 #define TI_RW_DATA_ADDR_I2C		0x60
208 #define TI_RW_DATA_ADDR_FLASH		0x70
209 #define TI_RW_DATA_ADDR_DSP		0x80
210 
211 #define TI_RW_DATA_UNSPECIFIED		0x00
212 #define TI_RW_DATA_BYTE			0x01
213 #define TI_RW_DATA_WORD			0x02
214 #define TI_RW_DATA_DOUBLE_WORD		0x04
215 
216 struct ti_write_data_bytes {
217 	u8	bAddrType;
218 	u8	bDataType;
219 	u8	bDataCounter;
220 	__be16	wBaseAddrHi;
221 	__be16	wBaseAddrLo;
222 	u8	bData[];
223 } __packed;
224 
225 struct ti_read_data_request {
226 	__u8	bAddrType;
227 	__u8	bDataType;
228 	__u8	bDataCounter;
229 	__be16	wBaseAddrHi;
230 	__be16	wBaseAddrLo;
231 } __packed;
232 
233 struct ti_read_data_bytes {
234 	__u8	bCmdCode;
235 	__u8	bModuleId;
236 	__u8	bErrorCode;
237 	__u8	bData[];
238 } __packed;
239 
240 /* Interrupt struct */
241 struct ti_interrupt {
242 	__u8	bICode;
243 	__u8	bIInfo;
244 } __packed;
245 
246 /* Interrupt codes */
247 #define TI_CODE_HARDWARE_ERROR		0xFF
248 #define TI_CODE_DATA_ERROR		0x03
249 #define TI_CODE_MODEM_STATUS		0x04
250 
251 /* Download firmware max packet size */
252 #define TI_DOWNLOAD_MAX_PACKET_SIZE	64
253 
254 /* Firmware image header */
255 struct ti_firmware_header {
256 	__le16	wLength;
257 	u8	bCheckSum;
258 } __packed;
259 
260 /* UART addresses */
261 #define TI_UART1_BASE_ADDR		0xFFA0	/* UART 1 base address */
262 #define TI_UART2_BASE_ADDR		0xFFB0	/* UART 2 base address */
263 #define TI_UART_OFFSET_LCR		0x0002	/* UART MCR register offset */
264 #define TI_UART_OFFSET_MCR		0x0004	/* UART MCR register offset */
265 
266 #define TI_DRIVER_AUTHOR	"Al Borchers <alborchers@steinerpoint.com>"
267 #define TI_DRIVER_DESC		"TI USB 3410/5052 Serial Driver"
268 
269 #define TI_FIRMWARE_BUF_SIZE	16284
270 
271 #define TI_TRANSFER_TIMEOUT	2
272 
273 #define TI_DEFAULT_CLOSING_WAIT	4000		/* in .01 secs */
274 
275 /* read urb states */
276 #define TI_READ_URB_RUNNING	0
277 #define TI_READ_URB_STOPPING	1
278 #define TI_READ_URB_STOPPED	2
279 
280 #define TI_EXTRA_VID_PID_COUNT	5
281 
282 struct ti_port {
283 	int			tp_is_open;
284 	u8			tp_msr;
285 	u8			tp_shadow_mcr;
286 	u8			tp_uart_mode;	/* 232 or 485 modes */
287 	unsigned int		tp_uart_base_addr;
288 	struct ti_device	*tp_tdev;
289 	struct usb_serial_port	*tp_port;
290 	spinlock_t		tp_lock;
291 	int			tp_read_urb_state;
292 	int			tp_write_urb_in_use;
293 };
294 
295 struct ti_device {
296 	struct mutex		td_open_close_lock;
297 	int			td_open_port_count;
298 	struct usb_serial	*td_serial;
299 	int			td_is_3410;
300 	bool			td_rs485_only;
301 };
302 
303 static int ti_startup(struct usb_serial *serial);
304 static void ti_release(struct usb_serial *serial);
305 static int ti_port_probe(struct usb_serial_port *port);
306 static void ti_port_remove(struct usb_serial_port *port);
307 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port);
308 static void ti_close(struct usb_serial_port *port);
309 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
310 		const unsigned char *data, int count);
311 static int ti_write_room(struct tty_struct *tty);
312 static int ti_chars_in_buffer(struct tty_struct *tty);
313 static bool ti_tx_empty(struct usb_serial_port *port);
314 static void ti_throttle(struct tty_struct *tty);
315 static void ti_unthrottle(struct tty_struct *tty);
316 static void ti_set_termios(struct tty_struct *tty,
317 		struct usb_serial_port *port, struct ktermios *old_termios);
318 static int ti_tiocmget(struct tty_struct *tty);
319 static int ti_tiocmset(struct tty_struct *tty,
320 		unsigned int set, unsigned int clear);
321 static void ti_break(struct tty_struct *tty, int break_state);
322 static void ti_interrupt_callback(struct urb *urb);
323 static void ti_bulk_in_callback(struct urb *urb);
324 static void ti_bulk_out_callback(struct urb *urb);
325 
326 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
327 		int length);
328 static void ti_send(struct ti_port *tport);
329 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr);
330 static int ti_get_lsr(struct ti_port *tport, u8 *lsr);
331 static int ti_get_serial_info(struct tty_struct *tty,
332 	struct serial_struct *ss);
333 static int ti_set_serial_info(struct tty_struct *tty,
334 	struct serial_struct *ss);
335 static void ti_handle_new_msr(struct ti_port *tport, u8 msr);
336 
337 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty);
338 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty);
339 
340 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
341 	__u16 moduleid, __u16 value, __u8 *data, int size);
342 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
343 	__u16 moduleid, __u16 value, __u8 *data, int size);
344 
345 static int ti_write_byte(struct usb_serial_port *port, struct ti_device *tdev,
346 			 unsigned long addr, u8 mask, u8 byte);
347 
348 static int ti_download_firmware(struct ti_device *tdev);
349 
350 static int closing_wait = TI_DEFAULT_CLOSING_WAIT;
351 
352 static const struct usb_device_id ti_id_table_3410[] = {
353 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
354 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
355 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
356 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
357 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
358 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
359 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
360 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
361 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
362 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
363 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
364 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
365 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
366 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STEREO_PLUG_ID) },
367 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
368 	{ USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
369 	{ USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
370 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
371 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
372 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
373 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
374 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
375 	{ }	/* terminator */
376 };
377 
378 static const struct usb_device_id ti_id_table_5052[] = {
379 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
380 	{ USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
381 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
382 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
383 	{ }
384 };
385 
386 static const struct usb_device_id ti_id_table_combined[] = {
387 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
388 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
389 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
390 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
391 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
392 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
393 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
394 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
395 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
396 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
397 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
398 	{ USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
399 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
400 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
401 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
402 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
403 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
404 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_PRODUCT_ID) },
405 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
406 	{ USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
407 	{ USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
408 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
409 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
410 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
411 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
412 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
413 	{ }	/* terminator */
414 };
415 
416 static struct usb_serial_driver ti_1port_device = {
417 	.driver = {
418 		.owner		= THIS_MODULE,
419 		.name		= "ti_usb_3410_5052_1",
420 	},
421 	.description		= "TI USB 3410 1 port adapter",
422 	.id_table		= ti_id_table_3410,
423 	.num_ports		= 1,
424 	.num_bulk_out		= 1,
425 	.attach			= ti_startup,
426 	.release		= ti_release,
427 	.port_probe		= ti_port_probe,
428 	.port_remove		= ti_port_remove,
429 	.open			= ti_open,
430 	.close			= ti_close,
431 	.write			= ti_write,
432 	.write_room		= ti_write_room,
433 	.chars_in_buffer	= ti_chars_in_buffer,
434 	.tx_empty		= ti_tx_empty,
435 	.throttle		= ti_throttle,
436 	.unthrottle		= ti_unthrottle,
437 	.get_serial		= ti_get_serial_info,
438 	.set_serial		= ti_set_serial_info,
439 	.set_termios		= ti_set_termios,
440 	.tiocmget		= ti_tiocmget,
441 	.tiocmset		= ti_tiocmset,
442 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
443 	.get_icount		= usb_serial_generic_get_icount,
444 	.break_ctl		= ti_break,
445 	.read_int_callback	= ti_interrupt_callback,
446 	.read_bulk_callback	= ti_bulk_in_callback,
447 	.write_bulk_callback	= ti_bulk_out_callback,
448 };
449 
450 static struct usb_serial_driver ti_2port_device = {
451 	.driver = {
452 		.owner		= THIS_MODULE,
453 		.name		= "ti_usb_3410_5052_2",
454 	},
455 	.description		= "TI USB 5052 2 port adapter",
456 	.id_table		= ti_id_table_5052,
457 	.num_ports		= 2,
458 	.num_bulk_out		= 1,
459 	.attach			= ti_startup,
460 	.release		= ti_release,
461 	.port_probe		= ti_port_probe,
462 	.port_remove		= ti_port_remove,
463 	.open			= ti_open,
464 	.close			= ti_close,
465 	.write			= ti_write,
466 	.write_room		= ti_write_room,
467 	.chars_in_buffer	= ti_chars_in_buffer,
468 	.tx_empty		= ti_tx_empty,
469 	.throttle		= ti_throttle,
470 	.unthrottle		= ti_unthrottle,
471 	.get_serial		= ti_get_serial_info,
472 	.set_serial		= ti_set_serial_info,
473 	.set_termios		= ti_set_termios,
474 	.tiocmget		= ti_tiocmget,
475 	.tiocmset		= ti_tiocmset,
476 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
477 	.get_icount		= usb_serial_generic_get_icount,
478 	.break_ctl		= ti_break,
479 	.read_int_callback	= ti_interrupt_callback,
480 	.read_bulk_callback	= ti_bulk_in_callback,
481 	.write_bulk_callback	= ti_bulk_out_callback,
482 };
483 
484 static struct usb_serial_driver * const serial_drivers[] = {
485 	&ti_1port_device, &ti_2port_device, NULL
486 };
487 
488 MODULE_AUTHOR(TI_DRIVER_AUTHOR);
489 MODULE_DESCRIPTION(TI_DRIVER_DESC);
490 MODULE_LICENSE("GPL");
491 
492 MODULE_FIRMWARE("ti_3410.fw");
493 MODULE_FIRMWARE("ti_5052.fw");
494 MODULE_FIRMWARE("mts_cdma.fw");
495 MODULE_FIRMWARE("mts_gsm.fw");
496 MODULE_FIRMWARE("mts_edge.fw");
497 MODULE_FIRMWARE("mts_mt9234mu.fw");
498 MODULE_FIRMWARE("mts_mt9234zba.fw");
499 MODULE_FIRMWARE("moxa/moxa-1110.fw");
500 MODULE_FIRMWARE("moxa/moxa-1130.fw");
501 MODULE_FIRMWARE("moxa/moxa-1131.fw");
502 MODULE_FIRMWARE("moxa/moxa-1150.fw");
503 MODULE_FIRMWARE("moxa/moxa-1151.fw");
504 
505 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
506 MODULE_PARM_DESC(closing_wait,
507     "Maximum wait for data to drain in close, in .01 secs, default is 4000");
508 
509 MODULE_DEVICE_TABLE(usb, ti_id_table_combined);
510 
511 module_usb_serial_driver(serial_drivers, ti_id_table_combined);
512 
513 static int ti_startup(struct usb_serial *serial)
514 {
515 	struct ti_device *tdev;
516 	struct usb_device *dev = serial->dev;
517 	struct usb_host_interface *cur_altsetting;
518 	int num_endpoints;
519 	u16 vid, pid;
520 	int status;
521 
522 	dev_dbg(&dev->dev,
523 		"%s - product 0x%4X, num configurations %d, configuration value %d\n",
524 		__func__, le16_to_cpu(dev->descriptor.idProduct),
525 		dev->descriptor.bNumConfigurations,
526 		dev->actconfig->desc.bConfigurationValue);
527 
528 	tdev = kzalloc(sizeof(struct ti_device), GFP_KERNEL);
529 	if (!tdev)
530 		return -ENOMEM;
531 
532 	mutex_init(&tdev->td_open_close_lock);
533 	tdev->td_serial = serial;
534 	usb_set_serial_data(serial, tdev);
535 
536 	/* determine device type */
537 	if (serial->type == &ti_1port_device)
538 		tdev->td_is_3410 = 1;
539 	dev_dbg(&dev->dev, "%s - device type is %s\n", __func__,
540 		tdev->td_is_3410 ? "3410" : "5052");
541 
542 	vid = le16_to_cpu(dev->descriptor.idVendor);
543 	pid = le16_to_cpu(dev->descriptor.idProduct);
544 	if (vid == MXU1_VENDOR_ID) {
545 		switch (pid) {
546 		case MXU1_1130_PRODUCT_ID:
547 		case MXU1_1131_PRODUCT_ID:
548 			tdev->td_rs485_only = true;
549 			break;
550 		}
551 	}
552 
553 	cur_altsetting = serial->interface->cur_altsetting;
554 	num_endpoints = cur_altsetting->desc.bNumEndpoints;
555 
556 	/* if we have only 1 configuration and 1 endpoint, download firmware */
557 	if (dev->descriptor.bNumConfigurations == 1 && num_endpoints == 1) {
558 		status = ti_download_firmware(tdev);
559 
560 		if (status != 0)
561 			goto free_tdev;
562 
563 		/* 3410 must be reset, 5052 resets itself */
564 		if (tdev->td_is_3410) {
565 			msleep_interruptible(100);
566 			usb_reset_device(dev);
567 		}
568 
569 		status = -ENODEV;
570 		goto free_tdev;
571 	}
572 
573 	/* the second configuration must be set */
574 	if (dev->actconfig->desc.bConfigurationValue == TI_BOOT_CONFIG) {
575 		status = usb_driver_set_configuration(dev, TI_ACTIVE_CONFIG);
576 		status = status ? status : -ENODEV;
577 		goto free_tdev;
578 	}
579 
580 	if (serial->num_bulk_in < serial->num_ports ||
581 			serial->num_bulk_out < serial->num_ports) {
582 		dev_err(&serial->interface->dev, "missing endpoints\n");
583 		status = -ENODEV;
584 		goto free_tdev;
585 	}
586 
587 	return 0;
588 
589 free_tdev:
590 	kfree(tdev);
591 	usb_set_serial_data(serial, NULL);
592 	return status;
593 }
594 
595 
596 static void ti_release(struct usb_serial *serial)
597 {
598 	struct ti_device *tdev = usb_get_serial_data(serial);
599 
600 	kfree(tdev);
601 }
602 
603 static int ti_port_probe(struct usb_serial_port *port)
604 {
605 	struct ti_port *tport;
606 
607 	tport = kzalloc(sizeof(*tport), GFP_KERNEL);
608 	if (!tport)
609 		return -ENOMEM;
610 
611 	spin_lock_init(&tport->tp_lock);
612 	if (port == port->serial->port[0])
613 		tport->tp_uart_base_addr = TI_UART1_BASE_ADDR;
614 	else
615 		tport->tp_uart_base_addr = TI_UART2_BASE_ADDR;
616 	port->port.closing_wait = msecs_to_jiffies(10 * closing_wait);
617 	tport->tp_port = port;
618 	tport->tp_tdev = usb_get_serial_data(port->serial);
619 
620 	if (tport->tp_tdev->td_rs485_only)
621 		tport->tp_uart_mode = TI_UART_485_RECEIVER_DISABLED;
622 	else
623 		tport->tp_uart_mode = TI_UART_232;
624 
625 	usb_set_serial_port_data(port, tport);
626 
627 	port->port.drain_delay = 3;
628 
629 	return 0;
630 }
631 
632 static void ti_port_remove(struct usb_serial_port *port)
633 {
634 	struct ti_port *tport;
635 
636 	tport = usb_get_serial_port_data(port);
637 	kfree(tport);
638 }
639 
640 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
641 {
642 	struct ti_port *tport = usb_get_serial_port_data(port);
643 	struct ti_device *tdev;
644 	struct usb_device *dev;
645 	struct urb *urb;
646 	int port_number;
647 	int status;
648 	u16 open_settings;
649 
650 	open_settings = (TI_PIPE_MODE_CONTINUOUS |
651 			 TI_PIPE_TIMEOUT_ENABLE |
652 			 (TI_TRANSFER_TIMEOUT << 2));
653 
654 	dev = port->serial->dev;
655 	tdev = tport->tp_tdev;
656 
657 	/* only one open on any port on a device at a time */
658 	if (mutex_lock_interruptible(&tdev->td_open_close_lock))
659 		return -ERESTARTSYS;
660 
661 	port_number = port->port_number;
662 
663 	tport->tp_msr = 0;
664 	tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
665 
666 	/* start interrupt urb the first time a port is opened on this device */
667 	if (tdev->td_open_port_count == 0) {
668 		dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
669 		urb = tdev->td_serial->port[0]->interrupt_in_urb;
670 		if (!urb) {
671 			dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
672 			status = -EINVAL;
673 			goto release_lock;
674 		}
675 		urb->context = tdev;
676 		status = usb_submit_urb(urb, GFP_KERNEL);
677 		if (status) {
678 			dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
679 			goto release_lock;
680 		}
681 	}
682 
683 	if (tty)
684 		ti_set_termios(tty, port, &tty->termios);
685 
686 	status = ti_command_out_sync(tdev, TI_OPEN_PORT,
687 		(__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
688 	if (status) {
689 		dev_err(&port->dev, "%s - cannot send open command, %d\n",
690 			__func__, status);
691 		goto unlink_int_urb;
692 	}
693 
694 	status = ti_command_out_sync(tdev, TI_START_PORT,
695 		(__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
696 	if (status) {
697 		dev_err(&port->dev, "%s - cannot send start command, %d\n",
698 							__func__, status);
699 		goto unlink_int_urb;
700 	}
701 
702 	status = ti_command_out_sync(tdev, TI_PURGE_PORT,
703 		(__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
704 	if (status) {
705 		dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
706 							__func__, status);
707 		goto unlink_int_urb;
708 	}
709 	status = ti_command_out_sync(tdev, TI_PURGE_PORT,
710 		(__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
711 	if (status) {
712 		dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
713 							__func__, status);
714 		goto unlink_int_urb;
715 	}
716 
717 	/* reset the data toggle on the bulk endpoints to work around bug in
718 	 * host controllers where things get out of sync some times */
719 	usb_clear_halt(dev, port->write_urb->pipe);
720 	usb_clear_halt(dev, port->read_urb->pipe);
721 
722 	if (tty)
723 		ti_set_termios(tty, port, &tty->termios);
724 
725 	status = ti_command_out_sync(tdev, TI_OPEN_PORT,
726 		(__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
727 	if (status) {
728 		dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
729 							__func__, status);
730 		goto unlink_int_urb;
731 	}
732 
733 	status = ti_command_out_sync(tdev, TI_START_PORT,
734 		(__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
735 	if (status) {
736 		dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
737 							__func__, status);
738 		goto unlink_int_urb;
739 	}
740 
741 	/* start read urb */
742 	urb = port->read_urb;
743 	if (!urb) {
744 		dev_err(&port->dev, "%s - no read urb\n", __func__);
745 		status = -EINVAL;
746 		goto unlink_int_urb;
747 	}
748 	tport->tp_read_urb_state = TI_READ_URB_RUNNING;
749 	urb->context = tport;
750 	status = usb_submit_urb(urb, GFP_KERNEL);
751 	if (status) {
752 		dev_err(&port->dev, "%s - submit read urb failed, %d\n",
753 							__func__, status);
754 		goto unlink_int_urb;
755 	}
756 
757 	tport->tp_is_open = 1;
758 	++tdev->td_open_port_count;
759 
760 	goto release_lock;
761 
762 unlink_int_urb:
763 	if (tdev->td_open_port_count == 0)
764 		usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
765 release_lock:
766 	mutex_unlock(&tdev->td_open_close_lock);
767 	return status;
768 }
769 
770 
771 static void ti_close(struct usb_serial_port *port)
772 {
773 	struct ti_device *tdev;
774 	struct ti_port *tport;
775 	int port_number;
776 	int status;
777 	unsigned long flags;
778 
779 	tdev = usb_get_serial_data(port->serial);
780 	tport = usb_get_serial_port_data(port);
781 
782 	tport->tp_is_open = 0;
783 
784 	usb_kill_urb(port->read_urb);
785 	usb_kill_urb(port->write_urb);
786 	tport->tp_write_urb_in_use = 0;
787 	spin_lock_irqsave(&tport->tp_lock, flags);
788 	kfifo_reset_out(&port->write_fifo);
789 	spin_unlock_irqrestore(&tport->tp_lock, flags);
790 
791 	port_number = port->port_number;
792 
793 	status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
794 		     (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
795 	if (status)
796 		dev_err(&port->dev,
797 			"%s - cannot send close port command, %d\n"
798 							, __func__, status);
799 
800 	mutex_lock(&tdev->td_open_close_lock);
801 	--tdev->td_open_port_count;
802 	if (tdev->td_open_port_count == 0) {
803 		/* last port is closed, shut down interrupt urb */
804 		usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
805 	}
806 	mutex_unlock(&tdev->td_open_close_lock);
807 }
808 
809 
810 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
811 			const unsigned char *data, int count)
812 {
813 	struct ti_port *tport = usb_get_serial_port_data(port);
814 
815 	if (count == 0) {
816 		return 0;
817 	}
818 
819 	if (!tport->tp_is_open)
820 		return -ENODEV;
821 
822 	count = kfifo_in_locked(&port->write_fifo, data, count,
823 							&tport->tp_lock);
824 	ti_send(tport);
825 
826 	return count;
827 }
828 
829 
830 static int ti_write_room(struct tty_struct *tty)
831 {
832 	struct usb_serial_port *port = tty->driver_data;
833 	struct ti_port *tport = usb_get_serial_port_data(port);
834 	int room = 0;
835 	unsigned long flags;
836 
837 	spin_lock_irqsave(&tport->tp_lock, flags);
838 	room = kfifo_avail(&port->write_fifo);
839 	spin_unlock_irqrestore(&tport->tp_lock, flags);
840 
841 	dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
842 	return room;
843 }
844 
845 
846 static int ti_chars_in_buffer(struct tty_struct *tty)
847 {
848 	struct usb_serial_port *port = tty->driver_data;
849 	struct ti_port *tport = usb_get_serial_port_data(port);
850 	int chars = 0;
851 	unsigned long flags;
852 
853 	spin_lock_irqsave(&tport->tp_lock, flags);
854 	chars = kfifo_len(&port->write_fifo);
855 	spin_unlock_irqrestore(&tport->tp_lock, flags);
856 
857 	dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
858 	return chars;
859 }
860 
861 static bool ti_tx_empty(struct usb_serial_port *port)
862 {
863 	struct ti_port *tport = usb_get_serial_port_data(port);
864 	int ret;
865 	u8 lsr;
866 
867 	ret = ti_get_lsr(tport, &lsr);
868 	if (!ret && !(lsr & TI_LSR_TX_EMPTY))
869 		return false;
870 
871 	return true;
872 }
873 
874 static void ti_throttle(struct tty_struct *tty)
875 {
876 	struct usb_serial_port *port = tty->driver_data;
877 	struct ti_port *tport = usb_get_serial_port_data(port);
878 
879 	if (I_IXOFF(tty) || C_CRTSCTS(tty))
880 		ti_stop_read(tport, tty);
881 
882 }
883 
884 
885 static void ti_unthrottle(struct tty_struct *tty)
886 {
887 	struct usb_serial_port *port = tty->driver_data;
888 	struct ti_port *tport = usb_get_serial_port_data(port);
889 	int status;
890 
891 	if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
892 		status = ti_restart_read(tport, tty);
893 		if (status)
894 			dev_err(&port->dev, "%s - cannot restart read, %d\n",
895 							__func__, status);
896 	}
897 }
898 
899 static void ti_set_termios(struct tty_struct *tty,
900 		struct usb_serial_port *port, struct ktermios *old_termios)
901 {
902 	struct ti_port *tport = usb_get_serial_port_data(port);
903 	struct ti_uart_config *config;
904 	int baud;
905 	int status;
906 	int port_number = port->port_number;
907 	unsigned int mcr;
908 	u16 wbaudrate;
909 	u16 wflags = 0;
910 
911 	config = kmalloc(sizeof(*config), GFP_KERNEL);
912 	if (!config)
913 		return;
914 
915 	/* these flags must be set */
916 	wflags |= TI_UART_ENABLE_MS_INTS;
917 	wflags |= TI_UART_ENABLE_AUTO_START_DMA;
918 	config->bUartMode = tport->tp_uart_mode;
919 
920 	switch (C_CSIZE(tty)) {
921 	case CS5:
922 		    config->bDataBits = TI_UART_5_DATA_BITS;
923 		    break;
924 	case CS6:
925 		    config->bDataBits = TI_UART_6_DATA_BITS;
926 		    break;
927 	case CS7:
928 		    config->bDataBits = TI_UART_7_DATA_BITS;
929 		    break;
930 	default:
931 	case CS8:
932 		    config->bDataBits = TI_UART_8_DATA_BITS;
933 		    break;
934 	}
935 
936 	/* CMSPAR isn't supported by this driver */
937 	tty->termios.c_cflag &= ~CMSPAR;
938 
939 	if (C_PARENB(tty)) {
940 		if (C_PARODD(tty)) {
941 			wflags |= TI_UART_ENABLE_PARITY_CHECKING;
942 			config->bParity = TI_UART_ODD_PARITY;
943 		} else {
944 			wflags |= TI_UART_ENABLE_PARITY_CHECKING;
945 			config->bParity = TI_UART_EVEN_PARITY;
946 		}
947 	} else {
948 		wflags &= ~TI_UART_ENABLE_PARITY_CHECKING;
949 		config->bParity = TI_UART_NO_PARITY;
950 	}
951 
952 	if (C_CSTOPB(tty))
953 		config->bStopBits = TI_UART_2_STOP_BITS;
954 	else
955 		config->bStopBits = TI_UART_1_STOP_BITS;
956 
957 	if (C_CRTSCTS(tty)) {
958 		/* RTS flow control must be off to drop RTS for baud rate B0 */
959 		if ((C_BAUD(tty)) != B0)
960 			wflags |= TI_UART_ENABLE_RTS_IN;
961 		wflags |= TI_UART_ENABLE_CTS_OUT;
962 	} else {
963 		ti_restart_read(tport, tty);
964 	}
965 
966 	if (I_IXOFF(tty) || I_IXON(tty)) {
967 		config->cXon  = START_CHAR(tty);
968 		config->cXoff = STOP_CHAR(tty);
969 
970 		if (I_IXOFF(tty))
971 			wflags |= TI_UART_ENABLE_X_IN;
972 		else
973 			ti_restart_read(tport, tty);
974 
975 		if (I_IXON(tty))
976 			wflags |= TI_UART_ENABLE_X_OUT;
977 	}
978 
979 	baud = tty_get_baud_rate(tty);
980 	if (!baud)
981 		baud = 9600;
982 	if (tport->tp_tdev->td_is_3410)
983 		wbaudrate = (923077 + baud/2) / baud;
984 	else
985 		wbaudrate = (461538 + baud/2) / baud;
986 
987 	/* FIXME: Should calculate resulting baud here and report it back */
988 	if ((C_BAUD(tty)) != B0)
989 		tty_encode_baud_rate(tty, baud, baud);
990 
991 	dev_dbg(&port->dev,
992 		"%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d\n",
993 		__func__, baud, wbaudrate, wflags,
994 		config->bDataBits, config->bParity, config->bStopBits,
995 		config->cXon, config->cXoff, config->bUartMode);
996 
997 	config->wBaudRate = cpu_to_be16(wbaudrate);
998 	config->wFlags = cpu_to_be16(wflags);
999 
1000 	status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
1001 		(__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
1002 		sizeof(*config));
1003 	if (status)
1004 		dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
1005 					__func__, port_number, status);
1006 
1007 	/* SET_CONFIG asserts RTS and DTR, reset them correctly */
1008 	mcr = tport->tp_shadow_mcr;
1009 	/* if baud rate is B0, clear RTS and DTR */
1010 	if (C_BAUD(tty) == B0)
1011 		mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
1012 	status = ti_set_mcr(tport, mcr);
1013 	if (status)
1014 		dev_err(&port->dev,
1015 			"%s - cannot set modem control on port %d, %d\n",
1016 						__func__, port_number, status);
1017 
1018 	kfree(config);
1019 }
1020 
1021 
1022 static int ti_tiocmget(struct tty_struct *tty)
1023 {
1024 	struct usb_serial_port *port = tty->driver_data;
1025 	struct ti_port *tport = usb_get_serial_port_data(port);
1026 	unsigned int result;
1027 	unsigned int msr;
1028 	unsigned int mcr;
1029 	unsigned long flags;
1030 
1031 	spin_lock_irqsave(&tport->tp_lock, flags);
1032 	msr = tport->tp_msr;
1033 	mcr = tport->tp_shadow_mcr;
1034 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1035 
1036 	result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
1037 		| ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
1038 		| ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
1039 		| ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
1040 		| ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
1041 		| ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
1042 		| ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
1043 
1044 	dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
1045 
1046 	return result;
1047 }
1048 
1049 
1050 static int ti_tiocmset(struct tty_struct *tty,
1051 				unsigned int set, unsigned int clear)
1052 {
1053 	struct usb_serial_port *port = tty->driver_data;
1054 	struct ti_port *tport = usb_get_serial_port_data(port);
1055 	unsigned int mcr;
1056 	unsigned long flags;
1057 
1058 	spin_lock_irqsave(&tport->tp_lock, flags);
1059 	mcr = tport->tp_shadow_mcr;
1060 
1061 	if (set & TIOCM_RTS)
1062 		mcr |= TI_MCR_RTS;
1063 	if (set & TIOCM_DTR)
1064 		mcr |= TI_MCR_DTR;
1065 	if (set & TIOCM_LOOP)
1066 		mcr |= TI_MCR_LOOP;
1067 
1068 	if (clear & TIOCM_RTS)
1069 		mcr &= ~TI_MCR_RTS;
1070 	if (clear & TIOCM_DTR)
1071 		mcr &= ~TI_MCR_DTR;
1072 	if (clear & TIOCM_LOOP)
1073 		mcr &= ~TI_MCR_LOOP;
1074 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1075 
1076 	return ti_set_mcr(tport, mcr);
1077 }
1078 
1079 
1080 static void ti_break(struct tty_struct *tty, int break_state)
1081 {
1082 	struct usb_serial_port *port = tty->driver_data;
1083 	struct ti_port *tport = usb_get_serial_port_data(port);
1084 	int status;
1085 
1086 	dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
1087 
1088 	status = ti_write_byte(port, tport->tp_tdev,
1089 		tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
1090 		TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
1091 
1092 	if (status)
1093 		dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
1094 }
1095 
1096 static int ti_get_port_from_code(unsigned char code)
1097 {
1098 	return (code >> 6) & 0x01;
1099 }
1100 
1101 static int ti_get_func_from_code(unsigned char code)
1102 {
1103 	return code & 0x0f;
1104 }
1105 
1106 static void ti_interrupt_callback(struct urb *urb)
1107 {
1108 	struct ti_device *tdev = urb->context;
1109 	struct usb_serial_port *port;
1110 	struct usb_serial *serial = tdev->td_serial;
1111 	struct ti_port *tport;
1112 	struct device *dev = &urb->dev->dev;
1113 	unsigned char *data = urb->transfer_buffer;
1114 	int length = urb->actual_length;
1115 	int port_number;
1116 	int function;
1117 	int status = urb->status;
1118 	int retval;
1119 	u8 msr;
1120 
1121 	switch (status) {
1122 	case 0:
1123 		break;
1124 	case -ECONNRESET:
1125 	case -ENOENT:
1126 	case -ESHUTDOWN:
1127 		dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1128 		return;
1129 	default:
1130 		dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
1131 		goto exit;
1132 	}
1133 
1134 	if (length != 2) {
1135 		dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
1136 		goto exit;
1137 	}
1138 
1139 	if (data[0] == TI_CODE_HARDWARE_ERROR) {
1140 		dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
1141 		goto exit;
1142 	}
1143 
1144 	port_number = ti_get_port_from_code(data[0]);
1145 	function = ti_get_func_from_code(data[0]);
1146 
1147 	dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
1148 		__func__, port_number, function, data[1]);
1149 
1150 	if (port_number >= serial->num_ports) {
1151 		dev_err(dev, "%s - bad port number, %d\n",
1152 						__func__, port_number);
1153 		goto exit;
1154 	}
1155 
1156 	port = serial->port[port_number];
1157 
1158 	tport = usb_get_serial_port_data(port);
1159 	if (!tport)
1160 		goto exit;
1161 
1162 	switch (function) {
1163 	case TI_CODE_DATA_ERROR:
1164 		dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
1165 			__func__, port_number, data[1]);
1166 		break;
1167 
1168 	case TI_CODE_MODEM_STATUS:
1169 		msr = data[1];
1170 		dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
1171 		ti_handle_new_msr(tport, msr);
1172 		break;
1173 
1174 	default:
1175 		dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
1176 							__func__, data[1]);
1177 		break;
1178 	}
1179 
1180 exit:
1181 	retval = usb_submit_urb(urb, GFP_ATOMIC);
1182 	if (retval)
1183 		dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1184 			__func__, retval);
1185 }
1186 
1187 
1188 static void ti_bulk_in_callback(struct urb *urb)
1189 {
1190 	struct ti_port *tport = urb->context;
1191 	struct usb_serial_port *port = tport->tp_port;
1192 	struct device *dev = &urb->dev->dev;
1193 	int status = urb->status;
1194 	unsigned long flags;
1195 	int retval = 0;
1196 
1197 	switch (status) {
1198 	case 0:
1199 		break;
1200 	case -ECONNRESET:
1201 	case -ENOENT:
1202 	case -ESHUTDOWN:
1203 		dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1204 		return;
1205 	default:
1206 		dev_err(dev, "%s - nonzero urb status, %d\n",
1207 			__func__, status);
1208 	}
1209 
1210 	if (status == -EPIPE)
1211 		goto exit;
1212 
1213 	if (status) {
1214 		dev_err(dev, "%s - stopping read!\n", __func__);
1215 		return;
1216 	}
1217 
1218 	if (urb->actual_length) {
1219 		usb_serial_debug_data(dev, __func__, urb->actual_length,
1220 				      urb->transfer_buffer);
1221 
1222 		if (!tport->tp_is_open)
1223 			dev_dbg(dev, "%s - port closed, dropping data\n",
1224 				__func__);
1225 		else
1226 			ti_recv(port, urb->transfer_buffer, urb->actual_length);
1227 		spin_lock_irqsave(&tport->tp_lock, flags);
1228 		port->icount.rx += urb->actual_length;
1229 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1230 	}
1231 
1232 exit:
1233 	/* continue to read unless stopping */
1234 	spin_lock_irqsave(&tport->tp_lock, flags);
1235 	if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1236 		retval = usb_submit_urb(urb, GFP_ATOMIC);
1237 	else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1238 		tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1239 
1240 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1241 	if (retval)
1242 		dev_err(dev, "%s - resubmit read urb failed, %d\n",
1243 			__func__, retval);
1244 }
1245 
1246 
1247 static void ti_bulk_out_callback(struct urb *urb)
1248 {
1249 	struct ti_port *tport = urb->context;
1250 	struct usb_serial_port *port = tport->tp_port;
1251 	int status = urb->status;
1252 
1253 	tport->tp_write_urb_in_use = 0;
1254 
1255 	switch (status) {
1256 	case 0:
1257 		break;
1258 	case -ECONNRESET:
1259 	case -ENOENT:
1260 	case -ESHUTDOWN:
1261 		dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1262 		return;
1263 	default:
1264 		dev_err_console(port, "%s - nonzero urb status, %d\n",
1265 			__func__, status);
1266 	}
1267 
1268 	/* send any buffered data */
1269 	ti_send(tport);
1270 }
1271 
1272 
1273 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1274 		int length)
1275 {
1276 	int cnt;
1277 
1278 	do {
1279 		cnt = tty_insert_flip_string(&port->port, data, length);
1280 		if (cnt < length) {
1281 			dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1282 						__func__, length - cnt);
1283 			if (cnt == 0)
1284 				break;
1285 		}
1286 		tty_flip_buffer_push(&port->port);
1287 		data += cnt;
1288 		length -= cnt;
1289 	} while (length > 0);
1290 }
1291 
1292 
1293 static void ti_send(struct ti_port *tport)
1294 {
1295 	int count, result;
1296 	struct usb_serial_port *port = tport->tp_port;
1297 	unsigned long flags;
1298 
1299 	spin_lock_irqsave(&tport->tp_lock, flags);
1300 
1301 	if (tport->tp_write_urb_in_use)
1302 		goto unlock;
1303 
1304 	count = kfifo_out(&port->write_fifo,
1305 				port->write_urb->transfer_buffer,
1306 				port->bulk_out_size);
1307 
1308 	if (count == 0)
1309 		goto unlock;
1310 
1311 	tport->tp_write_urb_in_use = 1;
1312 
1313 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1314 
1315 	usb_serial_debug_data(&port->dev, __func__, count,
1316 			      port->write_urb->transfer_buffer);
1317 
1318 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1319 			   usb_sndbulkpipe(port->serial->dev,
1320 					    port->bulk_out_endpointAddress),
1321 			   port->write_urb->transfer_buffer, count,
1322 			   ti_bulk_out_callback, tport);
1323 
1324 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1325 	if (result) {
1326 		dev_err_console(port, "%s - submit write urb failed, %d\n",
1327 							__func__, result);
1328 		tport->tp_write_urb_in_use = 0;
1329 		/* TODO: reschedule ti_send */
1330 	} else {
1331 		spin_lock_irqsave(&tport->tp_lock, flags);
1332 		port->icount.tx += count;
1333 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1334 	}
1335 
1336 	/* more room in the buffer for new writes, wakeup */
1337 	tty_port_tty_wakeup(&port->port);
1338 
1339 	return;
1340 unlock:
1341 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1342 	return;
1343 }
1344 
1345 
1346 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1347 {
1348 	unsigned long flags;
1349 	int status;
1350 
1351 	status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1352 		tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1353 		TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1354 
1355 	spin_lock_irqsave(&tport->tp_lock, flags);
1356 	if (!status)
1357 		tport->tp_shadow_mcr = mcr;
1358 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1359 
1360 	return status;
1361 }
1362 
1363 
1364 static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1365 {
1366 	int size, status;
1367 	struct ti_device *tdev = tport->tp_tdev;
1368 	struct usb_serial_port *port = tport->tp_port;
1369 	int port_number = port->port_number;
1370 	struct ti_port_status *data;
1371 
1372 	size = sizeof(struct ti_port_status);
1373 	data = kmalloc(size, GFP_KERNEL);
1374 	if (!data)
1375 		return -ENOMEM;
1376 
1377 	status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1378 		(__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1379 	if (status) {
1380 		dev_err(&port->dev,
1381 			"%s - get port status command failed, %d\n",
1382 							__func__, status);
1383 		goto free_data;
1384 	}
1385 
1386 	dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1387 
1388 	*lsr = data->bLSR;
1389 
1390 free_data:
1391 	kfree(data);
1392 	return status;
1393 }
1394 
1395 
1396 static int ti_get_serial_info(struct tty_struct *tty,
1397 	struct serial_struct *ss)
1398 {
1399 	struct usb_serial_port *port = tty->driver_data;
1400 	struct ti_port *tport = usb_get_serial_port_data(port);
1401 	unsigned cwait;
1402 
1403 	cwait = port->port.closing_wait;
1404 	if (cwait != ASYNC_CLOSING_WAIT_NONE)
1405 		cwait = jiffies_to_msecs(cwait) / 10;
1406 
1407 	ss->type = PORT_16550A;
1408 	ss->line = port->minor;
1409 	ss->port = port->port_number;
1410 	ss->xmit_fifo_size = kfifo_size(&port->write_fifo);
1411 	ss->baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1412 	ss->closing_wait = cwait;
1413 	return 0;
1414 }
1415 
1416 
1417 static int ti_set_serial_info(struct tty_struct *tty,
1418 	struct serial_struct *ss)
1419 {
1420 	struct usb_serial_port *port = tty->driver_data;
1421 	struct ti_port *tport = usb_get_serial_port_data(port);
1422 	unsigned cwait;
1423 
1424 	cwait = ss->closing_wait;
1425 	if (cwait != ASYNC_CLOSING_WAIT_NONE)
1426 		cwait = msecs_to_jiffies(10 * ss->closing_wait);
1427 
1428 	tport->tp_port->port.closing_wait = cwait;
1429 
1430 	return 0;
1431 }
1432 
1433 
1434 static void ti_handle_new_msr(struct ti_port *tport, u8 msr)
1435 {
1436 	struct async_icount *icount;
1437 	struct tty_struct *tty;
1438 	unsigned long flags;
1439 
1440 	dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1441 
1442 	if (msr & TI_MSR_DELTA_MASK) {
1443 		spin_lock_irqsave(&tport->tp_lock, flags);
1444 		icount = &tport->tp_port->icount;
1445 		if (msr & TI_MSR_DELTA_CTS)
1446 			icount->cts++;
1447 		if (msr & TI_MSR_DELTA_DSR)
1448 			icount->dsr++;
1449 		if (msr & TI_MSR_DELTA_CD)
1450 			icount->dcd++;
1451 		if (msr & TI_MSR_DELTA_RI)
1452 			icount->rng++;
1453 		wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1454 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1455 	}
1456 
1457 	tport->tp_msr = msr & TI_MSR_MASK;
1458 
1459 	/* handle CTS flow control */
1460 	tty = tty_port_tty_get(&tport->tp_port->port);
1461 	if (tty && C_CRTSCTS(tty)) {
1462 		if (msr & TI_MSR_CTS)
1463 			tty_wakeup(tty);
1464 	}
1465 	tty_kref_put(tty);
1466 }
1467 
1468 
1469 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1470 {
1471 	unsigned long flags;
1472 
1473 	spin_lock_irqsave(&tport->tp_lock, flags);
1474 
1475 	if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1476 		tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1477 
1478 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1479 }
1480 
1481 
1482 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1483 {
1484 	struct urb *urb;
1485 	int status = 0;
1486 	unsigned long flags;
1487 
1488 	spin_lock_irqsave(&tport->tp_lock, flags);
1489 
1490 	if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1491 		tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1492 		urb = tport->tp_port->read_urb;
1493 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1494 		urb->context = tport;
1495 		status = usb_submit_urb(urb, GFP_KERNEL);
1496 	} else  {
1497 		tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1498 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1499 	}
1500 
1501 	return status;
1502 }
1503 
1504 
1505 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1506 	__u16 moduleid, __u16 value, __u8 *data, int size)
1507 {
1508 	int status;
1509 
1510 	status = usb_control_msg(tdev->td_serial->dev,
1511 		usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1512 		(USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1513 		value, moduleid, data, size, 1000);
1514 
1515 	if (status < 0)
1516 		return status;
1517 
1518 	return 0;
1519 }
1520 
1521 
1522 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1523 	__u16 moduleid, __u16 value, __u8 *data, int size)
1524 {
1525 	int status;
1526 
1527 	status = usb_control_msg(tdev->td_serial->dev,
1528 		usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1529 		(USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1530 		value, moduleid, data, size, 1000);
1531 
1532 	if (status == size)
1533 		status = 0;
1534 	else if (status >= 0)
1535 		status = -ECOMM;
1536 
1537 	return status;
1538 }
1539 
1540 
1541 static int ti_write_byte(struct usb_serial_port *port,
1542 			 struct ti_device *tdev, unsigned long addr,
1543 			 u8 mask, u8 byte)
1544 {
1545 	int status;
1546 	unsigned int size;
1547 	struct ti_write_data_bytes *data;
1548 
1549 	dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1550 		addr, mask, byte);
1551 
1552 	size = sizeof(struct ti_write_data_bytes) + 2;
1553 	data = kmalloc(size, GFP_KERNEL);
1554 	if (!data)
1555 		return -ENOMEM;
1556 
1557 	data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1558 	data->bDataType = TI_RW_DATA_BYTE;
1559 	data->bDataCounter = 1;
1560 	data->wBaseAddrHi = cpu_to_be16(addr>>16);
1561 	data->wBaseAddrLo = cpu_to_be16(addr);
1562 	data->bData[0] = mask;
1563 	data->bData[1] = byte;
1564 
1565 	status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1566 		(__u8 *)data, size);
1567 
1568 	if (status < 0)
1569 		dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1570 
1571 	kfree(data);
1572 
1573 	return status;
1574 }
1575 
1576 static int ti_do_download(struct usb_device *dev, int pipe,
1577 						u8 *buffer, int size)
1578 {
1579 	int pos;
1580 	u8 cs = 0;
1581 	int done;
1582 	struct ti_firmware_header *header;
1583 	int status = 0;
1584 	int len;
1585 
1586 	for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1587 		cs = (u8)(cs + buffer[pos]);
1588 
1589 	header = (struct ti_firmware_header *)buffer;
1590 	header->wLength = cpu_to_le16(size - sizeof(*header));
1591 	header->bCheckSum = cs;
1592 
1593 	dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1594 	for (pos = 0; pos < size; pos += done) {
1595 		len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1596 		status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1597 								&done, 1000);
1598 		if (status)
1599 			break;
1600 	}
1601 	return status;
1602 }
1603 
1604 static int ti_download_firmware(struct ti_device *tdev)
1605 {
1606 	int status;
1607 	int buffer_size;
1608 	u8 *buffer;
1609 	struct usb_device *dev = tdev->td_serial->dev;
1610 	unsigned int pipe = usb_sndbulkpipe(dev,
1611 		tdev->td_serial->port[0]->bulk_out_endpointAddress);
1612 	const struct firmware *fw_p;
1613 	char buf[32];
1614 
1615 	if (le16_to_cpu(dev->descriptor.idVendor) == MXU1_VENDOR_ID) {
1616 		snprintf(buf,
1617 			sizeof(buf),
1618 			"moxa/moxa-%04x.fw",
1619 			le16_to_cpu(dev->descriptor.idProduct));
1620 
1621 		status = request_firmware(&fw_p, buf, &dev->dev);
1622 		goto check_firmware;
1623 	}
1624 
1625 	/* try ID specific firmware first, then try generic firmware */
1626 	sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1627 			le16_to_cpu(dev->descriptor.idVendor),
1628 			le16_to_cpu(dev->descriptor.idProduct));
1629 	status = request_firmware(&fw_p, buf, &dev->dev);
1630 
1631 	if (status != 0) {
1632 		buf[0] = '\0';
1633 		if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1634 			switch (le16_to_cpu(dev->descriptor.idProduct)) {
1635 			case MTS_CDMA_PRODUCT_ID:
1636 				strcpy(buf, "mts_cdma.fw");
1637 				break;
1638 			case MTS_GSM_PRODUCT_ID:
1639 				strcpy(buf, "mts_gsm.fw");
1640 				break;
1641 			case MTS_EDGE_PRODUCT_ID:
1642 				strcpy(buf, "mts_edge.fw");
1643 				break;
1644 			case MTS_MT9234MU_PRODUCT_ID:
1645 				strcpy(buf, "mts_mt9234mu.fw");
1646 				break;
1647 			case MTS_MT9234ZBA_PRODUCT_ID:
1648 				strcpy(buf, "mts_mt9234zba.fw");
1649 				break;
1650 			case MTS_MT9234ZBAOLD_PRODUCT_ID:
1651 				strcpy(buf, "mts_mt9234zba.fw");
1652 				break;			}
1653 		}
1654 		if (buf[0] == '\0') {
1655 			if (tdev->td_is_3410)
1656 				strcpy(buf, "ti_3410.fw");
1657 			else
1658 				strcpy(buf, "ti_5052.fw");
1659 		}
1660 		status = request_firmware(&fw_p, buf, &dev->dev);
1661 	}
1662 
1663 check_firmware:
1664 	if (status) {
1665 		dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1666 		return -ENOENT;
1667 	}
1668 	if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1669 		dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1670 		release_firmware(fw_p);
1671 		return -ENOENT;
1672 	}
1673 
1674 	buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1675 	buffer = kmalloc(buffer_size, GFP_KERNEL);
1676 	if (buffer) {
1677 		memcpy(buffer, fw_p->data, fw_p->size);
1678 		memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1679 		status = ti_do_download(dev, pipe, buffer, fw_p->size);
1680 		kfree(buffer);
1681 	} else {
1682 		status = -ENOMEM;
1683 	}
1684 	release_firmware(fw_p);
1685 	if (status) {
1686 		dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1687 							__func__, status);
1688 		return status;
1689 	}
1690 
1691 	dev_dbg(&dev->dev, "%s - download successful\n", __func__);
1692 
1693 	return 0;
1694 }
1695