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);
382 static int keyspan_pda_set_modem_info(struct usb_serial
*serial
,
386 rc
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
388 USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
|USB_DIR_OUT
,
389 value
, 0, NULL
, 0, 2000);
393 static int keyspan_pda_tiocmget(struct tty_struct
*tty
)
395 struct usb_serial_port
*port
= tty
->driver_data
;
396 struct usb_serial
*serial
= port
->serial
;
398 unsigned char status
;
401 rc
= keyspan_pda_get_modem_info(serial
, &status
);
405 ((status
& (1<<7)) ? TIOCM_DTR
: 0) |
406 ((status
& (1<<6)) ? TIOCM_CAR
: 0) |
407 ((status
& (1<<5)) ? TIOCM_RNG
: 0) |
408 ((status
& (1<<4)) ? TIOCM_DSR
: 0) |
409 ((status
& (1<<3)) ? TIOCM_CTS
: 0) |
410 ((status
& (1<<2)) ? TIOCM_RTS
: 0);
414 static int keyspan_pda_tiocmset(struct tty_struct
*tty
,
415 unsigned int set
, unsigned int clear
)
417 struct usb_serial_port
*port
= tty
->driver_data
;
418 struct usb_serial
*serial
= port
->serial
;
420 unsigned char status
;
422 rc
= keyspan_pda_get_modem_info(serial
, &status
);
431 if (clear
& TIOCM_RTS
)
433 if (clear
& TIOCM_DTR
)
435 rc
= keyspan_pda_set_modem_info(serial
, status
);
439 static int keyspan_pda_write(struct tty_struct
*tty
,
440 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
442 struct usb_serial
*serial
= port
->serial
;
443 int request_unthrottle
= 0;
445 struct keyspan_pda_private
*priv
;
447 priv
= usb_get_serial_port_data(port
);
448 /* guess how much room is left in the device's ring buffer, and if we
449 want to send more than that, check first, updating our notion of
450 what is left. If our write will result in no room left, ask the
451 device to give us an interrupt when the room available rises above
452 a threshold, and hold off all writers (eventually, those using
453 select() or poll() too) until we receive that unthrottle interrupt.
454 Block if we can't write anything at all, otherwise write as much as
457 dev_dbg(&port
->dev
, "write request of 0 bytes\n");
461 /* we might block because of:
462 the TX urb is in-flight (wait until it completes)
463 the device is full (wait until it says there is room)
465 spin_lock_bh(&port
->lock
);
466 if (!test_bit(0, &port
->write_urbs_free
) || priv
->tx_throttled
) {
467 spin_unlock_bh(&port
->lock
);
470 clear_bit(0, &port
->write_urbs_free
);
471 spin_unlock_bh(&port
->lock
);
473 /* At this point the URB is in our control, nobody else can submit it
474 again (the only sudden transition was the one from EINPROGRESS to
475 finished). Also, the tx process is not throttled. So we are
478 count
= (count
> port
->bulk_out_size
) ? port
->bulk_out_size
: count
;
480 /* Check if we might overrun the Tx buffer. If so, ask the
481 device how much room it really has. This is done only on
482 scheduler time, since usb_control_msg() sleeps. */
483 if (count
> priv
->tx_room
&& !in_interrupt()) {
486 room
= kmalloc(1, GFP_KERNEL
);
492 rc
= usb_control_msg(serial
->dev
,
493 usb_rcvctrlpipe(serial
->dev
, 0),
495 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
497 0, /* value: 0 means "remaining room" */
503 dev_dbg(&port
->dev
, "roomquery says %d\n", *room
);
504 priv
->tx_room
= *room
;
508 dev_dbg(&port
->dev
, "roomquery failed\n");
512 dev_dbg(&port
->dev
, "roomquery returned 0 bytes\n");
513 rc
= -EIO
; /* device didn't return any data */
517 if (count
> priv
->tx_room
) {
518 /* we're about to completely fill the Tx buffer, so
519 we'll be throttled afterwards. */
520 count
= priv
->tx_room
;
521 request_unthrottle
= 1;
525 /* now transfer data */
526 memcpy(port
->write_urb
->transfer_buffer
, buf
, count
);
527 /* send the data out the bulk port */
528 port
->write_urb
->transfer_buffer_length
= count
;
530 priv
->tx_room
-= count
;
532 rc
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
534 dev_dbg(&port
->dev
, "usb_submit_urb(write bulk) failed\n");
538 /* There wasn't any room left, so we are throttled until
539 the buffer empties a bit */
540 request_unthrottle
= 1;
543 if (request_unthrottle
) {
544 priv
->tx_throttled
= 1; /* block writers */
545 schedule_work(&priv
->unthrottle_work
);
551 set_bit(0, &port
->write_urbs_free
);
556 static void keyspan_pda_write_bulk_callback(struct urb
*urb
)
558 struct usb_serial_port
*port
= urb
->context
;
559 struct keyspan_pda_private
*priv
;
561 set_bit(0, &port
->write_urbs_free
);
562 priv
= usb_get_serial_port_data(port
);
564 /* queue up a wakeup at scheduler time */
565 schedule_work(&priv
->wakeup_work
);
569 static int keyspan_pda_write_room(struct tty_struct
*tty
)
571 struct usb_serial_port
*port
= tty
->driver_data
;
572 struct keyspan_pda_private
*priv
;
573 priv
= usb_get_serial_port_data(port
);
574 /* used by n_tty.c for processing of tabs and such. Giving it our
575 conservative guess is probably good enough, but needs testing by
576 running a console through the device. */
577 return priv
->tx_room
;
581 static int keyspan_pda_chars_in_buffer(struct tty_struct
*tty
)
583 struct usb_serial_port
*port
= tty
->driver_data
;
584 struct keyspan_pda_private
*priv
;
588 priv
= usb_get_serial_port_data(port
);
590 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
591 n_tty.c:normal_poll() ) that we're not writeable. */
593 spin_lock_irqsave(&port
->lock
, flags
);
594 if (!test_bit(0, &port
->write_urbs_free
) || priv
->tx_throttled
)
596 spin_unlock_irqrestore(&port
->lock
, flags
);
601 static void keyspan_pda_dtr_rts(struct usb_serial_port
*port
, int on
)
603 struct usb_serial
*serial
= port
->serial
;
606 keyspan_pda_set_modem_info(serial
, (1 << 7) | (1 << 2));
608 keyspan_pda_set_modem_info(serial
, 0);
612 static int keyspan_pda_open(struct tty_struct
*tty
,
613 struct usb_serial_port
*port
)
615 struct usb_serial
*serial
= port
->serial
;
618 struct keyspan_pda_private
*priv
;
620 /* find out how much room is in the Tx ring */
621 room
= kmalloc(1, GFP_KERNEL
);
625 rc
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
627 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
635 dev_dbg(&port
->dev
, "%s - roomquery failed\n", __func__
);
639 dev_dbg(&port
->dev
, "%s - roomquery returned 0 bytes\n", __func__
);
643 priv
= usb_get_serial_port_data(port
);
644 priv
->tx_room
= *room
;
645 priv
->tx_throttled
= *room
? 0 : 1;
647 /*Start reading from the device*/
648 rc
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
650 dev_dbg(&port
->dev
, "%s - usb_submit_urb(read int) failed\n", __func__
);
657 static void keyspan_pda_close(struct usb_serial_port
*port
)
659 usb_kill_urb(port
->write_urb
);
660 usb_kill_urb(port
->interrupt_in_urb
);
664 /* download the firmware to a "fake" device (pre-renumeration) */
665 static int keyspan_pda_fake_startup(struct usb_serial
*serial
)
670 /* download the firmware here ... */
671 response
= ezusb_fx1_set_reset(serial
->dev
, 1);
675 else if (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == KEYSPAN_VENDOR_ID
)
676 fw_name
= "keyspan_pda/keyspan_pda.fw";
679 else if ((le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == XIRCOM_VENDOR_ID
) ||
680 (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == ENTREGA_VENDOR_ID
))
681 fw_name
= "keyspan_pda/xircom_pgs.fw";
684 dev_err(&serial
->dev
->dev
, "%s: unknown vendor, aborting.\n",
689 if (ezusb_fx1_ihex_firmware_download(serial
->dev
, fw_name
) < 0) {
690 dev_err(&serial
->dev
->dev
, "failed to load firmware \"%s\"\n",
695 /* after downloading firmware Renumeration will occur in a
696 moment and the new device will bind to the real driver */
698 /* we want this device to fail to have a driver assigned to it. */
703 MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
706 MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
709 static int keyspan_pda_port_probe(struct usb_serial_port
*port
)
712 struct keyspan_pda_private
*priv
;
714 priv
= kmalloc(sizeof(struct keyspan_pda_private
), GFP_KERNEL
);
718 INIT_WORK(&priv
->wakeup_work
, keyspan_pda_wakeup_write
);
719 INIT_WORK(&priv
->unthrottle_work
, keyspan_pda_request_unthrottle
);
720 priv
->serial
= port
->serial
;
723 usb_set_serial_port_data(port
, priv
);
728 static int keyspan_pda_port_remove(struct usb_serial_port
*port
)
730 struct keyspan_pda_private
*priv
;
732 priv
= usb_get_serial_port_data(port
);
739 static struct usb_serial_driver keyspan_pda_fake_device
= {
741 .owner
= THIS_MODULE
,
742 .name
= "keyspan_pda_pre",
744 .description
= "Keyspan PDA - (prerenumeration)",
745 .id_table
= id_table_fake
,
747 .attach
= keyspan_pda_fake_startup
,
752 static struct usb_serial_driver xircom_pgs_fake_device
= {
754 .owner
= THIS_MODULE
,
755 .name
= "xircom_no_firm",
757 .description
= "Xircom / Entrega PGS - (prerenumeration)",
758 .id_table
= id_table_fake_xircom
,
760 .attach
= keyspan_pda_fake_startup
,
764 static struct usb_serial_driver keyspan_pda_device
= {
766 .owner
= THIS_MODULE
,
767 .name
= "keyspan_pda",
769 .description
= "Keyspan PDA",
770 .id_table
= id_table_std
,
773 .num_interrupt_in
= 1,
774 .dtr_rts
= keyspan_pda_dtr_rts
,
775 .open
= keyspan_pda_open
,
776 .close
= keyspan_pda_close
,
777 .write
= keyspan_pda_write
,
778 .write_room
= keyspan_pda_write_room
,
779 .write_bulk_callback
= keyspan_pda_write_bulk_callback
,
780 .read_int_callback
= keyspan_pda_rx_interrupt
,
781 .chars_in_buffer
= keyspan_pda_chars_in_buffer
,
782 .throttle
= keyspan_pda_rx_throttle
,
783 .unthrottle
= keyspan_pda_rx_unthrottle
,
784 .set_termios
= keyspan_pda_set_termios
,
785 .break_ctl
= keyspan_pda_break_ctl
,
786 .tiocmget
= keyspan_pda_tiocmget
,
787 .tiocmset
= keyspan_pda_tiocmset
,
788 .port_probe
= keyspan_pda_port_probe
,
789 .port_remove
= keyspan_pda_port_remove
,
792 static struct usb_serial_driver
* const serial_drivers
[] = {
795 &keyspan_pda_fake_device
,
798 &xircom_pgs_fake_device
,
803 module_usb_serial_driver(serial_drivers
, id_table_combined
);
805 MODULE_AUTHOR(DRIVER_AUTHOR
);
806 MODULE_DESCRIPTION(DRIVER_DESC
);
807 MODULE_LICENSE("GPL");