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