spcp8x5.c 12.8 KB
Newer Older
1 2 3
/*
 * spcp8x5 USB to serial adaptor driver
 *
4
 * Copyright (C) 2010-2013 Johan Hovold (jhovold@gmail.com)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 * Copyright (C) 2006 Linxb (xubin.lin@worldplus.com.cn)
 * Copyright (C) 2006 S1 Corp.
 *
 * Original driver for 2.6.10 pl2303 driver by
 *   Greg Kroah-Hartman (greg@kroah.com)
 * Changes for 2.6.20 by Harald Klein <hari@vt100.at>
 *
 *	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/errno.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>

J
Johan Hovold 已提交
28
#define DRIVER_DESC	"SPCP8x5 USB to serial adaptor driver"
29

30 31 32
#define SPCP825_QUIRK_NO_UART_STATUS	0x01
#define SPCP825_QUIRK_NO_WORK_MODE	0x02

33 34 35 36 37 38 39 40 41 42 43
#define SPCP8x5_007_VID		0x04FC
#define SPCP8x5_007_PID		0x0201
#define SPCP8x5_008_VID		0x04fc
#define SPCP8x5_008_PID		0x0235
#define SPCP8x5_PHILIPS_VID	0x0471
#define SPCP8x5_PHILIPS_PID	0x081e
#define SPCP8x5_INTERMATIC_VID	0x04FC
#define SPCP8x5_INTERMATIC_PID	0x0204
#define SPCP8x5_835_VID		0x04fc
#define SPCP8x5_835_PID		0x0231

44
static const struct usb_device_id id_table[] = {
45 46 47 48
	{ USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)},
	{ USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)},
	{ USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
	{ USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
49 50 51
	{ USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID),
	  .driver_info = SPCP825_QUIRK_NO_UART_STATUS |
				SPCP825_QUIRK_NO_WORK_MODE },
52 53 54 55 56
	{ }					/* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, id_table);

struct spcp8x5_usb_ctrl_arg {
J
Johan Hovold 已提交
57
	u8	type;
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
	u8	cmd;
	u8	cmd_type;
	u16	value;
	u16	index;
	u16	length;
};


/* spcp8x5 spec register define */
#define MCR_CONTROL_LINE_RTS		0x02
#define MCR_CONTROL_LINE_DTR		0x01
#define MCR_DTR				0x01
#define MCR_RTS				0x02

#define MSR_STATUS_LINE_DCD		0x80
#define MSR_STATUS_LINE_RI		0x40
#define MSR_STATUS_LINE_DSR		0x20
#define MSR_STATUS_LINE_CTS		0x10

/* verdor command here , we should define myself */
#define SET_DEFAULT			0x40
#define SET_DEFAULT_TYPE		0x20

#define SET_UART_FORMAT			0x40
#define SET_UART_FORMAT_TYPE		0x21
#define SET_UART_FORMAT_SIZE_5		0x00
#define SET_UART_FORMAT_SIZE_6		0x01
#define SET_UART_FORMAT_SIZE_7		0x02
#define SET_UART_FORMAT_SIZE_8		0x03
#define SET_UART_FORMAT_STOP_1		0x00
#define SET_UART_FORMAT_STOP_2		0x04
#define SET_UART_FORMAT_PAR_NONE	0x00
#define SET_UART_FORMAT_PAR_ODD		0x10
#define SET_UART_FORMAT_PAR_EVEN	0x30
#define SET_UART_FORMAT_PAR_MASK	0xD0
#define SET_UART_FORMAT_PAR_SPACE	0x90

#define GET_UART_STATUS_TYPE		0xc0
#define GET_UART_STATUS			0x22
#define GET_UART_STATUS_MSR		0x06

#define SET_UART_STATUS			0x40
#define SET_UART_STATUS_TYPE		0x23
#define SET_UART_STATUS_MCR		0x0004
#define SET_UART_STATUS_MCR_DTR		0x01
#define SET_UART_STATUS_MCR_RTS		0x02
#define SET_UART_STATUS_MCR_LOOP	0x10

