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 .num_bulk_out = 1,
431 .attach = ti_startup,
432 .release = ti_release,
433 .port_probe = ti_port_probe,
434 .port_remove = ti_port_remove,
435 .open = ti_open,
436 .close = ti_close,
437 .write = ti_write,
438 .write_room = ti_write_room,
439 .chars_in_buffer = ti_chars_in_buffer,
440 .tx_empty = ti_tx_empty,
441 .throttle = ti_throttle,
442 .unthrottle = ti_unthrottle,
443 .ioctl = ti_ioctl,
444 .set_termios = ti_set_termios,
445 .tiocmget = ti_tiocmget,
446 .tiocmset = ti_tiocmset,
447 .tiocmiwait = usb_serial_generic_tiocmiwait,
448 .get_icount = usb_serial_generic_get_icount,
449 .break_ctl = ti_break,
450 .read_int_callback = ti_interrupt_callback,
451 .read_bulk_callback = ti_bulk_in_callback,
452 .write_bulk_callback = ti_bulk_out_callback,
453 };
454
455 static struct usb_serial_driver ti_2port_device = {
456 .driver = {
457 .owner = THIS_MODULE,
458 .name = "ti_usb_3410_5052_2",
459 },
460 .description = "TI USB 5052 2 port adapter",
461 .id_table = ti_id_table_5052,
462 .num_ports = 2,
463 .num_bulk_out = 1,
464 .attach = ti_startup,
465 .release = ti_release,
466 .port_probe = ti_port_probe,
467 .port_remove = ti_port_remove,
468 .open = ti_open,
469 .close = ti_close,
470 .write = ti_write,
471 .write_room = ti_write_room,
472 .chars_in_buffer = ti_chars_in_buffer,
473 .tx_empty = ti_tx_empty,
474 .throttle = ti_throttle,
475 .unthrottle = ti_unthrottle,
476 .ioctl = ti_ioctl,
477 .set_termios = ti_set_termios,
478 .tiocmget = ti_tiocmget,
479 .tiocmset = ti_tiocmset,
480 .tiocmiwait = usb_serial_generic_tiocmiwait,
481 .get_icount = usb_serial_generic_get_icount,
482 .break_ctl = ti_break,
483 .read_int_callback = ti_interrupt_callback,
484 .read_bulk_callback = ti_bulk_in_callback,
485 .write_bulk_callback = ti_bulk_out_callback,
486 };
487
488 static struct usb_serial_driver * const serial_drivers[] = {
489 &ti_1port_device, &ti_2port_device, NULL
490 };
491
492 MODULE_AUTHOR(TI_DRIVER_AUTHOR);
493 MODULE_DESCRIPTION(TI_DRIVER_DESC);
494 MODULE_LICENSE("GPL");
495
496 MODULE_FIRMWARE("ti_3410.fw");
497 MODULE_FIRMWARE("ti_5052.fw");
498 MODULE_FIRMWARE("mts_cdma.fw");
499 MODULE_FIRMWARE("mts_gsm.fw");
500 MODULE_FIRMWARE("mts_edge.fw");
501 MODULE_FIRMWARE("mts_mt9234mu.fw");
502 MODULE_FIRMWARE("mts_mt9234zba.fw");
503 MODULE_FIRMWARE("moxa/moxa-1110.fw");
504 MODULE_FIRMWARE("moxa/moxa-1130.fw");
505 MODULE_FIRMWARE("moxa/moxa-1131.fw");
506 MODULE_FIRMWARE("moxa/moxa-1150.fw");
507 MODULE_FIRMWARE("moxa/moxa-1151.fw");
508
509 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
510 MODULE_PARM_DESC(closing_wait,
511 "Maximum wait for data to drain in close, in .01 secs, default is 4000");
512
513 MODULE_DEVICE_TABLE(usb, ti_id_table_combined);
514
515 module_usb_serial_driver(serial_drivers, ti_id_table_combined);
516
ti_startup(struct usb_serial * serial)517 static int ti_startup(struct usb_serial *serial)
518 {
519 struct ti_device *tdev;
520 struct usb_device *dev = serial->dev;
521 struct usb_host_interface *cur_altsetting;
522 int num_endpoints;
523 u16 vid, pid;
524 int status;
525
526 dev_dbg(&dev->dev,
527 "%s - product 0x%4X, num configurations %d, configuration value %d\n",
528 __func__, le16_to_cpu(dev->descriptor.idProduct),
529 dev->descriptor.bNumConfigurations,
530 dev->actconfig->desc.bConfigurationValue);
531
532 tdev = kzalloc(sizeof(struct ti_device), GFP_KERNEL);
533 if (!tdev)
534 return -ENOMEM;
535
536 mutex_init(&tdev->td_open_close_lock);
537 tdev->td_serial = serial;
538 usb_set_serial_data(serial, tdev);
539
540 /* determine device type */
541 if (serial->type == &ti_1port_device)
542 tdev->td_is_3410 = 1;
543 dev_dbg(&dev->dev, "%s - device type is %s\n", __func__,
544 tdev->td_is_3410 ? "3410" : "5052");
545
546 vid = le16_to_cpu(dev->descriptor.idVendor);
547 pid = le16_to_cpu(dev->descriptor.idProduct);
548 if (vid == MXU1_VENDOR_ID) {
549 switch (pid) {
550 case MXU1_1130_PRODUCT_ID:
551 case MXU1_1131_PRODUCT_ID:
552 tdev->td_rs485_only = true;
553 break;
554 }
555 }
556
557 cur_altsetting = serial->interface->cur_altsetting;
558 num_endpoints = cur_altsetting->desc.bNumEndpoints;
559
560 /* if we have only 1 configuration and 1 endpoint, download firmware */
561 if (dev->descriptor.bNumConfigurations == 1 && num_endpoints == 1) {
562 status = ti_download_firmware(tdev);
563
564 if (status != 0)
565 goto free_tdev;
566
567 /* 3410 must be reset, 5052 resets itself */
568 if (tdev->td_is_3410) {
569 msleep_interruptible(100);
570 usb_reset_device(dev);
571 }
572
573 status = -ENODEV;
574 goto free_tdev;
575 }
576
577 /* the second configuration must be set */
578 if (dev->actconfig->desc.bConfigurationValue == TI_BOOT_CONFIG) {
579 status = usb_driver_set_configuration(dev, TI_ACTIVE_CONFIG);
580 status = status ? status : -ENODEV;
581 goto free_tdev;
582 }
583
584 if (serial->num_bulk_in < serial->num_ports ||
585 serial->num_bulk_out < serial->num_ports) {
586 dev_err(&serial->interface->dev, "missing endpoints\n");
587 status = -ENODEV;
588 goto free_tdev;
589 }
590
591 return 0;
592
593 free_tdev:
594 kfree(tdev);
595 usb_set_serial_data(serial, NULL);
596 return status;
597 }
598
599
ti_release(struct usb_serial * serial)600 static void ti_release(struct usb_serial *serial)
601 {
602 struct ti_device *tdev = usb_get_serial_data(serial);
603
604 kfree(tdev);
605 }
606
ti_port_probe(struct usb_serial_port * port)607 static int ti_port_probe(struct usb_serial_port *port)
608 {
609 struct ti_port *tport;
610
611 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
612 if (!tport)
613 return -ENOMEM;
614
615 spin_lock_init(&tport->tp_lock);
616 if (port == port->serial->port[0])
617 tport->tp_uart_base_addr = TI_UART1_BASE_ADDR;
618 else
619 tport->tp_uart_base_addr = TI_UART2_BASE_ADDR;
620 port->port.closing_wait = msecs_to_jiffies(10 * closing_wait);
621 tport->tp_port = port;
622 tport->tp_tdev = usb_get_serial_data(port->serial);
623
624 if (tport->tp_tdev->td_rs485_only)
625 tport->tp_uart_mode = TI_UART_485_RECEIVER_DISABLED;
626 else
627 tport->tp_uart_mode = TI_UART_232;
628
629 usb_set_serial_port_data(port, tport);
630
631 port->port.drain_delay = 3;
632
633 return 0;
634 }
635
ti_port_remove(struct usb_serial_port * port)636 static int ti_port_remove(struct usb_serial_port *port)
637 {
638 struct ti_port *tport;
639
640 tport = usb_get_serial_port_data(port);
641 kfree(tport);
642
643 return 0;
644 }
645
ti_open(struct tty_struct * tty,struct usb_serial_port * port)646 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
647 {
648 struct ti_port *tport = usb_get_serial_port_data(port);
649 struct ti_device *tdev;
650 struct usb_device *dev;
651 struct urb *urb;
652 int port_number;
653 int status;
654 u16 open_settings;
655
656 open_settings = (TI_PIPE_MODE_CONTINUOUS |
657 TI_PIPE_TIMEOUT_ENABLE |
658 (TI_TRANSFER_TIMEOUT << 2));
659
660 dev = port->serial->dev;
661 tdev = tport->tp_tdev;
662
663 /* only one open on any port on a device at a time */
664 if (mutex_lock_interruptible(&tdev->td_open_close_lock))
665 return -ERESTARTSYS;
666
667 port_number = port->port_number;
668
669 tport->tp_msr = 0;
670 tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
671
672 /* start interrupt urb the first time a port is opened on this device */
673 if (tdev->td_open_port_count == 0) {
674 dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
675 urb = tdev->td_serial->port[0]->interrupt_in_urb;
676 if (!urb) {
677 dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
678 status = -EINVAL;
679 goto release_lock;
680 }
681 urb->context = tdev;
682 status = usb_submit_urb(urb, GFP_KERNEL);
683 if (status) {
684 dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
685 goto release_lock;
686 }
687 }
688
689 if (tty)
690 ti_set_termios(tty, port, &tty->termios);
691
692 status = ti_command_out_sync(tdev, TI_OPEN_PORT,
693 (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
694 if (status) {
695 dev_err(&port->dev, "%s - cannot send open command, %d\n",
696 __func__, status);
697 goto unlink_int_urb;
698 }
699
700 status = ti_command_out_sync(tdev, TI_START_PORT,
701 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
702 if (status) {
703 dev_err(&port->dev, "%s - cannot send start command, %d\n",
704 __func__, status);
705 goto unlink_int_urb;
706 }
707
708 status = ti_command_out_sync(tdev, TI_PURGE_PORT,
709 (__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
710 if (status) {
711 dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
712 __func__, status);
713 goto unlink_int_urb;
714 }
715 status = ti_command_out_sync(tdev, TI_PURGE_PORT,
716 (__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
717 if (status) {
718 dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
719 __func__, status);
720 goto unlink_int_urb;
721 }
722
723 /* reset the data toggle on the bulk endpoints to work around bug in
724 * host controllers where things get out of sync some times */
725 usb_clear_halt(dev, port->write_urb->pipe);
726 usb_clear_halt(dev, port->read_urb->pipe);
727
728 if (tty)
729 ti_set_termios(tty, port, &tty->termios);
730
731 status = ti_command_out_sync(tdev, TI_OPEN_PORT,
732 (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
733 if (status) {
734 dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
735 __func__, status);
736 goto unlink_int_urb;
737 }
738
739 status = ti_command_out_sync(tdev, TI_START_PORT,
740 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
741 if (status) {
742 dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
743 __func__, status);
744 goto unlink_int_urb;
745 }
746
747 /* start read urb */
748 urb = port->read_urb;
749 if (!urb) {
750 dev_err(&port->dev, "%s - no read urb\n", __func__);
751 status = -EINVAL;
752 goto unlink_int_urb;
753 }
754 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
755 urb->context = tport;
756 status = usb_submit_urb(urb, GFP_KERNEL);
757 if (status) {
758 dev_err(&port->dev, "%s - submit read urb failed, %d\n",
759 __func__, status);
760 goto unlink_int_urb;
761 }
762
763 tport->tp_is_open = 1;
764 ++tdev->td_open_port_count;
765
766 goto release_lock;
767
768 unlink_int_urb:
769 if (tdev->td_open_port_count == 0)
770 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
771 release_lock:
772 mutex_unlock(&tdev->td_open_close_lock);
773 return status;
774 }
775
776
ti_close(struct usb_serial_port * port)777 static void ti_close(struct usb_serial_port *port)
778 {
779 struct ti_device *tdev;
780 struct ti_port *tport;
781 int port_number;
782 int status;
783 unsigned long flags;
784
785 tdev = usb_get_serial_data(port->serial);
786 tport = usb_get_serial_port_data(port);
787
788 tport->tp_is_open = 0;
789
790 usb_kill_urb(port->read_urb);
791 usb_kill_urb(port->write_urb);
792 tport->tp_write_urb_in_use = 0;
793 spin_lock_irqsave(&tport->tp_lock, flags);
794 kfifo_reset_out(&port->write_fifo);
795 spin_unlock_irqrestore(&tport->tp_lock, flags);
796
797 port_number = port->port_number;
798
799 status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
800 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
801 if (status)
802 dev_err(&port->dev,
803 "%s - cannot send close port command, %d\n"
804 , __func__, status);
805
806 mutex_lock(&tdev->td_open_close_lock);
807 --tport->tp_tdev->td_open_port_count;
808 if (tport->tp_tdev->td_open_port_count == 0) {
809 /* last port is closed, shut down interrupt urb */
810 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
811 }
812 mutex_unlock(&tdev->td_open_close_lock);
813 }
814
815
ti_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * data,int count)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
ti_write_room(struct tty_struct * tty)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
ti_chars_in_buffer(struct tty_struct * tty)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
ti_tx_empty(struct usb_serial_port * port)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
ti_throttle(struct tty_struct * tty)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
ti_unthrottle(struct tty_struct * tty)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
ti_ioctl(struct tty_struct * tty,unsigned int cmd,unsigned long arg)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
ti_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)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
ti_tiocmget(struct tty_struct * tty)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
ti_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)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
ti_break(struct tty_struct * tty,int break_state)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
ti_get_port_from_code(unsigned char code)1120 static int ti_get_port_from_code(unsigned char code)
1121 {
1122 return (code >> 6) & 0x01;
1123 }
1124
ti_get_func_from_code(unsigned char code)1125 static int ti_get_func_from_code(unsigned char code)
1126 {
1127 return code & 0x0f;
1128 }
1129
ti_interrupt_callback(struct urb * urb)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
ti_bulk_in_callback(struct urb * urb)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 int retval = 0;
1219
1220 switch (status) {
1221 case 0:
1222 break;
1223 case -ECONNRESET:
1224 case -ENOENT:
1225 case -ESHUTDOWN:
1226 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1227 return;
1228 default:
1229 dev_err(dev, "%s - nonzero urb status, %d\n",
1230 __func__, status);
1231 }
1232
1233 if (status == -EPIPE)
1234 goto exit;
1235
1236 if (status) {
1237 dev_err(dev, "%s - stopping read!\n", __func__);
1238 return;
1239 }
1240
1241 if (urb->actual_length) {
1242 usb_serial_debug_data(dev, __func__, urb->actual_length,
1243 urb->transfer_buffer);
1244
1245 if (!tport->tp_is_open)
1246 dev_dbg(dev, "%s - port closed, dropping data\n",
1247 __func__);
1248 else
1249 ti_recv(port, urb->transfer_buffer, urb->actual_length);
1250 spin_lock(&tport->tp_lock);
1251 port->icount.rx += urb->actual_length;
1252 spin_unlock(&tport->tp_lock);
1253 }
1254
1255 exit:
1256 /* continue to read unless stopping */
1257 spin_lock(&tport->tp_lock);
1258 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1259 retval = usb_submit_urb(urb, GFP_ATOMIC);
1260 else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1261 tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1262
1263 spin_unlock(&tport->tp_lock);
1264 if (retval)
1265 dev_err(dev, "%s - resubmit read urb failed, %d\n",
1266 __func__, retval);
1267 }
1268
1269
ti_bulk_out_callback(struct urb * urb)1270 static void ti_bulk_out_callback(struct urb *urb)
1271 {
1272 struct ti_port *tport = urb->context;
1273 struct usb_serial_port *port = tport->tp_port;
1274 int status = urb->status;
1275
1276 tport->tp_write_urb_in_use = 0;
1277
1278 switch (status) {
1279 case 0:
1280 break;
1281 case -ECONNRESET:
1282 case -ENOENT:
1283 case -ESHUTDOWN:
1284 dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1285 return;
1286 default:
1287 dev_err_console(port, "%s - nonzero urb status, %d\n",
1288 __func__, status);
1289 }
1290
1291 /* send any buffered data */
1292 ti_send(tport);
1293 }
1294
1295
ti_recv(struct usb_serial_port * port,unsigned char * data,int length)1296 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1297 int length)
1298 {
1299 int cnt;
1300
1301 do {
1302 cnt = tty_insert_flip_string(&port->port, data, length);
1303 if (cnt < length) {
1304 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1305 __func__, length - cnt);
1306 if (cnt == 0)
1307 break;
1308 }
1309 tty_flip_buffer_push(&port->port);
1310 data += cnt;
1311 length -= cnt;
1312 } while (length > 0);
1313 }
1314
1315
ti_send(struct ti_port * tport)1316 static void ti_send(struct ti_port *tport)
1317 {
1318 int count, result;
1319 struct usb_serial_port *port = tport->tp_port;
1320 unsigned long flags;
1321
1322 spin_lock_irqsave(&tport->tp_lock, flags);
1323
1324 if (tport->tp_write_urb_in_use)
1325 goto unlock;
1326
1327 count = kfifo_out(&port->write_fifo,
1328 port->write_urb->transfer_buffer,
1329 port->bulk_out_size);
1330
1331 if (count == 0)
1332 goto unlock;
1333
1334 tport->tp_write_urb_in_use = 1;
1335
1336 spin_unlock_irqrestore(&tport->tp_lock, flags);
1337
1338 usb_serial_debug_data(&port->dev, __func__, count,
1339 port->write_urb->transfer_buffer);
1340
1341 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1342 usb_sndbulkpipe(port->serial->dev,
1343 port->bulk_out_endpointAddress),
1344 port->write_urb->transfer_buffer, count,
1345 ti_bulk_out_callback, tport);
1346
1347 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1348 if (result) {
1349 dev_err_console(port, "%s - submit write urb failed, %d\n",
1350 __func__, result);
1351 tport->tp_write_urb_in_use = 0;
1352 /* TODO: reschedule ti_send */
1353 } else {
1354 spin_lock_irqsave(&tport->tp_lock, flags);
1355 port->icount.tx += count;
1356 spin_unlock_irqrestore(&tport->tp_lock, flags);
1357 }
1358
1359 /* more room in the buffer for new writes, wakeup */
1360 tty_port_tty_wakeup(&port->port);
1361
1362 return;
1363 unlock:
1364 spin_unlock_irqrestore(&tport->tp_lock, flags);
1365 return;
1366 }
1367
1368
ti_set_mcr(struct ti_port * tport,unsigned int mcr)1369 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1370 {
1371 unsigned long flags;
1372 int status;
1373
1374 status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1375 tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1376 TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1377
1378 spin_lock_irqsave(&tport->tp_lock, flags);
1379 if (!status)
1380 tport->tp_shadow_mcr = mcr;
1381 spin_unlock_irqrestore(&tport->tp_lock, flags);
1382
1383 return status;
1384 }
1385
1386
ti_get_lsr(struct ti_port * tport,u8 * lsr)1387 static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1388 {
1389 int size, status;
1390 struct ti_device *tdev = tport->tp_tdev;
1391 struct usb_serial_port *port = tport->tp_port;
1392 int port_number = port->port_number;
1393 struct ti_port_status *data;
1394
1395 size = sizeof(struct ti_port_status);
1396 data = kmalloc(size, GFP_KERNEL);
1397 if (!data)
1398 return -ENOMEM;
1399
1400 status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1401 (__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1402 if (status) {
1403 dev_err(&port->dev,
1404 "%s - get port status command failed, %d\n",
1405 __func__, status);
1406 goto free_data;
1407 }
1408
1409 dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1410
1411 *lsr = data->bLSR;
1412
1413 free_data:
1414 kfree(data);
1415 return status;
1416 }
1417
1418
ti_get_serial_info(struct ti_port * tport,struct serial_struct __user * ret_arg)1419 static int ti_get_serial_info(struct ti_port *tport,
1420 struct serial_struct __user *ret_arg)
1421 {
1422 struct usb_serial_port *port = tport->tp_port;
1423 struct serial_struct ret_serial;
1424 unsigned cwait;
1425
1426 cwait = port->port.closing_wait;
1427 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1428 cwait = jiffies_to_msecs(cwait) / 10;
1429
1430 memset(&ret_serial, 0, sizeof(ret_serial));
1431
1432 ret_serial.type = PORT_16550A;
1433 ret_serial.line = port->minor;
1434 ret_serial.port = port->port_number;
1435 ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1436 ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1437 ret_serial.closing_wait = cwait;
1438
1439 if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1440 return -EFAULT;
1441
1442 return 0;
1443 }
1444
1445
ti_set_serial_info(struct tty_struct * tty,struct ti_port * tport,struct serial_struct __user * new_arg)1446 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1447 struct serial_struct __user *new_arg)
1448 {
1449 struct serial_struct new_serial;
1450 unsigned cwait;
1451
1452 if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1453 return -EFAULT;
1454
1455 cwait = new_serial.closing_wait;
1456 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1457 cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1458
1459 tport->tp_port->port.closing_wait = cwait;
1460
1461 return 0;
1462 }
1463
1464
ti_handle_new_msr(struct ti_port * tport,u8 msr)1465 static void ti_handle_new_msr(struct ti_port *tport, u8 msr)
1466 {
1467 struct async_icount *icount;
1468 struct tty_struct *tty;
1469 unsigned long flags;
1470
1471 dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1472
1473 if (msr & TI_MSR_DELTA_MASK) {
1474 spin_lock_irqsave(&tport->tp_lock, flags);
1475 icount = &tport->tp_port->icount;
1476 if (msr & TI_MSR_DELTA_CTS)
1477 icount->cts++;
1478 if (msr & TI_MSR_DELTA_DSR)
1479 icount->dsr++;
1480 if (msr & TI_MSR_DELTA_CD)
1481 icount->dcd++;
1482 if (msr & TI_MSR_DELTA_RI)
1483 icount->rng++;
1484 wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1485 spin_unlock_irqrestore(&tport->tp_lock, flags);
1486 }
1487
1488 tport->tp_msr = msr & TI_MSR_MASK;
1489
1490 /* handle CTS flow control */
1491 tty = tty_port_tty_get(&tport->tp_port->port);
1492 if (tty && C_CRTSCTS(tty)) {
1493 if (msr & TI_MSR_CTS)
1494 tty_wakeup(tty);
1495 }
1496 tty_kref_put(tty);
1497 }
1498
1499
ti_stop_read(struct ti_port * tport,struct tty_struct * tty)1500 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1501 {
1502 unsigned long flags;
1503
1504 spin_lock_irqsave(&tport->tp_lock, flags);
1505
1506 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1507 tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1508
1509 spin_unlock_irqrestore(&tport->tp_lock, flags);
1510 }
1511
1512
ti_restart_read(struct ti_port * tport,struct tty_struct * tty)1513 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1514 {
1515 struct urb *urb;
1516 int status = 0;
1517 unsigned long flags;
1518
1519 spin_lock_irqsave(&tport->tp_lock, flags);
1520
1521 if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1522 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1523 urb = tport->tp_port->read_urb;
1524 spin_unlock_irqrestore(&tport->tp_lock, flags);
1525 urb->context = tport;
1526 status = usb_submit_urb(urb, GFP_KERNEL);
1527 } else {
1528 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1529 spin_unlock_irqrestore(&tport->tp_lock, flags);
1530 }
1531
1532 return status;
1533 }
1534
1535
ti_command_out_sync(struct ti_device * tdev,__u8 command,__u16 moduleid,__u16 value,__u8 * data,int size)1536 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1537 __u16 moduleid, __u16 value, __u8 *data, int size)
1538 {
1539 int status;
1540
1541 status = usb_control_msg(tdev->td_serial->dev,
1542 usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1543 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1544 value, moduleid, data, size, 1000);
1545
1546 if (status < 0)
1547 return status;
1548
1549 return 0;
1550 }
1551
1552
ti_command_in_sync(struct ti_device * tdev,__u8 command,__u16 moduleid,__u16 value,__u8 * data,int size)1553 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1554 __u16 moduleid, __u16 value, __u8 *data, int size)
1555 {
1556 int status;
1557
1558 status = usb_control_msg(tdev->td_serial->dev,
1559 usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1560 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1561 value, moduleid, data, size, 1000);
1562
1563 if (status == size)
1564 status = 0;
1565 else if (status >= 0)
1566 status = -ECOMM;
1567
1568 return status;
1569 }
1570
1571
ti_write_byte(struct usb_serial_port * port,struct ti_device * tdev,unsigned long addr,u8 mask,u8 byte)1572 static int ti_write_byte(struct usb_serial_port *port,
1573 struct ti_device *tdev, unsigned long addr,
1574 u8 mask, u8 byte)
1575 {
1576 int status;
1577 unsigned int size;
1578 struct ti_write_data_bytes *data;
1579
1580 dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1581 addr, mask, byte);
1582
1583 size = sizeof(struct ti_write_data_bytes) + 2;
1584 data = kmalloc(size, GFP_KERNEL);
1585 if (!data)
1586 return -ENOMEM;
1587
1588 data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1589 data->bDataType = TI_RW_DATA_BYTE;
1590 data->bDataCounter = 1;
1591 data->wBaseAddrHi = cpu_to_be16(addr>>16);
1592 data->wBaseAddrLo = cpu_to_be16(addr);
1593 data->bData[0] = mask;
1594 data->bData[1] = byte;
1595
1596 status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1597 (__u8 *)data, size);
1598
1599 if (status < 0)
1600 dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1601
1602 kfree(data);
1603
1604 return status;
1605 }
1606
ti_do_download(struct usb_device * dev,int pipe,u8 * buffer,int size)1607 static int ti_do_download(struct usb_device *dev, int pipe,
1608 u8 *buffer, int size)
1609 {
1610 int pos;
1611 u8 cs = 0;
1612 int done;
1613 struct ti_firmware_header *header;
1614 int status = 0;
1615 int len;
1616
1617 for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1618 cs = (u8)(cs + buffer[pos]);
1619
1620 header = (struct ti_firmware_header *)buffer;
1621 header->wLength = cpu_to_le16(size - sizeof(*header));
1622 header->bCheckSum = cs;
1623
1624 dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1625 for (pos = 0; pos < size; pos += done) {
1626 len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1627 status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1628 &done, 1000);
1629 if (status)
1630 break;
1631 }
1632 return status;
1633 }
1634
ti_download_firmware(struct ti_device * tdev)1635 static int ti_download_firmware(struct ti_device *tdev)
1636 {
1637 int status;
1638 int buffer_size;
1639 u8 *buffer;
1640 struct usb_device *dev = tdev->td_serial->dev;
1641 unsigned int pipe = usb_sndbulkpipe(dev,
1642 tdev->td_serial->port[0]->bulk_out_endpointAddress);
1643 const struct firmware *fw_p;
1644 char buf[32];
1645
1646 if (le16_to_cpu(dev->descriptor.idVendor) == MXU1_VENDOR_ID) {
1647 snprintf(buf,
1648 sizeof(buf),
1649 "moxa/moxa-%04x.fw",
1650 le16_to_cpu(dev->descriptor.idProduct));
1651
1652 status = request_firmware(&fw_p, buf, &dev->dev);
1653 goto check_firmware;
1654 }
1655
1656 /* try ID specific firmware first, then try generic firmware */
1657 sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1658 le16_to_cpu(dev->descriptor.idVendor),
1659 le16_to_cpu(dev->descriptor.idProduct));
1660 status = request_firmware(&fw_p, buf, &dev->dev);
1661
1662 if (status != 0) {
1663 buf[0] = '\0';
1664 if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1665 switch (le16_to_cpu(dev->descriptor.idProduct)) {
1666 case MTS_CDMA_PRODUCT_ID:
1667 strcpy(buf, "mts_cdma.fw");
1668 break;
1669 case MTS_GSM_PRODUCT_ID:
1670 strcpy(buf, "mts_gsm.fw");
1671 break;
1672 case MTS_EDGE_PRODUCT_ID:
1673 strcpy(buf, "mts_edge.fw");
1674 break;
1675 case MTS_MT9234MU_PRODUCT_ID:
1676 strcpy(buf, "mts_mt9234mu.fw");
1677 break;
1678 case MTS_MT9234ZBA_PRODUCT_ID:
1679 strcpy(buf, "mts_mt9234zba.fw");
1680 break;
1681 case MTS_MT9234ZBAOLD_PRODUCT_ID:
1682 strcpy(buf, "mts_mt9234zba.fw");
1683 break; }
1684 }
1685 if (buf[0] == '\0') {
1686 if (tdev->td_is_3410)
1687 strcpy(buf, "ti_3410.fw");
1688 else
1689 strcpy(buf, "ti_5052.fw");
1690 }
1691 status = request_firmware(&fw_p, buf, &dev->dev);
1692 }
1693
1694 check_firmware:
1695 if (status) {
1696 dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1697 return -ENOENT;
1698 }
1699 if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1700 dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1701 release_firmware(fw_p);
1702 return -ENOENT;
1703 }
1704
1705 buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1706 buffer = kmalloc(buffer_size, GFP_KERNEL);
1707 if (buffer) {
1708 memcpy(buffer, fw_p->data, fw_p->size);
1709 memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1710 status = ti_do_download(dev, pipe, buffer, fw_p->size);
1711 kfree(buffer);
1712 } else {
1713 status = -ENOMEM;
1714 }
1715 release_firmware(fw_p);
1716 if (status) {
1717 dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1718 __func__, status);
1719 return status;
1720 }
1721
1722 dev_dbg(&dev->dev, "%s - download successful\n", __func__);
1723
1724 return 0;
1725 }
1726