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/init.h>
25 #include <linux/slab.h>
26 #include <linux/tty.h>
27 #include <linux/tty_driver.h>
28 #include <linux/tty_flip.h>
29 #include <linux/module.h>
30 #include <linux/spinlock.h>
31 #include <linux/ioctl.h>
32 #include <linux/serial.h>
33 #include <linux/kfifo.h>
34 #include <linux/mutex.h>
35 #include <linux/uaccess.h>
36 #include <linux/usb.h>
37 #include <linux/usb/serial.h>
39 #include "ti_usb_3410_5052.h"
43 #define TI_DRIVER_AUTHOR "Al Borchers <alborchers@steinerpoint.com>"
44 #define TI_DRIVER_DESC "TI USB 3410/5052 Serial Driver"
46 #define TI_FIRMWARE_BUF_SIZE 16284
48 #define TI_TRANSFER_TIMEOUT 2
50 #define TI_DEFAULT_CLOSING_WAIT 4000 /* in .01 secs */
52 /* supported setserial flags */
53 #define TI_SET_SERIAL_FLAGS 0
56 #define TI_READ_URB_RUNNING 0
57 #define TI_READ_URB_STOPPING 1
58 #define TI_READ_URB_STOPPED 2
60 #define TI_EXTRA_VID_PID_COUNT 5
69 __u8 tp_uart_mode; /* 232 or 485 modes */
70 unsigned int tp_uart_base_addr;
72 struct ti_device *tp_tdev;
73 struct usb_serial_port *tp_port;
75 int tp_read_urb_state;
76 int tp_write_urb_in_use;
80 struct mutex td_open_close_lock;
81 int td_open_port_count;
82 struct usb_serial *td_serial;
88 /* Function Declarations */
90 static int ti_startup(struct usb_serial *serial);
91 static void ti_release(struct usb_serial *serial);
92 static int ti_port_probe(struct usb_serial_port *port);
93 static int ti_port_remove(struct usb_serial_port *port);
94 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port);
95 static void ti_close(struct usb_serial_port *port);
96 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
97 const unsigned char *data, int count);
98 static int ti_write_room(struct tty_struct *tty);
99 static int ti_chars_in_buffer(struct tty_struct *tty);
100 static bool ti_tx_empty(struct usb_serial_port *port);
101 static void ti_throttle(struct tty_struct *tty);
102 static void ti_unthrottle(struct tty_struct *tty);
103 static int ti_ioctl(struct tty_struct *tty,
104 unsigned int cmd, unsigned long arg);
105 static void ti_set_termios(struct tty_struct *tty,
106 struct usb_serial_port *port, struct ktermios *old_termios);
107 static int ti_tiocmget(struct tty_struct *tty);
108 static int ti_tiocmset(struct tty_struct *tty,
109 unsigned int set, unsigned int clear);
110 static void ti_break(struct tty_struct *tty, int break_state);
111 static void ti_interrupt_callback(struct urb *urb);
112 static void ti_bulk_in_callback(struct urb *urb);
113 static void ti_bulk_out_callback(struct urb *urb);
115 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
117 static void ti_send(struct ti_port *tport);
118 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr);
119 static int ti_get_lsr(struct ti_port *tport, u8 *lsr);
120 static int ti_get_serial_info(struct ti_port *tport,
121 struct serial_struct __user *ret_arg);
122 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
123 struct serial_struct __user *new_arg);
124 static void ti_handle_new_msr(struct ti_port *tport, __u8 msr);
126 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty);
127 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty);
129 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
130 __u16 moduleid, __u16 value, __u8 *data, int size);
131 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
132 __u16 moduleid, __u16 value, __u8 *data, int size);
134 static int ti_write_byte(struct usb_serial_port *port, struct ti_device *tdev,
135 unsigned long addr, __u8 mask, __u8 byte);
137 static int ti_download_firmware(struct ti_device *tdev);
142 /* module parameters */
143 static int closing_wait = TI_DEFAULT_CLOSING_WAIT;
145 /* supported devices */
146 static struct usb_device_id ti_id_table_3410[] = {
147 { USB_DEVICE(TI_VENDOR_ID, TI_3410_PRODUCT_ID) },
148 { USB_DEVICE(TI_VENDOR_ID, TI_3410_EZ430_ID) },
149 { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_NO_FW_PRODUCT_ID) },
150 { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_NO_FW_PRODUCT_ID) },
151 { USB_DEVICE(MTS_VENDOR_ID, MTS_CDMA_PRODUCT_ID) },
152 { USB_DEVICE(MTS_VENDOR_ID, MTS_GSM_PRODUCT_ID) },
153 { USB_DEVICE(MTS_VENDOR_ID, MTS_EDGE_PRODUCT_ID) },
154 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234MU_PRODUCT_ID) },
155 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBA_PRODUCT_ID) },
156 { USB_DEVICE(MTS_VENDOR_ID, MTS_MT9234ZBAOLD_PRODUCT_ID) },
157 { USB_DEVICE(IBM_VENDOR_ID, IBM_4543_PRODUCT_ID) },
158 { USB_DEVICE(IBM_VENDOR_ID, IBM_454B_PRODUCT_ID) },
159 { USB_DEVICE(IBM_VENDOR_ID, IBM_454C_PRODUCT_ID) },
160 { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STEREO_PLUG_ID) },
161 { USB_DEVICE(ABBOTT_VENDOR_ID, ABBOTT_STRIP_PORT_ID) },
162 { USB_DEVICE(TI_VENDOR_ID, FRI2_PRODUCT_ID) },
166 static 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 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) },
198 static struct usb_serial_driver ti_1port_device = {
200 .owner = THIS_MODULE,
201 .name = "ti_usb_3410_5052_1",
203 .description = "TI USB 3410 1 port adapter",
204 .id_table = ti_id_table_3410,
206 .attach = ti_startup,
207 .release = ti_release,
208 .port_probe = ti_port_probe,
209 .port_remove = ti_port_remove,
213 .write_room = ti_write_room,
214 .chars_in_buffer = ti_chars_in_buffer,
215 .tx_empty = ti_tx_empty,
216 .throttle = ti_throttle,
217 .unthrottle = ti_unthrottle,
219 .set_termios = ti_set_termios,
220 .tiocmget = ti_tiocmget,
221 .tiocmset = ti_tiocmset,
222 .tiocmiwait = usb_serial_generic_tiocmiwait,
223 .get_icount = usb_serial_generic_get_icount,
224 .break_ctl = ti_break,
225 .read_int_callback = ti_interrupt_callback,
226 .read_bulk_callback = ti_bulk_in_callback,
227 .write_bulk_callback = ti_bulk_out_callback,
230 static struct usb_serial_driver ti_2port_device = {
232 .owner = THIS_MODULE,
233 .name = "ti_usb_3410_5052_2",
235 .description = "TI USB 5052 2 port adapter",
236 .id_table = ti_id_table_5052,
238 .attach = ti_startup,
239 .release = ti_release,
240 .port_probe = ti_port_probe,
241 .port_remove = ti_port_remove,
245 .write_room = ti_write_room,
246 .chars_in_buffer = ti_chars_in_buffer,
247 .tx_empty = ti_tx_empty,
248 .throttle = ti_throttle,
249 .unthrottle = ti_unthrottle,
251 .set_termios = ti_set_termios,
252 .tiocmget = ti_tiocmget,
253 .tiocmset = ti_tiocmset,
254 .tiocmiwait = usb_serial_generic_tiocmiwait,
255 .get_icount = usb_serial_generic_get_icount,
256 .break_ctl = ti_break,
257 .read_int_callback = ti_interrupt_callback,
258 .read_bulk_callback = ti_bulk_in_callback,
259 .write_bulk_callback = ti_bulk_out_callback,
262 static struct usb_serial_driver * const serial_drivers[] = {
263 &ti_1port_device, &ti_2port_device, NULL
268 MODULE_AUTHOR(TI_DRIVER_AUTHOR);
269 MODULE_DESCRIPTION(TI_DRIVER_DESC);
270 MODULE_LICENSE("GPL");
272 MODULE_FIRMWARE("ti_3410.fw");
273 MODULE_FIRMWARE("ti_5052.fw");
274 MODULE_FIRMWARE("mts_cdma.fw");
275 MODULE_FIRMWARE("mts_gsm.fw");
276 MODULE_FIRMWARE("mts_edge.fw");
277 MODULE_FIRMWARE("mts_mt9234mu.fw");
278 MODULE_FIRMWARE("mts_mt9234zba.fw");
280 module_param(closing_wait, int, S_IRUGO | S_IWUSR);
281 MODULE_PARM_DESC(closing_wait,
282 "Maximum wait for data to drain in close, in .01 secs, default is 4000");
284 MODULE_DEVICE_TABLE(usb, ti_id_table_combined);
286 module_usb_serial_driver(serial_drivers, ti_id_table_combined);
290 static int ti_startup(struct usb_serial *serial)
292 struct ti_device *tdev;
293 struct usb_device *dev = serial->dev;
297 "%s - product 0x%4X, num configurations %d, configuration value %d",
298 __func__, le16_to_cpu(dev->descriptor.idProduct),
299 dev->descriptor.bNumConfigurations,
300 dev->actconfig->desc.bConfigurationValue);
302 /* create device structure */
303 tdev = kzalloc(sizeof(struct ti_device), GFP_KERNEL);
305 dev_err(&dev->dev, "%s - out of memory\n", __func__);
308 mutex_init(&tdev->td_open_close_lock);
309 tdev->td_serial = serial;
310 usb_set_serial_data(serial, tdev);
312 /* determine device type */
313 if (serial->type == &ti_1port_device)
314 tdev->td_is_3410 = 1;
315 dev_dbg(&dev->dev, "%s - device type is %s\n", __func__,
316 tdev->td_is_3410 ? "3410" : "5052");
318 /* if we have only 1 configuration, download firmware */
319 if (dev->descriptor.bNumConfigurations == 1) {
320 status = ti_download_firmware(tdev);
325 /* 3410 must be reset, 5052 resets itself */
326 if (tdev->td_is_3410) {
327 msleep_interruptible(100);
328 usb_reset_device(dev);
335 /* the second configuration must be set */
336 if (dev->actconfig->desc.bConfigurationValue == TI_BOOT_CONFIG) {
337 status = usb_driver_set_configuration(dev, TI_ACTIVE_CONFIG);
338 status = status ? status : -ENODEV;
346 usb_set_serial_data(serial, NULL);
351 static void ti_release(struct usb_serial *serial)
353 struct ti_device *tdev = usb_get_serial_data(serial);
358 static int ti_port_probe(struct usb_serial_port *port)
360 struct ti_port *tport;
362 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
366 spin_lock_init(&tport->tp_lock);
367 if (port == port->serial->port[0])
368 tport->tp_uart_base_addr = TI_UART1_BASE_ADDR;
370 tport->tp_uart_base_addr = TI_UART2_BASE_ADDR;
371 port->port.closing_wait = msecs_to_jiffies(10 * closing_wait);
372 tport->tp_port = port;
373 tport->tp_tdev = usb_get_serial_data(port->serial);
374 tport->tp_uart_mode = 0; /* default is RS232 */
376 usb_set_serial_port_data(port, tport);
378 port->port.drain_delay = 3;
383 static int ti_port_remove(struct usb_serial_port *port)
385 struct ti_port *tport;
387 tport = usb_get_serial_port_data(port);
393 static int ti_open(struct tty_struct *tty, struct usb_serial_port *port)
395 struct ti_port *tport = usb_get_serial_port_data(port);
396 struct ti_device *tdev;
397 struct usb_device *dev;
401 __u16 open_settings = (__u8)(TI_PIPE_MODE_CONTINOUS |
402 TI_PIPE_TIMEOUT_ENABLE |
403 (TI_TRANSFER_TIMEOUT << 2));
408 dev = port->serial->dev;
409 tdev = tport->tp_tdev;
411 /* only one open on any port on a device at a time */
412 if (mutex_lock_interruptible(&tdev->td_open_close_lock))
415 port_number = port->port_number;
418 tport->tp_shadow_mcr |= (TI_MCR_RTS | TI_MCR_DTR);
420 /* start interrupt urb the first time a port is opened on this device */
421 if (tdev->td_open_port_count == 0) {
422 dev_dbg(&port->dev, "%s - start interrupt in urb\n", __func__);
423 urb = tdev->td_serial->port[0]->interrupt_in_urb;
425 dev_err(&port->dev, "%s - no interrupt urb\n", __func__);
430 status = usb_submit_urb(urb, GFP_KERNEL);
432 dev_err(&port->dev, "%s - submit interrupt urb failed, %d\n", __func__, status);
438 ti_set_termios(tty, port, &tty->termios);
440 dev_dbg(&port->dev, "%s - sending TI_OPEN_PORT\n", __func__);
441 status = ti_command_out_sync(tdev, TI_OPEN_PORT,
442 (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
444 dev_err(&port->dev, "%s - cannot send open command, %d\n",
449 dev_dbg(&port->dev, "%s - sending TI_START_PORT\n", __func__);
450 status = ti_command_out_sync(tdev, TI_START_PORT,
451 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
453 dev_err(&port->dev, "%s - cannot send start command, %d\n",
458 dev_dbg(&port->dev, "%s - sending TI_PURGE_PORT\n", __func__);
459 status = ti_command_out_sync(tdev, TI_PURGE_PORT,
460 (__u8)(TI_UART1_PORT + port_number), TI_PURGE_INPUT, NULL, 0);
462 dev_err(&port->dev, "%s - cannot clear input buffers, %d\n",
466 status = ti_command_out_sync(tdev, TI_PURGE_PORT,
467 (__u8)(TI_UART1_PORT + port_number), TI_PURGE_OUTPUT, NULL, 0);
469 dev_err(&port->dev, "%s - cannot clear output buffers, %d\n",
474 /* reset the data toggle on the bulk endpoints to work around bug in
475 * host controllers where things get out of sync some times */
476 usb_clear_halt(dev, port->write_urb->pipe);
477 usb_clear_halt(dev, port->read_urb->pipe);
480 ti_set_termios(tty, port, &tty->termios);
482 dev_dbg(&port->dev, "%s - sending TI_OPEN_PORT (2)\n", __func__);
483 status = ti_command_out_sync(tdev, TI_OPEN_PORT,
484 (__u8)(TI_UART1_PORT + port_number), open_settings, NULL, 0);
486 dev_err(&port->dev, "%s - cannot send open command (2), %d\n",
491 dev_dbg(&port->dev, "%s - sending TI_START_PORT (2)\n", __func__);
492 status = ti_command_out_sync(tdev, TI_START_PORT,
493 (__u8)(TI_UART1_PORT + port_number), 0, NULL, 0);
495 dev_err(&port->dev, "%s - cannot send start command (2), %d\n",
501 dev_dbg(&port->dev, "%s - start read urb\n", __func__);
502 urb = port->read_urb;
504 dev_err(&port->dev, "%s - no read urb\n", __func__);
508 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
509 urb->context = tport;
510 status = usb_submit_urb(urb, GFP_KERNEL);
512 dev_err(&port->dev, "%s - submit read urb failed, %d\n",
517 tport->tp_is_open = 1;
518 ++tdev->td_open_port_count;
523 if (tdev->td_open_port_count == 0)
524 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
526 mutex_unlock(&tdev->td_open_close_lock);
527 dev_dbg(&port->dev, "%s - exit %d\n", __func__, status);
532 static void ti_close(struct usb_serial_port *port)
534 struct ti_device *tdev;
535 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 /* if mutex_lock is interrupted, continue anyway */
566 do_unlock = !mutex_lock_interruptible(&tdev->td_open_close_lock);
567 --tport->tp_tdev->td_open_port_count;
568 if (tport->tp_tdev->td_open_port_count <= 0) {
569 /* last port is closed, shut down interrupt urb */
570 usb_kill_urb(port->serial->port[0]->interrupt_in_urb);
571 tport->tp_tdev->td_open_port_count = 0;
574 mutex_unlock(&tdev->td_open_close_lock);
578 static int ti_write(struct tty_struct *tty, struct usb_serial_port *port,
579 const unsigned char *data, int count)
581 struct ti_port *tport = usb_get_serial_port_data(port);
584 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
588 if (tport == NULL || !tport->tp_is_open)
591 count = kfifo_in_locked(&port->write_fifo, data, count,
599 static int ti_write_room(struct tty_struct *tty)
601 struct usb_serial_port *port = tty->driver_data;
602 struct ti_port *tport = usb_get_serial_port_data(port);
609 spin_lock_irqsave(&tport->tp_lock, flags);
610 room = kfifo_avail(&port->write_fifo);
611 spin_unlock_irqrestore(&tport->tp_lock, flags);
613 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
618 static int ti_chars_in_buffer(struct tty_struct *tty)
620 struct usb_serial_port *port = tty->driver_data;
621 struct ti_port *tport = usb_get_serial_port_data(port);
628 spin_lock_irqsave(&tport->tp_lock, flags);
629 chars = kfifo_len(&port->write_fifo);
630 spin_unlock_irqrestore(&tport->tp_lock, flags);
632 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
636 static bool ti_tx_empty(struct usb_serial_port *port)
638 struct ti_port *tport = usb_get_serial_port_data(port);
642 ret = ti_get_lsr(tport, &lsr);
643 if (!ret && !(lsr & TI_LSR_TX_EMPTY))
649 static void ti_throttle(struct tty_struct *tty)
651 struct usb_serial_port *port = tty->driver_data;
652 struct ti_port *tport = usb_get_serial_port_data(port);
657 if (I_IXOFF(tty) || C_CRTSCTS(tty))
658 ti_stop_read(tport, tty);
663 static void ti_unthrottle(struct tty_struct *tty)
665 struct usb_serial_port *port = tty->driver_data;
666 struct ti_port *tport = usb_get_serial_port_data(port);
672 if (I_IXOFF(tty) || C_CRTSCTS(tty)) {
673 status = ti_restart_read(tport, tty);
675 dev_err(&port->dev, "%s - cannot restart read, %d\n",
680 static int ti_ioctl(struct tty_struct *tty,
681 unsigned int cmd, unsigned long arg)
683 struct usb_serial_port *port = tty->driver_data;
684 struct ti_port *tport = usb_get_serial_port_data(port);
686 dev_dbg(&port->dev, "%s - cmd = 0x%04X\n", __func__, cmd);
693 dev_dbg(&port->dev, "%s - TIOCGSERIAL\n", __func__);
694 return ti_get_serial_info(tport,
695 (struct serial_struct __user *)arg);
697 dev_dbg(&port->dev, "%s - TIOCSSERIAL\n", __func__);
698 return ti_set_serial_info(tty, tport,
699 (struct serial_struct __user *)arg);
705 static void ti_set_termios(struct tty_struct *tty,
706 struct usb_serial_port *port, struct ktermios *old_termios)
708 struct ti_port *tport = usb_get_serial_port_data(port);
709 struct ti_uart_config *config;
710 tcflag_t cflag, iflag;
713 int port_number = port->port_number;
716 cflag = tty->termios.c_cflag;
717 iflag = tty->termios.c_iflag;
719 dev_dbg(&port->dev, "%s - cflag %08x, iflag %08x\n", __func__, cflag, iflag);
720 dev_dbg(&port->dev, "%s - old clfag %08x, old iflag %08x\n", __func__,
721 old_termios->c_cflag, old_termios->c_iflag);
726 config = kmalloc(sizeof(*config), GFP_KERNEL);
728 dev_err(&port->dev, "%s - out of memory\n", __func__);
734 /* these flags must be set */
735 config->wFlags |= TI_UART_ENABLE_MS_INTS;
736 config->wFlags |= TI_UART_ENABLE_AUTO_START_DMA;
737 config->bUartMode = (__u8)(tport->tp_uart_mode);
739 switch (cflag & CSIZE) {
741 config->bDataBits = TI_UART_5_DATA_BITS;
744 config->bDataBits = TI_UART_6_DATA_BITS;
747 config->bDataBits = TI_UART_7_DATA_BITS;
751 config->bDataBits = TI_UART_8_DATA_BITS;
755 /* CMSPAR isn't supported by this driver */
756 tty->termios.c_cflag &= ~CMSPAR;
758 if (cflag & PARENB) {
759 if (cflag & PARODD) {
760 config->wFlags |= TI_UART_ENABLE_PARITY_CHECKING;
761 config->bParity = TI_UART_ODD_PARITY;
763 config->wFlags |= TI_UART_ENABLE_PARITY_CHECKING;
764 config->bParity = TI_UART_EVEN_PARITY;
767 config->wFlags &= ~TI_UART_ENABLE_PARITY_CHECKING;
768 config->bParity = TI_UART_NO_PARITY;
772 config->bStopBits = TI_UART_2_STOP_BITS;
774 config->bStopBits = TI_UART_1_STOP_BITS;
776 if (cflag & CRTSCTS) {
777 /* RTS flow control must be off to drop RTS for baud rate B0 */
778 if ((cflag & CBAUD) != B0)
779 config->wFlags |= TI_UART_ENABLE_RTS_IN;
780 config->wFlags |= TI_UART_ENABLE_CTS_OUT;
783 ti_restart_read(tport, tty);
786 if (I_IXOFF(tty) || I_IXON(tty)) {
787 config->cXon = START_CHAR(tty);
788 config->cXoff = STOP_CHAR(tty);
791 config->wFlags |= TI_UART_ENABLE_X_IN;
793 ti_restart_read(tport, tty);
796 config->wFlags |= TI_UART_ENABLE_X_OUT;
799 baud = tty_get_baud_rate(tty);
802 if (tport->tp_tdev->td_is_3410)
803 config->wBaudRate = (__u16)((923077 + baud/2) / baud);
805 config->wBaudRate = (__u16)((461538 + baud/2) / baud);
807 /* FIXME: Should calculate resulting baud here and report it back */
808 if ((cflag & CBAUD) != B0)
809 tty_encode_baud_rate(tty, baud, baud);
812 "%s - BaudRate=%d, wBaudRate=%d, wFlags=0x%04X, bDataBits=%d, bParity=%d, bStopBits=%d, cXon=%d, cXoff=%d, bUartMode=%d",
813 __func__, baud, config->wBaudRate, config->wFlags,
814 config->bDataBits, config->bParity, config->bStopBits,
815 config->cXon, config->cXoff, config->bUartMode);
817 cpu_to_be16s(&config->wBaudRate);
818 cpu_to_be16s(&config->wFlags);
820 status = ti_command_out_sync(tport->tp_tdev, TI_SET_CONFIG,
821 (__u8)(TI_UART1_PORT + port_number), 0, (__u8 *)config,
824 dev_err(&port->dev, "%s - cannot set config on port %d, %d\n",
825 __func__, port_number, status);
827 /* SET_CONFIG asserts RTS and DTR, reset them correctly */
828 mcr = tport->tp_shadow_mcr;
829 /* if baud rate is B0, clear RTS and DTR */
830 if ((cflag & CBAUD) == B0)
831 mcr &= ~(TI_MCR_DTR | TI_MCR_RTS);
832 status = ti_set_mcr(tport, mcr);
835 "%s - cannot set modem control on port %d, %d\n",
836 __func__, port_number, status);
842 static int ti_tiocmget(struct tty_struct *tty)
844 struct usb_serial_port *port = tty->driver_data;
845 struct ti_port *tport = usb_get_serial_port_data(port);
854 spin_lock_irqsave(&tport->tp_lock, flags);
856 mcr = tport->tp_shadow_mcr;
857 spin_unlock_irqrestore(&tport->tp_lock, flags);
859 result = ((mcr & TI_MCR_DTR) ? TIOCM_DTR : 0)
860 | ((mcr & TI_MCR_RTS) ? TIOCM_RTS : 0)
861 | ((mcr & TI_MCR_LOOP) ? TIOCM_LOOP : 0)
862 | ((msr & TI_MSR_CTS) ? TIOCM_CTS : 0)
863 | ((msr & TI_MSR_CD) ? TIOCM_CAR : 0)
864 | ((msr & TI_MSR_RI) ? TIOCM_RI : 0)
865 | ((msr & TI_MSR_DSR) ? TIOCM_DSR : 0);
867 dev_dbg(&port->dev, "%s - 0x%04X\n", __func__, result);
873 static int ti_tiocmset(struct tty_struct *tty,
874 unsigned int set, unsigned int clear)
876 struct usb_serial_port *port = tty->driver_data;
877 struct ti_port *tport = usb_get_serial_port_data(port);
884 spin_lock_irqsave(&tport->tp_lock, flags);
885 mcr = tport->tp_shadow_mcr;
891 if (set & TIOCM_LOOP)
894 if (clear & TIOCM_RTS)
896 if (clear & TIOCM_DTR)
898 if (clear & TIOCM_LOOP)
900 spin_unlock_irqrestore(&tport->tp_lock, flags);
902 return ti_set_mcr(tport, mcr);
906 static void ti_break(struct tty_struct *tty, int break_state)
908 struct usb_serial_port *port = tty->driver_data;
909 struct ti_port *tport = usb_get_serial_port_data(port);
912 dev_dbg(&port->dev, "%s - state = %d\n", __func__, break_state);
917 status = ti_write_byte(port, tport->tp_tdev,
918 tport->tp_uart_base_addr + TI_UART_OFFSET_LCR,
919 TI_LCR_BREAK, break_state == -1 ? TI_LCR_BREAK : 0);
922 dev_dbg(&port->dev, "%s - error setting break, %d\n", __func__, status);
926 static void ti_interrupt_callback(struct urb *urb)
928 struct ti_device *tdev = urb->context;
929 struct usb_serial_port *port;
930 struct usb_serial *serial = tdev->td_serial;
931 struct ti_port *tport;
932 struct device *dev = &urb->dev->dev;
933 unsigned char *data = urb->transfer_buffer;
934 int length = urb->actual_length;
937 int status = urb->status;
947 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
948 tdev->td_urb_error = 1;
951 dev_err(dev, "%s - nonzero urb status, %d\n", __func__, status);
952 tdev->td_urb_error = 1;
957 dev_dbg(dev, "%s - bad packet size, %d\n", __func__, length);
961 if (data[0] == TI_CODE_HARDWARE_ERROR) {
962 dev_err(dev, "%s - hardware error, %d\n", __func__, data[1]);
966 port_number = TI_GET_PORT_FROM_CODE(data[0]);
967 function = TI_GET_FUNC_FROM_CODE(data[0]);
969 dev_dbg(dev, "%s - port_number %d, function %d, data 0x%02X\n",
970 __func__, port_number, function, data[1]);
972 if (port_number >= serial->num_ports) {
973 dev_err(dev, "%s - bad port number, %d\n",
974 __func__, port_number);
978 port = serial->port[port_number];
980 tport = usb_get_serial_port_data(port);
985 case TI_CODE_DATA_ERROR:
986 dev_err(dev, "%s - DATA ERROR, port %d, data 0x%02X\n",
987 __func__, port_number, data[1]);
990 case TI_CODE_MODEM_STATUS:
992 dev_dbg(dev, "%s - port %d, msr 0x%02X\n", __func__, port_number, msr);
993 ti_handle_new_msr(tport, msr);
997 dev_err(dev, "%s - unknown interrupt code, 0x%02X\n",
1003 retval = usb_submit_urb(urb, GFP_ATOMIC);
1005 dev_err(dev, "%s - resubmit interrupt urb failed, %d\n",
1010 static void ti_bulk_in_callback(struct urb *urb)
1012 struct ti_port *tport = urb->context;
1013 struct usb_serial_port *port = tport->tp_port;
1014 struct device *dev = &urb->dev->dev;
1015 int status = urb->status;
1024 dev_dbg(dev, "%s - urb shutting down, %d\n", __func__, status);
1025 tport->tp_tdev->td_urb_error = 1;
1028 dev_err(dev, "%s - nonzero urb status, %d\n",
1030 tport->tp_tdev->td_urb_error = 1;
1033 if (status == -EPIPE)
1037 dev_err(dev, "%s - stopping read!\n", __func__);
1041 if (urb->actual_length) {
1042 usb_serial_debug_data(dev, __func__, urb->actual_length,
1043 urb->transfer_buffer);
1045 if (!tport->tp_is_open)
1046 dev_dbg(dev, "%s - port closed, dropping data\n",
1049 ti_recv(port, urb->transfer_buffer, urb->actual_length);
1050 spin_lock(&tport->tp_lock);
1051 port->icount.rx += urb->actual_length;
1052 spin_unlock(&tport->tp_lock);
1056 /* continue to read unless stopping */
1057 spin_lock(&tport->tp_lock);
1058 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1059 retval = usb_submit_urb(urb, GFP_ATOMIC);
1060 else if (tport->tp_read_urb_state == TI_READ_URB_STOPPING)
1061 tport->tp_read_urb_state = TI_READ_URB_STOPPED;
1063 spin_unlock(&tport->tp_lock);
1065 dev_err(dev, "%s - resubmit read urb failed, %d\n",
1070 static void ti_bulk_out_callback(struct urb *urb)
1072 struct ti_port *tport = urb->context;
1073 struct usb_serial_port *port = tport->tp_port;
1074 int status = urb->status;
1076 tport->tp_write_urb_in_use = 0;
1084 dev_dbg(&port->dev, "%s - urb shutting down, %d\n", __func__, status);
1085 tport->tp_tdev->td_urb_error = 1;
1088 dev_err_console(port, "%s - nonzero urb status, %d\n",
1090 tport->tp_tdev->td_urb_error = 1;
1093 /* send any buffered data */
1098 static void ti_recv(struct usb_serial_port *port, unsigned char *data,
1104 cnt = tty_insert_flip_string(&port->port, data, length);
1106 dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
1107 __func__, length - cnt);
1111 tty_flip_buffer_push(&port->port);
1114 } while (length > 0);
1118 static void ti_send(struct ti_port *tport)
1121 struct usb_serial_port *port = tport->tp_port;
1122 unsigned long flags;
1124 spin_lock_irqsave(&tport->tp_lock, flags);
1126 if (tport->tp_write_urb_in_use)
1129 count = kfifo_out(&port->write_fifo,
1130 port->write_urb->transfer_buffer,
1131 port->bulk_out_size);
1136 tport->tp_write_urb_in_use = 1;
1138 spin_unlock_irqrestore(&tport->tp_lock, flags);
1140 usb_serial_debug_data(&port->dev, __func__, count,
1141 port->write_urb->transfer_buffer);
1143 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1144 usb_sndbulkpipe(port->serial->dev,
1145 port->bulk_out_endpointAddress),
1146 port->write_urb->transfer_buffer, count,
1147 ti_bulk_out_callback, tport);
1149 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1151 dev_err_console(port, "%s - submit write urb failed, %d\n",
1153 tport->tp_write_urb_in_use = 0;
1154 /* TODO: reschedule ti_send */
1156 spin_lock_irqsave(&tport->tp_lock, flags);
1157 port->icount.tx += count;
1158 spin_unlock_irqrestore(&tport->tp_lock, flags);
1161 /* more room in the buffer for new writes, wakeup */
1162 tty_port_tty_wakeup(&port->port);
1166 spin_unlock_irqrestore(&tport->tp_lock, flags);
1171 static int ti_set_mcr(struct ti_port *tport, unsigned int mcr)
1173 unsigned long flags;
1176 status = ti_write_byte(tport->tp_port, tport->tp_tdev,
1177 tport->tp_uart_base_addr + TI_UART_OFFSET_MCR,
1178 TI_MCR_RTS | TI_MCR_DTR | TI_MCR_LOOP, mcr);
1180 spin_lock_irqsave(&tport->tp_lock, flags);
1182 tport->tp_shadow_mcr = mcr;
1183 spin_unlock_irqrestore(&tport->tp_lock, flags);
1189 static int ti_get_lsr(struct ti_port *tport, u8 *lsr)
1192 struct ti_device *tdev = tport->tp_tdev;
1193 struct usb_serial_port *port = tport->tp_port;
1194 int port_number = port->port_number;
1195 struct ti_port_status *data;
1197 size = sizeof(struct ti_port_status);
1198 data = kmalloc(size, GFP_KERNEL);
1200 dev_err(&port->dev, "%s - out of memory\n", __func__);
1204 status = ti_command_in_sync(tdev, TI_GET_PORT_STATUS,
1205 (__u8)(TI_UART1_PORT+port_number), 0, (__u8 *)data, size);
1208 "%s - get port status command failed, %d\n",
1213 dev_dbg(&port->dev, "%s - lsr 0x%02X\n", __func__, data->bLSR);
1223 static int ti_get_serial_info(struct ti_port *tport,
1224 struct serial_struct __user *ret_arg)
1226 struct usb_serial_port *port = tport->tp_port;
1227 struct serial_struct ret_serial;
1233 cwait = port->port.closing_wait;
1234 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1235 cwait = jiffies_to_msecs(cwait) / 10;
1237 memset(&ret_serial, 0, sizeof(ret_serial));
1239 ret_serial.type = PORT_16550A;
1240 ret_serial.line = port->minor;
1241 ret_serial.port = port->port_number;
1242 ret_serial.flags = tport->tp_flags;
1243 ret_serial.xmit_fifo_size = kfifo_size(&port->write_fifo);
1244 ret_serial.baud_base = tport->tp_tdev->td_is_3410 ? 921600 : 460800;
1245 ret_serial.closing_wait = cwait;
1247 if (copy_to_user(ret_arg, &ret_serial, sizeof(*ret_arg)))
1254 static int ti_set_serial_info(struct tty_struct *tty, struct ti_port *tport,
1255 struct serial_struct __user *new_arg)
1257 struct serial_struct new_serial;
1260 if (copy_from_user(&new_serial, new_arg, sizeof(new_serial)))
1263 cwait = new_serial.closing_wait;
1264 if (cwait != ASYNC_CLOSING_WAIT_NONE)
1265 cwait = msecs_to_jiffies(10 * new_serial.closing_wait);
1267 tport->tp_flags = new_serial.flags & TI_SET_SERIAL_FLAGS;
1268 tport->tp_port->port.closing_wait = cwait;
1274 static void ti_handle_new_msr(struct ti_port *tport, __u8 msr)
1276 struct async_icount *icount;
1277 struct tty_struct *tty;
1278 unsigned long flags;
1280 dev_dbg(&tport->tp_port->dev, "%s - msr 0x%02X\n", __func__, msr);
1282 if (msr & TI_MSR_DELTA_MASK) {
1283 spin_lock_irqsave(&tport->tp_lock, flags);
1284 icount = &tport->tp_port->icount;
1285 if (msr & TI_MSR_DELTA_CTS)
1287 if (msr & TI_MSR_DELTA_DSR)
1289 if (msr & TI_MSR_DELTA_CD)
1291 if (msr & TI_MSR_DELTA_RI)
1293 wake_up_interruptible(&tport->tp_port->port.delta_msr_wait);
1294 spin_unlock_irqrestore(&tport->tp_lock, flags);
1297 tport->tp_msr = msr & TI_MSR_MASK;
1299 /* handle CTS flow control */
1300 tty = tty_port_tty_get(&tport->tp_port->port);
1301 if (tty && C_CRTSCTS(tty)) {
1302 if (msr & TI_MSR_CTS) {
1303 tty->hw_stopped = 0;
1306 tty->hw_stopped = 1;
1313 static void ti_stop_read(struct ti_port *tport, struct tty_struct *tty)
1315 unsigned long flags;
1317 spin_lock_irqsave(&tport->tp_lock, flags);
1319 if (tport->tp_read_urb_state == TI_READ_URB_RUNNING)
1320 tport->tp_read_urb_state = TI_READ_URB_STOPPING;
1322 spin_unlock_irqrestore(&tport->tp_lock, flags);
1326 static int ti_restart_read(struct ti_port *tport, struct tty_struct *tty)
1330 unsigned long flags;
1332 spin_lock_irqsave(&tport->tp_lock, flags);
1334 if (tport->tp_read_urb_state == TI_READ_URB_STOPPED) {
1335 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1336 urb = tport->tp_port->read_urb;
1337 spin_unlock_irqrestore(&tport->tp_lock, flags);
1338 urb->context = tport;
1339 status = usb_submit_urb(urb, GFP_KERNEL);
1341 tport->tp_read_urb_state = TI_READ_URB_RUNNING;
1342 spin_unlock_irqrestore(&tport->tp_lock, flags);
1349 static int ti_command_out_sync(struct ti_device *tdev, __u8 command,
1350 __u16 moduleid, __u16 value, __u8 *data, int size)
1354 status = usb_control_msg(tdev->td_serial->dev,
1355 usb_sndctrlpipe(tdev->td_serial->dev, 0), command,
1356 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT),
1357 value, moduleid, data, size, 1000);
1369 static int ti_command_in_sync(struct ti_device *tdev, __u8 command,
1370 __u16 moduleid, __u16 value, __u8 *data, int size)
1374 status = usb_control_msg(tdev->td_serial->dev,
1375 usb_rcvctrlpipe(tdev->td_serial->dev, 0), command,
1376 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN),
1377 value, moduleid, data, size, 1000);
1389 static int ti_write_byte(struct usb_serial_port *port,
1390 struct ti_device *tdev, unsigned long addr,
1391 __u8 mask, __u8 byte)
1395 struct ti_write_data_bytes *data;
1397 dev_dbg(&port->dev, "%s - addr 0x%08lX, mask 0x%02X, byte 0x%02X\n", __func__,
1400 size = sizeof(struct ti_write_data_bytes) + 2;
1401 data = kmalloc(size, GFP_KERNEL);
1403 dev_err(&port->dev, "%s - out of memory\n", __func__);
1407 data->bAddrType = TI_RW_DATA_ADDR_XDATA;
1408 data->bDataType = TI_RW_DATA_BYTE;
1409 data->bDataCounter = 1;
1410 data->wBaseAddrHi = cpu_to_be16(addr>>16);
1411 data->wBaseAddrLo = cpu_to_be16(addr);
1412 data->bData[0] = mask;
1413 data->bData[1] = byte;
1415 status = ti_command_out_sync(tdev, TI_WRITE_DATA, TI_RAM_PORT, 0,
1416 (__u8 *)data, size);
1419 dev_err(&port->dev, "%s - failed, %d\n", __func__, status);
1426 static int ti_do_download(struct usb_device *dev, int pipe,
1427 u8 *buffer, int size)
1432 struct ti_firmware_header *header;
1436 for (pos = sizeof(struct ti_firmware_header); pos < size; pos++)
1437 cs = (__u8)(cs + buffer[pos]);
1439 header = (struct ti_firmware_header *)buffer;
1440 header->wLength = cpu_to_le16((__u16)(size
1441 - sizeof(struct ti_firmware_header)));
1442 header->bCheckSum = cs;
1444 dev_dbg(&dev->dev, "%s - downloading firmware\n", __func__);
1445 for (pos = 0; pos < size; pos += done) {
1446 len = min(size - pos, TI_DOWNLOAD_MAX_PACKET_SIZE);
1447 status = usb_bulk_msg(dev, pipe, buffer + pos, len,
1455 static int ti_download_firmware(struct ti_device *tdev)
1460 struct usb_device *dev = tdev->td_serial->dev;
1461 unsigned int pipe = usb_sndbulkpipe(dev,
1462 tdev->td_serial->port[0]->bulk_out_endpointAddress);
1463 const struct firmware *fw_p;
1466 /* try ID specific firmware first, then try generic firmware */
1467 sprintf(buf, "ti_usb-v%04x-p%04x.fw",
1468 le16_to_cpu(dev->descriptor.idVendor),
1469 le16_to_cpu(dev->descriptor.idProduct));
1470 status = request_firmware(&fw_p, buf, &dev->dev);
1474 if (le16_to_cpu(dev->descriptor.idVendor) == MTS_VENDOR_ID) {
1475 switch (le16_to_cpu(dev->descriptor.idProduct)) {
1476 case MTS_CDMA_PRODUCT_ID:
1477 strcpy(buf, "mts_cdma.fw");
1479 case MTS_GSM_PRODUCT_ID:
1480 strcpy(buf, "mts_gsm.fw");
1482 case MTS_EDGE_PRODUCT_ID:
1483 strcpy(buf, "mts_edge.fw");
1485 case MTS_MT9234MU_PRODUCT_ID:
1486 strcpy(buf, "mts_mt9234mu.fw");
1488 case MTS_MT9234ZBA_PRODUCT_ID:
1489 strcpy(buf, "mts_mt9234zba.fw");
1491 case MTS_MT9234ZBAOLD_PRODUCT_ID:
1492 strcpy(buf, "mts_mt9234zba.fw");
1495 if (buf[0] == '\0') {
1496 if (tdev->td_is_3410)
1497 strcpy(buf, "ti_3410.fw");
1499 strcpy(buf, "ti_5052.fw");
1501 status = request_firmware(&fw_p, buf, &dev->dev);
1504 dev_err(&dev->dev, "%s - firmware not found\n", __func__);
1507 if (fw_p->size > TI_FIRMWARE_BUF_SIZE) {
1508 dev_err(&dev->dev, "%s - firmware too large %zu\n", __func__, fw_p->size);
1509 release_firmware(fw_p);
1513 buffer_size = TI_FIRMWARE_BUF_SIZE + sizeof(struct ti_firmware_header);
1514 buffer = kmalloc(buffer_size, GFP_KERNEL);
1516 memcpy(buffer, fw_p->data, fw_p->size);
1517 memset(buffer + fw_p->size, 0xff, buffer_size - fw_p->size);
1518 status = ti_do_download(dev, pipe, buffer, fw_p->size);
1521 dev_dbg(&dev->dev, "%s ENOMEM\n", __func__);
1524 release_firmware(fw_p);
1526 dev_err(&dev->dev, "%s - error downloading firmware, %d\n",
1531 dev_dbg(&dev->dev, "%s - download successful\n", __func__);