ark3116.c 12 KB
Newer Older
1
/*
2 3 4
 * Copyright (C) 2006
 *   Simon Schulz (ark3116_driver <at> auctionant.de)
 *
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * ark3116
 * - implements a driver for the arkmicro ark3116 chipset (vendor=0x6547,
 *   productid=0x0232) (used in a datacable called KQ-U8A)
 *
 * - based on code by krisfx -> thanks !!
 *   (see http://www.linuxquestions.org/questions/showthread.php?p=2184457#post2184457)
 *
 *  - based on logs created by usbsnoopy
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 */

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/tty.h>
#include <linux/module.h>
#include <linux/usb.h>
25
#include <linux/usb/serial.h>
26 27
#include <linux/serial.h>
#include <asm/uaccess.h>
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48


static int debug;

static struct usb_device_id id_table [] = {
	{ USB_DEVICE(0x6547, 0x0232) },
	{ },
};
MODULE_DEVICE_TABLE(usb, id_table);

struct ark3116_private {
	spinlock_t lock;
	u8 termios_initialized;
};

static inline void ARK3116_SND(struct usb_serial *serial, int seq,
			       __u8 request, __u8 requesttype,
			       __u16 value, __u16 index)
{
	int result;
	result = usb_control_msg(serial->dev,
49
				 usb_sndctrlpipe(serial->dev, 0),
50
				 request, requesttype, value, index,
51 52
				 NULL, 0x00, 1000);
	dbg("%03d > ok", seq);
53 54 55 56 57 58 59 60 61
}

static inline void ARK3116_RCV(struct usb_serial *serial, int seq,
			       __u8 request, __u8 requesttype,
			       __u16 value, __u16 index, __u8 expected,
			       char *buf)
{
	int result;
	result = usb_control_msg(serial->dev,
62 63 64
				 usb_rcvctrlpipe(serial->dev, 0),
				 request, requesttype, value, index,
				 buf, 0x0000001, 1000);
65
	if (result)
66 67
		dbg("%03d < %d bytes [0x%02X]", seq, result,
		    ((unsigned char *)buf)[0]);
68 69 70 71 72 73 74 75 76
	else
		dbg("%03d < 0 bytes", seq);
}

static inline void ARK3116_RCV_QUIET(struct usb_serial *serial,
				     __u8 request, __u8 requesttype,
				     __u16 value, __u16 index, char *buf)
{
	usb_control_msg(serial->dev,
77
			usb_rcvctrlpipe(serial->dev, 0),
78 79 80 81 82 83 84 85 86 87 88
			request, requesttype, value, index,
			buf, 0x0000001, 1000);
}

static int ark3116_attach(struct usb_serial *serial)
{
	char *buf;
	struct ark3116_private *priv;
	int i;

	for (i = 0; i < serial->num_ports; ++i) {
89
		priv = kzalloc(sizeof(struct ark3116_private), GFP_KERNEL);
90 91 92 93 94 95 96 97 98
		if (!priv)
			goto cleanup;
		spin_lock_init(&priv->lock);

		usb_set_serial_port_data(serial->port[i], priv);
	}

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf) {
99
		dbg("error kmalloc -> out of mem?");
100 101 102 103
		goto cleanup;
	}

	/* 3 */
104 105 106 107
	ARK3116_SND(serial, 3, 0xFE, 0x40, 0x0008, 0x0002);
	ARK3116_SND(serial, 4, 0xFE, 0x40, 0x0008, 0x0001);
	ARK3116_SND(serial, 5, 0xFE, 0x40, 0x0000, 0x0008);
	ARK3116_SND(serial, 6, 0xFE, 0x40, 0x0000, 0x000B);
108 109

	/* <-- seq7 */
