Loading...
1/*
2 * Copyright (C) 2009 by Bart Hartgers (bart.hartgers+ark3116@gmail.com)
3 * Original version:
4 * Copyright (C) 2006
5 * Simon Schulz (ark3116_driver <at> auctionant.de)
6 *
7 * ark3116
8 * - implements a driver for the arkmicro ark3116 chipset (vendor=0x6547,
9 * productid=0x0232) (used in a datacable called KQ-U8A)
10 *
11 * Supports full modem status lines, break, hardware flow control. Does not
12 * support software flow control, since I do not know how to enable it in hw.
13 *
14 * This driver is a essentially new implementation. I initially dug
15 * into the old ark3116.c driver and suddenly realized the ark3116 is
16 * a 16450 with a USB interface glued to it. See comments at the
17 * bottom of this file.
18 *
19 * This program is free software; you can redistribute it and/or modify it
20 * under the terms of the GNU General Public License as published by the
21 * Free Software Foundation; either version 2 of the License, or (at your
22 * option) any later version.
23 */
24
25#include <linux/kernel.h>
26#include <linux/ioctl.h>
27#include <linux/tty.h>
28#include <linux/slab.h>
29#include <linux/tty_flip.h>
30#include <linux/module.h>
31#include <linux/usb.h>
32#include <linux/usb/serial.h>
33#include <linux/serial.h>
34#include <linux/serial_reg.h>
35#include <linux/uaccess.h>
36#include <linux/mutex.h>
37#include <linux/spinlock.h>
38
39#define DRIVER_AUTHOR "Bart Hartgers <bart.hartgers+ark3116@gmail.com>"
40#define DRIVER_DESC "USB ARK3116 serial/IrDA driver"
41#define DRIVER_DEV_DESC "ARK3116 RS232/IrDA"
42#define DRIVER_NAME "ark3116"
43
44/* usb timeout of 1 second */
45#define ARK_TIMEOUT 1000
46
47static const struct usb_device_id id_table[] = {
48 { USB_DEVICE(0x6547, 0x0232) },
49 { USB_DEVICE(0x18ec, 0x3118) }, /* USB to IrDA adapter */
50 { },
51};
52MODULE_DEVICE_TABLE(usb, id_table);
53
54static int is_irda(struct usb_serial *serial)
55{
56 struct usb_device *dev = serial->dev;
57 if (le16_to_cpu(dev->descriptor.idVendor) == 0x18ec &&
58 le16_to_cpu(dev->descriptor.idProduct) == 0x3118)
59 return 1;
60 return 0;
61}
62
63struct ark3116_private {
64 int irda; /* 1 for irda device */
65
66 /* protects hw register updates */
67 struct mutex hw_lock;
68
69 int quot; /* baudrate divisor */
70 __u32 lcr; /* line control register value */
71 __u32 hcr; /* handshake control register (0x8)
72 * value */
73 __u32 mcr; /* modem control register value */
74
75 /* protects the status values below */
76 spinlock_t status_lock;
77 __u32 msr; /* modem status register value */
78 __u32 lsr; /* line status register value */
79};
80
81static int ark3116_write_reg(struct usb_serial *serial,
82 unsigned reg, __u8 val)
83{
84 int result;
85 /* 0xfe 0x40 are magic values taken from original driver */
86 result = usb_control_msg(serial->dev,
87 usb_sndctrlpipe(serial->dev, 0),
88 0xfe, 0x40, val, reg,
89 NULL, 0, ARK_TIMEOUT);
90 return result;
91}
92
93static int ark3116_read_reg(struct usb_serial *serial,
94 unsigned reg, unsigned char *buf)
95{
96 int result;
97 /* 0xfe 0xc0 are magic values taken from original driver */
98 result = usb_control_msg(serial->dev,
99 usb_rcvctrlpipe(serial->dev, 0),
100 0xfe, 0xc0, 0, reg,
101 buf, 1, ARK_TIMEOUT);
102 if (result < 0)
103 return result;
104 else
105 return buf[0];
106}
107
108static inline int calc_divisor(int bps)
109{
110 /* Original ark3116 made some exceptions in rounding here
111 * because windows did the same. Assume that is not really
112 * necessary.
113 * Crystal is 12MHz, probably because of USB, but we divide by 4?
114 */
115 return (12000000 + 2*bps) / (4*bps);
116}
117
118static int ark3116_attach(struct usb_serial *serial)
119{
120 /* make sure we have our end-points */
121 if ((serial->num_bulk_in == 0) ||
122 (serial->num_bulk_out == 0) ||
123 (serial->num_interrupt_in == 0)) {
124 dev_err(&serial->dev->dev,
125 "%s - missing endpoint - "
126 "bulk in: %d, bulk out: %d, int in %d\n",
127 KBUILD_MODNAME,
128 serial->num_bulk_in,
129 serial->num_bulk_out,
130 serial->num_interrupt_in);
131 return -EINVAL;
132 }
133
134 return 0;
135}
136
137static int ark3116_port_probe(struct usb_serial_port *port)
138{
139 struct usb_serial *serial = port->serial;
140 struct ark3116_private *priv;
141
142 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
143 if (!priv)
144 return -ENOMEM;
145
146 mutex_init(&priv->hw_lock);
147 spin_lock_init(&priv->status_lock);
148
149 priv->irda = is_irda(serial);
150
151 usb_set_serial_port_data(port, priv);
152
153 /* setup the hardware */
154 ark3116_write_reg(serial, UART_IER, 0);
155 /* disable DMA */
156 ark3116_write_reg(serial, UART_FCR, 0);
157 /* handshake control */
158 priv->hcr = 0;
159 ark3116_write_reg(serial, 0x8 , 0);
160 /* modem control */
161 priv->mcr = 0;
162 ark3116_write_reg(serial, UART_MCR, 0);
163
164 if (!(priv->irda)) {
165 ark3116_write_reg(serial, 0xb , 0);
166 } else {
167 ark3116_write_reg(serial, 0xb , 1);
168 ark3116_write_reg(serial, 0xc , 0);
169 ark3116_write_reg(serial, 0xd , 0x41);
170 ark3116_write_reg(serial, 0xa , 1);
171 }
172
173 /* setup baudrate */
174 ark3116_write_reg(serial, UART_LCR, UART_LCR_DLAB);
175
176 /* setup for 9600 8N1 */
177 priv->quot = calc_divisor(9600);
178 ark3116_write_reg(serial, UART_DLL, priv->quot & 0xff);
179 ark3116_write_reg(serial, UART_DLM, (priv->quot>>8) & 0xff);
180
181 priv->lcr = UART_LCR_WLEN8;
182 ark3116_write_reg(serial, UART_LCR, UART_LCR_WLEN8);
183
184 ark3116_write_reg(serial, 0xe, 0);
185
186 if (priv->irda)
187 ark3116_write_reg(serial, 0x9, 0);
188
189 dev_info(&serial->dev->dev,
190 "%s using %s mode\n",
191 KBUILD_MODNAME,
192 priv->irda ? "IrDA" : "RS232");
193 return 0;
194}
195
196static int ark3116_port_remove(struct usb_serial_port *port)
197{
198 struct ark3116_private *priv = usb_get_serial_port_data(port);
199
200 /* device is closed, so URBs and DMA should be down */
201 mutex_destroy(&priv->hw_lock);
202 kfree(priv);
203
204 return 0;
205}
206
207static void ark3116_init_termios(struct tty_struct *tty)
208{
209 struct ktermios *termios = &tty->termios;
210 *termios = tty_std_termios;
211 termios->c_cflag = B9600 | CS8
212 | CREAD | HUPCL | CLOCAL;
213 termios->c_ispeed = 9600;
214 termios->c_ospeed = 9600;
215}
216
217static void ark3116_set_termios(struct tty_struct *tty,
218 struct usb_serial_port *port,
219 struct ktermios *old_termios)
220{
221 struct usb_serial *serial = port->serial;
222 struct ark3116_private *priv = usb_get_serial_port_data(port);
223 struct ktermios *termios = &tty->termios;
224 unsigned int cflag = termios->c_cflag;
225 int bps = tty_get_baud_rate(tty);
226 int quot;
227 __u8 lcr, hcr, eval;
228
229 /* set data bit count */
230 switch (cflag & CSIZE) {
231 case CS5:
232 lcr = UART_LCR_WLEN5;
233 break;
234 case CS6:
235 lcr = UART_LCR_WLEN6;
236 break;
237 case CS7:
238 lcr = UART_LCR_WLEN7;
239 break;
240 default:
241 case CS8:
242 lcr = UART_LCR_WLEN8;
243 break;
244 }
245 if (cflag & CSTOPB)
246 lcr |= UART_LCR_STOP;
247 if (cflag & PARENB)
248 lcr |= UART_LCR_PARITY;
249 if (!(cflag & PARODD))
250 lcr |= UART_LCR_EPAR;
251#ifdef CMSPAR
252 if (cflag & CMSPAR)
253 lcr |= UART_LCR_SPAR;
254#endif
255 /* handshake control */
256 hcr = (cflag & CRTSCTS) ? 0x03 : 0x00;
257
258 /* calc baudrate */
259 dev_dbg(&port->dev, "%s - setting bps to %d\n", __func__, bps);
260 eval = 0;
261 switch (bps) {
262 case 0:
263 quot = calc_divisor(9600);
264 break;
265 default:
266 if ((bps < 75) || (bps > 3000000))
267 bps = 9600;
268 quot = calc_divisor(bps);
269 break;
270 case 460800:
271 eval = 1;
272 quot = calc_divisor(bps);
273 break;
274 case 921600:
275 eval = 2;
276 quot = calc_divisor(bps);
277 break;
278 }
279
280 /* Update state: synchronize */
281 mutex_lock(&priv->hw_lock);
282
283 /* keep old LCR_SBC bit */
284 lcr |= (priv->lcr & UART_LCR_SBC);
285
286 dev_dbg(&port->dev, "%s - setting hcr:0x%02x,lcr:0x%02x,quot:%d\n",
287 __func__, hcr, lcr, quot);
288
289 /* handshake control */
290 if (priv->hcr != hcr) {
291 priv->hcr = hcr;
292 ark3116_write_reg(serial, 0x8, hcr);
293 }
294
295 /* baudrate */
296 if (priv->quot != quot) {
297 priv->quot = quot;
298 priv->lcr = lcr; /* need to write lcr anyway */
299
300 /* disable DMA since transmit/receive is
301 * shadowed by UART_DLL
302 */
303 ark3116_write_reg(serial, UART_FCR, 0);
304
305 ark3116_write_reg(serial, UART_LCR,
306 lcr|UART_LCR_DLAB);
307 ark3116_write_reg(serial, UART_DLL, quot & 0xff);
308 ark3116_write_reg(serial, UART_DLM, (quot>>8) & 0xff);
309
310 /* restore lcr */
311 ark3116_write_reg(serial, UART_LCR, lcr);
312 /* magic baudrate thingy: not sure what it does,
313 * but windows does this as well.
314 */
315 ark3116_write_reg(serial, 0xe, eval);
316
317 /* enable DMA */
318 ark3116_write_reg(serial, UART_FCR, UART_FCR_DMA_SELECT);
319 } else if (priv->lcr != lcr) {
320 priv->lcr = lcr;
321 ark3116_write_reg(serial, UART_LCR, lcr);
322 }
323
324 mutex_unlock(&priv->hw_lock);
325
326 /* check for software flow control */
327 if (I_IXOFF(tty) || I_IXON(tty)) {
328 dev_warn(&serial->dev->dev,
329 "%s: don't know how to do software flow control\n",
330 KBUILD_MODNAME);
331 }
332
333 /* Don't rewrite B0 */
334 if (tty_termios_baud_rate(termios))
335 tty_termios_encode_baud_rate(termios, bps, bps);
336}
337
338static void ark3116_close(struct usb_serial_port *port)
339{
340 struct usb_serial *serial = port->serial;
341
342 /* disable DMA */
343 ark3116_write_reg(serial, UART_FCR, 0);
344
345 /* deactivate interrupts */
346 ark3116_write_reg(serial, UART_IER, 0);
347
348 usb_serial_generic_close(port);
349 if (serial->num_interrupt_in)
350 usb_kill_urb(port->interrupt_in_urb);
351}
352
353static int ark3116_open(struct tty_struct *tty, struct usb_serial_port *port)
354{
355 struct ark3116_private *priv = usb_get_serial_port_data(port);
356 struct usb_serial *serial = port->serial;
357 unsigned char *buf;
358 int result;
359
360 buf = kmalloc(1, GFP_KERNEL);
361 if (buf == NULL)
362 return -ENOMEM;
363
364 result = usb_serial_generic_open(tty, port);
365 if (result) {
366 dev_dbg(&port->dev,
367 "%s - usb_serial_generic_open failed: %d\n",
368 __func__, result);
369 goto err_out;
370 }
371
372 /* remove any data still left: also clears error state */
373 ark3116_read_reg(serial, UART_RX, buf);
374
375 /* read modem status */
376 priv->msr = ark3116_read_reg(serial, UART_MSR, buf);
377 /* read line status */
378 priv->lsr = ark3116_read_reg(serial, UART_LSR, buf);
379
380 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
381 if (result) {
382 dev_err(&port->dev, "submit irq_in urb failed %d\n",
383 result);
384 ark3116_close(port);
385 goto err_out;
386 }
387
388 /* activate interrupts */
389 ark3116_write_reg(port->serial, UART_IER, UART_IER_MSI|UART_IER_RLSI);
390
391 /* enable DMA */
392 ark3116_write_reg(port->serial, UART_FCR, UART_FCR_DMA_SELECT);
393
394 /* setup termios */
395 if (tty)
396 ark3116_set_termios(tty, port, NULL);
397
398err_out:
399 kfree(buf);
400 return result;
401}
402
403static int ark3116_ioctl(struct tty_struct *tty,
404 unsigned int cmd, unsigned long arg)
405{
406 struct usb_serial_port *port = tty->driver_data;
407 struct serial_struct serstruct;
408 void __user *user_arg = (void __user *)arg;
409
410 switch (cmd) {
411 case TIOCGSERIAL:
412 /* XXX: Some of these values are probably wrong. */
413 memset(&serstruct, 0, sizeof(serstruct));
414 serstruct.type = PORT_16654;
415 serstruct.line = port->minor;
416 serstruct.port = port->port_number;
417 serstruct.custom_divisor = 0;
418 serstruct.baud_base = 460800;
419
420 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
421 return -EFAULT;
422
423 return 0;
424 case TIOCSSERIAL:
425 if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
426 return -EFAULT;
427 return 0;
428 }
429
430 return -ENOIOCTLCMD;
431}
432
433static int ark3116_tiocmget(struct tty_struct *tty)
434{
435 struct usb_serial_port *port = tty->driver_data;
436 struct ark3116_private *priv = usb_get_serial_port_data(port);
437 __u32 status;
438 __u32 ctrl;
439 unsigned long flags;
440
441 mutex_lock(&priv->hw_lock);
442 ctrl = priv->mcr;
443 mutex_unlock(&priv->hw_lock);
444
445 spin_lock_irqsave(&priv->status_lock, flags);
446 status = priv->msr;
447 spin_unlock_irqrestore(&priv->status_lock, flags);
448
449 return (status & UART_MSR_DSR ? TIOCM_DSR : 0) |
450 (status & UART_MSR_CTS ? TIOCM_CTS : 0) |
451 (status & UART_MSR_RI ? TIOCM_RI : 0) |
452 (status & UART_MSR_DCD ? TIOCM_CD : 0) |
453 (ctrl & UART_MCR_DTR ? TIOCM_DTR : 0) |
454 (ctrl & UART_MCR_RTS ? TIOCM_RTS : 0) |
455 (ctrl & UART_MCR_OUT1 ? TIOCM_OUT1 : 0) |
456 (ctrl & UART_MCR_OUT2 ? TIOCM_OUT2 : 0);
457}
458
459static int ark3116_tiocmset(struct tty_struct *tty,
460 unsigned set, unsigned clr)
461{
462 struct usb_serial_port *port = tty->driver_data;
463 struct ark3116_private *priv = usb_get_serial_port_data(port);
464
465 /* we need to take the mutex here, to make sure that the value
466 * in priv->mcr is actually the one that is in the hardware
467 */
468
469 mutex_lock(&priv->hw_lock);
470
471 if (set & TIOCM_RTS)
472 priv->mcr |= UART_MCR_RTS;
473 if (set & TIOCM_DTR)
474 priv->mcr |= UART_MCR_DTR;
475 if (set & TIOCM_OUT1)
476 priv->mcr |= UART_MCR_OUT1;
477 if (set & TIOCM_OUT2)
478 priv->mcr |= UART_MCR_OUT2;
479 if (clr & TIOCM_RTS)
480 priv->mcr &= ~UART_MCR_RTS;
481 if (clr & TIOCM_DTR)
482 priv->mcr &= ~UART_MCR_DTR;
483 if (clr & TIOCM_OUT1)
484 priv->mcr &= ~UART_MCR_OUT1;
485 if (clr & TIOCM_OUT2)
486 priv->mcr &= ~UART_MCR_OUT2;
487
488 ark3116_write_reg(port->serial, UART_MCR, priv->mcr);
489
490 mutex_unlock(&priv->hw_lock);
491
492 return 0;
493}
494
495static void ark3116_break_ctl(struct tty_struct *tty, int break_state)
496{
497 struct usb_serial_port *port = tty->driver_data;
498 struct ark3116_private *priv = usb_get_serial_port_data(port);
499
500 /* LCR is also used for other things: protect access */
501 mutex_lock(&priv->hw_lock);
502
503 if (break_state)
504 priv->lcr |= UART_LCR_SBC;
505 else
506 priv->lcr &= ~UART_LCR_SBC;
507
508 ark3116_write_reg(port->serial, UART_LCR, priv->lcr);
509
510 mutex_unlock(&priv->hw_lock);
511}
512
513static void ark3116_update_msr(struct usb_serial_port *port, __u8 msr)
514{
515 struct ark3116_private *priv = usb_get_serial_port_data(port);
516 unsigned long flags;
517
518 spin_lock_irqsave(&priv->status_lock, flags);
519 priv->msr = msr;
520 spin_unlock_irqrestore(&priv->status_lock, flags);
521
522 if (msr & UART_MSR_ANY_DELTA) {
523 /* update input line counters */
524 if (msr & UART_MSR_DCTS)
525 port->icount.cts++;
526 if (msr & UART_MSR_DDSR)
527 port->icount.dsr++;
528 if (msr & UART_MSR_DDCD)
529 port->icount.dcd++;
530 if (msr & UART_MSR_TERI)
531 port->icount.rng++;
532 wake_up_interruptible(&port->port.delta_msr_wait);
533 }
534}
535
536static void ark3116_update_lsr(struct usb_serial_port *port, __u8 lsr)
537{
538 struct ark3116_private *priv = usb_get_serial_port_data(port);
539 unsigned long flags;
540
541 spin_lock_irqsave(&priv->status_lock, flags);
542 /* combine bits */
543 priv->lsr |= lsr;
544 spin_unlock_irqrestore(&priv->status_lock, flags);
545
546 if (lsr&UART_LSR_BRK_ERROR_BITS) {
547 if (lsr & UART_LSR_BI)
548 port->icount.brk++;
549 if (lsr & UART_LSR_FE)
550 port->icount.frame++;
551 if (lsr & UART_LSR_PE)
552 port->icount.parity++;
553 if (lsr & UART_LSR_OE)
554 port->icount.overrun++;
555 }
556}
557
558static void ark3116_read_int_callback(struct urb *urb)
559{
560 struct usb_serial_port *port = urb->context;
561 int status = urb->status;
562 const __u8 *data = urb->transfer_buffer;
563 int result;
564
565 switch (status) {
566 case -ECONNRESET:
567 case -ENOENT:
568 case -ESHUTDOWN:
569 /* this urb is terminated, clean up */
570 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
571 __func__, status);
572 return;
573 default:
574 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
575 __func__, status);
576 break;
577 case 0: /* success */
578 /* discovered this by trail and error... */
579 if ((urb->actual_length == 4) && (data[0] == 0xe8)) {
580 const __u8 id = data[1]&UART_IIR_ID;
581 dev_dbg(&port->dev, "%s: iir=%02x\n", __func__, data[1]);
582 if (id == UART_IIR_MSI) {
583 dev_dbg(&port->dev, "%s: msr=%02x\n",
584 __func__, data[3]);
585 ark3116_update_msr(port, data[3]);
586 break;
587 } else if (id == UART_IIR_RLSI) {
588 dev_dbg(&port->dev, "%s: lsr=%02x\n",
589 __func__, data[2]);
590 ark3116_update_lsr(port, data[2]);
591 break;
592 }
593 }
594 /*
595 * Not sure what this data meant...
596 */
597 usb_serial_debug_data(&port->dev, __func__,
598 urb->actual_length,
599 urb->transfer_buffer);
600 break;
601 }
602
603 result = usb_submit_urb(urb, GFP_ATOMIC);
604 if (result)
605 dev_err(&urb->dev->dev,
606 "%s - Error %d submitting interrupt urb\n",
607 __func__, result);
608}
609
610
611/* Data comes in via the bulk (data) URB, errors/interrupts via the int URB.
612 * This means that we cannot be sure which data byte has an associated error
613 * condition, so we report an error for all data in the next bulk read.
614 *
615 * Actually, there might even be a window between the bulk data leaving the
616 * ark and reading/resetting the lsr in the read_bulk_callback where an
617 * interrupt for the next data block could come in.
618 * Without somekind of ordering on the ark, we would have to report the
619 * error for the next block of data as well...
620 * For now, let's pretend this can't happen.
621 */
622static void ark3116_process_read_urb(struct urb *urb)
623{
624 struct usb_serial_port *port = urb->context;
625 struct ark3116_private *priv = usb_get_serial_port_data(port);
626 unsigned char *data = urb->transfer_buffer;
627 char tty_flag = TTY_NORMAL;
628 unsigned long flags;
629 __u32 lsr;
630
631 /* update line status */
632 spin_lock_irqsave(&priv->status_lock, flags);
633 lsr = priv->lsr;
634 priv->lsr &= ~UART_LSR_BRK_ERROR_BITS;
635 spin_unlock_irqrestore(&priv->status_lock, flags);
636
637 if (!urb->actual_length)
638 return;
639
640 if (lsr & UART_LSR_BRK_ERROR_BITS) {
641 if (lsr & UART_LSR_BI)
642 tty_flag = TTY_BREAK;
643 else if (lsr & UART_LSR_PE)
644 tty_flag = TTY_PARITY;
645 else if (lsr & UART_LSR_FE)
646 tty_flag = TTY_FRAME;
647
648 /* overrun is special, not associated with a char */
649 if (lsr & UART_LSR_OE)
650 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
651 }
652 tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
653 urb->actual_length);
654 tty_flip_buffer_push(&port->port);
655}
656
657static struct usb_serial_driver ark3116_device = {
658 .driver = {
659 .owner = THIS_MODULE,
660 .name = "ark3116",
661 },
662 .id_table = id_table,
663 .num_ports = 1,
664 .attach = ark3116_attach,
665 .port_probe = ark3116_port_probe,
666 .port_remove = ark3116_port_remove,
667 .set_termios = ark3116_set_termios,
668 .init_termios = ark3116_init_termios,
669 .ioctl = ark3116_ioctl,
670 .tiocmget = ark3116_tiocmget,
671 .tiocmset = ark3116_tiocmset,
672 .tiocmiwait = usb_serial_generic_tiocmiwait,
673 .get_icount = usb_serial_generic_get_icount,
674 .open = ark3116_open,
675 .close = ark3116_close,
676 .break_ctl = ark3116_break_ctl,
677 .read_int_callback = ark3116_read_int_callback,
678 .process_read_urb = ark3116_process_read_urb,
679};
680
681static struct usb_serial_driver * const serial_drivers[] = {
682 &ark3116_device, NULL
683};
684
685module_usb_serial_driver(serial_drivers, id_table);
686
687MODULE_LICENSE("GPL");
688
689MODULE_AUTHOR(DRIVER_AUTHOR);
690MODULE_DESCRIPTION(DRIVER_DESC);
691
692/*
693 * The following describes what I learned from studying the old
694 * ark3116.c driver, disassembling the windows driver, and some lucky
695 * guesses. Since I do not have any datasheet or other
696 * documentation, inaccuracies are almost guaranteed.
697 *
698 * Some specs for the ARK3116 can be found here:
699 * http://web.archive.org/web/20060318000438/
700 * www.arkmicro.com/en/products/view.php?id=10
701 * On that page, 2 GPIO pins are mentioned: I assume these are the
702 * OUT1 and OUT2 pins of the UART, so I added support for those
703 * through the MCR. Since the pins are not available on my hardware,
704 * I could not verify this.
705 * Also, it states there is "on-chip hardware flow control". I have
706 * discovered how to enable that. Unfortunately, I do not know how to
707 * enable XON/XOFF (software) flow control, which would need support
708 * from the chip as well to work. Because of the wording on the web
709 * page there is a real possibility the chip simply does not support
710 * software flow control.
711 *
712 * I got my ark3116 as part of a mobile phone adapter cable. On the
713 * PCB, the following numbered contacts are present:
714 *
715 * 1:- +5V
716 * 2:o DTR
717 * 3:i RX
718 * 4:i DCD
719 * 5:o RTS
720 * 6:o TX
721 * 7:i RI
722 * 8:i DSR
723 * 10:- 0V
724 * 11:i CTS
725 *
726 * On my chip, all signals seem to be 3.3V, but 5V tolerant. But that
727 * may be different for the one you have ;-).
728 *
729 * The windows driver limits the registers to 0-F, so I assume there
730 * are actually 16 present on the device.
731 *
732 * On an UART interrupt, 4 bytes of data come in on the interrupt
733 * endpoint. The bytes are 0xe8 IIR LSR MSR.
734 *
735 * The baudrate seems to be generated from the 12MHz crystal, using
736 * 4-times subsampling. So quot=12e6/(4*baud). Also see description
737 * of register E.
738 *
739 * Registers 0-7:
740 * These seem to be the same as for a regular 16450. The FCR is set
741 * to UART_FCR_DMA_SELECT (0x8), I guess to enable transfers between
742 * the UART and the USB bridge/DMA engine.
743 *
744 * Register 8:
745 * By trial and error, I found out that bit 0 enables hardware CTS,
746 * stopping TX when CTS is +5V. Bit 1 does the same for RTS, making
747 * RTS +5V when the 3116 cannot transfer the data to the USB bus
748 * (verified by disabling the reading URB). Note that as far as I can
749 * tell, the windows driver does NOT use this, so there might be some
750 * hardware bug or something.
751 *
752 * According to a patch provided here
753 * (http://lkml.org/lkml/2009/7/26/56), the ARK3116 can also be used
754 * as an IrDA dongle. Since I do not have such a thing, I could not
755 * investigate that aspect. However, I can speculate ;-).
756 *
757 * - IrDA encodes data differently than RS232. Most likely, one of
758 * the bits in registers 9..E enables the IR ENDEC (encoder/decoder).
759 * - Depending on the IR transceiver, the input and output need to be
760 * inverted, so there are probably bits for that as well.
761 * - IrDA is half-duplex, so there should be a bit for selecting that.
762 *
763 * This still leaves at least two registers unaccounted for. Perhaps
764 * The chip can do XON/XOFF or CRC in HW?
765 *
766 * Register 9:
767 * Set to 0x00 for IrDA, when the baudrate is initialised.
768 *
769 * Register A:
770 * Set to 0x01 for IrDA, at init.
771 *
772 * Register B:
773 * Set to 0x01 for IrDA, 0x00 for RS232, at init.
774 *
775 * Register C:
776 * Set to 00 for IrDA, at init.
777 *
778 * Register D:
779 * Set to 0x41 for IrDA, at init.
780 *
781 * Register E:
782 * Somekind of baudrate override. The windows driver seems to set
783 * this to 0x00 for normal baudrates, 0x01 for 460800, 0x02 for 921600.
784 * Since 460800 and 921600 cannot be obtained by dividing 3MHz by an integer,
785 * it could be somekind of subdivisor thingy.
786 * However,it does not seem to do anything: selecting 921600 (divisor 3,
787 * reg E=2), still gets 1 MHz. I also checked if registers 9, C or F would
788 * work, but they don't.
789 *
790 * Register F: unknown
791 */
1/*
2 * Copyright (C) 2009 by Bart Hartgers (bart.hartgers+ark3116@gmail.com)
3 * Original version:
4 * Copyright (C) 2006
5 * Simon Schulz (ark3116_driver <at> auctionant.de)
6 *
7 * ark3116
8 * - implements a driver for the arkmicro ark3116 chipset (vendor=0x6547,
9 * productid=0x0232) (used in a datacable called KQ-U8A)
10 *
11 * Supports full modem status lines, break, hardware flow control. Does not
12 * support software flow control, since I do not know how to enable it in hw.
13 *
14 * This driver is a essentially new implementation. I initially dug
15 * into the old ark3116.c driver and suddenly realized the ark3116 is
16 * a 16450 with a USB interface glued to it. See comments at the
17 * bottom of this file.
18 *
19 * This program is free software; you can redistribute it and/or modify it
20 * under the terms of the GNU General Public License as published by the
21 * Free Software Foundation; either version 2 of the License, or (at your
22 * option) any later version.
23 */
24
25#include <linux/kernel.h>
26#include <linux/init.h>
27#include <linux/ioctl.h>
28#include <linux/tty.h>
29#include <linux/slab.h>
30#include <linux/tty_flip.h>
31#include <linux/module.h>
32#include <linux/usb.h>
33#include <linux/usb/serial.h>
34#include <linux/serial.h>
35#include <linux/serial_reg.h>
36#include <linux/uaccess.h>
37#include <linux/mutex.h>
38#include <linux/spinlock.h>
39
40static bool debug;
41/*
42 * Version information
43 */
44
45#define DRIVER_VERSION "v0.7"
46#define DRIVER_AUTHOR "Bart Hartgers <bart.hartgers+ark3116@gmail.com>"
47#define DRIVER_DESC "USB ARK3116 serial/IrDA driver"
48#define DRIVER_DEV_DESC "ARK3116 RS232/IrDA"
49#define DRIVER_NAME "ark3116"
50
51/* usb timeout of 1 second */
52#define ARK_TIMEOUT (1*HZ)
53
54static const struct usb_device_id id_table[] = {
55 { USB_DEVICE(0x6547, 0x0232) },
56 { USB_DEVICE(0x18ec, 0x3118) }, /* USB to IrDA adapter */
57 { },
58};
59MODULE_DEVICE_TABLE(usb, id_table);
60
61static int is_irda(struct usb_serial *serial)
62{
63 struct usb_device *dev = serial->dev;
64 if (le16_to_cpu(dev->descriptor.idVendor) == 0x18ec &&
65 le16_to_cpu(dev->descriptor.idProduct) == 0x3118)
66 return 1;
67 return 0;
68}
69
70struct ark3116_private {
71 wait_queue_head_t delta_msr_wait;
72 struct async_icount icount;
73 int irda; /* 1 for irda device */
74
75 /* protects hw register updates */
76 struct mutex hw_lock;
77
78 int quot; /* baudrate divisor */
79 __u32 lcr; /* line control register value */
80 __u32 hcr; /* handshake control register (0x8)
81 * value */
82 __u32 mcr; /* modem contol register value */
83
84 /* protects the status values below */
85 spinlock_t status_lock;
86 __u32 msr; /* modem status register value */
87 __u32 lsr; /* line status register value */
88};
89
90static int ark3116_write_reg(struct usb_serial *serial,
91 unsigned reg, __u8 val)
92{
93 int result;
94 /* 0xfe 0x40 are magic values taken from original driver */
95 result = usb_control_msg(serial->dev,
96 usb_sndctrlpipe(serial->dev, 0),
97 0xfe, 0x40, val, reg,
98 NULL, 0, ARK_TIMEOUT);
99 return result;
100}
101
102static int ark3116_read_reg(struct usb_serial *serial,
103 unsigned reg, unsigned char *buf)
104{
105 int result;
106 /* 0xfe 0xc0 are magic values taken from original driver */
107 result = usb_control_msg(serial->dev,
108 usb_rcvctrlpipe(serial->dev, 0),
109 0xfe, 0xc0, 0, reg,
110 buf, 1, ARK_TIMEOUT);
111 if (result < 0)
112 return result;
113 else
114 return buf[0];
115}
116
117static inline int calc_divisor(int bps)
118{
119 /* Original ark3116 made some exceptions in rounding here
120 * because windows did the same. Assume that is not really
121 * necessary.
122 * Crystal is 12MHz, probably because of USB, but we divide by 4?
123 */
124 return (12000000 + 2*bps) / (4*bps);
125}
126
127static int ark3116_attach(struct usb_serial *serial)
128{
129 struct usb_serial_port *port = serial->port[0];
130 struct ark3116_private *priv;
131
132 /* make sure we have our end-points */
133 if ((serial->num_bulk_in == 0) ||
134 (serial->num_bulk_out == 0) ||
135 (serial->num_interrupt_in == 0)) {
136 dev_err(&serial->dev->dev,
137 "%s - missing endpoint - "
138 "bulk in: %d, bulk out: %d, int in %d\n",
139 KBUILD_MODNAME,
140 serial->num_bulk_in,
141 serial->num_bulk_out,
142 serial->num_interrupt_in);
143 return -EINVAL;
144 }
145
146 priv = kzalloc(sizeof(struct ark3116_private),
147 GFP_KERNEL);
148 if (!priv)
149 return -ENOMEM;
150
151 init_waitqueue_head(&priv->delta_msr_wait);
152 mutex_init(&priv->hw_lock);
153 spin_lock_init(&priv->status_lock);
154
155 priv->irda = is_irda(serial);
156
157 usb_set_serial_port_data(port, priv);
158
159 /* setup the hardware */
160 ark3116_write_reg(serial, UART_IER, 0);
161 /* disable DMA */
162 ark3116_write_reg(serial, UART_FCR, 0);
163 /* handshake control */
164 priv->hcr = 0;
165 ark3116_write_reg(serial, 0x8 , 0);
166 /* modem control */
167 priv->mcr = 0;
168 ark3116_write_reg(serial, UART_MCR, 0);
169
170 if (!(priv->irda)) {
171 ark3116_write_reg(serial, 0xb , 0);
172 } else {
173 ark3116_write_reg(serial, 0xb , 1);
174 ark3116_write_reg(serial, 0xc , 0);
175 ark3116_write_reg(serial, 0xd , 0x41);
176 ark3116_write_reg(serial, 0xa , 1);
177 }
178
179 /* setup baudrate */
180 ark3116_write_reg(serial, UART_LCR, UART_LCR_DLAB);
181
182 /* setup for 9600 8N1 */
183 priv->quot = calc_divisor(9600);
184 ark3116_write_reg(serial, UART_DLL, priv->quot & 0xff);
185 ark3116_write_reg(serial, UART_DLM, (priv->quot>>8) & 0xff);
186
187 priv->lcr = UART_LCR_WLEN8;
188 ark3116_write_reg(serial, UART_LCR, UART_LCR_WLEN8);
189
190 ark3116_write_reg(serial, 0xe, 0);
191
192 if (priv->irda)
193 ark3116_write_reg(serial, 0x9, 0);
194
195 dev_info(&serial->dev->dev,
196 "%s using %s mode\n",
197 KBUILD_MODNAME,
198 priv->irda ? "IrDA" : "RS232");
199 return 0;
200}
201
202static void ark3116_release(struct usb_serial *serial)
203{
204 struct usb_serial_port *port = serial->port[0];
205 struct ark3116_private *priv = usb_get_serial_port_data(port);
206
207 /* device is closed, so URBs and DMA should be down */
208
209 usb_set_serial_port_data(port, NULL);
210
211 mutex_destroy(&priv->hw_lock);
212
213 kfree(priv);
214}
215
216static void ark3116_init_termios(struct tty_struct *tty)
217{
218 struct ktermios *termios = tty->termios;
219 *termios = tty_std_termios;
220 termios->c_cflag = B9600 | CS8
221 | CREAD | HUPCL | CLOCAL;
222 termios->c_ispeed = 9600;
223 termios->c_ospeed = 9600;
224}
225
226static void ark3116_set_termios(struct tty_struct *tty,
227 struct usb_serial_port *port,
228 struct ktermios *old_termios)
229{
230 struct usb_serial *serial = port->serial;
231 struct ark3116_private *priv = usb_get_serial_port_data(port);
232 struct ktermios *termios = tty->termios;
233 unsigned int cflag = termios->c_cflag;
234 int bps = tty_get_baud_rate(tty);
235 int quot;
236 __u8 lcr, hcr, eval;
237
238 /* set data bit count */
239 switch (cflag & CSIZE) {
240 case CS5:
241 lcr = UART_LCR_WLEN5;
242 break;
243 case CS6:
244 lcr = UART_LCR_WLEN6;
245 break;
246 case CS7:
247 lcr = UART_LCR_WLEN7;
248 break;
249 default:
250 case CS8:
251 lcr = UART_LCR_WLEN8;
252 break;
253 }
254 if (cflag & CSTOPB)
255 lcr |= UART_LCR_STOP;
256 if (cflag & PARENB)
257 lcr |= UART_LCR_PARITY;
258 if (!(cflag & PARODD))
259 lcr |= UART_LCR_EPAR;
260#ifdef CMSPAR
261 if (cflag & CMSPAR)
262 lcr |= UART_LCR_SPAR;
263#endif
264 /* handshake control */
265 hcr = (cflag & CRTSCTS) ? 0x03 : 0x00;
266
267 /* calc baudrate */
268 dev_dbg(&port->dev, "%s - setting bps to %d\n", __func__, bps);
269 eval = 0;
270 switch (bps) {
271 case 0:
272 quot = calc_divisor(9600);
273 break;
274 default:
275 if ((bps < 75) || (bps > 3000000))
276 bps = 9600;
277 quot = calc_divisor(bps);
278 break;
279 case 460800:
280 eval = 1;
281 quot = calc_divisor(bps);
282 break;
283 case 921600:
284 eval = 2;
285 quot = calc_divisor(bps);
286 break;
287 }
288
289 /* Update state: synchronize */
290 mutex_lock(&priv->hw_lock);
291
292 /* keep old LCR_SBC bit */
293 lcr |= (priv->lcr & UART_LCR_SBC);
294
295 dev_dbg(&port->dev, "%s - setting hcr:0x%02x,lcr:0x%02x,quot:%d\n",
296 __func__, hcr, lcr, quot);
297
298 /* handshake control */
299 if (priv->hcr != hcr) {
300 priv->hcr = hcr;
301 ark3116_write_reg(serial, 0x8, hcr);
302 }
303
304 /* baudrate */
305 if (priv->quot != quot) {
306 priv->quot = quot;
307 priv->lcr = lcr; /* need to write lcr anyway */
308
309 /* disable DMA since transmit/receive is
310 * shadowed by UART_DLL
311 */
312 ark3116_write_reg(serial, UART_FCR, 0);
313
314 ark3116_write_reg(serial, UART_LCR,
315 lcr|UART_LCR_DLAB);
316 ark3116_write_reg(serial, UART_DLL, quot & 0xff);
317 ark3116_write_reg(serial, UART_DLM, (quot>>8) & 0xff);
318
319 /* restore lcr */
320 ark3116_write_reg(serial, UART_LCR, lcr);
321 /* magic baudrate thingy: not sure what it does,
322 * but windows does this as well.
323 */
324 ark3116_write_reg(serial, 0xe, eval);
325
326 /* enable DMA */
327 ark3116_write_reg(serial, UART_FCR, UART_FCR_DMA_SELECT);
328 } else if (priv->lcr != lcr) {
329 priv->lcr = lcr;
330 ark3116_write_reg(serial, UART_LCR, lcr);
331 }
332
333 mutex_unlock(&priv->hw_lock);
334
335 /* check for software flow control */
336 if (I_IXOFF(tty) || I_IXON(tty)) {
337 dev_warn(&serial->dev->dev,
338 "%s: don't know how to do software flow control\n",
339 KBUILD_MODNAME);
340 }
341
342 /* Don't rewrite B0 */
343 if (tty_termios_baud_rate(termios))
344 tty_termios_encode_baud_rate(termios, bps, bps);
345}
346
347static void ark3116_close(struct usb_serial_port *port)
348{
349 struct usb_serial *serial = port->serial;
350
351 if (serial->dev) {
352 /* disable DMA */
353 ark3116_write_reg(serial, UART_FCR, 0);
354
355 /* deactivate interrupts */
356 ark3116_write_reg(serial, UART_IER, 0);
357
358 usb_serial_generic_close(port);
359 if (serial->num_interrupt_in)
360 usb_kill_urb(port->interrupt_in_urb);
361 }
362
363}
364
365static int ark3116_open(struct tty_struct *tty, struct usb_serial_port *port)
366{
367 struct ark3116_private *priv = usb_get_serial_port_data(port);
368 struct usb_serial *serial = port->serial;
369 unsigned char *buf;
370 int result;
371
372 buf = kmalloc(1, GFP_KERNEL);
373 if (buf == NULL)
374 return -ENOMEM;
375
376 result = usb_serial_generic_open(tty, port);
377 if (result) {
378 dev_dbg(&port->dev,
379 "%s - usb_serial_generic_open failed: %d\n",
380 __func__, result);
381 goto err_out;
382 }
383
384 /* remove any data still left: also clears error state */
385 ark3116_read_reg(serial, UART_RX, buf);
386
387 /* read modem status */
388 priv->msr = ark3116_read_reg(serial, UART_MSR, buf);
389 /* read line status */
390 priv->lsr = ark3116_read_reg(serial, UART_LSR, buf);
391
392 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
393 if (result) {
394 dev_err(&port->dev, "submit irq_in urb failed %d\n",
395 result);
396 ark3116_close(port);
397 goto err_out;
398 }
399
400 /* activate interrupts */
401 ark3116_write_reg(port->serial, UART_IER, UART_IER_MSI|UART_IER_RLSI);
402
403 /* enable DMA */
404 ark3116_write_reg(port->serial, UART_FCR, UART_FCR_DMA_SELECT);
405
406 /* setup termios */
407 if (tty)
408 ark3116_set_termios(tty, port, NULL);
409
410err_out:
411 kfree(buf);
412 return result;
413}
414
415static int ark3116_get_icount(struct tty_struct *tty,
416 struct serial_icounter_struct *icount)
417{
418 struct usb_serial_port *port = tty->driver_data;
419 struct ark3116_private *priv = usb_get_serial_port_data(port);
420 struct async_icount cnow = priv->icount;
421 icount->cts = cnow.cts;
422 icount->dsr = cnow.dsr;
423 icount->rng = cnow.rng;
424 icount->dcd = cnow.dcd;
425 icount->rx = cnow.rx;
426 icount->tx = cnow.tx;
427 icount->frame = cnow.frame;
428 icount->overrun = cnow.overrun;
429 icount->parity = cnow.parity;
430 icount->brk = cnow.brk;
431 icount->buf_overrun = cnow.buf_overrun;
432 return 0;
433}
434
435static int ark3116_ioctl(struct tty_struct *tty,
436 unsigned int cmd, unsigned long arg)
437{
438 struct usb_serial_port *port = tty->driver_data;
439 struct ark3116_private *priv = usb_get_serial_port_data(port);
440 struct serial_struct serstruct;
441 void __user *user_arg = (void __user *)arg;
442
443 switch (cmd) {
444 case TIOCGSERIAL:
445 /* XXX: Some of these values are probably wrong. */
446 memset(&serstruct, 0, sizeof(serstruct));
447 serstruct.type = PORT_16654;
448 serstruct.line = port->serial->minor;
449 serstruct.port = port->number;
450 serstruct.custom_divisor = 0;
451 serstruct.baud_base = 460800;
452
453 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
454 return -EFAULT;
455
456 return 0;
457 case TIOCSSERIAL:
458 if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
459 return -EFAULT;
460 return 0;
461 case TIOCMIWAIT:
462 for (;;) {
463 struct async_icount prev = priv->icount;
464 interruptible_sleep_on(&priv->delta_msr_wait);
465 /* see if a signal did it */
466 if (signal_pending(current))
467 return -ERESTARTSYS;
468 if ((prev.rng == priv->icount.rng) &&
469 (prev.dsr == priv->icount.dsr) &&
470 (prev.dcd == priv->icount.dcd) &&
471 (prev.cts == priv->icount.cts))
472 return -EIO;
473 if ((arg & TIOCM_RNG &&
474 (prev.rng != priv->icount.rng)) ||
475 (arg & TIOCM_DSR &&
476 (prev.dsr != priv->icount.dsr)) ||
477 (arg & TIOCM_CD &&
478 (prev.dcd != priv->icount.dcd)) ||
479 (arg & TIOCM_CTS &&
480 (prev.cts != priv->icount.cts)))
481 return 0;
482 }
483 break;
484 }
485
486 return -ENOIOCTLCMD;
487}
488
489static int ark3116_tiocmget(struct tty_struct *tty)
490{
491 struct usb_serial_port *port = tty->driver_data;
492 struct ark3116_private *priv = usb_get_serial_port_data(port);
493 __u32 status;
494 __u32 ctrl;
495 unsigned long flags;
496
497 mutex_lock(&priv->hw_lock);
498 ctrl = priv->mcr;
499 mutex_unlock(&priv->hw_lock);
500
501 spin_lock_irqsave(&priv->status_lock, flags);
502 status = priv->msr;
503 spin_unlock_irqrestore(&priv->status_lock, flags);
504
505 return (status & UART_MSR_DSR ? TIOCM_DSR : 0) |
506 (status & UART_MSR_CTS ? TIOCM_CTS : 0) |
507 (status & UART_MSR_RI ? TIOCM_RI : 0) |
508 (status & UART_MSR_DCD ? TIOCM_CD : 0) |
509 (ctrl & UART_MCR_DTR ? TIOCM_DTR : 0) |
510 (ctrl & UART_MCR_RTS ? TIOCM_RTS : 0) |
511 (ctrl & UART_MCR_OUT1 ? TIOCM_OUT1 : 0) |
512 (ctrl & UART_MCR_OUT2 ? TIOCM_OUT2 : 0);
513}
514
515static int ark3116_tiocmset(struct tty_struct *tty,
516 unsigned set, unsigned clr)
517{
518 struct usb_serial_port *port = tty->driver_data;
519 struct ark3116_private *priv = usb_get_serial_port_data(port);
520
521 /* we need to take the mutex here, to make sure that the value
522 * in priv->mcr is actually the one that is in the hardware
523 */
524
525 mutex_lock(&priv->hw_lock);
526
527 if (set & TIOCM_RTS)
528 priv->mcr |= UART_MCR_RTS;
529 if (set & TIOCM_DTR)
530 priv->mcr |= UART_MCR_DTR;
531 if (set & TIOCM_OUT1)
532 priv->mcr |= UART_MCR_OUT1;
533 if (set & TIOCM_OUT2)
534 priv->mcr |= UART_MCR_OUT2;
535 if (clr & TIOCM_RTS)
536 priv->mcr &= ~UART_MCR_RTS;
537 if (clr & TIOCM_DTR)
538 priv->mcr &= ~UART_MCR_DTR;
539 if (clr & TIOCM_OUT1)
540 priv->mcr &= ~UART_MCR_OUT1;
541 if (clr & TIOCM_OUT2)
542 priv->mcr &= ~UART_MCR_OUT2;
543
544 ark3116_write_reg(port->serial, UART_MCR, priv->mcr);
545
546 mutex_unlock(&priv->hw_lock);
547
548 return 0;
549}
550
551static void ark3116_break_ctl(struct tty_struct *tty, int break_state)
552{
553 struct usb_serial_port *port = tty->driver_data;
554 struct ark3116_private *priv = usb_get_serial_port_data(port);
555
556 /* LCR is also used for other things: protect access */
557 mutex_lock(&priv->hw_lock);
558
559 if (break_state)
560 priv->lcr |= UART_LCR_SBC;
561 else
562 priv->lcr &= ~UART_LCR_SBC;
563
564 ark3116_write_reg(port->serial, UART_LCR, priv->lcr);
565
566 mutex_unlock(&priv->hw_lock);
567}
568
569static void ark3116_update_msr(struct usb_serial_port *port, __u8 msr)
570{
571 struct ark3116_private *priv = usb_get_serial_port_data(port);
572 unsigned long flags;
573
574 spin_lock_irqsave(&priv->status_lock, flags);
575 priv->msr = msr;
576 spin_unlock_irqrestore(&priv->status_lock, flags);
577
578 if (msr & UART_MSR_ANY_DELTA) {
579 /* update input line counters */
580 if (msr & UART_MSR_DCTS)
581 priv->icount.cts++;
582 if (msr & UART_MSR_DDSR)
583 priv->icount.dsr++;
584 if (msr & UART_MSR_DDCD)
585 priv->icount.dcd++;
586 if (msr & UART_MSR_TERI)
587 priv->icount.rng++;
588 wake_up_interruptible(&priv->delta_msr_wait);
589 }
590}
591
592static void ark3116_update_lsr(struct usb_serial_port *port, __u8 lsr)
593{
594 struct ark3116_private *priv = usb_get_serial_port_data(port);
595 unsigned long flags;
596
597 spin_lock_irqsave(&priv->status_lock, flags);
598 /* combine bits */
599 priv->lsr |= lsr;
600 spin_unlock_irqrestore(&priv->status_lock, flags);
601
602 if (lsr&UART_LSR_BRK_ERROR_BITS) {
603 if (lsr & UART_LSR_BI)
604 priv->icount.brk++;
605 if (lsr & UART_LSR_FE)
606 priv->icount.frame++;
607 if (lsr & UART_LSR_PE)
608 priv->icount.parity++;
609 if (lsr & UART_LSR_OE)
610 priv->icount.overrun++;
611 }
612}
613
614static void ark3116_read_int_callback(struct urb *urb)
615{
616 struct usb_serial_port *port = urb->context;
617 int status = urb->status;
618 const __u8 *data = urb->transfer_buffer;
619 int result;
620
621 switch (status) {
622 case -ECONNRESET:
623 case -ENOENT:
624 case -ESHUTDOWN:
625 /* this urb is terminated, clean up */
626 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
627 __func__, status);
628 return;
629 default:
630 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
631 __func__, status);
632 break;
633 case 0: /* success */
634 /* discovered this by trail and error... */
635 if ((urb->actual_length == 4) && (data[0] == 0xe8)) {
636 const __u8 id = data[1]&UART_IIR_ID;
637 dev_dbg(&port->dev, "%s: iir=%02x\n", __func__, data[1]);
638 if (id == UART_IIR_MSI) {
639 dev_dbg(&port->dev, "%s: msr=%02x\n",
640 __func__, data[3]);
641 ark3116_update_msr(port, data[3]);
642 break;
643 } else if (id == UART_IIR_RLSI) {
644 dev_dbg(&port->dev, "%s: lsr=%02x\n",
645 __func__, data[2]);
646 ark3116_update_lsr(port, data[2]);
647 break;
648 }
649 }
650 /*
651 * Not sure what this data meant...
652 */
653 usb_serial_debug_data(debug, &port->dev,
654 __func__,
655 urb->actual_length,
656 urb->transfer_buffer);
657 break;
658 }
659
660 result = usb_submit_urb(urb, GFP_ATOMIC);
661 if (result)
662 dev_err(&urb->dev->dev,
663 "%s - Error %d submitting interrupt urb\n",
664 __func__, result);
665}
666
667
668/* Data comes in via the bulk (data) URB, erors/interrupts via the int URB.
669 * This means that we cannot be sure which data byte has an associated error
670 * condition, so we report an error for all data in the next bulk read.
671 *
672 * Actually, there might even be a window between the bulk data leaving the
673 * ark and reading/resetting the lsr in the read_bulk_callback where an
674 * interrupt for the next data block could come in.
675 * Without somekind of ordering on the ark, we would have to report the
676 * error for the next block of data as well...
677 * For now, let's pretend this can't happen.
678 */
679static void ark3116_process_read_urb(struct urb *urb)
680{
681 struct usb_serial_port *port = urb->context;
682 struct ark3116_private *priv = usb_get_serial_port_data(port);
683 struct tty_struct *tty;
684 unsigned char *data = urb->transfer_buffer;
685 char tty_flag = TTY_NORMAL;
686 unsigned long flags;
687 __u32 lsr;
688
689 /* update line status */
690 spin_lock_irqsave(&priv->status_lock, flags);
691 lsr = priv->lsr;
692 priv->lsr &= ~UART_LSR_BRK_ERROR_BITS;
693 spin_unlock_irqrestore(&priv->status_lock, flags);
694
695 if (!urb->actual_length)
696 return;
697
698 tty = tty_port_tty_get(&port->port);
699 if (!tty)
700 return;
701
702 if (lsr & UART_LSR_BRK_ERROR_BITS) {
703 if (lsr & UART_LSR_BI)
704 tty_flag = TTY_BREAK;
705 else if (lsr & UART_LSR_PE)
706 tty_flag = TTY_PARITY;
707 else if (lsr & UART_LSR_FE)
708 tty_flag = TTY_FRAME;
709
710 /* overrun is special, not associated with a char */
711 if (lsr & UART_LSR_OE)
712 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
713 }
714 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
715 urb->actual_length);
716 tty_flip_buffer_push(tty);
717 tty_kref_put(tty);
718}
719
720static struct usb_serial_driver ark3116_device = {
721 .driver = {
722 .owner = THIS_MODULE,
723 .name = "ark3116",
724 },
725 .id_table = id_table,
726 .num_ports = 1,
727 .attach = ark3116_attach,
728 .release = ark3116_release,
729 .set_termios = ark3116_set_termios,
730 .init_termios = ark3116_init_termios,
731 .ioctl = ark3116_ioctl,
732 .tiocmget = ark3116_tiocmget,
733 .tiocmset = ark3116_tiocmset,
734 .get_icount = ark3116_get_icount,
735 .open = ark3116_open,
736 .close = ark3116_close,
737 .break_ctl = ark3116_break_ctl,
738 .read_int_callback = ark3116_read_int_callback,
739 .process_read_urb = ark3116_process_read_urb,
740};
741
742static struct usb_serial_driver * const serial_drivers[] = {
743 &ark3116_device, NULL
744};
745
746module_usb_serial_driver(serial_drivers, id_table);
747
748MODULE_LICENSE("GPL");
749
750MODULE_AUTHOR(DRIVER_AUTHOR);
751MODULE_DESCRIPTION(DRIVER_DESC);
752
753module_param(debug, bool, S_IRUGO | S_IWUSR);
754MODULE_PARM_DESC(debug, "Enable debug");
755
756/*
757 * The following describes what I learned from studying the old
758 * ark3116.c driver, disassembling the windows driver, and some lucky
759 * guesses. Since I do not have any datasheet or other
760 * documentation, inaccuracies are almost guaranteed.
761 *
762 * Some specs for the ARK3116 can be found here:
763 * http://web.archive.org/web/20060318000438/
764 * www.arkmicro.com/en/products/view.php?id=10
765 * On that page, 2 GPIO pins are mentioned: I assume these are the
766 * OUT1 and OUT2 pins of the UART, so I added support for those
767 * through the MCR. Since the pins are not available on my hardware,
768 * I could not verify this.
769 * Also, it states there is "on-chip hardware flow control". I have
770 * discovered how to enable that. Unfortunately, I do not know how to
771 * enable XON/XOFF (software) flow control, which would need support
772 * from the chip as well to work. Because of the wording on the web
773 * page there is a real possibility the chip simply does not support
774 * software flow control.
775 *
776 * I got my ark3116 as part of a mobile phone adapter cable. On the
777 * PCB, the following numbered contacts are present:
778 *
779 * 1:- +5V
780 * 2:o DTR
781 * 3:i RX
782 * 4:i DCD
783 * 5:o RTS
784 * 6:o TX
785 * 7:i RI
786 * 8:i DSR
787 * 10:- 0V
788 * 11:i CTS
789 *
790 * On my chip, all signals seem to be 3.3V, but 5V tolerant. But that
791 * may be different for the one you have ;-).
792 *
793 * The windows driver limits the registers to 0-F, so I assume there
794 * are actually 16 present on the device.
795 *
796 * On an UART interrupt, 4 bytes of data come in on the interrupt
797 * endpoint. The bytes are 0xe8 IIR LSR MSR.
798 *
799 * The baudrate seems to be generated from the 12MHz crystal, using
800 * 4-times subsampling. So quot=12e6/(4*baud). Also see description
801 * of register E.
802 *
803 * Registers 0-7:
804 * These seem to be the same as for a regular 16450. The FCR is set
805 * to UART_FCR_DMA_SELECT (0x8), I guess to enable transfers between
806 * the UART and the USB bridge/DMA engine.
807 *
808 * Register 8:
809 * By trial and error, I found out that bit 0 enables hardware CTS,
810 * stopping TX when CTS is +5V. Bit 1 does the same for RTS, making
811 * RTS +5V when the 3116 cannot transfer the data to the USB bus
812 * (verified by disabling the reading URB). Note that as far as I can
813 * tell, the windows driver does NOT use this, so there might be some
814 * hardware bug or something.
815 *
816 * According to a patch provided here
817 * (http://lkml.org/lkml/2009/7/26/56), the ARK3116 can also be used
818 * as an IrDA dongle. Since I do not have such a thing, I could not
819 * investigate that aspect. However, I can speculate ;-).
820 *
821 * - IrDA encodes data differently than RS232. Most likely, one of
822 * the bits in registers 9..E enables the IR ENDEC (encoder/decoder).
823 * - Depending on the IR transceiver, the input and output need to be
824 * inverted, so there are probably bits for that as well.
825 * - IrDA is half-duplex, so there should be a bit for selecting that.
826 *
827 * This still leaves at least two registers unaccounted for. Perhaps
828 * The chip can do XON/XOFF or CRC in HW?
829 *
830 * Register 9:
831 * Set to 0x00 for IrDA, when the baudrate is initialised.
832 *
833 * Register A:
834 * Set to 0x01 for IrDA, at init.
835 *
836 * Register B:
837 * Set to 0x01 for IrDA, 0x00 for RS232, at init.
838 *
839 * Register C:
840 * Set to 00 for IrDA, at init.
841 *
842 * Register D:
843 * Set to 0x41 for IrDA, at init.
844 *
845 * Register E:
846 * Somekind of baudrate override. The windows driver seems to set
847 * this to 0x00 for normal baudrates, 0x01 for 460800, 0x02 for 921600.
848 * Since 460800 and 921600 cannot be obtained by dividing 3MHz by an integer,
849 * it could be somekind of subdivisor thingy.
850 * However,it does not seem to do anything: selecting 921600 (divisor 3,
851 * reg E=2), still gets 1 MHz. I also checked if registers 9, C or F would
852 * work, but they don't.
853 *
854 * Register F: unknown
855 */