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