keyspan_pda.c 20.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * USB Keyspan PDA / Xircom / Entregra Converter driver
 *
 * Copyright (C) 1999 - 2001 Greg Kroah-Hartman	<greg@kroah.com>
 * Copyright (C) 1999, 2000 Brian Warner	<warner@lothar.com>
 * Copyright (C) 2000 Al Borchers		<borchers@steinerpoint.com>
 *
 *	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.
 *
A
Alan Cox 已提交
13 14
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
L
Linus Torvalds 已提交
15 16 17 18 19 20 21 22 23 24 25 26
 */


#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/workqueue.h>
A
Alan Cox 已提交
27
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
28
#include <linux/usb.h>
29
#include <linux/usb/serial.h>
30
#include <linux/usb/ezusb.h>
L
Linus Torvalds 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

/* make a simple define to handle if we are compiling keyspan_pda or xircom support */
#if defined(CONFIG_USB_SERIAL_KEYSPAN_PDA) || defined(CONFIG_USB_SERIAL_KEYSPAN_PDA_MODULE)
	#define KEYSPAN
#else
	#undef KEYSPAN
#endif
#if defined(CONFIG_USB_SERIAL_XIRCOM) || defined(CONFIG_USB_SERIAL_XIRCOM_MODULE)
	#define XIRCOM
#else
	#undef XIRCOM
#endif

#define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
#define DRIVER_DESC "USB Keyspan PDA Converter driver"

struct keyspan_pda_private {
	int			tx_room;
	int			tx_throttled;
	struct work_struct			wakeup_work;
	struct work_struct			unthrottle_work;
D
David Howells 已提交
52 53
	struct usb_serial	*serial;
	struct usb_serial_port	*port;
L
Linus Torvalds 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66
};


#define KEYSPAN_VENDOR_ID		0x06cd
#define KEYSPAN_PDA_FAKE_ID		0x0103
#define KEYSPAN_PDA_ID			0x0104 /* no clue */

/* For Xircom PGSDB9 and older Entregra version of the same device */
#define XIRCOM_VENDOR_ID		0x085a
#define XIRCOM_FAKE_ID			0x8027
#define ENTREGRA_VENDOR_ID		0x1645
#define ENTREGRA_FAKE_ID		0x8093

