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 struct keyspan_pda_private
{
50 struct work_struct wakeup_work
;
51 struct work_struct unthrottle_work
;
52 struct usb_serial
*serial
;
53 struct usb_serial_port
*port
;
57 #define KEYSPAN_VENDOR_ID 0x06cd
58 #define KEYSPAN_PDA_FAKE_ID 0x0103
59 #define KEYSPAN_PDA_ID 0x0104 /* no clue */
61 /* For Xircom PGSDB9 and older Entrega version of the same device */
62 #define XIRCOM_VENDOR_ID 0x085a
63 #define XIRCOM_FAKE_ID 0x8027
64 #define XIRCOM_FAKE_ID_2 0x8025 /* "PGMFHUB" serial */
65 #define ENTREGA_VENDOR_ID 0x1645
66 #define ENTREGA_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(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID_2
) },
75 { USB_DEVICE(ENTREGA_VENDOR_ID
, ENTREGA_FAKE_ID
) },
77 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_ID
) },
78 { } /* Terminating entry */
81 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
83 static const struct usb_device_id id_table_std
[] = {
84 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_ID
) },
85 { } /* Terminating entry */
89 static const struct usb_device_id id_table_fake
[] = {
90 { USB_DEVICE(KEYSPAN_VENDOR_ID
, KEYSPAN_PDA_FAKE_ID
) },
91 { } /* Terminating entry */
96 static const struct usb_device_id id_table_fake_xircom
[] = {
97 { USB_DEVICE(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID
) },
98 { USB_DEVICE(XIRCOM_VENDOR_ID
, XIRCOM_FAKE_ID_2
) },
99 { USB_DEVICE(ENTREGA_VENDOR_ID
, ENTREGA_FAKE_ID
) },
104 static void keyspan_pda_wakeup_write(struct work_struct
*work
)
106 struct keyspan_pda_private
*priv
=
107 container_of(work
, struct keyspan_pda_private
, wakeup_work
);
108 struct usb_serial_port
*port
= priv
->port
;
110 tty_port_tty_wakeup(&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 unsigned char *data
= urb
->transfer_buffer
;
142 unsigned int len
= urb
->actual_length
;
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
);
164 dev_warn(&port
->dev
, "short message received\n");
168 /* see if the message is data or a status interrupt */
171 /* rest of message is rx data */
174 tty_insert_flip_string(&port
->port
, data
+ 1, len
- 1);
175 tty_flip_buffer_push(&port
->port
);
178 /* status interrupt */
180 dev_warn(&port
->dev
, "short interrupt message received\n");
183 dev_dbg(&port
->dev
, "rx int, d1=%d, d2=%d\n", data
[1], data
[2]);
185 case 1: /* modemline change */
187 case 2: /* tx unthrottle interrupt */
188 priv
->tx_throttled
= 0;
189 /* queue up a wakeup at scheduler time */
190 schedule_work(&priv
->wakeup_work
);
201 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
204 "%s - usb_submit_urb failed with result %d\n",
209 static void keyspan_pda_rx_throttle(struct tty_struct
*tty
)
211 /* stop receiving characters. We just turn off the URB request, and
212 let chars pile up in the device. If we're doing hardware
213 flowcontrol, the device will signal the other end when its buffer
214 fills up. If we're doing XON/XOFF, this would be a good time to
215 send an XOFF, although it might make sense to foist that off
216 upon the device too. */
217 struct usb_serial_port
*port
= tty
->driver_data
;
219 usb_kill_urb(port
->interrupt_in_urb
);
223 static void keyspan_pda_rx_unthrottle(struct tty_struct
*tty
)
225 struct usb_serial_port
*port
= tty
->driver_data
;
226 /* just restart the receive interrupt URB */
228 if (usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
))
229 dev_dbg(&port
->dev
, "usb_submit_urb(read urb) failed\n");
233 static speed_t
keyspan_pda_setbaud(struct usb_serial
*serial
, speed_t baud
)
270 bindex
= 5; /* Default to 9600 */
274 /* rather than figure out how to sleep while waiting for this
275 to complete, I just use the "legacy" API. */
276 rc
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
279 | USB_RECIP_INTERFACE
280 | USB_DIR_OUT
, /* type */
292 static void keyspan_pda_break_ctl(struct tty_struct
*tty
, int break_state
)
294 struct usb_serial_port
*port
= tty
->driver_data
;
295 struct usb_serial
*serial
= port
->serial
;
299 if (break_state
== -1)
300 value
= 1; /* start break */
302 value
= 0; /* clear break */
303 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
305 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
306 value
, 0, NULL
, 0, 2000);
308 dev_dbg(&port
->dev
, "%s - error %d from usb_control_msg\n",
310 /* there is something funky about this.. the TCSBRK that 'cu' performs
311 ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
312 seconds apart, but it feels like the break sent isn't as long as it
317 static void keyspan_pda_set_termios(struct tty_struct
*tty
,
318 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
320 struct usb_serial
*serial
= port
->serial
;
323 /* cflag specifies lots of stuff: number of stop bits, parity, number
324 of data bits, baud. What can the device actually handle?:
325 CSTOPB (1 stop bit or 2)
328 There is minimal hw support for parity (a PSW bit seems to hold the
329 parity of whatever is in the accumulator). The UART either deals
330 with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
331 1 special, stop). So, with firmware changes, we could do:
333 8N2: 11 bit, extra bit always (mark?)
334 8[EOMS]1: 11 bit, extra bit is parity
335 7[EOMS]1: 10 bit, b0/b7 is parity
336 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
338 HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
341 For now, just do baud. */
343 speed
= tty_get_baud_rate(tty
);
344 speed
= keyspan_pda_setbaud(serial
, speed
);
347 dev_dbg(&port
->dev
, "can't handle requested baud rate\n");
348 /* It hasn't changed so.. */
349 speed
= tty_termios_baud_rate(old_termios
);
351 /* Only speed can change so copy the old h/w parameters
352 then encode the new speed */
353 tty_termios_copy_hw(&tty
->termios
, old_termios
);
354 tty_encode_baud_rate(tty
, speed
, speed
);
358 /* modem control pins: DTR and RTS are outputs and can be controlled.
359 DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
360 read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
362 static int keyspan_pda_get_modem_info(struct usb_serial
*serial
,
363 unsigned char *value
)
368 data
= kmalloc(1, GFP_KERNEL
);
372 rc
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
374 USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
|USB_DIR_IN
,
375 0, 0, data
, 1, 2000);
384 static int keyspan_pda_set_modem_info(struct usb_serial
*serial
,
388 rc
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
390 USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
|USB_DIR_OUT
,
391 value
, 0, NULL
, 0, 2000);
395 static int keyspan_pda_tiocmget(struct tty_struct
*tty
)
397 struct usb_serial_port
*port
= tty
->driver_data
;
398 struct usb_serial
*serial
= port
->serial
;
400 unsigned char status
;
403 rc
= keyspan_pda_get_modem_info(serial
, &status
);
407 ((status
& (1<<7)) ? TIOCM_DTR
: 0) |
408 ((status
& (1<<6)) ? TIOCM_CAR
: 0) |
409 ((status
& (1<<5)) ? TIOCM_RNG
: 0) |
410 ((status
& (1<<4)) ? TIOCM_DSR
: 0) |
411 ((status
& (1<<3)) ? TIOCM_CTS
: 0) |
412 ((status
& (1<<2)) ? TIOCM_RTS
: 0);
416 static int keyspan_pda_tiocmset(struct tty_struct
*tty
,
417 unsigned int set
, unsigned int clear
)
419 struct usb_serial_port
*port
= tty
->driver_data
;
420 struct usb_serial
*serial
= port
->serial
;
422 unsigned char status
;
424 rc
= keyspan_pda_get_modem_info(serial
, &status
);
433 if (clear
& TIOCM_RTS
)
435 if (clear
& TIOCM_DTR
)
437 rc
= keyspan_pda_set_modem_info(serial
, status
);
441 static int keyspan_pda_write(struct tty_struct
*tty
,
442 struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
444 struct usb_serial
*serial
= port
->serial
;
445 int request_unthrottle
= 0;
447 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_bh(&port
->lock
);
468 if (!test_bit(0, &port
->write_urbs_free
) || priv
->tx_throttled
) {
469 spin_unlock_bh(&port
->lock
);
472 clear_bit(0, &port
->write_urbs_free
);
473 spin_unlock_bh(&port
->lock
);
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 */
519 if (count
> priv
->tx_room
) {
520 /* we're about to completely fill the Tx buffer, so
521 we'll be throttled afterwards. */
522 count
= priv
->tx_room
;
523 request_unthrottle
= 1;
527 /* now transfer data */
528 memcpy(port
->write_urb
->transfer_buffer
, buf
, count
);
529 /* send the data out the bulk port */
530 port
->write_urb
->transfer_buffer_length
= count
;
532 priv
->tx_room
-= count
;
534 rc
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
536 dev_dbg(&port
->dev
, "usb_submit_urb(write bulk) failed\n");
540 /* There wasn't any room left, so we are throttled until
541 the buffer empties a bit */
542 request_unthrottle
= 1;
545 if (request_unthrottle
) {
546 priv
->tx_throttled
= 1; /* block writers */
547 schedule_work(&priv
->unthrottle_work
);
553 set_bit(0, &port
->write_urbs_free
);
558 static void keyspan_pda_write_bulk_callback(struct urb
*urb
)
560 struct usb_serial_port
*port
= urb
->context
;
561 struct keyspan_pda_private
*priv
;
563 set_bit(0, &port
->write_urbs_free
);
564 priv
= usb_get_serial_port_data(port
);
566 /* queue up a wakeup at scheduler time */
567 schedule_work(&priv
->wakeup_work
);
571 static int keyspan_pda_write_room(struct tty_struct
*tty
)
573 struct usb_serial_port
*port
= tty
->driver_data
;
574 struct keyspan_pda_private
*priv
;
575 priv
= usb_get_serial_port_data(port
);
576 /* used by n_tty.c for processing of tabs and such. Giving it our
577 conservative guess is probably good enough, but needs testing by
578 running a console through the device. */
579 return priv
->tx_room
;
583 static int keyspan_pda_chars_in_buffer(struct tty_struct
*tty
)
585 struct usb_serial_port
*port
= tty
->driver_data
;
586 struct keyspan_pda_private
*priv
;
590 priv
= usb_get_serial_port_data(port
);
592 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
593 n_tty.c:normal_poll() ) that we're not writeable. */
595 spin_lock_irqsave(&port
->lock
, flags
);
596 if (!test_bit(0, &port
->write_urbs_free
) || priv
->tx_throttled
)
598 spin_unlock_irqrestore(&port
->lock
, flags
);
603 static void keyspan_pda_dtr_rts(struct usb_serial_port
*port
, int on
)
605 struct usb_serial
*serial
= port
->serial
;
608 keyspan_pda_set_modem_info(serial
, (1 << 7) | (1 << 2));
610 keyspan_pda_set_modem_info(serial
, 0);
614 static int keyspan_pda_open(struct tty_struct
*tty
,
615 struct usb_serial_port
*port
)
617 struct usb_serial
*serial
= port
->serial
;
620 struct keyspan_pda_private
*priv
;
622 /* find out how much room is in the Tx ring */
623 room
= kmalloc(1, GFP_KERNEL
);
627 rc
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
629 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
637 dev_dbg(&port
->dev
, "%s - roomquery failed\n", __func__
);
641 dev_dbg(&port
->dev
, "%s - roomquery returned 0 bytes\n", __func__
);
645 priv
= usb_get_serial_port_data(port
);
646 priv
->tx_room
= *room
;
647 priv
->tx_throttled
= *room
? 0 : 1;
649 /*Start reading from the device*/
650 rc
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
652 dev_dbg(&port
->dev
, "%s - usb_submit_urb(read int) failed\n", __func__
);
659 static void keyspan_pda_close(struct usb_serial_port
*port
)
661 usb_kill_urb(port
->write_urb
);
662 usb_kill_urb(port
->interrupt_in_urb
);
666 /* download the firmware to a "fake" device (pre-renumeration) */
667 static int keyspan_pda_fake_startup(struct usb_serial
*serial
)
672 /* download the firmware here ... */
673 response
= ezusb_fx1_set_reset(serial
->dev
, 1);
677 else if (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == KEYSPAN_VENDOR_ID
)
678 fw_name
= "keyspan_pda/keyspan_pda.fw";
681 else if ((le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == XIRCOM_VENDOR_ID
) ||
682 (le16_to_cpu(serial
->dev
->descriptor
.idVendor
) == ENTREGA_VENDOR_ID
))
683 fw_name
= "keyspan_pda/xircom_pgs.fw";
686 dev_err(&serial
->dev
->dev
, "%s: unknown vendor, aborting.\n",
691 if (ezusb_fx1_ihex_firmware_download(serial
->dev
, fw_name
) < 0) {
692 dev_err(&serial
->dev
->dev
, "failed to load firmware \"%s\"\n",
697 /* after downloading firmware Renumeration will occur in a
698 moment and the new device will bind to the real driver */
700 /* we want this device to fail to have a driver assigned to it. */
705 MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
708 MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
711 static int keyspan_pda_port_probe(struct usb_serial_port
*port
)
714 struct keyspan_pda_private
*priv
;
716 priv
= kmalloc(sizeof(struct keyspan_pda_private
), GFP_KERNEL
);
720 INIT_WORK(&priv
->wakeup_work
, keyspan_pda_wakeup_write
);
721 INIT_WORK(&priv
->unthrottle_work
, keyspan_pda_request_unthrottle
);
722 priv
->serial
= port
->serial
;
725 usb_set_serial_port_data(port
, priv
);
730 static int keyspan_pda_port_remove(struct usb_serial_port
*port
)
732 struct keyspan_pda_private
*priv
;
734 priv
= usb_get_serial_port_data(port
);
741 static struct usb_serial_driver keyspan_pda_fake_device
= {
743 .owner
= THIS_MODULE
,
744 .name
= "keyspan_pda_pre",
746 .description
= "Keyspan PDA - (prerenumeration)",
747 .id_table
= id_table_fake
,
749 .attach
= keyspan_pda_fake_startup
,
754 static struct usb_serial_driver xircom_pgs_fake_device
= {
756 .owner
= THIS_MODULE
,
757 .name
= "xircom_no_firm",
759 .description
= "Xircom / Entrega PGS - (prerenumeration)",
760 .id_table
= id_table_fake_xircom
,
762 .attach
= keyspan_pda_fake_startup
,
766 static struct usb_serial_driver keyspan_pda_device
= {
768 .owner
= THIS_MODULE
,
769 .name
= "keyspan_pda",
771 .description
= "Keyspan PDA",
772 .id_table
= id_table_std
,
775 .num_interrupt_in
= 1,
776 .dtr_rts
= keyspan_pda_dtr_rts
,
777 .open
= keyspan_pda_open
,
778 .close
= keyspan_pda_close
,
779 .write
= keyspan_pda_write
,
780 .write_room
= keyspan_pda_write_room
,
781 .write_bulk_callback
= keyspan_pda_write_bulk_callback
,
782 .read_int_callback
= keyspan_pda_rx_interrupt
,
783 .chars_in_buffer
= keyspan_pda_chars_in_buffer
,
784 .throttle
= keyspan_pda_rx_throttle
,
785 .unthrottle
= keyspan_pda_rx_unthrottle
,
786 .set_termios
= keyspan_pda_set_termios
,
787 .break_ctl
= keyspan_pda_break_ctl
,
788 .tiocmget
= keyspan_pda_tiocmget
,
789 .tiocmset
= keyspan_pda_tiocmset
,
790 .port_probe
= keyspan_pda_port_probe
,
791 .port_remove
= keyspan_pda_port_remove
,
794 static struct usb_serial_driver
* const serial_drivers
[] = {
797 &keyspan_pda_fake_device
,
800 &xircom_pgs_fake_device
,
805 module_usb_serial_driver(serial_drivers
, id_table_combined
);
807 MODULE_AUTHOR(DRIVER_AUTHOR
);
808 MODULE_DESCRIPTION(DRIVER_DESC
);
809 MODULE_LICENSE("GPL");