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