110 111 112 113 114
	ARK3116_RCV(serial,  7, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
	ARK3116_SND(serial,  8, 0xFE, 0x40, 0x0080, 0x0003);
	ARK3116_SND(serial,  9, 0xFE, 0x40, 0x001A, 0x0000);
	ARK3116_SND(serial, 10, 0xFE, 0x40, 0x0000, 0x0001);
	ARK3116_SND(serial, 11, 0xFE, 0x40, 0x0000, 0x0003);
115 116

	/* <-- seq12 */
117 118
	ARK3116_RCV(serial, 12, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
	ARK3116_SND(serial, 13, 0xFE, 0x40, 0x0000, 0x0004);
119 120

	/* 14 */
121 122
	ARK3116_RCV(serial, 14, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
	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 137 138 139 140 141 142 143 144 145 146 147 148
	/* seems like serial port status info (RTS, CTS, ...) */
	/* returns modem control line status?! */
	ARK3116_RCV(serial, 20, 0xFE, 0xC0, 0x0000, 0x0006, 0xFF, buf);

	/* set 9600 baud & do some init?! */
	ARK3116_SND(serial, 147, 0xFE, 0x40, 0x0083, 0x0003);
	ARK3116_SND(serial, 148, 0xFE, 0x40, 0x0038, 0x0000);
	ARK3116_SND(serial, 149, 0xFE, 0x40, 0x0001, 0x0001);
	ARK3116_SND(serial, 150, 0xFE, 0x40, 0x0003, 0x0003);
	ARK3116_RCV(serial, 151, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf);
	ARK3116_SND(serial, 152, 0xFE, 0x40, 0x0000, 0x0003);
	ARK3116_RCV(serial, 153, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
	ARK3116_SND(serial, 154, 0xFE, 0x40, 0x0003, 0x0003);
149 150

	kfree(buf);
151
	return 0;
152 153

cleanup:
154 155
	for (--i; i >= 0; --i) {
		kfree(usb_get_serial_port_data(serial->port[i]));
156
		usb_set_serial_port_data(serial->port[i], NULL);
157
	}
158 159 160 161
	return -ENOMEM;
}

static void ark3116_set_termios(struct usb_serial_port *port,
Alan Cox's avatar
Alan Cox committed
162
				struct ktermios *old_termios)
163 164 165
{
	struct usb_serial *serial = port->serial;
	struct ark3116_private *priv = usb_get_serial_port_data(port);
166 167
	struct ktermios *termios = port->tty->termios;
	unsigned int cflag = termios->c_cflag;
168 169 170 171 172 173 174 175
	unsigned long flags;
	int baud;
	int ark3116_baud;
	char *buf;
	char config;

	config = 0;

176
	dbg("%s - port %d", __func__, port->number);
177 178 179 180

	spin_lock_irqsave(&priv->lock, flags);
	if (!priv->termios_initialized) {
		*(port->tty->termios) = tty_std_termios;
181 182
		port->tty->termios->c_cflag = B9600 | CS8
					      | CREAD | HUPCL | CLOCAL;
183 184
		termios->c_ispeed = 9600;
		termios->c_ospeed = 9600;
185 186 187 188
		priv->termios_initialized = 1;
	}
	spin_unlock_irqrestore(&priv->lock, flags);

189 190
	cflag = termios->c_cflag;
	termios->c_cflag &= ~(CMSPAR|CRTSCTS);
191 192 193 194

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf) {
		dbg("error kmalloc");
195
		*port->tty->termios = *old_termios;
196 197 198 199
		return;
	}

	/* set data bit count (8/7/6/5) */
200 201
	if (cflag & CSIZE) {
		switch (cflag & CSIZE) {
202 203 204 205 206 207 208 209 210 211 212 213 214
		case CS5:
			config |= 0x00;
			dbg("setting CS5");
			break;
		case CS6:
			config |= 0x01;
			dbg("setting CS6");
			break;
		case CS7:
			config |= 0x02;
			dbg("setting CS7");
			break;
		default:
215
			dbg("CSIZE was set but not CS5-CS8, using CS8!");
216
			/* fall through */
217 218 219 220 221 222 223
		case CS8:
			config |= 0x03;
			dbg("setting CS8");
			break;
		}
	}

224 225
	/* set parity (NONE/EVEN/ODD) */
	if (cflag & PARENB) {
226 227 228 229 230 231 232 233 234 235 236
		if (cflag & PARODD) {
			config |= 0x08;
			dbg("setting parity to ODD");
		} else {
			config |= 0x18;
			dbg("setting parity to EVEN");
		}
	} else {
		dbg("setting parity to NONE");
	}

237
	/* set stop bit (1/2) */
238 239
	if (cflag & CSTOPB) {
		config |= 0x04;
240
		dbg("setting 2 stop bits");
241
	} else {
242
		dbg("setting 1 stop bit");
243 244
	}

245
	/* set baudrate */
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
	baud = tty_get_baud_rate(port->tty);

	switch (baud) {
		case 75:
		case 150:
		case 300:
		case 600:
		case 1200:
		case 1800:
		case 2400:
		case 4800:
		case 9600:
		case 19200:
		case 38400:
		case 57600:
		case 115200:
		case 230400:
		case 460800:
264 265
			/* Report the resulting rate back to the caller */
			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 270
			tty_encode_baud_rate(port->tty, 9600, 9600);
		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 279
	 */
	if (baud == 460800)
		/* strange, for 460800 the formula is wrong
280
		 * if using round() then 9600baud is wrong) */
281 282 283 284 285
		ark3116_baud = 7;
	else
		ark3116_baud = 3000000 / baud;

	/* ? */
286 287
	ARK3116_RCV(serial, 0, 0xFE, 0xC0, 0x0000, 0x0003, 0x03, buf);

288 289
	/* offset = buf[0]; */
	/* offset = 0x03; */
290
	/* dbg("using 0x%04X as target for 0x0003:", 0x0080 + offset); */
291 292

	/* set baudrate */
293 294 295 296 297 298 299
	dbg("setting baudrate to %d (->reg=%d)", baud, ark3116_baud);
	ARK3116_SND(serial, 147, 0xFE, 0x40, 0x0083, 0x0003);
	ARK3116_SND(serial, 148, 0xFE, 0x40,
			    (ark3116_baud & 0x00FF), 0x0000);
	ARK3116_SND(serial, 149, 0xFE, 0x40,
			    (ark3116_baud & 0xFF00) >> 8, 0x0001);
	ARK3116_SND(serial, 150, 0xFE, 0x40, 0x0003, 0x0003);
300 301

	/* ? */
302 303
	ARK3116_RCV(serial, 151, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf);
	ARK3116_SND(serial, 152, 0xFE, 0x40, 0x0000, 0x0003);
304 305 306

	/* set data bit count, stop bit count & parity: */
	dbg("updating bit count, stop bit or parity (cfg=0x%02X)", config);
307 308
	ARK3116_RCV(serial, 153, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
	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 318 319 320 321
	return;
}

static int ark3116_open(struct usb_serial_port *port, struct file *filp)
{
Alan Cox's avatar
Alan Cox committed
322
	struct ktermios tmp_termios;
323 324 325 326
	struct usb_serial *serial = port->serial;
	char *buf;
	int result = 0;

327
	dbg("%s - port %d", __func__, port->number);
328 329 330

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf) {
331
		dbg("error kmalloc -> out of mem?");
332 333 334 335 336
		return -ENOMEM;
	}

	result = usb_serial_generic_open(port, filp);
	if (result)
Oliver Neukum's avatar
Oliver Neukum committed
337
		goto err_out;
338 339

	/* open */
340
	ARK3116_RCV(serial, 111, 0xFE, 0xC0, 0x0000, 0x0003, 0x02, buf);
341

342 343 344 345
	ARK3116_SND(serial, 112, 0xFE, 0x40, 0x0082, 0x0003);
	ARK3116_SND(serial, 113, 0xFE, 0x40, 0x001A, 0x0000);
	ARK3116_SND(serial, 114, 0xFE, 0x40, 0x0000, 0x0001);
	ARK3116_SND(serial, 115, 0xFE, 0x40, 0x0002, 0x0003);
346

347 348
	ARK3116_RCV(serial, 116, 0xFE, 0xC0, 0x0000, 0x0004, 0x03, buf);
	ARK3116_SND(serial, 117, 0xFE, 0x40, 0x0002, 0x0004);
349

350 351
	ARK3116_RCV(serial, 118, 0xFE, 0xC0, 0x0000, 0x0004, 0x02, buf);
	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 362
	/* returns different values (control lines?!) */
	ARK3116_RCV(serial, 124, 0xFE, 0xC0, 0x0000, 0x0006, 0xFF, buf);
363

364
	/* initialise termios */
365 366 367
	if (port->tty)
		ark3116_set_termios(port, &tmp_termios);

Oliver Neukum's avatar
Oliver Neukum committed
368
err_out:
369 370 371 372 373 374 375 376
	kfree(buf);

	return result;
}

static int ark3116_ioctl(struct usb_serial_port *port, struct file *file,
			 unsigned int cmd, unsigned long arg)
{
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
	struct serial_struct serstruct;
	void __user *user_arg = (void __user *)arg;

	switch (cmd) {
	case TIOCGSERIAL:
		/* XXX: Some of these values are probably wrong. */
		memset(&serstruct, 0, sizeof (serstruct));
		serstruct.type = PORT_16654;
		serstruct.line = port->serial->minor;
		serstruct.port = port->number;
		serstruct.custom_divisor = 0;
		serstruct.baud_base = 460800;

		if (copy_to_user(user_arg, &serstruct, sizeof (serstruct)))
			return -EFAULT;

		return 0;
	case TIOCSSERIAL:
		if (copy_from_user(&serstruct, user_arg, sizeof (serstruct)))
			return -EFAULT;
		return 0;
	default:
399
		dbg("%s cmd 0x%04x not supported", __func__, cmd);
400 401 402
		break;
	}

403 404 405 406 407 408 409 410 411
	return -ENOIOCTLCMD;
}

static int ark3116_tiocmget(struct usb_serial_port *port, struct file *file)
{
	struct usb_serial *serial = port->serial;
	char *buf;
	char temp;

412
	/* seems like serial port status info (RTS, CTS, ...) is stored
413 414 415 416 417 418 419 420 421 422 423
	 * in reg(?) 0x0006
	 * pcb connection point 11 = GND -> sets bit4 of response
	 * pcb connection point  7 = GND -> sets bit6 of response
	 */

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf) {
		dbg("error kmalloc");
		return -ENOMEM;
	}

424 425
	/* read register */
	ARK3116_RCV_QUIET(serial, 0xFE, 0xC0, 0x0000, 0x0006, buf);
426 427 428
	temp = buf[0];
	kfree(buf);

429 430
	/* i do not really know if bit4=CTS and bit6=DSR... just a
	 * quick guess!
431
	 */
432 433
	return (temp & (1<<4) ? TIOCM_CTS : 0)
	       | (temp & (1<<6) ? TIOCM_DSR : 0);
434 435 436 437 438 439 440
}

static struct usb_driver ark3116_driver = {
	.name =		"ark3116",
	.probe =	usb_serial_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	id_table,
441
	.no_dynamic_id =	1,
442 443 444 445 446 447 448 449
};

static struct usb_serial_driver ark3116_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"ark3116",
	},
	.id_table =		id_table,
450
	.usb_driver =		&ark3116_driver,
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
	.num_ports =		1,
	.attach =		ark3116_attach,
	.set_termios =		ark3116_set_termios,
	.ioctl =		ark3116_ioctl,
	.tiocmget =		ark3116_tiocmget,
	.open =			ark3116_open,
};

static int __init ark3116_init(void)
{
	int retval;

	retval = usb_serial_register(&ark3116_device);
	if (retval)
		return retval;
	retval = usb_register(&ark3116_driver);
	if (retval)
		usb_serial_deregister(&ark3116_device);
	return retval;
}

static void __exit ark3116_exit(void)
{
	usb_deregister(&ark3116_driver);
	usb_serial_deregister(&ark3116_device);
}

module_init(ark3116_init);
module_exit(ark3116_exit);
MODULE_LICENSE("GPL");

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled or not");