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://blemings.org/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.
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
26 Tip 'o the hat to IBM (and previously Linuxcare :) for supporting
27 staff in their work on open source projects.
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
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
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>
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 */
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 */
175 unsigned int old_cflag;
176 enum {flow_none, flow_cts, flow_xon} flow_control;
177 int rts_state; /* Handshaking pins (outputs) */
179 int cts_state; /* Handshaking pins (inputs) */
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)
204 retval = usb_serial_register(&keyspan_pre_device);
206 goto failed_pre_device_register;
207 retval = usb_serial_register(&keyspan_1port_device);
209 goto failed_1port_device_register;
210 retval = usb_serial_register(&keyspan_2port_device);
212 goto failed_2port_device_register;
213 retval = usb_serial_register(&keyspan_4port_device);
215 goto failed_4port_device_register;
216 retval = usb_register(&keyspan_driver);
218 goto failed_usb_register;
220 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
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:
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;
255 p_priv = usb_get_serial_port_data(port);
257 if (break_state == -1)
258 p_priv->break_on = 1;
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;
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;
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)
306 struct usb_serial_port *port = tty->driver_data;
307 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
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);
320 static int keyspan_tiocmset(struct tty_struct *tty,
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);
327 p_priv->rts_state = 1;
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);
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;
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) {
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) {
366 if (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__);
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))
386 usb_unlink_urb(this_urb);
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);
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);
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;
414 static void usa26_indat_callback(struct urb *urb)
418 struct usb_serial_port *port;
419 struct tty_struct *tty;
420 unsigned char *data = urb->transfer_buffer;
421 int status = urb->status;
425 endpoint = usb_pipeendpoint(urb->pipe);
428 dbg("%s - nonzero status: %x on endpoint %d.",
429 __func__, status, endpoint);
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)
444 for (i = 1; i < urb->actual_length ; ++i)
445 tty_insert_flip_char(tty, data[i], err);
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)
453 if (stat & RXERROR_FRAMING)
455 if (stat & RXERROR_PARITY)
457 /* XXX should handle break (0x10) */
458 tty_insert_flip_char(tty, data[i+1], flag);
461 tty_flip_buffer_push(tty);
465 /* Resubmit urb so we continue receiving */
466 urb->dev = port->serial->dev;
467 err = usb_submit_urb(urb, GFP_ATOMIC);
469 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
472 /* Outdat handling is common for all devices */
473 static void usa2x_outdat_callback(struct urb *urb)
475 struct usb_serial_port *port;
476 struct keyspan_port_private *p_priv;
479 p_priv = usb_get_serial_port_data(port);
480 dbg("%s - urb %d", __func__, urb == p_priv->out_urbs[1]);
482 usb_serial_port_softint(port);
485 static void usa26_inack_callback(struct urb *urb)
491 static void usa26_outcont_callback(struct urb *urb)
493 struct usb_serial_port *port;
494 struct keyspan_port_private *p_priv;
497 p_priv = usb_get_serial_port_data(port);
499 if (p_priv->resend_cont) {
500 dbg("%s - sending setup", __func__);
501 keyspan_usa26_send_setup(port->serial, port,
502 p_priv->resend_cont - 1);
506 static void usa26_instat_callback(struct urb *urb)
508 unsigned char *data = urb->transfer_buffer;
509 struct keyspan_usa26_portStatusMessage *msg;
510 struct usb_serial *serial;
511 struct usb_serial_port *port;
512 struct keyspan_port_private *p_priv;
513 struct tty_struct *tty;
514 int old_dcd_state, err;
515 int status = urb->status;
517 serial = urb->context;
520 dbg("%s - nonzero status: %x", __func__, status);
523 if (urb->actual_length != 9) {
524 dbg("%s - %d byte report??", __func__, urb->actual_length);
528 msg = (struct keyspan_usa26_portStatusMessage *)data;
531 dbg("%s - port status: port %d cts %d dcd %d dsr %d ri %d toff %d txoff %d rxen %d cr %d",
532 __func__, msg->port, msg->hskia_cts, msg->gpia_dcd, msg->dsr, msg->ri, msg->_txOff,
533 msg->_txXoff, msg->rxEnabled, msg->controlResponse);
536 /* Now do something useful with the data */
539 /* Check port number from message and retrieve private data */
540 if (msg->port >= serial->num_ports) {
541 dbg("%s - Unexpected port number %d", __func__, msg->port);
544 port = serial->port[msg->port];
545 p_priv = usb_get_serial_port_data(port);
547 /* Update handshaking pin state information */
548 old_dcd_state = p_priv->dcd_state;
549 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
550 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
551 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
552 p_priv->ri_state = ((msg->ri) ? 1 : 0);
554 if (old_dcd_state != p_priv->dcd_state) {
555 tty = tty_port_tty_get(&port->port);
556 if (tty && !C_CLOCAL(tty))
561 /* Resubmit urb so we continue receiving */
562 urb->dev = serial->dev;
563 err = usb_submit_urb(urb, GFP_ATOMIC);
565 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
569 static void usa26_glocont_callback(struct urb *urb)
575 static void usa28_indat_callback(struct urb *urb)
578 struct usb_serial_port *port;
579 struct tty_struct *tty;
581 struct keyspan_port_private *p_priv;
582 int status = urb->status;
587 p_priv = usb_get_serial_port_data(port);
588 data = urb->transfer_buffer;
590 if (urb != p_priv->in_urbs[p_priv->in_flip])
595 dbg("%s - nonzero status: %x on endpoint %d.",
596 __func__, status, usb_pipeendpoint(urb->pipe));
601 p_priv = usb_get_serial_port_data(port);
602 data = urb->transfer_buffer;
604 tty =tty_port_tty_get(&port->port);
605 if (tty && urb->actual_length) {
606 tty_insert_flip_string(tty, data, urb->actual_length);
607 tty_flip_buffer_push(tty);
611 /* Resubmit urb so we continue receiving */
612 urb->dev = port->serial->dev;
613 err = usb_submit_urb(urb, GFP_ATOMIC);
615 dbg("%s - resubmit read urb failed. (%d)",
617 p_priv->in_flip ^= 1;
619 urb = p_priv->in_urbs[p_priv->in_flip];
620 } while (urb->status != -EINPROGRESS);
623 static void usa28_inack_callback(struct urb *urb)
628 static void usa28_outcont_callback(struct urb *urb)
630 struct usb_serial_port *port;
631 struct keyspan_port_private *p_priv;
634 p_priv = usb_get_serial_port_data(port);
636 if (p_priv->resend_cont) {
637 dbg("%s - sending setup", __func__);
638 keyspan_usa28_send_setup(port->serial, port,
639 p_priv->resend_cont - 1);
643 static void usa28_instat_callback(struct urb *urb)
646 unsigned char *data = urb->transfer_buffer;
647 struct keyspan_usa28_portStatusMessage *msg;
648 struct usb_serial *serial;
649 struct usb_serial_port *port;
650 struct keyspan_port_private *p_priv;
651 struct tty_struct *tty;
653 int status = urb->status;
655 serial = urb->context;
658 dbg("%s - nonzero status: %x", __func__, status);
662 if (urb->actual_length != sizeof(struct keyspan_usa28_portStatusMessage)) {
663 dbg("%s - bad length %d", __func__, urb->actual_length);
667 /*dbg("%s %x %x %x %x %x %x %x %x %x %x %x %x", __func__
668 data[0], data[1], data[2], data[3], data[4], data[5],
669 data[6], data[7], data[8], data[9], data[10], data[11]);*/
671 /* Now do something useful with the data */
672 msg = (struct keyspan_usa28_portStatusMessage *)data;
674 /* Check port number from message and retrieve private data */
675 if (msg->port >= serial->num_ports) {
676 dbg("%s - Unexpected port number %d", __func__, msg->port);
679 port = serial->port[msg->port];
680 p_priv = usb_get_serial_port_data(port);
682 /* Update handshaking pin state information */
683 old_dcd_state = p_priv->dcd_state;
684 p_priv->cts_state = ((msg->cts) ? 1 : 0);
685 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
686 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
687 p_priv->ri_state = ((msg->ri) ? 1 : 0);
689 if( old_dcd_state != p_priv->dcd_state && old_dcd_state) {
690 tty = tty_port_tty_get(&port->port);
691 if (tty && !C_CLOCAL(tty))
696 /* Resubmit urb so we continue receiving */
697 urb->dev = serial->dev;
698 err = usb_submit_urb(urb, GFP_ATOMIC);
700 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
704 static void usa28_glocont_callback(struct urb *urb)
710 static void usa49_glocont_callback(struct urb *urb)
712 struct usb_serial *serial;
713 struct usb_serial_port *port;
714 struct keyspan_port_private *p_priv;
719 serial = urb->context;
720 for (i = 0; i < serial->num_ports; ++i) {
721 port = serial->port[i];
722 p_priv = usb_get_serial_port_data(port);
724 if (p_priv->resend_cont) {
725 dbg("%s - sending setup", __func__);
726 keyspan_usa49_send_setup(serial, port,
727 p_priv->resend_cont - 1);
733 /* This is actually called glostat in the Keyspan
735 static void usa49_instat_callback(struct urb *urb)
738 unsigned char *data = urb->transfer_buffer;
739 struct keyspan_usa49_portStatusMessage *msg;
740 struct usb_serial *serial;
741 struct usb_serial_port *port;
742 struct keyspan_port_private *p_priv;
744 int status = urb->status;
748 serial = urb->context;
751 dbg("%s - nonzero status: %x", __func__, status);
755 if (urb->actual_length !=
756 sizeof(struct keyspan_usa49_portStatusMessage)) {
757 dbg("%s - bad length %d", __func__, urb->actual_length);
761 /*dbg(" %x %x %x %x %x %x %x %x %x %x %x", __func__,
762 data[0], data[1], data[2], data[3], data[4], data[5],
763 data[6], data[7], data[8], data[9], data[10]);*/
765 /* Now do something useful with the data */
766 msg = (struct keyspan_usa49_portStatusMessage *)data;
768 /* Check port number from message and retrieve private data */
769 if (msg->portNumber >= serial->num_ports) {
770 dbg("%s - Unexpected port number %d",
771 __func__, msg->portNumber);
774 port = serial->port[msg->portNumber];
775 p_priv = usb_get_serial_port_data(port);
777 /* Update handshaking pin state information */
778 old_dcd_state = p_priv->dcd_state;
779 p_priv->cts_state = ((msg->cts) ? 1 : 0);
780 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
781 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
782 p_priv->ri_state = ((msg->ri) ? 1 : 0);
784 if (old_dcd_state != p_priv->dcd_state && old_dcd_state) {
785 struct tty_struct *tty = tty_port_tty_get(&port->port);
786 if (tty && !C_CLOCAL(tty))
791 /* Resubmit urb so we continue receiving */
792 urb->dev = serial->dev;
794 err = usb_submit_urb(urb, GFP_ATOMIC);
796 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
800 static void usa49_inack_callback(struct urb *urb)
805 static void usa49_indat_callback(struct urb *urb)
809 struct usb_serial_port *port;
810 struct tty_struct *tty;
811 unsigned char *data = urb->transfer_buffer;
812 int status = urb->status;
816 endpoint = usb_pipeendpoint(urb->pipe);
819 dbg("%s - nonzero status: %x on endpoint %d.", __func__,
825 tty = tty_port_tty_get(&port->port);
826 if (tty && urb->actual_length) {
827 /* 0x80 bit is error flag */
828 if ((data[0] & 0x80) == 0) {
829 /* no error on any byte */
830 tty_insert_flip_string(tty, data + 1,
831 urb->actual_length - 1);
833 /* some bytes had errors, every byte has status */
834 for (i = 0; i + 1 < urb->actual_length; i += 2) {
835 int stat = data[i], flag = 0;
836 if (stat & RXERROR_OVERRUN)
838 if (stat & RXERROR_FRAMING)
840 if (stat & RXERROR_PARITY)
842 /* XXX should handle break (0x10) */
843 tty_insert_flip_char(tty, data[i+1], flag);
846 tty_flip_buffer_push(tty);
850 /* Resubmit urb so we continue receiving */
851 urb->dev = port->serial->dev;
852 err = usb_submit_urb(urb, GFP_ATOMIC);
854 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
857 static void usa49wg_indat_callback(struct urb *urb)
860 struct usb_serial *serial;
861 struct usb_serial_port *port;
862 struct tty_struct *tty;
863 unsigned char *data = urb->transfer_buffer;
864 int status = urb->status;
868 serial = urb->context;
871 dbg("%s - nonzero status: %x", __func__, status);
875 /* inbound data is in the form P#, len, status, data */
879 if (urb->actual_length) {
880 while (i < urb->actual_length) {
882 /* Check port number from message*/
883 if (data[i] >= serial->num_ports) {
884 dbg("%s - Unexpected port number %d",
888 port = serial->port[data[i++]];
889 tty = tty_port_tty_get(&port->port);
892 /* 0x80 bit is error flag */
893 if ((data[i] & 0x80) == 0) {
894 /* no error on any byte */
896 for (x = 1; x < len ; ++x)
897 tty_insert_flip_char(tty, data[i++], 0);
900 * some bytes had errors, every byte has status
902 for (x = 0; x + 1 < len; x += 2) {
903 int stat = data[i], flag = 0;
904 if (stat & RXERROR_OVERRUN)
906 if (stat & RXERROR_FRAMING)
908 if (stat & RXERROR_PARITY)
910 /* XXX should handle break (0x10) */
911 tty_insert_flip_char(tty,
916 tty_flip_buffer_push(tty);
921 /* Resubmit urb so we continue receiving */
922 urb->dev = serial->dev;
924 err = usb_submit_urb(urb, GFP_ATOMIC);
926 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
929 /* not used, usa-49 doesn't have per-port control endpoints */
930 static void usa49_outcont_callback(struct urb *urb)
935 static void usa90_indat_callback(struct urb *urb)
939 struct usb_serial_port *port;
940 struct keyspan_port_private *p_priv;
941 struct tty_struct *tty;
942 unsigned char *data = urb->transfer_buffer;
943 int status = urb->status;
947 endpoint = usb_pipeendpoint(urb->pipe);
950 dbg("%s - nonzero status: %x on endpoint %d.",
951 __func__, status, endpoint);
956 p_priv = usb_get_serial_port_data(port);
958 if (urb->actual_length) {
959 tty = tty_port_tty_get(&port->port);
960 /* if current mode is DMA, looks like usa28 format
961 otherwise looks like usa26 data format */
963 if (p_priv->baud > 57600)
964 tty_insert_flip_string(tty, data, urb->actual_length);
966 /* 0x80 bit is error flag */
967 if ((data[0] & 0x80) == 0) {
968 /* no errors on individual bytes, only
969 possible overrun err*/
970 if (data[0] & RXERROR_OVERRUN)
974 for (i = 1; i < urb->actual_length ; ++i)
975 tty_insert_flip_char(tty, data[i],
978 /* some bytes had errors, every byte has status */
979 dbg("%s - RX error!!!!", __func__);
980 for (i = 0; i + 1 < urb->actual_length; i += 2) {
981 int stat = data[i], flag = 0;
982 if (stat & RXERROR_OVERRUN)
984 if (stat & RXERROR_FRAMING)
986 if (stat & RXERROR_PARITY)
988 /* XXX should handle break (0x10) */
989 tty_insert_flip_char(tty, data[i+1],
994 tty_flip_buffer_push(tty);
998 /* Resubmit urb so we continue receiving */
999 urb->dev = port->serial->dev;
1000 err = usb_submit_urb(urb, GFP_ATOMIC);
1002 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
1006 static void usa90_instat_callback(struct urb *urb)
1008 unsigned char *data = urb->transfer_buffer;
1009 struct keyspan_usa90_portStatusMessage *msg;
1010 struct usb_serial *serial;
1011 struct usb_serial_port *port;
1012 struct keyspan_port_private *p_priv;
1013 struct tty_struct *tty;
1014 int old_dcd_state, err;
1015 int status = urb->status;
1017 serial = urb->context;
1020 dbg("%s - nonzero status: %x", __func__, status);
1023 if (urb->actual_length < 14) {
1024 dbg("%s - %d byte report??", __func__, urb->actual_length);
1028 msg = (struct keyspan_usa90_portStatusMessage *)data;
1030 /* Now do something useful with the data */
1032 port = serial->port[0];
1033 p_priv = usb_get_serial_port_data(port);
1035 /* Update handshaking pin state information */
1036 old_dcd_state = p_priv->dcd_state;
1037 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1038 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1039 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1040 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1042 if (old_dcd_state != p_priv->dcd_state && old_dcd_state) {
1043 tty = tty_port_tty_get(&port->port);
1044 if (tty && !C_CLOCAL(tty))
1049 /* Resubmit urb so we continue receiving */
1050 urb->dev = serial->dev;
1051 err = usb_submit_urb(urb, GFP_ATOMIC);
1053 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
1058 static void usa90_outcont_callback(struct urb *urb)
1060 struct usb_serial_port *port;
1061 struct keyspan_port_private *p_priv;
1063 port = urb->context;
1064 p_priv = usb_get_serial_port_data(port);
1066 if (p_priv->resend_cont) {
1067 dbg("%s - sending setup", __func__);
1068 keyspan_usa90_send_setup(port->serial, port,
1069 p_priv->resend_cont - 1);
1073 /* Status messages from the 28xg */
1074 static void usa67_instat_callback(struct urb *urb)
1077 unsigned char *data = urb->transfer_buffer;
1078 struct keyspan_usa67_portStatusMessage *msg;
1079 struct usb_serial *serial;
1080 struct usb_serial_port *port;
1081 struct keyspan_port_private *p_priv;
1083 int status = urb->status;
1085 dbg("%s", __func__);
1087 serial = urb->context;
1090 dbg("%s - nonzero status: %x", __func__, status);
1094 if (urb->actual_length !=
1095 sizeof(struct keyspan_usa67_portStatusMessage)) {
1096 dbg("%s - bad length %d", __func__, urb->actual_length);
1101 /* Now do something useful with the data */
1102 msg = (struct keyspan_usa67_portStatusMessage *)data;
1104 /* Check port number from message and retrieve private data */
1105 if (msg->port >= serial->num_ports) {
1106 dbg("%s - Unexpected port number %d", __func__, msg->port);
1110 port = serial->port[msg->port];
1111 p_priv = usb_get_serial_port_data(port);
1113 /* Update handshaking pin state information */
1114 old_dcd_state = p_priv->dcd_state;
1115 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
1116 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
1118 if (old_dcd_state != p_priv->dcd_state && old_dcd_state) {
1119 struct tty_struct *tty = tty_port_tty_get(&port->port);
1120 if (tty && !C_CLOCAL(tty))
1125 /* Resubmit urb so we continue receiving */
1126 urb->dev = serial->dev;
1127 err = usb_submit_urb(urb, GFP_ATOMIC);
1129 dbg("%s - resubmit read urb failed. (%d)", __func__, err);
1132 static void usa67_glocont_callback(struct urb *urb)
1134 struct usb_serial *serial;
1135 struct usb_serial_port *port;
1136 struct keyspan_port_private *p_priv;
1139 dbg("%s", __func__);
1141 serial = urb->context;
1142 for (i = 0; i < serial->num_ports; ++i) {
1143 port = serial->port[i];
1144 p_priv = usb_get_serial_port_data(port);
1146 if (p_priv->resend_cont) {
1147 dbg("%s - sending setup", __func__);
1148 keyspan_usa67_send_setup(serial, port,
1149 p_priv->resend_cont - 1);
1155 static int keyspan_write_room(struct tty_struct *tty)
1157 struct usb_serial_port *port = tty->driver_data;
1158 struct keyspan_port_private *p_priv;
1159 const struct keyspan_device_details *d_details;
1162 struct urb *this_urb;
1164 dbg("%s", __func__);
1165 p_priv = usb_get_serial_port_data(port);
1166 d_details = p_priv->device_details;
1168 /* FIXME: locking */
1169 if (d_details->msg_format == msg_usa90)
1174 flip = p_priv->out_flip;
1176 /* Check both endpoints to see if any are available. */
1177 this_urb = p_priv->out_urbs[flip];
1178 if (this_urb != NULL) {
1179 if (this_urb->status != -EINPROGRESS)
1181 flip = (flip + 1) & d_details->outdat_endp_flip;
1182 this_urb = p_priv->out_urbs[flip];
1183 if (this_urb != NULL) {
1184 if (this_urb->status != -EINPROGRESS)
1192 static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port)
1194 struct keyspan_port_private *p_priv;
1195 struct keyspan_serial_private *s_priv;
1196 struct usb_serial *serial = port->serial;
1197 const struct keyspan_device_details *d_details;
1199 int baud_rate, device_port;
1201 unsigned int cflag = 0;
1203 s_priv = usb_get_serial_data(serial);
1204 p_priv = usb_get_serial_port_data(port);
1205 d_details = p_priv->device_details;
1207 dbg("%s - port%d.", __func__, port->number);
1209 /* Set some sane defaults */
1210 p_priv->rts_state = 1;
1211 p_priv->dtr_state = 1;
1212 p_priv->baud = 9600;
1214 /* force baud and lcr to be set on open */
1215 p_priv->old_baud = 0;
1216 p_priv->old_cflag = 0;
1218 p_priv->out_flip = 0;
1219 p_priv->in_flip = 0;
1221 /* Reset low level data toggle and start reading from endpoints */
1222 for (i = 0; i < 2; i++) {
1223 urb = p_priv->in_urbs[i];
1226 urb->dev = serial->dev;
1228 /* make sure endpoint data toggle is synchronized
1230 usb_clear_halt(urb->dev, urb->pipe);
1231 err = usb_submit_urb(urb, GFP_KERNEL);
1233 dbg("%s - submit urb %d failed (%d)",
1237 /* Reset low level data toggle on out endpoints */
1238 for (i = 0; i < 2; i++) {
1239 urb = p_priv->out_urbs[i];
1242 urb->dev = serial->dev;
1243 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1244 usb_pipeout(urb->pipe), 0); */
1247 /* get the terminal config for the setup message now so we don't
1248 * need to send 2 of them */
1250 device_port = port->number - port->serial->minor;
1252 cflag = tty->termios->c_cflag;
1253 /* Baud rate calculation takes baud rate as an integer
1254 so other rates can be generated if desired. */
1255 baud_rate = tty_get_baud_rate(tty);
1256 /* If no match or invalid, leave as default */
1258 && d_details->calculate_baud_rate(baud_rate, d_details->baudclk,
1259 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
1260 p_priv->baud = baud_rate;
1263 /* set CTS/RTS handshake etc. */
1264 p_priv->cflag = cflag;
1265 p_priv->flow_control = (cflag & CRTSCTS)? flow_cts: flow_none;
1267 keyspan_send_setup(port, 1);
1269 /* keyspan_set_termios(port, NULL); */
1274 static inline void stop_urb(struct urb *urb)
1276 if (urb && urb->status == -EINPROGRESS)
1280 static void keyspan_dtr_rts(struct usb_serial_port *port, int on)
1282 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
1284 p_priv->rts_state = on;
1285 p_priv->dtr_state = on;
1286 keyspan_send_setup(port, 0);
1289 static void keyspan_close(struct usb_serial_port *port)
1292 struct usb_serial *serial = port->serial;
1293 struct keyspan_serial_private *s_priv;
1294 struct keyspan_port_private *p_priv;
1296 dbg("%s", __func__);
1297 s_priv = usb_get_serial_data(serial);
1298 p_priv = usb_get_serial_port_data(port);
1300 p_priv->rts_state = 0;
1301 p_priv->dtr_state = 0;
1304 keyspan_send_setup(port, 2);
1305 /* pilot-xfer seems to work best with this delay */
1307 /* keyspan_set_termios(port, NULL); */
1310 /*while (p_priv->outcont_urb->status == -EINPROGRESS) {
1311 dbg("%s - urb in progress", __func__);
1314 p_priv->out_flip = 0;
1315 p_priv->in_flip = 0;
1318 /* Stop reading/writing urbs */
1319 stop_urb(p_priv->inack_urb);
1320 /* stop_urb(p_priv->outcont_urb); */
1321 for (i = 0; i < 2; i++) {
1322 stop_urb(p_priv->in_urbs[i]);
1323 stop_urb(p_priv->out_urbs[i]);
1328 /* download the firmware to a pre-renumeration device */
1329 static int keyspan_fake_startup(struct usb_serial *serial)
1332 const struct ihex_binrec *record;
1334 const struct firmware *fw;
1336 dbg("Keyspan startup version %04x product %04x",
1337 le16_to_cpu(serial->dev->descriptor.bcdDevice),
1338 le16_to_cpu(serial->dev->descriptor.idProduct));
1340 if ((le16_to_cpu(serial->dev->descriptor.bcdDevice) & 0x8000)
1342 dbg("Firmware already loaded. Quitting.");
1346 /* Select firmware image on the basis of idProduct */
1347 switch (le16_to_cpu(serial->dev->descriptor.idProduct)) {
1348 case keyspan_usa28_pre_product_id:
1349 fw_name = "keyspan/usa28.fw";
1352 case keyspan_usa28x_pre_product_id:
1353 fw_name = "keyspan/usa28x.fw";
1356 case keyspan_usa28xa_pre_product_id:
1357 fw_name = "keyspan/usa28xa.fw";
1360 case keyspan_usa28xb_pre_product_id:
1361 fw_name = "keyspan/usa28xb.fw";
1364 case keyspan_usa19_pre_product_id:
1365 fw_name = "keyspan/usa19.fw";
1368 case keyspan_usa19qi_pre_product_id:
1369 fw_name = "keyspan/usa19qi.fw";
1372 case keyspan_mpr_pre_product_id:
1373 fw_name = "keyspan/mpr.fw";
1376 case keyspan_usa19qw_pre_product_id:
1377 fw_name = "keyspan/usa19qw.fw";
1380 case keyspan_usa18x_pre_product_id:
1381 fw_name = "keyspan/usa18x.fw";
1384 case keyspan_usa19w_pre_product_id:
1385 fw_name = "keyspan/usa19w.fw";
1388 case keyspan_usa49w_pre_product_id:
1389 fw_name = "keyspan/usa49w.fw";
1392 case keyspan_usa49wlc_pre_product_id:
1393 fw_name = "keyspan/usa49wlc.fw";
1397 dev_err(&serial->dev->dev, "Unknown product ID (%04x)\n",
1398 le16_to_cpu(serial->dev->descriptor.idProduct));
1402 if (request_ihex_firmware(&fw, fw_name, &serial->dev->dev)) {
1403 dev_err(&serial->dev->dev, "Required keyspan firmware image (%s) unavailable.\n", fw_name);
1407 dbg("Uploading Keyspan %s firmware.", fw_name);
1409 /* download the firmware image */
1410 response = ezusb_set_reset(serial, 1);
1412 record = (const struct ihex_binrec *)fw->data;
1415 response = ezusb_writememory(serial, be32_to_cpu(record->addr),
1416 (unsigned char *)record->data,
1417 be16_to_cpu(record->len), 0xa0);
1419 dev_err(&serial->dev->dev, "ezusb_writememory failed for Keyspan firmware (%d %04X %p %d)\n",
1420 response, be32_to_cpu(record->addr),
1421 record->data, be16_to_cpu(record->len));
1424 record = ihex_next_binrec(record);
1426 release_firmware(fw);
1427 /* bring device out of reset. Renumeration will occur in a
1428 moment and the new device will bind to the real driver */
1429 response = ezusb_set_reset(serial, 0);
1431 /* we don't want this device to have a driver assigned to it. */
1435 /* Helper functions used by keyspan_setup_urbs */
1436 static struct usb_endpoint_descriptor const *find_ep(struct usb_serial const *serial,
1439 struct usb_host_interface *iface_desc;
1440 struct usb_endpoint_descriptor *ep;
1443 iface_desc = serial->interface->cur_altsetting;
1444 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1445 ep = &iface_desc->endpoint[i].desc;
1446 if (ep->bEndpointAddress == endpoint)
1449 dev_warn(&serial->interface->dev, "found no endpoint descriptor for "
1450 "endpoint %x\n", endpoint);
1454 static struct urb *keyspan_setup_urb(struct usb_serial *serial, int endpoint,
1455 int dir, void *ctx, char *buf, int len,
1456 void (*callback)(struct urb *))
1459 struct usb_endpoint_descriptor const *ep_desc;
1460 char const *ep_type_name;
1463 return NULL; /* endpoint not needed */
1465 dbg("%s - alloc for endpoint %d.", __func__, endpoint);
1466 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
1468 dbg("%s - alloc for endpoint %d failed.", __func__, endpoint);
1472 if (endpoint == 0) {
1473 /* control EP filled in when used */
1477 ep_desc = find_ep(serial, endpoint);
1479 /* leak the urb, something's wrong and the callers don't care */
1482 if (usb_endpoint_xfer_int(ep_desc)) {
1483 ep_type_name = "INT";
1484 usb_fill_int_urb(urb, serial->dev,
1485 usb_sndintpipe(serial->dev, endpoint) | dir,
1486 buf, len, callback, ctx,
1487 ep_desc->bInterval);
1488 } else if (usb_endpoint_xfer_bulk(ep_desc)) {
1489 ep_type_name = "BULK";
1490 usb_fill_bulk_urb(urb, serial->dev,
1491 usb_sndbulkpipe(serial->dev, endpoint) | dir,
1492 buf, len, callback, ctx);
1494 dev_warn(&serial->interface->dev,
1495 "unsupported endpoint type %x\n",
1496 usb_endpoint_type(ep_desc));
1501 dbg("%s - using urb %p for %s endpoint %x",
1502 __func__, urb, ep_type_name, endpoint);
1506 static struct callbacks {
1507 void (*instat_callback)(struct urb *);
1508 void (*glocont_callback)(struct urb *);
1509 void (*indat_callback)(struct urb *);
1510 void (*outdat_callback)(struct urb *);
1511 void (*inack_callback)(struct urb *);
1512 void (*outcont_callback)(struct urb *);
1513 } keyspan_callbacks[] = {
1515 /* msg_usa26 callbacks */
1516 .instat_callback = usa26_instat_callback,
1517 .glocont_callback = usa26_glocont_callback,
1518 .indat_callback = usa26_indat_callback,
1519 .outdat_callback = usa2x_outdat_callback,
1520 .inack_callback = usa26_inack_callback,
1521 .outcont_callback = usa26_outcont_callback,
1523 /* msg_usa28 callbacks */
1524 .instat_callback = usa28_instat_callback,
1525 .glocont_callback = usa28_glocont_callback,
1526 .indat_callback = usa28_indat_callback,
1527 .outdat_callback = usa2x_outdat_callback,
1528 .inack_callback = usa28_inack_callback,
1529 .outcont_callback = usa28_outcont_callback,
1531 /* msg_usa49 callbacks */
1532 .instat_callback = usa49_instat_callback,
1533 .glocont_callback = usa49_glocont_callback,
1534 .indat_callback = usa49_indat_callback,
1535 .outdat_callback = usa2x_outdat_callback,
1536 .inack_callback = usa49_inack_callback,
1537 .outcont_callback = usa49_outcont_callback,
1539 /* msg_usa90 callbacks */
1540 .instat_callback = usa90_instat_callback,
1541 .glocont_callback = usa28_glocont_callback,
1542 .indat_callback = usa90_indat_callback,
1543 .outdat_callback = usa2x_outdat_callback,
1544 .inack_callback = usa28_inack_callback,
1545 .outcont_callback = usa90_outcont_callback,
1547 /* msg_usa67 callbacks */
1548 .instat_callback = usa67_instat_callback,
1549 .glocont_callback = usa67_glocont_callback,
1550 .indat_callback = usa26_indat_callback,
1551 .outdat_callback = usa2x_outdat_callback,
1552 .inack_callback = usa26_inack_callback,
1553 .outcont_callback = usa26_outcont_callback,
1557 /* Generic setup urbs function that uses
1558 data in device_details */
1559 static void keyspan_setup_urbs(struct usb_serial *serial)
1562 struct keyspan_serial_private *s_priv;
1563 const struct keyspan_device_details *d_details;
1564 struct usb_serial_port *port;
1565 struct keyspan_port_private *p_priv;
1566 struct callbacks *cback;
1569 dbg("%s", __func__);
1571 s_priv = usb_get_serial_data(serial);
1572 d_details = s_priv->device_details;
1574 /* Setup values for the various callback routines */
1575 cback = &keyspan_callbacks[d_details->msg_format];
1577 /* Allocate and set up urbs for each one that is in use,
1578 starting with instat endpoints */
1579 s_priv->instat_urb = keyspan_setup_urb
1580 (serial, d_details->instat_endpoint, USB_DIR_IN,
1581 serial, s_priv->instat_buf, INSTAT_BUFLEN,
1582 cback->instat_callback);
1584 s_priv->indat_urb = keyspan_setup_urb
1585 (serial, d_details->indat_endpoint, USB_DIR_IN,
1586 serial, s_priv->indat_buf, INDAT49W_BUFLEN,
1587 usa49wg_indat_callback);
1589 s_priv->glocont_urb = keyspan_setup_urb
1590 (serial, d_details->glocont_endpoint, USB_DIR_OUT,
1591 serial, s_priv->glocont_buf, GLOCONT_BUFLEN,
1592 cback->glocont_callback);
1594 /* Setup endpoints for each port specific thing */
1595 for (i = 0; i < d_details->num_ports; i++) {
1596 port = serial->port[i];
1597 p_priv = usb_get_serial_port_data(port);
1599 /* Do indat endpoints first, once for each flip */
1600 endp = d_details->indat_endpoints[i];
1601 for (j = 0; j <= d_details->indat_endp_flip; ++j, ++endp) {
1602 p_priv->in_urbs[j] = keyspan_setup_urb
1603 (serial, endp, USB_DIR_IN, port,
1604 p_priv->in_buffer[j], 64,
1605 cback->indat_callback);
1608 p_priv->in_urbs[j] = NULL;
1610 /* outdat endpoints also have flip */
1611 endp = d_details->outdat_endpoints[i];
1612 for (j = 0; j <= d_details->outdat_endp_flip; ++j, ++endp) {
1613 p_priv->out_urbs[j] = keyspan_setup_urb
1614 (serial, endp, USB_DIR_OUT, port,
1615 p_priv->out_buffer[j], 64,
1616 cback->outdat_callback);
1619 p_priv->out_urbs[j] = NULL;
1621 /* inack endpoint */
1622 p_priv->inack_urb = keyspan_setup_urb
1623 (serial, d_details->inack_endpoints[i], USB_DIR_IN,
1624 port, p_priv->inack_buffer, 1, cback->inack_callback);
1626 /* outcont endpoint */
1627 p_priv->outcont_urb = keyspan_setup_urb
1628 (serial, d_details->outcont_endpoints[i], USB_DIR_OUT,
1629 port, p_priv->outcont_buffer, 64,
1630 cback->outcont_callback);
1634 /* usa19 function doesn't require prescaler */
1635 static int keyspan_usa19_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1636 u8 *rate_low, u8 *prescaler, int portnum)
1638 u32 b16, /* baud rate times 16 (actual rate used internally) */
1640 cnt; /* inverse of divisor (programmed into 8051) */
1642 dbg("%s - %d.", __func__, baud_rate);
1644 /* prevent divide by zero... */
1645 b16 = baud_rate * 16L;
1647 return KEYSPAN_INVALID_BAUD_RATE;
1648 /* Any "standard" rate over 57k6 is marginal on the USA-19
1649 as we run out of divisor resolution. */
1650 if (baud_rate > 57600)
1651 return KEYSPAN_INVALID_BAUD_RATE;
1653 /* calculate the divisor and the counter (its inverse) */
1654 div = baudclk / b16;
1656 return KEYSPAN_INVALID_BAUD_RATE;
1661 return KEYSPAN_INVALID_BAUD_RATE;
1663 /* return the counter values if non-null */
1665 *rate_low = (u8) (cnt & 0xff);
1667 *rate_hi = (u8) ((cnt >> 8) & 0xff);
1668 if (rate_low && rate_hi)
1669 dbg("%s - %d %02x %02x.",
1670 __func__, baud_rate, *rate_hi, *rate_low);
1671 return KEYSPAN_BAUD_RATE_OK;
1674 /* usa19hs function doesn't require prescaler */
1675 static int keyspan_usa19hs_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1676 u8 *rate_low, u8 *prescaler, int portnum)
1678 u32 b16, /* baud rate times 16 (actual rate used internally) */
1681 dbg("%s - %d.", __func__, baud_rate);
1683 /* prevent divide by zero... */
1684 b16 = baud_rate * 16L;
1686 return KEYSPAN_INVALID_BAUD_RATE;
1688 /* calculate the divisor */
1689 div = baudclk / b16;
1691 return KEYSPAN_INVALID_BAUD_RATE;
1694 return KEYSPAN_INVALID_BAUD_RATE;
1696 /* return the counter values if non-null */
1698 *rate_low = (u8) (div & 0xff);
1701 *rate_hi = (u8) ((div >> 8) & 0xff);
1703 if (rate_low && rate_hi)
1704 dbg("%s - %d %02x %02x.",
1705 __func__, baud_rate, *rate_hi, *rate_low);
1707 return KEYSPAN_BAUD_RATE_OK;
1710 static int keyspan_usa19w_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1711 u8 *rate_low, u8 *prescaler, int portnum)
1713 u32 b16, /* baud rate times 16 (actual rate used internally) */
1714 clk, /* clock with 13/8 prescaler */
1715 div, /* divisor using 13/8 prescaler */
1716 res, /* resulting baud rate using 13/8 prescaler */
1717 diff, /* error using 13/8 prescaler */
1722 dbg("%s - %d.", __func__, baud_rate);
1724 /* prevent divide by zero */
1725 b16 = baud_rate * 16L;
1727 return KEYSPAN_INVALID_BAUD_RATE;
1729 /* Calculate prescaler by trying them all and looking
1732 /* start with largest possible difference */
1733 smallest_diff = 0xffffffff;
1735 /* 0 is an invalid prescaler, used as a flag */
1738 for (i = 8; i <= 0xff; ++i) {
1739 clk = (baudclk * 8) / (u32) i;
1746 diff = (res > b16) ? (res-b16) : (b16-res);
1748 if (diff < smallest_diff) {
1750 smallest_diff = diff;
1754 if (best_prescaler == 0)
1755 return KEYSPAN_INVALID_BAUD_RATE;
1757 clk = (baudclk * 8) / (u32) best_prescaler;
1760 /* return the divisor and prescaler if non-null */
1762 *rate_low = (u8) (div & 0xff);
1764 *rate_hi = (u8) ((div >> 8) & 0xff);
1766 *prescaler = best_prescaler;
1767 /* dbg("%s - %d %d", __func__, *prescaler, div); */
1769 return KEYSPAN_BAUD_RATE_OK;
1772 /* USA-28 supports different maximum baud rates on each port */
1773 static int keyspan_usa28_calc_baud(u32 baud_rate, u32 baudclk, u8 *rate_hi,
1774 u8 *rate_low, u8 *prescaler, int portnum)
1776 u32 b16, /* baud rate times 16 (actual rate used internally) */
1778 cnt; /* inverse of divisor (programmed into 8051) */
1780 dbg("%s - %d.", __func__, baud_rate);
1782 /* prevent divide by zero */
1783 b16 = baud_rate * 16L;
1785 return KEYSPAN_INVALID_BAUD_RATE;
1787 /* calculate the divisor and the counter (its inverse) */
1788 div = KEYSPAN_USA28_BAUDCLK / b16;
1790 return KEYSPAN_INVALID_BAUD_RATE;
1794 /* check for out of range, based on portnum,
1795 and return result */
1798 return KEYSPAN_INVALID_BAUD_RATE;
1802 return KEYSPAN_INVALID_BAUD_RATE;
1804 return KEYSPAN_INVALID_BAUD_RATE;
1807 /* return the counter values if not NULL
1808 (port 1 will ignore retHi) */
1810 *rate_low = (u8) (cnt & 0xff);
1812 *rate_hi = (u8) ((cnt >> 8) & 0xff);
1813 dbg("%s - %d OK.", __func__, baud_rate);
1814 return KEYSPAN_BAUD_RATE_OK;
1817 static int keyspan_usa26_send_setup(struct usb_serial *serial,
1818 struct usb_serial_port *port,
1821 struct keyspan_usa26_portControlMessage msg;
1822 struct keyspan_serial_private *s_priv;
1823 struct keyspan_port_private *p_priv;
1824 const struct keyspan_device_details *d_details;
1826 struct urb *this_urb;
1827 int device_port, err;
1829 dbg("%s reset=%d", __func__, reset_port);
1831 s_priv = usb_get_serial_data(serial);
1832 p_priv = usb_get_serial_port_data(port);
1833 d_details = s_priv->device_details;
1834 device_port = port->number - port->serial->minor;
1836 outcont_urb = d_details->outcont_endpoints[port->number];
1837 this_urb = p_priv->outcont_urb;
1839 dbg("%s - endpoint %d", __func__, usb_pipeendpoint(this_urb->pipe));
1841 /* Make sure we have an urb then send the message */
1842 if (this_urb == NULL) {
1843 dbg("%s - oops no urb.", __func__);
1847 /* Save reset port val for resend.
1848 Don't overwrite resend for open/close condition. */
1849 if ((reset_port + 1) > p_priv->resend_cont)
1850 p_priv->resend_cont = reset_port + 1;
1851 if (this_urb->status == -EINPROGRESS) {
1852 /* dbg("%s - already writing", __func__); */
1857 memset(&msg, 0, sizeof(struct keyspan_usa26_portControlMessage));
1859 /* Only set baud rate if it's changed */
1860 if (p_priv->old_baud != p_priv->baud) {
1861 p_priv->old_baud = p_priv->baud;
1862 msg.setClocking = 0xff;
1863 if (d_details->calculate_baud_rate
1864 (p_priv->baud, d_details->baudclk, &msg.baudHi,
1865 &msg.baudLo, &msg.prescaler, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
1866 dbg("%s - Invalid baud rate %d requested, using 9600.",
1867 __func__, p_priv->baud);
1869 msg.baudHi = 125; /* Values for 9600 baud */
1872 msg.setPrescaler = 0xff;
1875 msg.lcr = (p_priv->cflag & CSTOPB)? STOPBITS_678_2: STOPBITS_5678_1;
1876 switch (p_priv->cflag & CSIZE) {
1878 msg.lcr |= USA_DATABITS_5;
1881 msg.lcr |= USA_DATABITS_6;
1884 msg.lcr |= USA_DATABITS_7;
1887 msg.lcr |= USA_DATABITS_8;
1890 if (p_priv->cflag & PARENB) {
1891 /* note USA_PARITY_NONE == 0 */
1892 msg.lcr |= (p_priv->cflag & PARODD)?
1893 USA_PARITY_ODD : USA_PARITY_EVEN;
1897 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
1898 msg.xonFlowControl = 0;
1899 msg.setFlowControl = 0xff;
1900 msg.forwardingLength = 16;
1905 if (reset_port == 1) {
1914 msg.returnStatus = 0;
1915 msg.resetDataToggle = 0xff;
1919 else if (reset_port == 2) {
1928 msg.returnStatus = 0;
1929 msg.resetDataToggle = 0;
1932 /* Sending intermediate configs */
1934 msg._txOn = (!p_priv->break_on);
1937 msg.txBreak = (p_priv->break_on);
1942 msg.returnStatus = 0;
1943 msg.resetDataToggle = 0x0;
1946 /* Do handshaking outputs */
1947 msg.setTxTriState_setRts = 0xff;
1948 msg.txTriState_rts = p_priv->rts_state;
1950 msg.setHskoa_setDtr = 0xff;
1951 msg.hskoa_dtr = p_priv->dtr_state;
1953 p_priv->resend_cont = 0;
1954 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
1956 /* send the data out the device on control endpoint */
1957 this_urb->transfer_buffer_length = sizeof(msg);
1959 this_urb->dev = serial->dev;
1960 err = usb_submit_urb(this_urb, GFP_ATOMIC);
1962 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__, err);
1965 dbg("%s - usb_submit_urb(%d) OK %d bytes (end %d)", __func__
1966 outcont_urb, this_urb->transfer_buffer_length,
1967 usb_pipeendpoint(this_urb->pipe));
1974 static int keyspan_usa28_send_setup(struct usb_serial *serial,
1975 struct usb_serial_port *port,
1978 struct keyspan_usa28_portControlMessage msg;
1979 struct keyspan_serial_private *s_priv;
1980 struct keyspan_port_private *p_priv;
1981 const struct keyspan_device_details *d_details;
1982 struct urb *this_urb;
1983 int device_port, err;
1985 dbg("%s", __func__);
1987 s_priv = usb_get_serial_data(serial);
1988 p_priv = usb_get_serial_port_data(port);
1989 d_details = s_priv->device_details;
1990 device_port = port->number - port->serial->minor;
1992 /* only do something if we have a bulk out endpoint */
1993 this_urb = p_priv->outcont_urb;
1994 if (this_urb == NULL) {
1995 dbg("%s - oops no urb.", __func__);
1999 /* Save reset port val for resend.
2000 Don't overwrite resend for open/close condition. */
2001 if ((reset_port + 1) > p_priv->resend_cont)
2002 p_priv->resend_cont = reset_port + 1;
2003 if (this_urb->status == -EINPROGRESS) {
2004 dbg("%s already writing", __func__);
2009 memset(&msg, 0, sizeof(struct keyspan_usa28_portControlMessage));
2011 msg.setBaudRate = 1;
2012 if (d_details->calculate_baud_rate(p_priv->baud, d_details->baudclk,
2013 &msg.baudHi, &msg.baudLo, NULL, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2014 dbg("%s - Invalid baud rate requested %d.",
2015 __func__, p_priv->baud);
2017 msg.baudHi = 0xb2; /* Values for 9600 baud */
2020 /* If parity is enabled, we must calculate it ourselves. */
2021 msg.parity = 0; /* XXX for now */
2023 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2024 msg.xonFlowControl = 0;
2026 /* Do handshaking outputs, DTR is inverted relative to RTS */
2027 msg.rts = p_priv->rts_state;
2028 msg.dtr = p_priv->dtr_state;
2030 msg.forwardingLength = 16;
2032 msg.breakThreshold = 45;
2036 /*msg.returnStatus = 1;
2037 msg.resetDataToggle = 0xff;*/
2039 if (reset_port == 1) {
2043 msg.txForceXoff = 0;
2049 msg.returnStatus = 0;
2050 msg.resetDataToggle = 0xff;
2053 else if (reset_port == 2) {
2057 msg.txForceXoff = 0;
2063 msg.returnStatus = 0;
2064 msg.resetDataToggle = 0;
2066 /* Sending intermediate configs */
2068 msg._txOn = (!p_priv->break_on);
2071 msg.txForceXoff = 0;
2072 msg.txBreak = (p_priv->break_on);
2077 msg.returnStatus = 0;
2078 msg.resetDataToggle = 0x0;
2081 p_priv->resend_cont = 0;
2082 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2084 /* send the data out the device on control endpoint */
2085 this_urb->transfer_buffer_length = sizeof(msg);
2087 this_urb->dev = serial->dev;
2088 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2090 dbg("%s - usb_submit_urb(setup) failed", __func__);
2093 dbg("%s - usb_submit_urb(setup) OK %d bytes", __func__,
2094 this_urb->transfer_buffer_length);
2101 static int keyspan_usa49_send_setup(struct usb_serial *serial,
2102 struct usb_serial_port *port,
2105 struct keyspan_usa49_portControlMessage msg;
2106 struct usb_ctrlrequest *dr = NULL;
2107 struct keyspan_serial_private *s_priv;
2108 struct keyspan_port_private *p_priv;
2109 const struct keyspan_device_details *d_details;
2110 struct urb *this_urb;
2111 int err, device_port;
2113 dbg("%s", __func__);
2115 s_priv = usb_get_serial_data(serial);
2116 p_priv = usb_get_serial_port_data(port);
2117 d_details = s_priv->device_details;
2119 this_urb = s_priv->glocont_urb;
2121 /* Work out which port within the device is being setup */
2122 device_port = port->number - port->serial->minor;
2124 dbg("%s - endpoint %d port %d (%d)",
2125 __func__, usb_pipeendpoint(this_urb->pipe),
2126 port->number, device_port);
2128 /* Make sure we have an urb then send the message */
2129 if (this_urb == NULL) {
2130 dbg("%s - oops no urb for port %d.", __func__, port->number);
2134 /* Save reset port val for resend.
2135 Don't overwrite resend for open/close condition. */
2136 if ((reset_port + 1) > p_priv->resend_cont)
2137 p_priv->resend_cont = reset_port + 1;
2139 if (this_urb->status == -EINPROGRESS) {
2140 /* dbg("%s - already writing", __func__); */
2145 memset(&msg, 0, sizeof(struct keyspan_usa49_portControlMessage));
2147 /*msg.portNumber = port->number;*/
2148 msg.portNumber = device_port;
2150 /* Only set baud rate if it's changed */
2151 if (p_priv->old_baud != p_priv->baud) {
2152 p_priv->old_baud = p_priv->baud;
2153 msg.setClocking = 0xff;
2154 if (d_details->calculate_baud_rate
2155 (p_priv->baud, d_details->baudclk, &msg.baudHi,
2156 &msg.baudLo, &msg.prescaler, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2157 dbg("%s - Invalid baud rate %d requested, using 9600.",
2158 __func__, p_priv->baud);
2160 msg.baudHi = 125; /* Values for 9600 baud */
2163 /* msg.setPrescaler = 0xff; */
2166 msg.lcr = (p_priv->cflag & CSTOPB)? STOPBITS_678_2: STOPBITS_5678_1;
2167 switch (p_priv->cflag & CSIZE) {
2169 msg.lcr |= USA_DATABITS_5;
2172 msg.lcr |= USA_DATABITS_6;
2175 msg.lcr |= USA_DATABITS_7;
2178 msg.lcr |= USA_DATABITS_8;
2181 if (p_priv->cflag & PARENB) {
2182 /* note USA_PARITY_NONE == 0 */
2183 msg.lcr |= (p_priv->cflag & PARODD)?
2184 USA_PARITY_ODD : USA_PARITY_EVEN;
2188 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2189 msg.xonFlowControl = 0;
2190 msg.setFlowControl = 0xff;
2192 msg.forwardingLength = 16;
2197 if (reset_port == 1) {
2206 msg.returnStatus = 0;
2207 msg.resetDataToggle = 0xff;
2209 msg.disablePort = 0;
2212 else if (reset_port == 2) {
2221 msg.returnStatus = 0;
2222 msg.resetDataToggle = 0;
2224 msg.disablePort = 1;
2226 /* Sending intermediate configs */
2228 msg._txOn = (!p_priv->break_on);
2231 msg.txBreak = (p_priv->break_on);
2236 msg.returnStatus = 0;
2237 msg.resetDataToggle = 0x0;
2239 msg.disablePort = 0;
2242 /* Do handshaking outputs */
2244 msg.rts = p_priv->rts_state;
2247 msg.dtr = p_priv->dtr_state;
2249 p_priv->resend_cont = 0;
2251 /* if the device is a 49wg, we send control message on usb
2254 if (d_details->product_id == keyspan_usa49wg_product_id) {
2255 dr = (void *)(s_priv->ctrl_buf);
2256 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_OUT;
2257 dr->bRequest = 0xB0; /* 49wg control message */;
2260 dr->wLength = cpu_to_le16(sizeof(msg));
2262 memcpy(s_priv->glocont_buf, &msg, sizeof(msg));
2264 usb_fill_control_urb(this_urb, serial->dev,
2265 usb_sndctrlpipe(serial->dev, 0),
2266 (unsigned char *)dr, s_priv->glocont_buf,
2267 sizeof(msg), usa49_glocont_callback, serial);
2270 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2272 /* send the data out the device on control endpoint */
2273 this_urb->transfer_buffer_length = sizeof(msg);
2275 this_urb->dev = serial->dev;
2277 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2279 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__, err);
2282 dbg("%s - usb_submit_urb(%d) OK %d bytes (end %d)", __func__,
2283 outcont_urb, this_urb->transfer_buffer_length,
2284 usb_pipeendpoint(this_urb->pipe));
2291 static int keyspan_usa90_send_setup(struct usb_serial *serial,
2292 struct usb_serial_port *port,
2295 struct keyspan_usa90_portControlMessage msg;
2296 struct keyspan_serial_private *s_priv;
2297 struct keyspan_port_private *p_priv;
2298 const struct keyspan_device_details *d_details;
2299 struct urb *this_urb;
2303 dbg("%s", __func__);
2305 s_priv = usb_get_serial_data(serial);
2306 p_priv = usb_get_serial_port_data(port);
2307 d_details = s_priv->device_details;
2309 /* only do something if we have a bulk out endpoint */
2310 this_urb = p_priv->outcont_urb;
2311 if (this_urb == NULL) {
2312 dbg("%s - oops no urb.", __func__);
2316 /* Save reset port val for resend.
2317 Don't overwrite resend for open/close condition. */
2318 if ((reset_port + 1) > p_priv->resend_cont)
2319 p_priv->resend_cont = reset_port + 1;
2320 if (this_urb->status == -EINPROGRESS) {
2321 dbg("%s already writing", __func__);
2326 memset(&msg, 0, sizeof(struct keyspan_usa90_portControlMessage));
2328 /* Only set baud rate if it's changed */
2329 if (p_priv->old_baud != p_priv->baud) {
2330 p_priv->old_baud = p_priv->baud;
2331 msg.setClocking = 0x01;
2332 if (d_details->calculate_baud_rate
2333 (p_priv->baud, d_details->baudclk, &msg.baudHi,
2334 &msg.baudLo, &prescaler, 0) == KEYSPAN_INVALID_BAUD_RATE) {
2335 dbg("%s - Invalid baud rate %d requested, using 9600.",
2336 __func__, p_priv->baud);
2337 p_priv->baud = 9600;
2338 d_details->calculate_baud_rate(p_priv->baud, d_details->baudclk,
2339 &msg.baudHi, &msg.baudLo, &prescaler, 0);
2345 /* modes must always be correctly specified */
2346 if (p_priv->baud > 57600) {
2347 msg.rxMode = RXMODE_DMA;
2348 msg.txMode = TXMODE_DMA;
2350 msg.rxMode = RXMODE_BYHAND;
2351 msg.txMode = TXMODE_BYHAND;
2354 msg.lcr = (p_priv->cflag & CSTOPB)? STOPBITS_678_2: STOPBITS_5678_1;
2355 switch (p_priv->cflag & CSIZE) {
2357 msg.lcr |= USA_DATABITS_5;
2360 msg.lcr |= USA_DATABITS_6;
2363 msg.lcr |= USA_DATABITS_7;
2366 msg.lcr |= USA_DATABITS_8;
2369 if (p_priv->cflag & PARENB) {
2370 /* note USA_PARITY_NONE == 0 */
2371 msg.lcr |= (p_priv->cflag & PARODD)?
2372 USA_PARITY_ODD : USA_PARITY_EVEN;
2374 if (p_priv->old_cflag != p_priv->cflag) {
2375 p_priv->old_cflag = p_priv->cflag;
2379 if (p_priv->flow_control == flow_cts)
2380 msg.txFlowControl = TXFLOW_CTS;
2381 msg.setTxFlowControl = 0x01;
2382 msg.setRxFlowControl = 0x01;
2384 msg.rxForwardingLength = 16;
2385 msg.rxForwardingTimeout = 16;
2386 msg.txAckSetting = 0;
2391 if (reset_port == 1) {
2392 msg.portEnabled = 1;
2394 msg.txBreak = (p_priv->break_on);
2397 else if (reset_port == 2)
2398 msg.portEnabled = 0;
2399 /* Sending intermediate configs */
2401 msg.portEnabled = 1;
2402 msg.txBreak = (p_priv->break_on);
2405 /* Do handshaking outputs */
2407 msg.rts = p_priv->rts_state;
2410 msg.dtr = p_priv->dtr_state;
2412 p_priv->resend_cont = 0;
2413 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2415 /* send the data out the device on control endpoint */
2416 this_urb->transfer_buffer_length = sizeof(msg);
2418 this_urb->dev = serial->dev;
2419 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2421 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__, err);
2425 static int keyspan_usa67_send_setup(struct usb_serial *serial,
2426 struct usb_serial_port *port,
2429 struct keyspan_usa67_portControlMessage msg;
2430 struct keyspan_serial_private *s_priv;
2431 struct keyspan_port_private *p_priv;
2432 const struct keyspan_device_details *d_details;
2433 struct urb *this_urb;
2434 int err, device_port;
2436 dbg("%s", __func__);
2438 s_priv = usb_get_serial_data(serial);
2439 p_priv = usb_get_serial_port_data(port);
2440 d_details = s_priv->device_details;
2442 this_urb = s_priv->glocont_urb;
2444 /* Work out which port within the device is being setup */
2445 device_port = port->number - port->serial->minor;
2447 /* Make sure we have an urb then send the message */
2448 if (this_urb == NULL) {
2449 dbg("%s - oops no urb for port %d.", __func__,
2454 /* Save reset port val for resend.
2455 Don't overwrite resend for open/close condition. */
2456 if ((reset_port + 1) > p_priv->resend_cont)
2457 p_priv->resend_cont = reset_port + 1;
2458 if (this_urb->status == -EINPROGRESS) {
2459 /* dbg("%s - already writing", __func__); */
2464 memset(&msg, 0, sizeof(struct keyspan_usa67_portControlMessage));
2466 msg.port = device_port;
2468 /* Only set baud rate if it's changed */
2469 if (p_priv->old_baud != p_priv->baud) {
2470 p_priv->old_baud = p_priv->baud;
2471 msg.setClocking = 0xff;
2472 if (d_details->calculate_baud_rate
2473 (p_priv->baud, d_details->baudclk, &msg.baudHi,
2474 &msg.baudLo, &msg.prescaler, device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2475 dbg("%s - Invalid baud rate %d requested, using 9600.",
2476 __func__, p_priv->baud);
2478 msg.baudHi = 125; /* Values for 9600 baud */
2481 msg.setPrescaler = 0xff;
2484 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2485 switch (p_priv->cflag & CSIZE) {
2487 msg.lcr |= USA_DATABITS_5;
2490 msg.lcr |= USA_DATABITS_6;
2493 msg.lcr |= USA_DATABITS_7;
2496 msg.lcr |= USA_DATABITS_8;
2499 if (p_priv->cflag & PARENB) {
2500 /* note USA_PARITY_NONE == 0 */
2501 msg.lcr |= (p_priv->cflag & PARODD)?
2502 USA_PARITY_ODD : USA_PARITY_EVEN;
2506 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2507 msg.xonFlowControl = 0;
2508 msg.setFlowControl = 0xff;
2509 msg.forwardingLength = 16;
2513 if (reset_port == 1) {
2523 msg.returnStatus = 0;
2524 msg.resetDataToggle = 0xff;
2525 } else if (reset_port == 2) {
2535 msg.returnStatus = 0;
2536 msg.resetDataToggle = 0;
2538 /* Sending intermediate configs */
2539 msg._txOn = (!p_priv->break_on);
2542 msg.txBreak = (p_priv->break_on);
2547 msg.returnStatus = 0;
2548 msg.resetDataToggle = 0x0;
2551 /* Do handshaking outputs */
2552 msg.setTxTriState_setRts = 0xff;
2553 msg.txTriState_rts = p_priv->rts_state;
2555 msg.setHskoa_setDtr = 0xff;
2556 msg.hskoa_dtr = p_priv->dtr_state;
2558 p_priv->resend_cont = 0;
2560 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2562 /* send the data out the device on control endpoint */
2563 this_urb->transfer_buffer_length = sizeof(msg);
2564 this_urb->dev = serial->dev;
2566 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2568 dbg("%s - usb_submit_urb(setup) failed (%d)", __func__,
2573 static void keyspan_send_setup(struct usb_serial_port *port, int reset_port)
2575 struct usb_serial *serial = port->serial;
2576 struct keyspan_serial_private *s_priv;
2577 const struct keyspan_device_details *d_details;
2579 dbg("%s", __func__);
2581 s_priv = usb_get_serial_data(serial);
2582 d_details = s_priv->device_details;
2584 switch (d_details->msg_format) {
2586 keyspan_usa26_send_setup(serial, port, reset_port);
2589 keyspan_usa28_send_setup(serial, port, reset_port);
2592 keyspan_usa49_send_setup(serial, port, reset_port);
2595 keyspan_usa90_send_setup(serial, port, reset_port);
2598 keyspan_usa67_send_setup(serial, port, reset_port);
2604 /* Gets called by the "real" driver (ie once firmware is loaded
2605 and renumeration has taken place. */
2606 static int keyspan_startup(struct usb_serial *serial)
2609 struct usb_serial_port *port;
2610 struct keyspan_serial_private *s_priv;
2611 struct keyspan_port_private *p_priv;
2612 const struct keyspan_device_details *d_details;
2614 dbg("%s", __func__);
2616 for (i = 0; (d_details = keyspan_devices[i]) != NULL; ++i)
2617 if (d_details->product_id ==
2618 le16_to_cpu(serial->dev->descriptor.idProduct))
2620 if (d_details == NULL) {
2621 dev_err(&serial->dev->dev, "%s - unknown product id %x\n",
2622 __func__, le16_to_cpu(serial->dev->descriptor.idProduct));
2626 /* Setup private data for serial driver */
2627 s_priv = kzalloc(sizeof(struct keyspan_serial_private), GFP_KERNEL);
2629 dbg("%s - kmalloc for keyspan_serial_private failed.",
2634 s_priv->device_details = d_details;
2635 usb_set_serial_data(serial, s_priv);
2637 /* Now setup per port private data */
2638 for (i = 0; i < serial->num_ports; i++) {
2639 port = serial->port[i];
2640 p_priv = kzalloc(sizeof(struct keyspan_port_private),
2643 dbg("%s - kmalloc for keyspan_port_private (%d) failed!.", __func__, i);
2646 p_priv->device_details = d_details;
2647 usb_set_serial_port_data(port, p_priv);
2650 keyspan_setup_urbs(serial);
2652 if (s_priv->instat_urb != NULL) {
2653 s_priv->instat_urb->dev = serial->dev;
2654 err = usb_submit_urb(s_priv->instat_urb, GFP_KERNEL);
2656 dbg("%s - submit instat urb failed %d", __func__,
2659 if (s_priv->indat_urb != NULL) {
2660 s_priv->indat_urb->dev = serial->dev;
2661 err = usb_submit_urb(s_priv->indat_urb, GFP_KERNEL);
2663 dbg("%s - submit indat urb failed %d", __func__,
2670 static void keyspan_disconnect(struct usb_serial *serial)
2673 struct usb_serial_port *port;
2674 struct keyspan_serial_private *s_priv;
2675 struct keyspan_port_private *p_priv;
2677 dbg("%s", __func__);
2679 s_priv = usb_get_serial_data(serial);
2681 /* Stop reading/writing urbs */
2682 stop_urb(s_priv->instat_urb);
2683 stop_urb(s_priv->glocont_urb);
2684 stop_urb(s_priv->indat_urb);
2685 for (i = 0; i < serial->num_ports; ++i) {
2686 port = serial->port[i];
2687 p_priv = usb_get_serial_port_data(port);
2688 stop_urb(p_priv->inack_urb);
2689 stop_urb(p_priv->outcont_urb);
2690 for (j = 0; j < 2; j++) {
2691 stop_urb(p_priv->in_urbs[j]);
2692 stop_urb(p_priv->out_urbs[j]);
2697 usb_free_urb(s_priv->instat_urb);
2698 usb_free_urb(s_priv->indat_urb);
2699 usb_free_urb(s_priv->glocont_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 usb_free_urb(p_priv->inack_urb);
2704 usb_free_urb(p_priv->outcont_urb);
2705 for (j = 0; j < 2; j++) {
2706 usb_free_urb(p_priv->in_urbs[j]);
2707 usb_free_urb(p_priv->out_urbs[j]);
2712 static void keyspan_release(struct usb_serial *serial)
2715 struct usb_serial_port *port;
2716 struct keyspan_serial_private *s_priv;
2718 dbg("%s", __func__);
2720 s_priv = usb_get_serial_data(serial);
2722 /* dbg("Freeing serial->private."); */
2725 /* dbg("Freeing port->private."); */
2726 /* Now free per port private data */
2727 for (i = 0; i < serial->num_ports; i++) {
2728 port = serial->port[i];
2729 kfree(usb_get_serial_port_data(port));
2733 MODULE_AUTHOR(DRIVER_AUTHOR);
2734 MODULE_DESCRIPTION(DRIVER_DESC);
2735 MODULE_LICENSE("GPL");
2737 MODULE_FIRMWARE("keyspan/usa28.fw");
2738 MODULE_FIRMWARE("keyspan/usa28x.fw");
2739 MODULE_FIRMWARE("keyspan/usa28xa.fw");
2740 MODULE_FIRMWARE("keyspan/usa28xb.fw");
2741 MODULE_FIRMWARE("keyspan/usa19.fw");
2742 MODULE_FIRMWARE("keyspan/usa19qi.fw");
2743 MODULE_FIRMWARE("keyspan/mpr.fw");
2744 MODULE_FIRMWARE("keyspan/usa19qw.fw");
2745 MODULE_FIRMWARE("keyspan/usa18x.fw");
2746 MODULE_FIRMWARE("keyspan/usa19w.fw");
2747 MODULE_FIRMWARE("keyspan/usa49w.fw");
2748 MODULE_FIRMWARE("keyspan/usa49wlc.fw");
2750 module_param(debug, bool, S_IRUGO | S_IWUSR);
2751 MODULE_PARM_DESC(debug, "Debug enabled or not");