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