#define SET_WORKING_MODE		0x40
#define SET_WORKING_MODE_TYPE		0x24
#define SET_WORKING_MODE_U2C		0x00
#define SET_WORKING_MODE_RS485		0x01
#define SET_WORKING_MODE_PDMA		0x02
#define SET_WORKING_MODE_SPP		0x03

#define SET_FLOWCTL_CHAR		0x40
#define SET_FLOWCTL_CHAR_TYPE		0x25

#define GET_VERSION			0xc0
#define GET_VERSION_TYPE		0x26

#define SET_REGISTER			0x40
#define SET_REGISTER_TYPE		0x27

#define	GET_REGISTER			0xc0
#define GET_REGISTER_TYPE		0x28

#define SET_RAM				0x40
#define SET_RAM_TYPE			0x31

#define GET_RAM				0xc0
#define GET_RAM_TYPE			0x32

/* how come ??? */
#define UART_STATE			0x08
133
#define UART_STATE_TRANSIENT_MASK	0x75
134 135 136 137 138 139 140 141 142 143
#define UART_DCD			0x01
#define UART_DSR			0x02
#define UART_BREAK_ERROR		0x04
#define UART_RING			0x08
#define UART_FRAME_ERROR		0x10
#define UART_PARITY_ERROR		0x20
#define UART_OVERRUN_ERROR		0x40
#define UART_CTS			0x80

struct spcp8x5_private {
144
	unsigned		quirks;
J
Johan Hovold 已提交
145 146
	spinlock_t		lock;
	u8			line_control;
147 148
};

149 150 151 152 153 154 155 156
static int spcp8x5_probe(struct usb_serial *serial,
						const struct usb_device_id *id)
{
	usb_set_serial_data(serial, (void *)id);

	return 0;
}

157
static int spcp8x5_port_probe(struct usb_serial_port *port)
158
{
159
	const struct usb_device_id *id = usb_get_serial_data(port->serial);
160 161
	struct spcp8x5_private *priv;

162 163 164
	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	if (!priv)
		return -ENOMEM;
165

166
	spin_lock_init(&priv->lock);
167
	priv->quirks = id->driver_info;
168

J
Johan Hovold 已提交
169
	usb_set_serial_port_data(port, priv);
170

171 172
	port->port.drain_delay = 256;

173 174 175
	return 0;
}

176
static int spcp8x5_port_remove(struct usb_serial_port *port)
177
{
178
	struct spcp8x5_private *priv;
179

180 181 182 183
	priv = usb_get_serial_port_data(port);
	kfree(priv);

	return 0;
184 185
}

186
static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
187
{
188 189
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	struct usb_device *dev = port->serial->dev;
190 191
	int retval;

192
	if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
193 194 195 196 197
		return -EPERM;

	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_UART_STATUS_TYPE, SET_UART_STATUS,
				 mcr, 0x04, NULL, 0, 100);
198 199 200 201
	if (retval != 0) {
		dev_err(&port->dev, "failed to set control lines: %d\n",
								retval);
	}
202 203 204
	return retval;
}

205
static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
206
{
207 208
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	struct usb_device *dev = port->serial->dev;
209
	u8 *buf;
210 211
	int ret;

212
	if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
213 214
		return -EPERM;

215 216
	buf = kzalloc(1, GFP_KERNEL);
	if (!buf)
217 218 219 220
		return -ENOMEM;

	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
			      GET_UART_STATUS, GET_UART_STATUS_TYPE,
221
			      0, GET_UART_STATUS_MSR, buf, 1, 100);
222
	if (ret < 0)
223
		dev_err(&port->dev, "failed to get modem status: %d\n", ret);
224

225
	dev_dbg(&port->dev, "0xc0:0x22:0:6  %d - 0x02%x\n", ret, *buf);
226 227
	*status = *buf;
	kfree(buf);
228 229 230 231

	return ret;
}

232 233
static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
								 u16 index)
234
{
235 236
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	struct usb_device *dev = port->serial->dev;
237 238
	int ret;

239
	if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE)
240 241 242 243 244
		return;

	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
			      SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
			      value, index, NULL, 0, 100);
245
	dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index);
246
	if (ret < 0)
247
		dev_err(&port->dev, "failed to set work mode: %d\n", ret);
248 249
}

