1 // SPDX-License-Identifier: GPL-2.0+
3 * USB Keyspan PDA / Xircom / Entrega Converter driver
5 * Copyright (C) 1999 - 2001 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (C) 1999, 2000 Brian Warner <warner@lothar.com>
7 * Copyright (C) 2000 Al Borchers <borchers@steinerpoint.com>
9 * See Documentation/usb/usb-serial.txt 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>
28 /* make a simple define to handle if we are compiling keyspan_pda or xircom support */
29 #if IS_ENABLED(CONFIG_USB_SERIAL_KEYSPAN_PDA)
34 #if IS_ENABLED(CONFIG_USB_SERIAL_XIRCOM)
40 #define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
41 #define DRIVER_DESC "USB Keyspan PDA Converter driver"
43 struct keyspan_pda_private
{
46 struct work_struct wakeup_work
;
47 struct work_struct unthrottle_work
;
48 struct usb_serial
*serial
;
49 struct usb_serial_port
*port
;
53 #define KEYSPAN_VENDOR_ID 0x06cd
54 #define KEYSPAN_PDA_FAKE_ID 0x0103
55 #define KEYSPAN_PDA_ID 0x0104 /* no clue */
57 /* For Xircom PGSDB9 and older Entrega version of the same device */
58 #define XIRCOM_VENDOR_ID 0x085a
59 #define XIRCOM_FAKE_ID 0x8027
60 #define XIRCOM_FAKE_ID_2 0x8025 /* "PGMFHUB" serial */
61 #define ENTREGA_VENDOR_ID 0x1645
62 #define ENTREGA_FAKE_ID 0x8093
64 static const struct usb_device_id id_table_combined
[] = {
66 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_FAKE_ID
) },
69 { USB_DEVICE(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID
) },
70 { USB_DEVICE(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID_2
) },
71 { USB_DEVICE(ENTREGA_VENDOR_ID
, ENTREGA_FAKE_ID
) },
73 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_ID
) },
74 { } /* Terminating entry */
77 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
79 static const struct usb_device_id id_table_std
[] = {
80 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_ID
) },
81 { } /* Terminating entry */
85 static const struct usb_device_id id_table_fake
[] = {
86 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_FAKE_ID
) },
87 { } /* Terminating entry */
92 static const struct usb_device_id id_table_fake_xircom
[] = {
93 { USB_DEVICE(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID
) },
94 { USB_DEVICE(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID_2
) },
95 { USB_DEVICE(ENTREGA_VENDOR_ID
, ENTREGA_FAKE_ID
) },
100 static void keyspan_pda_wakeup_write(struct work_struct
*work
)
102 struct keyspan_pda_private
*priv
=
103 container_of(work
, struct keyspan_pda_private
, wakeup_work
);
104 struct usb_serial_port
*port
= priv
->port
;
106 tty_port_tty_wakeup(&port
->port
);
109 static void keyspan_pda_request_unthrottle(struct work_struct
*work
)
111 struct keyspan_pda_private
*priv
=
112 container_of(work
, struct keyspan_pda_private
, unthrottle_work
);
113 struct usb_serial
*serial
= priv
->serial
;
116 /* ask the device to tell us when the tx buffer becomes
117 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 16, /* value: threshold */
129 dev_dbg(&serial
->dev
->dev
, "%s - error %d from usb_control_msg\n",
134 static void keyspan_pda_rx_interrupt(struct urb
*urb
)
136 struct usb_serial_port
*port
= urb
->context
;
137 unsigned char *data
= urb
->transfer_buffer
;
138 unsigned int len
= urb
->actual_length
;
140 int status
= urb
->status
;
141 struct keyspan_pda_private
*priv
;
142 priv
= usb_get_serial_port_data(port
);
151 /* this urb is terminated, clean up */
152 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down with status: %d\n", __func__
, status
);
155 dev_dbg(&urb
->dev
->dev
, "%s - nonzero urb status received: %d\n", __func__
, status
);
160 dev_warn(&port
->dev
, "short message received\n");
164 /* see if the message is data or a status interrupt */
167 /* rest of message is rx data */
170 tty_insert_flip_string(&port
->port
, data
+ 1, len
- 1);
171 tty_flip_buffer_push(&port
->port
);
174 /* status interrupt */
176 dev_warn(&port
->dev
, "short interrupt message received\n");
179 dev_dbg(&port
->dev
, "rx int, d1=%d, d2=%d\n", data
[1], data
[2]);
181 case 1: /* modemline change */
183 case 2: /* tx unthrottle interrupt */
184 priv
->tx_throttled
= 0;
185 /* queue up a wakeup at scheduler time */
186 schedule_work(&priv
->wakeup_work
);
197 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
200 "%s - usb_submit_urb failed with result %d\n",
205 static void keyspan_pda_rx_throttle(struct tty_struct
*tty
)
207 /* stop receiving characters. We just turn off the URB request, and
208 let chars pile up in the device. If we're doing hardware
209 flowcontrol, the device will signal the other end when its buffer
210 fills up. If we're doing XON/XOFF, this would be a good time to
211 send an XOFF, although it might make sense to foist that off
212 upon the device too. */
213 struct usb_serial_port
*port
= tty
->driver_data
;
215 usb_kill_urb(port
->interrupt_in_urb
);
219 static void keyspan_pda_rx_unthrottle(struct tty_struct
*tty
)
221 struct usb_serial_port
*port
= tty
->driver_data
;
222 /* just restart the receive interrupt URB */
224 if (usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
))
225 dev_dbg(&port
->dev
, "usb_submit_urb(read urb) failed\n");
229 static speed_t
keyspan_pda_setbaud(struct usb_serial
*serial
, speed_t baud
)
266 bindex
= 5; /* Default to 9600 */
270 /* rather than figure out how to sleep while waiting for this
271 to complete, I just use the "legacy" API. */
272 rc
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
275 | USB_RECIP_INTERFACE
276 | USB_DIR_OUT
, /* type */
288 static void keyspan_pda_break_ctl(struct tty_struct
*tty
, int break_state
)
290 struct usb_serial_port
*port
= tty
->driver_data
;
291 struct usb_serial
*serial
= port
->serial
;
295 if (break_state
== -1)
296 value
= 1; /* start break */
298 value
= 0; /* clear break */
299 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
301 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
302 value
, 0, NULL
, 0, 2000);
304 dev_dbg(&port
->dev
, "%s - error %d from usb_control_msg\n",
306 /* there is something funky about this.. the TCSBRK that 'cu' performs
307 ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
308 seconds apart, but it feels like the break sent isn't as long as it
313 static void keyspan_pda_set_termios(struct tty_struct
*tty
,
314 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
316 struct usb_serial
*serial
= port
->serial
;
319 /* cflag specifies lots of stuff: number of stop bits, parity, number
320 of data bits, baud. What can the device actually handle?:
321 CSTOPB (1 stop bit or 2)
324 There is minimal hw support for parity (a PSW bit seems to hold the
325 parity of whatever is in the accumulator). The UART either deals
326 with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
327 1 special, stop). So, with firmware changes, we could do:
329 8N2: 11 bit, extra bit always (mark?)
330 8[EOMS]1: 11 bit, extra bit is parity
331 7[EOMS]1: 10 bit, b0/b7 is parity
332 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
334 HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
337 For now, just do baud. */
339 speed
= tty_get_baud_rate(tty
);
340 speed
= keyspan_pda_setbaud(serial
, speed
);
343 dev_dbg(&port
->dev
, "can't handle requested baud rate\n");
344 /* It hasn't changed so.. */
345 speed
= tty_termios_baud_rate(old_termios
);
347 /* Only speed can change so copy the old h/w parameters
348 then encode the new speed */
349 tty_termios_copy_hw(&tty
->termios
, old_termios
);
350 tty_encode_baud_rate(tty
, speed
, speed
);
354 /* modem control pins: DTR and RTS are outputs and can be controlled.
355 DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
356 read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
358 static int keyspan_pda_get_modem_info(struct usb_serial
*serial
,
359 unsigned char *value
)
364 data
= kmalloc(1, GFP_KERNEL
);
368 rc
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
370 USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
|USB_DIR_IN
,
371 0, 0, data
, 1, 2000);
380 static int keyspan_pda_set_modem_info(struct usb_serial
*serial
,
384 rc
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
386 USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
|USB_DIR_OUT
,
387 value
, 0, NULL
, 0, 2000);
391 static int keyspan_pda_tiocmget(struct tty_struct
*tty
)
393 struct usb_serial_port
*port
= tty
->driver_data
;
394 struct usb_serial
*serial
= port
->serial
;
396 unsigned char status
;
399 rc
= keyspan_pda_get_modem_info(serial
, &status
);
403 ((status
& (1<<7)) ? TIOCM_DTR
: 0) |
404 ((status
& (1<<6)) ? TIOCM_CAR
: 0) |
405 ((status
& (1<<5)) ? TIOCM_RNG
: 0) |
406 ((status
& (1<<4)) ? TIOCM_DSR
: 0) |
407 ((status
& (1<<3)) ? TIOCM_CTS
: 0) |
408 ((status
& (1<<2)) ? TIOCM_RTS
: 0);
412 static int keyspan_pda_tiocmset(struct tty_struct
*tty
,
413 unsigned int set
, unsigned int clear
)
415 struct usb_serial_port
*port
= tty
->driver_data
;
416 struct usb_serial
*serial
= port
->serial
;
418 unsigned char status
;
420 rc
= keyspan_pda_get_modem_info(serial
, &status
);
429 if (clear
& TIOCM_RTS
)
431 if (clear
& TIOCM_DTR
)
433 rc
= keyspan_pda_set_modem_info(serial
, status
);
437 static int keyspan_pda_write(struct tty_struct
*tty
,
438 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
440 struct usb_serial
*serial
= port
->serial
;
441 int request_unthrottle
= 0;
443 struct keyspan_pda_private
*priv
;
445 priv
= usb_get_serial_port_data(port
);
446 /* guess how much room is left in the device's ring buffer, and if we
447 want to send more than that, check first, updating our notion of
448 what is left. If our write will result in no room left, ask the
449 device to give us an interrupt when the room available rises above
450 a threshold, and hold off all writers (eventually, those using
451 select() or poll() too) until we receive that unthrottle interrupt.
452 Block if we can't write anything at all, otherwise write as much as
455 dev_dbg(&port
->dev
, "write request of 0 bytes\n");
459 /* we might block because of:
460 the TX urb is in-flight (wait until it completes)
461 the device is full (wait until it says there is room)
463 spin_lock_bh(&port
->lock
);
464 if (!test_bit(0, &port
->write_urbs_free
) || priv
->tx_throttled
) {
465 spin_unlock_bh(&port
->lock
);
468 clear_bit(0, &port
->write_urbs_free
);
469 spin_unlock_bh(&port
->lock
);
471 /* At this point the URB is in our control, nobody else can submit it
472 again (the only sudden transition was the one from EINPROGRESS to
473 finished). Also, the tx process is not throttled. So we are
476 count
= (count
> port
->bulk_out_size
) ? port
->bulk_out_size
: count
;
478 /* Check if we might overrun the Tx buffer. If so, ask the
479 device how much room it really has. This is done only on
480 scheduler time, since usb_control_msg() sleeps. */
481 if (count
> priv
->tx_room
&& !in_interrupt()) {
484 room
= kmalloc(1, GFP_KERNEL
);
490 rc
= usb_control_msg(serial
->dev
,
491 usb_rcvctrlpipe(serial
->dev
, 0),
493 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
495 0, /* value: 0 means "remaining room" */
501 dev_dbg(&port
->dev
, "roomquery says %d\n", *room
);
502 priv
->tx_room
= *room
;
506 dev_dbg(&port
->dev
, "roomquery failed\n");
510 dev_dbg(&port
->dev
, "roomquery returned 0 bytes\n");
511 rc
= -EIO
; /* device didn't return any data */
515 if (count
> priv
->tx_room
) {
516 /* we're about to completely fill the Tx buffer, so
517 we'll be throttled afterwards. */
518 count
= priv
->tx_room
;
519 request_unthrottle
= 1;
523 /* now transfer data */
524 memcpy(port
->write_urb
->transfer_buffer
, buf
, count
);
525 /* send the data out the bulk port */
526 port
->write_urb
->transfer_buffer_length
= count
;
528 priv
->tx_room
-= count
;
530 rc
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
532 dev_dbg(&port
->dev
, "usb_submit_urb(write bulk) failed\n");
536 /* There wasn't any room left, so we are throttled until
537 the buffer empties a bit */
538 request_unthrottle
= 1;
541 if (request_unthrottle
) {
542 priv
->tx_throttled
= 1; /* block writers */
543 schedule_work(&priv
->unthrottle_work
);
549 set_bit(0, &port
->write_urbs_free
);
554 static void keyspan_pda_write_bulk_callback(struct urb
*urb
)
556 struct usb_serial_port
*port
= urb
->context
;
557 struct keyspan_pda_private
*priv
;
559 set_bit(0, &port
->write_urbs_free
);
560 priv
= usb_get_serial_port_data(port
);
562 /* queue up a wakeup at scheduler time */
563 schedule_work(&priv
->wakeup_work
);
567 static int keyspan_pda_write_room(struct tty_struct
*tty
)
569 struct usb_serial_port
*port
= tty
->driver_data
;
570 struct keyspan_pda_private
*priv
;
571 priv
= usb_get_serial_port_data(port
);
572 /* used by n_tty.c for processing of tabs and such. Giving it our
573 conservative guess is probably good enough, but needs testing by
574 running a console through the device. */
575 return priv
->tx_room
;
579 static int keyspan_pda_chars_in_buffer(struct tty_struct
*tty
)
581 struct usb_serial_port
*port
= tty
->driver_data
;
582 struct keyspan_pda_private
*priv
;
586 priv
= usb_get_serial_port_data(port
);
588 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
589 n_tty.c:normal_poll() ) that we're not writeable. */
591 spin_lock_irqsave(&port
->lock
, flags
);
592 if (!test_bit(0, &port
->write_urbs_free
) || priv
->tx_throttled
)
594 spin_unlock_irqrestore(&port
->lock
, flags
);
599 static void keyspan_pda_dtr_rts(struct usb_serial_port
*port
, int on
)
601 struct usb_serial
*serial
= port
->serial
;
604 keyspan_pda_set_modem_info(serial
, (1 << 7) | (1 << 2));
606 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 usb_kill_urb(port
->write_urb
);
658 usb_kill_urb(port
->interrupt_in_urb
);
662 /* download the firmware to a "fake" device (pre-renumeration) */
663 static int keyspan_pda_fake_startup(struct usb_serial
*serial
)
668 /* download the firmware here ... */
669 response
= ezusb_fx1_set_reset(serial
->dev
, 1);
673 else if (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == KEYSPAN_VENDOR_ID
)
674 fw_name
= "keyspan_pda/keyspan_pda.fw";
677 else if ((le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == XIRCOM_VENDOR_ID
) ||
678 (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == ENTREGA_VENDOR_ID
))
679 fw_name
= "keyspan_pda/xircom_pgs.fw";
682 dev_err(&serial
->dev
->dev
, "%s: unknown vendor, aborting.\n",
687 if (ezusb_fx1_ihex_firmware_download(serial
->dev
, fw_name
) < 0) {
688 dev_err(&serial
->dev
->dev
, "failed to load firmware \"%s\"\n",
693 /* after downloading firmware Renumeration will occur in a
694 moment and the new device will bind to the real driver */
696 /* we want this device to fail to have a driver assigned to it. */
701 MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
704 MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
707 static int keyspan_pda_port_probe(struct usb_serial_port
*port
)
710 struct keyspan_pda_private
*priv
;
712 priv
= kmalloc(sizeof(struct keyspan_pda_private
), GFP_KERNEL
);
716 INIT_WORK(&priv
->wakeup_work
, keyspan_pda_wakeup_write
);
717 INIT_WORK(&priv
->unthrottle_work
, keyspan_pda_request_unthrottle
);
718 priv
->serial
= port
->serial
;
721 usb_set_serial_port_data(port
, priv
);
726 static int keyspan_pda_port_remove(struct usb_serial_port
*port
)
728 struct keyspan_pda_private
*priv
;
730 priv
= usb_get_serial_port_data(port
);
737 static struct usb_serial_driver keyspan_pda_fake_device
= {
739 .owner
= THIS_MODULE
,
740 .name
= "keyspan_pda_pre",
742 .description
= "Keyspan PDA - (prerenumeration)",
743 .id_table
= id_table_fake
,
745 .attach
= keyspan_pda_fake_startup
,
750 static struct usb_serial_driver xircom_pgs_fake_device
= {
752 .owner
= THIS_MODULE
,
753 .name
= "xircom_no_firm",
755 .description
= "Xircom / Entrega PGS - (prerenumeration)",
756 .id_table
= id_table_fake_xircom
,
758 .attach
= keyspan_pda_fake_startup
,
762 static struct usb_serial_driver keyspan_pda_device
= {
764 .owner
= THIS_MODULE
,
765 .name
= "keyspan_pda",
767 .description
= "Keyspan PDA",
768 .id_table
= id_table_std
,
771 .num_interrupt_in
= 1,
772 .dtr_rts
= keyspan_pda_dtr_rts
,
773 .open
= keyspan_pda_open
,
774 .close
= keyspan_pda_close
,
775 .write
= keyspan_pda_write
,
776 .write_room
= keyspan_pda_write_room
,
777 .write_bulk_callback
= keyspan_pda_write_bulk_callback
,
778 .read_int_callback
= keyspan_pda_rx_interrupt
,
779 .chars_in_buffer
= keyspan_pda_chars_in_buffer
,
780 .throttle
= keyspan_pda_rx_throttle
,
781 .unthrottle
= keyspan_pda_rx_unthrottle
,
782 .set_termios
= keyspan_pda_set_termios
,
783 .break_ctl
= keyspan_pda_break_ctl
,
784 .tiocmget
= keyspan_pda_tiocmget
,
785 .tiocmset
= keyspan_pda_tiocmset
,
786 .port_probe
= keyspan_pda_port_probe
,
787 .port_remove
= keyspan_pda_port_remove
,
790 static struct usb_serial_driver
* const serial_drivers
[] = {
793 &keyspan_pda_fake_device
,
796 &xircom_pgs_fake_device
,
801 module_usb_serial_driver(serial_drivers
, id_table_combined
);
803 MODULE_AUTHOR(DRIVER_AUTHOR
);
804 MODULE_DESCRIPTION(DRIVER_DESC
);
805 MODULE_LICENSE("GPL");