blob: 38d43c4b7ce547700e007f6f406d17f2c65d3ca4 [file] [log] [blame]
Greg Kroah-Hartman5fd54ac2017-11-03 11:28:30 +01001// SPDX-License-Identifier: GPL-2.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Mark Knibbs5f9f9752014-10-04 12:19:59 +01003 * USB Keyspan PDA / Xircom / Entrega Converter driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
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>
8 *
Alan Cox9e70f312008-07-22 11:13:42 +01009 * See Documentation/usb/usb-serial.txt for more information on using this
10 * driver
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 */
12
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/kernel.h>
15#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#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>
Alan Cox9e70f312008-07-22 11:13:42 +010023#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/usb.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070025#include <linux/usb/serial.h>
Rene Buergelcc183e22012-09-18 09:00:41 +020026#include <linux/usb/ezusb.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/* make a simple define to handle if we are compiling keyspan_pda or xircom support */
Javier Martinez Canillas91956862016-08-18 09:45:06 -040029#if IS_ENABLED(CONFIG_USB_SERIAL_KEYSPAN_PDA)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 #define KEYSPAN
31#else
32 #undef KEYSPAN
33#endif
Javier Martinez Canillas91956862016-08-18 09:45:06 -040034#if IS_ENABLED(CONFIG_USB_SERIAL_XIRCOM)
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 #define XIRCOM
36#else
37 #undef XIRCOM
38#endif
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
41#define DRIVER_DESC "USB Keyspan PDA Converter driver"
42
43struct keyspan_pda_private {
44 int tx_room;
45 int tx_throttled;
46 struct work_struct wakeup_work;
47 struct work_struct unthrottle_work;
David Howellsc4028952006-11-22 14:57:56 +000048 struct usb_serial *serial;
49 struct usb_serial_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050};
51
52
53#define KEYSPAN_VENDOR_ID 0x06cd
54#define KEYSPAN_PDA_FAKE_ID 0x0103
55#define KEYSPAN_PDA_ID 0x0104 /* no clue */
56
Mark Knibbs5f9f9752014-10-04 12:19:59 +010057/* For Xircom PGSDB9 and older Entrega version of the same device */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#define XIRCOM_VENDOR_ID 0x085a
59#define XIRCOM_FAKE_ID 0x8027
Nathaniel W Filardo5e71fc862015-03-16 11:19:55 -040060#define XIRCOM_FAKE_ID_2 0x8025 /* "PGMFHUB" serial */
Mark Knibbs5f9f9752014-10-04 12:19:59 +010061#define ENTREGA_VENDOR_ID 0x1645
62#define ENTREGA_FAKE_ID 0x8093
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Németh Márton7d40d7e2010-01-10 15:34:24 +010064static const struct usb_device_id id_table_combined[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#ifdef KEYSPAN
66 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
67#endif
68#ifdef XIRCOM
69 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
Nathaniel W Filardo5e71fc862015-03-16 11:19:55 -040070 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
Mark Knibbs5f9f9752014-10-04 12:19:59 +010071 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#endif
73 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
74 { } /* Terminating entry */
75};
76
Alan Cox9e70f312008-07-22 11:13:42 +010077MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Németh Márton7d40d7e2010-01-10 15:34:24 +010079static const struct usb_device_id id_table_std[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
81 { } /* Terminating entry */
82};
83
84#ifdef KEYSPAN
Németh Márton7d40d7e2010-01-10 15:34:24 +010085static const struct usb_device_id id_table_fake[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
87 { } /* Terminating entry */
88};
89#endif
90
91#ifdef XIRCOM
Németh Márton7d40d7e2010-01-10 15:34:24 +010092static const struct usb_device_id id_table_fake_xircom[] = {
Alan Cox9e70f312008-07-22 11:13:42 +010093 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
Nathaniel W Filardo5e71fc862015-03-16 11:19:55 -040094 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
Mark Knibbs5f9f9752014-10-04 12:19:59 +010095 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
Alan Cox9e70f312008-07-22 11:13:42 +010096 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -070097};
98#endif
99
David Howellsc4028952006-11-22 14:57:56 +0000100static void keyspan_pda_wakeup_write(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
David Howellsc4028952006-11-22 14:57:56 +0000102 struct keyspan_pda_private *priv =
103 container_of(work, struct keyspan_pda_private, wakeup_work);
104 struct usb_serial_port *port = priv->port;
Jiri Slaby6aad04f2013-03-07 13:12:29 +0100105
106 tty_port_tty_wakeup(&port->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107}
108
David Howellsc4028952006-11-22 14:57:56 +0000109static void keyspan_pda_request_unthrottle(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
David Howellsc4028952006-11-22 14:57:56 +0000111 struct keyspan_pda_private *priv =
112 container_of(work, struct keyspan_pda_private, unthrottle_work);
113 struct usb_serial *serial = priv->serial;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 int result;
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 /* ask the device to tell us when the tx buffer becomes
117 sufficiently empty */
Alan Cox9e70f312008-07-22 11:13:42 +0100118 result = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 usb_sndctrlpipe(serial->dev, 0),
120 7, /* request_unthrottle */
121 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
122 | USB_DIR_OUT,
123 16, /* value: threshold */
124 0, /* index */
125 NULL,
126 0,
127 2000);
128 if (result < 0)
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700129 dev_dbg(&serial->dev->dev, "%s - error %d from usb_control_msg\n",
130 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131}
132
133
Alan Cox9e70f312008-07-22 11:13:42 +0100134static void keyspan_pda_rx_interrupt(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135{
Ming Leicdc97792008-02-24 18:41:47 +0800136 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 unsigned char *data = urb->transfer_buffer;
Johan Hovoldc528fcb2017-01-31 17:17:29 +0100138 unsigned int len = urb->actual_length;
Greg Kroah-Hartman23189ae2007-06-15 15:44:13 -0700139 int retval;
140 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 struct keyspan_pda_private *priv;
142 priv = usb_get_serial_port_data(port);
143
Greg Kroah-Hartman23189ae2007-06-15 15:44:13 -0700144 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 case 0:
146 /* success */
147 break;
148 case -ECONNRESET:
149 case -ENOENT:
150 case -ESHUTDOWN:
151 /* this urb is terminated, clean up */
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700152 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
Jiri Slabyf7d7aed2011-02-28 10:34:05 +0100153 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 default:
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700155 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 goto exit;
157 }
158
Johan Hovoldc528fcb2017-01-31 17:17:29 +0100159 if (len < 1) {
160 dev_warn(&port->dev, "short message received\n");
161 goto exit;
162 }
163
Alan Cox9e70f312008-07-22 11:13:42 +0100164 /* see if the message is data or a status interrupt */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 switch (data[0]) {
166 case 0:
Jiri Slabyf7d7aed2011-02-28 10:34:05 +0100167 /* rest of message is rx data */
Johan Hovoldc528fcb2017-01-31 17:17:29 +0100168 if (len < 2)
169 break;
170 tty_insert_flip_string(&port->port, data + 1, len - 1);
171 tty_flip_buffer_push(&port->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 break;
173 case 1:
174 /* status interrupt */
Johan Hovoldc528fcb2017-01-31 17:17:29 +0100175 if (len < 3) {
176 dev_warn(&port->dev, "short interrupt message received\n");
177 break;
178 }
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700179 dev_dbg(&port->dev, "rx int, d1=%d, d2=%d\n", data[1], data[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 switch (data[1]) {
181 case 1: /* modemline change */
182 break;
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);
187 break;
188 default:
189 break;
190 }
191 break;
192 default:
193 break;
194 }
195
196exit:
Alan Cox9e70f312008-07-22 11:13:42 +0100197 retval = usb_submit_urb(urb, GFP_ATOMIC);
Greg Kroah-Hartman23189ae2007-06-15 15:44:13 -0700198 if (retval)
Alan Cox4a90f092008-10-13 10:39:46 +0100199 dev_err(&port->dev,
Johan Hovoldd9a38a82014-03-12 19:09:42 +0100200 "%s - usb_submit_urb failed with result %d\n",
Alan Cox4a90f092008-10-13 10:39:46 +0100201 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202}
203
204
Alan Cox95da3102008-07-22 11:09:07 +0100205static void keyspan_pda_rx_throttle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206{
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. */
Alan Cox95da3102008-07-22 11:09:07 +0100213 struct usb_serial_port *port = tty->driver_data;
Greg Kroah-Hartman5542cf72012-05-03 16:44:23 -0700214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 usb_kill_urb(port->interrupt_in_urb);
216}
217
218
Alan Cox95da3102008-07-22 11:09:07 +0100219static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
Alan Cox95da3102008-07-22 11:09:07 +0100221 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 /* just restart the receive interrupt URB */
Greg Kroah-Hartman5542cf72012-05-03 16:44:23 -0700223
Oliver Neukum63832512009-10-07 10:50:23 +0200224 if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700225 dev_dbg(&port->dev, "usb_submit_urb(read urb) failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226}
227
228
Alan Cox9e70f312008-07-22 11:13:42 +0100229static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
231 int rc;
232 int bindex;
233
Alan Cox9e70f312008-07-22 11:13:42 +0100234 switch (baud) {
235 case 110:
236 bindex = 0;
237 break;
238 case 300:
239 bindex = 1;
240 break;
241 case 1200:
242 bindex = 2;
243 break;
244 case 2400:
245 bindex = 3;
246 break;
247 case 4800:
248 bindex = 4;
249 break;
250 case 9600:
251 bindex = 5;
252 break;
253 case 19200:
254 bindex = 6;
255 break;
256 case 38400:
257 bindex = 7;
258 break;
259 case 57600:
260 bindex = 8;
261 break;
262 case 115200:
263 bindex = 9;
264 break;
265 default:
266 bindex = 5; /* Default to 9600 */
267 baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 }
269
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),
273 0, /* set baud */
Alan Cox9e70f312008-07-22 11:13:42 +0100274 USB_TYPE_VENDOR
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 | USB_RECIP_INTERFACE
276 | USB_DIR_OUT, /* type */
277 bindex, /* value */
278 0, /* index */
279 NULL, /* &data */
280 0, /* size */
281 2000); /* timeout */
Alan Coxe7806e32007-12-13 16:15:28 -0800282 if (rc < 0)
283 return 0;
284 return baud;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285}
286
287
Alan Cox95da3102008-07-22 11:09:07 +0100288static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Alan Cox95da3102008-07-22 11:09:07 +0100290 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 struct usb_serial *serial = port->serial;
292 int value;
293 int result;
294
295 if (break_state == -1)
296 value = 1; /* start break */
297 else
298 value = 0; /* clear break */
299 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
Alan Cox9e70f312008-07-22 11:13:42 +0100300 4, /* set break */
301 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
302 value, 0, NULL, 0, 2000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 if (result < 0)
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700304 dev_dbg(&port->dev, "%s - error %d from usb_control_msg\n",
305 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 /* 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
309 is on /dev/ttyS0 */
310}
311
312
Alan Cox95da3102008-07-22 11:09:07 +0100313static void keyspan_pda_set_termios(struct tty_struct *tty,
314 struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315{
316 struct usb_serial *serial = port->serial;
Alan Coxe7806e32007-12-13 16:15:28 -0800317 speed_t speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
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)
322 PARENB (parity)
323 CSIZE (5bit .. 8bit)
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:
328 8N1: 10 bit
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?)
333
Alan Coxadc8d742012-07-14 15:31:47 +0100334 HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 bit.
336
337 For now, just do baud. */
338
Alan Cox95da3102008-07-22 11:09:07 +0100339 speed = tty_get_baud_rate(tty);
Alan Coxe7806e32007-12-13 16:15:28 -0800340 speed = keyspan_pda_setbaud(serial, speed);
341
342 if (speed == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700343 dev_dbg(&port->dev, "can't handle requested baud rate\n");
Alan Coxe7806e32007-12-13 16:15:28 -0800344 /* It hasn't changed so.. */
345 speed = tty_termios_baud_rate(old_termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 }
Alan Coxe7806e32007-12-13 16:15:28 -0800347 /* Only speed can change so copy the old h/w parameters
348 then encode the new speed */
Alan Coxadc8d742012-07-14 15:31:47 +0100349 tty_termios_copy_hw(&tty->termios, old_termios);
Alan Cox95da3102008-07-22 11:09:07 +0100350 tty_encode_baud_rate(tty, speed, speed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
352
353
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 */
357
358static int keyspan_pda_get_modem_info(struct usb_serial *serial,
359 unsigned char *value)
360{
361 int rc;
Johan Hovoldca65d252009-12-28 23:01:51 +0100362 u8 *data;
363
364 data = kmalloc(1, GFP_KERNEL);
365 if (!data)
366 return -ENOMEM;
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
369 3, /* get pins */
370 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
Johan Hovoldca65d252009-12-28 23:01:51 +0100371 0, 0, data, 1, 2000);
Johan Hovold01b3cdf2018-07-04 17:02:16 +0200372 if (rc == 1)
Johan Hovoldca65d252009-12-28 23:01:51 +0100373 *value = *data;
Johan Hovold01b3cdf2018-07-04 17:02:16 +0200374 else if (rc >= 0)
375 rc = -EIO;
Johan Hovoldca65d252009-12-28 23:01:51 +0100376
377 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 return rc;
379}
380
381
382static int keyspan_pda_set_modem_info(struct usb_serial *serial,
383 unsigned char value)
384{
385 int rc;
386 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
387 3, /* set pins */
388 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
389 value, 0, NULL, 0, 2000);
390 return rc;
391}
392
Alan Cox60b33c12011-02-14 16:26:14 +0000393static int keyspan_pda_tiocmget(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
Alan Cox95da3102008-07-22 11:09:07 +0100395 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 struct usb_serial *serial = port->serial;
397 int rc;
398 unsigned char status;
399 int value;
400
401 rc = keyspan_pda_get_modem_info(serial, &status);
402 if (rc < 0)
403 return rc;
404 value =
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);
411 return value;
412}
413
Alan Cox20b9d172011-02-14 16:26:50 +0000414static int keyspan_pda_tiocmset(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 unsigned int set, unsigned int clear)
416{
Alan Cox95da3102008-07-22 11:09:07 +0100417 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 struct usb_serial *serial = port->serial;
419 int rc;
420 unsigned char status;
421
422 rc = keyspan_pda_get_modem_info(serial, &status);
423 if (rc < 0)
424 return rc;
425
426 if (set & TIOCM_RTS)
427 status |= (1<<2);
428 if (set & TIOCM_DTR)
429 status |= (1<<7);
430
431 if (clear & TIOCM_RTS)
432 status &= ~(1<<2);
433 if (clear & TIOCM_DTR)
434 status &= ~(1<<7);
435 rc = keyspan_pda_set_modem_info(serial, status);
436 return rc;
437}
438
Alan Cox95da3102008-07-22 11:09:07 +0100439static int keyspan_pda_write(struct tty_struct *tty,
440 struct usb_serial_port *port, const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 struct usb_serial *serial = port->serial;
443 int request_unthrottle = 0;
444 int rc = 0;
445 struct keyspan_pda_private *priv;
446
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
455 we can. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 if (count == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700457 dev_dbg(&port->dev, "write request of 0 bytes\n");
Alan Cox9e70f312008-07-22 11:13:42 +0100458 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 }
460
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)
464 */
Peter Zijlstrae81ee632006-09-25 12:51:41 +0200465 spin_lock_bh(&port->lock);
Johan Hovoldda280e32011-11-06 19:06:24 +0100466 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled) {
Peter Zijlstrae81ee632006-09-25 12:51:41 +0200467 spin_unlock_bh(&port->lock);
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700468 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 }
Johan Hovoldda280e32011-11-06 19:06:24 +0100470 clear_bit(0, &port->write_urbs_free);
Peter Zijlstrae81ee632006-09-25 12:51:41 +0200471 spin_unlock_bh(&port->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
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
476 ready to write. */
477
478 count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
479
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()) {
Johan Hovoldca65d252009-12-28 23:01:51 +0100484 u8 *room;
485
486 room = kmalloc(1, GFP_KERNEL);
487 if (!room) {
488 rc = -ENOMEM;
489 goto exit;
490 }
491
Alan Cox9e70f312008-07-22 11:13:42 +0100492 rc = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 usb_rcvctrlpipe(serial->dev, 0),
494 6, /* write_room */
495 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
496 | USB_DIR_IN,
497 0, /* value: 0 means "remaining room" */
498 0, /* index */
Johan Hovoldca65d252009-12-28 23:01:51 +0100499 room,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 1,
501 2000);
Johan Hovoldca65d252009-12-28 23:01:51 +0100502 if (rc > 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700503 dev_dbg(&port->dev, "roomquery says %d\n", *room);
Johan Hovoldca65d252009-12-28 23:01:51 +0100504 priv->tx_room = *room;
505 }
506 kfree(room);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 if (rc < 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700508 dev_dbg(&port->dev, "roomquery failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 goto exit;
510 }
511 if (rc == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700512 dev_dbg(&port->dev, "roomquery returned 0 bytes\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 rc = -EIO; /* device didn't return any data */
514 goto exit;
515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 }
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;
522 }
523
524 if (count) {
525 /* now transfer data */
Alan Cox9e70f312008-07-22 11:13:42 +0100526 memcpy(port->write_urb->transfer_buffer, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 /* send the data out the bulk port */
528 port->write_urb->transfer_buffer_length = count;
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 priv->tx_room -= count;
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
533 if (rc) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700534 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 goto exit;
536 }
Alan Cox9e70f312008-07-22 11:13:42 +0100537 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 /* There wasn't any room left, so we are throttled until
539 the buffer empties a bit */
540 request_unthrottle = 1;
541 }
542
543 if (request_unthrottle) {
544 priv->tx_throttled = 1; /* block writers */
545 schedule_work(&priv->unthrottle_work);
546 }
547
548 rc = count;
549exit:
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700550 if (rc < 0)
Johan Hovoldda280e32011-11-06 19:06:24 +0100551 set_bit(0, &port->write_urbs_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 return rc;
553}
554
555
Alan Cox9e70f312008-07-22 11:13:42 +0100556static void keyspan_pda_write_bulk_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557{
Ming Leicdc97792008-02-24 18:41:47 +0800558 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 struct keyspan_pda_private *priv;
560
Johan Hovoldda280e32011-11-06 19:06:24 +0100561 set_bit(0, &port->write_urbs_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 priv = usb_get_serial_port_data(port);
563
564 /* queue up a wakeup at scheduler time */
565 schedule_work(&priv->wakeup_work);
566}
567
568
Alan Cox95da3102008-07-22 11:09:07 +0100569static int keyspan_pda_write_room(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Alan Cox95da3102008-07-22 11:09:07 +0100571 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 struct keyspan_pda_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 /* 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. */
Alan Cox9e70f312008-07-22 11:13:42 +0100577 return priv->tx_room;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578}
579
580
Alan Cox95da3102008-07-22 11:09:07 +0100581static int keyspan_pda_chars_in_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
Alan Cox95da3102008-07-22 11:09:07 +0100583 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 struct keyspan_pda_private *priv;
Alan Coxa5b6f602008-04-08 17:16:06 +0100585 unsigned long flags;
586 int ret = 0;
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 priv = usb_get_serial_port_data(port);
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
591 n_tty.c:normal_poll() ) that we're not writeable. */
Alan Coxa5b6f602008-04-08 17:16:06 +0100592
593 spin_lock_irqsave(&port->lock, flags);
Johan Hovoldda280e32011-11-06 19:06:24 +0100594 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled)
Alan Coxa5b6f602008-04-08 17:16:06 +0100595 ret = 256;
596 spin_unlock_irqrestore(&port->lock, flags);
597 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
599
600
Alan Cox335f8512009-06-11 12:26:29 +0100601static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
602{
603 struct usb_serial *serial = port->serial;
604
Johan Hovoldd7f08452013-03-21 12:36:33 +0100605 if (on)
606 keyspan_pda_set_modem_info(serial, (1 << 7) | (1 << 2));
607 else
608 keyspan_pda_set_modem_info(serial, 0);
Alan Cox335f8512009-06-11 12:26:29 +0100609}
610
Alan Cox335f8512009-06-11 12:26:29 +0100611
Alan Cox95da3102008-07-22 11:09:07 +0100612static int keyspan_pda_open(struct tty_struct *tty,
Alan Coxa509a7e2009-09-19 13:13:26 -0700613 struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614{
615 struct usb_serial *serial = port->serial;
Johan Hovoldca65d252009-12-28 23:01:51 +0100616 u8 *room;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 int rc = 0;
618 struct keyspan_pda_private *priv;
619
620 /* find out how much room is in the Tx ring */
Johan Hovoldca65d252009-12-28 23:01:51 +0100621 room = kmalloc(1, GFP_KERNEL);
622 if (!room)
623 return -ENOMEM;
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
626 6, /* write_room */
627 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
628 | USB_DIR_IN,
629 0, /* value */
630 0, /* index */
Johan Hovoldca65d252009-12-28 23:01:51 +0100631 room,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 1,
633 2000);
634 if (rc < 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700635 dev_dbg(&port->dev, "%s - roomquery failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 goto error;
637 }
638 if (rc == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700639 dev_dbg(&port->dev, "%s - roomquery returned 0 bytes\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 rc = -EIO;
641 goto error;
642 }
643 priv = usb_get_serial_port_data(port);
Johan Hovoldca65d252009-12-28 23:01:51 +0100644 priv->tx_room = *room;
645 priv->tx_throttled = *room ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 /*Start reading from the device*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
649 if (rc) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700650 dev_dbg(&port->dev, "%s - usb_submit_urb(read int) failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 goto error;
652 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653error:
Johan Hovoldca65d252009-12-28 23:01:51 +0100654 kfree(room);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 return rc;
656}
Alan Cox335f8512009-06-11 12:26:29 +0100657static void keyspan_pda_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
Johan Hovold75d22b32013-03-21 12:36:34 +0100659 usb_kill_urb(port->write_urb);
660 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
663
664/* download the firmware to a "fake" device (pre-renumeration) */
Alan Cox9e70f312008-07-22 11:13:42 +0100665static int keyspan_pda_fake_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666{
667 int response;
David Woodhouse3edbf982008-05-30 15:15:13 +0300668 const char *fw_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
670 /* download the firmware here ... */
Rene Buergelcc183e22012-09-18 09:00:41 +0200671 response = ezusb_fx1_set_reset(serial->dev, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
David Woodhouse3edbf982008-05-30 15:15:13 +0300673 if (0) { ; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674#ifdef KEYSPAN
David Woodhouse3edbf982008-05-30 15:15:13 +0300675 else if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
676 fw_name = "keyspan_pda/keyspan_pda.fw";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677#endif
678#ifdef XIRCOM
David Woodhouse3edbf982008-05-30 15:15:13 +0300679 else if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
Mark Knibbs5f9f9752014-10-04 12:19:59 +0100680 (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGA_VENDOR_ID))
David Woodhouse3edbf982008-05-30 15:15:13 +0300681 fw_name = "keyspan_pda/xircom_pgs.fw";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682#endif
David Woodhouse3edbf982008-05-30 15:15:13 +0300683 else {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700684 dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
685 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 return -ENODEV;
687 }
Rene Buergel8d733e22012-09-18 09:02:01 +0200688
689 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700690 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
691 fw_name);
David Woodhouse3edbf982008-05-30 15:15:13 +0300692 return -ENOENT;
693 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Rene Buergel8d733e22012-09-18 09:02:01 +0200695 /* after downloading firmware Renumeration will occur in a
696 moment and the new device will bind to the real driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
698 /* we want this device to fail to have a driver assigned to it. */
Alan Cox9e70f312008-07-22 11:13:42 +0100699 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
701
Ben Hutchingse6c4ef92010-01-13 23:34:18 +0000702#ifdef KEYSPAN
703MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
704#endif
705#ifdef XIRCOM
706MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
707#endif
708
Johan Hovold94ab71c2012-10-17 13:35:00 +0200709static int keyspan_pda_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710{
711
712 struct keyspan_pda_private *priv;
713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
715 if (!priv)
Johan Hovold94ab71c2012-10-17 13:35:00 +0200716 return -ENOMEM;
717
David Howellsc4028952006-11-22 14:57:56 +0000718 INIT_WORK(&priv->wakeup_work, keyspan_pda_wakeup_write);
719 INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
Johan Hovold94ab71c2012-10-17 13:35:00 +0200720 priv->serial = port->serial;
721 priv->port = port;
722
723 usb_set_serial_port_data(port, priv);
724
Alan Cox9e70f312008-07-22 11:13:42 +0100725 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}
727
Johan Hovold94ab71c2012-10-17 13:35:00 +0200728static int keyspan_pda_port_remove(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Johan Hovold94ab71c2012-10-17 13:35:00 +0200730 struct keyspan_pda_private *priv;
731
732 priv = usb_get_serial_port_data(port);
733 kfree(priv);
734
735 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
737
738#ifdef KEYSPAN
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700739static struct usb_serial_driver keyspan_pda_fake_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700740 .driver = {
741 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700742 .name = "keyspan_pda_pre",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700743 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700744 .description = "Keyspan PDA - (prerenumeration)",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 .id_table = id_table_fake,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 .num_ports = 1,
747 .attach = keyspan_pda_fake_startup,
748};
749#endif
750
751#ifdef XIRCOM
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700752static struct usb_serial_driver xircom_pgs_fake_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700753 .driver = {
754 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700755 .name = "xircom_no_firm",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700756 },
Mark Knibbs5f9f9752014-10-04 12:19:59 +0100757 .description = "Xircom / Entrega PGS - (prerenumeration)",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 .id_table = id_table_fake_xircom,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 .num_ports = 1,
760 .attach = keyspan_pda_fake_startup,
761};
762#endif
763
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700764static struct usb_serial_driver keyspan_pda_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700765 .driver = {
766 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700767 .name = "keyspan_pda",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700768 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700769 .description = "Keyspan PDA",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 .id_table = id_table_std,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 .num_ports = 1,
Johan Hovoldb714d5d2017-03-02 12:51:25 +0100772 .num_bulk_out = 1,
773 .num_interrupt_in = 1,
Alan Cox335f8512009-06-11 12:26:29 +0100774 .dtr_rts = keyspan_pda_dtr_rts,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 .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,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 .set_termios = keyspan_pda_set_termios,
785 .break_ctl = keyspan_pda_break_ctl,
786 .tiocmget = keyspan_pda_tiocmget,
787 .tiocmset = keyspan_pda_tiocmset,
Johan Hovold94ab71c2012-10-17 13:35:00 +0200788 .port_probe = keyspan_pda_port_probe,
789 .port_remove = keyspan_pda_port_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790};
791
Greg Kroah-Hartman8c49fc92012-02-24 12:49:34 -0800792static struct usb_serial_driver * const serial_drivers[] = {
793 &keyspan_pda_device,
794#ifdef KEYSPAN
795 &keyspan_pda_fake_device,
796#endif
797#ifdef XIRCOM
798 &xircom_pgs_fake_device,
799#endif
800 NULL
801};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Greg Kroah-Hartman68e24112012-05-08 15:46:14 -0700803module_usb_serial_driver(serial_drivers, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Alan Cox9e70f312008-07-22 11:13:42 +0100805MODULE_AUTHOR(DRIVER_AUTHOR);
806MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807MODULE_LICENSE("GPL");