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