module_param: make bool parameters really bool (drivers & misc)
[deliverable/linux.git] / drivers / usb / serial / keyspan_pda.c
CommitLineData
1da177e4
LT
1/*
2 * USB Keyspan PDA / Xircom / Entregra Converter driver
3 *
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 *
9e70f319
AC
13 * See Documentation/usb/usb-serial.txt for more information on using this
14 * driver
1da177e4
LT
15 */
16
17
1da177e4
LT
18#include <linux/kernel.h>
19#include <linux/errno.h>
20#include <linux/init.h>
21#include <linux/slab.h>
22#include <linux/tty.h>
23#include <linux/tty_driver.h>
24#include <linux/tty_flip.h>
25#include <linux/module.h>
26#include <linux/spinlock.h>
27#include <linux/workqueue.h>
3edbf98b
DW
28#include <linux/firmware.h>
29#include <linux/ihex.h>
9e70f319 30#include <linux/uaccess.h>
1da177e4 31#include <linux/usb.h>
a969888c 32#include <linux/usb/serial.h>
1da177e4 33
90ab5ee9 34static bool debug;
1da177e4 35
1da177e4
LT
36/* make a simple define to handle if we are compiling keyspan_pda or xircom support */
37#if defined(CONFIG_USB_SERIAL_KEYSPAN_PDA) || defined(CONFIG_USB_SERIAL_KEYSPAN_PDA_MODULE)
38 #define KEYSPAN
39#else
40 #undef KEYSPAN
41#endif
42#if defined(CONFIG_USB_SERIAL_XIRCOM) || defined(CONFIG_USB_SERIAL_XIRCOM_MODULE)
43 #define XIRCOM
44#else
45 #undef XIRCOM
46#endif
47
1da177e4
LT
48/*
49 * Version Information
50 */
51#define DRIVER_VERSION "v1.1"
52#define DRIVER_AUTHOR "Brian Warner <warner@lothar.com>"
53#define DRIVER_DESC "USB Keyspan PDA Converter driver"
54
55struct keyspan_pda_private {
56 int tx_room;
57 int tx_throttled;
58 struct work_struct wakeup_work;
59 struct work_struct unthrottle_work;
c4028958
DH
60 struct usb_serial *serial;
61 struct usb_serial_port *port;
1da177e4
LT
62};
63
64
65#define KEYSPAN_VENDOR_ID 0x06cd
66#define KEYSPAN_PDA_FAKE_ID 0x0103
67#define KEYSPAN_PDA_ID 0x0104 /* no clue */
68
69/* For Xircom PGSDB9 and older Entregra version of the same device */
70#define XIRCOM_VENDOR_ID 0x085a
71#define XIRCOM_FAKE_ID 0x8027
72#define ENTREGRA_VENDOR_ID 0x1645
73#define ENTREGRA_FAKE_ID 0x8093
74
7d40d7e8 75static const struct usb_device_id id_table_combined[] = {
1da177e4
LT
76#ifdef KEYSPAN
77 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
78#endif
79#ifdef XIRCOM
80 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
81 { USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
82#endif
83 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
84 { } /* Terminating entry */
85};
86
9e70f319 87MODULE_DEVICE_TABLE(usb, id_table_combined);
1da177e4
LT
88
89static struct usb_driver keyspan_pda_driver = {
1da177e4
LT
90 .name = "keyspan_pda",
91 .probe = usb_serial_probe,
92 .disconnect = usb_serial_disconnect,
93 .id_table = id_table_combined,
ba9dc657 94 .no_dynamic_id = 1,
1da177e4
LT
95};
96
7d40d7e8 97static const struct usb_device_id id_table_std[] = {
1da177e4
LT
98 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_ID) },
99 { } /* Terminating entry */
100};
101
102#ifdef KEYSPAN
7d40d7e8 103static const struct usb_device_id id_table_fake[] = {
1da177e4
LT
104 { USB_DEVICE(KEYSPAN_VENDOR_ID, KEYSPAN_PDA_FAKE_ID) },
105 { } /* Terminating entry */
106};
107#endif
108
109#ifdef XIRCOM
7d40d7e8 110static const struct usb_device_id id_table_fake_xircom[] = {
9e70f319
AC
111 { USB_DEVICE(XIRCOM_VENDOR_ID, XIRCOM_FAKE_ID) },
112 { USB_DEVICE(ENTREGRA_VENDOR_ID, ENTREGRA_FAKE_ID) },
113 { }
1da177e4
LT
114};
115#endif
116
c4028958 117static void keyspan_pda_wakeup_write(struct work_struct *work)
1da177e4 118{
c4028958
DH
119 struct keyspan_pda_private *priv =
120 container_of(work, struct keyspan_pda_private, wakeup_work);
121 struct usb_serial_port *port = priv->port;
4a90f09b 122 struct tty_struct *tty = tty_port_tty_get(&port->port);
f7d7aedf
JS
123 if (tty)
124 tty_wakeup(tty);
4a90f09b 125 tty_kref_put(tty);
1da177e4
LT
126}
127
c4028958 128static void keyspan_pda_request_unthrottle(struct work_struct *work)
1da177e4 129{
c4028958
DH
130 struct keyspan_pda_private *priv =
131 container_of(work, struct keyspan_pda_private, unthrottle_work);
132 struct usb_serial *serial = priv->serial;
1da177e4
LT
133 int result;
134
135 dbg(" request_unthrottle");
136 /* ask the device to tell us when the tx buffer becomes
137 sufficiently empty */
9e70f319 138 result = usb_control_msg(serial->dev,
1da177e4
LT
139 usb_sndctrlpipe(serial->dev, 0),
140 7, /* request_unthrottle */
141 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
142 | USB_DIR_OUT,
143 16, /* value: threshold */
144 0, /* index */
145 NULL,
146 0,
147 2000);
148 if (result < 0)
9e70f319 149 dbg("%s - error %d from usb_control_msg",
441b62c1 150 __func__, result);
1da177e4
LT
151}
152
153
9e70f319 154static void keyspan_pda_rx_interrupt(struct urb *urb)
1da177e4 155{
cdc97792 156 struct usb_serial_port *port = urb->context;
f7d7aedf 157 struct tty_struct *tty;
1da177e4 158 unsigned char *data = urb->transfer_buffer;
23189aee
GKH
159 int retval;
160 int status = urb->status;
1da177e4
LT
161 struct keyspan_pda_private *priv;
162 priv = usb_get_serial_port_data(port);
163
23189aee 164 switch (status) {
1da177e4
LT
165 case 0:
166 /* success */
167 break;
168 case -ECONNRESET:
169 case -ENOENT:
170 case -ESHUTDOWN:
171 /* this urb is terminated, clean up */
23189aee 172 dbg("%s - urb shutting down with status: %d",
441b62c1 173 __func__, status);
f7d7aedf 174 return;
1da177e4 175 default:
23189aee 176 dbg("%s - nonzero urb status received: %d",
441b62c1 177 __func__, status);
1da177e4
LT
178 goto exit;
179 }
180
9e70f319 181 /* see if the message is data or a status interrupt */
1da177e4
LT
182 switch (data[0]) {
183 case 0:
f7d7aedf
JS
184 tty = tty_port_tty_get(&port->port);
185 /* rest of message is rx data */
186 if (tty && urb->actual_length) {
8dd03a5b
AC
187 tty_insert_flip_string(tty, data + 1,
188 urb->actual_length - 1);
1da177e4
LT
189 tty_flip_buffer_push(tty);
190 }
f7d7aedf 191 tty_kref_put(tty);
1da177e4
LT
192 break;
193 case 1:
194 /* status interrupt */
195 dbg(" rx int, d1=%d, d2=%d", data[1], data[2]);
196 switch (data[1]) {
197 case 1: /* modemline change */
198 break;
199 case 2: /* tx unthrottle interrupt */
200 priv->tx_throttled = 0;
201 /* queue up a wakeup at scheduler time */
202 schedule_work(&priv->wakeup_work);
203 break;
204 default:
205 break;
206 }
207 break;
208 default:
209 break;
210 }
211
212exit:
9e70f319 213 retval = usb_submit_urb(urb, GFP_ATOMIC);
23189aee 214 if (retval)
4a90f09b
AC
215 dev_err(&port->dev,
216 "%s - usb_submit_urb failed with result %d",
217 __func__, retval);
1da177e4
LT
218}
219
220
95da310e 221static void keyspan_pda_rx_throttle(struct tty_struct *tty)
1da177e4
LT
222{
223 /* stop receiving characters. We just turn off the URB request, and
224 let chars pile up in the device. If we're doing hardware
225 flowcontrol, the device will signal the other end when its buffer
226 fills up. If we're doing XON/XOFF, this would be a good time to
227 send an XOFF, although it might make sense to foist that off
228 upon the device too. */
95da310e 229 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
230 dbg("keyspan_pda_rx_throttle port %d", port->number);
231 usb_kill_urb(port->interrupt_in_urb);
232}
233
234
95da310e 235static void keyspan_pda_rx_unthrottle(struct tty_struct *tty)
1da177e4 236{
95da310e 237 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
238 /* just restart the receive interrupt URB */
239 dbg("keyspan_pda_rx_unthrottle port %d", port->number);
63832515 240 if (usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL))
1da177e4 241 dbg(" usb_submit_urb(read urb) failed");
1da177e4
LT
242}
243
244
9e70f319 245static speed_t keyspan_pda_setbaud(struct usb_serial *serial, speed_t baud)
1da177e4
LT
246{
247 int rc;
248 int bindex;
249
9e70f319
AC
250 switch (baud) {
251 case 110:
252 bindex = 0;
253 break;
254 case 300:
255 bindex = 1;
256 break;
257 case 1200:
258 bindex = 2;
259 break;
260 case 2400:
261 bindex = 3;
262 break;
263 case 4800:
264 bindex = 4;
265 break;
266 case 9600:
267 bindex = 5;
268 break;
269 case 19200:
270 bindex = 6;
271 break;
272 case 38400:
273 bindex = 7;
274 break;
275 case 57600:
276 bindex = 8;
277 break;
278 case 115200:
279 bindex = 9;
280 break;
281 default:
282 bindex = 5; /* Default to 9600 */
283 baud = 9600;
1da177e4
LT
284 }
285
286 /* rather than figure out how to sleep while waiting for this
287 to complete, I just use the "legacy" API. */
288 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
289 0, /* set baud */
9e70f319 290 USB_TYPE_VENDOR
1da177e4
LT
291 | USB_RECIP_INTERFACE
292 | USB_DIR_OUT, /* type */
293 bindex, /* value */
294 0, /* index */
295 NULL, /* &data */
296 0, /* size */
297 2000); /* timeout */
e7806e36
AC
298 if (rc < 0)
299 return 0;
300 return baud;
1da177e4
LT
301}
302
303
95da310e 304static void keyspan_pda_break_ctl(struct tty_struct *tty, int break_state)
1da177e4 305{
95da310e 306 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
307 struct usb_serial *serial = port->serial;
308 int value;
309 int result;
310
311 if (break_state == -1)
312 value = 1; /* start break */
313 else
314 value = 0; /* clear break */
315 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
9e70f319
AC
316 4, /* set break */
317 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
318 value, 0, NULL, 0, 2000);
1da177e4 319 if (result < 0)
9e70f319 320 dbg("%s - error %d from usb_control_msg",
441b62c1 321 __func__, result);
1da177e4
LT
322 /* there is something funky about this.. the TCSBRK that 'cu' performs
323 ought to translate into a break_ctl(-1),break_ctl(0) pair HZ/4
324 seconds apart, but it feels like the break sent isn't as long as it
325 is on /dev/ttyS0 */
326}
327
328
95da310e
AC
329static void keyspan_pda_set_termios(struct tty_struct *tty,
330 struct usb_serial_port *port, struct ktermios *old_termios)
1da177e4
LT
331{
332 struct usb_serial *serial = port->serial;
e7806e36 333 speed_t speed;
1da177e4
LT
334
335 /* cflag specifies lots of stuff: number of stop bits, parity, number
336 of data bits, baud. What can the device actually handle?:
337 CSTOPB (1 stop bit or 2)
338 PARENB (parity)
339 CSIZE (5bit .. 8bit)
340 There is minimal hw support for parity (a PSW bit seems to hold the
341 parity of whatever is in the accumulator). The UART either deals
342 with 10 bits (start, 8 data, stop) or 11 bits (start, 8 data,
343 1 special, stop). So, with firmware changes, we could do:
344 8N1: 10 bit
345 8N2: 11 bit, extra bit always (mark?)
346 8[EOMS]1: 11 bit, extra bit is parity
347 7[EOMS]1: 10 bit, b0/b7 is parity
348 7[EOMS]2: 11 bit, b0/b7 is parity, extra bit always (mark?)
349
350 HW flow control is dictated by the tty->termios->c_cflags & CRTSCTS
351 bit.
352
353 For now, just do baud. */
354
95da310e 355 speed = tty_get_baud_rate(tty);
e7806e36
AC
356 speed = keyspan_pda_setbaud(serial, speed);
357
358 if (speed == 0) {
359 dbg("can't handle requested baud rate");
360 /* It hasn't changed so.. */
361 speed = tty_termios_baud_rate(old_termios);
1da177e4 362 }
e7806e36
AC
363 /* Only speed can change so copy the old h/w parameters
364 then encode the new speed */
95da310e
AC
365 tty_termios_copy_hw(tty->termios, old_termios);
366 tty_encode_baud_rate(tty, speed, speed);
1da177e4
LT
367}
368
369
370/* modem control pins: DTR and RTS are outputs and can be controlled.
371 DCD, RI, DSR, CTS are inputs and can be read. All outputs can also be
372 read. The byte passed is: DTR(b7) DCD RI DSR CTS RTS(b2) unused unused */
373
374static int keyspan_pda_get_modem_info(struct usb_serial *serial,
375 unsigned char *value)
376{
377 int rc;
ca65d256
JH
378 u8 *data;
379
380 data = kmalloc(1, GFP_KERNEL);
381 if (!data)
382 return -ENOMEM;
383
1da177e4
LT
384 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
385 3, /* get pins */
386 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_IN,
ca65d256 387 0, 0, data, 1, 2000);
3b36a8fd 388 if (rc >= 0)
ca65d256
JH
389 *value = *data;
390
391 kfree(data);
1da177e4
LT
392 return rc;
393}
394
395
396static int keyspan_pda_set_modem_info(struct usb_serial *serial,
397 unsigned char value)
398{
399 int rc;
400 rc = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
401 3, /* set pins */
402 USB_TYPE_VENDOR|USB_RECIP_INTERFACE|USB_DIR_OUT,
403 value, 0, NULL, 0, 2000);
404 return rc;
405}
406
60b33c13 407static int keyspan_pda_tiocmget(struct tty_struct *tty)
1da177e4 408{
95da310e 409 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
410 struct usb_serial *serial = port->serial;
411 int rc;
412 unsigned char status;
413 int value;
414
415 rc = keyspan_pda_get_modem_info(serial, &status);
416 if (rc < 0)
417 return rc;
418 value =
419 ((status & (1<<7)) ? TIOCM_DTR : 0) |
420 ((status & (1<<6)) ? TIOCM_CAR : 0) |
421 ((status & (1<<5)) ? TIOCM_RNG : 0) |
422 ((status & (1<<4)) ? TIOCM_DSR : 0) |
423 ((status & (1<<3)) ? TIOCM_CTS : 0) |
424 ((status & (1<<2)) ? TIOCM_RTS : 0);
425 return value;
426}
427
20b9d177 428static int keyspan_pda_tiocmset(struct tty_struct *tty,
1da177e4
LT
429 unsigned int set, unsigned int clear)
430{
95da310e 431 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
432 struct usb_serial *serial = port->serial;
433 int rc;
434 unsigned char status;
435
436 rc = keyspan_pda_get_modem_info(serial, &status);
437 if (rc < 0)
438 return rc;
439
440 if (set & TIOCM_RTS)
441 status |= (1<<2);
442 if (set & TIOCM_DTR)
443 status |= (1<<7);
444
445 if (clear & TIOCM_RTS)
446 status &= ~(1<<2);
447 if (clear & TIOCM_DTR)
448 status &= ~(1<<7);
449 rc = keyspan_pda_set_modem_info(serial, status);
450 return rc;
451}
452
95da310e
AC
453static int keyspan_pda_write(struct tty_struct *tty,
454 struct usb_serial_port *port, const unsigned char *buf, int count)
1da177e4
LT
455{
456 struct usb_serial *serial = port->serial;
457 int request_unthrottle = 0;
458 int rc = 0;
459 struct keyspan_pda_private *priv;
460
461 priv = usb_get_serial_port_data(port);
462 /* guess how much room is left in the device's ring buffer, and if we
463 want to send more than that, check first, updating our notion of
464 what is left. If our write will result in no room left, ask the
465 device to give us an interrupt when the room available rises above
466 a threshold, and hold off all writers (eventually, those using
467 select() or poll() too) until we receive that unthrottle interrupt.
468 Block if we can't write anything at all, otherwise write as much as
469 we can. */
9e70f319 470 dbg("keyspan_pda_write(%d)", count);
1da177e4
LT
471 if (count == 0) {
472 dbg(" write request of 0 bytes");
9e70f319 473 return 0;
1da177e4
LT
474 }
475
476 /* we might block because of:
477 the TX urb is in-flight (wait until it completes)
478 the device is full (wait until it says there is room)
479 */
e81ee637 480 spin_lock_bh(&port->lock);
da280e34 481 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled) {
e81ee637 482 spin_unlock_bh(&port->lock);
507ca9bc 483 return 0;
1da177e4 484 }
da280e34 485 clear_bit(0, &port->write_urbs_free);
e81ee637 486 spin_unlock_bh(&port->lock);
1da177e4
LT
487
488 /* At this point the URB is in our control, nobody else can submit it
489 again (the only sudden transition was the one from EINPROGRESS to
490 finished). Also, the tx process is not throttled. So we are
491 ready to write. */
492
493 count = (count > port->bulk_out_size) ? port->bulk_out_size : count;
494
495 /* Check if we might overrun the Tx buffer. If so, ask the
496 device how much room it really has. This is done only on
497 scheduler time, since usb_control_msg() sleeps. */
498 if (count > priv->tx_room && !in_interrupt()) {
ca65d256
JH
499 u8 *room;
500
501 room = kmalloc(1, GFP_KERNEL);
502 if (!room) {
503 rc = -ENOMEM;
504 goto exit;
505 }
506
9e70f319 507 rc = usb_control_msg(serial->dev,
1da177e4
LT
508 usb_rcvctrlpipe(serial->dev, 0),
509 6, /* write_room */
510 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
511 | USB_DIR_IN,
512 0, /* value: 0 means "remaining room" */
513 0, /* index */
ca65d256 514 room,
1da177e4
LT
515 1,
516 2000);
ca65d256
JH
517 if (rc > 0) {
518 dbg(" roomquery says %d", *room);
519 priv->tx_room = *room;
520 }
521 kfree(room);
1da177e4
LT
522 if (rc < 0) {
523 dbg(" roomquery failed");
524 goto exit;
525 }
526 if (rc == 0) {
527 dbg(" roomquery returned 0 bytes");
528 rc = -EIO; /* device didn't return any data */
529 goto exit;
530 }
1da177e4
LT
531 }
532 if (count > priv->tx_room) {
533 /* we're about to completely fill the Tx buffer, so
534 we'll be throttled afterwards. */
535 count = priv->tx_room;
536 request_unthrottle = 1;
537 }
538
539 if (count) {
540 /* now transfer data */
9e70f319 541 memcpy(port->write_urb->transfer_buffer, buf, count);
1da177e4
LT
542 /* send the data out the bulk port */
543 port->write_urb->transfer_buffer_length = count;
507ca9bc 544
1da177e4
LT
545 priv->tx_room -= count;
546
1da177e4
LT
547 rc = usb_submit_urb(port->write_urb, GFP_ATOMIC);
548 if (rc) {
549 dbg(" usb_submit_urb(write bulk) failed");
550 goto exit;
551 }
9e70f319 552 } else {
1da177e4
LT
553 /* There wasn't any room left, so we are throttled until
554 the buffer empties a bit */
555 request_unthrottle = 1;
556 }
557
558 if (request_unthrottle) {
559 priv->tx_throttled = 1; /* block writers */
560 schedule_work(&priv->unthrottle_work);
561 }
562
563 rc = count;
564exit:
507ca9bc 565 if (rc < 0)
da280e34 566 set_bit(0, &port->write_urbs_free);
1da177e4
LT
567 return rc;
568}
569
570
9e70f319 571static void keyspan_pda_write_bulk_callback(struct urb *urb)
1da177e4 572{
cdc97792 573 struct usb_serial_port *port = urb->context;
1da177e4
LT
574 struct keyspan_pda_private *priv;
575
da280e34 576 set_bit(0, &port->write_urbs_free);
1da177e4
LT
577 priv = usb_get_serial_port_data(port);
578
579 /* queue up a wakeup at scheduler time */
580 schedule_work(&priv->wakeup_work);
581}
582
583
95da310e 584static int keyspan_pda_write_room(struct tty_struct *tty)
1da177e4 585{
95da310e 586 struct usb_serial_port *port = tty->driver_data;
1da177e4 587 struct keyspan_pda_private *priv;
1da177e4 588 priv = usb_get_serial_port_data(port);
1da177e4
LT
589 /* used by n_tty.c for processing of tabs and such. Giving it our
590 conservative guess is probably good enough, but needs testing by
591 running a console through the device. */
9e70f319 592 return priv->tx_room;
1da177e4
LT
593}
594
595
95da310e 596static int keyspan_pda_chars_in_buffer(struct tty_struct *tty)
1da177e4 597{
95da310e 598 struct usb_serial_port *port = tty->driver_data;
1da177e4 599 struct keyspan_pda_private *priv;
a5b6f60c
AC
600 unsigned long flags;
601 int ret = 0;
507ca9bc 602
1da177e4 603 priv = usb_get_serial_port_data(port);
507ca9bc 604
1da177e4
LT
605 /* when throttled, return at least WAKEUP_CHARS to tell select() (via
606 n_tty.c:normal_poll() ) that we're not writeable. */
a5b6f60c
AC
607
608 spin_lock_irqsave(&port->lock, flags);
da280e34 609 if (!test_bit(0, &port->write_urbs_free) || priv->tx_throttled)
a5b6f60c
AC
610 ret = 256;
611 spin_unlock_irqrestore(&port->lock, flags);
612 return ret;
1da177e4
LT
613}
614
615
335f8514
AC
616static void keyspan_pda_dtr_rts(struct usb_serial_port *port, int on)
617{
618 struct usb_serial *serial = port->serial;
619
620 if (serial->dev) {
621 if (on)
622 keyspan_pda_set_modem_info(serial, (1<<7) | (1<< 2));
623 else
624 keyspan_pda_set_modem_info(serial, 0);
625 }
626}
627
335f8514 628
95da310e 629static int keyspan_pda_open(struct tty_struct *tty,
a509a7e4 630 struct usb_serial_port *port)
1da177e4
LT
631{
632 struct usb_serial *serial = port->serial;
ca65d256 633 u8 *room;
1da177e4
LT
634 int rc = 0;
635 struct keyspan_pda_private *priv;
636
637 /* find out how much room is in the Tx ring */
ca65d256
JH
638 room = kmalloc(1, GFP_KERNEL);
639 if (!room)
640 return -ENOMEM;
641
1da177e4
LT
642 rc = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
643 6, /* write_room */
644 USB_TYPE_VENDOR | USB_RECIP_INTERFACE
645 | USB_DIR_IN,
646 0, /* value */
647 0, /* index */
ca65d256 648 room,
1da177e4
LT
649 1,
650 2000);
651 if (rc < 0) {
441b62c1 652 dbg("%s - roomquery failed", __func__);
1da177e4
LT
653 goto error;
654 }
655 if (rc == 0) {
441b62c1 656 dbg("%s - roomquery returned 0 bytes", __func__);
1da177e4
LT
657 rc = -EIO;
658 goto error;
659 }
660 priv = usb_get_serial_port_data(port);
ca65d256
JH
661 priv->tx_room = *room;
662 priv->tx_throttled = *room ? 0 : 1;
1da177e4 663
1da177e4 664 /*Start reading from the device*/
1da177e4
LT
665 rc = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
666 if (rc) {
441b62c1 667 dbg("%s - usb_submit_urb(read int) failed", __func__);
1da177e4
LT
668 goto error;
669 }
1da177e4 670error:
ca65d256 671 kfree(room);
1da177e4
LT
672 return rc;
673}
335f8514 674static void keyspan_pda_close(struct usb_serial_port *port)
1da177e4
LT
675{
676 struct usb_serial *serial = port->serial;
677
678 if (serial->dev) {
1da177e4
LT
679 /* shutdown our bulk reads and writes */
680 usb_kill_urb(port->write_urb);
681 usb_kill_urb(port->interrupt_in_urb);
682 }
683}
684
685
686/* download the firmware to a "fake" device (pre-renumeration) */
9e70f319 687static int keyspan_pda_fake_startup(struct usb_serial *serial)
1da177e4
LT
688{
689 int response;
3edbf98b
DW
690 const char *fw_name;
691 const struct ihex_binrec *record;
692 const struct firmware *fw;
1da177e4
LT
693
694 /* download the firmware here ... */
695 response = ezusb_set_reset(serial, 1);
696
3edbf98b 697 if (0) { ; }
1da177e4 698#ifdef KEYSPAN
3edbf98b
DW
699 else if (le16_to_cpu(serial->dev->descriptor.idVendor) == KEYSPAN_VENDOR_ID)
700 fw_name = "keyspan_pda/keyspan_pda.fw";
1da177e4
LT
701#endif
702#ifdef XIRCOM
3edbf98b
DW
703 else if ((le16_to_cpu(serial->dev->descriptor.idVendor) == XIRCOM_VENDOR_ID) ||
704 (le16_to_cpu(serial->dev->descriptor.idVendor) == ENTREGRA_VENDOR_ID))
705 fw_name = "keyspan_pda/xircom_pgs.fw";
1da177e4 706#endif
3edbf98b 707 else {
194343d9
GKH
708 dev_err(&serial->dev->dev, "%s: unknown vendor, aborting.\n",
709 __func__);
1da177e4
LT
710 return -ENODEV;
711 }
3edbf98b 712 if (request_ihex_firmware(&fw, fw_name, &serial->dev->dev)) {
194343d9
GKH
713 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
714 fw_name);
3edbf98b
DW
715 return -ENOENT;
716 }
717 record = (const struct ihex_binrec *)fw->data;
1da177e4 718
3edbf98b
DW
719 while (record) {
720 response = ezusb_writememory(serial, be32_to_cpu(record->addr),
1da177e4 721 (unsigned char *)record->data,
3edbf98b 722 be16_to_cpu(record->len), 0xa0);
1da177e4 723 if (response < 0) {
194343d9
GKH
724 dev_err(&serial->dev->dev, "ezusb_writememory failed "
725 "for Keyspan PDA firmware (%d %04X %p %d)\n",
726 response, be32_to_cpu(record->addr),
727 record->data, be16_to_cpu(record->len));
1da177e4
LT
728 break;
729 }
3edbf98b 730 record = ihex_next_binrec(record);
1da177e4 731 }
3edbf98b 732 release_firmware(fw);
1da177e4
LT
733 /* bring device out of reset. Renumeration will occur in a moment
734 and the new device will bind to the real driver */
735 response = ezusb_set_reset(serial, 0);
736
737 /* we want this device to fail to have a driver assigned to it. */
9e70f319 738 return 1;
1da177e4
LT
739}
740
e6c4ef98
BH
741#ifdef KEYSPAN
742MODULE_FIRMWARE("keyspan_pda/keyspan_pda.fw");
743#endif
744#ifdef XIRCOM
745MODULE_FIRMWARE("keyspan_pda/xircom_pgs.fw");
746#endif
747
9e70f319 748static int keyspan_pda_startup(struct usb_serial *serial)
1da177e4
LT
749{
750
751 struct keyspan_pda_private *priv;
752
753 /* allocate the private data structures for all ports. Well, for all
754 one ports. */
755
756 priv = kmalloc(sizeof(struct keyspan_pda_private), GFP_KERNEL);
757 if (!priv)
9e70f319 758 return 1; /* error */
1da177e4
LT
759 usb_set_serial_port_data(serial->port[0], priv);
760 init_waitqueue_head(&serial->port[0]->write_wait);
c4028958
DH
761 INIT_WORK(&priv->wakeup_work, keyspan_pda_wakeup_write);
762 INIT_WORK(&priv->unthrottle_work, keyspan_pda_request_unthrottle);
763 priv->serial = serial;
764 priv->port = serial->port[0];
9e70f319 765 return 0;
1da177e4
LT
766}
767
f9c99bb8 768static void keyspan_pda_release(struct usb_serial *serial)
1da177e4 769{
441b62c1 770 dbg("%s", __func__);
9e70f319 771
1da177e4
LT
772 kfree(usb_get_serial_port_data(serial->port[0]));
773}
774
775#ifdef KEYSPAN
ea65370d 776static struct usb_serial_driver keyspan_pda_fake_device = {
18fcac35
GKH
777 .driver = {
778 .owner = THIS_MODULE,
269bda1c 779 .name = "keyspan_pda_pre",
18fcac35 780 },
269bda1c 781 .description = "Keyspan PDA - (prerenumeration)",
d9b1b787 782 .usb_driver = &keyspan_pda_driver,
1da177e4 783 .id_table = id_table_fake,
1da177e4
LT
784 .num_ports = 1,
785 .attach = keyspan_pda_fake_startup,
786};
787#endif
788
789#ifdef XIRCOM
ea65370d 790static struct usb_serial_driver xircom_pgs_fake_device = {
18fcac35
GKH
791 .driver = {
792 .owner = THIS_MODULE,
269bda1c 793 .name = "xircom_no_firm",
18fcac35 794 },
269bda1c 795 .description = "Xircom / Entregra PGS - (prerenumeration)",
d9b1b787 796 .usb_driver = &keyspan_pda_driver,
1da177e4 797 .id_table = id_table_fake_xircom,
1da177e4
LT
798 .num_ports = 1,
799 .attach = keyspan_pda_fake_startup,
800};
801#endif
802
ea65370d 803static struct usb_serial_driver keyspan_pda_device = {
18fcac35
GKH
804 .driver = {
805 .owner = THIS_MODULE,
269bda1c 806 .name = "keyspan_pda",
18fcac35 807 },
269bda1c 808 .description = "Keyspan PDA",
d9b1b787 809 .usb_driver = &keyspan_pda_driver,
1da177e4 810 .id_table = id_table_std,
1da177e4 811 .num_ports = 1,
335f8514 812 .dtr_rts = keyspan_pda_dtr_rts,
1da177e4
LT
813 .open = keyspan_pda_open,
814 .close = keyspan_pda_close,
815 .write = keyspan_pda_write,
816 .write_room = keyspan_pda_write_room,
817 .write_bulk_callback = keyspan_pda_write_bulk_callback,
818 .read_int_callback = keyspan_pda_rx_interrupt,
819 .chars_in_buffer = keyspan_pda_chars_in_buffer,
820 .throttle = keyspan_pda_rx_throttle,
821 .unthrottle = keyspan_pda_rx_unthrottle,
1da177e4
LT
822 .set_termios = keyspan_pda_set_termios,
823 .break_ctl = keyspan_pda_break_ctl,
824 .tiocmget = keyspan_pda_tiocmget,
825 .tiocmset = keyspan_pda_tiocmset,
826 .attach = keyspan_pda_startup,
f9c99bb8 827 .release = keyspan_pda_release,
1da177e4
LT
828};
829
830
9e70f319 831static int __init keyspan_pda_init(void)
1da177e4
LT
832{
833 int retval;
834 retval = usb_serial_register(&keyspan_pda_device);
835 if (retval)
836 goto failed_pda_register;
837#ifdef KEYSPAN
838 retval = usb_serial_register(&keyspan_pda_fake_device);
839 if (retval)
840 goto failed_pda_fake_register;
841#endif
842#ifdef XIRCOM
843 retval = usb_serial_register(&xircom_pgs_fake_device);
844 if (retval)
845 goto failed_xircom_register;
846#endif
847 retval = usb_register(&keyspan_pda_driver);
848 if (retval)
849 goto failed_usb_register;
c197a8db
GKH
850 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
851 DRIVER_DESC "\n");
1da177e4 852 return 0;
9e70f319 853failed_usb_register:
1da177e4
LT
854#ifdef XIRCOM
855 usb_serial_deregister(&xircom_pgs_fake_device);
856failed_xircom_register:
857#endif /* XIRCOM */
858#ifdef KEYSPAN
859 usb_serial_deregister(&keyspan_pda_fake_device);
860#endif
861#ifdef KEYSPAN
862failed_pda_fake_register:
863#endif
864 usb_serial_deregister(&keyspan_pda_device);
865failed_pda_register:
866 return retval;
867}
868
869
9e70f319 870static void __exit keyspan_pda_exit(void)
1da177e4 871{
9e70f319
AC
872 usb_deregister(&keyspan_pda_driver);
873 usb_serial_deregister(&keyspan_pda_device);
1da177e4 874#ifdef KEYSPAN
9e70f319 875 usb_serial_deregister(&keyspan_pda_fake_device);
1da177e4
LT
876#endif
877#ifdef XIRCOM
9e70f319 878 usb_serial_deregister(&xircom_pgs_fake_device);
1da177e4
LT
879#endif
880}
881
882
883module_init(keyspan_pda_init);
884module_exit(keyspan_pda_exit);
885
9e70f319
AC
886MODULE_AUTHOR(DRIVER_AUTHOR);
887MODULE_DESCRIPTION(DRIVER_DESC);
1da177e4
LT
888MODULE_LICENSE("GPL");
889
890module_param(debug, bool, S_IRUGO | S_IWUSR);
891MODULE_PARM_DESC(debug, "Debug enabled or not");
892
This page took 0.731371 seconds and 5 git commands to generate.