250 251
static int spcp8x5_carrier_raised(struct usb_serial_port *port)
{
252 253
	u8 msr;
	int ret;
J
Johan Hovold 已提交
254

255 256
	ret = spcp8x5_get_msr(port, &msr);
	if (ret || msr & MSR_STATUS_LINE_DCD)
257
		return 1;
J
Johan Hovold 已提交
258

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
	return 0;
}

static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
{
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;

	spin_lock_irqsave(&priv->lock, flags);
	if (on)
		priv->line_control = MCR_CONTROL_LINE_DTR
						| MCR_CONTROL_LINE_RTS;
	else
		priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
						| MCR_CONTROL_LINE_RTS);
	control = priv->line_control;
	spin_unlock_irqrestore(&priv->lock, flags);
277
	spcp8x5_set_ctrl_line(port, control);
278 279
}

A
Alan Cox 已提交
280 281
static void spcp8x5_init_termios(struct tty_struct *tty)
{
282 283 284 285
	tty->termios = tty_std_termios;
	tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
	tty->termios.c_ispeed = 115200;
	tty->termios.c_ospeed = 115200;
A
Alan Cox 已提交
286 287
}

A
Alan Cox 已提交
288 289
static void spcp8x5_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
290 291 292 293
{
	struct usb_serial *serial = port->serial;
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
294
	unsigned int cflag = tty->termios.c_cflag;
295 296 297 298 299 300 301
	unsigned short uartdata;
	unsigned char buf[2] = {0, 0};
	int baud;
	int i;
	u8 control;

	/* check that they really want us to change something */
302
	if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
303 304 305 306 307
		return;

	/* set DTR/RTS active */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
308
	if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
309
		priv->line_control |= MCR_DTR;
310
		if (!(old_termios->c_cflag & CRTSCTS))
311 312 313 314 315
			priv->line_control |= MCR_RTS;
	}
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
316
		spcp8x5_set_ctrl_line(port, control);
317 318 319 320 321
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}

	/* Set Baud Rate */
322
	baud = tty_get_baud_rate(tty);
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
	switch (baud) {
	case 300:	buf[0] = 0x00;	break;
	case 600:	buf[0] = 0x01;	break;
	case 1200:	buf[0] = 0x02;	break;
	case 2400:	buf[0] = 0x03;	break;
	case 4800:	buf[0] = 0x04;	break;
	case 9600:	buf[0] = 0x05;	break;
	case 19200:	buf[0] = 0x07;	break;
	case 38400:	buf[0] = 0x09;	break;
	case 57600:	buf[0] = 0x0a;	break;
	case 115200:	buf[0] = 0x0b;	break;
	case 230400:	buf[0] = 0x0c;	break;
	case 460800:	buf[0] = 0x0d;	break;
	case 921600:	buf[0] = 0x0e;	break;
/*	case 1200000:	buf[0] = 0x0f;	break; */
/*	case 2400000:	buf[0] = 0x10;	break; */
	case 3000000:	buf[0] = 0x11;	break;
/*	case 6000000:	buf[0] = 0x12;	break; */
	case 0:
	case 1000000:
			buf[0] = 0x0b;	break;
	default:
345
		dev_err(&port->dev, "unsupported baudrate, using 9600\n");
346 347 348
	}

	/* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
349 350 351 352 353 354 355 356 357 358 359 360 361 362
	switch (cflag & CSIZE) {
	case CS5:
		buf[1] |= SET_UART_FORMAT_SIZE_5;
		break;
	case CS6:
		buf[1] |= SET_UART_FORMAT_SIZE_6;
		break;
	case CS7:
		buf[1] |= SET_UART_FORMAT_SIZE_7;
		break;
	default:
	case CS8:
		buf[1] |= SET_UART_FORMAT_SIZE_8;
		break;
363 364 365 366 367 368 369 370 371 372
	}

	/* Set Stop bit2 : 0:1bit 1:2bit */
	buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
				     SET_UART_FORMAT_STOP_1;

	/* Set Parity bit3-4 01:Odd 11:Even */
	if (cflag & PARENB) {
		buf[1] |= (cflag & PARODD) ?
		SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
J
Johan Hovold 已提交
373
	} else {
374
		buf[1] |= SET_UART_FORMAT_PAR_NONE;
J
Johan Hovold 已提交
375
	}
