3 * TI 3410/5052 USB Serial Driver
5 * Copyright (C) 2004 Texas Instruments
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
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * For questions or problems with this driver, contact Texas Instruments
17 * technical support, or Al Borchers <alborchers@steinerpoint.com>, or
18 * Peter Berger <pberger@brimson.com>.
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23 #include <linux/firmware.h>
24 #include <linux/slab.h>
25 #include <linux/tty.h>
26 #include <linux/tty_driver.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/spinlock.h>
30 #include <linux/ioctl.h>
31 #include <linux/serial.h>
32 #include <linux/kfifo.h>
33 #include <linux/mutex.h>
34 #include <linux/uaccess.h>
35 #include <linux/usb.h>
36 #include <linux/usb/serial.h>
38 #include "ti_usb_3410_5052.h"
42 #define TI_DRIVER_AUTHOR "Al Borchers <alborchers@steinerpoint.com>"
43 #define TI_DRIVER_DESC "TI USB 3410/5052 Serial Driver"
45 #define TI_FIRMWARE_BUF_SIZE 16284
47 #define TI_TRANSFER_TIMEOUT 2
49 #define TI_DEFAULT_CLOSING_WAIT 4000 /* in .01 secs */
51 /* supported setserial flags */
52 #define TI_SET_SERIAL_FLAGS 0
55 #define TI_READ_URB_RUNNING 0
56 #define TI_READ_URB_STOPPING 1
57 #define TI_READ_URB_STOPPED 2
59 #define TI_EXTRA_VID_PID_COUNT 5
68 __u8 tp_uart_mode; /* 232 or 485 modes */
69 unsigned int tp_uart_base_addr;
71 struct ti_device *tp_tdev;
72 struct usb_serial_port *tp_port;
74 int tp_read_urb_state;
75 int tp_write_urb_in_use;
79 struct mutex td_open_close_lock;
80 int td_open_port_count;
81 struct usb_serial *td_serial;
87 /* Function Declarations */
89 static int ti_startup(struct usb_serial *serial);
90 static void ti_release(struct usb_serial *serial);
91 static int ti_port_probe(struct usb_serial_port *port);
92 static int ti_port_remove(struct usb_serial_port *port);
93 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port);
94 static void ti_close(struct usb_serial_port *port);
95 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
96 const unsigned char *data, int count);
97 static int ti_write_room(struct tty_struct *tty);
98 static int ti_chars_in_buffer(struct tty_struct *tty);
99 static bool ti_tx_empty(struct usb_serial_port *port);
100 static void ti_throttle(struct tty_struct *tty);
101 static void ti_unthrottle(struct tty_struct *tty);
102 static int ti_ioctl(struct tty_struct *tty,
103 unsigned int cmd, unsigned long arg);
104 static void ti_set_termios(struct tty_struct *tty,
105 struct usb_serial_port *port, struct ktermios *old_termios);
106 static int ti_tiocmget(struct tty_struct *tty);
107 static int ti_tiocmset(struct tty_struct *tty,
108 unsigned int set, unsigned int clear);
109 static void ti_break(struct tty_struct *tty, int break_state);
110 static void ti_interrupt_callback(struct urb *urb);
111 static void ti_bulk_in_callback(struct urb *urb);
112 static void ti_bulk_out_callback(struct urb *urb);
114 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
116 static void ti_send(struct ti_port *tport);
117 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr);
118 static int ti_get_lsr(struct ti_port *tport, u8 *lsr);
119 static int ti_get_serial_info(struct ti_port *tport,
120 struct serial_struct __user *ret_arg);
121 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
122 struct serial_struct __user *new_arg);
123 static void ti_handle_new_msr(struct ti_port *tport, __u8 msr);
125 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty);
126 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty);
128 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
129 __u16 moduleid, __u16 value, __u8 *data, int size);
130 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
131 __u16 moduleid, __u16 value, __u8 *data, int size);
133 static int ti_write_byte(struct usb_serial_port *port, struct ti_device *tdev,
134 unsigned long addr, __u8 mask, __u8 byte);
136 static int ti_download_firmware(struct ti_device *tdev);
141 /* module parameters */
142 static int closing_wait = TI_DEFAULT_CLOSING_WAIT;
144 /* supported devices */
145 static const struct usb_device_id ti_id_table_3410[] = {
146 { USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
147 { USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
148 { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
149 { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
150 { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
151 { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
152 { USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
153 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
154 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
155 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
156 { USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
157 { USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
158 { USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
159 { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STEREO_PLUG_ID) },
160 { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
161 { USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
162 { USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
166 static const struct usb_device_id ti_id_table_5052[] = {
167 { USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
168 { USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
169 { USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
170 { USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
174 static const struct usb_device_id ti_id_table_combined[] = {
175 { USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
176 { USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
177 { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
178 { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
179 { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
180 { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
181 { USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
182 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
183 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
184 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
185 { USB_DEVICE(TI_VENDOR_ID, TI_5052_BOOT_PRODUCT_ID) },
186 { USB_DEVICE(TI_VENDOR_ID, TI_5152_BOOT_PRODUCT_ID) },
187 { USB_DEVICE(TI_VENDOR_ID, TI_5052_EEPROM_PRODUCT_ID) },
188 { USB_DEVICE(TI_VENDOR_ID, TI_5052_FIRMWARE_PRODUCT_ID) },
189 { USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
190 { USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
191 { USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
192 { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_PRODUCT_ID) },
193 { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
194 { USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
195 { USB_DEVICE(HONEYWELL_VENDOR_ID, HONEYWELL_HGI80_PRODUCT_ID) },
199 static struct usb_serial_driver ti_1port_device = {
201 .owner = THIS_MODULE,
202 .name = "ti_usb_3410_5052_1",
204 .description = "TI USB 3410 1 port adapter",
205 .id_table = ti_id_table_3410,
207 .attach = ti_startup,
208 .release = ti_release,
209 .port_probe = ti_port_probe,
210 .port_remove = ti_port_remove,
214 .write_room = ti_write_room,
215 .chars_in_buffer = ti_chars_in_buffer,
216 .tx_empty = ti_tx_empty,
217 .throttle = ti_throttle,
218 .unthrottle = ti_unthrottle,
220 .set_termios = ti_set_termios,
221 .tiocmget = ti_tiocmget,
222 .tiocmset = ti_tiocmset,
223 .tiocmiwait = usb_serial_generic_tiocmiwait,
224 .get_icount = usb_serial_generic_get_icount,
225 .break_ctl = ti_break,
226 .read_int_callback = ti_interrupt_callback,
227 .read_bulk_callback = ti_bulk_in_callback,
228 .write_bulk_callback = ti_bulk_out_callback,
231 static struct usb_serial_driver ti_2port_device = {
233 .owner = THIS_MODULE,
234 .name = "ti_usb_3410_5052_2",
236 .description = "TI USB 5052 2 port adapter",
237 .id_table = ti_id_table_5052,
239 .attach = ti_startup,
240 .release = ti_release,
241 .port_probe = ti_port_probe,
242 .port_remove = ti_port_remove,
246 .write_room = ti_write_room,
247 .chars_in_buffer = ti_chars_in_buffer,
248 .tx_empty = ti_tx_empty,
249 .throttle = ti_throttle,
250 .unthrottle = ti_unthrottle,
252 .set_termios = ti_set_termios,
253 .tiocmget = ti_tiocmget,
254 .tiocmset = ti_tiocmset,
255 .tiocmiwait = usb_serial_generic_tiocmiwait,
256 .get_icount = usb_serial_generic_get_icount,
257 .break_ctl = ti_break,
258 .read_int_callback = ti_interrupt_callback,
259 .read_bulk_callback = ti_bulk_in_callback,
260 .write_bulk_callback = ti_bulk_out_callback,
263 static struct usb_serial_driver * const serial_drivers[] = {
264 &ti_1port_device, &ti_2port_device, NULL
269 MODULE_AUTHOR(TI_DRIVER_AUTHOR);
270 MODULE_DESCRIPTION(TI_DRIVER_DESC);
271 MODULE_LICENSE("GPL");
275 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
276 MODULE_PARM_DESC(closing_wait,
277 "Maximum wait for data to drain in close, in .01 secs, default is 4000");
279 MODULE_DEVICE_TABLE(usb, ti_id_table_combined);
281 module_usb_serial_driver(serial_drivers, ti_id_table_combined);
285 static int ti_startup(struct usb_serial *serial)
287 struct ti_device *tdev;
288 struct usb_device *dev = serial->dev;
292 "%s - product 0x%4X, num configurations %d, configuration value %d\n",
293 __func__, le16_to_cpu(dev->descriptor.idProduct),
294 dev->descriptor.bNumConfigurations,
295 dev->actconfig->desc.bConfigurationValue);
297 /* create device structure */
298 tdev = kzalloc(sizeof(struct ti_device), GFP_KERNEL);
302 mutex_init(&tdev->td_open_close_lock);
303 tdev->td_serial = serial;
304 usb_set_serial_data(serial, tdev);
306 /* determine device type */
307 if (serial->type == &ti_1port_device)
308 tdev->td_is_3410 = 1;
309 dev_dbg(&dev->dev, "%s - device type is %s\n", __func__,
310 tdev->td_is_3410 ? "3410" : "5052");
312 /* if we have only 1 configuration, download firmware */
313 if (dev->descriptor.bNumConfigurations == 1) {
314 status = ti_download_firmware(tdev);
319 /* 3410 must be reset, 5052 resets itself */
320 if (tdev->td_is_3410) {
321 msleep_interruptible(100);
322 usb_reset_device(dev);
329 /* the second configuration must be set */
330 if (dev->actconfig->desc.bConfigurationValue == TI_BOOT_CONFIG) {
331 status = usb_driver_set_configuration(dev, TI_ACTIVE_CONFIG);
332 status = status ? status : -ENODEV;
336 if (serial->num_bulk_in < serial->num_ports ||
337 serial->num_bulk_out < serial->num_ports) {
338 dev_err(&serial->interface->dev, "missing endpoints\n");
347 usb_set_serial_data(serial, NULL);
352 static void ti_release(struct usb_serial *serial)
354 struct ti_device *tdev = usb_get_serial_data(serial);
359 static int ti_port_probe(struct usb_serial_port *port)
361 struct ti_port *tport;
363 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
367 spin_lock_init(&tport->tp_lock);
368 if (port == port->serial->port[0])
369 tport->tp_uart_base_addr = TI_UART1_BASE_ADDR;
371 tport->tp_uart_base_addr = TI_UART2_BASE_ADDR;
372 port->port.closing_wait = msecs_to_jiffies(10 * closing_wait);
373 tport->tp_port = port;
374 tport->tp_tdev = usb_get_serial_data(port->serial);
375 tport->tp_uart_mode = 0; /* default is RS232 */
377 usb_set_serial_port_data(port, tport);
379 port->port.drain_delay = 3;
384 static int ti_port_remove(struct usb_serial_port *port)
386 struct ti_port *tport;
388 tport = usb_get_serial_port_data(port);
394 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
396 struct ti_port *tport = usb_get_serial_port_data(port);
397 struct ti_device *tdev;
398 struct usb_device *dev;
402 __u16 open_settings = (__u8)(TI_PIPE_MODE_CONTINOUS |
403 TI_PIPE_TIMEOUT_ENABLE |
404 (TI_TRANSFER_TIMEOUT << 2));
409 dev = port->serial->dev;
410 tdev = tport->tp_tdev;
412 /* only one open on any port on a device at a time */
413 if (mutex_lock_interruptible(&tdev->td_open_close_lock))
416 port_number = port->port_number;
419 tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
421 /* start interrupt urb the first time a port is opened on this device */
422 if (tdev->td_open_port_count == 0) {
423 dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
424 urb = tdev->td_serial->port[0]->interrupt_in_urb;
426 dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
431 status = usb_submit_urb(urb, GFP_KERNEL);
433 dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
439 ti_set_termios(tty, port, &tty->termios);
441 dev_dbg(&port->dev, "%s - sending TI_OPEN_PORT\n", __func__);
442 status = ti_command_out_sync(tdev, TI_OPEN_PORT,
443 (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
445 dev_err(&port->dev, "%s - cannot send open command, %d\n",
450 dev_dbg(&port->dev, "%s - sending TI_START_PORT\n", __func__);
451 status = ti_command_out_sync(tdev, TI_START_PORT,
452 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
454 dev_err(&port->dev, "%s - cannot send start command, %d\n",
459 dev_dbg(&port->dev, "%s - sending TI_PURGE_PORT\n", __func__);
460 status = ti_command_out_sync(tdev, TI_PURGE_PORT,
461 (__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
463 dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
467 status = ti_command_out_sync(tdev, TI_PURGE_PORT,
468 (__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
470 dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
475 /* reset the data toggle on the bulk endpoints to work around bug in
476 * host controllers where things get out of sync some times */
477 usb_clear_halt(dev, port->write_urb->pipe);
478 usb_clear_halt(dev, port->read_urb->pipe);
481 ti_set_termios(tty, port, &tty->termios);
483 dev_dbg(&port->dev, "%s - sending TI_OPEN_PORT (2)\n", __func__);
484 status = ti_command_out_sync(tdev, TI_OPEN_PORT,
485 (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
487 dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
492 dev_dbg(&port->dev, "%s - sending TI_START_PORT (2)\n", __func__);
493 status = ti_command_out_sync(tdev, TI_START_PORT,
494 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
496 dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
502 dev_dbg(&port->dev, "%s - start read urb\n", __func__);
503 urb = port->read_urb;
505 dev_err(&port->dev, "%s - no read urb\n", __func__);
509 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
510 urb->context = tport;
511 status = usb_submit_urb(urb, GFP_KERNEL);
513 dev_err(&port->dev, "%s - submit read urb failed, %d\n",
518 tport->tp_is_open = 1;
519 ++tdev->td_open_port_count;
524 if (tdev->td_open_port_count == 0)
525 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
527 mutex_unlock(&tdev->td_open_close_lock);
528 dev_dbg(&port->dev, "%s - exit %d\n", __func__, status);
533 static void ti_close(struct usb_serial_port *port)
535 struct ti_device *tdev;
536 struct ti_port *tport;
541 tdev = usb_get_serial_data(port->serial);
542 tport = usb_get_serial_port_data(port);
543 if (tdev == NULL || tport == NULL)
546 tport->tp_is_open = 0;
548 usb_kill_urb(port->read_urb);
549 usb_kill_urb(port->write_urb);
550 tport->tp_write_urb_in_use = 0;
551 spin_lock_irqsave(&tport->tp_lock, flags);
552 kfifo_reset_out(&port->write_fifo);
553 spin_unlock_irqrestore(&tport->tp_lock, flags);
555 port_number = port->port_number;
557 dev_dbg(&port->dev, "%s - sending TI_CLOSE_PORT\n", __func__);
558 status = ti_command_out_sync(tdev, TI_CLOSE_PORT,
559 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
562 "%s - cannot send close port command, %d\n"
565 mutex_lock(&tdev->td_open_close_lock);
566 --tport->tp_tdev->td_open_port_count;
567 if (tport->tp_tdev->td_open_port_count == 0) {
568 /* last port is closed, shut down interrupt urb */
569 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
571 mutex_unlock(&tdev->td_open_close_lock);
575 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
576 const unsigned char *data, int count)
578 struct ti_port *tport = usb_get_serial_port_data(port);
581 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
585 if (tport == NULL || !tport->tp_is_open)
588 count = kfifo_in_locked(&port->write_fifo, data, count,
596 static int ti_write_room(struct tty_struct *tty)
598 struct usb_serial_port *port = tty->driver_data;
599 struct ti_port *tport = usb_get_serial_port_data(port);
606 spin_lock_irqsave(&tport->tp_lock, flags);
607 room = kfifo_avail(&port->write_fifo);
608 spin_unlock_irqrestore(&tport->tp_lock, flags);
610 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
615 static int ti_chars_in_buffer(struct tty_struct *tty)
617 struct usb_serial_port *port = tty->driver_data;
618 struct ti_port *tport = usb_get_serial_port_data(port);
625 spin_lock_irqsave(&tport->tp_lock, flags);
626 chars = kfifo_len(&port->write_fifo);
627 spin_unlock_irqrestore(&tport->tp_lock, flags);
629 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
633 static bool ti_tx_empty(struct usb_serial_port *port)
635 struct ti_port *tport = usb_get_serial_port_data(port);
639 ret = ti_get_lsr(tport, &lsr);
640 if (!ret && !(lsr & TI_LSR_TX_EMPTY))
646 static void ti_throttle(struct tty_struct *tty)
648 struct usb_serial_port *port = tty->driver_data;
649 struct ti_port *tport = usb_get_serial_port_data(port);
654 if (I_IXOFF(tty) || C_CRTSCTS(tty))
655 ti_stop_read(tport, tty);
660 static void ti_unthrottle(struct tty_struct *tty)
662 struct usb_serial_port *port = tty->driver_data;
663 struct ti_port *tport = usb_get_serial_port_data(port);
669 if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
670 status = ti_restart_read(tport, tty);
672 dev_err(&port->dev, "%s - cannot restart read, %d\n",
677 static int ti_ioctl(struct tty_struct *tty,
678 unsigned int cmd, unsigned long arg)
680 struct usb_serial_port *port = tty->driver_data;
681 struct ti_port *tport = usb_get_serial_port_data(port);
688 dev_dbg(&port->dev, "%s - TIOCGSERIAL\n", __func__);
689 return ti_get_serial_info(tport,
690 (struct serial_struct __user *)arg);
692 dev_dbg(&port->dev, "%s - TIOCSSERIAL\n", __func__);
693 return ti_set_serial_info(tty, tport,
694 (struct serial_struct __user *)arg);
700 static void ti_set_termios(struct tty_struct *tty,
701 struct usb_serial_port *port, struct ktermios *old_termios)
703 struct ti_port *tport = usb_get_serial_port_data(port);
704 struct ti_uart_config *config;
705 tcflag_t cflag, iflag;
708 int port_number = port->port_number;
711 cflag = tty->termios.c_cflag;
712 iflag = tty->termios.c_iflag;
714 dev_dbg(&port->dev, "%s - cflag %08x, iflag %08x\n", __func__, cflag, iflag);
715 dev_dbg(&port->dev, "%s - old clfag %08x, old iflag %08x\n", __func__,
716 old_termios->c_cflag, old_termios->c_iflag);
721 config = kmalloc(sizeof(*config), GFP_KERNEL);
727 /* these flags must be set */
728 config->wFlags |= TI_UART_ENABLE_MS_INTS;
729 config->wFlags |= TI_UART_ENABLE_AUTO_START_DMA;
730 config->bUartMode = (__u8)(tport->tp_uart_mode);
732 switch (cflag & CSIZE) {
734 config->bDataBits = TI_UART_5_DATA_BITS;
737 config->bDataBits = TI_UART_6_DATA_BITS;
740 config->bDataBits = TI_UART_7_DATA_BITS;
744 config->bDataBits = TI_UART_8_DATA_BITS;
748 /* CMSPAR isn't supported by this driver */
749 tty->termios.c_cflag &= ~CMSPAR;
751 if (cflag & PARENB) {
752 if (cflag & PARODD) {
753 config->wFlags |= TI_UART_ENABLE_PARITY_CHECKING;
754 config->bParity = TI_UART_ODD_PARITY;
756 config->wFlags |= TI_UART_ENABLE_PARITY_CHECKING;
757 config->bParity = TI_UART_EVEN_PARITY;
760 config->wFlags &= ~TI_UART_ENABLE_PARITY_CHECKING;
761 config->bParity = TI_UART_NO_PARITY;
765 config->bStopBits = TI_UART_2_STOP_BITS;
767 config->bStopBits = TI_UART_1_STOP_BITS;
769 if (cflag & CRTSCTS) {
770 /* RTS flow control must be off to drop RTS for baud rate B0 */
771 if ((cflag & CBAUD) != B0)
772 config->wFlags |= TI_UART_ENABLE_RTS_IN;
773 config->wFlags |= TI_UART_ENABLE_CTS_OUT;
775 ti_restart_read(tport, tty);
778 if (I_IXOFF(tty) || I_IXON(tty)) {
779 config->cXon = START_CHAR(tty);
780 config->cXoff = STOP_CHAR(tty);
783 config->wFlags |= TI_UART_ENABLE_X_IN;
785 ti_restart_read(tport, tty);
788 config->wFlags |= TI_UART_ENABLE_X_OUT;
791 baud = tty_get_baud_rate(tty);
794 if (tport->tp_tdev->td_is_3410)
795 config->wBaudRate = (__u16)((923077 + baud/2) / baud);
797 config->wBaudRate = (__u16)((461538 + baud/2) / baud);
799 /* FIXME: Should calculate resulting baud here and report it back */
800 if ((cflag & CBAUD) != B0)
801 tty_encode_baud_rate(tty, baud, baud);
804 "%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d\n",
805 __func__, baud, config->wBaudRate, config->wFlags,
806 config->bDataBits, config->bParity, config->bStopBits,
807 config->cXon, config->cXoff, config->bUartMode);
809 cpu_to_be16s(&config->wBaudRate);
810 cpu_to_be16s(&config->wFlags);
812 status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
813 (__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
816 dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
817 __func__, port_number, status);
819 /* SET_CONFIG asserts RTS and DTR, reset them correctly */
820 mcr = tport->tp_shadow_mcr;
821 /* if baud rate is B0, clear RTS and DTR */
822 if ((cflag & CBAUD) == B0)
823 mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
824 status = ti_set_mcr(tport, mcr);
827 "%s - cannot set modem control on port %d, %d\n",
828 __func__, port_number, status);
834 static int ti_tiocmget(struct tty_struct *tty)
836 struct usb_serial_port *port = tty->driver_data;
837 struct ti_port *tport = usb_get_serial_port_data(port);
846 spin_lock_irqsave(&tport->tp_lock, flags);
848 mcr = tport->tp_shadow_mcr;
849 spin_unlock_irqrestore(&tport->tp_lock, flags);
851 result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
852 | ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
853 | ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
854 | ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
855 | ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
856 | ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
857 | ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
859 dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
865 static int ti_tiocmset(struct tty_struct *tty,
866 unsigned int set, unsigned int clear)
868 struct usb_serial_port *port = tty->driver_data;
869 struct ti_port *tport = usb_get_serial_port_data(port);
876 spin_lock_irqsave(&tport->tp_lock, flags);
877 mcr = tport->tp_shadow_mcr;
883 if (set & TIOCM_LOOP)
886 if (clear & TIOCM_RTS)
888 if (clear & TIOCM_DTR)
890 if (clear & TIOCM_LOOP)
892 spin_unlock_irqrestore(&tport->tp_lock, flags);
894 return ti_set_mcr(tport, mcr);
898 static void ti_break(struct tty_struct *tty, int break_state)
900 struct usb_serial_port *port = tty->driver_data;
901 struct ti_port *tport = usb_get_serial_port_data(port);
904 dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
909 status = ti_write_byte(port, tport->tp_tdev,
910 tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
911 TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
914 dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
918 static void ti_interrupt_callback(struct urb *urb)
920 struct ti_device *tdev = urb->context;
921 struct usb_serial_port *port;
922 struct usb_serial *serial = tdev->td_serial;
923 struct ti_port *tport;
924 struct device *dev = &urb->dev->dev;
925 unsigned char *data = urb->transfer_buffer;
926 int length = urb->actual_length;
929 int status = urb->status;
939 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
940 tdev->td_urb_error = 1;
943 dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
944 tdev->td_urb_error = 1;
949 dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
953 if (data[0] == TI_CODE_HARDWARE_ERROR) {
954 dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
958 port_number = TI_GET_PORT_FROM_CODE(data[0]);
959 function = TI_GET_FUNC_FROM_CODE(data[0]);
961 dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
962 __func__, port_number, function, data[1]);
964 if (port_number >= serial->num_ports) {
965 dev_err(dev, "%s - bad port number, %d\n",
966 __func__, port_number);
970 port = serial->port[port_number];
972 tport = usb_get_serial_port_data(port);
977 case TI_CODE_DATA_ERROR:
978 dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
979 __func__, port_number, data[1]);
982 case TI_CODE_MODEM_STATUS:
984 dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
985 ti_handle_new_msr(tport, msr);
989 dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
995 retval = usb_submit_urb(urb, GFP_ATOMIC);
997 dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1002 static void ti_bulk_in_callback(struct urb *urb)
1004 struct ti_port *tport = urb->context;
1005 struct usb_serial_port *port = tport->tp_port;
1006 struct device *dev = &urb->dev->dev;
1007 int status = urb->status;
1016 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1017 tport->tp_tdev->td_urb_error = 1;
1020 dev_err(dev, "%s - nonzero urb status, %d\n",
1022 tport->tp_tdev->td_urb_error = 1;
1025 if (status == -EPIPE)
1029 dev_err(dev, "%s - stopping read!\n", __func__);
1033 if (urb->actual_length) {
1034 usb_serial_debug_data(dev, __func__, urb->actual_length,
1035 urb->transfer_buffer);
1037 if (!tport->tp_is_open)
1038 dev_dbg(dev, "%s - port closed, dropping data\n",
1041 ti_recv(port, urb->transfer_buffer, urb->actual_length);
1042 spin_lock(&tport->tp_lock);
1043 port->icount.rx += urb->actual_length;
1044 spin_unlock(&tport->tp_lock);
1048 /* continue to read unless stopping */
1049 spin_lock(&tport->tp_lock);
1050 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1051 retval = usb_submit_urb(urb, GFP_ATOMIC);
1052 else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1053 tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1055 spin_unlock(&tport->tp_lock);
1057 dev_err(dev, "%s - resubmit read urb failed, %d\n",
1062 static void ti_bulk_out_callback(struct urb *urb)
1064 struct ti_port *tport = urb->context;
1065 struct usb_serial_port *port = tport->tp_port;
1066 int status = urb->status;
1068 tport->tp_write_urb_in_use = 0;
1076 dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1077 tport->tp_tdev->td_urb_error = 1;
1080 dev_err_console(port, "%s - nonzero urb status, %d\n",
1082 tport->tp_tdev->td_urb_error = 1;
1085 /* send any buffered data */
1090 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1096 cnt = tty_insert_flip_string(&port->port, data, length);
1098 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1099 __func__, length - cnt);
1103 tty_flip_buffer_push(&port->port);
1106 } while (length > 0);
1110 static void ti_send(struct ti_port *tport)
1113 struct usb_serial_port *port = tport->tp_port;
1114 unsigned long flags;
1116 spin_lock_irqsave(&tport->tp_lock, flags);
1118 if (tport->tp_write_urb_in_use)
1121 count = kfifo_out(&port->write_fifo,
1122 port->write_urb->transfer_buffer,
1123 port->bulk_out_size);
1128 tport->tp_write_urb_in_use = 1;
1130 spin_unlock_irqrestore(&tport->tp_lock, flags);
1132 usb_serial_debug_data(&port->dev, __func__, count,
1133 port->write_urb->transfer_buffer);
1135 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1136 usb_sndbulkpipe(port->serial->dev,
1137 port->bulk_out_endpointAddress),
1138 port->write_urb->transfer_buffer, count,
1139 ti_bulk_out_callback, tport);
1141 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1143 dev_err_console(port, "%s - submit write urb failed, %d\n",
1145 tport->tp_write_urb_in_use = 0;
1146 /* TODO: reschedule ti_send */
1148 spin_lock_irqsave(&tport->tp_lock, flags);
1149 port->icount.tx += count;
1150 spin_unlock_irqrestore(&tport->tp_lock, flags);
1153 /* more room in the buffer for new writes, wakeup */
1154 tty_port_tty_wakeup(&port->port);
1158 spin_unlock_irqrestore(&tport->tp_lock, flags);
1163 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1165 unsigned long flags;
1168 status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1169 tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1170 TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1172 spin_lock_irqsave(&tport->tp_lock, flags);
1174 tport->tp_shadow_mcr = mcr;
1175 spin_unlock_irqrestore(&tport->tp_lock, flags);
1181 static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1184 struct ti_device *tdev = tport->tp_tdev;
1185 struct usb_serial_port *port = tport->tp_port;
1186 int port_number = port->port_number;
1187 struct ti_port_status *data;
1189 size = sizeof(struct ti_port_status);
1190 data = kmalloc(size, GFP_KERNEL);
1194 status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1195 (__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1198 "%s - get port status command failed, %d\n",
1203 dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1213 static int ti_get_serial_info(struct ti_port *tport,
1214 struct serial_struct __user *ret_arg)
1216 struct usb_serial_port *port = tport->tp_port;
1217 struct serial_struct ret_serial;
1223 cwait = port->port.closing_wait;
1224 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1225 cwait = jiffies_to_msecs(cwait) / 10;
1227 memset(&ret_serial, 0, sizeof(ret_serial));
1229 ret_serial.type = PORT_16550A;
1230 ret_serial.line = port->minor;
1231 ret_serial.port = port->port_number;
1232 ret_serial.flags = tport->tp_flags;
1233 ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1234 ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1235 ret_serial.closing_wait = cwait;
1237 if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1244 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1245 struct serial_struct __user *new_arg)
1247 struct serial_struct new_serial;
1250 if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1253 cwait = new_serial.closing_wait;
1254 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1255 cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1257 tport->tp_flags = new_serial.flags & TI_SET_SERIAL_FLAGS;
1258 tport->tp_port->port.closing_wait = cwait;
1264 static void ti_handle_new_msr(struct ti_port *tport, __u8 msr)
1266 struct async_icount *icount;
1267 struct tty_struct *tty;
1268 unsigned long flags;
1270 dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1272 if (msr & TI_MSR_DELTA_MASK) {
1273 spin_lock_irqsave(&tport->tp_lock, flags);
1274 icount = &tport->tp_port->icount;
1275 if (msr & TI_MSR_DELTA_CTS)
1277 if (msr & TI_MSR_DELTA_DSR)
1279 if (msr & TI_MSR_DELTA_CD)
1281 if (msr & TI_MSR_DELTA_RI)
1283 wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1284 spin_unlock_irqrestore(&tport->tp_lock, flags);
1287 tport->tp_msr = msr & TI_MSR_MASK;
1289 /* handle CTS flow control */
1290 tty = tty_port_tty_get(&tport->tp_port->port);
1291 if (tty && C_CRTSCTS(tty)) {
1292 if (msr & TI_MSR_CTS)
1299 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1301 unsigned long flags;
1303 spin_lock_irqsave(&tport->tp_lock, flags);
1305 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1306 tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1308 spin_unlock_irqrestore(&tport->tp_lock, flags);
1312 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1316 unsigned long flags;
1318 spin_lock_irqsave(&tport->tp_lock, flags);
1320 if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1321 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1322 urb = tport->tp_port->read_urb;
1323 spin_unlock_irqrestore(&tport->tp_lock, flags);
1324 urb->context = tport;
1325 status = usb_submit_urb(urb, GFP_KERNEL);
1327 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1328 spin_unlock_irqrestore(&tport->tp_lock, flags);
1335 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1336 __u16 moduleid, __u16 value, __u8 *data, int size)
1340 status = usb_control_msg(tdev->td_serial->dev,
1341 usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1342 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1343 value, moduleid, data, size, 1000);
1352 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1353 __u16 moduleid, __u16 value, __u8 *data, int size)
1357 status = usb_control_msg(tdev->td_serial->dev,
1358 usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1359 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1360 value, moduleid, data, size, 1000);
1364 else if (status >= 0)
1371 static int ti_write_byte(struct usb_serial_port *port,
1372 struct ti_device *tdev, unsigned long addr,
1373 __u8 mask, __u8 byte)
1377 struct ti_write_data_bytes *data;
1379 dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1382 size = sizeof(struct ti_write_data_bytes) + 2;
1383 data = kmalloc(size, GFP_KERNEL);
1387 data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1388 data->bDataType = TI_RW_DATA_BYTE;
1389 data->bDataCounter = 1;
1390 data->wBaseAddrHi = cpu_to_be16(addr>>16);
1391 data->wBaseAddrLo = cpu_to_be16(addr);
1392 data->bData[0] = mask;
1393 data->bData[1] = byte;
1395 status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1396 (__u8 *)data, size);
1399 dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1406 static int ti_do_download(struct usb_device *dev, int pipe,
1407 u8 *buffer, int size)
1412 struct ti_firmware_header *header;
1416 for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1417 cs = (__u8)(cs + buffer[pos]);
1419 header = (struct ti_firmware_header *)buffer;
1420 header->wLength = cpu_to_le16((__u16)(size
1421 - sizeof(struct ti_firmware_header)));
1422 header->bCheckSum = cs;
1424 dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1425 for (pos = 0; pos < size; pos += done) {
1426 len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1427 status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1435 static int ti_download_firmware(struct ti_device *tdev)
1440 struct usb_device *dev = tdev->td_serial->dev;
1441 unsigned int pipe = usb_sndbulkpipe(dev,
1442 tdev->td_serial->port[0]->bulk_out_endpointAddress);
1443 const struct firmware *fw_p;
1446 /* try ID specific firmware first, then try generic firmware */
1447 sprintf(buf, "/*(DEBLOBBED)*/",
1448 le16_to_cpu(dev->descriptor.idVendor),
1449 le16_to_cpu(dev->descriptor.idProduct));
1450 status = reject_firmware(&fw_p, buf, &dev->dev);
1454 if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1455 switch (le16_to_cpu(dev->descriptor.idProduct)) {
1456 case MTS_CDMA_PRODUCT_ID:
1457 strcpy(buf, "/*(DEBLOBBED)*/");
1459 case MTS_GSM_PRODUCT_ID:
1460 strcpy(buf, "/*(DEBLOBBED)*/");
1462 case MTS_EDGE_PRODUCT_ID:
1463 strcpy(buf, "/*(DEBLOBBED)*/");
1465 case MTS_MT9234MU_PRODUCT_ID:
1466 strcpy(buf, "/*(DEBLOBBED)*/");
1468 case MTS_MT9234ZBA_PRODUCT_ID:
1469 strcpy(buf, "/*(DEBLOBBED)*/");
1471 case MTS_MT9234ZBAOLD_PRODUCT_ID:
1472 strcpy(buf, "/*(DEBLOBBED)*/");
1475 if (buf[0] == '\0') {
1476 if (tdev->td_is_3410)
1477 strcpy(buf, "/*(DEBLOBBED)*/");
1479 strcpy(buf, "/*(DEBLOBBED)*/");
1481 status = reject_firmware(&fw_p, buf, &dev->dev);
1484 dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1487 if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1488 dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1489 release_firmware(fw_p);
1493 buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1494 buffer = kmalloc(buffer_size, GFP_KERNEL);
1496 memcpy(buffer, fw_p->data, fw_p->size);
1497 memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1498 status = ti_do_download(dev, pipe, buffer, fw_p->size);
1503 release_firmware(fw_p);
1505 dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1510 dev_dbg(&dev->dev, "%s - download successful\n", __func__);