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