67
static const struct usb_device_id id_table_combined[] = {
L
Linus Torvalds 已提交
68 69 70 71 72 73 74 75 76 77 78
#ifdef KEYSPAN
	{ USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
#endif
#ifdef XIRCOM
	{ USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
	{ USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
#endif
	{ USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
	{ }						/* Terminating entry */
};

A
Alan Cox 已提交
79
MODULE_DEVICE_TABLE(usb, id_table_combined);
L
Linus Torvalds 已提交
80

81
static const struct usb_device_id id_table_std[] = {
L
Linus Torvalds 已提交
82 83 84 85 86
	{ USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
	{ }						/* Terminating entry */
};

#ifdef KEYSPAN
87
static const struct usb_device_id id_table_fake[] = {
L
Linus Torvalds 已提交
88 89 90 91 92 93
	{ USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
	{ }						/* Terminating entry */
};
#endif

#ifdef XIRCOM
94
static const struct usb_device_id id_table_fake_xircom[] = {
A
Alan Cox 已提交
95 96 97
	{ USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
	{ USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
	{ }
L
Linus Torvalds 已提交
98 99 100
};
#endif

D
David Howells 已提交
101
static void keyspan_pda_wakeup_write(struct work_struct *work)
L
Linus Torvalds 已提交
102
{
D
David Howells 已提交
103 104 105
	struct keyspan_pda_private *priv =
		container_of(work, struct keyspan_pda_private, wakeup_work);
	struct usb_serial_port *port = priv->port;
J
Jiri Slaby 已提交
106 107

	tty_port_tty_wakeup(&port->port);
L
Linus Torvalds 已提交
108 109
}

D
David Howells 已提交
110
static void keyspan_pda_request_unthrottle(struct work_struct *work)
L
Linus Torvalds 已提交
111
{
D
David Howells 已提交
112 113 114
	struct keyspan_pda_private *priv =
		container_of(work, struct keyspan_pda_private, unthrottle_work);
	struct usb_serial *serial = priv->serial;
L
Linus Torvalds 已提交
115 116 117 118
	int result;

	/* ask the device to tell us when the tx buffer becomes
	   sufficiently empty */
A
Alan Cox 已提交
119
	result = usb_control_msg(serial->dev,
L
Linus Torvalds 已提交
120 121 122 123 124 125 126 127 128 129
				 usb_sndctrlpipe(serial->dev, 0),
				 7, /* request_unthrottle */
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
				 | USB_DIR_OUT,
				 16, /* value: threshold */
				 0, /* index */
				 NULL,
				 0,
				 2000);
	if (result < 0)
130 131
		dev_dbg(&serial->dev->dev, "%s - error %d from usb_control_msg\n",
			__func__, result);
L
Linus Torvalds 已提交
132 133 134
}


A
Alan Cox 已提交
135
static void keyspan_pda_rx_interrupt(struct urb *urb)
L
Linus Torvalds 已提交
136
{
137
	struct usb_serial_port *port = urb->context;
L
Linus Torvalds 已提交
138
	unsigned char *data = urb->transfer_buffer;
139 140
	int retval;
	int status = urb->status;
L
Linus Torvalds 已提交
141 142 143
	struct keyspan_pda_private *priv;
	priv = usb_get_serial_port_data(port);

144
	switch (status) {
L
Linus Torvalds 已提交
145 146 147 148 149 150 151
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
152
		dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
153
		return;
L
Linus Torvalds 已提交
154
	default:
155
		dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
L
Linus Torvalds 已提交
156 157 158
		goto exit;
	}

A
Alan Cox 已提交
159
	/* see if the message is data or a status interrupt */
L
Linus Torvalds 已提交
160 161
	switch (data[0]) {
	case 0:
162
		 /* rest of message is rx data */
J
Jiri Slaby 已提交
163
		if (urb->actual_length) {
J
Jiri Slaby 已提交
164
			tty_insert_flip_string(&port->port, data + 1,
165
						urb->actual_length - 1);
J
Jiri Slaby 已提交
166
			tty_flip_buffer_push(&port->port);
L
Linus Torvalds 已提交
167 168 169 170
		}
		break;
	case 1:
		/* status interrupt */
171
		dev_dbg(&port->dev, "rx int, d1=%d, d2=%d\n", data[1], data[2]);
L
Linus Torvalds 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
		switch (data[1]) {
		case 1: /* modemline change */
			break;
		case 2: /* tx unthrottle interrupt */
			priv->tx_throttled = 0;
			/* queue up a wakeup at scheduler time */
			schedule_work(&priv->wakeup_work);
			break;
		default:
			break;
		}
		break;
	default:
		break;
	}

exit:
A
Alan Cox 已提交
189
	retval = usb_submit_urb(urb, GFP_ATOMIC);
190
	if (retval)
A
Alan Cox 已提交
191 192 193
		dev_err(&port->dev,
			"%s - usb_submit_urb failed with result %d",
			__func__, retval);
L
Linus Torvalds 已提交
194 195 196
}


A
Alan Cox 已提交
197
static void keyspan_pda_rx_throttle(struct tty_struct *tty)
L
Linus Torvalds 已提交
198 199 200 201 202 203 204
{
	/* stop receiving characters. We just turn off the URB request, and
	   let chars pile up in the device. If we're doing hardware
	   flowcontrol, the device will signal the other end when its buffer
	   fills up. If we're doing XON/XOFF, this would be a good time to
	   send an XOFF, although it might make sense to foist that off
	   upon the device too. */
A
Alan Cox 已提交
205
	struct usb_serial_port *port = tty->driver_data;
206

L
Linus Torvalds 已提交
207 208 209 210
	usb_kill_urb(port->interrupt_in_urb);
}


A
Alan Cox 已提交
211
static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
L
Linus Torvalds 已提交
212
{
A
Alan Cox 已提交
213
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
214
	/* just restart the receive interrupt URB */
215

216
	if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
217
		dev_dbg(&port->dev, "usb_submit_urb(read urb) failed\n");
L
Linus Torvalds 已提交
218 219 220
}


A
Alan Cox 已提交
221
static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
L
Linus Torvalds 已提交
222 223 224 225
{
	int rc;
	int bindex;

A
Alan Cox 已提交
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
	switch (baud) {
	case 110:
		bindex = 0;
		break;
	case 300:
		bindex = 1;
		break;
	case 1200:
		bindex = 2;
		break;
	case 2400:
		bindex = 3;
		break;
	case 4800:
		bindex = 4;
		break;
	case 9600:
		bindex = 5;
		break;
	case 19200:
		bindex = 6;
		break;
	case 38400:
		bindex = 7;
		break;
	case 57600:
		bindex = 8;
		break;
	case 115200:
		bindex = 9;
		break;
	default:
		bindex = 5;	/* Default to 9600 */
		baud = 9600;
L
Linus Torvalds 已提交
260 261 262 263 264 265
	}

	/* rather than figure out how to sleep while waiting for this
	   to complete, I just use the "legacy" API. */
	rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			     0, /* set baud */
A
Alan Cox 已提交
266
			     USB_TYPE_VENDOR
L
Linus Torvalds 已提交
267 268 269 270 271 272 273
			     | USB_RECIP_INTERFACE
			     | USB_DIR_OUT, /* type */
			     bindex, /* value */
			     0, /* index */
			     NULL, /* &data */
			     0, /* size */
			     2000); /* timeout */
274 275 276
	if (rc < 0)
		return 0;
	return baud;
L
Linus Torvalds 已提交
277 278 279
}


A
Alan Cox 已提交
280
static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
L
Linus Torvalds 已提交
281
{
A
Alan Cox 已提交
282
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
283 284 285 286 287 288 289 290 291
	struct usb_serial *serial = port->serial;
	int value;
	int result;

	if (break_state == -1)
		value = 1; /* start break */
	else
		value = 0; /* clear break */
	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
A
Alan Cox 已提交
292 293 294
			4, /* set break */
			USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
			value, 0, NULL, 0, 2000);
L
Linus Torvalds 已提交
295
	if (result < 0)
296 297
		dev_dbg(&port->dev, "%s - error %d from usb_control_msg\n",
			__func__, result);
L
Linus Torvalds 已提交
298 299 300 301 302 303 304
	/* there is something funky about this.. the TCSBRK that 'cu' performs
	   ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
	   seconds apart, but it feels like the break sent isn't as long as it
	   is on /dev/ttyS0 */
}


A
Alan Cox 已提交
305 306
static void keyspan_pda_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
L
Linus Torvalds 已提交
307 308
{
	struct usb_serial *serial = port->serial;
309
	speed_t speed;
L
Linus Torvalds 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

	/* cflag specifies lots of stuff: number of stop bits, parity, number
	   of data bits, baud. What can the device actually handle?:
	   CSTOPB (1 stop bit or 2)
	   PARENB (parity)
	   CSIZE (5bit .. 8bit)
	   There is minimal hw support for parity (a PSW bit seems to hold the
	   parity of whatever is in the accumulator). The UART either deals
	   with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
	   1 special, stop). So, with firmware changes, we could do:
	   8N1: 10 bit
	   8N2: 11 bit, extra bit always (mark?)
	   8[EOMS]1: 11 bit, extra bit is parity
	   7[EOMS]1: 10 bit, b0/b7 is parity
	   7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)

326
	   HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
L
Linus Torvalds 已提交
327 328 329 330
	   bit.

	   For now, just do baud. */

A
Alan Cox 已提交
331
	speed = tty_get_baud_rate(tty);
332 333 334
	speed = keyspan_pda_setbaud(serial, speed);

	if (speed == 0) {
335
		dev_dbg(&port->dev, "can't handle requested baud rate\n");
336 337
		/* It hasn't changed so.. */
		speed = tty_termios_baud_rate(old_termios);
L
Linus Torvalds 已提交
338
	}
339 340
	/* Only speed can change so copy the old h/w parameters
	   then encode the new speed */
341
	tty_termios_copy_hw(&tty->termios, old_termios);
A
Alan Cox 已提交
342
	tty_encode_baud_rate(tty, speed, speed);
L
Linus Torvalds 已提交
343 344 345 346 347 348 349 350 351 352 353
}


/* modem control pins: DTR and RTS are outputs and can be controlled.
   DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
   read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */

static int keyspan_pda_get_modem_info(struct usb_serial *serial,
				      unsigned char *value)
{
	int rc;
354 355 356 357 358 359
	u8 *data;

	data = kmalloc(1, GFP_KERNEL);
	if (!data)
		return -ENOMEM;

L
Linus Torvalds 已提交
360 361 362
	rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			     3, /* get pins */
			     USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
363
			     0, 0, data, 1, 2000);
364
	if (rc >= 0)
365 366 367
		*value = *data;

	kfree(data);
L
Linus Torvalds 已提交
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
	return rc;
}


static int keyspan_pda_set_modem_info(struct usb_serial *serial,
				      unsigned char value)
{
	int rc;
	rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			     3, /* set pins */
			     USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
			     value, 0, NULL, 0, 2000);
	return rc;
}

383
static int keyspan_pda_tiocmget(struct tty_struct *tty)
L
Linus Torvalds 已提交
384
{
A
Alan Cox 已提交
385
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
	struct usb_serial *serial = port->serial;
	int rc;
	unsigned char status;
	int value;

	rc = keyspan_pda_get_modem_info(serial, &status);
	if (rc < 0)
		return rc;
	value =
		((status & (1<<7)) ? TIOCM_DTR : 0) |
		((status & (1<<6)) ? TIOCM_CAR : 0) |
		((status & (1<<5)) ? TIOCM_RNG : 0) |
		((status & (1<<4)) ? TIOCM_DSR : 0) |
		((status & (1<<3)) ? TIOCM_CTS : 0) |
		((status & (1<<2)) ? TIOCM_RTS : 0);
	return value;
}

404
static int keyspan_pda_tiocmset(struct tty_struct *tty,
L
Linus Torvalds 已提交
405 406
				unsigned int set, unsigned int clear)
{
A
Alan Cox 已提交
407
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
	struct usb_serial *serial = port->serial;
	int rc;
	unsigned char status;

	rc = keyspan_pda_get_modem_info(serial, &status);
	if (rc < 0)
		return rc;

	if (set & TIOCM_RTS)
		status |= (1<<2);
	if (set & TIOCM_DTR)
		status |= (1<<7);

	if (clear & TIOCM_RTS)
		status &= ~(1<<2);
	if (clear & TIOCM_DTR)
		status &= ~(1<<7);
	rc = keyspan_pda_set_modem_info(serial, status);
	return rc;
}

A
Alan Cox 已提交
429 430
static int keyspan_pda_write(struct tty_struct *tty,
	struct usb_serial_port *port, const unsigned char *buf, int count)
L
Linus Torvalds 已提交
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
{
	struct usb_serial *serial = port->serial;
	int request_unthrottle = 0;
	int rc = 0;
	struct keyspan_pda_private *priv;

	priv = usb_get_serial_port_data(port);
	/* guess how much room is left in the device's ring buffer, and if we
	   want to send more than that, check first, updating our notion of
	   what is left. If our write will result in no room left, ask the
	   device to give us an interrupt when the room available rises above
	   a threshold, and hold off all writers (eventually, those using
	   select() or poll() too) until we receive that unthrottle interrupt.
	   Block if we can't write anything at all, otherwise write as much as
	   we can. */
	if (count == 0) {
447
		dev_dbg(&port->dev, "write request of 0 bytes\n");
A
Alan Cox 已提交
448
		return 0;
L
Linus Torvalds 已提交
449 450 451 452 453 454
	}

	/* we might block because of:
	   the TX urb is in-flight (wait until it completes)
	   the device is full (wait until it says there is room)
	*/
455
	spin_lock_bh(&port->lock);
456
	if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled) {
457
		spin_unlock_bh(&port->lock);
458
		return 0;
L
Linus Torvalds 已提交
459
	}
460
	clear_bit(0, &port->write_urbs_free);
461
	spin_unlock_bh(&port->lock);
L
Linus Torvalds 已提交
462 463 464 465 466 467 468 469 470 471 472 473

	/* At this point the URB is in our control, nobody else can submit it
	   again (the only sudden transition was the one from EINPROGRESS to
	   finished).  Also, the tx process is not throttled. So we are
	   ready to write. */

	count = (count > port->bulk_out_size) ? port->bulk_out_size : count;

	/* Check if we might overrun the Tx buffer.   If so, ask the
	   device how much room it really has.  This is done only on
	   scheduler time, since usb_control_msg() sleeps. */
	if (count > priv->tx_room && !in_interrupt()) {
474 475 476 477 478 479 480 481
		u8 *room;

		room = kmalloc(1, GFP_KERNEL);
		if (!room) {
			rc = -ENOMEM;
			goto exit;
		}

A
Alan Cox 已提交
482
		rc = usb_control_msg(serial->dev,
L
Linus Torvalds 已提交
483 484 485 486 487 488
				     usb_rcvctrlpipe(serial->dev, 0),
				     6, /* write_room */
				     USB_TYPE_VENDOR | USB_RECIP_INTERFACE
				     | USB_DIR_IN,
				     0, /* value: 0 means "remaining room" */
				     0, /* index */
489
				     room,
L
Linus Torvalds 已提交
490 491
				     1,
				     2000);
492
		if (rc > 0) {
493
			dev_dbg(&port->dev, "roomquery says %d\n", *room);
494 495 496
			priv->tx_room = *room;
		}
		kfree(room);
L
Linus Torvalds 已提交
497
		if (rc < 0) {
498
			dev_dbg(&port->dev, "roomquery failed\n");
L
Linus Torvalds 已提交
499 500 501
			goto exit;
		}
		if (rc == 0) {
502
			dev_dbg(&port->dev, "roomquery returned 0 bytes\n");
L
Linus Torvalds 已提交
503 504 505 506 507 508 509 510 511 512 513 514 515
			rc = -EIO; /* device didn't return any data */
			goto exit;
		}
	}
	if (count > priv->tx_room) {
		/* we're about to completely fill the Tx buffer, so
		   we'll be throttled afterwards. */
		count = priv->tx_room;
		request_unthrottle = 1;
	}

	if (count) {
		/* now transfer data */
A
Alan Cox 已提交
516
		memcpy(port->write_urb->transfer_buffer, buf, count);
L
Linus Torvalds 已提交
517 518
		/* send the data out the bulk port */
		port->write_urb->transfer_buffer_length = count;
519

L
Linus Torvalds 已提交
520 521 522 523
		priv->tx_room -= count;

		rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
		if (rc) {
524
			dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed\n");
L
Linus Torvalds 已提交
525 526
			goto exit;
		}
A
Alan Cox 已提交
527
	} else {
L
Linus Torvalds 已提交
528 529 530 531 532 533 534 535 536 537 538 539
		/* There wasn't any room left, so we are throttled until
		   the buffer empties a bit */
		request_unthrottle = 1;
	}

	if (request_unthrottle) {
		priv->tx_throttled = 1; /* block writers */
		schedule_work(&priv->unthrottle_work);
	}

	rc = count;
exit:
540
	if (rc < 0)
541
		set_bit(0, &port->write_urbs_free);
L
Linus Torvalds 已提交
542 543 544 545
	return rc;
}


A
Alan Cox 已提交
546
static void keyspan_pda_write_bulk_callback(struct urb *urb)
L
Linus Torvalds 已提交
547
{
548
	struct usb_serial_port *port = urb->context;
L
Linus Torvalds 已提交
549 550
	struct keyspan_pda_private *priv;

551
	set_bit(0, &port->write_urbs_free);
L
Linus Torvalds 已提交
552 553 554 555 556 557 558
	priv = usb_get_serial_port_data(port);

	/* queue up a wakeup at scheduler time */
	schedule_work(&priv->wakeup_work);
}


A
Alan Cox 已提交
559
static int keyspan_pda_write_room(struct tty_struct *tty)
L
Linus Torvalds 已提交
560
{
A
Alan Cox 已提交
561
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
562 563 564 565 566
	struct keyspan_pda_private *priv;
	priv = usb_get_serial_port_data(port);
	/* used by n_tty.c for processing of tabs and such. Giving it our
	   conservative guess is probably good enough, but needs testing by
	   running a console through the device. */
A
Alan Cox 已提交
567
	return priv->tx_room;
L
Linus Torvalds 已提交
568 569 570
}


A
Alan Cox 已提交
571
static int keyspan_pda_chars_in_buffer(struct tty_struct *tty)
L
Linus Torvalds 已提交
572
{
A
Alan Cox 已提交
573
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
574
	struct keyspan_pda_private *priv;
575 576
	unsigned long flags;
	int ret = 0;
577

L
Linus Torvalds 已提交
578
	priv = usb_get_serial_port_data(port);
579

L
Linus Torvalds 已提交
580 581
	/* when throttled, return at least WAKEUP_CHARS to tell select() (via
	   n_tty.c:normal_poll() ) that we're not writeable. */
582 583

	spin_lock_irqsave(&port->lock, flags);
584
	if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled)
585 586 587
		ret = 256;
	spin_unlock_irqrestore(&port->lock, flags);
	return ret;
L
Linus Torvalds 已提交
588 589 590
}


591 592 593 594
static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
{
	struct usb_serial *serial = port->serial;

595 596 597 598
	if (on)
		keyspan_pda_set_modem_info(serial, (1 << 7) | (1 << 2));
	else
		keyspan_pda_set_modem_info(serial, 0);
599 600 601
}


A
Alan Cox 已提交
602
static int keyspan_pda_open(struct tty_struct *tty,
603
					struct usb_serial_port *port)
L
Linus Torvalds 已提交
604 605
{
	struct usb_serial *serial = port->serial;
606
	u8 *room;
L
Linus Torvalds 已提交
607 608 609 610
	int rc = 0;
	struct keyspan_pda_private *priv;

	/* find out how much room is in the Tx ring */
611 612 613 614
	room = kmalloc(1, GFP_KERNEL);
	if (!room)
		return -ENOMEM;

L
Linus Torvalds 已提交
615 616 617 618 619 620
	rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			     6, /* write_room */
			     USB_TYPE_VENDOR | USB_RECIP_INTERFACE
			     | USB_DIR_IN,
			     0, /* value */
			     0, /* index */
621
			     room,
L
Linus Torvalds 已提交
622 623 624
			     1,
			     2000);
	if (rc < 0) {
625
		dev_dbg(&port->dev, "%s - roomquery failed\n", __func__);
L
Linus Torvalds 已提交
626 627 628
		goto error;
	}
	if (rc == 0) {
629
		dev_dbg(&port->dev, "%s - roomquery returned 0 bytes\n", __func__);
L
Linus Torvalds 已提交
630 631 632 633
		rc = -EIO;
		goto error;
	}
	priv = usb_get_serial_port_data(port);
634 635
	priv->tx_room = *room;
	priv->tx_throttled = *room ? 0 : 1;
L
Linus Torvalds 已提交
636 637 638 639

	/*Start reading from the device*/
	rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
	if (rc) {
640
		dev_dbg(&port->dev, "%s - usb_submit_urb(read int) failed\n", __func__);
L
Linus Torvalds 已提交
641 642 643
		goto error;
	}
error:
644
	kfree(room);
L
Linus Torvalds 已提交
645 646
	return rc;
}
647
static void keyspan_pda_close(struct usb_serial_port *port)
L
Linus Torvalds 已提交
648
{
649 650
	usb_kill_urb(port->write_urb);
	usb_kill_urb(port->interrupt_in_urb);
L
Linus Torvalds 已提交
651 652 653 654
}


/* download the firmware to a "fake" device (pre-renumeration) */
A
Alan Cox 已提交
655
static int keyspan_pda_fake_startup(struct usb_serial *serial)
L
Linus Torvalds 已提交
656 657
{
	int response;
658
	const char *fw_name;
L
Linus Torvalds 已提交
659 660

	/* download the firmware here ... */
661
	response = ezusb_fx1_set_reset(serial->dev, 1);
L
Linus Torvalds 已提交
662

663
	if (0) { ; }
L
Linus Torvalds 已提交
664
#ifdef KEYSPAN
665 666
	else if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
		fw_name = "keyspan_pda/keyspan_pda.fw";
L
Linus Torvalds 已提交
667 668
#endif
#ifdef XIRCOM
669 670 671
	else if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
		 (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGRA_VENDOR_ID))
		fw_name = "keyspan_pda/xircom_pgs.fw";
L
Linus Torvalds 已提交
672
#endif
673
	else {
674 675
		dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
			__func__);
L
Linus Torvalds 已提交
676 677
		return -ENODEV;
	}
