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