2 * USB Keyspan PDA / Xircom / Entregra Converter driver
4 * Copyright (C) 1999 - 2001 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 1999, 2000 Brian Warner <warner@lothar.com>
6 * Copyright (C) 2000 Al Borchers <borchers@steinerpoint.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * See Documentation/usb/usb-serial.txt for more information on using this
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/init.h>
21 #include <linux/slab.h>
22 #include <linux/tty.h>
23 #include <linux/tty_driver.h>
24 #include <linux/tty_flip.h>
25 #include <linux/module.h>
26 #include <linux/spinlock.h>
27 #include <linux/workqueue.h>
28 #include <linux/uaccess.h>
29 #include <linux/usb.h>
30 #include <linux/usb/serial.h>
31 #include <linux/usb/ezusb.h>
33 /* make a simple define to handle if we are compiling keyspan_pda or xircom support */
34 #if defined(CONFIG_USB_SERIAL_KEYSPAN_PDA) || defined(CONFIG_USB_SERIAL_KEYSPAN_PDA_MODULE)
39 #if defined(CONFIG_USB_SERIAL_XIRCOM) || defined(CONFIG_USB_SERIAL_XIRCOM_MODULE)
45 #define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
46 #define DRIVER_DESC "USB Keyspan PDA Converter driver"
48 struct keyspan_pda_private {
51 struct work_struct wakeup_work;
52 struct work_struct unthrottle_work;
53 struct usb_serial *serial;
54 struct usb_serial_port *port;
58 #define KEYSPAN_VENDOR_ID 0x06cd
59 #define KEYSPAN_PDA_FAKE_ID 0x0103
60 #define KEYSPAN_PDA_ID 0x0104 /* no clue */
62 /* For Xircom PGSDB9 and older Entregra version of the same device */
63 #define XIRCOM_VENDOR_ID 0x085a
64 #define XIRCOM_FAKE_ID 0x8027
65 #define ENTREGRA_VENDOR_ID 0x1645
66 #define ENTREGRA_FAKE_ID 0x8093
68 static const struct usb_device_id id_table_combined[] = {
70 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
73 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
74 { USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
76 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
77 { } /* Terminating entry */
80 MODULE_DEVICE_TABLE(usb, id_table_combined);
82 static const struct usb_device_id id_table_std[] = {
83 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
84 { } /* Terminating entry */
88 static const struct usb_device_id id_table_fake[] = {
89 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
90 { } /* Terminating entry */
95 static const struct usb_device_id id_table_fake_xircom[] = {
96 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
97 { USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
102 static void keyspan_pda_wakeup_write(struct work_struct *work)
104 struct keyspan_pda_private *priv =
105 container_of(work, struct keyspan_pda_private, wakeup_work);
106 struct usb_serial_port *port = priv->port;
107 struct tty_struct *tty = tty_port_tty_get(&port->port);
113 static void keyspan_pda_request_unthrottle(struct work_struct *work)
115 struct keyspan_pda_private *priv =
116 container_of(work, struct keyspan_pda_private, unthrottle_work);
117 struct usb_serial *serial = priv->serial;
120 /* ask the device to tell us when the tx buffer becomes
121 sufficiently empty */
122 result = usb_control_msg(serial->dev,
123 usb_sndctrlpipe(serial->dev, 0),
124 7, /* request_unthrottle */
125 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
127 16, /* value: threshold */
133 dev_dbg(&serial->dev->dev, "%s - error %d from usb_control_msg\n",
138 static void keyspan_pda_rx_interrupt(struct urb *urb)
140 struct usb_serial_port *port = urb->context;
141 struct tty_struct *tty;
142 unsigned char *data = urb->transfer_buffer;
144 int status = urb->status;
145 struct keyspan_pda_private *priv;
146 priv = usb_get_serial_port_data(port);
155 /* this urb is terminated, clean up */
156 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
159 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
163 /* see if the message is data or a status interrupt */
166 tty = tty_port_tty_get(&port->port);
167 /* rest of message is rx data */
168 if (tty && urb->actual_length) {
169 tty_insert_flip_string(tty, data + 1,
170 urb->actual_length - 1);
171 tty_flip_buffer_push(tty);
176 /* status interrupt */
177 dev_dbg(&port->dev, "rx int, d1=%d, d2=%d\n", data[1], data[2]);
179 case 1: /* modemline change */
181 case 2: /* tx unthrottle interrupt */
182 priv->tx_throttled = 0;
183 /* queue up a wakeup at scheduler time */
184 schedule_work(&priv->wakeup_work);
195 retval = usb_submit_urb(urb, GFP_ATOMIC);
198 "%s - usb_submit_urb failed with result %d",
203 static void keyspan_pda_rx_throttle(struct tty_struct *tty)
205 /* stop receiving characters. We just turn off the URB request, and
206 let chars pile up in the device. If we're doing hardware
207 flowcontrol, the device will signal the other end when its buffer
208 fills up. If we're doing XON/XOFF, this would be a good time to
209 send an XOFF, although it might make sense to foist that off
210 upon the device too. */
211 struct usb_serial_port *port = tty->driver_data;
213 usb_kill_urb(port->interrupt_in_urb);
217 static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
219 struct usb_serial_port *port = tty->driver_data;
220 /* just restart the receive interrupt URB */
222 if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
223 dev_dbg(&port->dev, "usb_submit_urb(read urb) failed\n");
227 static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
264 bindex = 5; /* Default to 9600 */
268 /* rather than figure out how to sleep while waiting for this
269 to complete, I just use the "legacy" API. */
270 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
273 | USB_RECIP_INTERFACE
274 | USB_DIR_OUT, /* type */
286 static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
288 struct usb_serial_port *port = tty->driver_data;
289 struct usb_serial *serial = port->serial;
293 if (break_state == -1)
294 value = 1; /* start break */
296 value = 0; /* clear break */
297 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
299 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
300 value, 0, NULL, 0, 2000);
302 dev_dbg(&port->dev, "%s - error %d from usb_control_msg\n",
304 /* there is something funky about this.. the TCSBRK that 'cu' performs
305 ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
306 seconds apart, but it feels like the break sent isn't as long as it
311 static void keyspan_pda_set_termios(struct tty_struct *tty,
312 struct usb_serial_port *port, struct ktermios *old_termios)
314 struct usb_serial *serial = port->serial;
317 /* cflag specifies lots of stuff: number of stop bits, parity, number
318 of data bits, baud. What can the device actually handle?:
319 CSTOPB (1 stop bit or 2)
322 There is minimal hw support for parity (a PSW bit seems to hold the
323 parity of whatever is in the accumulator). The UART either deals
324 with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
325 1 special, stop). So, with firmware changes, we could do:
327 8N2: 11 bit, extra bit always (mark?)
328 8[EOMS]1: 11 bit, extra bit is parity
329 7[EOMS]1: 10 bit, b0/b7 is parity
330 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
332 HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
335 For now, just do baud. */
337 speed = tty_get_baud_rate(tty);
338 speed = keyspan_pda_setbaud(serial, speed);
341 dev_dbg(&port->dev, "can't handle requested baud rate\n");
342 /* It hasn't changed so.. */
343 speed = tty_termios_baud_rate(old_termios);
345 /* Only speed can change so copy the old h/w parameters
346 then encode the new speed */
347 tty_termios_copy_hw(&tty->termios, old_termios);
348 tty_encode_baud_rate(tty, speed, speed);
352 /* modem control pins: DTR and RTS are outputs and can be controlled.
353 DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
354 read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
356 static int keyspan_pda_get_modem_info(struct usb_serial *serial,
357 unsigned char *value)
362 data = kmalloc(1, GFP_KERNEL);
366 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
368 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
369 0, 0, data, 1, 2000);
378 static int keyspan_pda_set_modem_info(struct usb_serial *serial,
382 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
384 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
385 value, 0, NULL, 0, 2000);
389 static int keyspan_pda_tiocmget(struct tty_struct *tty)
391 struct usb_serial_port *port = tty->driver_data;
392 struct usb_serial *serial = port->serial;
394 unsigned char status;
397 rc = keyspan_pda_get_modem_info(serial, &status);
401 ((status & (1<<7)) ? TIOCM_DTR : 0) |
402 ((status & (1<<6)) ? TIOCM_CAR : 0) |
403 ((status & (1<<5)) ? TIOCM_RNG : 0) |
404 ((status & (1<<4)) ? TIOCM_DSR : 0) |
405 ((status & (1<<3)) ? TIOCM_CTS : 0) |
406 ((status & (1<<2)) ? TIOCM_RTS : 0);
410 static int keyspan_pda_tiocmset(struct tty_struct *tty,
411 unsigned int set, unsigned int clear)
413 struct usb_serial_port *port = tty->driver_data;
414 struct usb_serial *serial = port->serial;
416 unsigned char status;
418 rc = keyspan_pda_get_modem_info(serial, &status);
427 if (clear & TIOCM_RTS)
429 if (clear & TIOCM_DTR)
431 rc = keyspan_pda_set_modem_info(serial, status);
435 static int keyspan_pda_write(struct tty_struct *tty,
436 struct usb_serial_port *port, const unsigned char *buf, int count)
438 struct usb_serial *serial = port->serial;
439 int request_unthrottle = 0;
441 struct keyspan_pda_private *priv;
443 priv = usb_get_serial_port_data(port);
444 /* guess how much room is left in the device's ring buffer, and if we
445 want to send more than that, check first, updating our notion of
446 what is left. If our write will result in no room left, ask the
447 device to give us an interrupt when the room available rises above
448 a threshold, and hold off all writers (eventually, those using
449 select() or poll() too) until we receive that unthrottle interrupt.
450 Block if we can't write anything at all, otherwise write as much as
453 dev_dbg(&port->dev, "write request of 0 bytes\n");
457 /* we might block because of:
458 the TX urb is in-flight (wait until it completes)
459 the device is full (wait until it says there is room)
461 spin_lock_bh(&port->lock);
462 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled) {
463 spin_unlock_bh(&port->lock);
466 clear_bit(0, &port->write_urbs_free);
467 spin_unlock_bh(&port->lock);
469 /* At this point the URB is in our control, nobody else can submit it
470 again (the only sudden transition was the one from EINPROGRESS to
471 finished). Also, the tx process is not throttled. So we are
474 count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
476 /* Check if we might overrun the Tx buffer. If so, ask the
477 device how much room it really has. This is done only on
478 scheduler time, since usb_control_msg() sleeps. */
479 if (count > priv->tx_room && !in_interrupt()) {
482 room = kmalloc(1, GFP_KERNEL);
488 rc = usb_control_msg(serial->dev,
489 usb_rcvctrlpipe(serial->dev, 0),
491 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
493 0, /* value: 0 means "remaining room" */
499 dev_dbg(&port->dev, "roomquery says %d\n", *room);
500 priv->tx_room = *room;
504 dev_dbg(&port->dev, "roomquery failed\n");
508 dev_dbg(&port->dev, "roomquery returned 0 bytes\n");
509 rc = -EIO; /* device didn't return any data */
513 if (count > priv->tx_room) {
514 /* we're about to completely fill the Tx buffer, so
515 we'll be throttled afterwards. */
516 count = priv->tx_room;
517 request_unthrottle = 1;
521 /* now transfer data */
522 memcpy(port->write_urb->transfer_buffer, buf, count);
523 /* send the data out the bulk port */
524 port->write_urb->transfer_buffer_length = count;
526 priv->tx_room -= count;
528 rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
530 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed\n");
534 /* There wasn't any room left, so we are throttled until
535 the buffer empties a bit */
536 request_unthrottle = 1;
539 if (request_unthrottle) {
540 priv->tx_throttled = 1; /* block writers */
541 schedule_work(&priv->unthrottle_work);
547 set_bit(0, &port->write_urbs_free);
552 static void keyspan_pda_write_bulk_callback(struct urb *urb)
554 struct usb_serial_port *port = urb->context;
555 struct keyspan_pda_private *priv;
557 set_bit(0, &port->write_urbs_free);
558 priv = usb_get_serial_port_data(port);
560 /* queue up a wakeup at scheduler time */
561 schedule_work(&priv->wakeup_work);
565 static int keyspan_pda_write_room(struct tty_struct *tty)
567 struct usb_serial_port *port = tty->driver_data;
568 struct keyspan_pda_private *priv;
569 priv = usb_get_serial_port_data(port);
570 /* used by n_tty.c for processing of tabs and such. Giving it our
571 conservative guess is probably good enough, but needs testing by
572 running a console through the device. */
573 return priv->tx_room;
577 static int keyspan_pda_chars_in_buffer(struct tty_struct *tty)
579 struct usb_serial_port *port = tty->driver_data;
580 struct keyspan_pda_private *priv;
584 priv = usb_get_serial_port_data(port);
586 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
587 n_tty.c:normal_poll() ) that we're not writeable. */
589 spin_lock_irqsave(&port->lock, flags);
590 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled)
592 spin_unlock_irqrestore(&port->lock, flags);
597 static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
599 struct usb_serial *serial = port->serial;
603 keyspan_pda_set_modem_info(serial, (1<<7) | (1<< 2));
605 keyspan_pda_set_modem_info(serial, 0);
610 static int keyspan_pda_open(struct tty_struct *tty,
611 struct usb_serial_port *port)
613 struct usb_serial *serial = port->serial;
616 struct keyspan_pda_private *priv;
618 /* find out how much room is in the Tx ring */
619 room = kmalloc(1, GFP_KERNEL);
623 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
625 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
633 dev_dbg(&port->dev, "%s - roomquery failed\n", __func__);
637 dev_dbg(&port->dev, "%s - roomquery returned 0 bytes\n", __func__);
641 priv = usb_get_serial_port_data(port);
642 priv->tx_room = *room;
643 priv->tx_throttled = *room ? 0 : 1;
645 /*Start reading from the device*/
646 rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
648 dev_dbg(&port->dev, "%s - usb_submit_urb(read int) failed\n", __func__);
655 static void keyspan_pda_close(struct usb_serial_port *port)
657 struct usb_serial *serial = port->serial;
660 /* shutdown our bulk reads and writes */
661 usb_kill_urb(port->write_urb);
662 usb_kill_urb(port->interrupt_in_urb);
667 /* download the firmware to a "fake" device (pre-renumeration) */
668 static int keyspan_pda_fake_startup(struct usb_serial *serial)
673 /* download the firmware here ... */
674 response = ezusb_fx1_set_reset(serial->dev, 1);
678 else if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
679 fw_name = "keyspan_pda/keyspan_pda.fw";
682 else if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
683 (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGRA_VENDOR_ID))
684 fw_name = "keyspan_pda/xircom_pgs.fw";
687 dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
692 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
693 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
698 /* after downloading firmware Renumeration will occur in a
699 moment and the new device will bind to the real driver */
701 /* we want this device to fail to have a driver assigned to it. */
706 MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
709 MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
712 static int keyspan_pda_port_probe(struct usb_serial_port *port)
715 struct keyspan_pda_private *priv;
717 priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
721 INIT_WORK(&priv->wakeup_work, keyspan_pda_wakeup_write);
722 INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
723 priv->serial = port->serial;
726 usb_set_serial_port_data(port, priv);
731 static int keyspan_pda_port_remove(struct usb_serial_port *port)
733 struct keyspan_pda_private *priv;
735 priv = usb_get_serial_port_data(port);
742 static struct usb_serial_driver keyspan_pda_fake_device = {
744 .owner = THIS_MODULE,
745 .name = "keyspan_pda_pre",
747 .description = "Keyspan PDA - (prerenumeration)",
748 .id_table = id_table_fake,
750 .attach = keyspan_pda_fake_startup,
755 static struct usb_serial_driver xircom_pgs_fake_device = {
757 .owner = THIS_MODULE,
758 .name = "xircom_no_firm",
760 .description = "Xircom / Entregra PGS - (prerenumeration)",
761 .id_table = id_table_fake_xircom,
763 .attach = keyspan_pda_fake_startup,
767 static struct usb_serial_driver keyspan_pda_device = {
769 .owner = THIS_MODULE,
770 .name = "keyspan_pda",
772 .description = "Keyspan PDA",
773 .id_table = id_table_std,
775 .dtr_rts = keyspan_pda_dtr_rts,
776 .open = keyspan_pda_open,
777 .close = keyspan_pda_close,
778 .write = keyspan_pda_write,
779 .write_room = keyspan_pda_write_room,
780 .write_bulk_callback = keyspan_pda_write_bulk_callback,
781 .read_int_callback = keyspan_pda_rx_interrupt,
782 .chars_in_buffer = keyspan_pda_chars_in_buffer,
783 .throttle = keyspan_pda_rx_throttle,
784 .unthrottle = keyspan_pda_rx_unthrottle,
785 .set_termios = keyspan_pda_set_termios,
786 .break_ctl = keyspan_pda_break_ctl,
787 .tiocmget = keyspan_pda_tiocmget,
788 .tiocmset = keyspan_pda_tiocmset,
789 .port_probe = keyspan_pda_port_probe,
790 .port_remove = keyspan_pda_port_remove,
793 static struct usb_serial_driver * const serial_drivers[] = {
796 &keyspan_pda_fake_device,
799 &xircom_pgs_fake_device,
804 module_usb_serial_driver(serial_drivers, id_table_combined);
806 MODULE_AUTHOR(DRIVER_AUTHOR);
807 MODULE_DESCRIPTION(DRIVER_DESC);
808 MODULE_LICENSE("GPL");