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 usb_set_serial_port_data(serial->port[i], NULL); 156 return -ENOMEM; 157 } 158 159 static void ark3116_set_termios(struct usb_serial_port *port, 160 struct ktermios *old_termios) 161 { 162 struct usb_serial *serial = port->serial; 163 struct ark3116_private *priv = usb_get_serial_port_data(port); 164 struct ktermios *termios = port->tty->termios; 165 unsigned int cflag = termios->c_cflag; 166 unsigned long flags; 167 int baud; 168 int ark3116_baud; 169 char *buf; 170 char config; 171 172 config = 0; 173 174 dbg("%s - port %d", __FUNCTION__, port->number); 175 176 spin_lock_irqsave(&priv->lock, flags); 177 if (!priv->termios_initialized) { 178 *(port->tty->termios) = tty_std_termios; 179 port->tty->termios->c_cflag = B9600 | CS8 180 | CREAD | HUPCL | CLOCAL; 181 termios->c_ispeed = 9600; 182 termios->c_ospeed = 9600; 183 priv->termios_initialized = 1; 184 } 185 spin_unlock_irqrestore(&priv->lock, flags); 186 187 cflag = termios->c_cflag; 188 termios->c_cflag &= ~(CMSPAR|CRTSCTS); 189 190 buf = kmalloc(1, GFP_KERNEL); 191 if (!buf) { 192 dbg("error kmalloc"); 193 return; 194 } 195 196 /* set data bit count (8/7/6/5) */ 197 if (cflag & CSIZE) { 198 switch (cflag & CSIZE) { 199 case CS5: 200 config |= 0x00; 201 dbg("setting CS5"); 202 break; 203 case CS6: 204 config |= 0x01; 205 dbg("setting CS6"); 206 break; 207 case CS7: 208 config |= 0x02; 209 dbg("setting CS7"); 210 break; 211 default: 212 dbg("CSIZE was set but not CS5-CS8, using CS8!"); 213 /* fall through */ 214 case CS8: 215 config |= 0x03; 216 dbg("setting CS8"); 217 break; 218 } 219 } 220 221 /* set parity (NONE/EVEN/ODD) */ 222 if (cflag & PARENB) { 223 if (cflag & PARODD) { 224 config |= 0x08; 225 dbg("setting parity to ODD"); 226 } else { 227 config |= 0x18; 228 dbg("setting parity to EVEN"); 229 } 230 } else { 231 dbg("setting parity to NONE"); 232 } 233 234 /* set stop bit (1/2) */ 235 if (cflag & CSTOPB) { 236 config |= 0x04; 237 dbg("setting 2 stop bits"); 238 } else { 239 dbg("setting 1 stop bit"); 240 } 241 242 /* set baudrate */ 243 baud = tty_get_baud_rate(port->tty); 244 245 switch (baud) { 246 case 75: 247 case 150: 248 case 300: 249 case 600: 250 case 1200: 251 case 1800: 252 case 2400: 253 case 4800: 254 case 9600: 255 case 19200: 256 case 38400: 257 case 57600: 258 case 115200: 259 case 230400: 260 case 460800: 261 /* Report the resulting rate back to the caller */ 262 tty_encode_baud_rate(port->tty, baud, baud); 263 break; 264 /* set 9600 as default (if given baudrate is invalid for example) */ 265 default: 266 tty_encode_baud_rate(port->tty, 9600, 9600); 267 case 0: 268 baud = 9600; 269 } 270 271 /* 272 * found by try'n'error, be careful, maybe there are other options 273 * for multiplicator etc! (3.5 for example) 274 */ 275 if (baud == 460800) 276 /* strange, for 460800 the formula is wrong 277 * if using round() then 9600baud is wrong) */ 278 ark3116_baud = 7; 279 else 280 ark3116_baud = 3000000 / baud; 281 282 /* ? */ 283 ARK3116_RCV(serial, 0, 0xFE, 0xC0, 0x0000, 0x0003, 0x03, buf); 284 285 /* offset = buf[0]; */ 286 /* offset = 0x03; */ 287 /* dbg("using 0x%04X as target for 0x0003:", 0x0080 + offset); */ 288 289 /* set baudrate */ 290 dbg("setting baudrate to %d (->reg=%d)", baud, ark3116_baud); 291 ARK3116_SND(serial, 147, 0xFE, 0x40, 0x0083, 0x0003); 292 ARK3116_SND(serial, 148, 0xFE, 0x40, 293 (ark3116_baud & 0x00FF), 0x0000); 294 ARK3116_SND(serial, 149, 0xFE, 0x40, 295 (ark3116_baud & 0xFF00) >> 8, 0x0001); 296 ARK3116_SND(serial, 150, 0xFE, 0x40, 0x0003, 0x0003); 297 298 /* ? */ 299 ARK3116_RCV(serial, 151, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf); 300 ARK3116_SND(serial, 152, 0xFE, 0x40, 0x0000, 0x0003); 301 302 /* set data bit count, stop bit count & parity: */ 303 dbg("updating bit count, stop bit or parity (cfg=0x%02X)", config); 304 ARK3116_RCV(serial, 153, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf); 305 ARK3116_SND(serial, 154, 0xFE, 0x40, config, 0x0003); 306 307 if (cflag & CRTSCTS) 308 dbg("CRTSCTS not supported by chipset?!"); 309 310 /* TEST ARK3116_SND(154, 0xFE, 0x40, 0xFFFF, 0x0006); */ 311 312 kfree(buf); 313 314 return; 315 } 316 317 static int ark3116_open(struct usb_serial_port *port, struct file *filp) 318 { 319 struct ktermios tmp_termios; 320 struct usb_serial *serial = port->serial; 321 char *buf; 322 int result = 0; 323 324 dbg("%s - port %d", __FUNCTION__, port->number); 325 326 buf = kmalloc(1, GFP_KERNEL); 327 if (!buf) { 328 dbg("error kmalloc -> out of mem?"); 329 return -ENOMEM; 330 } 331 332 result = usb_serial_generic_open(port, filp); 333 if (result) 334 goto err_out; 335 336 /* open */ 337 ARK3116_RCV(serial, 111, 0xFE, 0xC0, 0x0000, 0x0003, 0x02, buf); 338 339 ARK3116_SND(serial, 112, 0xFE, 0x40, 0x0082, 0x0003); 340 ARK3116_SND(serial, 113, 0xFE, 0x40, 0x001A, 0x0000); 341 ARK3116_SND(serial, 114, 0xFE, 0x40, 0x0000, 0x0001); 342 ARK3116_SND(serial, 115, 0xFE, 0x40, 0x0002, 0x0003); 343 344 ARK3116_RCV(serial, 116, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf); 345 ARK3116_SND(serial, 117, 0xFE, 0x40, 0x0002, 0x0004); 346 347 ARK3116_RCV(serial, 118, 0xFE, 0xC0, 0x0000, 0x0004, 0x02, buf); 348 ARK3116_SND(serial, 119, 0xFE, 0x40, 0x0000, 0x0004); 349 350 ARK3116_RCV(serial, 120, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf); 351 352 ARK3116_SND(serial, 121, 0xFE, 0x40, 0x0001, 0x0004); 353 354 ARK3116_RCV(serial, 122, 0xFE, 0xC0, 0x0000, 0x0004, 0x01, buf); 355 356 ARK3116_SND(serial, 123, 0xFE, 0x40, 0x0003, 0x0004); 357 358 /* returns different values (control lines?!) */ 359 ARK3116_RCV(serial, 124, 0xFE, 0xC0, 0x0000, 0x0006, 0xFF, buf); 360 361 /* initialise termios */ 362 if (port->tty) 363 ark3116_set_termios(port, &tmp_termios); 364 365 err_out: 366 kfree(buf); 367 368 return result; 369 } 370 371 static int ark3116_ioctl(struct usb_serial_port *port, struct file *file, 372 unsigned int cmd, unsigned long arg) 373 { 374 struct serial_struct serstruct; 375 void __user *user_arg = (void __user *)arg; 376 377 switch (cmd) { 378 case TIOCGSERIAL: 379 /* XXX: Some of these values are probably wrong. */ 380 memset(&serstruct, 0, sizeof (serstruct)); 381 serstruct.type = PORT_16654; 382 serstruct.line = port->serial->minor; 383 serstruct.port = port->number; 384 serstruct.custom_divisor = 0; 385 serstruct.baud_base = 460800; 386 387 if (copy_to_user(user_arg, &serstruct, sizeof (serstruct))) 388 return -EFAULT; 389 390 return 0; 391 case TIOCSSERIAL: 392 if (copy_from_user(&serstruct, user_arg, sizeof (serstruct))) 393 return -EFAULT; 394 return 0; 395 default: 396 dbg("%s cmd 0x%04x not supported", __FUNCTION__, cmd); 397 break; 398 } 399 400 return -ENOIOCTLCMD; 401 } 402 403 static int ark3116_tiocmget(struct usb_serial_port *port, struct file *file) 404 { 405 struct usb_serial *serial = port->serial; 406 char *buf; 407 char temp; 408 409 /* seems like serial port status info (RTS, CTS, ...) is stored 410 * in reg(?) 0x0006 411 * pcb connection point 11 = GND -> sets bit4 of response 412 * pcb connection point 7 = GND -> sets bit6 of response 413 */ 414 415 buf = kmalloc(1, GFP_KERNEL); 416 if (!buf) { 417 dbg("error kmalloc"); 418 return -ENOMEM; 419 } 420 421 /* read register */ 422 ARK3116_RCV_QUIET(serial, 0xFE, 0xC0, 0x0000, 0x0006, buf); 423 temp = buf[0]; 424 kfree(buf); 425 426 /* i do not really know if bit4=CTS and bit6=DSR... just a 427 * quick guess! 428 */ 429 return (temp & (1<<4) ? TIOCM_CTS : 0) 430 | (temp & (1<<6) ? TIOCM_DSR : 0); 431 } 432 433 static struct usb_driver ark3116_driver = { 434 .name = "ark3116", 435 .probe = usb_serial_probe, 436 .disconnect = usb_serial_disconnect, 437 .id_table = id_table, 438 .no_dynamic_id = 1, 439 }; 440 441 static struct usb_serial_driver ark3116_device = { 442 .driver = { 443 .owner = THIS_MODULE, 444 .name = "ark3116", 445 }, 446 .id_table = id_table, 447 .usb_driver = &ark3116_driver, 448 .num_interrupt_in = 1, 449 .num_bulk_in = 1, 450 .num_bulk_out = 1, 451 .num_ports = 1, 452 .attach = ark3116_attach, 453 .set_termios = ark3116_set_termios, 454 .ioctl = ark3116_ioctl, 455 .tiocmget = ark3116_tiocmget, 456 .open = ark3116_open, 457 }; 458 459 static int __init ark3116_init(void) 460 { 461 int retval; 462 463 retval = usb_serial_register(&ark3116_device); 464 if (retval) 465 return retval; 466 retval = usb_register(&ark3116_driver); 467 if (retval) 468 usb_serial_deregister(&ark3116_device); 469 return retval; 470 } 471 472 static void __exit ark3116_exit(void) 473 { 474 usb_deregister(&ark3116_driver); 475 usb_serial_deregister(&ark3116_device); 476 } 477 478 module_init(ark3116_init); 479 module_exit(ark3116_exit); 480 MODULE_LICENSE("GPL"); 481 482 module_param(debug, bool, S_IRUGO | S_IWUSR); 483 MODULE_PARM_DESC(debug, "Debug enabled or not"); 484 485