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