678 679

	if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
680 681
		dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
			fw_name);
682 683
		return -ENOENT;
	}
684 685 686

	/* after downloading firmware Renumeration will occur in a
	  moment and the new device will bind to the real driver */
L
Linus Torvalds 已提交
687 688

	/* we want this device to fail to have a driver assigned to it. */
A
Alan Cox 已提交
689
	return 1;
L
Linus Torvalds 已提交
690 691
}

692 693 694 695 696 697 698
#ifdef KEYSPAN
MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
#endif
#ifdef XIRCOM
MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
#endif

699
static int keyspan_pda_port_probe(struct usb_serial_port *port)
L
Linus Torvalds 已提交
700 701 702 703 704 705
{

	struct keyspan_pda_private *priv;

	priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
	if (!priv)
706 707
		return -ENOMEM;

D
David Howells 已提交
708 709
	INIT_WORK(&priv->wakeup_work, keyspan_pda_wakeup_write);
	INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
710 711 712 713 714
	priv->serial = port->serial;
	priv->port = port;

	usb_set_serial_port_data(port, priv);

A
Alan Cox 已提交
715
	return 0;
L
Linus Torvalds 已提交
716 717
}

718
static int keyspan_pda_port_remove(struct usb_serial_port *port)
L
Linus Torvalds 已提交
719
{
720 721 722 723 724 725
	struct keyspan_pda_private *priv;

	priv = usb_get_serial_port_data(port);
	kfree(priv);

	return 0;
L
Linus Torvalds 已提交
726 727 728
}

