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