2 * USB Keyspan PDA / Xircom / Entrega 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/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/module.h>
25 #include <linux/spinlock.h>
26 #include <linux/workqueue.h>
27 #include <linux/uaccess.h>
28 #include <linux/usb.h>
29 #include <linux/usb/serial.h>
30 #include <linux/usb/ezusb.h>
32 /* make a simple define to handle if we are compiling keyspan_pda or xircom support */
33 #if IS_ENABLED(CONFIG_USB_SERIAL_KEYSPAN_PDA)
38 #if IS_ENABLED(CONFIG_USB_SERIAL_XIRCOM)
44 #define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
45 #define DRIVER_DESC "USB Keyspan PDA Converter driver"
47 #define KEYSPAN_TX_THRESHOLD 16
49 struct keyspan_pda_private {
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 Entrega version of the same device */
63 #define XIRCOM_VENDOR_ID 0x085a
64 #define XIRCOM_FAKE_ID 0x8027
65 #define XIRCOM_FAKE_ID_2 0x8025 /* "PGMFHUB" serial */
66 #define ENTREGA_VENDOR_ID 0x1645
67 #define ENTREGA_FAKE_ID 0x8093
69 static const struct usb_device_id id_table_combined[] = {
71 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
74 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
75 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
76 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
78 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
79 { } /* Terminating entry */
82 MODULE_DEVICE_TABLE(usb, id_table_combined);
84 static const struct usb_device_id id_table_std[] = {
85 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
86 { } /* Terminating entry */
90 static const struct usb_device_id id_table_fake[] = {
91 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
92 { } /* Terminating entry */
97 static const struct usb_device_id id_table_fake_xircom[] = {
98 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
99 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
100 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
105 static void keyspan_pda_request_unthrottle(struct work_struct *work)
107 struct keyspan_pda_private *priv =
108 container_of(work, struct keyspan_pda_private, unthrottle_work);
109 struct usb_serial *serial = priv->serial;
112 /* ask the device to tell us when the tx buffer becomes
113 sufficiently empty */
114 result = usb_control_msg(serial->dev,
115 usb_sndctrlpipe(serial->dev, 0),
116 7, /* request_unthrottle */
117 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
119 KEYSPAN_TX_THRESHOLD,
125 dev_dbg(&serial->dev->dev, "%s - error %d from usb_control_msg\n",
130 static void keyspan_pda_rx_interrupt(struct urb *urb)
132 struct usb_serial_port *port = urb->context;
133 unsigned char *data = urb->transfer_buffer;
134 unsigned int len = urb->actual_length;
136 int status = urb->status;
137 struct keyspan_pda_private *priv;
140 priv = usb_get_serial_port_data(port);
149 /* this urb is terminated, clean up */
150 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
153 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
158 dev_warn(&port->dev, "short message received\n");
162 /* see if the message is data or a status interrupt */
165 /* rest of message is rx data */
168 tty_insert_flip_string(&port->port, data + 1, len - 1);
169 tty_flip_buffer_push(&port->port);
172 /* status interrupt */
174 dev_warn(&port->dev, "short interrupt message received\n");
177 dev_dbg(&port->dev, "rx int, d1=%d\n", data[1]);
179 case 1: /* modemline change */
181 case 2: /* tx unthrottle interrupt */
182 spin_lock_irqsave(&port->lock, flags);
183 priv->tx_throttled = 0;
184 priv->tx_room = max(priv->tx_room, KEYSPAN_TX_THRESHOLD);
185 spin_unlock_irqrestore(&port->lock, flags);
186 /* queue up a wakeup at scheduler time */
187 usb_serial_port_softint(port);
198 retval = usb_submit_urb(urb, GFP_ATOMIC);
201 "%s - usb_submit_urb failed with result %d\n",
206 static void keyspan_pda_rx_throttle(struct tty_struct *tty)
208 /* stop receiving characters. We just turn off the URB request, and
209 let chars pile up in the device. If we're doing hardware
210 flowcontrol, the device will signal the other end when its buffer
211 fills up. If we're doing XON/XOFF, this would be a good time to
212 send an XOFF, although it might make sense to foist that off
213 upon the device too. */
214 struct usb_serial_port *port = tty->driver_data;
216 usb_kill_urb(port->interrupt_in_urb);
220 static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
222 struct usb_serial_port *port = tty->driver_data;
223 /* just restart the receive interrupt URB */
225 if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
226 dev_dbg(&port->dev, "usb_submit_urb(read urb) failed\n");
230 static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
267 bindex = 5; /* Default to 9600 */
271 /* rather than figure out how to sleep while waiting for this
272 to complete, I just use the "legacy" API. */
273 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
276 | USB_RECIP_INTERFACE
277 | USB_DIR_OUT, /* type */
289 static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
291 struct usb_serial_port *port = tty->driver_data;
292 struct usb_serial *serial = port->serial;
296 if (break_state == -1)
297 value = 1; /* start break */
299 value = 0; /* clear break */
300 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
302 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
303 value, 0, NULL, 0, 2000);
305 dev_dbg(&port->dev, "%s - error %d from usb_control_msg\n",
307 /* there is something funky about this.. the TCSBRK that 'cu' performs
308 ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
309 seconds apart, but it feels like the break sent isn't as long as it
314 static void keyspan_pda_set_termios(struct tty_struct *tty,
315 struct usb_serial_port *port, struct ktermios *old_termios)
317 struct usb_serial *serial = port->serial;
320 /* cflag specifies lots of stuff: number of stop bits, parity, number
321 of data bits, baud. What can the device actually handle?:
322 CSTOPB (1 stop bit or 2)
325 There is minimal hw support for parity (a PSW bit seems to hold the
326 parity of whatever is in the accumulator). The UART either deals
327 with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
328 1 special, stop). So, with firmware changes, we could do:
330 8N2: 11 bit, extra bit always (mark?)
331 8[EOMS]1: 11 bit, extra bit is parity
332 7[EOMS]1: 10 bit, b0/b7 is parity
333 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
335 HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
338 For now, just do baud. */
340 speed = tty_get_baud_rate(tty);
341 speed = keyspan_pda_setbaud(serial, speed);
344 dev_dbg(&port->dev, "can't handle requested baud rate\n");
345 /* It hasn't changed so.. */
346 speed = tty_termios_baud_rate(old_termios);
348 /* Only speed can change so copy the old h/w parameters
349 then encode the new speed */
350 tty_termios_copy_hw(&tty->termios, old_termios);
351 tty_encode_baud_rate(tty, speed, speed);
355 /* modem control pins: DTR and RTS are outputs and can be controlled.
356 DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
357 read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
359 static int keyspan_pda_get_modem_info(struct usb_serial *serial,
360 unsigned char *value)
365 data = kmalloc(1, GFP_KERNEL);
369 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
371 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
372 0, 0, data, 1, 2000);
383 static int keyspan_pda_set_modem_info(struct usb_serial *serial,
387 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
389 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
390 value, 0, NULL, 0, 2000);
394 static int keyspan_pda_tiocmget(struct tty_struct *tty)
396 struct usb_serial_port *port = tty->driver_data;
397 struct usb_serial *serial = port->serial;
399 unsigned char status;
402 rc = keyspan_pda_get_modem_info(serial, &status);
406 ((status & (1<<7)) ? TIOCM_DTR : 0) |
407 ((status & (1<<6)) ? TIOCM_CAR : 0) |
408 ((status & (1<<5)) ? TIOCM_RNG : 0) |
409 ((status & (1<<4)) ? TIOCM_DSR : 0) |
410 ((status & (1<<3)) ? TIOCM_CTS : 0) |
411 ((status & (1<<2)) ? TIOCM_RTS : 0);
415 static int keyspan_pda_tiocmset(struct tty_struct *tty,
416 unsigned int set, unsigned int clear)
418 struct usb_serial_port *port = tty->driver_data;
419 struct usb_serial *serial = port->serial;
421 unsigned char status;
423 rc = keyspan_pda_get_modem_info(serial, &status);
432 if (clear & TIOCM_RTS)
434 if (clear & TIOCM_DTR)
436 rc = keyspan_pda_set_modem_info(serial, status);
440 static int keyspan_pda_write(struct tty_struct *tty,
441 struct usb_serial_port *port, const unsigned char *buf, int count)
443 struct usb_serial *serial = port->serial;
444 int request_unthrottle = 0;
446 struct keyspan_pda_private *priv;
449 priv = usb_get_serial_port_data(port);
450 /* guess how much room is left in the device's ring buffer, and if we
451 want to send more than that, check first, updating our notion of
452 what is left. If our write will result in no room left, ask the
453 device to give us an interrupt when the room available rises above
454 a threshold, and hold off all writers (eventually, those using
455 select() or poll() too) until we receive that unthrottle interrupt.
456 Block if we can't write anything at all, otherwise write as much as
459 dev_dbg(&port->dev, "write request of 0 bytes\n");
463 /* we might block because of:
464 the TX urb is in-flight (wait until it completes)
465 the device is full (wait until it says there is room)
467 spin_lock_irqsave(&port->lock, flags);
468 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled) {
469 spin_unlock_irqrestore(&port->lock, flags);
472 clear_bit(0, &port->write_urbs_free);
473 spin_unlock_irqrestore(&port->lock, flags);
475 /* At this point the URB is in our control, nobody else can submit it
476 again (the only sudden transition was the one from EINPROGRESS to
477 finished). Also, the tx process is not throttled. So we are
480 count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
482 /* Check if we might overrun the Tx buffer. If so, ask the
483 device how much room it really has. This is done only on
484 scheduler time, since usb_control_msg() sleeps. */
485 if (count > priv->tx_room && !in_interrupt()) {
488 room = kmalloc(1, GFP_KERNEL);
494 rc = usb_control_msg(serial->dev,
495 usb_rcvctrlpipe(serial->dev, 0),
497 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
499 0, /* value: 0 means "remaining room" */
505 dev_dbg(&port->dev, "roomquery says %d\n", *room);
506 priv->tx_room = *room;
510 dev_dbg(&port->dev, "roomquery failed\n");
514 dev_dbg(&port->dev, "roomquery returned 0 bytes\n");
515 rc = -EIO; /* device didn't return any data */
520 if (count >= priv->tx_room) {
521 /* we're about to completely fill the Tx buffer, so
522 we'll be throttled afterwards. */
523 count = priv->tx_room;
524 request_unthrottle = 1;
528 /* now transfer data */
529 memcpy(port->write_urb->transfer_buffer, buf, count);
530 /* send the data out the bulk port */
531 port->write_urb->transfer_buffer_length = count;
533 priv->tx_room -= count;
535 rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
537 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed\n");
541 /* There wasn't any room left, so we are throttled until
542 the buffer empties a bit */
543 request_unthrottle = 1;
546 if (request_unthrottle) {
547 priv->tx_throttled = 1; /* block writers */
548 schedule_work(&priv->unthrottle_work);
554 set_bit(0, &port->write_urbs_free);
559 static void keyspan_pda_write_bulk_callback(struct urb *urb)
561 struct usb_serial_port *port = urb->context;
563 set_bit(0, &port->write_urbs_free);
565 /* queue up a wakeup at scheduler time */
566 usb_serial_port_softint(port);
570 static int keyspan_pda_write_room(struct tty_struct *tty)
572 struct usb_serial_port *port = tty->driver_data;
573 struct keyspan_pda_private *priv = usb_get_serial_port_data(port);
577 spin_lock_irqsave(&port->lock, flags);
578 if (test_bit(0, &port->write_urbs_free) && !priv->tx_throttled)
579 room = priv->tx_room;
580 spin_unlock_irqrestore(&port->lock, flags);
585 static int keyspan_pda_chars_in_buffer(struct tty_struct *tty)
587 struct usb_serial_port *port = tty->driver_data;
588 struct keyspan_pda_private *priv;
592 priv = usb_get_serial_port_data(port);
594 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
595 n_tty.c:normal_poll() ) that we're not writeable. */
597 spin_lock_irqsave(&port->lock, flags);
598 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled)
600 spin_unlock_irqrestore(&port->lock, flags);
605 static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
607 struct usb_serial *serial = port->serial;
610 keyspan_pda_set_modem_info(serial, (1 << 7) | (1 << 2));
612 keyspan_pda_set_modem_info(serial, 0);
616 static int keyspan_pda_open(struct tty_struct *tty,
617 struct usb_serial_port *port)
619 struct usb_serial *serial = port->serial;
622 struct keyspan_pda_private *priv;
624 /* find out how much room is in the Tx ring */
625 room = kmalloc(1, GFP_KERNEL);
629 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
631 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
639 dev_dbg(&port->dev, "%s - roomquery failed\n", __func__);
643 dev_dbg(&port->dev, "%s - roomquery returned 0 bytes\n", __func__);
647 priv = usb_get_serial_port_data(port);
648 priv->tx_room = *room;
649 priv->tx_throttled = *room ? 0 : 1;
651 /*Start reading from the device*/
652 rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
654 dev_dbg(&port->dev, "%s - usb_submit_urb(read int) failed\n", __func__);
661 static void keyspan_pda_close(struct usb_serial_port *port)
663 struct keyspan_pda_private *priv = usb_get_serial_port_data(port);
665 usb_kill_urb(port->write_urb);
666 usb_kill_urb(port->interrupt_in_urb);
668 cancel_work_sync(&priv->unthrottle_work);
672 /* download the firmware to a "fake" device (pre-renumeration) */
673 static int keyspan_pda_fake_startup(struct usb_serial *serial)
678 /* download the firmware here ... */
679 response = ezusb_fx1_set_reset(serial->dev, 1);
683 else if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
684 fw_name = "keyspan_pda/keyspan_pda.fw";
687 else if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
688 (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGA_VENDOR_ID))
689 fw_name = "keyspan_pda/xircom_pgs.fw";
692 dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
697 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
698 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
703 /* after downloading firmware Renumeration will occur in a
704 moment and the new device will bind to the real driver */
706 /* we want this device to fail to have a driver assigned to it. */
711 MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
714 MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
717 static int keyspan_pda_port_probe(struct usb_serial_port *port)
720 struct keyspan_pda_private *priv;
722 priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
726 INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
727 priv->serial = port->serial;
730 usb_set_serial_port_data(port, priv);
735 static int keyspan_pda_port_remove(struct usb_serial_port *port)
737 struct keyspan_pda_private *priv;
739 priv = usb_get_serial_port_data(port);
746 static struct usb_serial_driver keyspan_pda_fake_device = {
748 .owner = THIS_MODULE,
749 .name = "keyspan_pda_pre",
751 .description = "Keyspan PDA - (prerenumeration)",
752 .id_table = id_table_fake,
754 .attach = keyspan_pda_fake_startup,
759 static struct usb_serial_driver xircom_pgs_fake_device = {
761 .owner = THIS_MODULE,
762 .name = "xircom_no_firm",
764 .description = "Xircom / Entrega PGS - (prerenumeration)",
765 .id_table = id_table_fake_xircom,
767 .attach = keyspan_pda_fake_startup,
771 static struct usb_serial_driver keyspan_pda_device = {
773 .owner = THIS_MODULE,
774 .name = "keyspan_pda",
776 .description = "Keyspan PDA",
777 .id_table = id_table_std,
780 .num_interrupt_in = 1,
781 .dtr_rts = keyspan_pda_dtr_rts,
782 .open = keyspan_pda_open,
783 .close = keyspan_pda_close,
784 .write = keyspan_pda_write,
785 .write_room = keyspan_pda_write_room,
786 .write_bulk_callback = keyspan_pda_write_bulk_callback,
787 .read_int_callback = keyspan_pda_rx_interrupt,
788 .chars_in_buffer = keyspan_pda_chars_in_buffer,
789 .throttle = keyspan_pda_rx_throttle,
790 .unthrottle = keyspan_pda_rx_unthrottle,
791 .set_termios = keyspan_pda_set_termios,
792 .break_ctl = keyspan_pda_break_ctl,
793 .tiocmget = keyspan_pda_tiocmget,
794 .tiocmset = keyspan_pda_tiocmset,
795 .port_probe = keyspan_pda_port_probe,
796 .port_remove = keyspan_pda_port_remove,
799 static struct usb_serial_driver * const serial_drivers[] = {
802 &keyspan_pda_fake_device,
805 &xircom_pgs_fake_device,
810 module_usb_serial_driver(serial_drivers, id_table_combined);
812 MODULE_AUTHOR(DRIVER_AUTHOR);
813 MODULE_DESCRIPTION(DRIVER_DESC);
814 MODULE_LICENSE("GPL");