2 * Fintek F81232 USB to serial adaptor driver
4 * Copyright (C) 2012 Greg Kroah-Hartman (gregkh@linuxfoundation.org)
5 * Copyright (C) 2012 Linux Foundation
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 as published by
9 * the Free Software Foundation.
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/init.h>
16 #include <linux/slab.h>
17 #include <linux/tty.h>
18 #include <linux/tty_driver.h>
19 #include <linux/tty_flip.h>
20 #include <linux/serial.h>
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/spinlock.h>
24 #include <linux/uaccess.h>
25 #include <linux/usb.h>
26 #include <linux/usb/serial.h>
30 static const struct usb_device_id id_table[] = {
31 { USB_DEVICE(0x1934, 0x0706) },
32 { } /* Terminating entry */
34 MODULE_DEVICE_TABLE(usb, id_table);
36 #define CONTROL_DTR 0x01
37 #define CONTROL_RTS 0x02
39 #define UART_STATE 0x08
40 #define UART_STATE_TRANSIENT_MASK 0x74
43 #define UART_BREAK_ERROR 0x04
44 #define UART_RING 0x08
45 #define UART_FRAME_ERROR 0x10
46 #define UART_PARITY_ERROR 0x20
47 #define UART_OVERRUN_ERROR 0x40
50 struct f81232_private {
52 wait_queue_head_t delta_msr_wait;
57 static void f81232_update_line_status(struct usb_serial_port *port,
59 unsigned int actual_length)
63 static void f81232_read_int_callback(struct urb *urb)
65 struct usb_serial_port *port = urb->context;
66 unsigned char *data = urb->transfer_buffer;
67 unsigned int actual_length = urb->actual_length;
68 int status = urb->status;
78 /* this urb is terminated, clean up */
79 dbg("%s - urb shutting down with status: %d", __func__,
83 dbg("%s - nonzero urb status received: %d", __func__,
88 usb_serial_debug_data(debug, &port->dev, __func__,
89 urb->actual_length, urb->transfer_buffer);
91 f81232_update_line_status(port, data, actual_length);
94 retval = usb_submit_urb(urb, GFP_ATOMIC);
96 dev_err(&urb->dev->dev,
97 "%s - usb_submit_urb failed with result %d\n",
101 static void f81232_process_read_urb(struct urb *urb)
103 struct usb_serial_port *port = urb->context;
104 struct f81232_private *priv = usb_get_serial_port_data(port);
105 struct tty_struct *tty;
106 unsigned char *data = urb->transfer_buffer;
107 char tty_flag = TTY_NORMAL;
112 /* update line status */
113 spin_lock_irqsave(&priv->lock, flags);
114 line_status = priv->line_status;
115 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
116 spin_unlock_irqrestore(&priv->lock, flags);
117 wake_up_interruptible(&priv->delta_msr_wait);
119 if (!urb->actual_length)
122 tty = tty_port_tty_get(&port->port);
126 /* break takes precedence over parity, */
127 /* which takes precedence over framing errors */
128 if (line_status & UART_BREAK_ERROR)
129 tty_flag = TTY_BREAK;
130 else if (line_status & UART_PARITY_ERROR)
131 tty_flag = TTY_PARITY;
132 else if (line_status & UART_FRAME_ERROR)
133 tty_flag = TTY_FRAME;
134 dbg("%s - tty_flag = %d", __func__, tty_flag);
136 /* overrun is special, not associated with a char */
137 if (line_status & UART_OVERRUN_ERROR)
138 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
140 if (port->port.console && port->sysrq) {
141 for (i = 0; i < urb->actual_length; ++i)
142 if (!usb_serial_handle_sysrq_char(port, data[i]))
143 tty_insert_flip_char(tty, data[i], tty_flag);
145 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
149 tty_flip_buffer_push(tty);
153 static int set_control_lines(struct usb_device *dev, u8 value)
155 /* FIXME - Stubbed out for now */
159 static void f81232_break_ctl(struct tty_struct *tty, int break_state)
161 /* FIXME - Stubbed out for now */
164 * break_state = -1 to turn on break, and 0 to turn off break
165 * see drivers/char/tty_io.c to see it used.
166 * last_set_data_urb_value NEVER has the break bit set in it.
170 static void f81232_set_termios(struct tty_struct *tty,
171 struct usb_serial_port *port, struct ktermios *old_termios)
173 /* FIXME - Stubbed out for now */
175 /* Don't change anything if nothing has changed */
176 if (!tty_termios_hw_change(tty->termios, old_termios))
179 /* Do the real work here... */
182 static int f81232_tiocmget(struct tty_struct *tty)
184 /* FIXME - Stubbed out for now */
188 static int f81232_tiocmset(struct tty_struct *tty,
189 unsigned int set, unsigned int clear)
191 /* FIXME - Stubbed out for now */
195 static int f81232_open(struct tty_struct *tty, struct usb_serial_port *port)
197 struct ktermios tmp_termios;
202 f81232_set_termios(tty, port, &tmp_termios);
204 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
206 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
207 " error %d\n", __func__, result);
211 result = usb_serial_generic_open(tty, port);
213 usb_kill_urb(port->interrupt_in_urb);
217 port->port.drain_delay = 256;
221 static void f81232_close(struct usb_serial_port *port)
223 usb_serial_generic_close(port);
224 usb_kill_urb(port->interrupt_in_urb);
227 static void f81232_dtr_rts(struct usb_serial_port *port, int on)
229 struct f81232_private *priv = usb_get_serial_port_data(port);
233 spin_lock_irqsave(&priv->lock, flags);
234 /* Change DTR and RTS */
236 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
238 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
239 control = priv->line_control;
240 spin_unlock_irqrestore(&priv->lock, flags);
241 set_control_lines(port->serial->dev, control);
244 static int f81232_carrier_raised(struct usb_serial_port *port)
246 struct f81232_private *priv = usb_get_serial_port_data(port);
247 if (priv->line_status & UART_DCD)
252 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
254 struct f81232_private *priv = usb_get_serial_port_data(port);
256 unsigned int prevstatus;
258 unsigned int changed;
260 spin_lock_irqsave(&priv->lock, flags);
261 prevstatus = priv->line_status;
262 spin_unlock_irqrestore(&priv->lock, flags);
265 interruptible_sleep_on(&priv->delta_msr_wait);
266 /* see if a signal did it */
267 if (signal_pending(current))
270 spin_lock_irqsave(&priv->lock, flags);
271 status = priv->line_status;
272 spin_unlock_irqrestore(&priv->lock, flags);
274 changed = prevstatus ^ status;
276 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
277 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
278 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
279 ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
288 static int f81232_ioctl(struct tty_struct *tty,
289 unsigned int cmd, unsigned long arg)
291 struct serial_struct ser;
292 struct usb_serial_port *port = tty->driver_data;
293 dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
297 memset(&ser, 0, sizeof ser);
298 ser.type = PORT_16654;
299 ser.line = port->serial->minor;
300 ser.port = port->number;
301 ser.baud_base = 460800;
303 if (copy_to_user((void __user *)arg, &ser, sizeof ser))
309 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
310 return wait_modem_info(port, arg);
312 dbg("%s not supported = 0x%04x", __func__, cmd);
318 static int f81232_startup(struct usb_serial *serial)
320 struct f81232_private *priv;
323 for (i = 0; i < serial->num_ports; ++i) {
324 priv = kzalloc(sizeof(struct f81232_private), GFP_KERNEL);
327 spin_lock_init(&priv->lock);
328 init_waitqueue_head(&priv->delta_msr_wait);
329 usb_set_serial_port_data(serial->port[i], priv);
334 for (--i; i >= 0; --i) {
335 priv = usb_get_serial_port_data(serial->port[i]);
337 usb_set_serial_port_data(serial->port[i], NULL);
342 static void f81232_release(struct usb_serial *serial)
345 struct f81232_private *priv;
347 for (i = 0; i < serial->num_ports; ++i) {
348 priv = usb_get_serial_port_data(serial->port[i]);
353 static struct usb_driver f81232_driver = {
355 .disconnect = usb_serial_disconnect,
356 .id_table = id_table,
359 static struct usb_serial_driver f81232_device = {
361 .owner = THIS_MODULE,
364 .id_table = id_table,
365 .usb_driver = &f81232_driver,
368 .bulk_out_size = 256,
370 .close = f81232_close,
371 .dtr_rts = f81232_dtr_rts,
372 .carrier_raised = f81232_carrier_raised,
373 .ioctl = f81232_ioctl,
374 .break_ctl = f81232_break_ctl,
375 .set_termios = f81232_set_termios,
376 .tiocmget = f81232_tiocmget,
377 .tiocmset = f81232_tiocmset,
378 .process_read_urb = f81232_process_read_urb,
379 .read_int_callback = f81232_read_int_callback,
380 .attach = f81232_startup,
381 .release = f81232_release,
384 static struct usb_serial_driver * const serial_drivers[] = {
389 module_usb_serial_driver(f81232_driver, serial_drivers);
391 MODULE_DESCRIPTION("Fintek F81232 USB to serial adaptor driver");
392 MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org");
393 MODULE_LICENSE("GPL v2");
395 module_param(debug, bool, S_IRUGO | S_IWUSR);
396 MODULE_PARM_DESC(debug, "Debug enabled or not");