drivers/usb/serial/ark3116.c

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