blob: a172ad5c5ce80c1c00983960a04339ac3c13fb24 [file] [log] [blame]
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -08001/*
2 * Fintek F81232 USB to serial adaptor driver
3 *
4 * Copyright (C) 2012 Greg Kroah-Hartman (gregkh@linuxfoundation.org)
5 * Copyright (C) 2012 Linux Foundation
6 *
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.
10 *
11 */
12
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>
27
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -080028static const struct usb_device_id id_table[] = {
29 { USB_DEVICE(0x1934, 0x0706) },
30 { } /* Terminating entry */
31};
32MODULE_DEVICE_TABLE(usb, id_table);
33
34#define CONTROL_DTR 0x01
35#define CONTROL_RTS 0x02
36
37#define UART_STATE 0x08
38#define UART_STATE_TRANSIENT_MASK 0x74
39#define UART_DCD 0x01
40#define UART_DSR 0x02
41#define UART_BREAK_ERROR 0x04
42#define UART_RING 0x08
43#define UART_FRAME_ERROR 0x10
44#define UART_PARITY_ERROR 0x20
45#define UART_OVERRUN_ERROR 0x40
46#define UART_CTS 0x80
47
48struct f81232_private {
49 spinlock_t lock;
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -080050 u8 line_control;
51 u8 line_status;
52};
53
54static void f81232_update_line_status(struct usb_serial_port *port,
55 unsigned char *data,
56 unsigned int actual_length)
57{
58}
59
60static void f81232_read_int_callback(struct urb *urb)
61{
62 struct usb_serial_port *port = urb->context;
63 unsigned char *data = urb->transfer_buffer;
64 unsigned int actual_length = urb->actual_length;
65 int status = urb->status;
66 int retval;
67
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -080068 switch (status) {
69 case 0:
70 /* success */
71 break;
72 case -ECONNRESET:
73 case -ENOENT:
74 case -ESHUTDOWN:
75 /* this urb is terminated, clean up */
Greg Kroah-Hartmana94e9b92012-05-15 16:27:17 -070076 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
77 __func__, status);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -080078 return;
79 default:
Greg Kroah-Hartmana94e9b92012-05-15 16:27:17 -070080 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
81 __func__, status);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -080082 goto exit;
83 }
84
Greg Kroah-Hartman59d33f22012-09-18 09:58:57 +010085 usb_serial_debug_data(&port->dev, __func__,
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -080086 urb->actual_length, urb->transfer_buffer);
87
88 f81232_update_line_status(port, data, actual_length);
89
90exit:
91 retval = usb_submit_urb(urb, GFP_ATOMIC);
92 if (retval)
93 dev_err(&urb->dev->dev,
94 "%s - usb_submit_urb failed with result %d\n",
95 __func__, retval);
96}
97
98static void f81232_process_read_urb(struct urb *urb)
99{
100 struct usb_serial_port *port = urb->context;
101 struct f81232_private *priv = usb_get_serial_port_data(port);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800102 unsigned char *data = urb->transfer_buffer;
103 char tty_flag = TTY_NORMAL;
104 unsigned long flags;
105 u8 line_status;
106 int i;
107
108 /* update line status */
109 spin_lock_irqsave(&priv->lock, flags);
110 line_status = priv->line_status;
111 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
112 spin_unlock_irqrestore(&priv->lock, flags);
Johan Hovold508f9402013-03-19 09:21:14 +0100113 wake_up_interruptible(&port->delta_msr_wait);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800114
115 if (!urb->actual_length)
116 return;
117
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800118 /* break takes precedence over parity, */
119 /* which takes precedence over framing errors */
120 if (line_status & UART_BREAK_ERROR)
121 tty_flag = TTY_BREAK;
122 else if (line_status & UART_PARITY_ERROR)
123 tty_flag = TTY_PARITY;
124 else if (line_status & UART_FRAME_ERROR)
125 tty_flag = TTY_FRAME;
Greg Kroah-Hartmana94e9b92012-05-15 16:27:17 -0700126 dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__, tty_flag);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800127
128 /* overrun is special, not associated with a char */
129 if (line_status & UART_OVERRUN_ERROR)
Jiri Slaby92a19f92013-01-03 15:53:03 +0100130 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800131
132 if (port->port.console && port->sysrq) {
133 for (i = 0; i < urb->actual_length; ++i)
134 if (!usb_serial_handle_sysrq_char(port, data[i]))
Jiri Slaby92a19f92013-01-03 15:53:03 +0100135 tty_insert_flip_char(&port->port, data[i],
136 tty_flag);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800137 } else {
Jiri Slaby2f693352013-01-03 15:53:02 +0100138 tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800139 urb->actual_length);
140 }
141
Jiri Slaby2e124b42013-01-03 15:53:06 +0100142 tty_flip_buffer_push(&port->port);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800143}
144
145static int set_control_lines(struct usb_device *dev, u8 value)
146{
147 /* FIXME - Stubbed out for now */
148 return 0;
149}
150
151static void f81232_break_ctl(struct tty_struct *tty, int break_state)
152{
153 /* FIXME - Stubbed out for now */
154
155 /*
156 * break_state = -1 to turn on break, and 0 to turn off break
157 * see drivers/char/tty_io.c to see it used.
158 * last_set_data_urb_value NEVER has the break bit set in it.
159 */
160}
161
162static void f81232_set_termios(struct tty_struct *tty,
163 struct usb_serial_port *port, struct ktermios *old_termios)
164{
165 /* FIXME - Stubbed out for now */
166
167 /* Don't change anything if nothing has changed */
Alan Coxadc8d742012-07-14 15:31:47 +0100168 if (!tty_termios_hw_change(&tty->termios, old_termios))
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800169 return;
170
171 /* Do the real work here... */
Alan Coxc97ce272012-07-14 15:32:10 +0100172 tty_termios_copy_hw(&tty->termios, old_termios);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800173}
174
175static int f81232_tiocmget(struct tty_struct *tty)
176{
177 /* FIXME - Stubbed out for now */
178 return 0;
179}
180
181static int f81232_tiocmset(struct tty_struct *tty,
182 unsigned int set, unsigned int clear)
183{
184 /* FIXME - Stubbed out for now */
185 return 0;
186}
187
188static int f81232_open(struct tty_struct *tty, struct usb_serial_port *port)
189{
190 struct ktermios tmp_termios;
191 int result;
192
193 /* Setup termios */
194 if (tty)
195 f81232_set_termios(tty, port, &tmp_termios);
196
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800197 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
198 if (result) {
199 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
200 " error %d\n", __func__, result);
201 return result;
202 }
203
204 result = usb_serial_generic_open(tty, port);
205 if (result) {
206 usb_kill_urb(port->interrupt_in_urb);
207 return result;
208 }
209
210 port->port.drain_delay = 256;
211 return 0;
212}
213
214static void f81232_close(struct usb_serial_port *port)
215{
216 usb_serial_generic_close(port);
217 usb_kill_urb(port->interrupt_in_urb);
218}
219
220static void f81232_dtr_rts(struct usb_serial_port *port, int on)
221{
222 struct f81232_private *priv = usb_get_serial_port_data(port);
223 unsigned long flags;
224 u8 control;
225
226 spin_lock_irqsave(&priv->lock, flags);
227 /* Change DTR and RTS */
228 if (on)
229 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
230 else
231 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
232 control = priv->line_control;
233 spin_unlock_irqrestore(&priv->lock, flags);
234 set_control_lines(port->serial->dev, control);
235}
236
237static int f81232_carrier_raised(struct usb_serial_port *port)
238{
239 struct f81232_private *priv = usb_get_serial_port_data(port);
240 if (priv->line_status & UART_DCD)
241 return 1;
242 return 0;
243}
244
245static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
246{
247 struct f81232_private *priv = usb_get_serial_port_data(port);
248 unsigned long flags;
249 unsigned int prevstatus;
250 unsigned int status;
251 unsigned int changed;
252
253 spin_lock_irqsave(&priv->lock, flags);
254 prevstatus = priv->line_status;
255 spin_unlock_irqrestore(&priv->lock, flags);
256
257 while (1) {
Johan Hovold508f9402013-03-19 09:21:14 +0100258 interruptible_sleep_on(&port->delta_msr_wait);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800259 /* see if a signal did it */
260 if (signal_pending(current))
261 return -ERESTARTSYS;
262
Johan Hovold508f9402013-03-19 09:21:14 +0100263 if (port->serial->disconnected)
264 return -EIO;
265
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800266 spin_lock_irqsave(&priv->lock, flags);
267 status = priv->line_status;
268 spin_unlock_irqrestore(&priv->lock, flags);
269
270 changed = prevstatus ^ status;
271
272 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
273 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
274 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
275 ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
276 return 0;
277 }
278 prevstatus = status;
279 }
280 /* NOTREACHED */
281 return 0;
282}
283
284static int f81232_ioctl(struct tty_struct *tty,
285 unsigned int cmd, unsigned long arg)
286{
287 struct serial_struct ser;
288 struct usb_serial_port *port = tty->driver_data;
Greg Kroah-Hartmana94e9b92012-05-15 16:27:17 -0700289
290 dev_dbg(&port->dev, "%s (%d) cmd = 0x%04x\n", __func__,
291 port->number, cmd);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800292
293 switch (cmd) {
294 case TIOCGSERIAL:
295 memset(&ser, 0, sizeof ser);
296 ser.type = PORT_16654;
297 ser.line = port->serial->minor;
298 ser.port = port->number;
299 ser.baud_base = 460800;
300
301 if (copy_to_user((void __user *)arg, &ser, sizeof ser))
302 return -EFAULT;
303
304 return 0;
305
306 case TIOCMIWAIT:
Greg Kroah-Hartmana94e9b92012-05-15 16:27:17 -0700307 dev_dbg(&port->dev, "%s (%d) TIOCMIWAIT\n", __func__,
308 port->number);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800309 return wait_modem_info(port, arg);
310 default:
Greg Kroah-Hartmana94e9b92012-05-15 16:27:17 -0700311 dev_dbg(&port->dev, "%s not supported = 0x%04x\n",
312 __func__, cmd);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800313 break;
314 }
315 return -ENOIOCTLCMD;
316}
317
Johan Hovold3124d1d2012-10-17 13:34:56 +0200318static int f81232_port_probe(struct usb_serial_port *port)
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800319{
320 struct f81232_private *priv;
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800321
Johan Hovold3124d1d2012-10-17 13:34:56 +0200322 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
323 if (!priv)
324 return -ENOMEM;
325
326 spin_lock_init(&priv->lock);
Johan Hovold3124d1d2012-10-17 13:34:56 +0200327
328 usb_set_serial_port_data(port, priv);
329
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800330 return 0;
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800331}
332
Johan Hovold3124d1d2012-10-17 13:34:56 +0200333static int f81232_port_remove(struct usb_serial_port *port)
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800334{
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800335 struct f81232_private *priv;
336
Johan Hovold3124d1d2012-10-17 13:34:56 +0200337 priv = usb_get_serial_port_data(port);
338 kfree(priv);
339
340 return 0;
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800341}
342
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800343static struct usb_serial_driver f81232_device = {
344 .driver = {
345 .owner = THIS_MODULE,
346 .name = "f81232",
347 },
348 .id_table = id_table,
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800349 .num_ports = 1,
350 .bulk_in_size = 256,
351 .bulk_out_size = 256,
352 .open = f81232_open,
353 .close = f81232_close,
354 .dtr_rts = f81232_dtr_rts,
355 .carrier_raised = f81232_carrier_raised,
356 .ioctl = f81232_ioctl,
357 .break_ctl = f81232_break_ctl,
358 .set_termios = f81232_set_termios,
359 .tiocmget = f81232_tiocmget,
360 .tiocmset = f81232_tiocmset,
361 .process_read_urb = f81232_process_read_urb,
362 .read_int_callback = f81232_read_int_callback,
Johan Hovold3124d1d2012-10-17 13:34:56 +0200363 .port_probe = f81232_port_probe,
364 .port_remove = f81232_port_remove,
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800365};
366
367static struct usb_serial_driver * const serial_drivers[] = {
368 &f81232_device,
369 NULL,
370};
371
Greg Kroah-Hartman68e24112012-05-08 15:46:14 -0700372module_usb_serial_driver(serial_drivers, id_table);
Greg Kroah-Hartmanaac1fc32012-02-28 13:36:35 -0800373
374MODULE_DESCRIPTION("Fintek F81232 USB to serial adaptor driver");
375MODULE_AUTHOR("Greg Kroah-Hartman <gregkh@linuxfoundation.org");
376MODULE_LICENSE("GPL v2");