1 // SPDX-License-Identifier: GPL-2.0+
3 * USB Keyspan PDA / Xircom / Entrega Converter driver
10 * See Documentation/usb/usb-serial.rst for more information on using this
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/slab.h>
17 #include <linux/tty.h>
18 #include <linux/tty_driver.h>
19 #include <linux/tty_flip.h>
20 #include <linux/module.h>
21 #include <linux/spinlock.h>
22 #include <linux/workqueue.h>
23 #include <linux/uaccess.h>
24 #include <linux/usb.h>
25 #include <linux/usb/serial.h>
26 #include <linux/usb/ezusb.h>
29 #define DRIVER_DESC "USB Keyspan PDA Converter driver"
31 #define KEYSPAN_TX_THRESHOLD 128
33 struct keyspan_pda_private {
35 struct work_struct unthrottle_work;
36 struct usb_serial *serial;
37 struct usb_serial_port *port;
40 static int keyspan_pda_write_start(struct usb_serial_port *port);
42 #define KEYSPAN_VENDOR_ID 0x06cd
43 #define KEYSPAN_PDA_FAKE_ID 0x0103
44 #define KEYSPAN_PDA_ID 0x0104 /* no clue */
46 /* For Xircom PGSDB9 and older Entrega version of the same device */
47 #define XIRCOM_VENDOR_ID 0x085a
48 #define XIRCOM_FAKE_ID 0x8027
49 #define XIRCOM_FAKE_ID_2 0x8025 /* "PGMFHUB" serial */
50 #define ENTREGA_VENDOR_ID 0x1645
51 #define ENTREGA_FAKE_ID 0x8093
53 static const struct usb_device_id id_table_combined[] = {
54 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
55 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
56 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
57 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
58 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
59 { } /* Terminating entry */
61 MODULE_DEVICE_TABLE(usb, id_table_combined);
63 static const struct usb_device_id id_table_std[] = {
64 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
65 { } /* Terminating entry */
68 static const struct usb_device_id id_table_fake[] = {
69 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
70 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
71 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
72 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
73 { } /* Terminating entry */
76 static int keyspan_pda_get_write_room(struct keyspan_pda_private *priv)
78 struct usb_serial_port *port = priv->port;
79 struct usb_serial *serial = port->serial;
83 rc = usb_control_msg_recv(serial->dev,
86 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_IN,
87 0, /* value: 0 means "remaining room" */
94 dev_dbg(&port->dev, "roomquery failed: %d\n", rc);
98 dev_dbg(&port->dev, "roomquery says %d\n", room);
103 static void keyspan_pda_request_unthrottle(struct work_struct *work)
105 struct keyspan_pda_private *priv =
106 container_of(work, struct keyspan_pda_private, unthrottle_work);
107 struct usb_serial_port *port = priv->port;
108 struct usb_serial *serial = port->serial;
112 dev_dbg(&port->dev, "%s\n", __func__);
115 * Ask the device to tell us when the tx buffer becomes
116 * sufficiently empty.
118 result = usb_control_msg(serial->dev,
119 usb_sndctrlpipe(serial->dev, 0),
120 7, /* request_unthrottle */
121 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
123 KEYSPAN_TX_THRESHOLD,
129 dev_dbg(&serial->dev->dev, "%s - error %d from usb_control_msg\n",
132 * Need to check available space after requesting notification in case
133 * buffer is already empty so that no notification is sent.
135 result = keyspan_pda_get_write_room(priv);
136 if (result > KEYSPAN_TX_THRESHOLD) {
137 spin_lock_irqsave(&port->lock, flags);
138 priv->tx_room = max(priv->tx_room, result);
139 spin_unlock_irqrestore(&port->lock, flags);
141 usb_serial_port_softint(port);
145 static void keyspan_pda_rx_interrupt(struct urb *urb)
147 struct usb_serial_port *port = urb->context;
148 unsigned char *data = urb->transfer_buffer;
149 unsigned int len = urb->actual_length;
151 int status = urb->status;
152 struct keyspan_pda_private *priv;
155 priv = usb_get_serial_port_data(port);
164 /* this urb is terminated, clean up */
165 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
168 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
173 dev_warn(&port->dev, "short message received\n");
177 /* see if the message is data or a status interrupt */
180 /* rest of message is rx data */
183 tty_insert_flip_string(&port->port, data + 1, len - 1);
184 tty_flip_buffer_push(&port->port);
187 /* status interrupt */
189 dev_warn(&port->dev, "short interrupt message received\n");
192 dev_dbg(&port->dev, "rx int, d1=%d\n", data[1]);
194 case 1: /* modemline change */
196 case 2: /* tx unthrottle interrupt */
197 spin_lock_irqsave(&port->lock, flags);
198 priv->tx_room = max(priv->tx_room, KEYSPAN_TX_THRESHOLD);
199 spin_unlock_irqrestore(&port->lock, flags);
201 keyspan_pda_write_start(port);
203 usb_serial_port_softint(port);
214 retval = usb_submit_urb(urb, GFP_ATOMIC);
217 "%s - usb_submit_urb failed with result %d\n",
221 static void keyspan_pda_rx_throttle(struct tty_struct *tty)
223 struct usb_serial_port *port = tty->driver_data;
226 * Stop receiving characters. We just turn off the URB request, and
227 * let chars pile up in the device. If we're doing hardware
228 * flowcontrol, the device will signal the other end when its buffer
229 * fills up. If we're doing XON/XOFF, this would be a good time to
230 * send an XOFF, although it might make sense to foist that off upon
233 usb_kill_urb(port->interrupt_in_urb);
236 static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
238 struct usb_serial_port *port = tty->driver_data;
240 /* just restart the receive interrupt URB */
241 if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
242 dev_dbg(&port->dev, "usb_submit_urb(read urb) failed\n");
245 static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
282 bindex = 5; /* Default to 9600 */
286 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
289 | USB_RECIP_INTERFACE
290 | USB_DIR_OUT, /* type */
302 static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
304 struct usb_serial_port *port = tty->driver_data;
305 struct usb_serial *serial = port->serial;
309 if (break_state == -1)
310 value = 1; /* start break */
312 value = 0; /* clear break */
314 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
316 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
317 value, 0, NULL, 0, 2000);
319 dev_dbg(&port->dev, "%s - error %d from usb_control_msg\n",
323 static void keyspan_pda_set_termios(struct tty_struct *tty,
324 struct usb_serial_port *port,
325 const struct ktermios *old_termios)
327 struct usb_serial *serial = port->serial;
331 * cflag specifies lots of stuff: number of stop bits, parity, number
332 * of data bits, baud. What can the device actually handle?:
333 * CSTOPB (1 stop bit or 2)
335 * CSIZE (5bit .. 8bit)
336 * There is minimal hw support for parity (a PSW bit seems to hold the
337 * parity of whatever is in the accumulator). The UART either deals
338 * with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
339 * 1 special, stop). So, with firmware changes, we could do:
341 * 8N2: 11 bit, extra bit always (mark?)
342 * 8[EOMS]1: 11 bit, extra bit is parity
343 * 7[EOMS]1: 10 bit, b0/b7 is parity
344 * 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
346 * HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
349 * For now, just do baud.
351 speed = tty_get_baud_rate(tty);
352 speed = keyspan_pda_setbaud(serial, speed);
355 dev_dbg(&port->dev, "can't handle requested baud rate\n");
356 /* It hasn't changed so.. */
357 speed = tty_termios_baud_rate(old_termios);
360 * Only speed can change so copy the old h/w parameters then encode
363 tty_termios_copy_hw(&tty->termios, old_termios);
364 tty_encode_baud_rate(tty, speed, speed);
368 * Modem control pins: DTR and RTS are outputs and can be controlled.
369 * DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
370 * read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused.
372 static int keyspan_pda_get_modem_info(struct usb_serial *serial,
373 unsigned char *value)
378 rc = usb_control_msg_recv(serial->dev, 0,
380 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_IN,
393 static int keyspan_pda_set_modem_info(struct usb_serial *serial,
397 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
399 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
400 value, 0, NULL, 0, 2000);
404 static int keyspan_pda_tiocmget(struct tty_struct *tty)
406 struct usb_serial_port *port = tty->driver_data;
407 struct usb_serial *serial = port->serial;
409 unsigned char status;
412 rc = keyspan_pda_get_modem_info(serial, &status);
416 value = ((status & BIT(7)) ? TIOCM_DTR : 0) |
417 ((status & BIT(6)) ? TIOCM_CAR : 0) |
418 ((status & BIT(5)) ? TIOCM_RNG : 0) |
419 ((status & BIT(4)) ? TIOCM_DSR : 0) |
420 ((status & BIT(3)) ? TIOCM_CTS : 0) |
421 ((status & BIT(2)) ? TIOCM_RTS : 0);
426 static int keyspan_pda_tiocmset(struct tty_struct *tty,
427 unsigned int set, unsigned int clear)
429 struct usb_serial_port *port = tty->driver_data;
430 struct usb_serial *serial = port->serial;
432 unsigned char status;
434 rc = keyspan_pda_get_modem_info(serial, &status);
443 if (clear & TIOCM_RTS)
445 if (clear & TIOCM_DTR)
447 rc = keyspan_pda_set_modem_info(serial, status);
451 static int keyspan_pda_write_start(struct usb_serial_port *port)
453 struct keyspan_pda_private *priv = usb_get_serial_port_data(port);
461 * Guess how much room is left in the device's ring buffer. If our
462 * write will result in no room left, ask the device to give us an
463 * interrupt when the room available rises above a threshold but also
464 * query how much room is currently available (in case our guess was
465 * too conservative and the buffer is already empty when the
466 * unthrottle work is scheduled).
470 * We might block because of:
471 * the TX urb is in-flight (wait until it completes)
472 * the device is full (wait until it says there is room)
474 spin_lock_irqsave(&port->lock, flags);
476 room = priv->tx_room;
477 count = kfifo_len(&port->write_fifo);
479 if (!test_bit(0, &port->write_urbs_free) || count == 0 || room == 0) {
480 spin_unlock_irqrestore(&port->lock, flags);
483 __clear_bit(0, &port->write_urbs_free);
487 if (count > port->bulk_out_size)
488 count = port->bulk_out_size;
490 urb = port->write_urb;
491 count = kfifo_out(&port->write_fifo, urb->transfer_buffer, count);
492 urb->transfer_buffer_length = count;
494 port->tx_bytes += count;
495 priv->tx_room -= count;
497 spin_unlock_irqrestore(&port->lock, flags);
499 dev_dbg(&port->dev, "%s - count = %d, txroom = %d\n", __func__, count, room);
501 rc = usb_submit_urb(urb, GFP_ATOMIC);
503 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed\n");
505 spin_lock_irqsave(&port->lock, flags);
506 port->tx_bytes -= count;
507 priv->tx_room = max(priv->tx_room, room + count);
508 __set_bit(0, &port->write_urbs_free);
509 spin_unlock_irqrestore(&port->lock, flags);
515 schedule_work(&priv->unthrottle_work);
520 static void keyspan_pda_write_bulk_callback(struct urb *urb)
522 struct usb_serial_port *port = urb->context;
525 spin_lock_irqsave(&port->lock, flags);
526 port->tx_bytes -= urb->transfer_buffer_length;
527 __set_bit(0, &port->write_urbs_free);
528 spin_unlock_irqrestore(&port->lock, flags);
530 keyspan_pda_write_start(port);
532 usb_serial_port_softint(port);
535 static int keyspan_pda_write(struct tty_struct *tty, struct usb_serial_port *port,
536 const unsigned char *buf, int count)
540 dev_dbg(&port->dev, "%s - count = %d\n", __func__, count);
545 count = kfifo_in_locked(&port->write_fifo, buf, count, &port->lock);
547 rc = keyspan_pda_write_start(port);
554 static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
556 struct usb_serial *serial = port->serial;
559 keyspan_pda_set_modem_info(serial, BIT(7) | BIT(2));
561 keyspan_pda_set_modem_info(serial, 0);
565 static int keyspan_pda_open(struct tty_struct *tty,
566 struct usb_serial_port *port)
568 struct keyspan_pda_private *priv = usb_get_serial_port_data(port);
571 /* find out how much room is in the Tx ring */
572 rc = keyspan_pda_get_write_room(priv);
576 spin_lock_irq(&port->lock);
578 spin_unlock_irq(&port->lock);
580 rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
582 dev_dbg(&port->dev, "%s - usb_submit_urb(read int) failed\n", __func__);
589 static void keyspan_pda_close(struct usb_serial_port *port)
591 struct keyspan_pda_private *priv = usb_get_serial_port_data(port);
594 * Stop the interrupt URB first as its completion handler may submit
597 usb_kill_urb(port->interrupt_in_urb);
598 usb_kill_urb(port->write_urb);
600 cancel_work_sync(&priv->unthrottle_work);
602 spin_lock_irq(&port->lock);
603 kfifo_reset(&port->write_fifo);
604 spin_unlock_irq(&port->lock);
607 /* download the firmware to a "fake" device (pre-renumeration) */
608 static int keyspan_pda_fake_startup(struct usb_serial *serial)
610 unsigned int vid = le16_to_cpu(serial->dev->descriptor.idVendor);
613 /* download the firmware here ... */
614 ezusb_fx1_set_reset(serial->dev, 1);
617 case KEYSPAN_VENDOR_ID:
618 fw_name = "keyspan_pda/keyspan_pda.fw";
620 case XIRCOM_VENDOR_ID:
621 case ENTREGA_VENDOR_ID:
622 fw_name = "keyspan_pda/xircom_pgs.fw";
625 dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
630 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
631 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
637 * After downloading firmware renumeration will occur in a moment and
638 * the new device will bind to the real driver.
641 /* We want this device to fail to have a driver assigned to it. */
645 MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
646 MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
648 static int keyspan_pda_port_probe(struct usb_serial_port *port)
651 struct keyspan_pda_private *priv;
653 priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
657 INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
660 usb_set_serial_port_data(port, priv);
665 static void keyspan_pda_port_remove(struct usb_serial_port *port)
667 struct keyspan_pda_private *priv;
669 priv = usb_get_serial_port_data(port);
673 static struct usb_serial_driver keyspan_pda_fake_device = {
675 .owner = THIS_MODULE,
676 .name = "keyspan_pda_pre",
678 .description = "Keyspan PDA - (prerenumeration)",
679 .id_table = id_table_fake,
681 .attach = keyspan_pda_fake_startup,
684 static struct usb_serial_driver keyspan_pda_device = {
686 .owner = THIS_MODULE,
687 .name = "keyspan_pda",
689 .description = "Keyspan PDA",
690 .id_table = id_table_std,
693 .num_interrupt_in = 1,
694 .dtr_rts = keyspan_pda_dtr_rts,
695 .open = keyspan_pda_open,
696 .close = keyspan_pda_close,
697 .write = keyspan_pda_write,
698 .write_bulk_callback = keyspan_pda_write_bulk_callback,
699 .read_int_callback = keyspan_pda_rx_interrupt,
700 .throttle = keyspan_pda_rx_throttle,
701 .unthrottle = keyspan_pda_rx_unthrottle,
702 .set_termios = keyspan_pda_set_termios,
703 .break_ctl = keyspan_pda_break_ctl,
704 .tiocmget = keyspan_pda_tiocmget,
705 .tiocmset = keyspan_pda_tiocmset,
706 .port_probe = keyspan_pda_port_probe,
707 .port_remove = keyspan_pda_port_remove,
710 static struct usb_serial_driver * const serial_drivers[] = {
712 &keyspan_pda_fake_device,
716 module_usb_serial_driver(serial_drivers, id_table_combined);
718 MODULE_AUTHOR(DRIVER_AUTHOR);
719 MODULE_DESCRIPTION(DRIVER_DESC);
720 MODULE_LICENSE("GPL");