tty: USB does not need the filp argument in the drivers
[deliverable/linux.git] / drivers / usb / serial / ark3116.c
CommitLineData
815ddc99 1/*
2f430b4b
WL
2 * Copyright (C) 2006
3 * Simon Schulz (ark3116_driver <at> auctionant.de)
4 *
815ddc99
GKH
5 * ark3116
6 * - implements a driver for the arkmicro ark3116 chipset (vendor=0x6547,
7 * productid=0x0232) (used in a datacable called KQ-U8A)
8 *
9 * - based on code by krisfx -> thanks !!
10 * (see http://www.linuxquestions.org/questions/showthread.php?p=2184457#post2184457)
11 *
12 * - based on logs created by usbsnoopy
13 *
815ddc99
GKH
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2 of the License, or (at your
17 * option) any later version.
18 */
19
20#include <linux/kernel.h>
21#include <linux/init.h>
22#include <linux/tty.h>
23#include <linux/module.h>
24#include <linux/usb.h>
a969888c 25#include <linux/usb/serial.h>
2f430b4b 26#include <linux/serial.h>
c4d0f8cb 27#include <linux/uaccess.h>
815ddc99
GKH
28
29
30static int debug;
31
32static struct usb_device_id id_table [] = {
33 { USB_DEVICE(0x6547, 0x0232) },
34 { },
35};
36MODULE_DEVICE_TABLE(usb, id_table);
37
38struct ark3116_private {
39 spinlock_t lock;
40 u8 termios_initialized;
41};
42
43static inline void ARK3116_SND(struct usb_serial *serial, int seq,
44 __u8 request, __u8 requesttype,
45 __u16 value, __u16 index)
46{
47 int result;
48 result = usb_control_msg(serial->dev,
988440e7 49 usb_sndctrlpipe(serial->dev, 0),
815ddc99 50 request, requesttype, value, index,
988440e7
WL
51 NULL, 0x00, 1000);
52 dbg("%03d > ok", seq);
815ddc99
GKH
53}
54
55static inline void ARK3116_RCV(struct usb_serial *serial, int seq,
56 __u8 request, __u8 requesttype,
57 __u16 value, __u16 index, __u8 expected,
58 char *buf)
59{
60 int result;
61 result = usb_control_msg(serial->dev,
988440e7
WL
62 usb_rcvctrlpipe(serial->dev, 0),
63 request, requesttype, value, index,
64 buf, 0x0000001, 1000);
815ddc99 65 if (result)
b268f484
JE
66 dbg("%03d < %d bytes [0x%02X]", seq, result,
67 ((unsigned char *)buf)[0]);
815ddc99
GKH
68 else
69 dbg("%03d < 0 bytes", seq);
70}
71
815ddc99
GKH
72static inline void ARK3116_RCV_QUIET(struct usb_serial *serial,
73 __u8 request, __u8 requesttype,
74 __u16 value, __u16 index, char *buf)
75{
76 usb_control_msg(serial->dev,
988440e7 77 usb_rcvctrlpipe(serial->dev, 0),
815ddc99
GKH
78 request, requesttype, value, index,
79 buf, 0x0000001, 1000);
80}
81
815ddc99
GKH
82static int ark3116_attach(struct usb_serial *serial)
83{
84 char *buf;
85 struct ark3116_private *priv;
86 int i;
87
88 for (i = 0; i < serial->num_ports; ++i) {
7ac9da10 89 priv = kzalloc(sizeof(struct ark3116_private), GFP_KERNEL);
815ddc99
GKH
90 if (!priv)
91 goto cleanup;
815ddc99
GKH
92 spin_lock_init(&priv->lock);
93
94 usb_set_serial_port_data(serial->port[i], priv);
95 }
96
97 buf = kmalloc(1, GFP_KERNEL);
98 if (!buf) {
988440e7 99 dbg("error kmalloc -> out of mem?");
815ddc99
GKH
100 goto cleanup;
101 }
102
103 /* 3 */
988440e7
WL
104 ARK3116_SND(serial, 3, 0xFE, 0x40, 0x0008, 0x0002);
105 ARK3116_SND(serial, 4, 0xFE, 0x40, 0x0008, 0x0001);
106 ARK3116_SND(serial, 5, 0xFE, 0x40, 0x0000, 0x0008);
107 ARK3116_SND(serial, 6, 0xFE, 0x40, 0x0000, 0x000B);
815ddc99
GKH
108
109 /* <-- seq7 */
988440e7
WL
110 ARK3116_RCV(serial, 7, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
111 ARK3116_SND(serial, 8, 0xFE, 0x40, 0x0080, 0x0003);
112 ARK3116_SND(serial, 9, 0xFE, 0x40, 0x001A, 0x0000);
113 ARK3116_SND(serial, 10, 0xFE, 0x40, 0x0000, 0x0001);
114 ARK3116_SND(serial, 11, 0xFE, 0x40, 0x0000, 0x0003);
815ddc99
GKH
115
116 /* <-- seq12 */
988440e7
WL
117 ARK3116_RCV(serial, 12, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
118 ARK3116_SND(serial, 13, 0xFE, 0x40, 0x0000, 0x0004);
815ddc99
GKH
119
120 /* 14 */
988440e7
WL
121 ARK3116_RCV(serial, 14, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
122 ARK3116_SND(serial, 15, 0xFE, 0x40, 0x0000, 0x0004);
815ddc99
GKH
123
124 /* 16 */
988440e7 125 ARK3116_RCV(serial, 16, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
815ddc99 126 /* --> seq17 */
988440e7 127 ARK3116_SND(serial, 17, 0xFE, 0x40, 0x0001, 0x0004);
815ddc99
GKH
128
129 /* <-- seq18 */
988440e7 130 ARK3116_RCV(serial, 18, 0xFE, 0xC0, 0x0000, 0x0004, 0x01, buf);
815ddc99
GKH
131
132 /* --> seq19 */
988440e7 133 ARK3116_SND(serial, 19, 0xFE, 0x40, 0x0003, 0x0004);
815ddc99
GKH
134
135 /* <-- seq20 */
988440e7
WL
136 /* seems like serial port status info (RTS, CTS, ...) */
137 /* returns modem control line status?! */
138 ARK3116_RCV(serial, 20, 0xFE, 0xC0, 0x0000, 0x0006, 0xFF, buf);
139
140 /* set 9600 baud & do some init?! */
141 ARK3116_SND(serial, 147, 0xFE, 0x40, 0x0083, 0x0003);
142 ARK3116_SND(serial, 148, 0xFE, 0x40, 0x0038, 0x0000);
143 ARK3116_SND(serial, 149, 0xFE, 0x40, 0x0001, 0x0001);
144 ARK3116_SND(serial, 150, 0xFE, 0x40, 0x0003, 0x0003);
145 ARK3116_RCV(serial, 151, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf);
146 ARK3116_SND(serial, 152, 0xFE, 0x40, 0x0000, 0x0003);
147 ARK3116_RCV(serial, 153, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
148 ARK3116_SND(serial, 154, 0xFE, 0x40, 0x0003, 0x0003);
815ddc99
GKH
149
150 kfree(buf);
988440e7 151 return 0;
815ddc99
GKH
152
153cleanup:
004b4f2d
ON
154 for (--i; i >= 0; --i) {
155 kfree(usb_get_serial_port_data(serial->port[i]));
815ddc99 156 usb_set_serial_port_data(serial->port[i], NULL);
004b4f2d 157 }
815ddc99
GKH
158 return -ENOMEM;
159}
160
95da310e
AC
161static void ark3116_set_termios(struct tty_struct *tty,
162 struct usb_serial_port *port,
606d099c 163 struct ktermios *old_termios)
815ddc99
GKH
164{
165 struct usb_serial *serial = port->serial;
166 struct ark3116_private *priv = usb_get_serial_port_data(port);
95da310e 167 struct ktermios *termios = tty->termios;
adb5dca1 168 unsigned int cflag = termios->c_cflag;
815ddc99
GKH
169 unsigned long flags;
170 int baud;
171 int ark3116_baud;
172 char *buf;
173 char config;
174
175 config = 0;
176
441b62c1 177 dbg("%s - port %d", __func__, port->number);
815ddc99 178
815ddc99
GKH
179 spin_lock_irqsave(&priv->lock, flags);
180 if (!priv->termios_initialized) {
95da310e
AC
181 *termios = tty_std_termios;
182 termios->c_cflag = B9600 | CS8
988440e7 183 | CREAD | HUPCL | CLOCAL;
adb5dca1
AC
184 termios->c_ispeed = 9600;
185 termios->c_ospeed = 9600;
815ddc99
GKH
186 priv->termios_initialized = 1;
187 }
188 spin_unlock_irqrestore(&priv->lock, flags);
189
adb5dca1
AC
190 cflag = termios->c_cflag;
191 termios->c_cflag &= ~(CMSPAR|CRTSCTS);
815ddc99 192
815ddc99
GKH
193 buf = kmalloc(1, GFP_KERNEL);
194 if (!buf) {
195 dbg("error kmalloc");
95da310e 196 *termios = *old_termios;
815ddc99
GKH
197 return;
198 }
199
200 /* set data bit count (8/7/6/5) */
988440e7
WL
201 if (cflag & CSIZE) {
202 switch (cflag & CSIZE) {
815ddc99
GKH
203 case CS5:
204 config |= 0x00;
205 dbg("setting CS5");
206 break;
207 case CS6:
208 config |= 0x01;
209 dbg("setting CS6");
210 break;
211 case CS7:
212 config |= 0x02;
213 dbg("setting CS7");
214 break;
215 default:
568c24ad 216 dbg("CSIZE was set but not CS5-CS8, using CS8!");
988440e7 217 /* fall through */
815ddc99
GKH
218 case CS8:
219 config |= 0x03;
220 dbg("setting CS8");
221 break;
222 }
223 }
224
988440e7
WL
225 /* set parity (NONE/EVEN/ODD) */
226 if (cflag & PARENB) {
815ddc99
GKH
227 if (cflag & PARODD) {
228 config |= 0x08;
229 dbg("setting parity to ODD");
230 } else {
231 config |= 0x18;
232 dbg("setting parity to EVEN");
233 }
234 } else {
235 dbg("setting parity to NONE");
236 }
237
988440e7 238 /* set stop bit (1/2) */
815ddc99
GKH
239 if (cflag & CSTOPB) {
240 config |= 0x04;
988440e7 241 dbg("setting 2 stop bits");
815ddc99 242 } else {
988440e7 243 dbg("setting 1 stop bit");
815ddc99
GKH
244 }
245
988440e7 246 /* set baudrate */
95da310e 247 baud = tty_get_baud_rate(tty);
568c24ad
AC
248
249 switch (baud) {
c4d0f8cb
AC
250 case 75:
251 case 150:
252 case 300:
253 case 600:
254 case 1200:
255 case 1800:
256 case 2400:
257 case 4800:
258 case 9600:
259 case 19200:
260 case 38400:
261 case 57600:
262 case 115200:
263 case 230400:
264 case 460800:
265 /* Report the resulting rate back to the caller */
95da310e 266 tty_encode_baud_rate(tty, baud, baud);
c4d0f8cb
AC
267 break;
268 /* set 9600 as default (if given baudrate is invalid for example) */
269 default:
95da310e 270 tty_encode_baud_rate(tty, 9600, 9600);
c4d0f8cb
AC
271 case 0:
272 baud = 9600;
815ddc99
GKH
273 }
274
815ddc99
GKH
275 /*
276 * found by try'n'error, be careful, maybe there are other options
568c24ad 277 * for multiplicator etc! (3.5 for example)
815ddc99
GKH
278 */
279 if (baud == 460800)
280 /* strange, for 460800 the formula is wrong
988440e7 281 * if using round() then 9600baud is wrong) */
815ddc99
GKH
282 ark3116_baud = 7;
283 else
284 ark3116_baud = 3000000 / baud;
285
286 /* ? */
988440e7
WL
287 ARK3116_RCV(serial, 0, 0xFE, 0xC0, 0x0000, 0x0003, 0x03, buf);
288
815ddc99
GKH
289 /* offset = buf[0]; */
290 /* offset = 0x03; */
988440e7 291 /* dbg("using 0x%04X as target for 0x0003:", 0x0080 + offset); */
815ddc99
GKH
292
293 /* set baudrate */
988440e7
WL
294 dbg("setting baudrate to %d (->reg=%d)", baud, ark3116_baud);
295 ARK3116_SND(serial, 147, 0xFE, 0x40, 0x0083, 0x0003);
296 ARK3116_SND(serial, 148, 0xFE, 0x40,
297 (ark3116_baud & 0x00FF), 0x0000);
298 ARK3116_SND(serial, 149, 0xFE, 0x40,
299 (ark3116_baud & 0xFF00) >> 8, 0x0001);
300 ARK3116_SND(serial, 150, 0xFE, 0x40, 0x0003, 0x0003);
815ddc99
GKH
301
302 /* ? */
988440e7
WL
303 ARK3116_RCV(serial, 151, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf);
304 ARK3116_SND(serial, 152, 0xFE, 0x40, 0x0000, 0x0003);
815ddc99
GKH
305
306 /* set data bit count, stop bit count & parity: */
307 dbg("updating bit count, stop bit or parity (cfg=0x%02X)", config);
988440e7
WL
308 ARK3116_RCV(serial, 153, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
309 ARK3116_SND(serial, 154, 0xFE, 0x40, config, 0x0003);
815ddc99
GKH
310
311 if (cflag & CRTSCTS)
988440e7 312 dbg("CRTSCTS not supported by chipset?!");
815ddc99 313
988440e7 314 /* TEST ARK3116_SND(154, 0xFE, 0x40, 0xFFFF, 0x0006); */
815ddc99
GKH
315
316 kfree(buf);
adb5dca1 317
815ddc99
GKH
318 return;
319}
320
a509a7e4 321static int ark3116_open(struct tty_struct *tty, struct usb_serial_port *port)
815ddc99 322{
606d099c 323 struct ktermios tmp_termios;
815ddc99
GKH
324 struct usb_serial *serial = port->serial;
325 char *buf;
326 int result = 0;
327
441b62c1 328 dbg("%s - port %d", __func__, port->number);
815ddc99
GKH
329
330 buf = kmalloc(1, GFP_KERNEL);
331 if (!buf) {
988440e7 332 dbg("error kmalloc -> out of mem?");
815ddc99
GKH
333 return -ENOMEM;
334 }
335
a509a7e4 336 result = usb_serial_generic_open(tty, port);
815ddc99 337 if (result)
4edf2c83 338 goto err_out;
815ddc99
GKH
339
340 /* open */
988440e7 341 ARK3116_RCV(serial, 111, 0xFE, 0xC0, 0x0000, 0x0003, 0x02, buf);
815ddc99 342
988440e7
WL
343 ARK3116_SND(serial, 112, 0xFE, 0x40, 0x0082, 0x0003);
344 ARK3116_SND(serial, 113, 0xFE, 0x40, 0x001A, 0x0000);
345 ARK3116_SND(serial, 114, 0xFE, 0x40, 0x0000, 0x0001);
346 ARK3116_SND(serial, 115, 0xFE, 0x40, 0x0002, 0x0003);
815ddc99 347
988440e7
WL
348 ARK3116_RCV(serial, 116, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf);
349 ARK3116_SND(serial, 117, 0xFE, 0x40, 0x0002, 0x0004);
815ddc99 350
988440e7
WL
351 ARK3116_RCV(serial, 118, 0xFE, 0xC0, 0x0000, 0x0004, 0x02, buf);
352 ARK3116_SND(serial, 119, 0xFE, 0x40, 0x0000, 0x0004);
815ddc99 353
988440e7 354 ARK3116_RCV(serial, 120, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
815ddc99 355
988440e7 356 ARK3116_SND(serial, 121, 0xFE, 0x40, 0x0001, 0x0004);
815ddc99 357
988440e7 358 ARK3116_RCV(serial, 122, 0xFE, 0xC0, 0x0000, 0x0004, 0x01, buf);
815ddc99 359
988440e7 360 ARK3116_SND(serial, 123, 0xFE, 0x40, 0x0003, 0x0004);
815ddc99 361
988440e7
WL
362 /* returns different values (control lines?!) */
363 ARK3116_RCV(serial, 124, 0xFE, 0xC0, 0x0000, 0x0006, 0xFF, buf);
815ddc99 364
988440e7 365 /* initialise termios */
95da310e
AC
366 if (tty)
367 ark3116_set_termios(tty, port, &tmp_termios);
815ddc99 368
4edf2c83 369err_out:
815ddc99
GKH
370 kfree(buf);
371
372 return result;
815ddc99
GKH
373}
374
95da310e 375static int ark3116_ioctl(struct tty_struct *tty, struct file *file,
815ddc99
GKH
376 unsigned int cmd, unsigned long arg)
377{
95da310e 378 struct usb_serial_port *port = tty->driver_data;
2f430b4b
WL
379 struct serial_struct serstruct;
380 void __user *user_arg = (void __user *)arg;
381
382 switch (cmd) {
383 case TIOCGSERIAL:
384 /* XXX: Some of these values are probably wrong. */
c4d0f8cb 385 memset(&serstruct, 0, sizeof(serstruct));
2f430b4b
WL
386 serstruct.type = PORT_16654;
387 serstruct.line = port->serial->minor;
388 serstruct.port = port->number;
389 serstruct.custom_divisor = 0;
390 serstruct.baud_base = 460800;
391
c4d0f8cb 392 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
2f430b4b
WL
393 return -EFAULT;
394
395 return 0;
396 case TIOCSSERIAL:
c4d0f8cb 397 if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
2f430b4b
WL
398 return -EFAULT;
399 return 0;
400 default:
441b62c1 401 dbg("%s cmd 0x%04x not supported", __func__, cmd);
2f430b4b
WL
402 break;
403 }
404
815ddc99
GKH
405 return -ENOIOCTLCMD;
406}
407
95da310e 408static int ark3116_tiocmget(struct tty_struct *tty, struct file *file)
815ddc99 409{
95da310e 410 struct usb_serial_port *port = tty->driver_data;
815ddc99
GKH
411 struct usb_serial *serial = port->serial;
412 char *buf;
413 char temp;
414
988440e7 415 /* seems like serial port status info (RTS, CTS, ...) is stored
815ddc99
GKH
416 * in reg(?) 0x0006
417 * pcb connection point 11 = GND -> sets bit4 of response
418 * pcb connection point 7 = GND -> sets bit6 of response
419 */
420
421 buf = kmalloc(1, GFP_KERNEL);
422 if (!buf) {
423 dbg("error kmalloc");
424 return -ENOMEM;
425 }
426
988440e7
WL
427 /* read register */
428 ARK3116_RCV_QUIET(serial, 0xFE, 0xC0, 0x0000, 0x0006, buf);
815ddc99
GKH
429 temp = buf[0];
430 kfree(buf);
431
988440e7
WL
432 /* i do not really know if bit4=CTS and bit6=DSR... just a
433 * quick guess!
815ddc99 434 */
988440e7
WL
435 return (temp & (1<<4) ? TIOCM_CTS : 0)
436 | (temp & (1<<6) ? TIOCM_DSR : 0);
815ddc99
GKH
437}
438
439static struct usb_driver ark3116_driver = {
440 .name = "ark3116",
441 .probe = usb_serial_probe,
442 .disconnect = usb_serial_disconnect,
443 .id_table = id_table,
d9b1b787 444 .no_dynamic_id = 1,
815ddc99
GKH
445};
446
447static struct usb_serial_driver ark3116_device = {
448 .driver = {
449 .owner = THIS_MODULE,
450 .name = "ark3116",
451 },
452 .id_table = id_table,
d9b1b787 453 .usb_driver = &ark3116_driver,
815ddc99
GKH
454 .num_ports = 1,
455 .attach = ark3116_attach,
456 .set_termios = ark3116_set_termios,
457 .ioctl = ark3116_ioctl,
458 .tiocmget = ark3116_tiocmget,
459 .open = ark3116_open,
460};
461
462static int __init ark3116_init(void)
463{
464 int retval;
465
466 retval = usb_serial_register(&ark3116_device);
467 if (retval)
468 return retval;
469 retval = usb_register(&ark3116_driver);
470 if (retval)
471 usb_serial_deregister(&ark3116_device);
472 return retval;
473}
474
475static void __exit ark3116_exit(void)
476{
477 usb_deregister(&ark3116_driver);
478 usb_serial_deregister(&ark3116_device);
479}
480
481module_init(ark3116_init);
482module_exit(ark3116_exit);
483MODULE_LICENSE("GPL");
484
485module_param(debug, bool, S_IRUGO | S_IWUSR);
486MODULE_PARM_DESC(debug, "Debug enabled or not");
487
This page took 0.429138 seconds and 5 git commands to generate.