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