Merge branch 'fluff' into release
[linux-2.6/sactl.git] / drivers / usb / serial / keyspan.c
blob9878c0fb3859f201345a2171459d31a55baf8831
1 /*
2 Keyspan USB to Serial Converter driver
4 (C) Copyright (C) 2000-2001 Hugh Blemings <hugh@blemings.org>
5 (C) Copyright (C) 2002 Greg Kroah-Hartman <greg@kroah.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 See http://misc.nu/hugh/keyspan.html for more information.
14 Code in this driver inspired by and in a number of places taken
15 from Brian Warner's original Keyspan-PDA driver.
17 This driver has been put together with the support of Innosys, Inc.
18 and Keyspan, Inc the manufacturers of the Keyspan USB-serial products.
19 Thanks Guys :)
21 Thanks to Paulus for miscellaneous tidy ups, some largish chunks
22 of much nicer and/or completely new code and (perhaps most uniquely)
23 having the patience to sit down and explain why and where he'd changed
24 stuff.
26 Tip 'o the hat to IBM (and previously Linuxcare :) for supporting
27 staff in their work on open source projects.
29 Change History
31 2003sep04 LPM (Keyspan) add support for new single port product USA19HS.
32 Improve setup message handling for all devices.
34 Wed Feb 19 22:00:00 PST 2003 (Jeffrey S. Laing <keyspan@jsl.com>)
35 Merged the current (1/31/03) Keyspan code with the current (2.4.21-pre4)
36 Linux source tree. The Linux tree lacked support for the 49WLC and
37 others. The Keyspan patches didn't work with the current kernel.
39 2003jan30 LPM add support for the 49WLC and MPR
41 Wed Apr 25 12:00:00 PST 2002 (Keyspan)
42 Started with Hugh Blemings' code dated Jan 17, 2002. All adapters
43 now supported (including QI and QW). Modified port open, port
44 close, and send setup() logic to fix various data and endpoint
45 synchronization bugs and device LED status bugs. Changed keyspan_
46 write_room() to accurately return transmit buffer availability.
47 Changed forwardingLength from 1 to 16 for all adapters.
49 Fri Oct 12 16:45:00 EST 2001
50 Preliminary USA-19QI and USA-28 support (both test OK for me, YMMV)
52 Wed Apr 25 12:00:00 PST 2002 (Keyspan)
53 Started with Hugh Blemings' code dated Jan 17, 2002. All adapters
54 now supported (including QI and QW). Modified port open, port
55 close, and send setup() logic to fix various data and endpoint
56 synchronization bugs and device LED status bugs. Changed keyspan_
57 write_room() to accurately return transmit buffer availability.
58 Changed forwardingLength from 1 to 16 for all adapters.
60 Fri Oct 12 16:45:00 EST 2001
61 Preliminary USA-19QI and USA-28 support (both test OK for me, YMMV)
63 Mon Oct 8 14:29:00 EST 2001 hugh
64 Fixed bug that prevented mulitport devices operating correctly
65 if they weren't the first unit attached.
67 Sat Oct 6 12:31:21 EST 2001 hugh
68 Added support for USA-28XA and -28XB, misc cleanups, break support
69 for usa26 based models thanks to David Gibson.
71 Thu May 31 11:56:42 PDT 2001 gkh
72 switched from using spinlock to a semaphore
74 (04/08/2001) gb
75 Identify version on module load.
77 (11/01/2000) Adam J. Richter
78 usb_device_id table support.
80 Tue Oct 10 23:15:33 EST 2000 Hugh
81 Merged Paul's changes with my USA-49W mods. Work in progress
82 still...
84 Wed Jul 19 14:00:42 EST 2000 gkh
85 Added module_init and module_exit functions to handle the fact that
86 this driver is a loadable module now.
88 Tue Jul 18 16:14:52 EST 2000 Hugh
89 Basic character input/output for USA-19 now mostly works,
90 fixed at 9600 baud for the moment.
92 Sat Jul 8 11:11:48 EST 2000 Hugh
93 First public release - nothing works except the firmware upload.
94 Tested on PPC and x86 architectures, seems to behave...
98 #include <linux/kernel.h>
99 #include <linux/jiffies.h>
100 #include <linux/errno.h>
101 #include <linux/init.h>
102 #include <linux/slab.h>
103 #include <linux/tty.h>
104 #include <linux/tty_driver.h>
105 #include <linux/tty_flip.h>
106 #include <linux/module.h>
107 #include <linux/spinlock.h>
108 #include <linux/firmware.h>
109 #include <linux/ihex.h>
110 #include <linux/uaccess.h>
111 #include <linux/usb.h>
112 #include <linux/usb/serial.h>
113 #include "keyspan.h"
115 static int debug;
118 * Version Information
120 #define DRIVER_VERSION "v1.1.5"
121 #define DRIVER_AUTHOR "Hugh Blemings <hugh@misc.nu"
122 #define DRIVER_DESC "Keyspan USB to Serial Converter Driver"
124 #define INSTAT_BUFLEN 32
125 #define GLOCONT_BUFLEN 64
126 #define INDAT49W_BUFLEN 512
128 /* Per device and per port private data */
129 struct keyspan_serial_private {
130 const struct keyspan_device_details *device_details;
132 struct urb *instat_urb;
133 char instat_buf[INSTAT_BUFLEN];
135 /* added to support 49wg, where data from all 4 ports comes in
136 on 1 EP and high-speed supported */
137 struct urb *indat_urb;
138 char indat_buf[INDAT49W_BUFLEN];
140 /* XXX this one probably will need a lock */
141 struct urb *glocont_urb;
142 char glocont_buf[GLOCONT_BUFLEN];
143 char ctrl_buf[8]; /* for EP0 control message */
146 struct keyspan_port_private {
147 /* Keep track of which input & output endpoints to use */
148 int in_flip;
149 int out_flip;
151 /* Keep duplicate of device details in each port
152 structure as well - simplifies some of the
153 callback functions etc. */
154 const struct keyspan_device_details *device_details;
156 /* Input endpoints and buffer for this port */
157 struct urb *in_urbs[2];
158 char in_buffer[2][64];
159 /* Output endpoints and buffer for this port */
160 struct urb *out_urbs[2];
161 char out_buffer[2][64];
163 /* Input ack endpoint */
164 struct urb *inack_urb;
165 char inack_buffer[1];
167 /* Output control endpoint */
168 struct urb *outcont_urb;
169 char outcont_buffer[64];
171 /* Settings for the port */
172 int baud;
173 int old_baud;
174 unsigned int cflag;
175 unsigned int old_cflag;
176 enum {flow_none, flow_cts, flow_xon} flow_control;
177 int rts_state; /* Handshaking pins (outputs) */
178 int dtr_state;
179 int cts_state; /* Handshaking pins (inputs) */
180 int dsr_state;
181 int dcd_state;
182 int ri_state;
183 int break_on;
185 unsigned long tx_start_time[2];
186 int resend_cont; /* need to resend control packet */
189 /* Include Keyspan message headers. All current Keyspan Adapters
190 make use of one of five message formats which are referred
191 to as USA-26, USA-28, USA-49, USA-90, USA-67 by Keyspan and
192 within this driver. */
193 #include "keyspan_usa26msg.h"
194 #include "keyspan_usa28msg.h"
195 #include "keyspan_usa49msg.h"
196 #include "keyspan_usa90msg.h"
197 #include "keyspan_usa67msg.h"
200 /* Functions used by new usb-serial code. */
201 static int __init keyspan_init(void)
203 int retval;
204 retval = usb_serial_register(&keyspan_pre_device);
205 if (retval)
206 goto failed_pre_device_register;
207 retval = usb_serial_register(&keyspan_1port_device);
208 if (retval)
209 goto failed_1port_device_register;
210 retval = usb_serial_register(&keyspan_2port_device);
211 if (retval)
212 goto failed_2port_device_register;
213 retval = usb_serial_register(&keyspan_4port_device);
214 if (retval)
215 goto failed_4port_device_register;
216 retval = usb_register(&keyspan_driver);
217 if (retval)
218 goto failed_usb_register;
220 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
221 DRIVER_DESC "\n");
223 return 0;
224 failed_usb_register:
225 usb_serial_deregister(&keyspan_4port_device);
226 failed_4port_device_register:
227 usb_serial_deregister(&keyspan_2port_device);
228 failed_2port_device_register:
229 usb_serial_deregister(&keyspan_1port_device);
230 failed_1port_device_register:
231 usb_serial_deregister(&keyspan_pre_device);
232 failed_pre_device_register:
233 return retval;
236 static void __exit keyspan_exit(void)
238 usb_deregister(&keyspan_driver);
239 usb_serial_deregister(&keyspan_pre_device);
240 usb_serial_deregister(&keyspan_1port_device);
241 usb_serial_deregister(&keyspan_2port_device);
242 usb_serial_deregister(&keyspan_4port_device);
245 module_init(keyspan_init);
246 module_exit(keyspan_exit);
248 static void keyspan_break_ctl(struct tty_struct *tty, int break_state)
250 struct usb_serial_port *port = tty->driver_data;
251 struct keyspan_port_private *p_priv;
253 dbg("%s", __func__);
255 p_priv = usb_get_serial_port_data(port);
257 if (break_state == -1)
258 p_priv->break_on = 1;
259 else
260 p_priv->break_on = 0;
262 keyspan_send_setup(port, 0);
266 static void keyspan_set_termios(struct tty_struct *tty,
267 struct usb_serial_port *port, struct ktermios *old_termios)
269 int baud_rate, device_port;
270 struct keyspan_port_private *p_priv;
271 const struct keyspan_device_details *d_details;
272 unsigned int cflag;
274 dbg("%s", __func__);
276 p_priv = usb_get_serial_port_data(port);
277 d_details = p_priv->device_details;
278 cflag = tty->termios->c_cflag;
279 device_port = port->number - port->serial->minor;
281 /* Baud rate calculation takes baud rate as an integer
282 so other rates can be generated if desired. */
283 baud_rate = tty_get_baud_rate(tty);
284 /* If no match or invalid, don't change */
285 if (d_details->calculate_baud_rate(baud_rate, d_details->baudclk,
286 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
287 /* FIXME - more to do here to ensure rate changes cleanly */
288 /* FIXME - calcuate exact rate from divisor ? */
289 p_priv->baud = baud_rate;
290 } else
291 baud_rate = tty_termios_baud_rate(old_termios);
293 tty_encode_baud_rate(tty, baud_rate, baud_rate);
294 /* set CTS/RTS handshake etc. */
295 p_priv->cflag = cflag;
296 p_priv->flow_control = (cflag & CRTSCTS)? flow_cts: flow_none;
298 /* Mark/Space not supported */
299 tty->termios->c_cflag &= ~CMSPAR;
301 keyspan_send_setup(port, 0);
304 static int keyspan_tiocmget(struct tty_struct *tty, struct file *file)
306 struct usb_serial_port *port = tty->driver_data;
307 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
308 unsigned int value;
310 value = ((p_priv->rts_state) ? TIOCM_RTS : 0) |
311 ((p_priv->dtr_state) ? TIOCM_DTR : 0) |
312 ((p_priv->cts_state) ? TIOCM_CTS : 0) |
313 ((p_priv->dsr_state) ? TIOCM_DSR : 0) |
314 ((p_priv->dcd_state) ? TIOCM_CAR : 0) |
315 ((p_priv->ri_state) ? TIOCM_RNG : 0);
317 return value;
320 static int keyspan_tiocmset(struct tty_struct *tty, struct file *file,
321 unsigned int set, unsigned int clear)
323 struct usb_serial_port *port = tty->driver_data;
324 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
326 if (set & TIOCM_RTS)
327 p_priv->rts_state = 1;
328 if (set & TIOCM_DTR)
329 p_priv->dtr_state = 1;
330 if (clear & TIOCM_RTS)
331 p_priv->rts_state = 0;
332 if (clear & TIOCM_DTR)
333 p_priv->dtr_state = 0;
334 keyspan_send_setup(port, 0);
335 return 0;
338 /* Write function is similar for the four protocols used
339 with only a minor change for usa90 (usa19hs) required */
340 static int keyspan_write(struct tty_struct *tty,
341 struct usb_serial_port *port, const unsigned char *buf, int count)
343 struct keyspan_port_private *p_priv;
344 const struct keyspan_device_details *d_details;
345 int flip;
346 int left, todo;
347 struct urb *this_urb;
348 int err, maxDataLen, dataOffset;
350 p_priv = usb_get_serial_port_data(port);
351 d_details = p_priv->device_details;
353 if (d_details->msg_format == msg_usa90) {
354 maxDataLen = 64;
355 dataOffset = 0;
356 } else {
357 maxDataLen = 63;
358 dataOffset = 1;
361 dbg("%s - for port %d (%d chars), flip=%d",
362 __func__, port->number, count, p_priv->out_flip);
364 for (left = count; left > 0; left -= todo) {
365 todo = left;
366 if (todo > maxDataLen)
367 todo = maxDataLen;
369 flip = p_priv->out_flip;
371 /* Check we have a valid urb/endpoint before we use it... */
372 this_urb = p_priv->out_urbs[flip];
373 if (this_urb == NULL) {
374 /* no bulk out, so return 0 bytes written */
375 dbg("%s - no output urb :(", __func__);
376 return count;
379 dbg("%s - endpoint %d flip %d",
380 __func__, usb_pipeendpoint(this_urb->pipe), flip);
382 if (this_urb->status == -EINPROGRESS) {
383 if (time_before(jiffies,
384 p_priv->tx_start_time[flip] + 10 * HZ))
385 break;
386 usb_unlink_urb(this_urb);
387 break;
390 /* First byte in buffer is "last flag" (except for usa19hx)
391 - unused so for now so set to zero */
392 ((char *)this_urb->transfer_buffer)[0] = 0;
394 memcpy(this_urb->transfer_buffer + dataOffset, buf, todo);
395 buf += todo;
397 /* send the data out the bulk port */
398 this_urb->transfer_buffer_length = todo + dataOffset;
400 this_urb->dev = port->serial->dev;
401 err = usb_submit_urb(this_urb, GFP_ATOMIC);
402 if (err != 0)
403 dbg("usb_submit_urb(write bulk) failed (%d)", err);
404 p_priv->tx_start_time[flip] = jiffies;
406 /* Flip for next time if usa26 or usa28 interface
407 (not used on usa49) */
408 p_priv->out_flip = (flip + 1) & d_details->outdat_endp_flip;
411 return count - left;
414 static void usa26_indat_callback(struct urb *urb)
416 int i, err;
417 int endpoint;
418 struct usb_serial_port *port;
419 struct tty_struct *tty;
420 unsigned char *data = urb->transfer_buffer;
421 int status = urb->status;
423 dbg("%s", __func__);
425 endpoint = usb_pipeendpoint(urb->pipe);
427 if (status) {
428 dbg("%s - nonzero status: %x on endpoint %d.",
429 __func__, status, endpoint);
430 return;
433 port = urb->context;
434 tty = tty_port_tty_get(&port->port);
435 if (tty && urb->actual_length) {
436 /* 0x80 bit is error flag */
437 if ((data[0] & 0x80) == 0) {
438 /* no errors on individual bytes, only
439 possible overrun err */
440 if (data[0] & RXERROR_OVERRUN)
441 err = TTY_OVERRUN;
442 else
443 err = 0;
444 for (i = 1; i < urb->actual_length ; ++i)
445 tty_insert_flip_char(tty, data[i], err);
446 } else {
447 /* some bytes had errors, every byte has status */
448 dbg("%s - RX error!!!!", __func__);
449 for (i = 0; i + 1 < urb->actual_length; i += 2) {
450 int stat = data[i], flag = 0;
451 if (stat & RXERROR_OVERRUN)
452 flag |= TTY_OVERRUN;
453 if (stat & RXERROR_FRAMING)
454 flag |= TTY_FRAME;
455 if (stat & RXERROR_PARITY)
456 flag |= TTY_PARITY;
457 /* XXX should handle break (0x10) */
458 tty_insert_flip_char(tty, data[i+1], flag);
461 tty_flip_buffer_push(tty);
463 tty_kref_put(tty);
465 /* Resubmit urb so we continue receiving */
466 urb->dev = port->serial->dev;
467 if (port->port.count) {
468 err = usb_submit_urb(urb, GFP_ATOMIC);
469 if (err != 0)
470 dbg("%s - resubmit read urb failed. (%d)",
471 __func__, err);
473 return;
476 /* Outdat handling is common for all devices */
477 static void usa2x_outdat_callback(struct urb *urb)
479 struct usb_serial_port *port;
480 struct keyspan_port_private *p_priv;
482 port = urb->context;
483 p_priv = usb_get_serial_port_data(port);
484 dbg("%s - urb %d", __func__, urb == p_priv->out_urbs[1]);
486 if (port->port.count)
487 usb_serial_port_softint(port);
490 static void usa26_inack_callback(struct urb *urb)
492 dbg("%s", __func__);
496 static void usa26_outcont_callback(struct urb *urb)
498 struct usb_serial_port *port;
499 struct keyspan_port_private *p_priv;
501 port = urb->context;
502 p_priv = usb_get_serial_port_data(port);
504 if (p_priv->resend_cont) {
505 dbg("%s - sending setup", __func__);
506 keyspan_usa26_send_setup(port->serial, port,
507 p_priv->resend_cont - 1);
511 static void usa26_instat_callback(struct urb *urb)
513 unsigned char *data = urb->transfer_buffer;
514 struct keyspan_usa26_portStatusMessage *msg;
515 struct usb_serial *serial;
516 struct usb_serial_port *port;
517 struct keyspan_port_private *p_priv;
518 struct tty_struct *tty;
519 int old_dcd_state, err;
520 int status = urb->status;
522 serial = urb->context;
524 if (status) {
525 dbg("%s - nonzero status: %x", __func__, status);
526 return;
528 if (urb->actual_length != 9) {
529 dbg("%s - %d byte report??", __func__, urb->actual_length);
530 goto exit;
533 msg = (struct keyspan_usa26_portStatusMessage *)data;
535 #if 0
536 dbg("%s - port status: port %d cts %d dcd %d dsr %d ri %d toff %d txoff %d rxen %d cr %d",
537 __func__, msg->port, msg->hskia_cts, msg->gpia_dcd, msg->dsr, msg->ri, msg->_txOff,
538 msg->_txXoff, msg->rxEnabled, msg->controlResponse);
539 #endif
541 /* Now do something useful with the data */
544 /* Check port number from message and retrieve private data */
545 if (msg->port >= serial->num_ports) {
546 dbg("%s - Unexpected port number %d", __func__, msg->port);
547 goto exit;
549 port = serial->port[msg->port];
550 p_priv = usb_get_serial_port_data(port);
552 /* Update handshaking pin state information */
553 old_dcd_state = p_priv->dcd_state;
554 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
555 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
556 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
557 p_priv->ri_state = ((msg->ri) ? 1 : 0);
559 if (old_dcd_state != p_priv->dcd_state) {
560 tty = tty_port_tty_get(&port->port);
561 if (tty && !C_CLOCAL(tty))
562 tty_hangup(tty);
563 tty_kref_put(tty);
566 /* Resubmit urb so we continue receiving */
567 urb->dev = serial->dev;
568 err = usb_submit_urb(urb, GFP_ATOMIC);
569 if (err != 0)
570 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
571 exit: ;
574 static void usa26_glocont_callback(struct urb *urb)
576 dbg("%s", __func__);
580 static void usa28_indat_callback(struct urb *urb)
582 int err;
583 struct usb_serial_port *port;
584 struct tty_struct *tty;
585 unsigned char *data;
586 struct keyspan_port_private *p_priv;
587 int status = urb->status;
589 dbg("%s", __func__);
591 port = urb->context;
592 p_priv = usb_get_serial_port_data(port);
593 data = urb->transfer_buffer;
595 if (urb != p_priv->in_urbs[p_priv->in_flip])
596 return;
598 do {
599 if (status) {
600 dbg("%s - nonzero status: %x on endpoint %d.",
601 __func__, status, usb_pipeendpoint(urb->pipe));
602 return;
605 port = urb->context;
606 p_priv = usb_get_serial_port_data(port);
607 data = urb->transfer_buffer;
609 tty =tty_port_tty_get(&port->port);
610 if (tty && urb->actual_length) {
611 tty_insert_flip_string(tty, data, urb->actual_length);
612 tty_flip_buffer_push(tty);
614 tty_kref_put(tty);
616 /* Resubmit urb so we continue receiving */
617 urb->dev = port->serial->dev;
618 if (port->port.count) {
619 err = usb_submit_urb(urb, GFP_ATOMIC);
620 if (err != 0)
621 dbg("%s - resubmit read urb failed. (%d)",
622 __func__, err);
624 p_priv->in_flip ^= 1;
626 urb = p_priv->in_urbs[p_priv->in_flip];
627 } while (urb->status != -EINPROGRESS);
630 static void usa28_inack_callback(struct urb *urb)
632 dbg("%s", __func__);
635 static void usa28_outcont_callback(struct urb *urb)
637 struct usb_serial_port *port;
638 struct keyspan_port_private *p_priv;
640 port = urb->context;
641 p_priv = usb_get_serial_port_data(port);
643 if (p_priv->resend_cont) {
644 dbg("%s - sending setup", __func__);
645 keyspan_usa28_send_setup(port->serial, port,
646 p_priv->resend_cont - 1);
650 static void usa28_instat_callback(struct urb *urb)
652 int err;
653 unsigned char *data = urb->transfer_buffer;
654 struct keyspan_usa28_portStatusMessage *msg;
655 struct usb_serial *serial;
656 struct usb_serial_port *port;
657 struct keyspan_port_private *p_priv;
658 struct tty_struct *tty;
659 int old_dcd_state;
660 int status = urb->status;
662 serial = urb->context;
664 if (status) {
665 dbg("%s - nonzero status: %x", __func__, status);
666 return;
669 if (urb->actual_length != sizeof(struct keyspan_usa28_portStatusMessage)) {
670 dbg("%s - bad length %d", __func__, urb->actual_length);
671 goto exit;
674 /*dbg("%s %x %x %x %x %x %x %x %x %x %x %x %x", __func__
675 data[0], data[1], data[2], data[3], data[4], data[5],
676 data[6], data[7], data[8], data[9], data[10], data[11]);*/
678 /* Now do something useful with the data */
679 msg = (struct keyspan_usa28_portStatusMessage *)data;
681 /* Check port number from message and retrieve private data */
682 if (msg->port >= serial->num_ports) {
683 dbg("%s - Unexpected port number %d", __func__, msg->port);
684 goto exit;
686 port = serial->port[msg->port];
687 p_priv = usb_get_serial_port_data(port);
689 /* Update handshaking pin state information */
690 old_dcd_state = p_priv->dcd_state;
691 p_priv->cts_state = ((msg->cts) ? 1 : 0);
692 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
693 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
694 p_priv->ri_state = ((msg->ri) ? 1 : 0);
696 if( old_dcd_state != p_priv->dcd_state && old_dcd_state) {
697 tty = tty_port_tty_get(&port->port);
698 if (tty && !C_CLOCAL(tty))
699 tty_hangup(tty);
700 tty_kref_put(tty);
703 /* Resubmit urb so we continue receiving */
704 urb->dev = serial->dev;
705 err = usb_submit_urb(urb, GFP_ATOMIC);
706 if (err != 0)
707 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
708 exit: ;
711 static void usa28_glocont_callback(struct urb *urb)
713 dbg("%s", __func__);
717 static void usa49_glocont_callback(struct urb *urb)
719 struct usb_serial *serial;
720 struct usb_serial_port *port;
721 struct keyspan_port_private *p_priv;
722 int i;
724 dbg("%s", __func__);
726 serial = urb->context;
727 for (i = 0; i < serial->num_ports; ++i) {
728 port = serial->port[i];
729 p_priv = usb_get_serial_port_data(port);
731 if (p_priv->resend_cont) {
732 dbg("%s - sending setup", __func__);
733 keyspan_usa49_send_setup(serial, port,
734 p_priv->resend_cont - 1);
735 break;
740 /* This is actually called glostat in the Keyspan
741 doco */
742 static void usa49_instat_callback(struct urb *urb)
744 int err;
745 unsigned char *data = urb->transfer_buffer;
746 struct keyspan_usa49_portStatusMessage *msg;
747 struct usb_serial *serial;
748 struct usb_serial_port *port;
749 struct keyspan_port_private *p_priv;
750 int old_dcd_state;
751 int status = urb->status;
753 dbg("%s", __func__);
755 serial = urb->context;
757 if (status) {
758 dbg("%s - nonzero status: %x", __func__, status);
759 return;
762 if (urb->actual_length !=
763 sizeof(struct keyspan_usa49_portStatusMessage)) {
764 dbg("%s - bad length %d", __func__, urb->actual_length);
765 goto exit;
768 /*dbg(" %x %x %x %x %x %x %x %x %x %x %x", __func__,
769 data[0], data[1], data[2], data[3], data[4], data[5],
770 data[6], data[7], data[8], data[9], data[10]);*/
772 /* Now do something useful with the data */
773 msg = (struct keyspan_usa49_portStatusMessage *)data;
775 /* Check port number from message and retrieve private data */
776 if (msg->portNumber >= serial->num_ports) {
777 dbg("%s - Unexpected port number %d",
778 __func__, msg->portNumber);
779 goto exit;
781 port = serial->port[msg->portNumber];
782 p_priv = usb_get_serial_port_data(port);
784 /* Update handshaking pin state information */
785 old_dcd_state = p_priv->dcd_state;
786 p_priv->cts_state = ((msg->cts) ? 1 : 0);
787 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
788 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
789 p_priv->ri_state = ((msg->ri) ? 1 : 0);
791 if (old_dcd_state != p_priv->dcd_state && old_dcd_state) {
792 struct tty_struct *tty = tty_port_tty_get(&port->port);
793 if (tty && !C_CLOCAL(tty))
794 tty_hangup(tty);
795 tty_kref_put(tty);
798 /* Resubmit urb so we continue receiving */
799 urb->dev = serial->dev;
801 err = usb_submit_urb(urb, GFP_ATOMIC);
802 if (err != 0)
803 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
804 exit: ;
807 static void usa49_inack_callback(struct urb *urb)
809 dbg("%s", __func__);
812 static void usa49_indat_callback(struct urb *urb)
814 int i, err;
815 int endpoint;
816 struct usb_serial_port *port;
817 struct tty_struct *tty;
818 unsigned char *data = urb->transfer_buffer;
819 int status = urb->status;
821 dbg("%s", __func__);
823 endpoint = usb_pipeendpoint(urb->pipe);
825 if (status) {
826 dbg("%s - nonzero status: %x on endpoint %d.", __func__,
827 status, endpoint);
828 return;
831 port = urb->context;
832 tty = tty_port_tty_get(&port->port);
833 if (tty && urb->actual_length) {
834 /* 0x80 bit is error flag */
835 if ((data[0] & 0x80) == 0) {
836 /* no error on any byte */
837 tty_insert_flip_string(tty, data + 1,
838 urb->actual_length - 1);
839 } else {
840 /* some bytes had errors, every byte has status */
841 for (i = 0; i + 1 < urb->actual_length; i += 2) {
842 int stat = data[i], flag = 0;
843 if (stat & RXERROR_OVERRUN)
844 flag |= TTY_OVERRUN;
845 if (stat & RXERROR_FRAMING)
846 flag |= TTY_FRAME;
847 if (stat & RXERROR_PARITY)
848 flag |= TTY_PARITY;
849 /* XXX should handle break (0x10) */
850 tty_insert_flip_char(tty, data[i+1], flag);
853 tty_flip_buffer_push(tty);
855 tty_kref_put(tty);
857 /* Resubmit urb so we continue receiving */
858 urb->dev = port->serial->dev;
859 if (port->port.count) {
860 err = usb_submit_urb(urb, GFP_ATOMIC);
861 if (err != 0)
862 dbg("%s - resubmit read urb failed. (%d)",
863 __func__, err);
867 static void usa49wg_indat_callback(struct urb *urb)
869 int i, len, x, err;
870 struct usb_serial *serial;
871 struct usb_serial_port *port;
872 struct tty_struct *tty;
873 unsigned char *data = urb->transfer_buffer;
874 int status = urb->status;
876 dbg("%s", __func__);
878 serial = urb->context;
880 if (status) {
881 dbg("%s - nonzero status: %x", __func__, status);
882 return;
885 /* inbound data is in the form P#, len, status, data */
886 i = 0;
887 len = 0;
889 if (urb->actual_length) {
890 while (i < urb->actual_length) {
892 /* Check port number from message*/
893 if (data[i] >= serial->num_ports) {
894 dbg("%s - Unexpected port number %d",
895 __func__, data[i]);
896 return;
898 port = serial->port[data[i++]];
899 tty = tty_port_tty_get(&port->port);
900 len = data[i++];
902 /* 0x80 bit is error flag */
903 if ((data[i] & 0x80) == 0) {
904 /* no error on any byte */
905 i++;
906 for (x = 1; x < len ; ++x)
907 if (port->port.count)
908 tty_insert_flip_char(tty,
909 data[i++], 0);
910 else
911 i++;
912 } else {
914 * some bytes had errors, every byte has status
916 for (x = 0; x + 1 < len; x += 2) {
917 int stat = data[i], flag = 0;
918 if (stat & RXERROR_OVERRUN)
919 flag |= TTY_OVERRUN;
920 if (stat & RXERROR_FRAMING)
921 flag |= TTY_FRAME;
922 if (stat & RXERROR_PARITY)
923 flag |= TTY_PARITY;
924 /* XXX should handle break (0x10) */
925 if (port->port.count)
926 tty_insert_flip_char(tty,
927 data[i+1], flag);
928 i += 2;
931 if (port->port.count)
932 tty_flip_buffer_push(tty);
933 tty_kref_put(tty);
937 /* Resubmit urb so we continue receiving */
938 urb->dev = serial->dev;
940 err = usb_submit_urb(urb, GFP_ATOMIC);
941 if (err != 0)
942 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
945 /* not used, usa-49 doesn't have per-port control endpoints */
946 static void usa49_outcont_callback(struct urb *urb)
948 dbg("%s", __func__);
951 static void usa90_indat_callback(struct urb *urb)
953 int i, err;
954 int endpoint;
955 struct usb_serial_port *port;
956 struct keyspan_port_private *p_priv;
957 struct tty_struct *tty;
958 unsigned char *data = urb->transfer_buffer;
959 int status = urb->status;
961 dbg("%s", __func__);
963 endpoint = usb_pipeendpoint(urb->pipe);
965 if (status) {
966 dbg("%s - nonzero status: %x on endpoint %d.",
967 __func__, status, endpoint);
968 return;
971 port = urb->context;
972 p_priv = usb_get_serial_port_data(port);
974 if (urb->actual_length) {
975 tty = tty_port_tty_get(&port->port);
976 /* if current mode is DMA, looks like usa28 format
977 otherwise looks like usa26 data format */
979 if (p_priv->baud > 57600)
980 tty_insert_flip_string(tty, data, urb->actual_length);
981 else {
982 /* 0x80 bit is error flag */
983 if ((data[0] & 0x80) == 0) {
984 /* no errors on individual bytes, only
985 possible overrun err*/
986 if (data[0] & RXERROR_OVERRUN)
987 err = TTY_OVERRUN;
988 else
989 err = 0;
990 for (i = 1; i < urb->actual_length ; ++i)
991 tty_insert_flip_char(tty, data[i],
992 err);
993 } else {
994 /* some bytes had errors, every byte has status */
995 dbg("%s - RX error!!!!", __func__);
996 for (i = 0; i + 1 < urb->actual_length; i += 2) {
997 int stat = data[i], flag = 0;
998 if (stat & RXERROR_OVERRUN)
999 flag |= TTY_OVERRUN;
1000 if (stat & RXERROR_FRAMING)
1001 flag |= TTY_FRAME;
1002 if (stat & RXERROR_PARITY)
1003 flag |= TTY_PARITY;
1004 /* XXX should handle break (0x10) */
1005 tty_insert_flip_char(tty, data[i+1],
1006 flag);
1010 tty_flip_buffer_push(tty);
1011 tty_kref_put(tty);
1014 /* Resubmit urb so we continue receiving */
1015 urb->dev = port->serial->dev;
1016 if (port->port.count) {
1017 err = usb_submit_urb(urb, GFP_ATOMIC);
1018 if (err != 0)
1019 dbg("%s - resubmit read urb failed. (%d)",
1020 __func__, err);
1022 return;
1026 static void usa90_instat_callback(struct urb *urb)
1028 unsigned char *data = urb->transfer_buffer;
1029 struct keyspan_usa90_portStatusMessage *msg;
1030 struct usb_serial *serial;
1031 struct usb_serial_port *port;
1032 struct keyspan_port_private *p_priv;
1033 struct tty_struct *tty;
1034 int old_dcd_state, err;
1035 int status = urb->status;
1037 serial = urb->context;
1039 if (status) {
1040 dbg("%s - nonzero status: %x", __func__, status);
1041 return;
1043 if (urb->actual_length < 14) {
1044 dbg("%s - %d byte report??", __func__, urb->actual_length);
1045 goto exit;
1048 msg = (struct keyspan_usa90_portStatusMessage *)data;
1050 /* Now do something useful with the data */
1052 port = serial->port[0];
1053 p_priv = usb_get_serial_port_data(port);
1055 /* Update handshaking pin state information */
1056 old_dcd_state = p_priv->dcd_state;
1057 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1058 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1059 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1060 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1062 if (old_dcd_state != p_priv->dcd_state && old_dcd_state) {
1063 tty = tty_port_tty_get(&port->port);
1064 if (tty && !C_CLOCAL(tty))
1065 tty_hangup(tty);
1066 tty_kref_put(tty);
1069 /* Resubmit urb so we continue receiving */
1070 urb->dev = serial->dev;
1071 err = usb_submit_urb(urb, GFP_ATOMIC);
1072 if (err != 0)
1073 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
1074 exit:
1078 static void usa90_outcont_callback(struct urb *urb)
1080 struct usb_serial_port *port;
1081 struct keyspan_port_private *p_priv;
1083 port = urb->context;
1084 p_priv = usb_get_serial_port_data(port);
1086 if (p_priv->resend_cont) {
1087 dbg("%s - sending setup", __func__);
1088 keyspan_usa90_send_setup(port->serial, port,
1089 p_priv->resend_cont - 1);
1093 /* Status messages from the 28xg */
1094 static void usa67_instat_callback(struct urb *urb)
1096 int err;
1097 unsigned char *data = urb->transfer_buffer;
1098 struct keyspan_usa67_portStatusMessage *msg;
1099 struct usb_serial *serial;
1100 struct usb_serial_port *port;
1101 struct keyspan_port_private *p_priv;
1102 int old_dcd_state;
1103 int status = urb->status;
1105 dbg("%s", __func__);
1107 serial = urb->context;
1109 if (status) {
1110 dbg("%s - nonzero status: %x", __func__, status);
1111 return;
1114 if (urb->actual_length !=
1115 sizeof(struct keyspan_usa67_portStatusMessage)) {
1116 dbg("%s - bad length %d", __func__, urb->actual_length);
1117 return;
1121 /* Now do something useful with the data */
1122 msg = (struct keyspan_usa67_portStatusMessage *)data;
1124 /* Check port number from message and retrieve private data */
1125 if (msg->port >= serial->num_ports) {
1126 dbg("%s - Unexpected port number %d", __func__, msg->port);
1127 return;
1130 port = serial->port[msg->port];
1131 p_priv = usb_get_serial_port_data(port);
1133 /* Update handshaking pin state information */
1134 old_dcd_state = p_priv->dcd_state;
1135 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
1136 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
1138 if (old_dcd_state != p_priv->dcd_state && old_dcd_state) {
1139 struct tty_struct *tty = tty_port_tty_get(&port->port);
1140 if (tty && !C_CLOCAL(tty))
1141 tty_hangup(tty);
1142 tty_kref_put(tty);
1145 /* Resubmit urb so we continue receiving */
1146 urb->dev = serial->dev;
1147 err = usb_submit_urb(urb, GFP_ATOMIC);
1148 if (err != 0)
1149 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
1152 static void usa67_glocont_callback(struct urb *urb)
1154 struct usb_serial *serial;
1155 struct usb_serial_port *port;
1156 struct keyspan_port_private *p_priv;
1157 int i;
1159 dbg("%s", __func__);
1161 serial = urb->context;
1162 for (i = 0; i < serial->num_ports; ++i) {
1163 port = serial->port[i];
1164 p_priv = usb_get_serial_port_data(port);
1166 if (p_priv->resend_cont) {
1167 dbg("%s - sending setup", __func__);
1168 keyspan_usa67_send_setup(serial, port,
1169 p_priv->resend_cont - 1);
1170 break;
1175 static int keyspan_write_room(struct tty_struct *tty)
1177 struct usb_serial_port *port = tty->driver_data;
1178 struct keyspan_port_private *p_priv;
1179 const struct keyspan_device_details *d_details;
1180 int flip;
1181 int data_len;
1182 struct urb *this_urb;
1184 dbg("%s", __func__);
1185 p_priv = usb_get_serial_port_data(port);
1186 d_details = p_priv->device_details;
1188 /* FIXME: locking */
1189 if (d_details->msg_format == msg_usa90)
1190 data_len = 64;
1191 else
1192 data_len = 63;
1194 flip = p_priv->out_flip;
1196 /* Check both endpoints to see if any are available. */
1197 this_urb = p_priv->out_urbs[flip];
1198 if (this_urb != NULL) {
1199 if (this_urb->status != -EINPROGRESS)
1200 return data_len;
1201 flip = (flip + 1) & d_details->outdat_endp_flip;
1202 this_urb = p_priv->out_urbs[flip];
1203 if (this_urb != NULL) {
1204 if (this_urb->status != -EINPROGRESS)
1205 return data_len;
1208 return 0;
1212 static int keyspan_open(struct tty_struct *tty,
1213 struct usb_serial_port *port, struct file *filp)
1215 struct keyspan_port_private *p_priv;
1216 struct keyspan_serial_private *s_priv;
1217 struct usb_serial *serial = port->serial;
1218 const struct keyspan_device_details *d_details;
1219 int i, err;
1220 int baud_rate, device_port;
1221 struct urb *urb;
1222 unsigned int cflag = 0;
1224 s_priv = usb_get_serial_data(serial);
1225 p_priv = usb_get_serial_port_data(port);
1226 d_details = p_priv->device_details;
1228 dbg("%s - port%d.", __func__, port->number);
1230 /* Set some sane defaults */
1231 p_priv->rts_state = 1;
1232 p_priv->dtr_state = 1;
1233 p_priv->baud = 9600;
1235 /* force baud and lcr to be set on open */
1236 p_priv->old_baud = 0;
1237 p_priv->old_cflag = 0;
1239 p_priv->out_flip = 0;
1240 p_priv->in_flip = 0;
1242 /* Reset low level data toggle and start reading from endpoints */
1243 for (i = 0; i < 2; i++) {
1244 urb = p_priv->in_urbs[i];
1245 if (urb == NULL)
1246 continue;
1247 urb->dev = serial->dev;
1249 /* make sure endpoint data toggle is synchronized
1250 with the device */
1251 usb_clear_halt(urb->dev, urb->pipe);
1252 err = usb_submit_urb(urb, GFP_KERNEL);
1253 if (err != 0)
1254 dbg("%s - submit urb %d failed (%d)",
1255 __func__, i, err);
1258 /* Reset low level data toggle on out endpoints */
1259 for (i = 0; i < 2; i++) {
1260 urb = p_priv->out_urbs[i];
1261 if (urb == NULL)
1262 continue;
1263 urb->dev = serial->dev;
1264 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1265 usb_pipeout(urb->pipe), 0); */
1268 /* get the terminal config for the setup message now so we don't
1269 * need to send 2 of them */
1271 device_port = port->number - port->serial->minor;
1272 if (tty) {
1273 cflag = tty->termios->c_cflag;
1274 /* Baud rate calculation takes baud rate as an integer
1275 so other rates can be generated if desired. */
1276 baud_rate = tty_get_baud_rate(tty);
1277 /* If no match or invalid, leave as default */
1278 if (baud_rate >= 0
1279 && d_details->calculate_baud_rate(baud_rate, d_details->baudclk,
1280 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
1281 p_priv->baud = baud_rate;
1284 /* set CTS/RTS handshake etc. */
1285 p_priv->cflag = cflag;
1286 p_priv->flow_control = (cflag & CRTSCTS)? flow_cts: flow_none;
1288 keyspan_send_setup(port, 1);
1289 /* mdelay(100); */
1290 /* keyspan_set_termios(port, NULL); */
1292 return 0;
1295 static inline void stop_urb(struct urb *urb)
1297 if (urb && urb->status == -EINPROGRESS)
1298 usb_kill_urb(urb);
1301 static void keyspan_close(struct tty_struct *tty,
1302 struct usb_serial_port *port, struct file *filp)
1304 int i;
1305 struct usb_serial *serial = port->serial;
1306 struct keyspan_serial_private *s_priv;
1307 struct keyspan_port_private *p_priv;
1309 dbg("%s", __func__);
1310 s_priv = usb_get_serial_data(serial);
1311 p_priv = usb_get_serial_port_data(port);
1313 p_priv->rts_state = 0;
1314 p_priv->dtr_state = 0;
1316 if (serial->dev) {
1317 keyspan_send_setup(port, 2);
1318 /* pilot-xfer seems to work best with this delay */
1319 mdelay(100);
1320 /* keyspan_set_termios(port, NULL); */
1323 /*while (p_priv->outcont_urb->status == -EINPROGRESS) {
1324 dbg("%s - urb in progress", __func__);
1327 p_priv->out_flip = 0;
1328 p_priv->in_flip = 0;
1330 if (serial->dev) {
1331 /* Stop reading/writing urbs */
1332 stop_urb(p_priv->inack_urb);
1333 /* stop_urb(p_priv->outcont_urb); */
1334 for (i = 0; i < 2; i++) {
1335 stop_urb(p_priv->in_urbs[i]);
1336 stop_urb(p_priv->out_urbs[i]);
1339 tty_port_tty_set(&port->port, NULL);
1342 /* download the firmware to a pre-renumeration device */
1343 static int keyspan_fake_startup(struct usb_serial *serial)
1345 int response;
1346 const struct ihex_binrec *record;
1347 char *fw_name;
1348 const struct firmware *fw;
1350 dbg("Keyspan startup version %04x product %04x",
1351 le16_to_cpu(serial->dev->descriptor.bcdDevice),
1352 le16_to_cpu(serial->dev->descriptor.idProduct));
1354 if ((le16_to_cpu(serial->dev->descriptor.bcdDevice) & 0x8000)
1355 != 0x8000) {
1356 dbg("Firmware already loaded. Quitting.");
1357 return 1;
1360 /* Select firmware image on the basis of idProduct */
1361 switch (le16_to_cpu(serial->dev->descriptor.idProduct)) {
1362 case keyspan_usa28_pre_product_id:
1363 fw_name = "keyspan/usa28.fw";
1364 break;
1366 case keyspan_usa28x_pre_product_id:
1367 fw_name = "keyspan/usa28x.fw";
1368 break;
1370 case keyspan_usa28xa_pre_product_id:
1371 fw_name = "keyspan/usa28xa.fw";
1372 break;
1374 case keyspan_usa28xb_pre_product_id:
1375 fw_name = "keyspan/usa28xb.fw";
1376 break;
1378 case keyspan_usa19_pre_product_id:
1379 fw_name = "keyspan/usa19.fw";
1380 break;
1382 case keyspan_usa19qi_pre_product_id:
1383 fw_name = "keyspan/usa19qi.fw";
1384 break;
1386 case keyspan_mpr_pre_product_id:
1387 fw_name = "keyspan/mpr.fw";
1388 break;
1390 case keyspan_usa19qw_pre_product_id:
1391 fw_name = "keyspan/usa19qw.fw";
1392 break;
1394 case keyspan_usa18x_pre_product_id:
1395 fw_name = "keyspan/usa18x.fw";
1396 break;
1398 case keyspan_usa19w_pre_product_id:
1399 fw_name = "keyspan/usa19w.fw";
1400 break;
1402 case keyspan_usa49w_pre_product_id:
1403 fw_name = "keyspan/usa49w.fw";
1404 break;
1406 case keyspan_usa49wlc_pre_product_id:
1407 fw_name = "keyspan/usa49wlc.fw";
1408 break;
1410 default:
1411 dev_err(&serial->dev->dev, "Unknown product ID (%04x)\n",
1412 le16_to_cpu(serial->dev->descriptor.idProduct));
1413 return 1;
1416 if (request_ihex_firmware(&fw, fw_name, &serial->dev->dev)) {
1417 dev_err(&serial->dev->dev, "Required keyspan firmware image (%s) unavailable.\n", fw_name);
1418 return(1);
1421 dbg("Uploading Keyspan %s firmware.", fw_name);
1423 /* download the firmware image */
1424 response = ezusb_set_reset(serial, 1);
1426 record = (const struct ihex_binrec *)fw->data;
1428 while (record) {
1429 response = ezusb_writememory(serial, be32_to_cpu(record->addr),
1430 (unsigned char *)record->data,
1431 be16_to_cpu(record->len), 0xa0);
1432 if (response < 0) {
1433 dev_err(&serial->dev->dev, "ezusb_writememory failed for Keyspan firmware (%d %04X %p %d)\n",
1434 response, be32_to_cpu(record->addr),
1435 record->data, be16_to_cpu(record->len));
1436 break;
1438 record = ihex_next_binrec(record);
1440 release_firmware(fw);
1441 /* bring device out of reset. Renumeration will occur in a
1442 moment and the new device will bind to the real driver */
1443 response = ezusb_set_reset(serial, 0);
1445 /* we don't want this device to have a driver assigned to it. */
1446 return 1;
1449 /* Helper functions used by keyspan_setup_urbs */
1450 static struct usb_endpoint_descriptor const *find_ep(struct usb_serial const *serial,
1451 int endpoint)
1453 struct usb_host_interface *iface_desc;
1454 struct usb_endpoint_descriptor *ep;
1455 int i;
1457 iface_desc = serial->interface->cur_altsetting;
1458 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1459 ep = &iface_desc->endpoint[i].desc;
1460 if (ep->bEndpointAddress == endpoint)
1461 return ep;
1463 dev_warn(&serial->interface->dev, "found no endpoint descriptor for "
1464 "endpoint %x\n", endpoint);
1465 return NULL;
1468 static struct urb *keyspan_setup_urb(struct usb_serial *serial, int endpoint,
1469 int dir, void *ctx, char *buf, int len,
1470 void (*callback)(struct urb *))
1472 struct urb *urb;
1473 struct usb_endpoint_descriptor const *ep_desc;
1474 char const *ep_type_name;
1476 if (endpoint == -1)
1477 return NULL; /* endpoint not needed */
1479 dbg("%s - alloc for endpoint %d.", __func__, endpoint);
1480 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
1481 if (urb == NULL) {
1482 dbg("%s - alloc for endpoint %d failed.", __func__, endpoint);
1483 return NULL;
1486 if (endpoint == 0) {
1487 /* control EP filled in when used */
1488 return urb;
1491 ep_desc = find_ep(serial, endpoint);
1492 if (!ep_desc) {
1493 /* leak the urb, something's wrong and the callers don't care */
1494 return urb;
1496 if (usb_endpoint_xfer_int(ep_desc)) {
1497 ep_type_name = "INT";
1498 usb_fill_int_urb(urb, serial->dev,
1499 usb_sndintpipe(serial->dev, endpoint) | dir,
1500 buf, len, callback, ctx,
1501 ep_desc->bInterval);
1502 } else if (usb_endpoint_xfer_bulk(ep_desc)) {
1503 ep_type_name = "BULK";
1504 usb_fill_bulk_urb(urb, serial->dev,
1505 usb_sndbulkpipe(serial->dev, endpoint) | dir,
1506 buf, len, callback, ctx);
1507 } else {
1508 dev_warn(&serial->interface->dev,
1509 "unsupported endpoint type %x\n",
1510 ep_desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
1511 usb_free_urb(urb);
1512 return NULL;
1515 dbg("%s - using urb %p for %s endpoint %x",
1516 __func__, urb, ep_type_name, endpoint);
1517 return urb;
1520 static struct callbacks {
1521 void (*instat_callback)(struct urb *);
1522 void (*glocont_callback)(struct urb *);
1523 void (*indat_callback)(struct urb *);
1524 void (*outdat_callback)(struct urb *);
1525 void (*inack_callback)(struct urb *);
1526 void (*outcont_callback)(struct urb *);
1527 } keyspan_callbacks[] = {
1529 /* msg_usa26 callbacks */
1530 .instat_callback = usa26_instat_callback,
1531 .glocont_callback = usa26_glocont_callback,
1532 .indat_callback = usa26_indat_callback,
1533 .outdat_callback = usa2x_outdat_callback,
1534 .inack_callback = usa26_inack_callback,
1535 .outcont_callback = usa26_outcont_callback,
1536 }, {
1537 /* msg_usa28 callbacks */
1538 .instat_callback = usa28_instat_callback,
1539 .glocont_callback = usa28_glocont_callback,
1540 .indat_callback = usa28_indat_callback,
1541 .outdat_callback = usa2x_outdat_callback,
1542 .inack_callback = usa28_inack_callback,
1543 .outcont_callback = usa28_outcont_callback,
1544 }, {
1545 /* msg_usa49 callbacks */
1546 .instat_callback = usa49_instat_callback,
1547 .glocont_callback = usa49_glocont_callback,
1548 .indat_callback = usa49_indat_callback,
1549 .outdat_callback = usa2x_outdat_callback,
1550 .inack_callback = usa49_inack_callback,
1551 .outcont_callback = usa49_outcont_callback,
1552 }, {
1553 /* msg_usa90 callbacks */
1554 .instat_callback = usa90_instat_callback,
1555 .glocont_callback = usa28_glocont_callback,
1556 .indat_callback = usa90_indat_callback,
1557 .outdat_callback = usa2x_outdat_callback,
1558 .inack_callback = usa28_inack_callback,
1559 .outcont_callback = usa90_outcont_callback,
1560 }, {
1561 /* msg_usa67 callbacks */
1562 .instat_callback = usa67_instat_callback,
1563 .glocont_callback = usa67_glocont_callback,
1564 .indat_callback = usa26_indat_callback,
1565 .outdat_callback = usa2x_outdat_callback,
1566 .inack_callback = usa26_inack_callback,
1567 .outcont_callback = usa26_outcont_callback,
1571 /* Generic setup urbs function that uses
1572 data in device_details */
1573 static void keyspan_setup_urbs(struct usb_serial *serial)
1575 int i, j;
1576 struct keyspan_serial_private *s_priv;
1577 const struct keyspan_device_details *d_details;
1578 struct usb_serial_port *port;
1579 struct keyspan_port_private *p_priv;
1580 struct callbacks *cback;
1581 int endp;
1583 dbg("%s", __func__);
1585 s_priv = usb_get_serial_data(serial);
1586 d_details = s_priv->device_details;
1588 /* Setup values for the various callback routines */
1589 cback = &keyspan_callbacks[d_details->msg_format];
1591 /* Allocate and set up urbs for each one that is in use,
1592 starting with instat endpoints */
1593 s_priv->instat_urb = keyspan_setup_urb
1594 (serial, d_details->instat_endpoint, USB_DIR_IN,
1595 serial, s_priv->instat_buf, INSTAT_BUFLEN,
1596 cback->instat_callback);
1598 s_priv->indat_urb = keyspan_setup_urb
1599 (serial, d_details->indat_endpoint, USB_DIR_IN,
1600 serial, s_priv->indat_buf, INDAT49W_BUFLEN,
1601 usa49wg_indat_callback);
1603 s_priv->glocont_urb = keyspan_setup_urb
1604 (serial, d_details->glocont_endpoint, USB_DIR_OUT,
1605 serial, s_priv->glocont_buf, GLOCONT_BUFLEN,
1606 cback->glocont_callback);
1608 /* Setup endpoints for each port specific thing */
1609 for (i = 0; i < d_details->num_ports; i++) {
1610 port = serial->port[i];
1611 p_priv = usb_get_serial_port_data(port);
1613 /* Do indat endpoints first, once for each flip */
1614 endp = d_details->indat_endpoints[i];
1615 for (j = 0; j <= d_details->indat_endp_flip; ++j, ++endp) {
1616 p_priv->in_urbs[j] = keyspan_setup_urb
1617 (serial, endp, USB_DIR_IN, port,
1618 p_priv->in_buffer[j], 64,
1619 cback->indat_callback);
1621 for (; j < 2; ++j)
1622 p_priv->in_urbs[j] = NULL;
1624 /* outdat endpoints also have flip */
1625 endp = d_details->outdat_endpoints[i];
1626 for (j = 0; j <= d_details->outdat_endp_flip; ++j, ++endp) {
1627 p_priv->out_urbs[j] = keyspan_setup_urb
1628 (serial, endp, USB_DIR_OUT, port,
1629 p_priv->out_buffer[j], 64,
1630 cback->outdat_callback);
1632 for (; j < 2; ++j)
1633 p_priv->out_urbs[j] = NULL;
1635 /* inack endpoint */
1636 p_priv->inack_urb = keyspan_setup_urb
1637 (serial, d_details->inack_endpoints[i], USB_DIR_IN,
1638 port, p_priv->inack_buffer, 1, cback->inack_callback);
1640 /* outcont endpoint */
1641 p_priv->outcont_urb = keyspan_setup_urb
1642 (serial, d_details->outcont_endpoints[i], USB_DIR_OUT,
1643 port, p_priv->outcont_buffer, 64,
1644 cback->outcont_callback);
1648 /* usa19 function doesn't require prescaler */
1649 static int keyspan_usa19_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1650 u8 *rate_low, u8 *prescaler, int portnum)
1652 u32 b16, /* baud rate times 16 (actual rate used internally) */
1653 div, /* divisor */
1654 cnt; /* inverse of divisor (programmed into 8051) */
1656 dbg("%s - %d.", __func__, baud_rate);
1658 /* prevent divide by zero... */
1659 b16 = baud_rate * 16L;
1660 if (b16 == 0)
1661 return KEYSPAN_INVALID_BAUD_RATE;
1662 /* Any "standard" rate over 57k6 is marginal on the USA-19
1663 as we run out of divisor resolution. */
1664 if (baud_rate > 57600)
1665 return KEYSPAN_INVALID_BAUD_RATE;
1667 /* calculate the divisor and the counter (its inverse) */
1668 div = baudclk / b16;
1669 if (div == 0)
1670 return KEYSPAN_INVALID_BAUD_RATE;
1671 else
1672 cnt = 0 - div;
1674 if (div > 0xffff)
1675 return KEYSPAN_INVALID_BAUD_RATE;
1677 /* return the counter values if non-null */
1678 if (rate_low)
1679 *rate_low = (u8) (cnt & 0xff);
1680 if (rate_hi)
1681 *rate_hi = (u8) ((cnt >> 8) & 0xff);
1682 if (rate_low && rate_hi)
1683 dbg("%s - %d %02x %02x.",
1684 __func__, baud_rate, *rate_hi, *rate_low);
1685 return KEYSPAN_BAUD_RATE_OK;
1688 /* usa19hs function doesn't require prescaler */
1689 static int keyspan_usa19hs_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1690 u8 *rate_low, u8 *prescaler, int portnum)
1692 u32 b16, /* baud rate times 16 (actual rate used internally) */
1693 div; /* divisor */
1695 dbg("%s - %d.", __func__, baud_rate);
1697 /* prevent divide by zero... */
1698 b16 = baud_rate * 16L;
1699 if (b16 == 0)
1700 return KEYSPAN_INVALID_BAUD_RATE;
1702 /* calculate the divisor */
1703 div = baudclk / b16;
1704 if (div == 0)
1705 return KEYSPAN_INVALID_BAUD_RATE;
1707 if (div > 0xffff)
1708 return KEYSPAN_INVALID_BAUD_RATE;
1710 /* return the counter values if non-null */
1711 if (rate_low)
1712 *rate_low = (u8) (div & 0xff);
1714 if (rate_hi)
1715 *rate_hi = (u8) ((div >> 8) & 0xff);
1717 if (rate_low && rate_hi)
1718 dbg("%s - %d %02x %02x.",
1719 __func__, baud_rate, *rate_hi, *rate_low);
1721 return KEYSPAN_BAUD_RATE_OK;
1724 static int keyspan_usa19w_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1725 u8 *rate_low, u8 *prescaler, int portnum)
1727 u32 b16, /* baud rate times 16 (actual rate used internally) */
1728 clk, /* clock with 13/8 prescaler */
1729 div, /* divisor using 13/8 prescaler */
1730 res, /* resulting baud rate using 13/8 prescaler */
1731 diff, /* error using 13/8 prescaler */
1732 smallest_diff;
1733 u8 best_prescaler;
1734 int i;
1736 dbg("%s - %d.", __func__, baud_rate);
1738 /* prevent divide by zero */
1739 b16 = baud_rate * 16L;
1740 if (b16 == 0)
1741 return KEYSPAN_INVALID_BAUD_RATE;
1743 /* Calculate prescaler by trying them all and looking
1744 for best fit */
1746 /* start with largest possible difference */
1747 smallest_diff = 0xffffffff;
1749 /* 0 is an invalid prescaler, used as a flag */
1750 best_prescaler = 0;
1752 for (i = 8; i <= 0xff; ++i) {
1753 clk = (baudclk * 8) / (u32) i;
1755 div = clk / b16;
1756 if (div == 0)
1757 continue;
1759 res = clk / div;
1760 diff = (res > b16) ? (res-b16) : (b16-res);
1762 if (diff < smallest_diff) {
1763 best_prescaler = i;
1764 smallest_diff = diff;
1768 if (best_prescaler == 0)
1769 return KEYSPAN_INVALID_BAUD_RATE;
1771 clk = (baudclk * 8) / (u32) best_prescaler;
1772 div = clk / b16;
1774 /* return the divisor and prescaler if non-null */
1775 if (rate_low)
1776 *rate_low = (u8) (div & 0xff);
1777 if (rate_hi)
1778 *rate_hi = (u8) ((div >> 8) & 0xff);
1779 if (prescaler) {
1780 *prescaler = best_prescaler;
1781 /* dbg("%s - %d %d", __func__, *prescaler, div); */
1783 return KEYSPAN_BAUD_RATE_OK;
1786 /* USA-28 supports different maximum baud rates on each port */
1787 static int keyspan_usa28_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1788 u8 *rate_low, u8 *prescaler, int portnum)
1790 u32 b16, /* baud rate times 16 (actual rate used internally) */
1791 div, /* divisor */
1792 cnt; /* inverse of divisor (programmed into 8051) */
1794 dbg("%s - %d.", __func__, baud_rate);
1796 /* prevent divide by zero */
1797 b16 = baud_rate * 16L;
1798 if (b16 == 0)
1799 return KEYSPAN_INVALID_BAUD_RATE;
1801 /* calculate the divisor and the counter (its inverse) */
1802 div = KEYSPAN_USA28_BAUDCLK / b16;
1803 if (div == 0)
1804 return KEYSPAN_INVALID_BAUD_RATE;
1805 else
1806 cnt = 0 - div;
1808 /* check for out of range, based on portnum,
1809 and return result */
1810 if (portnum == 0) {
1811 if (div > 0xffff)
1812 return KEYSPAN_INVALID_BAUD_RATE;
1813 } else {
1814 if (portnum == 1) {
1815 if (div > 0xff)
1816 return KEYSPAN_INVALID_BAUD_RATE;
1817 } else
1818 return KEYSPAN_INVALID_BAUD_RATE;
1821 /* return the counter values if not NULL
1822 (port 1 will ignore retHi) */
1823 if (rate_low)
1824 *rate_low = (u8) (cnt & 0xff);
1825 if (rate_hi)
1826 *rate_hi = (u8) ((cnt >> 8) & 0xff);
1827 dbg("%s - %d OK.", __func__, baud_rate);
1828 return KEYSPAN_BAUD_RATE_OK;
1831 static int keyspan_usa26_send_setup(struct usb_serial *serial,
1832 struct usb_serial_port *port,
1833 int reset_port)
1835 struct keyspan_usa26_portControlMessage msg;
1836 struct keyspan_serial_private *s_priv;
1837 struct keyspan_port_private *p_priv;
1838 const struct keyspan_device_details *d_details;
1839 int outcont_urb;
1840 struct urb *this_urb;
1841 int device_port, err;
1843 dbg("%s reset=%d", __func__, reset_port);
1845 s_priv = usb_get_serial_data(serial);
1846 p_priv = usb_get_serial_port_data(port);
1847 d_details = s_priv->device_details;
1848 device_port = port->number - port->serial->minor;
1850 outcont_urb = d_details->outcont_endpoints[port->number];
1851 this_urb = p_priv->outcont_urb;
1853 dbg("%s - endpoint %d", __func__, usb_pipeendpoint(this_urb->pipe));
1855 /* Make sure we have an urb then send the message */
1856 if (this_urb == NULL) {
1857 dbg("%s - oops no urb.", __func__);
1858 return -1;
1861 /* Save reset port val for resend.
1862 Don't overwrite resend for open/close condition. */
1863 if ((reset_port + 1) > p_priv->resend_cont)
1864 p_priv->resend_cont = reset_port + 1;
1865 if (this_urb->status == -EINPROGRESS) {
1866 /* dbg("%s - already writing", __func__); */
1867 mdelay(5);
1868 return -1;
1871 memset(&msg, 0, sizeof(struct keyspan_usa26_portControlMessage));
1873 /* Only set baud rate if it's changed */
1874 if (p_priv->old_baud != p_priv->baud) {
1875 p_priv->old_baud = p_priv->baud;
1876 msg.setClocking = 0xff;
1877 if (d_details->calculate_baud_rate
1878 (p_priv->baud, d_details->baudclk, &msg.baudHi,
1879 &msg.baudLo, &msg.prescaler, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
1880 dbg("%s - Invalid baud rate %d requested, using 9600.",
1881 __func__, p_priv->baud);
1882 msg.baudLo = 0;
1883 msg.baudHi = 125; /* Values for 9600 baud */
1884 msg.prescaler = 10;
1886 msg.setPrescaler = 0xff;
1889 msg.lcr = (p_priv->cflag & CSTOPB)? STOPBITS_678_2: STOPBITS_5678_1;
1890 switch (p_priv->cflag & CSIZE) {
1891 case CS5:
1892 msg.lcr |= USA_DATABITS_5;
1893 break;
1894 case CS6:
1895 msg.lcr |= USA_DATABITS_6;
1896 break;
1897 case CS7:
1898 msg.lcr |= USA_DATABITS_7;
1899 break;
1900 case CS8:
1901 msg.lcr |= USA_DATABITS_8;
1902 break;
1904 if (p_priv->cflag & PARENB) {
1905 /* note USA_PARITY_NONE == 0 */
1906 msg.lcr |= (p_priv->cflag & PARODD)?
1907 USA_PARITY_ODD : USA_PARITY_EVEN;
1909 msg.setLcr = 0xff;
1911 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
1912 msg.xonFlowControl = 0;
1913 msg.setFlowControl = 0xff;
1914 msg.forwardingLength = 16;
1915 msg.xonChar = 17;
1916 msg.xoffChar = 19;
1918 /* Opening port */
1919 if (reset_port == 1) {
1920 msg._txOn = 1;
1921 msg._txOff = 0;
1922 msg.txFlush = 0;
1923 msg.txBreak = 0;
1924 msg.rxOn = 1;
1925 msg.rxOff = 0;
1926 msg.rxFlush = 1;
1927 msg.rxForward = 0;
1928 msg.returnStatus = 0;
1929 msg.resetDataToggle = 0xff;
1932 /* Closing port */
1933 else if (reset_port == 2) {
1934 msg._txOn = 0;
1935 msg._txOff = 1;
1936 msg.txFlush = 0;
1937 msg.txBreak = 0;
1938 msg.rxOn = 0;
1939 msg.rxOff = 1;
1940 msg.rxFlush = 1;
1941 msg.rxForward = 0;
1942 msg.returnStatus = 0;
1943 msg.resetDataToggle = 0;
1946 /* Sending intermediate configs */
1947 else {
1948 msg._txOn = (!p_priv->break_on);
1949 msg._txOff = 0;
1950 msg.txFlush = 0;
1951 msg.txBreak = (p_priv->break_on);
1952 msg.rxOn = 0;
1953 msg.rxOff = 0;
1954 msg.rxFlush = 0;
1955 msg.rxForward = 0;
1956 msg.returnStatus = 0;
1957 msg.resetDataToggle = 0x0;
1960 /* Do handshaking outputs */
1961 msg.setTxTriState_setRts = 0xff;
1962 msg.txTriState_rts = p_priv->rts_state;
1964 msg.setHskoa_setDtr = 0xff;
1965 msg.hskoa_dtr = p_priv->dtr_state;
1967 p_priv->resend_cont = 0;
1968 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
1970 /* send the data out the device on control endpoint */
1971 this_urb->transfer_buffer_length = sizeof(msg);
1973 this_urb->dev = serial->dev;
1974 err = usb_submit_urb(this_urb, GFP_ATOMIC);
1975 if (err != 0)
1976 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__, err);
1977 #if 0
1978 else {
1979 dbg("%s - usb_submit_urb(%d) OK %d bytes (end %d)", __func__
1980 outcont_urb, this_urb->transfer_buffer_length,
1981 usb_pipeendpoint(this_urb->pipe));
1983 #endif
1985 return 0;
1988 static int keyspan_usa28_send_setup(struct usb_serial *serial,
1989 struct usb_serial_port *port,
1990 int reset_port)
1992 struct keyspan_usa28_portControlMessage msg;
1993 struct keyspan_serial_private *s_priv;
1994 struct keyspan_port_private *p_priv;
1995 const struct keyspan_device_details *d_details;
1996 struct urb *this_urb;
1997 int device_port, err;
1999 dbg("%s", __func__);
2001 s_priv = usb_get_serial_data(serial);
2002 p_priv = usb_get_serial_port_data(port);
2003 d_details = s_priv->device_details;
2004 device_port = port->number - port->serial->minor;
2006 /* only do something if we have a bulk out endpoint */
2007 this_urb = p_priv->outcont_urb;
2008 if (this_urb == NULL) {
2009 dbg("%s - oops no urb.", __func__);
2010 return -1;
2013 /* Save reset port val for resend.
2014 Don't overwrite resend for open/close condition. */
2015 if ((reset_port + 1) > p_priv->resend_cont)
2016 p_priv->resend_cont = reset_port + 1;
2017 if (this_urb->status == -EINPROGRESS) {
2018 dbg("%s already writing", __func__);
2019 mdelay(5);
2020 return -1;
2023 memset(&msg, 0, sizeof(struct keyspan_usa28_portControlMessage));
2025 msg.setBaudRate = 1;
2026 if (d_details->calculate_baud_rate(p_priv->baud, d_details->baudclk,
2027 &msg.baudHi, &msg.baudLo, NULL, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2028 dbg("%s - Invalid baud rate requested %d.",
2029 __func__, p_priv->baud);
2030 msg.baudLo = 0xff;
2031 msg.baudHi = 0xb2; /* Values for 9600 baud */
2034 /* If parity is enabled, we must calculate it ourselves. */
2035 msg.parity = 0; /* XXX for now */
2037 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2038 msg.xonFlowControl = 0;
2040 /* Do handshaking outputs, DTR is inverted relative to RTS */
2041 msg.rts = p_priv->rts_state;
2042 msg.dtr = p_priv->dtr_state;
2044 msg.forwardingLength = 16;
2045 msg.forwardMs = 10;
2046 msg.breakThreshold = 45;
2047 msg.xonChar = 17;
2048 msg.xoffChar = 19;
2050 /*msg.returnStatus = 1;
2051 msg.resetDataToggle = 0xff;*/
2052 /* Opening port */
2053 if (reset_port == 1) {
2054 msg._txOn = 1;
2055 msg._txOff = 0;
2056 msg.txFlush = 0;
2057 msg.txForceXoff = 0;
2058 msg.txBreak = 0;
2059 msg.rxOn = 1;
2060 msg.rxOff = 0;
2061 msg.rxFlush = 1;
2062 msg.rxForward = 0;
2063 msg.returnStatus = 0;
2064 msg.resetDataToggle = 0xff;
2066 /* Closing port */
2067 else if (reset_port == 2) {
2068 msg._txOn = 0;
2069 msg._txOff = 1;
2070 msg.txFlush = 0;
2071 msg.txForceXoff = 0;
2072 msg.txBreak = 0;
2073 msg.rxOn = 0;
2074 msg.rxOff = 1;
2075 msg.rxFlush = 1;
2076 msg.rxForward = 0;
2077 msg.returnStatus = 0;
2078 msg.resetDataToggle = 0;
2080 /* Sending intermediate configs */
2081 else {
2082 msg._txOn = (!p_priv->break_on);
2083 msg._txOff = 0;
2084 msg.txFlush = 0;
2085 msg.txForceXoff = 0;
2086 msg.txBreak = (p_priv->break_on);
2087 msg.rxOn = 0;
2088 msg.rxOff = 0;
2089 msg.rxFlush = 0;
2090 msg.rxForward = 0;
2091 msg.returnStatus = 0;
2092 msg.resetDataToggle = 0x0;
2095 p_priv->resend_cont = 0;
2096 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2098 /* send the data out the device on control endpoint */
2099 this_urb->transfer_buffer_length = sizeof(msg);
2101 this_urb->dev = serial->dev;
2102 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2103 if (err != 0)
2104 dbg("%s - usb_submit_urb(setup) failed", __func__);
2105 #if 0
2106 else {
2107 dbg("%s - usb_submit_urb(setup) OK %d bytes", __func__,
2108 this_urb->transfer_buffer_length);
2110 #endif
2112 return 0;
2115 static int keyspan_usa49_send_setup(struct usb_serial *serial,
2116 struct usb_serial_port *port,
2117 int reset_port)
2119 struct keyspan_usa49_portControlMessage msg;
2120 struct usb_ctrlrequest *dr = NULL;
2121 struct keyspan_serial_private *s_priv;
2122 struct keyspan_port_private *p_priv;
2123 const struct keyspan_device_details *d_details;
2124 struct urb *this_urb;
2125 int err, device_port;
2127 dbg("%s", __func__);
2129 s_priv = usb_get_serial_data(serial);
2130 p_priv = usb_get_serial_port_data(port);
2131 d_details = s_priv->device_details;
2133 this_urb = s_priv->glocont_urb;
2135 /* Work out which port within the device is being setup */
2136 device_port = port->number - port->serial->minor;
2138 dbg("%s - endpoint %d port %d (%d)",
2139 __func__, usb_pipeendpoint(this_urb->pipe),
2140 port->number, device_port);
2142 /* Make sure we have an urb then send the message */
2143 if (this_urb == NULL) {
2144 dbg("%s - oops no urb for port %d.", __func__, port->number);
2145 return -1;
2148 /* Save reset port val for resend.
2149 Don't overwrite resend for open/close condition. */
2150 if ((reset_port + 1) > p_priv->resend_cont)
2151 p_priv->resend_cont = reset_port + 1;
2153 if (this_urb->status == -EINPROGRESS) {
2154 /* dbg("%s - already writing", __func__); */
2155 mdelay(5);
2156 return -1;
2159 memset(&msg, 0, sizeof(struct keyspan_usa49_portControlMessage));
2161 /*msg.portNumber = port->number;*/
2162 msg.portNumber = device_port;
2164 /* Only set baud rate if it's changed */
2165 if (p_priv->old_baud != p_priv->baud) {
2166 p_priv->old_baud = p_priv->baud;
2167 msg.setClocking = 0xff;
2168 if (d_details->calculate_baud_rate
2169 (p_priv->baud, d_details->baudclk, &msg.baudHi,
2170 &msg.baudLo, &msg.prescaler, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2171 dbg("%s - Invalid baud rate %d requested, using 9600.",
2172 __func__, p_priv->baud);
2173 msg.baudLo = 0;
2174 msg.baudHi = 125; /* Values for 9600 baud */
2175 msg.prescaler = 10;
2177 /* msg.setPrescaler = 0xff; */
2180 msg.lcr = (p_priv->cflag & CSTOPB)? STOPBITS_678_2: STOPBITS_5678_1;
2181 switch (p_priv->cflag & CSIZE) {
2182 case CS5:
2183 msg.lcr |= USA_DATABITS_5;
2184 break;
2185 case CS6:
2186 msg.lcr |= USA_DATABITS_6;
2187 break;
2188 case CS7:
2189 msg.lcr |= USA_DATABITS_7;
2190 break;
2191 case CS8:
2192 msg.lcr |= USA_DATABITS_8;
2193 break;
2195 if (p_priv->cflag & PARENB) {
2196 /* note USA_PARITY_NONE == 0 */
2197 msg.lcr |= (p_priv->cflag & PARODD)?
2198 USA_PARITY_ODD : USA_PARITY_EVEN;
2200 msg.setLcr = 0xff;
2202 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2203 msg.xonFlowControl = 0;
2204 msg.setFlowControl = 0xff;
2206 msg.forwardingLength = 16;
2207 msg.xonChar = 17;
2208 msg.xoffChar = 19;
2210 /* Opening port */
2211 if (reset_port == 1) {
2212 msg._txOn = 1;
2213 msg._txOff = 0;
2214 msg.txFlush = 0;
2215 msg.txBreak = 0;
2216 msg.rxOn = 1;
2217 msg.rxOff = 0;
2218 msg.rxFlush = 1;
2219 msg.rxForward = 0;
2220 msg.returnStatus = 0;
2221 msg.resetDataToggle = 0xff;
2222 msg.enablePort = 1;
2223 msg.disablePort = 0;
2225 /* Closing port */
2226 else if (reset_port == 2) {
2227 msg._txOn = 0;
2228 msg._txOff = 1;
2229 msg.txFlush = 0;
2230 msg.txBreak = 0;
2231 msg.rxOn = 0;
2232 msg.rxOff = 1;
2233 msg.rxFlush = 1;
2234 msg.rxForward = 0;
2235 msg.returnStatus = 0;
2236 msg.resetDataToggle = 0;
2237 msg.enablePort = 0;
2238 msg.disablePort = 1;
2240 /* Sending intermediate configs */
2241 else {
2242 msg._txOn = (!p_priv->break_on);
2243 msg._txOff = 0;
2244 msg.txFlush = 0;
2245 msg.txBreak = (p_priv->break_on);
2246 msg.rxOn = 0;
2247 msg.rxOff = 0;
2248 msg.rxFlush = 0;
2249 msg.rxForward = 0;
2250 msg.returnStatus = 0;
2251 msg.resetDataToggle = 0x0;
2252 msg.enablePort = 0;
2253 msg.disablePort = 0;
2256 /* Do handshaking outputs */
2257 msg.setRts = 0xff;
2258 msg.rts = p_priv->rts_state;
2260 msg.setDtr = 0xff;
2261 msg.dtr = p_priv->dtr_state;
2263 p_priv->resend_cont = 0;
2265 /* if the device is a 49wg, we send control message on usb
2266 control EP 0 */
2268 if (d_details->product_id == keyspan_usa49wg_product_id) {
2269 dr = (void *)(s_priv->ctrl_buf);
2270 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_OUT;
2271 dr->bRequest = 0xB0; /* 49wg control message */;
2272 dr->wValue = 0;
2273 dr->wIndex = 0;
2274 dr->wLength = cpu_to_le16(sizeof(msg));
2276 memcpy(s_priv->glocont_buf, &msg, sizeof(msg));
2278 usb_fill_control_urb(this_urb, serial->dev,
2279 usb_sndctrlpipe(serial->dev, 0),
2280 (unsigned char *)dr, s_priv->glocont_buf,
2281 sizeof(msg), usa49_glocont_callback, serial);
2283 } else {
2284 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2286 /* send the data out the device on control endpoint */
2287 this_urb->transfer_buffer_length = sizeof(msg);
2289 this_urb->dev = serial->dev;
2291 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2292 if (err != 0)
2293 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__, err);
2294 #if 0
2295 else {
2296 dbg("%s - usb_submit_urb(%d) OK %d bytes (end %d)", __func__,
2297 outcont_urb, this_urb->transfer_buffer_length,
2298 usb_pipeendpoint(this_urb->pipe));
2300 #endif
2302 return 0;
2305 static int keyspan_usa90_send_setup(struct usb_serial *serial,
2306 struct usb_serial_port *port,
2307 int reset_port)
2309 struct keyspan_usa90_portControlMessage msg;
2310 struct keyspan_serial_private *s_priv;
2311 struct keyspan_port_private *p_priv;
2312 const struct keyspan_device_details *d_details;
2313 struct urb *this_urb;
2314 int err;
2315 u8 prescaler;
2317 dbg("%s", __func__);
2319 s_priv = usb_get_serial_data(serial);
2320 p_priv = usb_get_serial_port_data(port);
2321 d_details = s_priv->device_details;
2323 /* only do something if we have a bulk out endpoint */
2324 this_urb = p_priv->outcont_urb;
2325 if (this_urb == NULL) {
2326 dbg("%s - oops no urb.", __func__);
2327 return -1;
2330 /* Save reset port val for resend.
2331 Don't overwrite resend for open/close condition. */
2332 if ((reset_port + 1) > p_priv->resend_cont)
2333 p_priv->resend_cont = reset_port + 1;
2334 if (this_urb->status == -EINPROGRESS) {
2335 dbg("%s already writing", __func__);
2336 mdelay(5);
2337 return -1;
2340 memset(&msg, 0, sizeof(struct keyspan_usa90_portControlMessage));
2342 /* Only set baud rate if it's changed */
2343 if (p_priv->old_baud != p_priv->baud) {
2344 p_priv->old_baud = p_priv->baud;
2345 msg.setClocking = 0x01;
2346 if (d_details->calculate_baud_rate
2347 (p_priv->baud, d_details->baudclk, &msg.baudHi,
2348 &msg.baudLo, &prescaler, 0) == KEYSPAN_INVALID_BAUD_RATE) {
2349 dbg("%s - Invalid baud rate %d requested, using 9600.",
2350 __func__, p_priv->baud);
2351 p_priv->baud = 9600;
2352 d_details->calculate_baud_rate(p_priv->baud, d_details->baudclk,
2353 &msg.baudHi, &msg.baudLo, &prescaler, 0);
2355 msg.setRxMode = 1;
2356 msg.setTxMode = 1;
2359 /* modes must always be correctly specified */
2360 if (p_priv->baud > 57600) {
2361 msg.rxMode = RXMODE_DMA;
2362 msg.txMode = TXMODE_DMA;
2363 } else {
2364 msg.rxMode = RXMODE_BYHAND;
2365 msg.txMode = TXMODE_BYHAND;
2368 msg.lcr = (p_priv->cflag & CSTOPB)? STOPBITS_678_2: STOPBITS_5678_1;
2369 switch (p_priv->cflag & CSIZE) {
2370 case CS5:
2371 msg.lcr |= USA_DATABITS_5;
2372 break;
2373 case CS6:
2374 msg.lcr |= USA_DATABITS_6;
2375 break;
2376 case CS7:
2377 msg.lcr |= USA_DATABITS_7;
2378 break;
2379 case CS8:
2380 msg.lcr |= USA_DATABITS_8;
2381 break;
2383 if (p_priv->cflag & PARENB) {
2384 /* note USA_PARITY_NONE == 0 */
2385 msg.lcr |= (p_priv->cflag & PARODD)?
2386 USA_PARITY_ODD : USA_PARITY_EVEN;
2388 if (p_priv->old_cflag != p_priv->cflag) {
2389 p_priv->old_cflag = p_priv->cflag;
2390 msg.setLcr = 0x01;
2393 if (p_priv->flow_control == flow_cts)
2394 msg.txFlowControl = TXFLOW_CTS;
2395 msg.setTxFlowControl = 0x01;
2396 msg.setRxFlowControl = 0x01;
2398 msg.rxForwardingLength = 16;
2399 msg.rxForwardingTimeout = 16;
2400 msg.txAckSetting = 0;
2401 msg.xonChar = 17;
2402 msg.xoffChar = 19;
2404 /* Opening port */
2405 if (reset_port == 1) {
2406 msg.portEnabled = 1;
2407 msg.rxFlush = 1;
2408 msg.txBreak = (p_priv->break_on);
2410 /* Closing port */
2411 else if (reset_port == 2)
2412 msg.portEnabled = 0;
2413 /* Sending intermediate configs */
2414 else {
2415 if (port->port.count)
2416 msg.portEnabled = 1;
2417 msg.txBreak = (p_priv->break_on);
2420 /* Do handshaking outputs */
2421 msg.setRts = 0x01;
2422 msg.rts = p_priv->rts_state;
2424 msg.setDtr = 0x01;
2425 msg.dtr = p_priv->dtr_state;
2427 p_priv->resend_cont = 0;
2428 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2430 /* send the data out the device on control endpoint */
2431 this_urb->transfer_buffer_length = sizeof(msg);
2433 this_urb->dev = serial->dev;
2434 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2435 if (err != 0)
2436 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__, err);
2437 return 0;
2440 static int keyspan_usa67_send_setup(struct usb_serial *serial,
2441 struct usb_serial_port *port,
2442 int reset_port)
2444 struct keyspan_usa67_portControlMessage msg;
2445 struct keyspan_serial_private *s_priv;
2446 struct keyspan_port_private *p_priv;
2447 const struct keyspan_device_details *d_details;
2448 struct urb *this_urb;
2449 int err, device_port;
2451 dbg("%s", __func__);
2453 s_priv = usb_get_serial_data(serial);
2454 p_priv = usb_get_serial_port_data(port);
2455 d_details = s_priv->device_details;
2457 this_urb = s_priv->glocont_urb;
2459 /* Work out which port within the device is being setup */
2460 device_port = port->number - port->serial->minor;
2462 /* Make sure we have an urb then send the message */
2463 if (this_urb == NULL) {
2464 dbg("%s - oops no urb for port %d.", __func__,
2465 port->number);
2466 return -1;
2469 /* Save reset port val for resend.
2470 Don't overwrite resend for open/close condition. */
2471 if ((reset_port + 1) > p_priv->resend_cont)
2472 p_priv->resend_cont = reset_port + 1;
2473 if (this_urb->status == -EINPROGRESS) {
2474 /* dbg("%s - already writing", __func__); */
2475 mdelay(5);
2476 return -1;
2479 memset(&msg, 0, sizeof(struct keyspan_usa67_portControlMessage));
2481 msg.port = device_port;
2483 /* Only set baud rate if it's changed */
2484 if (p_priv->old_baud != p_priv->baud) {
2485 p_priv->old_baud = p_priv->baud;
2486 msg.setClocking = 0xff;
2487 if (d_details->calculate_baud_rate
2488 (p_priv->baud, d_details->baudclk, &msg.baudHi,
2489 &msg.baudLo, &msg.prescaler, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2490 dbg("%s - Invalid baud rate %d requested, using 9600.",
2491 __func__, p_priv->baud);
2492 msg.baudLo = 0;
2493 msg.baudHi = 125; /* Values for 9600 baud */
2494 msg.prescaler = 10;
2496 msg.setPrescaler = 0xff;
2499 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2500 switch (p_priv->cflag & CSIZE) {
2501 case CS5:
2502 msg.lcr |= USA_DATABITS_5;
2503 break;
2504 case CS6:
2505 msg.lcr |= USA_DATABITS_6;
2506 break;
2507 case CS7:
2508 msg.lcr |= USA_DATABITS_7;
2509 break;
2510 case CS8:
2511 msg.lcr |= USA_DATABITS_8;
2512 break;
2514 if (p_priv->cflag & PARENB) {
2515 /* note USA_PARITY_NONE == 0 */
2516 msg.lcr |= (p_priv->cflag & PARODD)?
2517 USA_PARITY_ODD : USA_PARITY_EVEN;
2519 msg.setLcr = 0xff;
2521 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2522 msg.xonFlowControl = 0;
2523 msg.setFlowControl = 0xff;
2524 msg.forwardingLength = 16;
2525 msg.xonChar = 17;
2526 msg.xoffChar = 19;
2528 if (reset_port == 1) {
2529 /* Opening port */
2530 msg._txOn = 1;
2531 msg._txOff = 0;
2532 msg.txFlush = 0;
2533 msg.txBreak = 0;
2534 msg.rxOn = 1;
2535 msg.rxOff = 0;
2536 msg.rxFlush = 1;
2537 msg.rxForward = 0;
2538 msg.returnStatus = 0;
2539 msg.resetDataToggle = 0xff;
2540 } else if (reset_port == 2) {
2541 /* Closing port */
2542 msg._txOn = 0;
2543 msg._txOff = 1;
2544 msg.txFlush = 0;
2545 msg.txBreak = 0;
2546 msg.rxOn = 0;
2547 msg.rxOff = 1;
2548 msg.rxFlush = 1;
2549 msg.rxForward = 0;
2550 msg.returnStatus = 0;
2551 msg.resetDataToggle = 0;
2552 } else {
2553 /* Sending intermediate configs */
2554 msg._txOn = (!p_priv->break_on);
2555 msg._txOff = 0;
2556 msg.txFlush = 0;
2557 msg.txBreak = (p_priv->break_on);
2558 msg.rxOn = 0;
2559 msg.rxOff = 0;
2560 msg.rxFlush = 0;
2561 msg.rxForward = 0;
2562 msg.returnStatus = 0;
2563 msg.resetDataToggle = 0x0;
2566 /* Do handshaking outputs */
2567 msg.setTxTriState_setRts = 0xff;
2568 msg.txTriState_rts = p_priv->rts_state;
2570 msg.setHskoa_setDtr = 0xff;
2571 msg.hskoa_dtr = p_priv->dtr_state;
2573 p_priv->resend_cont = 0;
2575 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2577 /* send the data out the device on control endpoint */
2578 this_urb->transfer_buffer_length = sizeof(msg);
2579 this_urb->dev = serial->dev;
2581 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2582 if (err != 0)
2583 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__,
2584 err);
2585 return 0;
2588 static void keyspan_send_setup(struct usb_serial_port *port, int reset_port)
2590 struct usb_serial *serial = port->serial;
2591 struct keyspan_serial_private *s_priv;
2592 const struct keyspan_device_details *d_details;
2594 dbg("%s", __func__);
2596 s_priv = usb_get_serial_data(serial);
2597 d_details = s_priv->device_details;
2599 switch (d_details->msg_format) {
2600 case msg_usa26:
2601 keyspan_usa26_send_setup(serial, port, reset_port);
2602 break;
2603 case msg_usa28:
2604 keyspan_usa28_send_setup(serial, port, reset_port);
2605 break;
2606 case msg_usa49:
2607 keyspan_usa49_send_setup(serial, port, reset_port);
2608 break;
2609 case msg_usa90:
2610 keyspan_usa90_send_setup(serial, port, reset_port);
2611 break;
2612 case msg_usa67:
2613 keyspan_usa67_send_setup(serial, port, reset_port);
2614 break;
2619 /* Gets called by the "real" driver (ie once firmware is loaded
2620 and renumeration has taken place. */
2621 static int keyspan_startup(struct usb_serial *serial)
2623 int i, err;
2624 struct usb_serial_port *port;
2625 struct keyspan_serial_private *s_priv;
2626 struct keyspan_port_private *p_priv;
2627 const struct keyspan_device_details *d_details;
2629 dbg("%s", __func__);
2631 for (i = 0; (d_details = keyspan_devices[i]) != NULL; ++i)
2632 if (d_details->product_id ==
2633 le16_to_cpu(serial->dev->descriptor.idProduct))
2634 break;
2635 if (d_details == NULL) {
2636 dev_err(&serial->dev->dev, "%s - unknown product id %x\n",
2637 __func__, le16_to_cpu(serial->dev->descriptor.idProduct));
2638 return 1;
2641 /* Setup private data for serial driver */
2642 s_priv = kzalloc(sizeof(struct keyspan_serial_private), GFP_KERNEL);
2643 if (!s_priv) {
2644 dbg("%s - kmalloc for keyspan_serial_private failed.",
2645 __func__);
2646 return -ENOMEM;
2649 s_priv->device_details = d_details;
2650 usb_set_serial_data(serial, s_priv);
2652 /* Now setup per port private data */
2653 for (i = 0; i < serial->num_ports; i++) {
2654 port = serial->port[i];
2655 p_priv = kzalloc(sizeof(struct keyspan_port_private),
2656 GFP_KERNEL);
2657 if (!p_priv) {
2658 dbg("%s - kmalloc for keyspan_port_private (%d) failed!.", __func__, i);
2659 return 1;
2661 p_priv->device_details = d_details;
2662 usb_set_serial_port_data(port, p_priv);
2665 keyspan_setup_urbs(serial);
2667 if (s_priv->instat_urb != NULL) {
2668 s_priv->instat_urb->dev = serial->dev;
2669 err = usb_submit_urb(s_priv->instat_urb, GFP_KERNEL);
2670 if (err != 0)
2671 dbg("%s - submit instat urb failed %d", __func__,
2672 err);
2674 if (s_priv->indat_urb != NULL) {
2675 s_priv->indat_urb->dev = serial->dev;
2676 err = usb_submit_urb(s_priv->indat_urb, GFP_KERNEL);
2677 if (err != 0)
2678 dbg("%s - submit indat urb failed %d", __func__,
2679 err);
2682 return 0;
2685 static void keyspan_shutdown(struct usb_serial *serial)
2687 int i, j;
2688 struct usb_serial_port *port;
2689 struct keyspan_serial_private *s_priv;
2690 struct keyspan_port_private *p_priv;
2692 dbg("%s", __func__);
2694 s_priv = usb_get_serial_data(serial);
2696 /* Stop reading/writing urbs */
2697 stop_urb(s_priv->instat_urb);
2698 stop_urb(s_priv->glocont_urb);
2699 stop_urb(s_priv->indat_urb);
2700 for (i = 0; i < serial->num_ports; ++i) {
2701 port = serial->port[i];
2702 p_priv = usb_get_serial_port_data(port);
2703 stop_urb(p_priv->inack_urb);
2704 stop_urb(p_priv->outcont_urb);
2705 for (j = 0; j < 2; j++) {
2706 stop_urb(p_priv->in_urbs[j]);
2707 stop_urb(p_priv->out_urbs[j]);
2711 /* Now free them */
2712 usb_free_urb(s_priv->instat_urb);
2713 usb_free_urb(s_priv->indat_urb);
2714 usb_free_urb(s_priv->glocont_urb);
2715 for (i = 0; i < serial->num_ports; ++i) {
2716 port = serial->port[i];
2717 p_priv = usb_get_serial_port_data(port);
2718 usb_free_urb(p_priv->inack_urb);
2719 usb_free_urb(p_priv->outcont_urb);
2720 for (j = 0; j < 2; j++) {
2721 usb_free_urb(p_priv->in_urbs[j]);
2722 usb_free_urb(p_priv->out_urbs[j]);
2726 /* dbg("Freeing serial->private."); */
2727 kfree(s_priv);
2729 /* dbg("Freeing port->private."); */
2730 /* Now free per port private data */
2731 for (i = 0; i < serial->num_ports; i++) {
2732 port = serial->port[i];
2733 kfree(usb_get_serial_port_data(port));
2737 MODULE_AUTHOR(DRIVER_AUTHOR);
2738 MODULE_DESCRIPTION(DRIVER_DESC);
2739 MODULE_LICENSE("GPL");
2741 MODULE_FIRMWARE("keyspan/usa28.fw");
2742 MODULE_FIRMWARE("keyspan/usa28x.fw");
2743 MODULE_FIRMWARE("keyspan/usa28xa.fw");
2744 MODULE_FIRMWARE("keyspan/usa28xb.fw");
2745 MODULE_FIRMWARE("keyspan/usa19.fw");
2746 MODULE_FIRMWARE("keyspan/usa19qi.fw");
2747 MODULE_FIRMWARE("keyspan/mpr.fw");
2748 MODULE_FIRMWARE("keyspan/usa19qw.fw");
2749 MODULE_FIRMWARE("keyspan/usa18x.fw");
2750 MODULE_FIRMWARE("keyspan/usa19w.fw");
2751 MODULE_FIRMWARE("keyspan/usa49w.fw");
2752 MODULE_FIRMWARE("keyspan/usa49wlc.fw");
2754 module_param(debug, bool, S_IRUGO | S_IWUSR);
2755 MODULE_PARM_DESC(debug, "Debug enabled or not");