ark3116.c 12.1 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
#include <linux/serial.h>
Alan Cox's avatar
Alan Cox committed
27
#include <linux/uaccess.h>
28 29 30 31 32 33


static int debug;

static struct usb_device_id id_table [] = {
	{ USB_DEVICE(0x6547, 0x0232) },
34
	{ USB_DEVICE(0x18ec, 0x3118) },		/* USB to IrDA adapter */
35 36 37 38
	{ },
};
MODULE_DEVICE_TABLE(usb, id_table);

39 40 41 42 43 44 45 46 47
static int is_irda(struct usb_serial *serial)
{
	struct usb_device *dev = serial->dev;
	if (le16_to_cpu(dev->descriptor.idVendor) == 0x18ec &&
			le16_to_cpu(dev->descriptor.idProduct) == 0x3118)
		return 1;
	return 0;
}

48 49 50 51 52 53
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,
54
				 usb_sndctrlpipe(serial->dev, 0),
55
				 request, requesttype, value, index,
56 57
				 NULL, 0x00, 1000);
	dbg("%03d > ok", seq);
58 59 60 61 62 63 64 65 66
}

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,
67 68 69
				 usb_rcvctrlpipe(serial->dev, 0),
				 request, requesttype, value, index,
				 buf, 0x0000001, 1000);
70
	if (result)
71 72
		dbg("%03d < %d bytes [0x%02X]", seq, result,
		    ((unsigned char *)buf)[0]);
73 74 75 76 77 78 79 80 81
	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,
82
			usb_rcvctrlpipe(serial->dev, 0),
83 84 85 86 87 88 89 90 91 92
			request, requesttype, value, index,
			buf, 0x0000001, 1000);
}

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

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf) {
93
		dbg("error kmalloc -> out of mem?");
Alan Cox's avatar
Alan Cox committed
94
		return -ENOMEM;
95 96
	}

97 98 99
	if (is_irda(serial))
		dbg("IrDA mode");

100
	/* 3 */
101 102 103
	ARK3116_SND(serial, 3, 0xFE, 0x40, 0x0008, 0x0002);
	ARK3116_SND(serial, 4, 0xFE, 0x40, 0x0008, 0x0001);
	ARK3116_SND(serial, 5, 0xFE, 0x40, 0x0000, 0x0008);
104 105 106 107 108 109 110 111
	ARK3116_SND(serial, 6, 0xFE, 0x40, is_irda(serial) ? 0x0001 : 0x0000,
		    0x000B);

	if (is_irda(serial)) {
		ARK3116_SND(serial, 1001, 0xFE, 0x40, 0x0000, 0x000C);
		ARK3116_SND(serial, 1002, 0xFE, 0x40, 0x0041, 0x000D);
		ARK3116_SND(serial, 1003, 0xFE, 0x40, 0x0001, 0x000A);
	}
112 113

	/* <-- seq7 */
114 115 116 117 118
	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);
119 120

	/* <-- seq12 */
