blob: 83523fcf6fb9d6a75bfba7738362e1c8bbfa01c9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Mark Knibbs5f9f9752014-10-04 12:19:59 +01002 * USB Keyspan PDA / Xircom / Entrega Converter driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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>
7 *
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.
12 *
Alan Cox9e70f312008-07-22 11:13:42 +010013 * See Documentation/usb/usb-serial.txt for more information on using this
14 * driver
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 */
16
17
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/kernel.h>
19#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#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>
Alan Cox9e70f312008-07-22 11:13:42 +010027#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/usb.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070029#include <linux/usb/serial.h>
Rene Buergelcc183e22012-09-18 09:00:41 +020030#include <linux/usb/ezusb.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032/* make a simple define to handle if we are compiling keyspan_pda or xircom support */
Javier Martinez Canillas91956862016-08-18 09:45:06 -040033#if IS_ENABLED(CONFIG_USB_SERIAL_KEYSPAN_PDA)
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 #define KEYSPAN
35#else
36 #undef KEYSPAN
37#endif
Javier Martinez Canillas91956862016-08-18 09:45:06 -040038#if IS_ENABLED(CONFIG_USB_SERIAL_XIRCOM)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 #define XIRCOM
40#else
41 #undef XIRCOM
42#endif
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
45#define DRIVER_DESC "USB Keyspan PDA Converter driver"
46
47struct keyspan_pda_private {
48 int tx_room;
49 int tx_throttled;
50 struct work_struct wakeup_work;
51 struct work_struct unthrottle_work;
David Howellsc4028952006-11-22 14:57:56 +000052 struct usb_serial *serial;
53 struct usb_serial_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054};
55
56
57#define KEYSPAN_VENDOR_ID 0x06cd
58#define KEYSPAN_PDA_FAKE_ID 0x0103
59#define KEYSPAN_PDA_ID 0x0104 /* no clue */
60
Mark Knibbs5f9f9752014-10-04 12:19:59 +010061/* For Xircom PGSDB9 and older Entrega version of the same device */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062#define XIRCOM_VENDOR_ID 0x085a
63#define XIRCOM_FAKE_ID 0x8027
Nathaniel W Filardo5e71fc82015-03-16 11:19:55 -040064#define XIRCOM_FAKE_ID_2 0x8025 /* "PGMFHUB" serial */
Mark Knibbs5f9f9752014-10-04 12:19:59 +010065#define ENTREGA_VENDOR_ID 0x1645
66#define ENTREGA_FAKE_ID 0x8093
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Németh Márton7d40d7e2010-01-10 15:34:24 +010068static const struct usb_device_id id_table_combined[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#ifdef KEYSPAN
70 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
71#endif
72#ifdef XIRCOM
73 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
Nathaniel W Filardo5e71fc82015-03-16 11:19:55 -040074 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
Mark Knibbs5f9f9752014-10-04 12:19:59 +010075 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
Linus Torvalds1da177e2005-04-16 15:20:36 -070076#endif
77 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
78 { } /* Terminating entry */
79};
80
Alan Cox9e70f312008-07-22 11:13:42 +010081MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Németh Márton7d40d7e2010-01-10 15:34:24 +010083static const struct usb_device_id id_table_std[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
85 { } /* Terminating entry */
86};
87
88#ifdef KEYSPAN
Németh Márton7d40d7e2010-01-10 15:34:24 +010089static const struct usb_device_id id_table_fake[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
91 { } /* Terminating entry */
92};
93#endif
94
95#ifdef XIRCOM
Németh Márton7d40d7e2010-01-10 15:34:24 +010096static const struct usb_device_id id_table_fake_xircom[] = {
Alan Cox9e70f312008-07-22 11:13:42 +010097 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
Nathaniel W Filardo5e71fc82015-03-16 11:19:55 -040098 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID_2) },
Mark Knibbs5f9f9752014-10-04 12:19:59 +010099 { USB_DEVICE(ENTREGA_VENDOR_ID, ENTREGA_FAKE_ID) },
Alan Cox9e70f312008-07-22 11:13:42 +0100100 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101};
102#endif
103
David Howellsc4028952006-11-22 14:57:56 +0000104static void keyspan_pda_wakeup_write(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
David Howellsc4028952006-11-22 14:57:56 +0000106 struct keyspan_pda_private *priv =
107 container_of(work, struct keyspan_pda_private, wakeup_work);
108 struct usb_serial_port *port = priv->port;
Jiri Slaby6aad04f2013-03-07 13:12:29 +0100109
110 tty_port_tty_wakeup(&port->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111}
112
David Howellsc4028952006-11-22 14:57:56 +0000113static void keyspan_pda_request_unthrottle(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
David Howellsc4028952006-11-22 14:57:56 +0000115 struct keyspan_pda_private *priv =
116 container_of(work, struct keyspan_pda_private, unthrottle_work);
117 struct usb_serial *serial = priv->serial;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 int result;
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 /* ask the device to tell us when the tx buffer becomes
121 sufficiently empty */
Alan Cox9e70f312008-07-22 11:13:42 +0100122 result = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 usb_sndctrlpipe(serial->dev, 0),
124 7, /* request_unthrottle */
125 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
126 | USB_DIR_OUT,
127 16, /* value: threshold */
128 0, /* index */
129 NULL,
130 0,
131 2000);
132 if (result < 0)
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700133 dev_dbg(&serial->dev->dev, "%s - error %d from usb_control_msg\n",
134 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135}
136
137
Alan Cox9e70f312008-07-22 11:13:42 +0100138static void keyspan_pda_rx_interrupt(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139{
Ming Leicdc97792008-02-24 18:41:47 +0800140 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 unsigned char *data = urb->transfer_buffer;
Greg Kroah-Hartman23189ae2007-06-15 15:44:13 -0700142 int retval;
143 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 struct keyspan_pda_private *priv;
145 priv = usb_get_serial_port_data(port);
146
Greg Kroah-Hartman23189ae2007-06-15 15:44:13 -0700147 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 case 0:
149 /* success */
150 break;
151 case -ECONNRESET:
152 case -ENOENT:
153 case -ESHUTDOWN:
154 /* this urb is terminated, clean up */
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700155 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
Jiri Slabyf7d7aed2011-02-28 10:34:05 +0100156 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 default:
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700158 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 goto exit;
160 }
161
Alan Cox9e70f312008-07-22 11:13:42 +0100162 /* see if the message is data or a status interrupt */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 switch (data[0]) {
164 case 0:
Jiri Slabyf7d7aed2011-02-28 10:34:05 +0100165 /* rest of message is rx data */
Jiri Slaby2e124b42013-01-03 15:53:06 +0100166 if (urb->actual_length) {
Jiri Slaby05c7cd32013-01-03 15:53:04 +0100167 tty_insert_flip_string(&port->port, data + 1,
Alan Cox8dd03a52008-07-22 11:13:51 +0100168 urb->actual_length - 1);
Jiri Slaby2e124b42013-01-03 15:53:06 +0100169 tty_flip_buffer_push(&port->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 }
171 break;
172 case 1:
173 /* status interrupt */
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700174 dev_dbg(&port->dev, "rx int, d1=%d, d2=%d\n", data[1], data[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 switch (data[1]) {
176 case 1: /* modemline change */
177 break;
178 case 2: /* tx unthrottle interrupt */
179 priv->tx_throttled = 0;
180 /* queue up a wakeup at scheduler time */
181 schedule_work(&priv->wakeup_work);
182 break;
183 default:
184 break;
185 }
186 break;
187 default:
188 break;
189 }
190
191exit:
Alan Cox9e70f312008-07-22 11:13:42 +0100192 retval = usb_submit_urb(urb, GFP_ATOMIC);
Greg Kroah-Hartman23189ae2007-06-15 15:44:13 -0700193 if (retval)
Alan Cox4a90f092008-10-13 10:39:46 +0100194 dev_err(&port->dev,
Johan Hovoldd9a38a82014-03-12 19:09:42 +0100195 "%s - usb_submit_urb failed with result %d\n",
Alan Cox4a90f092008-10-13 10:39:46 +0100196 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
199
Alan Cox95da3102008-07-22 11:09:07 +0100200static void keyspan_pda_rx_throttle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
202 /* stop receiving characters. We just turn off the URB request, and
203 let chars pile up in the device. If we're doing hardware
204 flowcontrol, the device will signal the other end when its buffer
205 fills up. If we're doing XON/XOFF, this would be a good time to
206 send an XOFF, although it might make sense to foist that off
207 upon the device too. */
Alan Cox95da3102008-07-22 11:09:07 +0100208 struct usb_serial_port *port = tty->driver_data;
Greg Kroah-Hartman5542cf72012-05-03 16:44:23 -0700209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 usb_kill_urb(port->interrupt_in_urb);
211}
212
213
Alan Cox95da3102008-07-22 11:09:07 +0100214static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215{
Alan Cox95da3102008-07-22 11:09:07 +0100216 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 /* just restart the receive interrupt URB */
Greg Kroah-Hartman5542cf72012-05-03 16:44:23 -0700218
Oliver Neukum63832512009-10-07 10:50:23 +0200219 if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700220 dev_dbg(&port->dev, "usb_submit_urb(read urb) failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221}
222
223
Alan Cox9e70f312008-07-22 11:13:42 +0100224static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
226 int rc;
227 int bindex;
228
Alan Cox9e70f312008-07-22 11:13:42 +0100229 switch (baud) {
230 case 110:
231 bindex = 0;
232 break;
233 case 300:
234 bindex = 1;
235 break;
236 case 1200:
237 bindex = 2;
238 break;
239 case 2400:
240 bindex = 3;
241 break;
242 case 4800:
243 bindex = 4;
244 break;
245 case 9600:
246 bindex = 5;
247 break;
248 case 19200:
249 bindex = 6;
250 break;
251 case 38400:
252 bindex = 7;
253 break;
254 case 57600:
255 bindex = 8;
256 break;
257 case 115200:
258 bindex = 9;
259 break;
260 default:
261 bindex = 5; /* Default to 9600 */
262 baud = 9600;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
264
265 /* rather than figure out how to sleep while waiting for this
266 to complete, I just use the "legacy" API. */
267 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
268 0, /* set baud */
Alan Cox9e70f312008-07-22 11:13:42 +0100269 USB_TYPE_VENDOR
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 | USB_RECIP_INTERFACE
271 | USB_DIR_OUT, /* type */
272 bindex, /* value */
273 0, /* index */
274 NULL, /* &data */
275 0, /* size */
276 2000); /* timeout */
Alan Coxe7806e32007-12-13 16:15:28 -0800277 if (rc < 0)
278 return 0;
279 return baud;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280}
281
282
Alan Cox95da3102008-07-22 11:09:07 +0100283static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
Alan Cox95da3102008-07-22 11:09:07 +0100285 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 struct usb_serial *serial = port->serial;
287 int value;
288 int result;
289
290 if (break_state == -1)
291 value = 1; /* start break */
292 else
293 value = 0; /* clear break */
294 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
Alan Cox9e70f312008-07-22 11:13:42 +0100295 4, /* set break */
296 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
297 value, 0, NULL, 0, 2000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 if (result < 0)
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700299 dev_dbg(&port->dev, "%s - error %d from usb_control_msg\n",
300 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 /* there is something funky about this.. the TCSBRK that 'cu' performs
302 ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
303 seconds apart, but it feels like the break sent isn't as long as it
304 is on /dev/ttyS0 */
305}
306
307
Alan Cox95da3102008-07-22 11:09:07 +0100308static void keyspan_pda_set_termios(struct tty_struct *tty,
309 struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310{
311 struct usb_serial *serial = port->serial;
Alan Coxe7806e32007-12-13 16:15:28 -0800312 speed_t speed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314 /* cflag specifies lots of stuff: number of stop bits, parity, number
315 of data bits, baud. What can the device actually handle?:
316 CSTOPB (1 stop bit or 2)
317 PARENB (parity)
318 CSIZE (5bit .. 8bit)
319 There is minimal hw support for parity (a PSW bit seems to hold the
320 parity of whatever is in the accumulator). The UART either deals
321 with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
322 1 special, stop). So, with firmware changes, we could do:
323 8N1: 10 bit
324 8N2: 11 bit, extra bit always (mark?)
325 8[EOMS]1: 11 bit, extra bit is parity
326 7[EOMS]1: 10 bit, b0/b7 is parity
327 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
328
Alan Coxadc8d742012-07-14 15:31:47 +0100329 HW flow control is dictated by the tty->termios.c_cflags & CRTSCTS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 bit.
331
332 For now, just do baud. */
333
Alan Cox95da3102008-07-22 11:09:07 +0100334 speed = tty_get_baud_rate(tty);
Alan Coxe7806e32007-12-13 16:15:28 -0800335 speed = keyspan_pda_setbaud(serial, speed);
336
337 if (speed == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700338 dev_dbg(&port->dev, "can't handle requested baud rate\n");
Alan Coxe7806e32007-12-13 16:15:28 -0800339 /* It hasn't changed so.. */
340 speed = tty_termios_baud_rate(old_termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 }
Alan Coxe7806e32007-12-13 16:15:28 -0800342 /* Only speed can change so copy the old h/w parameters
343 then encode the new speed */
Alan Coxadc8d742012-07-14 15:31:47 +0100344 tty_termios_copy_hw(&tty->termios, old_termios);
Alan Cox95da3102008-07-22 11:09:07 +0100345 tty_encode_baud_rate(tty, speed, speed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346}
347
348
349/* modem control pins: DTR and RTS are outputs and can be controlled.
350 DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
351 read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
352
353static int keyspan_pda_get_modem_info(struct usb_serial *serial,
354 unsigned char *value)
355{
356 int rc;
Johan Hovoldca65d252009-12-28 23:01:51 +0100357 u8 *data;
358
359 data = kmalloc(1, GFP_KERNEL);
360 if (!data)
361 return -ENOMEM;
362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
364 3, /* get pins */
365 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
Johan Hovoldca65d252009-12-28 23:01:51 +0100366 0, 0, data, 1, 2000);
Benny Halevy3b36a8f2008-06-27 12:22:32 +0300367 if (rc >= 0)
Johan Hovoldca65d252009-12-28 23:01:51 +0100368 *value = *data;
369
370 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 return rc;
372}
373
374
375static int keyspan_pda_set_modem_info(struct usb_serial *serial,
376 unsigned char value)
377{
378 int rc;
379 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
380 3, /* set pins */
381 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
382 value, 0, NULL, 0, 2000);
383 return rc;
384}
385
Alan Cox60b33c12011-02-14 16:26:14 +0000386static int keyspan_pda_tiocmget(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
Alan Cox95da3102008-07-22 11:09:07 +0100388 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 struct usb_serial *serial = port->serial;
390 int rc;
391 unsigned char status;
392 int value;
393
394 rc = keyspan_pda_get_modem_info(serial, &status);
395 if (rc < 0)
396 return rc;
397 value =
398 ((status & (1<<7)) ? TIOCM_DTR : 0) |
399 ((status & (1<<6)) ? TIOCM_CAR : 0) |
400 ((status & (1<<5)) ? TIOCM_RNG : 0) |
401 ((status & (1<<4)) ? TIOCM_DSR : 0) |
402 ((status & (1<<3)) ? TIOCM_CTS : 0) |
403 ((status & (1<<2)) ? TIOCM_RTS : 0);
404 return value;
405}
406
Alan Cox20b9d172011-02-14 16:26:50 +0000407static int keyspan_pda_tiocmset(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 unsigned int set, unsigned int clear)
409{
Alan Cox95da3102008-07-22 11:09:07 +0100410 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 struct usb_serial *serial = port->serial;
412 int rc;
413 unsigned char status;
414
415 rc = keyspan_pda_get_modem_info(serial, &status);
416 if (rc < 0)
417 return rc;
418
419 if (set & TIOCM_RTS)
420 status |= (1<<2);
421 if (set & TIOCM_DTR)
422 status |= (1<<7);
423
424 if (clear & TIOCM_RTS)
425 status &= ~(1<<2);
426 if (clear & TIOCM_DTR)
427 status &= ~(1<<7);
428 rc = keyspan_pda_set_modem_info(serial, status);
429 return rc;
430}
431
Alan Cox95da3102008-07-22 11:09:07 +0100432static int keyspan_pda_write(struct tty_struct *tty,
433 struct usb_serial_port *port, const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434{
435 struct usb_serial *serial = port->serial;
436 int request_unthrottle = 0;
437 int rc = 0;
438 struct keyspan_pda_private *priv;
439
440 priv = usb_get_serial_port_data(port);
441 /* guess how much room is left in the device's ring buffer, and if we
442 want to send more than that, check first, updating our notion of
443 what is left. If our write will result in no room left, ask the
444 device to give us an interrupt when the room available rises above
445 a threshold, and hold off all writers (eventually, those using
446 select() or poll() too) until we receive that unthrottle interrupt.
447 Block if we can't write anything at all, otherwise write as much as
448 we can. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 if (count == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700450 dev_dbg(&port->dev, "write request of 0 bytes\n");
Alan Cox9e70f312008-07-22 11:13:42 +0100451 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 }
453
454 /* we might block because of:
455 the TX urb is in-flight (wait until it completes)
456 the device is full (wait until it says there is room)
457 */
Peter Zijlstrae81ee632006-09-25 12:51:41 +0200458 spin_lock_bh(&port->lock);
Johan Hovoldda280e32011-11-06 19:06:24 +0100459 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled) {
Peter Zijlstrae81ee632006-09-25 12:51:41 +0200460 spin_unlock_bh(&port->lock);
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700461 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 }
Johan Hovoldda280e32011-11-06 19:06:24 +0100463 clear_bit(0, &port->write_urbs_free);
Peter Zijlstrae81ee632006-09-25 12:51:41 +0200464 spin_unlock_bh(&port->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466 /* At this point the URB is in our control, nobody else can submit it
467 again (the only sudden transition was the one from EINPROGRESS to
468 finished). Also, the tx process is not throttled. So we are
469 ready to write. */
470
471 count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
472
473 /* Check if we might overrun the Tx buffer. If so, ask the
474 device how much room it really has. This is done only on
475 scheduler time, since usb_control_msg() sleeps. */
476 if (count > priv->tx_room && !in_interrupt()) {
Johan Hovoldca65d252009-12-28 23:01:51 +0100477 u8 *room;
478
479 room = kmalloc(1, GFP_KERNEL);
480 if (!room) {
481 rc = -ENOMEM;
482 goto exit;
483 }
484
Alan Cox9e70f312008-07-22 11:13:42 +0100485 rc = usb_control_msg(serial->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 usb_rcvctrlpipe(serial->dev, 0),
487 6, /* write_room */
488 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
489 | USB_DIR_IN,
490 0, /* value: 0 means "remaining room" */
491 0, /* index */
Johan Hovoldca65d252009-12-28 23:01:51 +0100492 room,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 1,
494 2000);
Johan Hovoldca65d252009-12-28 23:01:51 +0100495 if (rc > 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700496 dev_dbg(&port->dev, "roomquery says %d\n", *room);
Johan Hovoldca65d252009-12-28 23:01:51 +0100497 priv->tx_room = *room;
498 }
499 kfree(room);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 if (rc < 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700501 dev_dbg(&port->dev, "roomquery failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 goto exit;
503 }
504 if (rc == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700505 dev_dbg(&port->dev, "roomquery returned 0 bytes\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 rc = -EIO; /* device didn't return any data */
507 goto exit;
508 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 }
510 if (count > priv->tx_room) {
511 /* we're about to completely fill the Tx buffer, so
512 we'll be throttled afterwards. */
513 count = priv->tx_room;
514 request_unthrottle = 1;
515 }
516
517 if (count) {
518 /* now transfer data */
Alan Cox9e70f312008-07-22 11:13:42 +0100519 memcpy(port->write_urb->transfer_buffer, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 /* send the data out the bulk port */
521 port->write_urb->transfer_buffer_length = count;
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 priv->tx_room -= count;
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
526 if (rc) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700527 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 goto exit;
529 }
Alan Cox9e70f312008-07-22 11:13:42 +0100530 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 /* There wasn't any room left, so we are throttled until
532 the buffer empties a bit */
533 request_unthrottle = 1;
534 }
535
536 if (request_unthrottle) {
537 priv->tx_throttled = 1; /* block writers */
538 schedule_work(&priv->unthrottle_work);
539 }
540
541 rc = count;
542exit:
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700543 if (rc < 0)
Johan Hovoldda280e32011-11-06 19:06:24 +0100544 set_bit(0, &port->write_urbs_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 return rc;
546}
547
548
Alan Cox9e70f312008-07-22 11:13:42 +0100549static void keyspan_pda_write_bulk_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
Ming Leicdc97792008-02-24 18:41:47 +0800551 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 struct keyspan_pda_private *priv;
553
Johan Hovoldda280e32011-11-06 19:06:24 +0100554 set_bit(0, &port->write_urbs_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 priv = usb_get_serial_port_data(port);
556
557 /* queue up a wakeup at scheduler time */
558 schedule_work(&priv->wakeup_work);
559}
560
561
Alan Cox95da3102008-07-22 11:09:07 +0100562static int keyspan_pda_write_room(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563{
Alan Cox95da3102008-07-22 11:09:07 +0100564 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 struct keyspan_pda_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 priv = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 /* used by n_tty.c for processing of tabs and such. Giving it our
568 conservative guess is probably good enough, but needs testing by
569 running a console through the device. */
Alan Cox9e70f312008-07-22 11:13:42 +0100570 return priv->tx_room;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
573
Alan Cox95da3102008-07-22 11:09:07 +0100574static int keyspan_pda_chars_in_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
Alan Cox95da3102008-07-22 11:09:07 +0100576 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 struct keyspan_pda_private *priv;
Alan Coxa5b6f602008-04-08 17:16:06 +0100578 unsigned long flags;
579 int ret = 0;
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 priv = usb_get_serial_port_data(port);
Greg Kroah-Hartman507ca9b2005-04-23 12:49:16 -0700582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
584 n_tty.c:normal_poll() ) that we're not writeable. */
Alan Coxa5b6f602008-04-08 17:16:06 +0100585
586 spin_lock_irqsave(&port->lock, flags);
Johan Hovoldda280e32011-11-06 19:06:24 +0100587 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled)
Alan Coxa5b6f602008-04-08 17:16:06 +0100588 ret = 256;
589 spin_unlock_irqrestore(&port->lock, flags);
590 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
593
Alan Cox335f8512009-06-11 12:26:29 +0100594static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
595{
596 struct usb_serial *serial = port->serial;
597
Johan Hovoldd7f08452013-03-21 12:36:33 +0100598 if (on)
599 keyspan_pda_set_modem_info(serial, (1 << 7) | (1 << 2));
600 else
601 keyspan_pda_set_modem_info(serial, 0);
Alan Cox335f8512009-06-11 12:26:29 +0100602}
603
Alan Cox335f8512009-06-11 12:26:29 +0100604
Alan Cox95da3102008-07-22 11:09:07 +0100605static int keyspan_pda_open(struct tty_struct *tty,
Alan Coxa509a7e2009-09-19 13:13:26 -0700606 struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 struct usb_serial *serial = port->serial;
Johan Hovoldca65d252009-12-28 23:01:51 +0100609 u8 *room;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 int rc = 0;
611 struct keyspan_pda_private *priv;
612
613 /* find out how much room is in the Tx ring */
Johan Hovoldca65d252009-12-28 23:01:51 +0100614 room = kmalloc(1, GFP_KERNEL);
615 if (!room)
616 return -ENOMEM;
617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
619 6, /* write_room */
620 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
621 | USB_DIR_IN,
622 0, /* value */
623 0, /* index */
Johan Hovoldca65d252009-12-28 23:01:51 +0100624 room,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 1,
626 2000);
627 if (rc < 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700628 dev_dbg(&port->dev, "%s - roomquery failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 goto error;
630 }
631 if (rc == 0) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700632 dev_dbg(&port->dev, "%s - roomquery returned 0 bytes\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 rc = -EIO;
634 goto error;
635 }
636 priv = usb_get_serial_port_data(port);
Johan Hovoldca65d252009-12-28 23:01:51 +0100637 priv->tx_room = *room;
638 priv->tx_throttled = *room ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 /*Start reading from the device*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
642 if (rc) {
Greg Kroah-Hartman826575f2012-09-14 12:06:52 -0700643 dev_dbg(&port->dev, "%s - usb_submit_urb(read int) failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 goto error;
645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646error:
Johan Hovoldca65d252009-12-28 23:01:51 +0100647 kfree(room);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 return rc;
649}
Alan Cox335f8512009-06-11 12:26:29 +0100650static void keyspan_pda_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
Johan Hovold75d22b32013-03-21 12:36:34 +0100652 usb_kill_urb(port->write_urb);
653 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
655
656
657/* download the firmware to a "fake" device (pre-renumeration) */
Alan Cox9e70f312008-07-22 11:13:42 +0100658static int keyspan_pda_fake_startup(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
660 int response;
David Woodhouse3edbf982008-05-30 15:15:13 +0300661 const char *fw_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
663 /* download the firmware here ... */
Rene Buergelcc183e22012-09-18 09:00:41 +0200664 response = ezusb_fx1_set_reset(serial->dev, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
David Woodhouse3edbf982008-05-30 15:15:13 +0300666 if (0) { ; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667#ifdef KEYSPAN
David Woodhouse3edbf982008-05-30 15:15:13 +0300668 else if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
669 fw_name = "keyspan_pda/keyspan_pda.fw";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670#endif
671#ifdef XIRCOM
David Woodhouse3edbf982008-05-30 15:15:13 +0300672 else if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
Mark Knibbs5f9f9752014-10-04 12:19:59 +0100673 (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGA_VENDOR_ID))
David Woodhouse3edbf982008-05-30 15:15:13 +0300674 fw_name = "keyspan_pda/xircom_pgs.fw";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675#endif
David Woodhouse3edbf982008-05-30 15:15:13 +0300676 else {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700677 dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
678 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 return -ENODEV;
680 }
Rene Buergel8d733e22012-09-18 09:02:01 +0200681
682 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700683 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
684 fw_name);
David Woodhouse3edbf982008-05-30 15:15:13 +0300685 return -ENOENT;
686 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Rene Buergel8d733e22012-09-18 09:02:01 +0200688 /* after downloading firmware Renumeration will occur in a
689 moment and the new device will bind to the real driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691 /* we want this device to fail to have a driver assigned to it. */
Alan Cox9e70f312008-07-22 11:13:42 +0100692 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693}
694
Ben Hutchingse6c4ef92010-01-13 23:34:18 +0000695#ifdef KEYSPAN
696MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
697#endif
698#ifdef XIRCOM
699MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
700#endif
701
Johan Hovolddda76112017-01-03 16:39:48 +0100702static int keyspan_pda_attach(struct usb_serial *serial)
703{
704 unsigned char num_ports = serial->num_ports;
705
706 if (serial->num_bulk_out < num_ports ||
707 serial->num_interrupt_in < num_ports) {
708 dev_err(&serial->interface->dev, "missing endpoints\n");
709 return -ENODEV;
710 }
711
712 return 0;
713}
714
Johan Hovold94ab71c2012-10-17 13:35:00 +0200715static int keyspan_pda_port_probe(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716{
717
718 struct keyspan_pda_private *priv;
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
721 if (!priv)
Johan Hovold94ab71c2012-10-17 13:35:00 +0200722 return -ENOMEM;
723
David Howellsc4028952006-11-22 14:57:56 +0000724 INIT_WORK(&priv->wakeup_work, keyspan_pda_wakeup_write);
725 INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
Johan Hovold94ab71c2012-10-17 13:35:00 +0200726 priv->serial = port->serial;
727 priv->port = port;
728
729 usb_set_serial_port_data(port, priv);
730
Alan Cox9e70f312008-07-22 11:13:42 +0100731 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
Johan Hovold94ab71c2012-10-17 13:35:00 +0200734static int keyspan_pda_port_remove(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735{
Johan Hovold94ab71c2012-10-17 13:35:00 +0200736 struct keyspan_pda_private *priv;
737
738 priv = usb_get_serial_port_data(port);
739 kfree(priv);
740
741 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742}
743
744#ifdef KEYSPAN
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700745static struct usb_serial_driver keyspan_pda_fake_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700746 .driver = {
747 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700748 .name = "keyspan_pda_pre",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700749 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700750 .description = "Keyspan PDA - (prerenumeration)",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 .id_table = id_table_fake,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 .num_ports = 1,
753 .attach = keyspan_pda_fake_startup,
754};
755#endif
756
757#ifdef XIRCOM
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700758static struct usb_serial_driver xircom_pgs_fake_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700759 .driver = {
760 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700761 .name = "xircom_no_firm",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700762 },
Mark Knibbs5f9f9752014-10-04 12:19:59 +0100763 .description = "Xircom / Entrega PGS - (prerenumeration)",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 .id_table = id_table_fake_xircom,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 .num_ports = 1,
766 .attach = keyspan_pda_fake_startup,
767};
768#endif
769
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700770static struct usb_serial_driver keyspan_pda_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700771 .driver = {
772 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700773 .name = "keyspan_pda",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700774 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700775 .description = "Keyspan PDA",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 .id_table = id_table_std,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 .num_ports = 1,
Alan Cox335f8512009-06-11 12:26:29 +0100778 .dtr_rts = keyspan_pda_dtr_rts,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 .open = keyspan_pda_open,
780 .close = keyspan_pda_close,
781 .write = keyspan_pda_write,
782 .write_room = keyspan_pda_write_room,
783 .write_bulk_callback = keyspan_pda_write_bulk_callback,
784 .read_int_callback = keyspan_pda_rx_interrupt,
785 .chars_in_buffer = keyspan_pda_chars_in_buffer,
786 .throttle = keyspan_pda_rx_throttle,
787 .unthrottle = keyspan_pda_rx_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 .set_termios = keyspan_pda_set_termios,
789 .break_ctl = keyspan_pda_break_ctl,
790 .tiocmget = keyspan_pda_tiocmget,
791 .tiocmset = keyspan_pda_tiocmset,
Johan Hovolddda76112017-01-03 16:39:48 +0100792 .attach = keyspan_pda_attach,
Johan Hovold94ab71c2012-10-17 13:35:00 +0200793 .port_probe = keyspan_pda_port_probe,
794 .port_remove = keyspan_pda_port_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795};
796
Greg Kroah-Hartman8c49fc92012-02-24 12:49:34 -0800797static struct usb_serial_driver * const serial_drivers[] = {
798 &keyspan_pda_device,
799#ifdef KEYSPAN
800 &keyspan_pda_fake_device,
801#endif
802#ifdef XIRCOM
803 &xircom_pgs_fake_device,
804#endif
805 NULL
806};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Greg Kroah-Hartman68e24112012-05-08 15:46:14 -0700808module_usb_serial_driver(serial_drivers, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Alan Cox9e70f312008-07-22 11:13:42 +0100810MODULE_AUTHOR(DRIVER_AUTHOR);
811MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812MODULE_LICENSE("GPL");