xref: /linux/drivers/usb/serial/ti_usb_3410_5052.c (revision e9f0878c4b2004ac19581274c1ae4c61ae3ca70e)
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[0];
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[0];
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 int 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 int ti_ioctl(struct tty_struct *tty,
317 		unsigned int cmd, unsigned long arg);
318 static void ti_set_termios(struct tty_struct *tty,
319 		struct usb_serial_port *port, struct ktermios *old_termios);
320 static int ti_tiocmget(struct tty_struct *tty);
321 static int ti_tiocmset(struct tty_struct *tty,
322 		unsigned int set, unsigned int clear);
323 static void ti_break(struct tty_struct *tty, int break_state);
324 static void ti_interrupt_callback(struct urb *urb);
325 static void ti_bulk_in_callback(struct urb *urb);
326 static void ti_bulk_out_callback(struct urb *urb);
327 
328 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
329 		int length);
330 static void ti_send(struct ti_port *tport);
331 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr);
332 static int ti_get_lsr(struct ti_port *tport, u8 *lsr);
333 static int ti_get_serial_info(struct ti_port *tport,
334 	struct serial_struct __user *ret_arg);
335 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
336 	struct serial_struct __user *new_arg);
337 static void ti_handle_new_msr(struct ti_port *tport, u8 msr);
338 
339 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty);
340 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty);
341 
342 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
343 	__u16 moduleid, __u16 value, __u8 *data, int size);
344 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
345 	__u16 moduleid, __u16 value, __u8 *data, int size);
346 
347 static int ti_write_byte(struct usb_serial_port *port, struct ti_device *tdev,
348 			 unsigned long addr, u8 mask, u8 byte);
349 
350 static int ti_download_firmware(struct ti_device *tdev);
351 
352 static int closing_wait = TI_DEFAULT_CLOSING_WAIT;
353 
354 static const struct usb_device_id ti_id_table_3410[] = {
355 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
356 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
357 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
358 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
359 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
360 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
361 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
362 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
363 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
364 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
365 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
366 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
367 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
368 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STEREO_PLUG_ID) },
369 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
370 	{ USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
371 	{ USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
372 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
373 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
374 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
375 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
376 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
377 	{ }	/* terminator */
378 };
379 
380 static const struct usb_device_id ti_id_table_5052[] = {
381 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
382 	{ USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
383 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
384 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
385 	{ }
386 };
387 
388 static const struct usb_device_id ti_id_table_combined[] = {
389 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
390 	{ USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
391 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
392 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
393 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
394 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
395 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
396 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
397 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
398 	{ USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
399 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
400 	{ USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
401 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
402 	{ USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
403 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
404 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
405 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
406 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_PRODUCT_ID) },
407 	{ USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
408 	{ USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
409 	{ USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
410 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
411 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
412 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
413 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
414 	{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
415 	{ }	/* terminator */
416 };
417 
418 static struct usb_serial_driver ti_1port_device = {
419 	.driver = {
420 		.owner		= THIS_MODULE,
421 		.name		= "ti_usb_3410_5052_1",
422 	},
423 	.description		= "TI USB 3410 1 port adapter",
424 	.id_table		= ti_id_table_3410,
425 	.num_ports		= 1,
426 	.num_bulk_out		= 1,
427 	.attach			= ti_startup,
428 	.release		= ti_release,
429 	.port_probe		= ti_port_probe,
430 	.port_remove		= ti_port_remove,
431 	.open			= ti_open,
432 	.close			= ti_close,
433 	.write			= ti_write,
434 	.write_room		= ti_write_room,
435 	.chars_in_buffer	= ti_chars_in_buffer,
436 	.tx_empty		= ti_tx_empty,
437 	.throttle		= ti_throttle,
438 	.unthrottle		= ti_unthrottle,
439 	.ioctl			= ti_ioctl,
440 	.set_termios		= ti_set_termios,
441 	.tiocmget		= ti_tiocmget,
442 	.tiocmset		= ti_tiocmset,
443 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
444 	.get_icount		= usb_serial_generic_get_icount,
445 	.break_ctl		= ti_break,
446 	.read_int_callback	= ti_interrupt_callback,
447 	.read_bulk_callback	= ti_bulk_in_callback,
448 	.write_bulk_callback	= ti_bulk_out_callback,
449 };
450 
451 static struct usb_serial_driver ti_2port_device = {
452 	.driver = {
453 		.owner		= THIS_MODULE,
454 		.name		= "ti_usb_3410_5052_2",
455 	},
456 	.description		= "TI USB 5052 2 port adapter",
457 	.id_table		= ti_id_table_5052,
458 	.num_ports		= 2,
459 	.num_bulk_out		= 1,
460 	.attach			= ti_startup,
461 	.release		= ti_release,
462 	.port_probe		= ti_port_probe,
463 	.port_remove		= ti_port_remove,
464 	.open			= ti_open,
465 	.close			= ti_close,
466 	.write			= ti_write,
467 	.write_room		= ti_write_room,
468 	.chars_in_buffer	= ti_chars_in_buffer,
469 	.tx_empty		= ti_tx_empty,
470 	.throttle		= ti_throttle,
471 	.unthrottle		= ti_unthrottle,
472 	.ioctl			= ti_ioctl,
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 int 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 	return 0;
640 }
641 
642 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
643 {
644 	struct ti_port *tport = usb_get_serial_port_data(port);
645 	struct ti_device *tdev;
646 	struct usb_device *dev;
647 	struct urb *urb;
648 	int port_number;
649 	int status;
650 	u16 open_settings;
651 
652 	open_settings = (TI_PIPE_MODE_CONTINUOUS |
653 			 TI_PIPE_TIMEOUT_ENABLE |
654 			 (TI_TRANSFER_TIMEOUT << 2));
655 
656 	dev = port->serial->dev;
657 	tdev = tport->tp_tdev;
658 
659 	/* only one open on any port on a device at a time */
660 	if (mutex_lock_interruptible(&tdev->td_open_close_lock))
661 		return -ERESTARTSYS;
662 
663 	port_number = port->port_number;
664 
665 	tport->tp_msr = 0;
666 	tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
667 
668 	/* start interrupt urb the first time a port is opened on this device */
669 	if (tdev->td_open_port_count == 0) {
670 		dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
671 		urb = tdev->td_serial->port[0]->interrupt_in_urb;
672 		if (!urb) {
673 			dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
674 			status = -EINVAL;
675 			goto release_lock;
676 		}
677 		urb->context = tdev;
678 		status = usb_submit_urb(urb, GFP_KERNEL);
679 		if (status) {
680 			dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
681 			goto release_lock;
682 		}
683 	}
684 
685 	if (tty)
686 		ti_set_termios(tty, port, &tty->termios);
687 
688 	status = ti_command_out_sync(tdev, TI_OPEN_PORT,
689 		(__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
690 	if (status) {
691 		dev_err(&port->dev, "%s - cannot send open command, %d\n",
692 			__func__, status);
693 		goto unlink_int_urb;
694 	}
695 
696 	status = ti_command_out_sync(tdev, TI_START_PORT,
697 		(__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
698 	if (status) {
699 		dev_err(&port->dev, "%s - cannot send start command, %d\n",
700 							__func__, status);
701 		goto unlink_int_urb;
702 	}
703 
704 	status = ti_command_out_sync(tdev, TI_PURGE_PORT,
705 		(__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
706 	if (status) {
707 		dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
708 							__func__, status);
709 		goto unlink_int_urb;
710 	}
711 	status = ti_command_out_sync(tdev, TI_PURGE_PORT,
712 		(__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
713 	if (status) {
714 		dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
715 							__func__, status);
716 		goto unlink_int_urb;
717 	}
718 
719 	/* reset the data toggle on the bulk endpoints to work around bug in
720 	 * host controllers where things get out of sync some times */
721 	usb_clear_halt(dev, port->write_urb->pipe);
722 	usb_clear_halt(dev, port->read_urb->pipe);
723 
724 	if (tty)
725 		ti_set_termios(tty, port, &tty->termios);
726 
727 	status = ti_command_out_sync(tdev, TI_OPEN_PORT,
728 		(__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
729 	if (status) {
730 		dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
731 							__func__, status);
732 		goto unlink_int_urb;
733 	}
734 
735 	status = ti_command_out_sync(tdev, TI_START_PORT,
736 		(__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
737 	if (status) {
738 		dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
739 							__func__, status);
740 		goto unlink_int_urb;
741 	}
742 
743 	/* start read urb */
744 	urb = port->read_urb;
745 	if (!urb) {
746 		dev_err(&port->dev, "%s - no read urb\n", __func__);
747 		status = -EINVAL;
748 		goto unlink_int_urb;
749 	}
750 	tport->tp_read_urb_state = TI_READ_URB_RUNNING;
751 	urb->context = tport;
752 	status = usb_submit_urb(urb, GFP_KERNEL);
753 	if (status) {
754 		dev_err(&port->dev, "%s - submit read urb failed, %d\n",
755 							__func__, status);
756 		goto unlink_int_urb;
757 	}
758 
759 	tport->tp_is_open = 1;
760 	++tdev->td_open_port_count;
761 
762 	goto release_lock;
763 
764 unlink_int_urb:
765 	if (tdev->td_open_port_count == 0)
766 		usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
767 release_lock:
768 	mutex_unlock(&tdev->td_open_close_lock);
769 	return status;
770 }
771 
772 
773 static void ti_close(struct usb_serial_port *port)
774 {
775 	struct ti_device *tdev;
776 	struct ti_port *tport;
777 	int port_number;
778 	int status;
779 	int do_unlock;
780 	unsigned long flags;
781 
782 	tdev = usb_get_serial_data(port->serial);
783 	tport = usb_get_serial_port_data(port);
784 
785 	tport->tp_is_open = 0;
786 
787 	usb_kill_urb(port->read_urb);
788 	usb_kill_urb(port->write_urb);
789 	tport->tp_write_urb_in_use = 0;
790 	spin_lock_irqsave(&tport->tp_lock, flags);
791 	kfifo_reset_out(&port->write_fifo);
792 	spin_unlock_irqrestore(&tport->tp_lock, flags);
793 
794 	port_number = port->port_number;
795 
796 	status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
797 		     (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
798 	if (status)
799 		dev_err(&port->dev,
800 			"%s - cannot send close port command, %d\n"
801 							, __func__, status);
802 
803 	/* if mutex_lock is interrupted, continue anyway */
804 	do_unlock = !mutex_lock_interruptible(&tdev->td_open_close_lock);
805 	--tport->tp_tdev->td_open_port_count;
806 	if (tport->tp_tdev->td_open_port_count <= 0) {
807 		/* last port is closed, shut down interrupt urb */
808 		usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
809 		tport->tp_tdev->td_open_port_count = 0;
810 	}
811 	if (do_unlock)
812 		mutex_unlock(&tdev->td_open_close_lock);
813 }
814 
815 
816 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
817 			const unsigned char *data, int count)
818 {
819 	struct ti_port *tport = usb_get_serial_port_data(port);
820 
821 	if (count == 0) {
822 		return 0;
823 	}
824 
825 	if (!tport->tp_is_open)
826 		return -ENODEV;
827 
828 	count = kfifo_in_locked(&port->write_fifo, data, count,
829 							&tport->tp_lock);
830 	ti_send(tport);
831 
832 	return count;
833 }
834 
835 
836 static int ti_write_room(struct tty_struct *tty)
837 {
838 	struct usb_serial_port *port = tty->driver_data;
839 	struct ti_port *tport = usb_get_serial_port_data(port);
840 	int room = 0;
841 	unsigned long flags;
842 
843 	spin_lock_irqsave(&tport->tp_lock, flags);
844 	room = kfifo_avail(&port->write_fifo);
845 	spin_unlock_irqrestore(&tport->tp_lock, flags);
846 
847 	dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
848 	return room;
849 }
850 
851 
852 static int ti_chars_in_buffer(struct tty_struct *tty)
853 {
854 	struct usb_serial_port *port = tty->driver_data;
855 	struct ti_port *tport = usb_get_serial_port_data(port);
856 	int chars = 0;
857 	unsigned long flags;
858 
859 	spin_lock_irqsave(&tport->tp_lock, flags);
860 	chars = kfifo_len(&port->write_fifo);
861 	spin_unlock_irqrestore(&tport->tp_lock, flags);
862 
863 	dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
864 	return chars;
865 }
866 
867 static bool ti_tx_empty(struct usb_serial_port *port)
868 {
869 	struct ti_port *tport = usb_get_serial_port_data(port);
870 	int ret;
871 	u8 lsr;
872 
873 	ret = ti_get_lsr(tport, &lsr);
874 	if (!ret && !(lsr & TI_LSR_TX_EMPTY))
875 		return false;
876 
877 	return true;
878 }
879 
880 static void ti_throttle(struct tty_struct *tty)
881 {
882 	struct usb_serial_port *port = tty->driver_data;
883 	struct ti_port *tport = usb_get_serial_port_data(port);
884 
885 	if (I_IXOFF(tty) || C_CRTSCTS(tty))
886 		ti_stop_read(tport, tty);
887 
888 }
889 
890 
891 static void ti_unthrottle(struct tty_struct *tty)
892 {
893 	struct usb_serial_port *port = tty->driver_data;
894 	struct ti_port *tport = usb_get_serial_port_data(port);
895 	int status;
896 
897 	if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
898 		status = ti_restart_read(tport, tty);
899 		if (status)
900 			dev_err(&port->dev, "%s - cannot restart read, %d\n",
901 							__func__, status);
902 	}
903 }
904 
905 static int ti_ioctl(struct tty_struct *tty,
906 	unsigned int cmd, unsigned long arg)
907 {
908 	struct usb_serial_port *port = tty->driver_data;
909 	struct ti_port *tport = usb_get_serial_port_data(port);
910 
911 	switch (cmd) {
912 	case TIOCGSERIAL:
913 		return ti_get_serial_info(tport,
914 				(struct serial_struct __user *)arg);
915 	case TIOCSSERIAL:
916 		return ti_set_serial_info(tty, tport,
917 				(struct serial_struct __user *)arg);
918 	}
919 	return -ENOIOCTLCMD;
920 }
921 
922 
923 static void ti_set_termios(struct tty_struct *tty,
924 		struct usb_serial_port *port, struct ktermios *old_termios)
925 {
926 	struct ti_port *tport = usb_get_serial_port_data(port);
927 	struct ti_uart_config *config;
928 	int baud;
929 	int status;
930 	int port_number = port->port_number;
931 	unsigned int mcr;
932 	u16 wbaudrate;
933 	u16 wflags = 0;
934 
935 	config = kmalloc(sizeof(*config), GFP_KERNEL);
936 	if (!config)
937 		return;
938 
939 	/* these flags must be set */
940 	wflags |= TI_UART_ENABLE_MS_INTS;
941 	wflags |= TI_UART_ENABLE_AUTO_START_DMA;
942 	config->bUartMode = tport->tp_uart_mode;
943 
944 	switch (C_CSIZE(tty)) {
945 	case CS5:
946 		    config->bDataBits = TI_UART_5_DATA_BITS;
947 		    break;
948 	case CS6:
949 		    config->bDataBits = TI_UART_6_DATA_BITS;
950 		    break;
951 	case CS7:
952 		    config->bDataBits = TI_UART_7_DATA_BITS;
953 		    break;
954 	default:
955 	case CS8:
956 		    config->bDataBits = TI_UART_8_DATA_BITS;
957 		    break;
958 	}
959 
960 	/* CMSPAR isn't supported by this driver */
961 	tty->termios.c_cflag &= ~CMSPAR;
962 
963 	if (C_PARENB(tty)) {
964 		if (C_PARODD(tty)) {
965 			wflags |= TI_UART_ENABLE_PARITY_CHECKING;
966 			config->bParity = TI_UART_ODD_PARITY;
967 		} else {
968 			wflags |= TI_UART_ENABLE_PARITY_CHECKING;
969 			config->bParity = TI_UART_EVEN_PARITY;
970 		}
971 	} else {
972 		wflags &= ~TI_UART_ENABLE_PARITY_CHECKING;
973 		config->bParity = TI_UART_NO_PARITY;
974 	}
975 
976 	if (C_CSTOPB(tty))
977 		config->bStopBits = TI_UART_2_STOP_BITS;
978 	else
979 		config->bStopBits = TI_UART_1_STOP_BITS;
980 
981 	if (C_CRTSCTS(tty)) {
982 		/* RTS flow control must be off to drop RTS for baud rate B0 */
983 		if ((C_BAUD(tty)) != B0)
984 			wflags |= TI_UART_ENABLE_RTS_IN;
985 		wflags |= TI_UART_ENABLE_CTS_OUT;
986 	} else {
987 		ti_restart_read(tport, tty);
988 	}
989 
990 	if (I_IXOFF(tty) || I_IXON(tty)) {
991 		config->cXon  = START_CHAR(tty);
992 		config->cXoff = STOP_CHAR(tty);
993 
994 		if (I_IXOFF(tty))
995 			wflags |= TI_UART_ENABLE_X_IN;
996 		else
997 			ti_restart_read(tport, tty);
998 
999 		if (I_IXON(tty))
1000 			wflags |= TI_UART_ENABLE_X_OUT;
1001 	}
1002 
1003 	baud = tty_get_baud_rate(tty);
1004 	if (!baud)
1005 		baud = 9600;
1006 	if (tport->tp_tdev->td_is_3410)
1007 		wbaudrate = (923077 + baud/2) / baud;
1008 	else
1009 		wbaudrate = (461538 + baud/2) / baud;
1010 
1011 	/* FIXME: Should calculate resulting baud here and report it back */
1012 	if ((C_BAUD(tty)) != B0)
1013 		tty_encode_baud_rate(tty, baud, baud);
1014 
1015 	dev_dbg(&port->dev,
1016 		"%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d\n",
1017 		__func__, baud, wbaudrate, wflags,
1018 		config->bDataBits, config->bParity, config->bStopBits,
1019 		config->cXon, config->cXoff, config->bUartMode);
1020 
1021 	config->wBaudRate = cpu_to_be16(wbaudrate);
1022 	config->wFlags = cpu_to_be16(wflags);
1023 
1024 	status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
1025 		(__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
1026 		sizeof(*config));
1027 	if (status)
1028 		dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
1029 					__func__, port_number, status);
1030 
1031 	/* SET_CONFIG asserts RTS and DTR, reset them correctly */
1032 	mcr = tport->tp_shadow_mcr;
1033 	/* if baud rate is B0, clear RTS and DTR */
1034 	if (C_BAUD(tty) == B0)
1035 		mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
1036 	status = ti_set_mcr(tport, mcr);
1037 	if (status)
1038 		dev_err(&port->dev,
1039 			"%s - cannot set modem control on port %d, %d\n",
1040 						__func__, port_number, status);
1041 
1042 	kfree(config);
1043 }
1044 
1045 
1046 static int ti_tiocmget(struct tty_struct *tty)
1047 {
1048 	struct usb_serial_port *port = tty->driver_data;
1049 	struct ti_port *tport = usb_get_serial_port_data(port);
1050 	unsigned int result;
1051 	unsigned int msr;
1052 	unsigned int mcr;
1053 	unsigned long flags;
1054 
1055 	spin_lock_irqsave(&tport->tp_lock, flags);
1056 	msr = tport->tp_msr;
1057 	mcr = tport->tp_shadow_mcr;
1058 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1059 
1060 	result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
1061 		| ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
1062 		| ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
1063 		| ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
1064 		| ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
1065 		| ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
1066 		| ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
1067 
1068 	dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
1069 
1070 	return result;
1071 }
1072 
1073 
1074 static int ti_tiocmset(struct tty_struct *tty,
1075 				unsigned int set, unsigned int clear)
1076 {
1077 	struct usb_serial_port *port = tty->driver_data;
1078 	struct ti_port *tport = usb_get_serial_port_data(port);
1079 	unsigned int mcr;
1080 	unsigned long flags;
1081 
1082 	spin_lock_irqsave(&tport->tp_lock, flags);
1083 	mcr = tport->tp_shadow_mcr;
1084 
1085 	if (set & TIOCM_RTS)
1086 		mcr |= TI_MCR_RTS;
1087 	if (set & TIOCM_DTR)
1088 		mcr |= TI_MCR_DTR;
1089 	if (set & TIOCM_LOOP)
1090 		mcr |= TI_MCR_LOOP;
1091 
1092 	if (clear & TIOCM_RTS)
1093 		mcr &= ~TI_MCR_RTS;
1094 	if (clear & TIOCM_DTR)
1095 		mcr &= ~TI_MCR_DTR;
1096 	if (clear & TIOCM_LOOP)
1097 		mcr &= ~TI_MCR_LOOP;
1098 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1099 
1100 	return ti_set_mcr(tport, mcr);
1101 }
1102 
1103 
1104 static void ti_break(struct tty_struct *tty, int break_state)
1105 {
1106 	struct usb_serial_port *port = tty->driver_data;
1107 	struct ti_port *tport = usb_get_serial_port_data(port);
1108 	int status;
1109 
1110 	dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
1111 
1112 	status = ti_write_byte(port, tport->tp_tdev,
1113 		tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
1114 		TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
1115 
1116 	if (status)
1117 		dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
1118 }
1119 
1120 static int ti_get_port_from_code(unsigned char code)
1121 {
1122 	return (code >> 4) - 3;
1123 }
1124 
1125 static int ti_get_func_from_code(unsigned char code)
1126 {
1127 	return code & 0x0f;
1128 }
1129 
1130 static void ti_interrupt_callback(struct urb *urb)
1131 {
1132 	struct ti_device *tdev = urb->context;
1133 	struct usb_serial_port *port;
1134 	struct usb_serial *serial = tdev->td_serial;
1135 	struct ti_port *tport;
1136 	struct device *dev = &urb->dev->dev;
1137 	unsigned char *data = urb->transfer_buffer;
1138 	int length = urb->actual_length;
1139 	int port_number;
1140 	int function;
1141 	int status = urb->status;
1142 	int retval;
1143 	u8 msr;
1144 
1145 	switch (status) {
1146 	case 0:
1147 		break;
1148 	case -ECONNRESET:
1149 	case -ENOENT:
1150 	case -ESHUTDOWN:
1151 		dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1152 		return;
1153 	default:
1154 		dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
1155 		goto exit;
1156 	}
1157 
1158 	if (length != 2) {
1159 		dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
1160 		goto exit;
1161 	}
1162 
1163 	if (data[0] == TI_CODE_HARDWARE_ERROR) {
1164 		dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
1165 		goto exit;
1166 	}
1167 
1168 	port_number = ti_get_port_from_code(data[0]);
1169 	function = ti_get_func_from_code(data[0]);
1170 
1171 	dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
1172 		__func__, port_number, function, data[1]);
1173 
1174 	if (port_number >= serial->num_ports) {
1175 		dev_err(dev, "%s - bad port number, %d\n",
1176 						__func__, port_number);
1177 		goto exit;
1178 	}
1179 
1180 	port = serial->port[port_number];
1181 
1182 	tport = usb_get_serial_port_data(port);
1183 	if (!tport)
1184 		goto exit;
1185 
1186 	switch (function) {
1187 	case TI_CODE_DATA_ERROR:
1188 		dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
1189 			__func__, port_number, data[1]);
1190 		break;
1191 
1192 	case TI_CODE_MODEM_STATUS:
1193 		msr = data[1];
1194 		dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
1195 		ti_handle_new_msr(tport, msr);
1196 		break;
1197 
1198 	default:
1199 		dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
1200 							__func__, data[1]);
1201 		break;
1202 	}
1203 
1204 exit:
1205 	retval = usb_submit_urb(urb, GFP_ATOMIC);
1206 	if (retval)
1207 		dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1208 			__func__, retval);
1209 }
1210 
1211 
1212 static void ti_bulk_in_callback(struct urb *urb)
1213 {
1214 	struct ti_port *tport = urb->context;
1215 	struct usb_serial_port *port = tport->tp_port;
1216 	struct device *dev = &urb->dev->dev;
1217 	int status = urb->status;
1218 	unsigned long flags;
1219 	int retval = 0;
1220 
1221 	switch (status) {
1222 	case 0:
1223 		break;
1224 	case -ECONNRESET:
1225 	case -ENOENT:
1226 	case -ESHUTDOWN:
1227 		dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1228 		return;
1229 	default:
1230 		dev_err(dev, "%s - nonzero urb status, %d\n",
1231 			__func__, status);
1232 	}
1233 
1234 	if (status == -EPIPE)
1235 		goto exit;
1236 
1237 	if (status) {
1238 		dev_err(dev, "%s - stopping read!\n", __func__);
1239 		return;
1240 	}
1241 
1242 	if (urb->actual_length) {
1243 		usb_serial_debug_data(dev, __func__, urb->actual_length,
1244 				      urb->transfer_buffer);
1245 
1246 		if (!tport->tp_is_open)
1247 			dev_dbg(dev, "%s - port closed, dropping data\n",
1248 				__func__);
1249 		else
1250 			ti_recv(port, urb->transfer_buffer, urb->actual_length);
1251 		spin_lock_irqsave(&tport->tp_lock, flags);
1252 		port->icount.rx += urb->actual_length;
1253 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1254 	}
1255 
1256 exit:
1257 	/* continue to read unless stopping */
1258 	spin_lock_irqsave(&tport->tp_lock, flags);
1259 	if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1260 		retval = usb_submit_urb(urb, GFP_ATOMIC);
1261 	else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1262 		tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1263 
1264 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1265 	if (retval)
1266 		dev_err(dev, "%s - resubmit read urb failed, %d\n",
1267 			__func__, retval);
1268 }
1269 
1270 
1271 static void ti_bulk_out_callback(struct urb *urb)
1272 {
1273 	struct ti_port *tport = urb->context;
1274 	struct usb_serial_port *port = tport->tp_port;
1275 	int status = urb->status;
1276 
1277 	tport->tp_write_urb_in_use = 0;
1278 
1279 	switch (status) {
1280 	case 0:
1281 		break;
1282 	case -ECONNRESET:
1283 	case -ENOENT:
1284 	case -ESHUTDOWN:
1285 		dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1286 		return;
1287 	default:
1288 		dev_err_console(port, "%s - nonzero urb status, %d\n",
1289 			__func__, status);
1290 	}
1291 
1292 	/* send any buffered data */
1293 	ti_send(tport);
1294 }
1295 
1296 
1297 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1298 		int length)
1299 {
1300 	int cnt;
1301 
1302 	do {
1303 		cnt = tty_insert_flip_string(&port->port, data, length);
1304 		if (cnt < length) {
1305 			dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1306 						__func__, length - cnt);
1307 			if (cnt == 0)
1308 				break;
1309 		}
1310 		tty_flip_buffer_push(&port->port);
1311 		data += cnt;
1312 		length -= cnt;
1313 	} while (length > 0);
1314 }
1315 
1316 
1317 static void ti_send(struct ti_port *tport)
1318 {
1319 	int count, result;
1320 	struct usb_serial_port *port = tport->tp_port;
1321 	unsigned long flags;
1322 
1323 	spin_lock_irqsave(&tport->tp_lock, flags);
1324 
1325 	if (tport->tp_write_urb_in_use)
1326 		goto unlock;
1327 
1328 	count = kfifo_out(&port->write_fifo,
1329 				port->write_urb->transfer_buffer,
1330 				port->bulk_out_size);
1331 
1332 	if (count == 0)
1333 		goto unlock;
1334 
1335 	tport->tp_write_urb_in_use = 1;
1336 
1337 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1338 
1339 	usb_serial_debug_data(&port->dev, __func__, count,
1340 			      port->write_urb->transfer_buffer);
1341 
1342 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1343 			   usb_sndbulkpipe(port->serial->dev,
1344 					    port->bulk_out_endpointAddress),
1345 			   port->write_urb->transfer_buffer, count,
1346 			   ti_bulk_out_callback, tport);
1347 
1348 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1349 	if (result) {
1350 		dev_err_console(port, "%s - submit write urb failed, %d\n",
1351 							__func__, result);
1352 		tport->tp_write_urb_in_use = 0;
1353 		/* TODO: reschedule ti_send */
1354 	} else {
1355 		spin_lock_irqsave(&tport->tp_lock, flags);
1356 		port->icount.tx += count;
1357 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1358 	}
1359 
1360 	/* more room in the buffer for new writes, wakeup */
1361 	tty_port_tty_wakeup(&port->port);
1362 
1363 	return;
1364 unlock:
1365 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1366 	return;
1367 }
1368 
1369 
1370 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1371 {
1372 	unsigned long flags;
1373 	int status;
1374 
1375 	status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1376 		tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1377 		TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1378 
1379 	spin_lock_irqsave(&tport->tp_lock, flags);
1380 	if (!status)
1381 		tport->tp_shadow_mcr = mcr;
1382 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1383 
1384 	return status;
1385 }
1386 
1387 
1388 static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1389 {
1390 	int size, status;
1391 	struct ti_device *tdev = tport->tp_tdev;
1392 	struct usb_serial_port *port = tport->tp_port;
1393 	int port_number = port->port_number;
1394 	struct ti_port_status *data;
1395 
1396 	size = sizeof(struct ti_port_status);
1397 	data = kmalloc(size, GFP_KERNEL);
1398 	if (!data)
1399 		return -ENOMEM;
1400 
1401 	status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1402 		(__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1403 	if (status) {
1404 		dev_err(&port->dev,
1405 			"%s - get port status command failed, %d\n",
1406 							__func__, status);
1407 		goto free_data;
1408 	}
1409 
1410 	dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1411 
1412 	*lsr = data->bLSR;
1413 
1414 free_data:
1415 	kfree(data);
1416 	return status;
1417 }
1418 
1419 
1420 static int ti_get_serial_info(struct ti_port *tport,
1421 	struct serial_struct __user *ret_arg)
1422 {
1423 	struct usb_serial_port *port = tport->tp_port;
1424 	struct serial_struct ret_serial;
1425 	unsigned cwait;
1426 
1427 	cwait = port->port.closing_wait;
1428 	if (cwait != ASYNC_CLOSING_WAIT_NONE)
1429 		cwait = jiffies_to_msecs(cwait) / 10;
1430 
1431 	memset(&ret_serial, 0, sizeof(ret_serial));
1432 
1433 	ret_serial.type = PORT_16550A;
1434 	ret_serial.line = port->minor;
1435 	ret_serial.port = port->port_number;
1436 	ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1437 	ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1438 	ret_serial.closing_wait = cwait;
1439 
1440 	if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1441 		return -EFAULT;
1442 
1443 	return 0;
1444 }
1445 
1446 
1447 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1448 	struct serial_struct __user *new_arg)
1449 {
1450 	struct serial_struct new_serial;
1451 	unsigned cwait;
1452 
1453 	if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1454 		return -EFAULT;
1455 
1456 	cwait = new_serial.closing_wait;
1457 	if (cwait != ASYNC_CLOSING_WAIT_NONE)
1458 		cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1459 
1460 	tport->tp_port->port.closing_wait = cwait;
1461 
1462 	return 0;
1463 }
1464 
1465 
1466 static void ti_handle_new_msr(struct ti_port *tport, u8 msr)
1467 {
1468 	struct async_icount *icount;
1469 	struct tty_struct *tty;
1470 	unsigned long flags;
1471 
1472 	dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1473 
1474 	if (msr & TI_MSR_DELTA_MASK) {
1475 		spin_lock_irqsave(&tport->tp_lock, flags);
1476 		icount = &tport->tp_port->icount;
1477 		if (msr & TI_MSR_DELTA_CTS)
1478 			icount->cts++;
1479 		if (msr & TI_MSR_DELTA_DSR)
1480 			icount->dsr++;
1481 		if (msr & TI_MSR_DELTA_CD)
1482 			icount->dcd++;
1483 		if (msr & TI_MSR_DELTA_RI)
1484 			icount->rng++;
1485 		wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1486 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1487 	}
1488 
1489 	tport->tp_msr = msr & TI_MSR_MASK;
1490 
1491 	/* handle CTS flow control */
1492 	tty = tty_port_tty_get(&tport->tp_port->port);
1493 	if (tty && C_CRTSCTS(tty)) {
1494 		if (msr & TI_MSR_CTS)
1495 			tty_wakeup(tty);
1496 	}
1497 	tty_kref_put(tty);
1498 }
1499 
1500 
1501 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1502 {
1503 	unsigned long flags;
1504 
1505 	spin_lock_irqsave(&tport->tp_lock, flags);
1506 
1507 	if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1508 		tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1509 
1510 	spin_unlock_irqrestore(&tport->tp_lock, flags);
1511 }
1512 
1513 
1514 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1515 {
1516 	struct urb *urb;
1517 	int status = 0;
1518 	unsigned long flags;
1519 
1520 	spin_lock_irqsave(&tport->tp_lock, flags);
1521 
1522 	if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1523 		tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1524 		urb = tport->tp_port->read_urb;
1525 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1526 		urb->context = tport;
1527 		status = usb_submit_urb(urb, GFP_KERNEL);
1528 	} else  {
1529 		tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1530 		spin_unlock_irqrestore(&tport->tp_lock, flags);
1531 	}
1532 
1533 	return status;
1534 }
1535 
1536 
1537 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1538 	__u16 moduleid, __u16 value, __u8 *data, int size)
1539 {
1540 	int status;
1541 
1542 	status = usb_control_msg(tdev->td_serial->dev,
1543 		usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1544 		(USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1545 		value, moduleid, data, size, 1000);
1546 
1547 	if (status < 0)
1548 		return status;
1549 
1550 	return 0;
1551 }
1552 
1553 
1554 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1555 	__u16 moduleid, __u16 value, __u8 *data, int size)
1556 {
1557 	int status;
1558 
1559 	status = usb_control_msg(tdev->td_serial->dev,
1560 		usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1561 		(USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1562 		value, moduleid, data, size, 1000);
1563 
1564 	if (status == size)
1565 		status = 0;
1566 	else if (status >= 0)
1567 		status = -ECOMM;
1568 
1569 	return status;
1570 }
1571 
1572 
1573 static int ti_write_byte(struct usb_serial_port *port,
1574 			 struct ti_device *tdev, unsigned long addr,
1575 			 u8 mask, u8 byte)
1576 {
1577 	int status;
1578 	unsigned int size;
1579 	struct ti_write_data_bytes *data;
1580 
1581 	dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1582 		addr, mask, byte);
1583 
1584 	size = sizeof(struct ti_write_data_bytes) + 2;
1585 	data = kmalloc(size, GFP_KERNEL);
1586 	if (!data)
1587 		return -ENOMEM;
1588 
1589 	data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1590 	data->bDataType = TI_RW_DATA_BYTE;
1591 	data->bDataCounter = 1;
1592 	data->wBaseAddrHi = cpu_to_be16(addr>>16);
1593 	data->wBaseAddrLo = cpu_to_be16(addr);
1594 	data->bData[0] = mask;
1595 	data->bData[1] = byte;
1596 
1597 	status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1598 		(__u8 *)data, size);
1599 
1600 	if (status < 0)
1601 		dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1602 
1603 	kfree(data);
1604 
1605 	return status;
1606 }
1607 
1608 static int ti_do_download(struct usb_device *dev, int pipe,
1609 						u8 *buffer, int size)
1610 {
1611 	int pos;
1612 	u8 cs = 0;
1613 	int done;
1614 	struct ti_firmware_header *header;
1615 	int status = 0;
1616 	int len;
1617 
1618 	for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1619 		cs = (u8)(cs + buffer[pos]);
1620 
1621 	header = (struct ti_firmware_header *)buffer;
1622 	header->wLength = cpu_to_le16(size - sizeof(*header));
1623 	header->bCheckSum = cs;
1624 
1625 	dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1626 	for (pos = 0; pos < size; pos += done) {
1627 		len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1628 		status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1629 								&done, 1000);
1630 		if (status)
1631 			break;
1632 	}
1633 	return status;
1634 }
1635 
1636 static int ti_download_firmware(struct ti_device *tdev)
1637 {
1638 	int status;
1639 	int buffer_size;
1640 	u8 *buffer;
1641 	struct usb_device *dev = tdev->td_serial->dev;
1642 	unsigned int pipe = usb_sndbulkpipe(dev,
1643 		tdev->td_serial->port[0]->bulk_out_endpointAddress);
1644 	const struct firmware *fw_p;
1645 	char buf[32];
1646 
1647 	if (le16_to_cpu(dev->descriptor.idVendor) == MXU1_VENDOR_ID) {
1648 		snprintf(buf,
1649 			sizeof(buf),
1650 			"moxa/moxa-%04x.fw",
1651 			le16_to_cpu(dev->descriptor.idProduct));
1652 
1653 		status = request_firmware(&fw_p, buf, &dev->dev);
1654 		goto check_firmware;
1655 	}
1656 
1657 	/* try ID specific firmware first, then try generic firmware */
1658 	sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1659 			le16_to_cpu(dev->descriptor.idVendor),
1660 			le16_to_cpu(dev->descriptor.idProduct));
1661 	status = request_firmware(&fw_p, buf, &dev->dev);
1662 
1663 	if (status != 0) {
1664 		buf[0] = '\0';
1665 		if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1666 			switch (le16_to_cpu(dev->descriptor.idProduct)) {
1667 			case MTS_CDMA_PRODUCT_ID:
1668 				strcpy(buf, "mts_cdma.fw");
1669 				break;
1670 			case MTS_GSM_PRODUCT_ID:
1671 				strcpy(buf, "mts_gsm.fw");
1672 				break;
1673 			case MTS_EDGE_PRODUCT_ID:
1674 				strcpy(buf, "mts_edge.fw");
1675 				break;
1676 			case MTS_MT9234MU_PRODUCT_ID:
1677 				strcpy(buf, "mts_mt9234mu.fw");
1678 				break;
1679 			case MTS_MT9234ZBA_PRODUCT_ID:
1680 				strcpy(buf, "mts_mt9234zba.fw");
1681 				break;
1682 			case MTS_MT9234ZBAOLD_PRODUCT_ID:
1683 				strcpy(buf, "mts_mt9234zba.fw");
1684 				break;			}
1685 		}
1686 		if (buf[0] == '\0') {
1687 			if (tdev->td_is_3410)
1688 				strcpy(buf, "ti_3410.fw");
1689 			else
1690 				strcpy(buf, "ti_5052.fw");
1691 		}
1692 		status = request_firmware(&fw_p, buf, &dev->dev);
1693 	}
1694 
1695 check_firmware:
1696 	if (status) {
1697 		dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1698 		return -ENOENT;
1699 	}
1700 	if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1701 		dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1702 		release_firmware(fw_p);
1703 		return -ENOENT;
1704 	}
1705 
1706 	buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1707 	buffer = kmalloc(buffer_size, GFP_KERNEL);
1708 	if (buffer) {
1709 		memcpy(buffer, fw_p->data, fw_p->size);
1710 		memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1711 		status = ti_do_download(dev, pipe, buffer, fw_p->size);
1712 		kfree(buffer);
1713 	} else {
1714 		status = -ENOMEM;
1715 	}
1716 	release_firmware(fw_p);
1717 	if (status) {
1718 		dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1719 							__func__, status);
1720 		return status;
1721 	}
1722 
1723 	dev_dbg(&dev->dev, "%s - download successful\n", __func__);
1724 
1725 	return 0;
1726 }
1727