376 377 378 379 380 381
	uartdata = buf[0] | buf[1]<<8;

	i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			    SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
			    uartdata, 0, NULL, 0, 100);
	if (i < 0)
382 383
		dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
			uartdata, i);
384
	dev_dbg(&port->dev, "0x21:0x40:0:0  %d\n", i);
385 386 387

	if (cflag & CRTSCTS) {
		/* enable hardware flow control */
388
		spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
389 390 391
	}
}

392
static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
393 394 395 396 397 398 399 400 401 402 403 404 405 406
{
	struct usb_serial *serial = port->serial;
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	int ret;

	usb_clear_halt(serial->dev, port->write_urb->pipe);
	usb_clear_halt(serial->dev, port->read_urb->pipe);

	ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			      0x09, 0x00,
			      0x01, 0x00, NULL, 0x00, 100);
	if (ret)
		return ret;

407
	spcp8x5_set_ctrl_line(port, priv->line_control);
408

A
Alan Cox 已提交
409
	if (tty)
410
		spcp8x5_set_termios(tty, port, NULL);
411

412
	return usb_serial_generic_open(tty, port);
413 414
}

415
static int spcp8x5_tiocmset(struct tty_struct *tty,
416 417
			    unsigned int set, unsigned int clear)
{
A
Alan Cox 已提交
418
	struct usb_serial_port *port = tty->driver_data;
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;

	spin_lock_irqsave(&priv->lock, flags);
	if (set & TIOCM_RTS)
		priv->line_control |= MCR_RTS;
	if (set & TIOCM_DTR)
		priv->line_control |= MCR_DTR;
	if (clear & TIOCM_RTS)
		priv->line_control &= ~MCR_RTS;
	if (clear & TIOCM_DTR)
		priv->line_control &= ~MCR_DTR;
	control = priv->line_control;
	spin_unlock_irqrestore(&priv->lock, flags);

435
	return spcp8x5_set_ctrl_line(port, control);
436 437
}

438
static int spcp8x5_tiocmget(struct tty_struct *tty)
439
{
A
Alan Cox 已提交
440
	struct usb_serial_port *port = tty->driver_data;
441 442 443
	struct spcp8x5_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
444
	u8 status;
445 446
	unsigned int result;

447 448 449 450
	result = spcp8x5_get_msr(port, &status);
	if (result)
		return result;

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
	spin_lock_irqsave(&priv->lock, flags);
	mcr = priv->line_control;
	spin_unlock_irqrestore(&priv->lock, flags);

	result = ((mcr & MCR_DTR)			? TIOCM_DTR : 0)
		  | ((mcr & MCR_RTS)			? TIOCM_RTS : 0)
		  | ((status & MSR_STATUS_LINE_CTS)	? TIOCM_CTS : 0)
		  | ((status & MSR_STATUS_LINE_DSR)	? TIOCM_DSR : 0)
		  | ((status & MSR_STATUS_LINE_RI)	? TIOCM_RI  : 0)
		  | ((status & MSR_STATUS_LINE_DCD)	? TIOCM_CD  : 0);

	return result;
}

static struct usb_serial_driver spcp8x5_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"SPCP8x5",
	},
	.id_table		= id_table,
	.num_ports		= 1,
J
Johan Hovold 已提交
472
	.open			= spcp8x5_open,
473 474
	.dtr_rts		= spcp8x5_dtr_rts,
	.carrier_raised		= spcp8x5_carrier_raised,
J
Johan Hovold 已提交
475
	.set_termios		= spcp8x5_set_termios,
A
Alan Cox 已提交
476
	.init_termios		= spcp8x5_init_termios,
J
Johan Hovold 已提交
477 478
	.tiocmget		= spcp8x5_tiocmget,
	.tiocmset		= spcp8x5_tiocmset,
479
	.probe			= spcp8x5_probe,
480 481
	.port_probe		= spcp8x5_port_probe,
	.port_remove		= spcp8x5_port_remove,
482 483
};

484 485 486 487
static struct usb_serial_driver * const serial_drivers[] = {
	&spcp8x5_device, NULL
};

488
module_usb_serial_driver(serial_drivers, id_table);
489 490 491

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");