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
ti_startup(struct usb_serial * serial)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
ti_release(struct usb_serial * serial)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
ti_port_probe(struct usb_serial_port * port)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
ti_port_remove(struct usb_serial_port * port)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
ti_open(struct tty_struct * tty,struct usb_serial_port * port)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
ti_close(struct usb_serial_port * port)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 unsigned long flags;
780
781 tdev = usb_get_serial_data(port->serial);
782 tport = usb_get_serial_port_data(port);
783
784 tport->tp_is_open = 0;
785
786 usb_kill_urb(port->read_urb);
787 usb_kill_urb(port->write_urb);
788 tport->tp_write_urb_in_use = 0;
789 spin_lock_irqsave(&tport->tp_lock, flags);
790 kfifo_reset_out(&port->write_fifo);
791 spin_unlock_irqrestore(&tport->tp_lock, flags);
792
793 port_number = port->port_number;
794
795 status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
796 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
797 if (status)
798 dev_err(&port->dev,
799 "%s - cannot send close port command, %d\n"
800 , __func__, status);
801
802 mutex_lock(&tdev->td_open_close_lock);
803 --tport->tp_tdev->td_open_port_count;
804 if (tport->tp_tdev->td_open_port_count == 0) {
805 /* last port is closed, shut down interrupt urb */
806 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
807 }
808 mutex_unlock(&tdev->td_open_close_lock);
809 }
810
811
ti_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * data,int count)812 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
813 const unsigned char *data, int count)
814 {
815 struct ti_port *tport = usb_get_serial_port_data(port);
816
817 if (count == 0) {
818 return 0;
819 }
820
821 if (!tport->tp_is_open)
822 return -ENODEV;
823
824 count = kfifo_in_locked(&port->write_fifo, data, count,
825 &tport->tp_lock);
826 ti_send(tport);
827
828 return count;
829 }
830
831
ti_write_room(struct tty_struct * tty)832 static int ti_write_room(struct tty_struct *tty)
833 {
834 struct usb_serial_port *port = tty->driver_data;
835 struct ti_port *tport = usb_get_serial_port_data(port);
836 int room = 0;
837 unsigned long flags;
838
839 spin_lock_irqsave(&tport->tp_lock, flags);
840 room = kfifo_avail(&port->write_fifo);
841 spin_unlock_irqrestore(&tport->tp_lock, flags);
842
843 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
844 return room;
845 }
846
847
ti_chars_in_buffer(struct tty_struct * tty)848 static int ti_chars_in_buffer(struct tty_struct *tty)
849 {
850 struct usb_serial_port *port = tty->driver_data;
851 struct ti_port *tport = usb_get_serial_port_data(port);
852 int chars = 0;
853 unsigned long flags;
854
855 spin_lock_irqsave(&tport->tp_lock, flags);
856 chars = kfifo_len(&port->write_fifo);
857 spin_unlock_irqrestore(&tport->tp_lock, flags);
858
859 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
860 return chars;
861 }
862
ti_tx_empty(struct usb_serial_port * port)863 static bool ti_tx_empty(struct usb_serial_port *port)
864 {
865 struct ti_port *tport = usb_get_serial_port_data(port);
866 int ret;
867 u8 lsr;
868
869 ret = ti_get_lsr(tport, &lsr);
870 if (!ret && !(lsr & TI_LSR_TX_EMPTY))
871 return false;
872
873 return true;
874 }
875
ti_throttle(struct tty_struct * tty)876 static void ti_throttle(struct tty_struct *tty)
877 {
878 struct usb_serial_port *port = tty->driver_data;
879 struct ti_port *tport = usb_get_serial_port_data(port);
880
881 if (I_IXOFF(tty) || C_CRTSCTS(tty))
882 ti_stop_read(tport, tty);
883
884 }
885
886
ti_unthrottle(struct tty_struct * tty)887 static void ti_unthrottle(struct tty_struct *tty)
888 {
889 struct usb_serial_port *port = tty->driver_data;
890 struct ti_port *tport = usb_get_serial_port_data(port);
891 int status;
892
893 if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
894 status = ti_restart_read(tport, tty);
895 if (status)
896 dev_err(&port->dev, "%s - cannot restart read, %d\n",
897 __func__, status);
898 }
899 }
900
ti_ioctl(struct tty_struct * tty,unsigned int cmd,unsigned long arg)901 static int ti_ioctl(struct tty_struct *tty,
902 unsigned int cmd, unsigned long arg)
903 {
904 struct usb_serial_port *port = tty->driver_data;
905 struct ti_port *tport = usb_get_serial_port_data(port);
906
907 switch (cmd) {
908 case TIOCGSERIAL:
909 return ti_get_serial_info(tport,
910 (struct serial_struct __user *)arg);
911 case TIOCSSERIAL:
912 return ti_set_serial_info(tty, tport,
913 (struct serial_struct __user *)arg);
914 }
915 return -ENOIOCTLCMD;
916 }
917
918
ti_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)919 static void ti_set_termios(struct tty_struct *tty,
920 struct usb_serial_port *port, struct ktermios *old_termios)
921 {
922 struct ti_port *tport = usb_get_serial_port_data(port);
923 struct ti_uart_config *config;
924 int baud;
925 int status;
926 int port_number = port->port_number;
927 unsigned int mcr;
928 u16 wbaudrate;
929 u16 wflags = 0;
930
931 config = kmalloc(sizeof(*config), GFP_KERNEL);
932 if (!config)
933 return;
934
935 /* these flags must be set */
936 wflags |= TI_UART_ENABLE_MS_INTS;
937 wflags |= TI_UART_ENABLE_AUTO_START_DMA;
938 config->bUartMode = tport->tp_uart_mode;
939
940 switch (C_CSIZE(tty)) {
941 case CS5:
942 config->bDataBits = TI_UART_5_DATA_BITS;
943 break;
944 case CS6:
945 config->bDataBits = TI_UART_6_DATA_BITS;
946 break;
947 case CS7:
948 config->bDataBits = TI_UART_7_DATA_BITS;
949 break;
950 default:
951 case CS8:
952 config->bDataBits = TI_UART_8_DATA_BITS;
953 break;
954 }
955
956 /* CMSPAR isn't supported by this driver */
957 tty->termios.c_cflag &= ~CMSPAR;
958
959 if (C_PARENB(tty)) {
960 if (C_PARODD(tty)) {
961 wflags |= TI_UART_ENABLE_PARITY_CHECKING;
962 config->bParity = TI_UART_ODD_PARITY;
963 } else {
964 wflags |= TI_UART_ENABLE_PARITY_CHECKING;
965 config->bParity = TI_UART_EVEN_PARITY;
966 }
967 } else {
968 wflags &= ~TI_UART_ENABLE_PARITY_CHECKING;
969 config->bParity = TI_UART_NO_PARITY;
970 }
971
972 if (C_CSTOPB(tty))
973 config->bStopBits = TI_UART_2_STOP_BITS;
974 else
975 config->bStopBits = TI_UART_1_STOP_BITS;
976
977 if (C_CRTSCTS(tty)) {
978 /* RTS flow control must be off to drop RTS for baud rate B0 */
979 if ((C_BAUD(tty)) != B0)
980 wflags |= TI_UART_ENABLE_RTS_IN;
981 wflags |= TI_UART_ENABLE_CTS_OUT;
982 } else {
983 ti_restart_read(tport, tty);
984 }
985
986 if (I_IXOFF(tty) || I_IXON(tty)) {
987 config->cXon = START_CHAR(tty);
988 config->cXoff = STOP_CHAR(tty);
989
990 if (I_IXOFF(tty))
991 wflags |= TI_UART_ENABLE_X_IN;
992 else
993 ti_restart_read(tport, tty);
994
995 if (I_IXON(tty))
996 wflags |= TI_UART_ENABLE_X_OUT;
997 }
998
999 baud = tty_get_baud_rate(tty);
1000 if (!baud)
1001 baud = 9600;
1002 if (tport->tp_tdev->td_is_3410)
1003 wbaudrate = (923077 + baud/2) / baud;
1004 else
1005 wbaudrate = (461538 + baud/2) / baud;
1006
1007 /* FIXME: Should calculate resulting baud here and report it back */
1008 if ((C_BAUD(tty)) != B0)
1009 tty_encode_baud_rate(tty, baud, baud);
1010
1011 dev_dbg(&port->dev,
1012 "%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d\n",
1013 __func__, baud, wbaudrate, wflags,
1014 config->bDataBits, config->bParity, config->bStopBits,
1015 config->cXon, config->cXoff, config->bUartMode);
1016
1017 config->wBaudRate = cpu_to_be16(wbaudrate);
1018 config->wFlags = cpu_to_be16(wflags);
1019
1020 status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
1021 (__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
1022 sizeof(*config));
1023 if (status)
1024 dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
1025 __func__, port_number, status);
1026
1027 /* SET_CONFIG asserts RTS and DTR, reset them correctly */
1028 mcr = tport->tp_shadow_mcr;
1029 /* if baud rate is B0, clear RTS and DTR */
1030 if (C_BAUD(tty) == B0)
1031 mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
1032 status = ti_set_mcr(tport, mcr);
1033 if (status)
1034 dev_err(&port->dev,
1035 "%s - cannot set modem control on port %d, %d\n",
1036 __func__, port_number, status);
1037
1038 kfree(config);
1039 }
1040
1041
ti_tiocmget(struct tty_struct * tty)1042 static int ti_tiocmget(struct tty_struct *tty)
1043 {
1044 struct usb_serial_port *port = tty->driver_data;
1045 struct ti_port *tport = usb_get_serial_port_data(port);
1046 unsigned int result;
1047 unsigned int msr;
1048 unsigned int mcr;
1049 unsigned long flags;
1050
1051 spin_lock_irqsave(&tport->tp_lock, flags);
1052 msr = tport->tp_msr;
1053 mcr = tport->tp_shadow_mcr;
1054 spin_unlock_irqrestore(&tport->tp_lock, flags);
1055
1056 result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
1057 | ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
1058 | ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
1059 | ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
1060 | ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
1061 | ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
1062 | ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
1063
1064 dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
1065
1066 return result;
1067 }
1068
1069
ti_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)1070 static int ti_tiocmset(struct tty_struct *tty,
1071 unsigned int set, unsigned int clear)
1072 {
1073 struct usb_serial_port *port = tty->driver_data;
1074 struct ti_port *tport = usb_get_serial_port_data(port);
1075 unsigned int mcr;
1076 unsigned long flags;
1077
1078 spin_lock_irqsave(&tport->tp_lock, flags);
1079 mcr = tport->tp_shadow_mcr;
1080
1081 if (set & TIOCM_RTS)
1082 mcr |= TI_MCR_RTS;
1083 if (set & TIOCM_DTR)
1084 mcr |= TI_MCR_DTR;
1085 if (set & TIOCM_LOOP)
1086 mcr |= TI_MCR_LOOP;
1087
1088 if (clear & TIOCM_RTS)
1089 mcr &= ~TI_MCR_RTS;
1090 if (clear & TIOCM_DTR)
1091 mcr &= ~TI_MCR_DTR;
1092 if (clear & TIOCM_LOOP)
1093 mcr &= ~TI_MCR_LOOP;
1094 spin_unlock_irqrestore(&tport->tp_lock, flags);
1095
1096 return ti_set_mcr(tport, mcr);
1097 }
1098
1099
ti_break(struct tty_struct * tty,int break_state)1100 static void ti_break(struct tty_struct *tty, int break_state)
1101 {
1102 struct usb_serial_port *port = tty->driver_data;
1103 struct ti_port *tport = usb_get_serial_port_data(port);
1104 int status;
1105
1106 dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
1107
1108 status = ti_write_byte(port, tport->tp_tdev,
1109 tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
1110 TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
1111
1112 if (status)
1113 dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
1114 }
1115
ti_get_port_from_code(unsigned char code)1116 static int ti_get_port_from_code(unsigned char code)
1117 {
1118 return (code >> 6) & 0x01;
1119 }
1120
ti_get_func_from_code(unsigned char code)1121 static int ti_get_func_from_code(unsigned char code)
1122 {
1123 return code & 0x0f;
1124 }
1125
ti_interrupt_callback(struct urb * urb)1126 static void ti_interrupt_callback(struct urb *urb)
1127 {
1128 struct ti_device *tdev = urb->context;
1129 struct usb_serial_port *port;
1130 struct usb_serial *serial = tdev->td_serial;
1131 struct ti_port *tport;
1132 struct device *dev = &urb->dev->dev;
1133 unsigned char *data = urb->transfer_buffer;
1134 int length = urb->actual_length;
1135 int port_number;
1136 int function;
1137 int status = urb->status;
1138 int retval;
1139 u8 msr;
1140
1141 switch (status) {
1142 case 0:
1143 break;
1144 case -ECONNRESET:
1145 case -ENOENT:
1146 case -ESHUTDOWN:
1147 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1148 return;
1149 default:
1150 dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
1151 goto exit;
1152 }
1153
1154 if (length != 2) {
1155 dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
1156 goto exit;
1157 }
1158
1159 if (data[0] == TI_CODE_HARDWARE_ERROR) {
1160 dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
1161 goto exit;
1162 }
1163
1164 port_number = ti_get_port_from_code(data[0]);
1165 function = ti_get_func_from_code(data[0]);
1166
1167 dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
1168 __func__, port_number, function, data[1]);
1169
1170 if (port_number >= serial->num_ports) {
1171 dev_err(dev, "%s - bad port number, %d\n",
1172 __func__, port_number);
1173 goto exit;
1174 }
1175
1176 port = serial->port[port_number];
1177
1178 tport = usb_get_serial_port_data(port);
1179 if (!tport)
1180 goto exit;
1181
1182 switch (function) {
1183 case TI_CODE_DATA_ERROR:
1184 dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
1185 __func__, port_number, data[1]);
1186 break;
1187
1188 case TI_CODE_MODEM_STATUS:
1189 msr = data[1];
1190 dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
1191 ti_handle_new_msr(tport, msr);
1192 break;
1193
1194 default:
1195 dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
1196 __func__, data[1]);
1197 break;
1198 }
1199
1200 exit:
1201 retval = usb_submit_urb(urb, GFP_ATOMIC);
1202 if (retval)
1203 dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1204 __func__, retval);
1205 }
1206
1207
ti_bulk_in_callback(struct urb * urb)1208 static void ti_bulk_in_callback(struct urb *urb)
1209 {
1210 struct ti_port *tport = urb->context;
1211 struct usb_serial_port *port = tport->tp_port;
1212 struct device *dev = &urb->dev->dev;
1213 int status = urb->status;
1214 unsigned long flags;
1215 int retval = 0;
1216
1217 switch (status) {
1218 case 0:
1219 break;
1220 case -ECONNRESET:
1221 case -ENOENT:
1222 case -ESHUTDOWN:
1223 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1224 return;
1225 default:
1226 dev_err(dev, "%s - nonzero urb status, %d\n",
1227 __func__, status);
1228 }
1229
1230 if (status == -EPIPE)
1231 goto exit;
1232
1233 if (status) {
1234 dev_err(dev, "%s - stopping read!\n", __func__);
1235 return;
1236 }
1237
1238 if (urb->actual_length) {
1239 usb_serial_debug_data(dev, __func__, urb->actual_length,
1240 urb->transfer_buffer);
1241
1242 if (!tport->tp_is_open)
1243 dev_dbg(dev, "%s - port closed, dropping data\n",
1244 __func__);
1245 else
1246 ti_recv(port, urb->transfer_buffer, urb->actual_length);
1247 spin_lock_irqsave(&tport->tp_lock, flags);
1248 port->icount.rx += urb->actual_length;
1249 spin_unlock_irqrestore(&tport->tp_lock, flags);
1250 }
1251
1252 exit:
1253 /* continue to read unless stopping */
1254 spin_lock_irqsave(&tport->tp_lock, flags);
1255 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1256 retval = usb_submit_urb(urb, GFP_ATOMIC);
1257 else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1258 tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1259
1260 spin_unlock_irqrestore(&tport->tp_lock, flags);
1261 if (retval)
1262 dev_err(dev, "%s - resubmit read urb failed, %d\n",
1263 __func__, retval);
1264 }
1265
1266
ti_bulk_out_callback(struct urb * urb)1267 static void ti_bulk_out_callback(struct urb *urb)
1268 {
1269 struct ti_port *tport = urb->context;
1270 struct usb_serial_port *port = tport->tp_port;
1271 int status = urb->status;
1272
1273 tport->tp_write_urb_in_use = 0;
1274
1275 switch (status) {
1276 case 0:
1277 break;
1278 case -ECONNRESET:
1279 case -ENOENT:
1280 case -ESHUTDOWN:
1281 dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1282 return;
1283 default:
1284 dev_err_console(port, "%s - nonzero urb status, %d\n",
1285 __func__, status);
1286 }
1287
1288 /* send any buffered data */
1289 ti_send(tport);
1290 }
1291
1292
ti_recv(struct usb_serial_port * port,unsigned char * data,int length)1293 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1294 int length)
1295 {
1296 int cnt;
1297
1298 do {
1299 cnt = tty_insert_flip_string(&port->port, data, length);
1300 if (cnt < length) {
1301 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1302 __func__, length - cnt);
1303 if (cnt == 0)
1304 break;
1305 }
1306 tty_flip_buffer_push(&port->port);
1307 data += cnt;
1308 length -= cnt;
1309 } while (length > 0);
1310 }
1311
1312
ti_send(struct ti_port * tport)1313 static void ti_send(struct ti_port *tport)
1314 {
1315 int count, result;
1316 struct usb_serial_port *port = tport->tp_port;
1317 unsigned long flags;
1318
1319 spin_lock_irqsave(&tport->tp_lock, flags);
1320
1321 if (tport->tp_write_urb_in_use)
1322 goto unlock;
1323
1324 count = kfifo_out(&port->write_fifo,
1325 port->write_urb->transfer_buffer,
1326 port->bulk_out_size);
1327
1328 if (count == 0)
1329 goto unlock;
1330
1331 tport->tp_write_urb_in_use = 1;
1332
1333 spin_unlock_irqrestore(&tport->tp_lock, flags);
1334
1335 usb_serial_debug_data(&port->dev, __func__, count,
1336 port->write_urb->transfer_buffer);
1337
1338 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1339 usb_sndbulkpipe(port->serial->dev,
1340 port->bulk_out_endpointAddress),
1341 port->write_urb->transfer_buffer, count,
1342 ti_bulk_out_callback, tport);
1343
1344 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1345 if (result) {
1346 dev_err_console(port, "%s - submit write urb failed, %d\n",
1347 __func__, result);
1348 tport->tp_write_urb_in_use = 0;
1349 /* TODO: reschedule ti_send */
1350 } else {
1351 spin_lock_irqsave(&tport->tp_lock, flags);
1352 port->icount.tx += count;
1353 spin_unlock_irqrestore(&tport->tp_lock, flags);
1354 }
1355
1356 /* more room in the buffer for new writes, wakeup */
1357 tty_port_tty_wakeup(&port->port);
1358
1359 return;
1360 unlock:
1361 spin_unlock_irqrestore(&tport->tp_lock, flags);
1362 return;
1363 }
1364
1365
ti_set_mcr(struct ti_port * tport,unsigned int mcr)1366 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1367 {
1368 unsigned long flags;
1369 int status;
1370
1371 status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1372 tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1373 TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1374
1375 spin_lock_irqsave(&tport->tp_lock, flags);
1376 if (!status)
1377 tport->tp_shadow_mcr = mcr;
1378 spin_unlock_irqrestore(&tport->tp_lock, flags);
1379
1380 return status;
1381 }
1382
1383
ti_get_lsr(struct ti_port * tport,u8 * lsr)1384 static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1385 {
1386 int size, status;
1387 struct ti_device *tdev = tport->tp_tdev;
1388 struct usb_serial_port *port = tport->tp_port;
1389 int port_number = port->port_number;
1390 struct ti_port_status *data;
1391
1392 size = sizeof(struct ti_port_status);
1393 data = kmalloc(size, GFP_KERNEL);
1394 if (!data)
1395 return -ENOMEM;
1396
1397 status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1398 (__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1399 if (status) {
1400 dev_err(&port->dev,
1401 "%s - get port status command failed, %d\n",
1402 __func__, status);
1403 goto free_data;
1404 }
1405
1406 dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1407
1408 *lsr = data->bLSR;
1409
1410 free_data:
1411 kfree(data);
1412 return status;
1413 }
1414
1415
ti_get_serial_info(struct ti_port * tport,struct serial_struct __user * ret_arg)1416 static int ti_get_serial_info(struct ti_port *tport,
1417 struct serial_struct __user *ret_arg)
1418 {
1419 struct usb_serial_port *port = tport->tp_port;
1420 struct serial_struct ret_serial;
1421 unsigned cwait;
1422
1423 cwait = port->port.closing_wait;
1424 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1425 cwait = jiffies_to_msecs(cwait) / 10;
1426
1427 memset(&ret_serial, 0, sizeof(ret_serial));
1428
1429 ret_serial.type = PORT_16550A;
1430 ret_serial.line = port->minor;
1431 ret_serial.port = port->port_number;
1432 ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1433 ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1434 ret_serial.closing_wait = cwait;
1435
1436 if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1437 return -EFAULT;
1438
1439 return 0;
1440 }
1441
1442
ti_set_serial_info(struct tty_struct * tty,struct ti_port * tport,struct serial_struct __user * new_arg)1443 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1444 struct serial_struct __user *new_arg)
1445 {
1446 struct serial_struct new_serial;
1447 unsigned cwait;
1448
1449 if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1450 return -EFAULT;
1451
1452 cwait = new_serial.closing_wait;
1453 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1454 cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1455
1456 tport->tp_port->port.closing_wait = cwait;
1457
1458 return 0;
1459 }
1460
1461
ti_handle_new_msr(struct ti_port * tport,u8 msr)1462 static void ti_handle_new_msr(struct ti_port *tport, u8 msr)
1463 {
1464 struct async_icount *icount;
1465 struct tty_struct *tty;
1466 unsigned long flags;
1467
1468 dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1469
1470 if (msr & TI_MSR_DELTA_MASK) {
1471 spin_lock_irqsave(&tport->tp_lock, flags);
1472 icount = &tport->tp_port->icount;
1473 if (msr & TI_MSR_DELTA_CTS)
1474 icount->cts++;
1475 if (msr & TI_MSR_DELTA_DSR)
1476 icount->dsr++;
1477 if (msr & TI_MSR_DELTA_CD)
1478 icount->dcd++;
1479 if (msr & TI_MSR_DELTA_RI)
1480 icount->rng++;
1481 wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1482 spin_unlock_irqrestore(&tport->tp_lock, flags);
1483 }
1484
1485 tport->tp_msr = msr & TI_MSR_MASK;
1486
1487 /* handle CTS flow control */
1488 tty = tty_port_tty_get(&tport->tp_port->port);
1489 if (tty && C_CRTSCTS(tty)) {
1490 if (msr & TI_MSR_CTS)
1491 tty_wakeup(tty);
1492 }
1493 tty_kref_put(tty);
1494 }
1495
1496
ti_stop_read(struct ti_port * tport,struct tty_struct * tty)1497 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1498 {
1499 unsigned long flags;
1500
1501 spin_lock_irqsave(&tport->tp_lock, flags);
1502
1503 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1504 tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1505
1506 spin_unlock_irqrestore(&tport->tp_lock, flags);
1507 }
1508
1509
ti_restart_read(struct ti_port * tport,struct tty_struct * tty)1510 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1511 {
1512 struct urb *urb;
1513 int status = 0;
1514 unsigned long flags;
1515
1516 spin_lock_irqsave(&tport->tp_lock, flags);
1517
1518 if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1519 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1520 urb = tport->tp_port->read_urb;
1521 spin_unlock_irqrestore(&tport->tp_lock, flags);
1522 urb->context = tport;
1523 status = usb_submit_urb(urb, GFP_KERNEL);
1524 } else {
1525 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1526 spin_unlock_irqrestore(&tport->tp_lock, flags);
1527 }
1528
1529 return status;
1530 }
1531
1532
ti_command_out_sync(struct ti_device * tdev,__u8 command,__u16 moduleid,__u16 value,__u8 * data,int size)1533 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1534 __u16 moduleid, __u16 value, __u8 *data, int size)
1535 {
1536 int status;
1537
1538 status = usb_control_msg(tdev->td_serial->dev,
1539 usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1540 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1541 value, moduleid, data, size, 1000);
1542
1543 if (status < 0)
1544 return status;
1545
1546 return 0;
1547 }
1548
1549
ti_command_in_sync(struct ti_device * tdev,__u8 command,__u16 moduleid,__u16 value,__u8 * data,int size)1550 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1551 __u16 moduleid, __u16 value, __u8 *data, int size)
1552 {
1553 int status;
1554
1555 status = usb_control_msg(tdev->td_serial->dev,
1556 usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1557 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1558 value, moduleid, data, size, 1000);
1559
1560 if (status == size)
1561 status = 0;
1562 else if (status >= 0)
1563 status = -ECOMM;
1564
1565 return status;
1566 }
1567
1568
ti_write_byte(struct usb_serial_port * port,struct ti_device * tdev,unsigned long addr,u8 mask,u8 byte)1569 static int ti_write_byte(struct usb_serial_port *port,
1570 struct ti_device *tdev, unsigned long addr,
1571 u8 mask, u8 byte)
1572 {
1573 int status;
1574 unsigned int size;
1575 struct ti_write_data_bytes *data;
1576
1577 dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1578 addr, mask, byte);
1579
1580 size = sizeof(struct ti_write_data_bytes) + 2;
1581 data = kmalloc(size, GFP_KERNEL);
1582 if (!data)
1583 return -ENOMEM;
1584
1585 data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1586 data->bDataType = TI_RW_DATA_BYTE;
1587 data->bDataCounter = 1;
1588 data->wBaseAddrHi = cpu_to_be16(addr>>16);
1589 data->wBaseAddrLo = cpu_to_be16(addr);
1590 data->bData[0] = mask;
1591 data->bData[1] = byte;
1592
1593 status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1594 (__u8 *)data, size);
1595
1596 if (status < 0)
1597 dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1598
1599 kfree(data);
1600
1601 return status;
1602 }
1603
ti_do_download(struct usb_device * dev,int pipe,u8 * buffer,int size)1604 static int ti_do_download(struct usb_device *dev, int pipe,
1605 u8 *buffer, int size)
1606 {
1607 int pos;
1608 u8 cs = 0;
1609 int done;
1610 struct ti_firmware_header *header;
1611 int status = 0;
1612 int len;
1613
1614 for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1615 cs = (u8)(cs + buffer[pos]);
1616
1617 header = (struct ti_firmware_header *)buffer;
1618 header->wLength = cpu_to_le16(size - sizeof(*header));
1619 header->bCheckSum = cs;
1620
1621 dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1622 for (pos = 0; pos < size; pos += done) {
1623 len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1624 status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1625 &done, 1000);
1626 if (status)
1627 break;
1628 }
1629 return status;
1630 }
1631
ti_download_firmware(struct ti_device * tdev)1632 static int ti_download_firmware(struct ti_device *tdev)
1633 {
1634 int status;
1635 int buffer_size;
1636 u8 *buffer;
1637 struct usb_device *dev = tdev->td_serial->dev;
1638 unsigned int pipe = usb_sndbulkpipe(dev,
1639 tdev->td_serial->port[0]->bulk_out_endpointAddress);
1640 const struct firmware *fw_p;
1641 char buf[32];
1642
1643 if (le16_to_cpu(dev->descriptor.idVendor) == MXU1_VENDOR_ID) {
1644 snprintf(buf,
1645 sizeof(buf),
1646 "moxa/moxa-%04x.fw",
1647 le16_to_cpu(dev->descriptor.idProduct));
1648
1649 status = request_firmware(&fw_p, buf, &dev->dev);
1650 goto check_firmware;
1651 }
1652
1653 /* try ID specific firmware first, then try generic firmware */
1654 sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1655 le16_to_cpu(dev->descriptor.idVendor),
1656 le16_to_cpu(dev->descriptor.idProduct));
1657 status = request_firmware(&fw_p, buf, &dev->dev);
1658
1659 if (status != 0) {
1660 buf[0] = '\0';
1661 if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1662 switch (le16_to_cpu(dev->descriptor.idProduct)) {
1663 case MTS_CDMA_PRODUCT_ID:
1664 strcpy(buf, "mts_cdma.fw");
1665 break;
1666 case MTS_GSM_PRODUCT_ID:
1667 strcpy(buf, "mts_gsm.fw");
1668 break;
1669 case MTS_EDGE_PRODUCT_ID:
1670 strcpy(buf, "mts_edge.fw");
1671 break;
1672 case MTS_MT9234MU_PRODUCT_ID:
1673 strcpy(buf, "mts_mt9234mu.fw");
1674 break;
1675 case MTS_MT9234ZBA_PRODUCT_ID:
1676 strcpy(buf, "mts_mt9234zba.fw");
1677 break;
1678 case MTS_MT9234ZBAOLD_PRODUCT_ID:
1679 strcpy(buf, "mts_mt9234zba.fw");
1680 break; }
1681 }
1682 if (buf[0] == '\0') {
1683 if (tdev->td_is_3410)
1684 strcpy(buf, "ti_3410.fw");
1685 else
1686 strcpy(buf, "ti_5052.fw");
1687 }
1688 status = request_firmware(&fw_p, buf, &dev->dev);
1689 }
1690
1691 check_firmware:
1692 if (status) {
1693 dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1694 return -ENOENT;
1695 }
1696 if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1697 dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1698 release_firmware(fw_p);
1699 return -ENOENT;
1700 }
1701
1702 buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1703 buffer = kmalloc(buffer_size, GFP_KERNEL);
1704 if (buffer) {
1705 memcpy(buffer, fw_p->data, fw_p->size);
1706 memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1707 status = ti_do_download(dev, pipe, buffer, fw_p->size);
1708 kfree(buffer);
1709 } else {
1710 status = -ENOMEM;
1711 }
1712 release_firmware(fw_p);
1713 if (status) {
1714 dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1715 __func__, status);
1716 return status;
1717 }
1718
1719 dev_dbg(&dev->dev, "%s - download successful\n", __func__);
1720
1721 return 0;
1722 }
1723