#ifdef KEYSPAN
729
static struct usb_serial_driver keyspan_pda_fake_device = {
730 731
	.driver = {
		.owner =	THIS_MODULE,
732
		.name =		"keyspan_pda_pre",
733
	},
734
	.description =		"Keyspan PDA - (prerenumeration)",
L
Linus Torvalds 已提交
735 736 737 738 739 740 741
	.id_table =		id_table_fake,
	.num_ports =		1,
	.attach =		keyspan_pda_fake_startup,
};
#endif

#ifdef XIRCOM
742
static struct usb_serial_driver xircom_pgs_fake_device = {
743 744
	.driver = {
		.owner =	THIS_MODULE,
745
		.name =		"xircom_no_firm",
746
	},
747
	.description =		"Xircom / Entregra PGS - (prerenumeration)",
L
Linus Torvalds 已提交
748 749 750 751 752 753
	.id_table =		id_table_fake_xircom,
	.num_ports =		1,
	.attach =		keyspan_pda_fake_startup,
};
#endif

754
static struct usb_serial_driver keyspan_pda_device = {
755 756
	.driver = {
		.owner =	THIS_MODULE,
757
		.name =		"keyspan_pda",
758
	},
759
	.description =		"Keyspan PDA",
L
Linus Torvalds 已提交
760 761
	.id_table =		id_table_std,
	.num_ports =		1,
762
	.dtr_rts =		keyspan_pda_dtr_rts,
L
Linus Torvalds 已提交
763 764 765 766 767 768 769 770 771 772 773 774 775
	.open =			keyspan_pda_open,
	.close =		keyspan_pda_close,
	.write =		keyspan_pda_write,
	.write_room =		keyspan_pda_write_room,
	.write_bulk_callback = 	keyspan_pda_write_bulk_callback,
	.read_int_callback =	keyspan_pda_rx_interrupt,
	.chars_in_buffer =	keyspan_pda_chars_in_buffer,
	.throttle =		keyspan_pda_rx_throttle,
	.unthrottle =		keyspan_pda_rx_unthrottle,
	.set_termios =		keyspan_pda_set_termios,
	.break_ctl =		keyspan_pda_break_ctl,
	.tiocmget =		keyspan_pda_tiocmget,
	.tiocmset =		keyspan_pda_tiocmset,
776 777
	.port_probe =		keyspan_pda_port_probe,
	.port_remove =		keyspan_pda_port_remove,
L
Linus Torvalds 已提交
778 779
};

780 781
static struct usb_serial_driver * const serial_drivers[] = {
	&keyspan_pda_device,
L
Linus Torvalds 已提交
782
#ifdef KEYSPAN
783
	&keyspan_pda_fake_device,
L
Linus Torvalds 已提交
784 785
#endif
#ifdef XIRCOM
786
	&xircom_pgs_fake_device,
L
Linus Torvalds 已提交
787
#endif
788 789
	NULL
};
L
Linus Torvalds 已提交
790

791
module_usb_serial_driver(serial_drivers, id_table_combined);
L
Linus Torvalds 已提交
792

A
Alan Cox 已提交
793 794
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
L
Linus Torvalds 已提交
795
MODULE_LICENSE("GPL");