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