121 122
	ARK3116_RCV(serial, 12, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
	ARK3116_SND(serial, 13, 0xFE, 0x40, 0x0000, 0x0004);
123 124

	/* 14 */
125 126
	ARK3116_RCV(serial, 14, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
	ARK3116_SND(serial, 15, 0xFE, 0x40, 0x0000, 0x0004);
127 128

	/* 16 */
129
	ARK3116_RCV(serial, 16, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
130
	/* --> seq17 */
131
	ARK3116_SND(serial, 17, 0xFE, 0x40, 0x0001, 0x0004);
132 133

	/* <-- seq18 */
134
	ARK3116_RCV(serial, 18, 0xFE, 0xC0, 0x0000, 0x0004, 0x01, buf);
135 136

	/* --> seq19 */
137
	ARK3116_SND(serial, 19, 0xFE, 0x40, 0x0003, 0x0004);
138 139

	/* <-- seq20 */
140 141 142 143 144 145 146 147
	/* 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);
148 149
	if (is_irda(serial))
		ARK3116_SND(serial, 1004, 0xFE, 0x40, 0x0000, 0x0009);
150 151 152 153 154
	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);
155 156

	kfree(buf);
157
	return 0;
Alan Cox's avatar
Alan Cox committed
158
}
159

Alan Cox's avatar
Alan Cox committed
160 161 162 163 164 165 166 167
static void ark3116_init_termios(struct tty_struct *tty)
{
	struct ktermios *termios = tty->termios;
	*termios = tty_std_termios;
	termios->c_cflag = B9600 | CS8
				      | CREAD | HUPCL | CLOCAL;
	termios->c_ispeed = 9600;
	termios->c_ospeed = 9600;
168 169
}

Alan Cox's avatar
Alan Cox committed
170 171
static void ark3116_set_termios(struct tty_struct *tty,
				struct usb_serial_port *port,
Alan Cox's avatar
Alan Cox committed
172
				struct ktermios *old_termios)
173 174
{
	struct usb_serial *serial = port->serial;
Alan Cox's avatar
Alan Cox committed
175
	struct ktermios *termios = tty->termios;
176
	unsigned int cflag = termios->c_cflag;
177 178 179 180 181 182 183
	int baud;
	int ark3116_baud;
	char *buf;
	char config;

	config = 0;

184
	dbg("%s - port %d", __func__, port->number);
185 186


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

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf) {
		dbg("error kmalloc");
Alan Cox's avatar
Alan Cox committed
193
		*termios = *old_termios;
194 195 196 197
		return;
	}

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

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

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

243
	/* set baudrate */
Alan Cox's avatar
Alan Cox committed
244
	baud = tty_get_baud_rate(tty);
245 246

	switch (baud) {
Alan Cox's avatar
Alan Cox committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
	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:
		/* Report the resulting rate back to the caller */
Alan Cox's avatar
Alan Cox committed
263
		tty_encode_baud_rate(tty, baud, baud);
Alan Cox's avatar
Alan Cox committed
264 265 266
		break;
	/* set 9600 as default (if given baudrate is invalid for example) */
	default:
Alan Cox's avatar
Alan Cox committed
267
		tty_encode_baud_rate(tty, 9600, 9600);
Alan Cox's avatar
Alan Cox committed
268 269
	case 0:
		baud = 9600;
270 271 272 273
	}

	/*
	 * found by try'n'error, be careful, maybe there are other options
274
	 * for multiplicator etc! (3.5 for example)
275 276 277
	 */
	if (baud == 460800)
		/* strange, for 460800 the formula is wrong
278
		 * if using round() then 9600baud is wrong) */
279 280 281 282 283
		ark3116_baud = 7;
	else
		ark3116_baud = 3000000 / baud;

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

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

	/* set baudrate */
291 292 293 294 295 296 297
	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);
298 299

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

	/* set data bit count, stop bit count & parity: */
	dbg("updating bit count, stop bit or parity (cfg=0x%02X)", config);
305 306
	ARK3116_RCV(serial, 153, 0xFE, 0xC0, 0x0000, 0x0003, 0x00, buf);
	ARK3116_SND(serial, 154, 0xFE, 0x40, config, 0x0003);
307 308

	if (cflag & CRTSCTS)
309
		dbg("CRTSCTS not supported by chipset?!");
310

311
	/* TEST ARK3116_SND(154, 0xFE, 0x40, 0xFFFF, 0x0006); */
312 313

	kfree(buf);
314

315 316 317
	return;
}

318
static int ark3116_open(struct tty_struct *tty, struct usb_serial_port *port)
319
{
Alan Cox's avatar
Alan Cox committed
320
	struct ktermios tmp_termios;
321 322 323 324
	struct usb_serial *serial = port->serial;
	char *buf;
	int result = 0;

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

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

333
	result = usb_serial_generic_open(tty, port);
334
	if (result)
Oliver Neukum's avatar
Oliver Neukum committed
335
		goto err_out;
336 337

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

340 341 342 343
	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);
344

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

348 349
	ARK3116_RCV(serial, 118, 0xFE, 0xC0, 0x0000, 0x0004, 0x02, buf);
	ARK3116_SND(serial, 119, 0xFE, 0x40, 0x0000, 0x0004);
350

351
	ARK3116_RCV(serial, 120, 0xFE, 0xC0, 0x0000, 0x0004, 0x00, buf);
352

353
	ARK3116_SND(serial, 121, 0xFE, 0x40, 0x0001, 0x0004);
354

355
	ARK3116_RCV(serial, 122, 0xFE, 0xC0, 0x0000, 0x0004, 0x01, buf);
356

357
	ARK3116_SND(serial, 123, 0xFE, 0x40, 0x0003, 0x0004);
358

359 360
	/* returns different values (control lines?!) */
	ARK3116_RCV(serial, 124, 0xFE, 0xC0, 0x0000, 0x0006, 0xFF, buf);
361

362
	/* initialise termios */
Alan Cox's avatar
Alan Cox committed
363 364
	if (tty)
		ark3116_set_termios(tty, port, &tmp_termios);
365

Oliver Neukum's avatar
Oliver Neukum committed
366
err_out:
367 368 369 370 371
	kfree(buf);

	return result;
}

Alan Cox's avatar
Alan Cox committed
372
static int ark3116_ioctl(struct tty_struct *tty, struct file *file,
373 374
			 unsigned int cmd, unsigned long arg)
{
Alan Cox's avatar
Alan Cox committed
375
	struct usb_serial_port *port = tty->driver_data;
376 377 378 379 380 381
	struct serial_struct serstruct;
	void __user *user_arg = (void __user *)arg;

	switch (cmd) {
	case TIOCGSERIAL:
		/* XXX: Some of these values are probably wrong. */
Alan Cox's avatar
Alan Cox committed
382
		memset(&serstruct, 0, sizeof(serstruct));
383 384 385 386 387 388
		serstruct.type = PORT_16654;
		serstruct.line = port->serial->minor;
		serstruct.port = port->number;
		serstruct.custom_divisor = 0;
		serstruct.baud_base = 460800;

Alan Cox's avatar
Alan Cox committed
389
		if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
390 391 392 393
			return -EFAULT;

		return 0;
	case TIOCSSERIAL:
Alan Cox's avatar
Alan Cox committed
394
		if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
395 396 397
			return -EFAULT;
		return 0;
	default:
398
		dbg("%s cmd 0x%04x not supported", __func__, cmd);
399 400 401
		break;
	}

402 403 404
	return -ENOIOCTLCMD;
}

Alan Cox's avatar
Alan Cox committed
405
static int ark3116_tiocmget(struct tty_struct *tty, struct file *file)
406
{
Alan Cox's avatar
Alan Cox committed
407
	struct usb_serial_port *port = tty->driver_data;
408 409 410 411
	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
	.num_ports =		1,
	.attach =		ark3116_attach,
	.set_termios =		ark3116_set_termios,
Alan Cox's avatar
Alan Cox committed
454
	.init_termios =		ark3116_init_termios,
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 485
	.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");