Linux Audio

Check our new training course

Loading...
v3.15
 
   1/*
   2  Keyspan USB to Serial Converter driver
   3
   4  (C) Copyright (C) 2000-2001	Hugh Blemings <hugh@blemings.org>
   5  (C) Copyright (C) 2002	Greg Kroah-Hartman <greg@kroah.com>
   6
   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.
  11
  12  See http://blemings.org/hugh/keyspan.html for more information.
  13
  14  Code in this driver inspired by and in a number of places taken
  15  from Brian Warner's original Keyspan-PDA driver.
  16
  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 :)
  20
  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.
  25
  26  Tip 'o the hat to IBM (and previously Linuxcare :) for supporting
  27  staff in their work on open source projects.
  28*/
  29
  30
  31#include <linux/kernel.h>
  32#include <linux/jiffies.h>
  33#include <linux/errno.h>
  34#include <linux/slab.h>
  35#include <linux/tty.h>
  36#include <linux/tty_driver.h>
  37#include <linux/tty_flip.h>
  38#include <linux/module.h>
  39#include <linux/spinlock.h>
  40#include <linux/uaccess.h>
  41#include <linux/usb.h>
  42#include <linux/usb/serial.h>
  43#include <linux/usb/ezusb.h>
  44#include "keyspan.h"
  45
  46#define DRIVER_AUTHOR "Hugh Blemings <hugh@misc.nu"
  47#define DRIVER_DESC "Keyspan USB to Serial Converter Driver"
  48
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  49#define INSTAT_BUFLEN	32
  50#define GLOCONT_BUFLEN	64
  51#define INDAT49W_BUFLEN	512
  52#define IN_BUFLEN	64
  53#define OUT_BUFLEN	64
  54#define INACK_BUFLEN	1
  55#define OUTCONT_BUFLEN	64
  56
  57	/* Per device and per port private data */
  58struct keyspan_serial_private {
  59	const struct keyspan_device_details	*device_details;
  60
  61	struct urb	*instat_urb;
  62	char		*instat_buf;
  63
  64	/* added to support 49wg, where data from all 4 ports comes in
  65	   on 1 EP and high-speed supported */
  66	struct urb	*indat_urb;
  67	char		*indat_buf;
  68
  69	/* XXX this one probably will need a lock */
  70	struct urb	*glocont_urb;
  71	char		*glocont_buf;
  72	char		*ctrl_buf;	/* for EP0 control message */
  73};
  74
  75struct keyspan_port_private {
  76	/* Keep track of which input & output endpoints to use */
  77	int		in_flip;
  78	int		out_flip;
  79
  80	/* Keep duplicate of device details in each port
  81	   structure as well - simplifies some of the
  82	   callback functions etc. */
  83	const struct keyspan_device_details	*device_details;
  84
  85	/* Input endpoints and buffer for this port */
  86	struct urb	*in_urbs[2];
  87	char		*in_buffer[2];
  88	/* Output endpoints and buffer for this port */
  89	struct urb	*out_urbs[2];
  90	char		*out_buffer[2];
  91
  92	/* Input ack endpoint */
  93	struct urb	*inack_urb;
  94	char		*inack_buffer;
  95
  96	/* Output control endpoint */
  97	struct urb	*outcont_urb;
  98	char		*outcont_buffer;
  99
 100	/* Settings for the port */
 101	int		baud;
 102	int		old_baud;
 103	unsigned int	cflag;
 104	unsigned int	old_cflag;
 105	enum		{flow_none, flow_cts, flow_xon} flow_control;
 106	int		rts_state;	/* Handshaking pins (outputs) */
 107	int		dtr_state;
 108	int		cts_state;	/* Handshaking pins (inputs) */
 109	int		dsr_state;
 110	int		dcd_state;
 111	int		ri_state;
 112	int		break_on;
 113
 114	unsigned long	tx_start_time[2];
 115	int		resend_cont;	/* need to resend control packet */
 116};
 117
 118/* Include Keyspan message headers.  All current Keyspan Adapters
 119   make use of one of five message formats which are referred
 120   to as USA-26, USA-28, USA-49, USA-90, USA-67 by Keyspan and
 121   within this driver. */
 122#include "keyspan_usa26msg.h"
 123#include "keyspan_usa28msg.h"
 124#include "keyspan_usa49msg.h"
 125#include "keyspan_usa90msg.h"
 126#include "keyspan_usa67msg.h"
 127
 128
 129module_usb_serial_driver(serial_drivers, keyspan_ids_combined);
 130
 131static void keyspan_break_ctl(struct tty_struct *tty, int break_state)
 132{
 133	struct usb_serial_port *port = tty->driver_data;
 134	struct keyspan_port_private 	*p_priv;
 135
 136	p_priv = usb_get_serial_port_data(port);
 137
 138	if (break_state == -1)
 139		p_priv->break_on = 1;
 140	else
 141		p_priv->break_on = 0;
 142
 143	keyspan_send_setup(port, 0);
 144}
 145
 146
 147static void keyspan_set_termios(struct tty_struct *tty,
 148		struct usb_serial_port *port, struct ktermios *old_termios)
 149{
 150	int				baud_rate, device_port;
 151	struct keyspan_port_private 	*p_priv;
 152	const struct keyspan_device_details	*d_details;
 153	unsigned int 			cflag;
 154
 155	p_priv = usb_get_serial_port_data(port);
 156	d_details = p_priv->device_details;
 157	cflag = tty->termios.c_cflag;
 158	device_port = port->port_number;
 159
 160	/* Baud rate calculation takes baud rate as an integer
 161	   so other rates can be generated if desired. */
 162	baud_rate = tty_get_baud_rate(tty);
 163	/* If no match or invalid, don't change */
 164	if (d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
 165				NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
 166		/* FIXME - more to do here to ensure rate changes cleanly */
 167		/* FIXME - calculate exact rate from divisor ? */
 168		p_priv->baud = baud_rate;
 169	} else
 170		baud_rate = tty_termios_baud_rate(old_termios);
 171
 172	tty_encode_baud_rate(tty, baud_rate, baud_rate);
 173	/* set CTS/RTS handshake etc. */
 174	p_priv->cflag = cflag;
 175	p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
 176
 177	/* Mark/Space not supported */
 178	tty->termios.c_cflag &= ~CMSPAR;
 179
 180	keyspan_send_setup(port, 0);
 181}
 182
 183static int keyspan_tiocmget(struct tty_struct *tty)
 184{
 185	struct usb_serial_port *port = tty->driver_data;
 186	struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
 187	unsigned int			value;
 188
 189	value = ((p_priv->rts_state) ? TIOCM_RTS : 0) |
 190		((p_priv->dtr_state) ? TIOCM_DTR : 0) |
 191		((p_priv->cts_state) ? TIOCM_CTS : 0) |
 192		((p_priv->dsr_state) ? TIOCM_DSR : 0) |
 193		((p_priv->dcd_state) ? TIOCM_CAR : 0) |
 194		((p_priv->ri_state) ? TIOCM_RNG : 0);
 195
 196	return value;
 197}
 198
 199static int keyspan_tiocmset(struct tty_struct *tty,
 200			    unsigned int set, unsigned int clear)
 201{
 202	struct usb_serial_port *port = tty->driver_data;
 203	struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
 204
 205	if (set & TIOCM_RTS)
 206		p_priv->rts_state = 1;
 207	if (set & TIOCM_DTR)
 208		p_priv->dtr_state = 1;
 209	if (clear & TIOCM_RTS)
 210		p_priv->rts_state = 0;
 211	if (clear & TIOCM_DTR)
 212		p_priv->dtr_state = 0;
 213	keyspan_send_setup(port, 0);
 214	return 0;
 215}
 216
 217/* Write function is similar for the four protocols used
 218   with only a minor change for usa90 (usa19hs) required */
 219static int keyspan_write(struct tty_struct *tty,
 220	struct usb_serial_port *port, const unsigned char *buf, int count)
 221{
 222	struct keyspan_port_private 	*p_priv;
 223	const struct keyspan_device_details	*d_details;
 224	int				flip;
 225	int 				left, todo;
 226	struct urb			*this_urb;
 227	int 				err, maxDataLen, dataOffset;
 228
 229	p_priv = usb_get_serial_port_data(port);
 230	d_details = p_priv->device_details;
 231
 232	if (d_details->msg_format == msg_usa90) {
 233		maxDataLen = 64;
 234		dataOffset = 0;
 235	} else {
 236		maxDataLen = 63;
 237		dataOffset = 1;
 238	}
 239
 240	dev_dbg(&port->dev, "%s - %d chars, flip=%d\n", __func__, count,
 241		p_priv->out_flip);
 242
 243	for (left = count; left > 0; left -= todo) {
 244		todo = left;
 245		if (todo > maxDataLen)
 246			todo = maxDataLen;
 247
 248		flip = p_priv->out_flip;
 249
 250		/* Check we have a valid urb/endpoint before we use it... */
 251		this_urb = p_priv->out_urbs[flip];
 252		if (this_urb == NULL) {
 253			/* no bulk out, so return 0 bytes written */
 254			dev_dbg(&port->dev, "%s - no output urb :(\n", __func__);
 255			return count;
 256		}
 257
 258		dev_dbg(&port->dev, "%s - endpoint %d flip %d\n",
 259			__func__, usb_pipeendpoint(this_urb->pipe), flip);
 260
 261		if (this_urb->status == -EINPROGRESS) {
 262			if (time_before(jiffies,
 263					p_priv->tx_start_time[flip] + 10 * HZ))
 264				break;
 265			usb_unlink_urb(this_urb);
 266			break;
 267		}
 268
 269		/* First byte in buffer is "last flag" (except for usa19hx)
 270		   - unused so for now so set to zero */
 271		((char *)this_urb->transfer_buffer)[0] = 0;
 272
 273		memcpy(this_urb->transfer_buffer + dataOffset, buf, todo);
 274		buf += todo;
 275
 276		/* send the data out the bulk port */
 277		this_urb->transfer_buffer_length = todo + dataOffset;
 278
 279		err = usb_submit_urb(this_urb, GFP_ATOMIC);
 280		if (err != 0)
 281			dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed (%d)\n", err);
 282		p_priv->tx_start_time[flip] = jiffies;
 283
 284		/* Flip for next time if usa26 or usa28 interface
 285		   (not used on usa49) */
 286		p_priv->out_flip = (flip + 1) & d_details->outdat_endp_flip;
 287	}
 288
 289	return count - left;
 290}
 291
 292static void	usa26_indat_callback(struct urb *urb)
 293{
 294	int			i, err;
 295	int			endpoint;
 296	struct usb_serial_port	*port;
 297	unsigned char 		*data = urb->transfer_buffer;
 298	int status = urb->status;
 299
 300	endpoint = usb_pipeendpoint(urb->pipe);
 301
 302	if (status) {
 303		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x on endpoint %d.\n",
 304			__func__, status, endpoint);
 305		return;
 306	}
 307
 308	port =  urb->context;
 309	if (urb->actual_length) {
 310		/* 0x80 bit is error flag */
 311		if ((data[0] & 0x80) == 0) {
 312			/* no errors on individual bytes, only
 313			   possible overrun err */
 314			if (data[0] & RXERROR_OVERRUN)
 315				err = TTY_OVERRUN;
 316			else
 317				err = 0;
 318			for (i = 1; i < urb->actual_length ; ++i)
 319				tty_insert_flip_char(&port->port, data[i], err);
 
 320		} else {
 321			/* some bytes had errors, every byte has status */
 322			dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
 323			for (i = 0; i + 1 < urb->actual_length; i += 2) {
 324				int stat = data[i], flag = 0;
 325				if (stat & RXERROR_OVERRUN)
 326					flag |= TTY_OVERRUN;
 327				if (stat & RXERROR_FRAMING)
 328					flag |= TTY_FRAME;
 329				if (stat & RXERROR_PARITY)
 330					flag |= TTY_PARITY;
 331				/* XXX should handle break (0x10) */
 
 
 
 
 
 332				tty_insert_flip_char(&port->port, data[i+1],
 333						flag);
 334			}
 335		}
 336		tty_flip_buffer_push(&port->port);
 337	}
 338
 339	/* Resubmit urb so we continue receiving */
 340	err = usb_submit_urb(urb, GFP_ATOMIC);
 341	if (err != 0)
 342		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 343}
 344
 345/* Outdat handling is common for all devices */
 346static void	usa2x_outdat_callback(struct urb *urb)
 347{
 348	struct usb_serial_port *port;
 349	struct keyspan_port_private *p_priv;
 350
 351	port =  urb->context;
 352	p_priv = usb_get_serial_port_data(port);
 353	dev_dbg(&port->dev, "%s - urb %d\n", __func__, urb == p_priv->out_urbs[1]);
 354
 355	usb_serial_port_softint(port);
 356}
 357
 358static void	usa26_inack_callback(struct urb *urb)
 359{
 360}
 361
 362static void	usa26_outcont_callback(struct urb *urb)
 363{
 364	struct usb_serial_port *port;
 365	struct keyspan_port_private *p_priv;
 366
 367	port =  urb->context;
 368	p_priv = usb_get_serial_port_data(port);
 369
 370	if (p_priv->resend_cont) {
 371		dev_dbg(&port->dev, "%s - sending setup\n", __func__);
 372		keyspan_usa26_send_setup(port->serial, port,
 373						p_priv->resend_cont - 1);
 374	}
 375}
 376
 377static void	usa26_instat_callback(struct urb *urb)
 378{
 379	unsigned char 				*data = urb->transfer_buffer;
 380	struct keyspan_usa26_portStatusMessage	*msg;
 381	struct usb_serial			*serial;
 382	struct usb_serial_port			*port;
 383	struct keyspan_port_private	 	*p_priv;
 384	int old_dcd_state, err;
 385	int status = urb->status;
 386
 387	serial =  urb->context;
 388
 389	if (status) {
 390		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x\n", __func__, status);
 
 391		return;
 392	}
 393	if (urb->actual_length != 9) {
 394		dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
 395		goto exit;
 396	}
 397
 398	msg = (struct keyspan_usa26_portStatusMessage *)data;
 399
 400	/* Check port number from message and retrieve private data */
 401	if (msg->port >= serial->num_ports) {
 402		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
 403		goto exit;
 404	}
 405	port = serial->port[msg->port];
 406	p_priv = usb_get_serial_port_data(port);
 
 
 407
 408	/* Update handshaking pin state information */
 409	old_dcd_state = p_priv->dcd_state;
 410	p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
 411	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
 412	p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
 413	p_priv->ri_state = ((msg->ri) ? 1 : 0);
 414
 415	if (old_dcd_state != p_priv->dcd_state)
 416		tty_port_tty_hangup(&port->port, true);
 417
 418	/* Resubmit urb so we continue receiving */
 419	err = usb_submit_urb(urb, GFP_ATOMIC);
 420	if (err != 0)
 421		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 422exit: ;
 423}
 424
 425static void	usa26_glocont_callback(struct urb *urb)
 426{
 427}
 428
 429
 430static void usa28_indat_callback(struct urb *urb)
 431{
 432	int                     err;
 433	struct usb_serial_port  *port;
 434	unsigned char           *data;
 435	struct keyspan_port_private             *p_priv;
 436	int status = urb->status;
 437
 438	port =  urb->context;
 439	p_priv = usb_get_serial_port_data(port);
 440	data = urb->transfer_buffer;
 441
 442	if (urb != p_priv->in_urbs[p_priv->in_flip])
 443		return;
 444
 445	do {
 446		if (status) {
 447			dev_dbg(&urb->dev->dev, "%s - nonzero status: %x on endpoint %d.\n",
 448				__func__, status, usb_pipeendpoint(urb->pipe));
 449			return;
 450		}
 451
 452		port =  urb->context;
 453		p_priv = usb_get_serial_port_data(port);
 454		data = urb->transfer_buffer;
 455
 456		if (urb->actual_length) {
 457			tty_insert_flip_string(&port->port, data,
 458					urb->actual_length);
 459			tty_flip_buffer_push(&port->port);
 460		}
 461
 462		/* Resubmit urb so we continue receiving */
 463		err = usb_submit_urb(urb, GFP_ATOMIC);
 464		if (err != 0)
 465			dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n",
 466							__func__, err);
 467		p_priv->in_flip ^= 1;
 468
 469		urb = p_priv->in_urbs[p_priv->in_flip];
 470	} while (urb->status != -EINPROGRESS);
 471}
 472
 473static void	usa28_inack_callback(struct urb *urb)
 474{
 475}
 476
 477static void	usa28_outcont_callback(struct urb *urb)
 478{
 479	struct usb_serial_port *port;
 480	struct keyspan_port_private *p_priv;
 481
 482	port =  urb->context;
 483	p_priv = usb_get_serial_port_data(port);
 484
 485	if (p_priv->resend_cont) {
 486		dev_dbg(&port->dev, "%s - sending setup\n", __func__);
 487		keyspan_usa28_send_setup(port->serial, port,
 488						p_priv->resend_cont - 1);
 489	}
 490}
 491
 492static void	usa28_instat_callback(struct urb *urb)
 493{
 494	int					err;
 495	unsigned char 				*data = urb->transfer_buffer;
 496	struct keyspan_usa28_portStatusMessage	*msg;
 497	struct usb_serial			*serial;
 498	struct usb_serial_port			*port;
 499	struct keyspan_port_private	 	*p_priv;
 500	int old_dcd_state;
 501	int status = urb->status;
 502
 503	serial =  urb->context;
 504
 505	if (status) {
 506		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x\n", __func__, status);
 
 507		return;
 508	}
 509
 510	if (urb->actual_length != sizeof(struct keyspan_usa28_portStatusMessage)) {
 511		dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
 512		goto exit;
 513	}
 514
 515	msg = (struct keyspan_usa28_portStatusMessage *)data;
 516
 517	/* Check port number from message and retrieve private data */
 518	if (msg->port >= serial->num_ports) {
 519		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
 520		goto exit;
 521	}
 522	port = serial->port[msg->port];
 523	p_priv = usb_get_serial_port_data(port);
 
 
 524
 525	/* Update handshaking pin state information */
 526	old_dcd_state = p_priv->dcd_state;
 527	p_priv->cts_state = ((msg->cts) ? 1 : 0);
 528	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
 529	p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
 530	p_priv->ri_state = ((msg->ri) ? 1 : 0);
 531
 532	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
 533		tty_port_tty_hangup(&port->port, true);
 534
 535		/* Resubmit urb so we continue receiving */
 536	err = usb_submit_urb(urb, GFP_ATOMIC);
 537	if (err != 0)
 538		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 539exit: ;
 540}
 541
 542static void	usa28_glocont_callback(struct urb *urb)
 543{
 544}
 545
 546
 547static void	usa49_glocont_callback(struct urb *urb)
 548{
 549	struct usb_serial *serial;
 550	struct usb_serial_port *port;
 551	struct keyspan_port_private *p_priv;
 552	int i;
 553
 554	serial =  urb->context;
 555	for (i = 0; i < serial->num_ports; ++i) {
 556		port = serial->port[i];
 557		p_priv = usb_get_serial_port_data(port);
 558
 559		if (p_priv->resend_cont) {
 560			dev_dbg(&port->dev, "%s - sending setup\n", __func__);
 561			keyspan_usa49_send_setup(serial, port,
 562						p_priv->resend_cont - 1);
 563			break;
 564		}
 565	}
 566}
 567
 568	/* This is actually called glostat in the Keyspan
 569	   doco */
 570static void	usa49_instat_callback(struct urb *urb)
 571{
 572	int					err;
 573	unsigned char 				*data = urb->transfer_buffer;
 574	struct keyspan_usa49_portStatusMessage	*msg;
 575	struct usb_serial			*serial;
 576	struct usb_serial_port			*port;
 577	struct keyspan_port_private	 	*p_priv;
 578	int old_dcd_state;
 579	int status = urb->status;
 580
 581	serial =  urb->context;
 582
 583	if (status) {
 584		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x\n", __func__, status);
 
 585		return;
 586	}
 587
 588	if (urb->actual_length !=
 589			sizeof(struct keyspan_usa49_portStatusMessage)) {
 590		dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
 591		goto exit;
 592	}
 593
 594	msg = (struct keyspan_usa49_portStatusMessage *)data;
 595
 596	/* Check port number from message and retrieve private data */
 597	if (msg->portNumber >= serial->num_ports) {
 598		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
 599			__func__, msg->portNumber);
 600		goto exit;
 601	}
 602	port = serial->port[msg->portNumber];
 603	p_priv = usb_get_serial_port_data(port);
 
 
 604
 605	/* Update handshaking pin state information */
 606	old_dcd_state = p_priv->dcd_state;
 607	p_priv->cts_state = ((msg->cts) ? 1 : 0);
 608	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
 609	p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
 610	p_priv->ri_state = ((msg->ri) ? 1 : 0);
 611
 612	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
 613		tty_port_tty_hangup(&port->port, true);
 614
 615	/* Resubmit urb so we continue receiving */
 616	err = usb_submit_urb(urb, GFP_ATOMIC);
 617	if (err != 0)
 618		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 619exit:	;
 620}
 621
 622static void	usa49_inack_callback(struct urb *urb)
 623{
 624}
 625
 626static void	usa49_indat_callback(struct urb *urb)
 627{
 628	int			i, err;
 629	int			endpoint;
 630	struct usb_serial_port	*port;
 631	unsigned char 		*data = urb->transfer_buffer;
 632	int status = urb->status;
 633
 634	endpoint = usb_pipeendpoint(urb->pipe);
 635
 636	if (status) {
 637		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x on endpoint %d.\n",
 638			__func__, status, endpoint);
 639		return;
 640	}
 641
 642	port =  urb->context;
 643	if (urb->actual_length) {
 644		/* 0x80 bit is error flag */
 645		if ((data[0] & 0x80) == 0) {
 646			/* no error on any byte */
 647			tty_insert_flip_string(&port->port, data + 1,
 648						urb->actual_length - 1);
 649		} else {
 650			/* some bytes had errors, every byte has status */
 651			for (i = 0; i + 1 < urb->actual_length; i += 2) {
 652				int stat = data[i], flag = 0;
 653				if (stat & RXERROR_OVERRUN)
 654					flag |= TTY_OVERRUN;
 655				if (stat & RXERROR_FRAMING)
 656					flag |= TTY_FRAME;
 657				if (stat & RXERROR_PARITY)
 658					flag |= TTY_PARITY;
 659				/* XXX should handle break (0x10) */
 
 
 
 
 
 660				tty_insert_flip_char(&port->port, data[i+1],
 661						flag);
 662			}
 663		}
 664		tty_flip_buffer_push(&port->port);
 665	}
 666
 667	/* Resubmit urb so we continue receiving */
 668	err = usb_submit_urb(urb, GFP_ATOMIC);
 669	if (err != 0)
 670		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 671}
 672
 673static void usa49wg_indat_callback(struct urb *urb)
 674{
 675	int			i, len, x, err;
 676	struct usb_serial	*serial;
 677	struct usb_serial_port	*port;
 678	unsigned char 		*data = urb->transfer_buffer;
 679	int status = urb->status;
 680
 681	serial = urb->context;
 682
 683	if (status) {
 684		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x\n", __func__, status);
 
 685		return;
 686	}
 687
 688	/* inbound data is in the form P#, len, status, data */
 689	i = 0;
 690	len = 0;
 691
 692	while (i < urb->actual_length) {
 693
 694		/* Check port number from message */
 695		if (data[i] >= serial->num_ports) {
 696			dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
 697				__func__, data[i]);
 698			return;
 699		}
 700		port = serial->port[data[i++]];
 701		len = data[i++];
 702
 703		/* 0x80 bit is error flag */
 704		if ((data[i] & 0x80) == 0) {
 705			/* no error on any byte */
 706			i++;
 707			for (x = 1; x < len && i < urb->actual_length; ++x)
 708				tty_insert_flip_char(&port->port,
 709						data[i++], 0);
 710		} else {
 711			/*
 712			 * some bytes had errors, every byte has status
 713			 */
 714			for (x = 0; x + 1 < len &&
 715				    i + 1 < urb->actual_length; x += 2) {
 716				int stat = data[i], flag = 0;
 
 717
 718				if (stat & RXERROR_OVERRUN)
 719					flag |= TTY_OVERRUN;
 720				if (stat & RXERROR_FRAMING)
 721					flag |= TTY_FRAME;
 722				if (stat & RXERROR_PARITY)
 723					flag |= TTY_PARITY;
 724				/* XXX should handle break (0x10) */
 
 
 
 
 
 725				tty_insert_flip_char(&port->port, data[i+1],
 726						     flag);
 727				i += 2;
 728			}
 729		}
 730		tty_flip_buffer_push(&port->port);
 731	}
 732
 733	/* Resubmit urb so we continue receiving */
 734	err = usb_submit_urb(urb, GFP_ATOMIC);
 735	if (err != 0)
 736		dev_dbg(&urb->dev->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 737}
 738
 739/* not used, usa-49 doesn't have per-port control endpoints */
 740static void usa49_outcont_callback(struct urb *urb)
 741{
 742}
 743
 744static void usa90_indat_callback(struct urb *urb)
 745{
 746	int			i, err;
 747	int			endpoint;
 748	struct usb_serial_port	*port;
 749	struct keyspan_port_private	 	*p_priv;
 750	unsigned char 		*data = urb->transfer_buffer;
 751	int status = urb->status;
 752
 753	endpoint = usb_pipeendpoint(urb->pipe);
 754
 755	if (status) {
 756		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x on endpoint %d.\n",
 757		    __func__, status, endpoint);
 758		return;
 759	}
 760
 761	port =  urb->context;
 762	p_priv = usb_get_serial_port_data(port);
 763
 764	if (urb->actual_length) {
 765		/* if current mode is DMA, looks like usa28 format
 766		   otherwise looks like usa26 data format */
 767
 768		if (p_priv->baud > 57600)
 769			tty_insert_flip_string(&port->port, data,
 770					urb->actual_length);
 771		else {
 772			/* 0x80 bit is error flag */
 773			if ((data[0] & 0x80) == 0) {
 774				/* no errors on individual bytes, only
 775				   possible overrun err*/
 776				if (data[0] & RXERROR_OVERRUN)
 777					err = TTY_OVERRUN;
 778				else
 779					err = 0;
 780				for (i = 1; i < urb->actual_length ; ++i)
 781					tty_insert_flip_char(&port->port,
 782							data[i], err);
 783			}  else {
 784			/* some bytes had errors, every byte has status */
 785				dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
 786				for (i = 0; i + 1 < urb->actual_length; i += 2) {
 787					int stat = data[i], flag = 0;
 788					if (stat & RXERROR_OVERRUN)
 789						flag |= TTY_OVERRUN;
 790					if (stat & RXERROR_FRAMING)
 791						flag |= TTY_FRAME;
 792					if (stat & RXERROR_PARITY)
 793						flag |= TTY_PARITY;
 
 794					/* XXX should handle break (0x10) */
 
 
 
 
 
 795					tty_insert_flip_char(&port->port,
 796							data[i+1], flag);
 797				}
 798			}
 799		}
 800		tty_flip_buffer_push(&port->port);
 801	}
 802
 803	/* Resubmit urb so we continue receiving */
 804	err = usb_submit_urb(urb, GFP_ATOMIC);
 805	if (err != 0)
 806		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 807}
 808
 809
 810static void	usa90_instat_callback(struct urb *urb)
 811{
 812	unsigned char 				*data = urb->transfer_buffer;
 813	struct keyspan_usa90_portStatusMessage	*msg;
 814	struct usb_serial			*serial;
 815	struct usb_serial_port			*port;
 816	struct keyspan_port_private	 	*p_priv;
 817	int old_dcd_state, err;
 818	int status = urb->status;
 819
 820	serial =  urb->context;
 821
 822	if (status) {
 823		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x\n", __func__, status);
 
 824		return;
 825	}
 826	if (urb->actual_length < 14) {
 827		dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
 828		goto exit;
 829	}
 830
 831	msg = (struct keyspan_usa90_portStatusMessage *)data;
 832
 833	/* Now do something useful with the data */
 834
 835	port = serial->port[0];
 836	p_priv = usb_get_serial_port_data(port);
 
 
 837
 838	/* Update handshaking pin state information */
 839	old_dcd_state = p_priv->dcd_state;
 840	p_priv->cts_state = ((msg->cts) ? 1 : 0);
 841	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
 842	p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
 843	p_priv->ri_state = ((msg->ri) ? 1 : 0);
 844
 845	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
 846		tty_port_tty_hangup(&port->port, true);
 847
 848	/* Resubmit urb so we continue receiving */
 849	err = usb_submit_urb(urb, GFP_ATOMIC);
 850	if (err != 0)
 851		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 852exit:
 853	;
 854}
 855
 856static void	usa90_outcont_callback(struct urb *urb)
 857{
 858	struct usb_serial_port *port;
 859	struct keyspan_port_private *p_priv;
 860
 861	port =  urb->context;
 862	p_priv = usb_get_serial_port_data(port);
 863
 864	if (p_priv->resend_cont) {
 865		dev_dbg(&urb->dev->dev, "%s - sending setup\n", __func__);
 866		keyspan_usa90_send_setup(port->serial, port,
 867						p_priv->resend_cont - 1);
 868	}
 869}
 870
 871/* Status messages from the 28xg */
 872static void	usa67_instat_callback(struct urb *urb)
 873{
 874	int					err;
 875	unsigned char 				*data = urb->transfer_buffer;
 876	struct keyspan_usa67_portStatusMessage	*msg;
 877	struct usb_serial			*serial;
 878	struct usb_serial_port			*port;
 879	struct keyspan_port_private	 	*p_priv;
 880	int old_dcd_state;
 881	int status = urb->status;
 882
 883	serial = urb->context;
 884
 885	if (status) {
 886		dev_dbg(&urb->dev->dev, "%s - nonzero status: %x\n", __func__, status);
 
 887		return;
 888	}
 889
 890	if (urb->actual_length !=
 891			sizeof(struct keyspan_usa67_portStatusMessage)) {
 892		dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
 893		return;
 894	}
 895
 896
 897	/* Now do something useful with the data */
 898	msg = (struct keyspan_usa67_portStatusMessage *)data;
 899
 900	/* Check port number from message and retrieve private data */
 901	if (msg->port >= serial->num_ports) {
 902		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
 903		return;
 904	}
 905
 906	port = serial->port[msg->port];
 907	p_priv = usb_get_serial_port_data(port);
 
 
 908
 909	/* Update handshaking pin state information */
 910	old_dcd_state = p_priv->dcd_state;
 911	p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
 912	p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
 913
 914	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
 915		tty_port_tty_hangup(&port->port, true);
 916
 917	/* Resubmit urb so we continue receiving */
 918	err = usb_submit_urb(urb, GFP_ATOMIC);
 919	if (err != 0)
 920		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 921}
 922
 923static void usa67_glocont_callback(struct urb *urb)
 924{
 925	struct usb_serial *serial;
 926	struct usb_serial_port *port;
 927	struct keyspan_port_private *p_priv;
 928	int i;
 929
 930	serial = urb->context;
 931	for (i = 0; i < serial->num_ports; ++i) {
 932		port = serial->port[i];
 933		p_priv = usb_get_serial_port_data(port);
 934
 935		if (p_priv->resend_cont) {
 936			dev_dbg(&port->dev, "%s - sending setup\n", __func__);
 937			keyspan_usa67_send_setup(serial, port,
 938						p_priv->resend_cont - 1);
 939			break;
 940		}
 941	}
 942}
 943
 944static int keyspan_write_room(struct tty_struct *tty)
 945{
 946	struct usb_serial_port *port = tty->driver_data;
 947	struct keyspan_port_private	*p_priv;
 948	const struct keyspan_device_details	*d_details;
 949	int				flip;
 950	int				data_len;
 951	struct urb			*this_urb;
 952
 953	p_priv = usb_get_serial_port_data(port);
 954	d_details = p_priv->device_details;
 955
 956	/* FIXME: locking */
 957	if (d_details->msg_format == msg_usa90)
 958		data_len = 64;
 959	else
 960		data_len = 63;
 961
 962	flip = p_priv->out_flip;
 963
 964	/* Check both endpoints to see if any are available. */
 965	this_urb = p_priv->out_urbs[flip];
 966	if (this_urb != NULL) {
 967		if (this_urb->status != -EINPROGRESS)
 968			return data_len;
 969		flip = (flip + 1) & d_details->outdat_endp_flip;
 970		this_urb = p_priv->out_urbs[flip];
 971		if (this_urb != NULL) {
 972			if (this_urb->status != -EINPROGRESS)
 973				return data_len;
 974		}
 975	}
 976	return 0;
 977}
 978
 979
 980static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port)
 981{
 982	struct keyspan_port_private 	*p_priv;
 983	const struct keyspan_device_details	*d_details;
 984	int				i, err;
 985	int				baud_rate, device_port;
 986	struct urb			*urb;
 987	unsigned int			cflag = 0;
 988
 989	p_priv = usb_get_serial_port_data(port);
 990	d_details = p_priv->device_details;
 991
 992	/* Set some sane defaults */
 993	p_priv->rts_state = 1;
 994	p_priv->dtr_state = 1;
 995	p_priv->baud = 9600;
 996
 997	/* force baud and lcr to be set on open */
 998	p_priv->old_baud = 0;
 999	p_priv->old_cflag = 0;
1000
1001	p_priv->out_flip = 0;
1002	p_priv->in_flip = 0;
1003
1004	/* Reset low level data toggle and start reading from endpoints */
1005	for (i = 0; i < 2; i++) {
1006		urb = p_priv->in_urbs[i];
1007		if (urb == NULL)
1008			continue;
1009
1010		/* make sure endpoint data toggle is synchronized
1011		   with the device */
1012		usb_clear_halt(urb->dev, urb->pipe);
1013		err = usb_submit_urb(urb, GFP_KERNEL);
1014		if (err != 0)
1015			dev_dbg(&port->dev, "%s - submit urb %d failed (%d)\n", __func__, i, err);
1016	}
1017
1018	/* Reset low level data toggle on out endpoints */
1019	for (i = 0; i < 2; i++) {
1020		urb = p_priv->out_urbs[i];
1021		if (urb == NULL)
1022			continue;
1023		/* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1024						usb_pipeout(urb->pipe), 0); */
1025	}
1026
1027	/* get the terminal config for the setup message now so we don't
1028	 * need to send 2 of them */
1029
1030	device_port = port->port_number;
1031	if (tty) {
1032		cflag = tty->termios.c_cflag;
1033		/* Baud rate calculation takes baud rate as an integer
1034		   so other rates can be generated if desired. */
1035		baud_rate = tty_get_baud_rate(tty);
1036		/* If no match or invalid, leave as default */
1037		if (baud_rate >= 0
1038		    && d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
1039					NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
1040			p_priv->baud = baud_rate;
1041		}
1042	}
1043	/* set CTS/RTS handshake etc. */
1044	p_priv->cflag = cflag;
1045	p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
1046
1047	keyspan_send_setup(port, 1);
1048	/* mdelay(100); */
1049	/* keyspan_set_termios(port, NULL); */
1050
1051	return 0;
1052}
1053
1054static inline void stop_urb(struct urb *urb)
1055{
1056	if (urb && urb->status == -EINPROGRESS)
1057		usb_kill_urb(urb);
1058}
1059
1060static void keyspan_dtr_rts(struct usb_serial_port *port, int on)
1061{
1062	struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
1063
1064	p_priv->rts_state = on;
1065	p_priv->dtr_state = on;
1066	keyspan_send_setup(port, 0);
1067}
1068
1069static void keyspan_close(struct usb_serial_port *port)
1070{
1071	int			i;
1072	struct keyspan_port_private 	*p_priv;
1073
1074	p_priv = usb_get_serial_port_data(port);
1075
1076	p_priv->rts_state = 0;
1077	p_priv->dtr_state = 0;
1078
1079	keyspan_send_setup(port, 2);
1080	/* pilot-xfer seems to work best with this delay */
1081	mdelay(100);
1082
1083	p_priv->out_flip = 0;
1084	p_priv->in_flip = 0;
1085
1086	stop_urb(p_priv->inack_urb);
1087	for (i = 0; i < 2; i++) {
1088		stop_urb(p_priv->in_urbs[i]);
1089		stop_urb(p_priv->out_urbs[i]);
1090	}
1091}
1092
1093/* download the firmware to a pre-renumeration device */
1094static int keyspan_fake_startup(struct usb_serial *serial)
1095{
1096	char	*fw_name;
1097
1098	dev_dbg(&serial->dev->dev, "Keyspan startup version %04x product %04x\n",
1099		le16_to_cpu(serial->dev->descriptor.bcdDevice),
1100		le16_to_cpu(serial->dev->descriptor.idProduct));
1101
1102	if ((le16_to_cpu(serial->dev->descriptor.bcdDevice) & 0x8000)
1103								!= 0x8000) {
1104		dev_dbg(&serial->dev->dev, "Firmware already loaded.  Quitting.\n");
1105		return 1;
1106	}
1107
1108		/* Select firmware image on the basis of idProduct */
1109	switch (le16_to_cpu(serial->dev->descriptor.idProduct)) {
1110	case keyspan_usa28_pre_product_id:
1111		fw_name = "keyspan/usa28.fw";
1112		break;
1113
1114	case keyspan_usa28x_pre_product_id:
1115		fw_name = "keyspan/usa28x.fw";
1116		break;
1117
1118	case keyspan_usa28xa_pre_product_id:
1119		fw_name = "keyspan/usa28xa.fw";
1120		break;
1121
1122	case keyspan_usa28xb_pre_product_id:
1123		fw_name = "keyspan/usa28xb.fw";
1124		break;
1125
1126	case keyspan_usa19_pre_product_id:
1127		fw_name = "keyspan/usa19.fw";
1128		break;
1129
1130	case keyspan_usa19qi_pre_product_id:
1131		fw_name = "keyspan/usa19qi.fw";
1132		break;
1133
1134	case keyspan_mpr_pre_product_id:
1135		fw_name = "keyspan/mpr.fw";
1136		break;
1137
1138	case keyspan_usa19qw_pre_product_id:
1139		fw_name = "keyspan/usa19qw.fw";
1140		break;
1141
1142	case keyspan_usa18x_pre_product_id:
1143		fw_name = "keyspan/usa18x.fw";
1144		break;
1145
1146	case keyspan_usa19w_pre_product_id:
1147		fw_name = "keyspan/usa19w.fw";
1148		break;
1149
1150	case keyspan_usa49w_pre_product_id:
1151		fw_name = "keyspan/usa49w.fw";
1152		break;
1153
1154	case keyspan_usa49wlc_pre_product_id:
1155		fw_name = "keyspan/usa49wlc.fw";
1156		break;
1157
1158	default:
1159		dev_err(&serial->dev->dev, "Unknown product ID (%04x)\n",
1160			le16_to_cpu(serial->dev->descriptor.idProduct));
1161		return 1;
1162	}
1163
1164	dev_dbg(&serial->dev->dev, "Uploading Keyspan %s firmware.\n", fw_name);
1165
1166	if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
1167		dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
1168			fw_name);
1169		return -ENOENT;
1170	}
1171
1172	/* after downloading firmware Renumeration will occur in a
1173	  moment and the new device will bind to the real driver */
1174
1175	/* we don't want this device to have a driver assigned to it. */
1176	return 1;
1177}
1178
1179/* Helper functions used by keyspan_setup_urbs */
1180static struct usb_endpoint_descriptor const *find_ep(struct usb_serial const *serial,
1181						     int endpoint)
1182{
1183	struct usb_host_interface *iface_desc;
1184	struct usb_endpoint_descriptor *ep;
1185	int i;
1186
1187	iface_desc = serial->interface->cur_altsetting;
1188	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1189		ep = &iface_desc->endpoint[i].desc;
1190		if (ep->bEndpointAddress == endpoint)
1191			return ep;
1192	}
1193	dev_warn(&serial->interface->dev, "found no endpoint descriptor for "
1194		 "endpoint %x\n", endpoint);
1195	return NULL;
1196}
1197
1198static struct urb *keyspan_setup_urb(struct usb_serial *serial, int endpoint,
1199				      int dir, void *ctx, char *buf, int len,
1200				      void (*callback)(struct urb *))
1201{
1202	struct urb *urb;
1203	struct usb_endpoint_descriptor const *ep_desc;
1204	char const *ep_type_name;
1205
1206	if (endpoint == -1)
1207		return NULL;		/* endpoint not needed */
1208
1209	dev_dbg(&serial->interface->dev, "%s - alloc for endpoint %d.\n", __func__, endpoint);
 
1210	urb = usb_alloc_urb(0, GFP_KERNEL);		/* No ISO */
1211	if (!urb)
1212		return NULL;
1213
1214	if (endpoint == 0) {
1215		/* control EP filled in when used */
1216		return urb;
1217	}
1218
1219	ep_desc = find_ep(serial, endpoint);
1220	if (!ep_desc) {
1221		/* leak the urb, something's wrong and the callers don't care */
1222		return urb;
1223	}
1224	if (usb_endpoint_xfer_int(ep_desc)) {
1225		ep_type_name = "INT";
1226		usb_fill_int_urb(urb, serial->dev,
1227				 usb_sndintpipe(serial->dev, endpoint) | dir,
1228				 buf, len, callback, ctx,
1229				 ep_desc->bInterval);
1230	} else if (usb_endpoint_xfer_bulk(ep_desc)) {
1231		ep_type_name = "BULK";
1232		usb_fill_bulk_urb(urb, serial->dev,
1233				  usb_sndbulkpipe(serial->dev, endpoint) | dir,
1234				  buf, len, callback, ctx);
1235	} else {
1236		dev_warn(&serial->interface->dev,
1237			 "unsupported endpoint type %x\n",
1238			 usb_endpoint_type(ep_desc));
1239		usb_free_urb(urb);
1240		return NULL;
1241	}
1242
1243	dev_dbg(&serial->interface->dev, "%s - using urb %p for %s endpoint %x\n",
1244	    __func__, urb, ep_type_name, endpoint);
1245	return urb;
1246}
1247
1248static struct callbacks {
1249	void	(*instat_callback)(struct urb *);
1250	void	(*glocont_callback)(struct urb *);
1251	void	(*indat_callback)(struct urb *);
1252	void	(*outdat_callback)(struct urb *);
1253	void	(*inack_callback)(struct urb *);
1254	void	(*outcont_callback)(struct urb *);
1255} keyspan_callbacks[] = {
1256	{
1257		/* msg_usa26 callbacks */
1258		.instat_callback =	usa26_instat_callback,
1259		.glocont_callback =	usa26_glocont_callback,
1260		.indat_callback =	usa26_indat_callback,
1261		.outdat_callback =	usa2x_outdat_callback,
1262		.inack_callback =	usa26_inack_callback,
1263		.outcont_callback =	usa26_outcont_callback,
1264	}, {
1265		/* msg_usa28 callbacks */
1266		.instat_callback =	usa28_instat_callback,
1267		.glocont_callback =	usa28_glocont_callback,
1268		.indat_callback =	usa28_indat_callback,
1269		.outdat_callback =	usa2x_outdat_callback,
1270		.inack_callback =	usa28_inack_callback,
1271		.outcont_callback =	usa28_outcont_callback,
1272	}, {
1273		/* msg_usa49 callbacks */
1274		.instat_callback =	usa49_instat_callback,
1275		.glocont_callback =	usa49_glocont_callback,
1276		.indat_callback =	usa49_indat_callback,
1277		.outdat_callback =	usa2x_outdat_callback,
1278		.inack_callback =	usa49_inack_callback,
1279		.outcont_callback =	usa49_outcont_callback,
1280	}, {
1281		/* msg_usa90 callbacks */
1282		.instat_callback =	usa90_instat_callback,
1283		.glocont_callback =	usa28_glocont_callback,
1284		.indat_callback =	usa90_indat_callback,
1285		.outdat_callback =	usa2x_outdat_callback,
1286		.inack_callback =	usa28_inack_callback,
1287		.outcont_callback =	usa90_outcont_callback,
1288	}, {
1289		/* msg_usa67 callbacks */
1290		.instat_callback =	usa67_instat_callback,
1291		.glocont_callback =	usa67_glocont_callback,
1292		.indat_callback =	usa26_indat_callback,
1293		.outdat_callback =	usa2x_outdat_callback,
1294		.inack_callback =	usa26_inack_callback,
1295		.outcont_callback =	usa26_outcont_callback,
1296	}
1297};
1298
1299	/* Generic setup urbs function that uses
1300	   data in device_details */
1301static void keyspan_setup_urbs(struct usb_serial *serial)
1302{
1303	struct keyspan_serial_private 	*s_priv;
1304	const struct keyspan_device_details	*d_details;
1305	struct callbacks		*cback;
1306
1307	s_priv = usb_get_serial_data(serial);
1308	d_details = s_priv->device_details;
1309
1310	/* Setup values for the various callback routines */
1311	cback = &keyspan_callbacks[d_details->msg_format];
1312
1313	/* Allocate and set up urbs for each one that is in use,
1314	   starting with instat endpoints */
1315	s_priv->instat_urb = keyspan_setup_urb
1316		(serial, d_details->instat_endpoint, USB_DIR_IN,
1317		 serial, s_priv->instat_buf, INSTAT_BUFLEN,
1318		 cback->instat_callback);
1319
1320	s_priv->indat_urb = keyspan_setup_urb
1321		(serial, d_details->indat_endpoint, USB_DIR_IN,
1322		 serial, s_priv->indat_buf, INDAT49W_BUFLEN,
1323		 usa49wg_indat_callback);
1324
1325	s_priv->glocont_urb = keyspan_setup_urb
1326		(serial, d_details->glocont_endpoint, USB_DIR_OUT,
1327		 serial, s_priv->glocont_buf, GLOCONT_BUFLEN,
1328		 cback->glocont_callback);
1329}
1330
1331/* usa19 function doesn't require prescaler */
1332static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
1333				   u32 baud_rate, u32 baudclk, u8 *rate_hi,
1334				   u8 *rate_low, u8 *prescaler, int portnum)
1335{
1336	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1337		div,	/* divisor */
1338		cnt;	/* inverse of divisor (programmed into 8051) */
1339
1340	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1341
1342	/* prevent divide by zero...  */
1343	b16 = baud_rate * 16L;
1344	if (b16 == 0)
1345		return KEYSPAN_INVALID_BAUD_RATE;
1346	/* Any "standard" rate over 57k6 is marginal on the USA-19
1347	   as we run out of divisor resolution. */
1348	if (baud_rate > 57600)
1349		return KEYSPAN_INVALID_BAUD_RATE;
1350
1351	/* calculate the divisor and the counter (its inverse) */
1352	div = baudclk / b16;
1353	if (div == 0)
1354		return KEYSPAN_INVALID_BAUD_RATE;
1355	else
1356		cnt = 0 - div;
1357
1358	if (div > 0xffff)
1359		return KEYSPAN_INVALID_BAUD_RATE;
1360
1361	/* return the counter values if non-null */
1362	if (rate_low)
1363		*rate_low = (u8) (cnt & 0xff);
1364	if (rate_hi)
1365		*rate_hi = (u8) ((cnt >> 8) & 0xff);
1366	if (rate_low && rate_hi)
1367		dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1368				__func__, baud_rate, *rate_hi, *rate_low);
1369	return KEYSPAN_BAUD_RATE_OK;
1370}
1371
1372/* usa19hs function doesn't require prescaler */
1373static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
1374				     u32 baud_rate, u32 baudclk, u8 *rate_hi,
1375				     u8 *rate_low, u8 *prescaler, int portnum)
1376{
1377	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1378			div;	/* divisor */
1379
1380	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1381
1382	/* prevent divide by zero...  */
1383	b16 = baud_rate * 16L;
1384	if (b16 == 0)
1385		return KEYSPAN_INVALID_BAUD_RATE;
1386
1387	/* calculate the divisor */
1388	div = baudclk / b16;
1389	if (div == 0)
1390		return KEYSPAN_INVALID_BAUD_RATE;
1391
1392	if (div > 0xffff)
1393		return KEYSPAN_INVALID_BAUD_RATE;
1394
1395	/* return the counter values if non-null */
1396	if (rate_low)
1397		*rate_low = (u8) (div & 0xff);
1398
1399	if (rate_hi)
1400		*rate_hi = (u8) ((div >> 8) & 0xff);
1401
1402	if (rate_low && rate_hi)
1403		dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1404			__func__, baud_rate, *rate_hi, *rate_low);
1405
1406	return KEYSPAN_BAUD_RATE_OK;
1407}
1408
1409static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
1410				    u32 baud_rate, u32 baudclk, u8 *rate_hi,
1411				    u8 *rate_low, u8 *prescaler, int portnum)
1412{
1413	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1414		clk,	/* clock with 13/8 prescaler */
1415		div,	/* divisor using 13/8 prescaler */
1416		res,	/* resulting baud rate using 13/8 prescaler */
1417		diff,	/* error using 13/8 prescaler */
1418		smallest_diff;
1419	u8	best_prescaler;
1420	int	i;
1421
1422	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1423
1424	/* prevent divide by zero */
1425	b16 = baud_rate * 16L;
1426	if (b16 == 0)
1427		return KEYSPAN_INVALID_BAUD_RATE;
1428
1429	/* Calculate prescaler by trying them all and looking
1430	   for best fit */
1431
1432	/* start with largest possible difference */
1433	smallest_diff = 0xffffffff;
1434
1435		/* 0 is an invalid prescaler, used as a flag */
1436	best_prescaler = 0;
1437
1438	for (i = 8; i <= 0xff; ++i) {
1439		clk = (baudclk * 8) / (u32) i;
1440
1441		div = clk / b16;
1442		if (div == 0)
1443			continue;
1444
1445		res = clk / div;
1446		diff = (res > b16) ? (res-b16) : (b16-res);
1447
1448		if (diff < smallest_diff) {
1449			best_prescaler = i;
1450			smallest_diff = diff;
1451		}
1452	}
1453
1454	if (best_prescaler == 0)
1455		return KEYSPAN_INVALID_BAUD_RATE;
1456
1457	clk = (baudclk * 8) / (u32) best_prescaler;
1458	div = clk / b16;
1459
1460	/* return the divisor and prescaler if non-null */
1461	if (rate_low)
1462		*rate_low = (u8) (div & 0xff);
1463	if (rate_hi)
1464		*rate_hi = (u8) ((div >> 8) & 0xff);
1465	if (prescaler) {
1466		*prescaler = best_prescaler;
1467		/*  dev_dbg(&port->dev, "%s - %d %d\n", __func__, *prescaler, div); */
1468	}
1469	return KEYSPAN_BAUD_RATE_OK;
1470}
1471
1472	/* USA-28 supports different maximum baud rates on each port */
1473static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
1474				   u32 baud_rate, u32 baudclk, u8 *rate_hi,
1475				   u8 *rate_low, u8 *prescaler, int portnum)
1476{
1477	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1478		div,	/* divisor */
1479		cnt;	/* inverse of divisor (programmed into 8051) */
1480
1481	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1482
1483		/* prevent divide by zero */
1484	b16 = baud_rate * 16L;
1485	if (b16 == 0)
1486		return KEYSPAN_INVALID_BAUD_RATE;
1487
1488	/* calculate the divisor and the counter (its inverse) */
1489	div = KEYSPAN_USA28_BAUDCLK / b16;
1490	if (div == 0)
1491		return KEYSPAN_INVALID_BAUD_RATE;
1492	else
1493		cnt = 0 - div;
1494
1495	/* check for out of range, based on portnum,
1496	   and return result */
1497	if (portnum == 0) {
1498		if (div > 0xffff)
1499			return KEYSPAN_INVALID_BAUD_RATE;
1500	} else {
1501		if (portnum == 1) {
1502			if (div > 0xff)
1503				return KEYSPAN_INVALID_BAUD_RATE;
1504		} else
1505			return KEYSPAN_INVALID_BAUD_RATE;
1506	}
1507
1508		/* return the counter values if not NULL
1509		   (port 1 will ignore retHi) */
1510	if (rate_low)
1511		*rate_low = (u8) (cnt & 0xff);
1512	if (rate_hi)
1513		*rate_hi = (u8) ((cnt >> 8) & 0xff);
1514	dev_dbg(&port->dev, "%s - %d OK.\n", __func__, baud_rate);
1515	return KEYSPAN_BAUD_RATE_OK;
1516}
1517
1518static int keyspan_usa26_send_setup(struct usb_serial *serial,
1519				    struct usb_serial_port *port,
1520				    int reset_port)
1521{
1522	struct keyspan_usa26_portControlMessage	msg;
1523	struct keyspan_serial_private 		*s_priv;
1524	struct keyspan_port_private 		*p_priv;
1525	const struct keyspan_device_details	*d_details;
1526	struct urb				*this_urb;
1527	int 					device_port, err;
1528
1529	dev_dbg(&port->dev, "%s reset=%d\n", __func__, reset_port);
1530
1531	s_priv = usb_get_serial_data(serial);
1532	p_priv = usb_get_serial_port_data(port);
1533	d_details = s_priv->device_details;
1534	device_port = port->port_number;
1535
1536	this_urb = p_priv->outcont_urb;
1537
1538	dev_dbg(&port->dev, "%s - endpoint %d\n", __func__, usb_pipeendpoint(this_urb->pipe));
1539
1540		/* Make sure we have an urb then send the message */
1541	if (this_urb == NULL) {
1542		dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
1543		return -1;
1544	}
1545
 
 
 
1546	/* Save reset port val for resend.
1547	   Don't overwrite resend for open/close condition. */
1548	if ((reset_port + 1) > p_priv->resend_cont)
1549		p_priv->resend_cont = reset_port + 1;
1550	if (this_urb->status == -EINPROGRESS) {
1551		/*  dev_dbg(&port->dev, "%s - already writing\n", __func__); */
1552		mdelay(5);
1553		return -1;
1554	}
1555
1556	memset(&msg, 0, sizeof(struct keyspan_usa26_portControlMessage));
1557
1558	/* Only set baud rate if it's changed */
1559	if (p_priv->old_baud != p_priv->baud) {
1560		p_priv->old_baud = p_priv->baud;
1561		msg.setClocking = 0xff;
1562		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
1563						   &msg.baudHi, &msg.baudLo, &msg.prescaler,
1564						   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
1565			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
1566				__func__, p_priv->baud);
1567			msg.baudLo = 0;
1568			msg.baudHi = 125;	/* Values for 9600 baud */
1569			msg.prescaler = 10;
1570		}
1571		msg.setPrescaler = 0xff;
1572	}
1573
1574	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
1575	switch (p_priv->cflag & CSIZE) {
1576	case CS5:
1577		msg.lcr |= USA_DATABITS_5;
1578		break;
1579	case CS6:
1580		msg.lcr |= USA_DATABITS_6;
1581		break;
1582	case CS7:
1583		msg.lcr |= USA_DATABITS_7;
1584		break;
1585	case CS8:
1586		msg.lcr |= USA_DATABITS_8;
1587		break;
1588	}
1589	if (p_priv->cflag & PARENB) {
1590		/* note USA_PARITY_NONE == 0 */
1591		msg.lcr |= (p_priv->cflag & PARODD) ?
1592			USA_PARITY_ODD : USA_PARITY_EVEN;
1593	}
1594	msg.setLcr = 0xff;
1595
1596	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
1597	msg.xonFlowControl = 0;
1598	msg.setFlowControl = 0xff;
1599	msg.forwardingLength = 16;
1600	msg.xonChar = 17;
1601	msg.xoffChar = 19;
1602
1603	/* Opening port */
1604	if (reset_port == 1) {
1605		msg._txOn = 1;
1606		msg._txOff = 0;
1607		msg.txFlush = 0;
1608		msg.txBreak = 0;
1609		msg.rxOn = 1;
1610		msg.rxOff = 0;
1611		msg.rxFlush = 1;
1612		msg.rxForward = 0;
1613		msg.returnStatus = 0;
1614		msg.resetDataToggle = 0xff;
1615	}
1616
1617	/* Closing port */
1618	else if (reset_port == 2) {
1619		msg._txOn = 0;
1620		msg._txOff = 1;
1621		msg.txFlush = 0;
1622		msg.txBreak = 0;
1623		msg.rxOn = 0;
1624		msg.rxOff = 1;
1625		msg.rxFlush = 1;
1626		msg.rxForward = 0;
1627		msg.returnStatus = 0;
1628		msg.resetDataToggle = 0;
1629	}
1630
1631	/* Sending intermediate configs */
1632	else {
1633		msg._txOn = (!p_priv->break_on);
1634		msg._txOff = 0;
1635		msg.txFlush = 0;
1636		msg.txBreak = (p_priv->break_on);
1637		msg.rxOn = 0;
1638		msg.rxOff = 0;
1639		msg.rxFlush = 0;
1640		msg.rxForward = 0;
1641		msg.returnStatus = 0;
1642		msg.resetDataToggle = 0x0;
1643	}
1644
1645	/* Do handshaking outputs */
1646	msg.setTxTriState_setRts = 0xff;
1647	msg.txTriState_rts = p_priv->rts_state;
1648
1649	msg.setHskoa_setDtr = 0xff;
1650	msg.hskoa_dtr = p_priv->dtr_state;
1651
1652	p_priv->resend_cont = 0;
1653	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
1654
1655	/* send the data out the device on control endpoint */
1656	this_urb->transfer_buffer_length = sizeof(msg);
1657
1658	err = usb_submit_urb(this_urb, GFP_ATOMIC);
1659	if (err != 0)
1660		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
1661	return 0;
1662}
1663
1664static int keyspan_usa28_send_setup(struct usb_serial *serial,
1665				    struct usb_serial_port *port,
1666				    int reset_port)
1667{
1668	struct keyspan_usa28_portControlMessage	msg;
1669	struct keyspan_serial_private	 	*s_priv;
1670	struct keyspan_port_private 		*p_priv;
1671	const struct keyspan_device_details	*d_details;
1672	struct urb				*this_urb;
1673	int 					device_port, err;
1674
1675	s_priv = usb_get_serial_data(serial);
1676	p_priv = usb_get_serial_port_data(port);
1677	d_details = s_priv->device_details;
1678	device_port = port->port_number;
1679
1680	/* only do something if we have a bulk out endpoint */
1681	this_urb = p_priv->outcont_urb;
1682	if (this_urb == NULL) {
1683		dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
1684		return -1;
1685	}
1686
1687	/* Save reset port val for resend.
1688	   Don't overwrite resend for open/close condition. */
1689	if ((reset_port + 1) > p_priv->resend_cont)
1690		p_priv->resend_cont = reset_port + 1;
1691	if (this_urb->status == -EINPROGRESS) {
1692		dev_dbg(&port->dev, "%s already writing\n", __func__);
1693		mdelay(5);
1694		return -1;
1695	}
1696
1697	memset(&msg, 0, sizeof(struct keyspan_usa28_portControlMessage));
1698
1699	msg.setBaudRate = 1;
1700	if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
1701					   &msg.baudHi, &msg.baudLo, NULL,
1702					   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
1703		dev_dbg(&port->dev, "%s - Invalid baud rate requested %d.\n",
1704						__func__, p_priv->baud);
1705		msg.baudLo = 0xff;
1706		msg.baudHi = 0xb2;	/* Values for 9600 baud */
1707	}
1708
1709	/* If parity is enabled, we must calculate it ourselves. */
1710	msg.parity = 0;		/* XXX for now */
1711
1712	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
1713	msg.xonFlowControl = 0;
1714
1715	/* Do handshaking outputs, DTR is inverted relative to RTS */
1716	msg.rts = p_priv->rts_state;
1717	msg.dtr = p_priv->dtr_state;
1718
1719	msg.forwardingLength = 16;
1720	msg.forwardMs = 10;
1721	msg.breakThreshold = 45;
1722	msg.xonChar = 17;
1723	msg.xoffChar = 19;
1724
1725	/*msg.returnStatus = 1;
1726	msg.resetDataToggle = 0xff;*/
1727	/* Opening port */
1728	if (reset_port == 1) {
1729		msg._txOn = 1;
1730		msg._txOff = 0;
1731		msg.txFlush = 0;
1732		msg.txForceXoff = 0;
1733		msg.txBreak = 0;
1734		msg.rxOn = 1;
1735		msg.rxOff = 0;
1736		msg.rxFlush = 1;
1737		msg.rxForward = 0;
1738		msg.returnStatus = 0;
1739		msg.resetDataToggle = 0xff;
1740	}
1741	/* Closing port */
1742	else if (reset_port == 2) {
1743		msg._txOn = 0;
1744		msg._txOff = 1;
1745		msg.txFlush = 0;
1746		msg.txForceXoff = 0;
1747		msg.txBreak = 0;
1748		msg.rxOn = 0;
1749		msg.rxOff = 1;
1750		msg.rxFlush = 1;
1751		msg.rxForward = 0;
1752		msg.returnStatus = 0;
1753		msg.resetDataToggle = 0;
1754	}
1755	/* Sending intermediate configs */
1756	else {
1757		msg._txOn = (!p_priv->break_on);
1758		msg._txOff = 0;
1759		msg.txFlush = 0;
1760		msg.txForceXoff = 0;
1761		msg.txBreak = (p_priv->break_on);
1762		msg.rxOn = 0;
1763		msg.rxOff = 0;
1764		msg.rxFlush = 0;
1765		msg.rxForward = 0;
1766		msg.returnStatus = 0;
1767		msg.resetDataToggle = 0x0;
1768	}
1769
1770	p_priv->resend_cont = 0;
1771	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
1772
1773	/* send the data out the device on control endpoint */
1774	this_urb->transfer_buffer_length = sizeof(msg);
1775
1776	err = usb_submit_urb(this_urb, GFP_ATOMIC);
1777	if (err != 0)
1778		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed\n", __func__);
1779
1780	return 0;
1781}
1782
1783static int keyspan_usa49_send_setup(struct usb_serial *serial,
1784				    struct usb_serial_port *port,
1785				    int reset_port)
1786{
1787	struct keyspan_usa49_portControlMessage	msg;
1788	struct usb_ctrlrequest 			*dr = NULL;
1789	struct keyspan_serial_private 		*s_priv;
1790	struct keyspan_port_private 		*p_priv;
1791	const struct keyspan_device_details	*d_details;
1792	struct urb				*this_urb;
1793	int 					err, device_port;
1794
1795	s_priv = usb_get_serial_data(serial);
1796	p_priv = usb_get_serial_port_data(port);
1797	d_details = s_priv->device_details;
1798
1799	this_urb = s_priv->glocont_urb;
1800
1801	/* Work out which port within the device is being setup */
1802	device_port = port->port_number;
1803
1804	/* Make sure we have an urb then send the message */
1805	if (this_urb == NULL) {
1806		dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
1807		return -1;
1808	}
1809
1810	dev_dbg(&port->dev, "%s - endpoint %d (%d)\n",
1811		__func__, usb_pipeendpoint(this_urb->pipe), device_port);
1812
1813	/* Save reset port val for resend.
1814	   Don't overwrite resend for open/close condition. */
1815	if ((reset_port + 1) > p_priv->resend_cont)
1816		p_priv->resend_cont = reset_port + 1;
1817
1818	if (this_urb->status == -EINPROGRESS) {
1819		/*  dev_dbg(&port->dev, "%s - already writing\n", __func__); */
1820		mdelay(5);
1821		return -1;
1822	}
1823
1824	memset(&msg, 0, sizeof(struct keyspan_usa49_portControlMessage));
1825
1826	msg.portNumber = device_port;
1827
1828	/* Only set baud rate if it's changed */
1829	if (p_priv->old_baud != p_priv->baud) {
1830		p_priv->old_baud = p_priv->baud;
1831		msg.setClocking = 0xff;
1832		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
1833						   &msg.baudHi, &msg.baudLo, &msg.prescaler,
1834						   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
1835			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
1836				__func__, p_priv->baud);
1837			msg.baudLo = 0;
1838			msg.baudHi = 125;	/* Values for 9600 baud */
1839			msg.prescaler = 10;
1840		}
1841		/* msg.setPrescaler = 0xff; */
1842	}
1843
1844	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
1845	switch (p_priv->cflag & CSIZE) {
1846	case CS5:
1847		msg.lcr |= USA_DATABITS_5;
1848		break;
1849	case CS6:
1850		msg.lcr |= USA_DATABITS_6;
1851		break;
1852	case CS7:
1853		msg.lcr |= USA_DATABITS_7;
1854		break;
1855	case CS8:
1856		msg.lcr |= USA_DATABITS_8;
1857		break;
1858	}
1859	if (p_priv->cflag & PARENB) {
1860		/* note USA_PARITY_NONE == 0 */
1861		msg.lcr |= (p_priv->cflag & PARODD) ?
1862			USA_PARITY_ODD : USA_PARITY_EVEN;
1863	}
1864	msg.setLcr = 0xff;
1865
1866	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
1867	msg.xonFlowControl = 0;
1868	msg.setFlowControl = 0xff;
1869
1870	msg.forwardingLength = 16;
1871	msg.xonChar = 17;
1872	msg.xoffChar = 19;
1873
1874	/* Opening port */
1875	if (reset_port == 1) {
1876		msg._txOn = 1;
1877		msg._txOff = 0;
1878		msg.txFlush = 0;
1879		msg.txBreak = 0;
1880		msg.rxOn = 1;
1881		msg.rxOff = 0;
1882		msg.rxFlush = 1;
1883		msg.rxForward = 0;
1884		msg.returnStatus = 0;
1885		msg.resetDataToggle = 0xff;
1886		msg.enablePort = 1;
1887		msg.disablePort = 0;
1888	}
1889	/* Closing port */
1890	else if (reset_port == 2) {
1891		msg._txOn = 0;
1892		msg._txOff = 1;
1893		msg.txFlush = 0;
1894		msg.txBreak = 0;
1895		msg.rxOn = 0;
1896		msg.rxOff = 1;
1897		msg.rxFlush = 1;
1898		msg.rxForward = 0;
1899		msg.returnStatus = 0;
1900		msg.resetDataToggle = 0;
1901		msg.enablePort = 0;
1902		msg.disablePort = 1;
1903	}
1904	/* Sending intermediate configs */
1905	else {
1906		msg._txOn = (!p_priv->break_on);
1907		msg._txOff = 0;
1908		msg.txFlush = 0;
1909		msg.txBreak = (p_priv->break_on);
1910		msg.rxOn = 0;
1911		msg.rxOff = 0;
1912		msg.rxFlush = 0;
1913		msg.rxForward = 0;
1914		msg.returnStatus = 0;
1915		msg.resetDataToggle = 0x0;
1916		msg.enablePort = 0;
1917		msg.disablePort = 0;
1918	}
1919
1920	/* Do handshaking outputs */
1921	msg.setRts = 0xff;
1922	msg.rts = p_priv->rts_state;
1923
1924	msg.setDtr = 0xff;
1925	msg.dtr = p_priv->dtr_state;
1926
1927	p_priv->resend_cont = 0;
1928
1929	/* if the device is a 49wg, we send control message on usb
1930	   control EP 0 */
1931
1932	if (d_details->product_id == keyspan_usa49wg_product_id) {
1933		dr = (void *)(s_priv->ctrl_buf);
1934		dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_OUT;
1935		dr->bRequest = 0xB0;	/* 49wg control message */;
1936		dr->wValue = 0;
1937		dr->wIndex = 0;
1938		dr->wLength = cpu_to_le16(sizeof(msg));
1939
1940		memcpy(s_priv->glocont_buf, &msg, sizeof(msg));
1941
1942		usb_fill_control_urb(this_urb, serial->dev,
1943				usb_sndctrlpipe(serial->dev, 0),
1944				(unsigned char *)dr, s_priv->glocont_buf,
1945				sizeof(msg), usa49_glocont_callback, serial);
1946
1947	} else {
1948		memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
1949
1950		/* send the data out the device on control endpoint */
1951		this_urb->transfer_buffer_length = sizeof(msg);
1952	}
1953	err = usb_submit_urb(this_urb, GFP_ATOMIC);
1954	if (err != 0)
1955		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
1956
1957	return 0;
1958}
1959
1960static int keyspan_usa90_send_setup(struct usb_serial *serial,
1961				    struct usb_serial_port *port,
1962				    int reset_port)
1963{
1964	struct keyspan_usa90_portControlMessage	msg;
1965	struct keyspan_serial_private 		*s_priv;
1966	struct keyspan_port_private 		*p_priv;
1967	const struct keyspan_device_details	*d_details;
1968	struct urb				*this_urb;
1969	int 					err;
1970	u8						prescaler;
1971
1972	s_priv = usb_get_serial_data(serial);
1973	p_priv = usb_get_serial_port_data(port);
1974	d_details = s_priv->device_details;
1975
1976	/* only do something if we have a bulk out endpoint */
1977	this_urb = p_priv->outcont_urb;
1978	if (this_urb == NULL) {
1979		dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
1980		return -1;
1981	}
1982
1983	/* Save reset port val for resend.
1984	   Don't overwrite resend for open/close condition. */
1985	if ((reset_port + 1) > p_priv->resend_cont)
1986		p_priv->resend_cont = reset_port + 1;
1987	if (this_urb->status == -EINPROGRESS) {
1988		dev_dbg(&port->dev, "%s already writing\n", __func__);
1989		mdelay(5);
1990		return -1;
1991	}
1992
1993	memset(&msg, 0, sizeof(struct keyspan_usa90_portControlMessage));
1994
1995	/* Only set baud rate if it's changed */
1996	if (p_priv->old_baud != p_priv->baud) {
1997		p_priv->old_baud = p_priv->baud;
1998		msg.setClocking = 0x01;
1999		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2000						   &msg.baudHi, &msg.baudLo, &prescaler, 0) == KEYSPAN_INVALID_BAUD_RATE) {
2001			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2002				__func__, p_priv->baud);
2003			p_priv->baud = 9600;
2004			d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2005				&msg.baudHi, &msg.baudLo, &prescaler, 0);
2006		}
2007		msg.setRxMode = 1;
2008		msg.setTxMode = 1;
2009	}
2010
2011	/* modes must always be correctly specified */
2012	if (p_priv->baud > 57600) {
2013		msg.rxMode = RXMODE_DMA;
2014		msg.txMode = TXMODE_DMA;
2015	} else {
2016		msg.rxMode = RXMODE_BYHAND;
2017		msg.txMode = TXMODE_BYHAND;
2018	}
2019
2020	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2021	switch (p_priv->cflag & CSIZE) {
2022	case CS5:
2023		msg.lcr |= USA_DATABITS_5;
2024		break;
2025	case CS6:
2026		msg.lcr |= USA_DATABITS_6;
2027		break;
2028	case CS7:
2029		msg.lcr |= USA_DATABITS_7;
2030		break;
2031	case CS8:
2032		msg.lcr |= USA_DATABITS_8;
2033		break;
2034	}
2035	if (p_priv->cflag & PARENB) {
2036		/* note USA_PARITY_NONE == 0 */
2037		msg.lcr |= (p_priv->cflag & PARODD) ?
2038			USA_PARITY_ODD : USA_PARITY_EVEN;
2039	}
2040	if (p_priv->old_cflag != p_priv->cflag) {
2041		p_priv->old_cflag = p_priv->cflag;
2042		msg.setLcr = 0x01;
2043	}
2044
2045	if (p_priv->flow_control == flow_cts)
2046		msg.txFlowControl = TXFLOW_CTS;
2047	msg.setTxFlowControl = 0x01;
2048	msg.setRxFlowControl = 0x01;
2049
2050	msg.rxForwardingLength = 16;
2051	msg.rxForwardingTimeout = 16;
2052	msg.txAckSetting = 0;
2053	msg.xonChar = 17;
2054	msg.xoffChar = 19;
2055
2056	/* Opening port */
2057	if (reset_port == 1) {
2058		msg.portEnabled = 1;
2059		msg.rxFlush = 1;
2060		msg.txBreak = (p_priv->break_on);
2061	}
2062	/* Closing port */
2063	else if (reset_port == 2)
2064		msg.portEnabled = 0;
2065	/* Sending intermediate configs */
2066	else {
2067		msg.portEnabled = 1;
2068		msg.txBreak = (p_priv->break_on);
2069	}
2070
2071	/* Do handshaking outputs */
2072	msg.setRts = 0x01;
2073	msg.rts = p_priv->rts_state;
2074
2075	msg.setDtr = 0x01;
2076	msg.dtr = p_priv->dtr_state;
2077
2078	p_priv->resend_cont = 0;
2079	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2080
2081	/* send the data out the device on control endpoint */
2082	this_urb->transfer_buffer_length = sizeof(msg);
2083
2084	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2085	if (err != 0)
2086		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2087	return 0;
2088}
2089
2090static int keyspan_usa67_send_setup(struct usb_serial *serial,
2091				    struct usb_serial_port *port,
2092				    int reset_port)
2093{
2094	struct keyspan_usa67_portControlMessage	msg;
2095	struct keyspan_serial_private 		*s_priv;
2096	struct keyspan_port_private 		*p_priv;
2097	const struct keyspan_device_details	*d_details;
2098	struct urb				*this_urb;
2099	int 					err, device_port;
2100
2101	s_priv = usb_get_serial_data(serial);
2102	p_priv = usb_get_serial_port_data(port);
2103	d_details = s_priv->device_details;
2104
2105	this_urb = s_priv->glocont_urb;
2106
2107	/* Work out which port within the device is being setup */
2108	device_port = port->port_number;
2109
2110	/* Make sure we have an urb then send the message */
2111	if (this_urb == NULL) {
2112		dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2113		return -1;
2114	}
2115
2116	/* Save reset port val for resend.
2117	   Don't overwrite resend for open/close condition. */
2118	if ((reset_port + 1) > p_priv->resend_cont)
2119		p_priv->resend_cont = reset_port + 1;
2120	if (this_urb->status == -EINPROGRESS) {
2121		/*  dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2122		mdelay(5);
2123		return -1;
2124	}
2125
2126	memset(&msg, 0, sizeof(struct keyspan_usa67_portControlMessage));
2127
2128	msg.port = device_port;
2129
2130	/* Only set baud rate if it's changed */
2131	if (p_priv->old_baud != p_priv->baud) {
2132		p_priv->old_baud = p_priv->baud;
2133		msg.setClocking = 0xff;
2134		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2135						   &msg.baudHi, &msg.baudLo, &msg.prescaler,
2136						   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2137			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2138				__func__, p_priv->baud);
2139			msg.baudLo = 0;
2140			msg.baudHi = 125;	/* Values for 9600 baud */
2141			msg.prescaler = 10;
2142		}
2143		msg.setPrescaler = 0xff;
2144	}
2145
2146	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2147	switch (p_priv->cflag & CSIZE) {
2148	case CS5:
2149		msg.lcr |= USA_DATABITS_5;
2150		break;
2151	case CS6:
2152		msg.lcr |= USA_DATABITS_6;
2153		break;
2154	case CS7:
2155		msg.lcr |= USA_DATABITS_7;
2156		break;
2157	case CS8:
2158		msg.lcr |= USA_DATABITS_8;
2159		break;
2160	}
2161	if (p_priv->cflag & PARENB) {
2162		/* note USA_PARITY_NONE == 0 */
2163		msg.lcr |= (p_priv->cflag & PARODD) ?
2164					USA_PARITY_ODD : USA_PARITY_EVEN;
2165	}
2166	msg.setLcr = 0xff;
2167
2168	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2169	msg.xonFlowControl = 0;
2170	msg.setFlowControl = 0xff;
2171	msg.forwardingLength = 16;
2172	msg.xonChar = 17;
2173	msg.xoffChar = 19;
2174
2175	if (reset_port == 1) {
2176		/* Opening port */
2177		msg._txOn = 1;
2178		msg._txOff = 0;
2179		msg.txFlush = 0;
2180		msg.txBreak = 0;
2181		msg.rxOn = 1;
2182		msg.rxOff = 0;
2183		msg.rxFlush = 1;
2184		msg.rxForward = 0;
2185		msg.returnStatus = 0;
2186		msg.resetDataToggle = 0xff;
2187	} else if (reset_port == 2) {
2188		/* Closing port */
2189		msg._txOn = 0;
2190		msg._txOff = 1;
2191		msg.txFlush = 0;
2192		msg.txBreak = 0;
2193		msg.rxOn = 0;
2194		msg.rxOff = 1;
2195		msg.rxFlush = 1;
2196		msg.rxForward = 0;
2197		msg.returnStatus = 0;
2198		msg.resetDataToggle = 0;
2199	} else {
2200		/* Sending intermediate configs */
2201		msg._txOn = (!p_priv->break_on);
2202		msg._txOff = 0;
2203		msg.txFlush = 0;
2204		msg.txBreak = (p_priv->break_on);
2205		msg.rxOn = 0;
2206		msg.rxOff = 0;
2207		msg.rxFlush = 0;
2208		msg.rxForward = 0;
2209		msg.returnStatus = 0;
2210		msg.resetDataToggle = 0x0;
2211	}
2212
2213	/* Do handshaking outputs */
2214	msg.setTxTriState_setRts = 0xff;
2215	msg.txTriState_rts = p_priv->rts_state;
2216
2217	msg.setHskoa_setDtr = 0xff;
2218	msg.hskoa_dtr = p_priv->dtr_state;
2219
2220	p_priv->resend_cont = 0;
2221
2222	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2223
2224	/* send the data out the device on control endpoint */
2225	this_urb->transfer_buffer_length = sizeof(msg);
2226
2227	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2228	if (err != 0)
2229		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2230	return 0;
2231}
2232
2233static void keyspan_send_setup(struct usb_serial_port *port, int reset_port)
2234{
2235	struct usb_serial *serial = port->serial;
2236	struct keyspan_serial_private *s_priv;
2237	const struct keyspan_device_details *d_details;
2238
2239	s_priv = usb_get_serial_data(serial);
2240	d_details = s_priv->device_details;
2241
2242	switch (d_details->msg_format) {
2243	case msg_usa26:
2244		keyspan_usa26_send_setup(serial, port, reset_port);
2245		break;
2246	case msg_usa28:
2247		keyspan_usa28_send_setup(serial, port, reset_port);
2248		break;
2249	case msg_usa49:
2250		keyspan_usa49_send_setup(serial, port, reset_port);
2251		break;
2252	case msg_usa90:
2253		keyspan_usa90_send_setup(serial, port, reset_port);
2254		break;
2255	case msg_usa67:
2256		keyspan_usa67_send_setup(serial, port, reset_port);
2257		break;
2258	}
2259}
2260
2261
2262/* Gets called by the "real" driver (ie once firmware is loaded
2263   and renumeration has taken place. */
2264static int keyspan_startup(struct usb_serial *serial)
2265{
2266	int				i, err;
2267	struct keyspan_serial_private 	*s_priv;
2268	const struct keyspan_device_details	*d_details;
2269
2270	for (i = 0; (d_details = keyspan_devices[i]) != NULL; ++i)
2271		if (d_details->product_id ==
2272				le16_to_cpu(serial->dev->descriptor.idProduct))
2273			break;
2274	if (d_details == NULL) {
2275		dev_err(&serial->dev->dev, "%s - unknown product id %x\n",
2276		    __func__, le16_to_cpu(serial->dev->descriptor.idProduct));
2277		return -ENODEV;
2278	}
2279
2280	/* Setup private data for serial driver */
2281	s_priv = kzalloc(sizeof(struct keyspan_serial_private), GFP_KERNEL);
2282	if (!s_priv)
2283		return -ENOMEM;
2284
2285	s_priv->instat_buf = kzalloc(INSTAT_BUFLEN, GFP_KERNEL);
2286	if (!s_priv->instat_buf)
2287		goto err_instat_buf;
2288
2289	s_priv->indat_buf = kzalloc(INDAT49W_BUFLEN, GFP_KERNEL);
2290	if (!s_priv->indat_buf)
2291		goto err_indat_buf;
2292
2293	s_priv->glocont_buf = kzalloc(GLOCONT_BUFLEN, GFP_KERNEL);
2294	if (!s_priv->glocont_buf)
2295		goto err_glocont_buf;
2296
2297	s_priv->ctrl_buf = kzalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
2298	if (!s_priv->ctrl_buf)
2299		goto err_ctrl_buf;
2300
2301	s_priv->device_details = d_details;
2302	usb_set_serial_data(serial, s_priv);
2303
2304	keyspan_setup_urbs(serial);
2305
2306	if (s_priv->instat_urb != NULL) {
2307		err = usb_submit_urb(s_priv->instat_urb, GFP_KERNEL);
2308		if (err != 0)
2309			dev_dbg(&serial->dev->dev, "%s - submit instat urb failed %d\n", __func__, err);
2310	}
2311	if (s_priv->indat_urb != NULL) {
2312		err = usb_submit_urb(s_priv->indat_urb, GFP_KERNEL);
2313		if (err != 0)
2314			dev_dbg(&serial->dev->dev, "%s - submit indat urb failed %d\n", __func__, err);
2315	}
2316
2317	return 0;
2318
2319err_ctrl_buf:
2320	kfree(s_priv->glocont_buf);
2321err_glocont_buf:
2322	kfree(s_priv->indat_buf);
2323err_indat_buf:
2324	kfree(s_priv->instat_buf);
2325err_instat_buf:
2326	kfree(s_priv);
2327
2328	return -ENOMEM;
2329}
2330
2331static void keyspan_disconnect(struct usb_serial *serial)
2332{
2333	struct keyspan_serial_private *s_priv;
2334
2335	s_priv = usb_get_serial_data(serial);
2336
2337	stop_urb(s_priv->instat_urb);
2338	stop_urb(s_priv->glocont_urb);
2339	stop_urb(s_priv->indat_urb);
2340}
2341
2342static void keyspan_release(struct usb_serial *serial)
2343{
2344	struct keyspan_serial_private *s_priv;
2345
2346	s_priv = usb_get_serial_data(serial);
2347
 
 
 
 
2348	usb_free_urb(s_priv->instat_urb);
2349	usb_free_urb(s_priv->indat_urb);
2350	usb_free_urb(s_priv->glocont_urb);
2351
2352	kfree(s_priv->ctrl_buf);
2353	kfree(s_priv->glocont_buf);
2354	kfree(s_priv->indat_buf);
2355	kfree(s_priv->instat_buf);
2356
2357	kfree(s_priv);
2358}
2359
2360static int keyspan_port_probe(struct usb_serial_port *port)
2361{
2362	struct usb_serial *serial = port->serial;
2363	struct keyspan_serial_private *s_priv;
2364	struct keyspan_port_private *p_priv;
2365	const struct keyspan_device_details *d_details;
2366	struct callbacks *cback;
2367	int endp;
2368	int port_num;
2369	int i;
2370
2371	s_priv = usb_get_serial_data(serial);
2372	d_details = s_priv->device_details;
2373
2374	p_priv = kzalloc(sizeof(*p_priv), GFP_KERNEL);
2375	if (!p_priv)
2376		return -ENOMEM;
2377
2378	for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i) {
2379		p_priv->in_buffer[i] = kzalloc(IN_BUFLEN, GFP_KERNEL);
2380		if (!p_priv->in_buffer[i])
2381			goto err_in_buffer;
2382	}
2383
2384	for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i) {
2385		p_priv->out_buffer[i] = kzalloc(OUT_BUFLEN, GFP_KERNEL);
2386		if (!p_priv->out_buffer[i])
2387			goto err_out_buffer;
2388	}
2389
2390	p_priv->inack_buffer = kzalloc(INACK_BUFLEN, GFP_KERNEL);
2391	if (!p_priv->inack_buffer)
2392		goto err_inack_buffer;
2393
2394	p_priv->outcont_buffer = kzalloc(OUTCONT_BUFLEN, GFP_KERNEL);
2395	if (!p_priv->outcont_buffer)
2396		goto err_outcont_buffer;
2397
2398	p_priv->device_details = d_details;
2399
2400	/* Setup values for the various callback routines */
2401	cback = &keyspan_callbacks[d_details->msg_format];
2402
2403	port_num = port->port_number;
2404
2405	/* Do indat endpoints first, once for each flip */
2406	endp = d_details->indat_endpoints[port_num];
2407	for (i = 0; i <= d_details->indat_endp_flip; ++i, ++endp) {
2408		p_priv->in_urbs[i] = keyspan_setup_urb(serial, endp,
2409						USB_DIR_IN, port,
2410						p_priv->in_buffer[i],
2411						IN_BUFLEN,
2412						cback->indat_callback);
2413	}
2414	/* outdat endpoints also have flip */
2415	endp = d_details->outdat_endpoints[port_num];
2416	for (i = 0; i <= d_details->outdat_endp_flip; ++i, ++endp) {
2417		p_priv->out_urbs[i] = keyspan_setup_urb(serial, endp,
2418						USB_DIR_OUT, port,
2419						p_priv->out_buffer[i],
2420						OUT_BUFLEN,
2421						cback->outdat_callback);
2422	}
2423	/* inack endpoint */
2424	p_priv->inack_urb = keyspan_setup_urb(serial,
2425					d_details->inack_endpoints[port_num],
2426					USB_DIR_IN, port,
2427					p_priv->inack_buffer,
2428					INACK_BUFLEN,
2429					cback->inack_callback);
2430	/* outcont endpoint */
2431	p_priv->outcont_urb = keyspan_setup_urb(serial,
2432					d_details->outcont_endpoints[port_num],
2433					USB_DIR_OUT, port,
2434					p_priv->outcont_buffer,
2435					OUTCONT_BUFLEN,
2436					 cback->outcont_callback);
2437
2438	usb_set_serial_port_data(port, p_priv);
2439
2440	return 0;
2441
2442err_outcont_buffer:
2443	kfree(p_priv->inack_buffer);
2444err_inack_buffer:
2445	for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
2446		kfree(p_priv->out_buffer[i]);
2447err_out_buffer:
2448	for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
2449		kfree(p_priv->in_buffer[i]);
2450err_in_buffer:
2451	kfree(p_priv);
2452
2453	return -ENOMEM;
2454}
2455
2456static int keyspan_port_remove(struct usb_serial_port *port)
2457{
2458	struct keyspan_port_private *p_priv;
2459	int i;
2460
2461	p_priv = usb_get_serial_port_data(port);
2462
2463	stop_urb(p_priv->inack_urb);
2464	stop_urb(p_priv->outcont_urb);
2465	for (i = 0; i < 2; i++) {
2466		stop_urb(p_priv->in_urbs[i]);
2467		stop_urb(p_priv->out_urbs[i]);
2468	}
2469
2470	usb_free_urb(p_priv->inack_urb);
2471	usb_free_urb(p_priv->outcont_urb);
2472	for (i = 0; i < 2; i++) {
2473		usb_free_urb(p_priv->in_urbs[i]);
2474		usb_free_urb(p_priv->out_urbs[i]);
2475	}
2476
2477	kfree(p_priv->outcont_buffer);
2478	kfree(p_priv->inack_buffer);
2479	for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
2480		kfree(p_priv->out_buffer[i]);
2481	for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
2482		kfree(p_priv->in_buffer[i]);
2483
2484	kfree(p_priv);
2485
2486	return 0;
2487}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2488
2489MODULE_AUTHOR(DRIVER_AUTHOR);
2490MODULE_DESCRIPTION(DRIVER_DESC);
2491MODULE_LICENSE("GPL");
2492
2493MODULE_FIRMWARE("keyspan/usa28.fw");
2494MODULE_FIRMWARE("keyspan/usa28x.fw");
2495MODULE_FIRMWARE("keyspan/usa28xa.fw");
2496MODULE_FIRMWARE("keyspan/usa28xb.fw");
2497MODULE_FIRMWARE("keyspan/usa19.fw");
2498MODULE_FIRMWARE("keyspan/usa19qi.fw");
2499MODULE_FIRMWARE("keyspan/mpr.fw");
2500MODULE_FIRMWARE("keyspan/usa19qw.fw");
2501MODULE_FIRMWARE("keyspan/usa18x.fw");
2502MODULE_FIRMWARE("keyspan/usa19w.fw");
2503MODULE_FIRMWARE("keyspan/usa49w.fw");
2504MODULE_FIRMWARE("keyspan/usa49wlc.fw");
v4.17
   1// SPDX-License-Identifier: GPL-2.0+
   2/*
   3  Keyspan USB to Serial Converter driver
   4
   5  (C) Copyright (C) 2000-2001	Hugh Blemings <hugh@blemings.org>
   6  (C) Copyright (C) 2002	Greg Kroah-Hartman <greg@kroah.com>
   7
 
 
 
 
 
   8  See http://blemings.org/hugh/keyspan.html for more information.
   9
  10  Code in this driver inspired by and in a number of places taken
  11  from Brian Warner's original Keyspan-PDA driver.
  12
  13  This driver has been put together with the support of Innosys, Inc.
  14  and Keyspan, Inc the manufacturers of the Keyspan USB-serial products.
  15  Thanks Guys :)
  16
  17  Thanks to Paulus for miscellaneous tidy ups, some largish chunks
  18  of much nicer and/or completely new code and (perhaps most uniquely)
  19  having the patience to sit down and explain why and where he'd changed
  20  stuff.
  21
  22  Tip 'o the hat to IBM (and previously Linuxcare :) for supporting
  23  staff in their work on open source projects.
  24*/
  25
  26
  27#include <linux/kernel.h>
  28#include <linux/jiffies.h>
  29#include <linux/errno.h>
  30#include <linux/slab.h>
  31#include <linux/tty.h>
  32#include <linux/tty_driver.h>
  33#include <linux/tty_flip.h>
  34#include <linux/module.h>
  35#include <linux/spinlock.h>
  36#include <linux/uaccess.h>
  37#include <linux/usb.h>
  38#include <linux/usb/serial.h>
  39#include <linux/usb/ezusb.h>
 
  40
  41#define DRIVER_AUTHOR "Hugh Blemings <hugh@misc.nu"
  42#define DRIVER_DESC "Keyspan USB to Serial Converter Driver"
  43
  44/* Function prototypes for Keyspan serial converter */
  45static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port);
  46static void keyspan_close(struct usb_serial_port *port);
  47static void keyspan_dtr_rts(struct usb_serial_port *port, int on);
  48static int keyspan_startup(struct usb_serial *serial);
  49static void keyspan_disconnect(struct usb_serial *serial);
  50static void keyspan_release(struct usb_serial *serial);
  51static int keyspan_port_probe(struct usb_serial_port *port);
  52static int keyspan_port_remove(struct usb_serial_port *port);
  53static int keyspan_write_room(struct tty_struct *tty);
  54static int keyspan_write(struct tty_struct *tty, struct usb_serial_port *port,
  55			 const unsigned char *buf, int count);
  56static void keyspan_send_setup(struct usb_serial_port *port, int reset_port);
  57static void keyspan_set_termios(struct tty_struct *tty,
  58				struct usb_serial_port *port,
  59				struct ktermios *old);
  60static void keyspan_break_ctl(struct tty_struct *tty, int break_state);
  61static int keyspan_tiocmget(struct tty_struct *tty);
  62static int keyspan_tiocmset(struct tty_struct *tty, unsigned int set,
  63			    unsigned int clear);
  64static int keyspan_fake_startup(struct usb_serial *serial);
  65
  66static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
  67				   u32 baud_rate, u32 baudclk,
  68				   u8 *rate_hi, u8 *rate_low,
  69				   u8 *prescaler, int portnum);
  70static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
  71				    u32 baud_rate, u32 baudclk,
  72				    u8 *rate_hi, u8 *rate_low,
  73				    u8 *prescaler, int portnum);
  74static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
  75				   u32 baud_rate, u32 baudclk,
  76				   u8 *rate_hi, u8 *rate_low,
  77				   u8 *prescaler, int portnum);
  78static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
  79				     u32 baud_rate, u32 baudclk,
  80				     u8 *rate_hi, u8 *rate_low,
  81				     u8 *prescaler, int portnum);
  82
  83static int keyspan_usa28_send_setup(struct usb_serial *serial,
  84				    struct usb_serial_port *port,
  85				    int reset_port);
  86static int keyspan_usa26_send_setup(struct usb_serial *serial,
  87				    struct usb_serial_port *port,
  88				    int reset_port);
  89static int keyspan_usa49_send_setup(struct usb_serial *serial,
  90				    struct usb_serial_port *port,
  91				    int reset_port);
  92static int keyspan_usa90_send_setup(struct usb_serial *serial,
  93				    struct usb_serial_port *port,
  94				    int reset_port);
  95static int keyspan_usa67_send_setup(struct usb_serial *serial,
  96				    struct usb_serial_port *port,
  97				    int reset_port);
  98
  99/* Values used for baud rate calculation - device specific */
 100#define KEYSPAN_INVALID_BAUD_RATE		(-1)
 101#define KEYSPAN_BAUD_RATE_OK			(0)
 102#define KEYSPAN_USA18X_BAUDCLK			(12000000L)	/* a guess */
 103#define KEYSPAN_USA19_BAUDCLK			(12000000L)
 104#define KEYSPAN_USA19W_BAUDCLK			(24000000L)
 105#define KEYSPAN_USA19HS_BAUDCLK			(14769231L)
 106#define KEYSPAN_USA28_BAUDCLK			(1843200L)
 107#define KEYSPAN_USA28X_BAUDCLK			(12000000L)
 108#define KEYSPAN_USA49W_BAUDCLK			(48000000L)
 109
 110/* Some constants used to characterise each device.  */
 111#define KEYSPAN_MAX_NUM_PORTS			(4)
 112#define KEYSPAN_MAX_FLIPS			(2)
 113
 114/*
 115 * Device info for the Keyspan serial converter, used by the overall
 116 * usb-serial probe function.
 117 */
 118#define KEYSPAN_VENDOR_ID			(0x06cd)
 119
 120/* Product IDs for the products supported, pre-renumeration */
 121#define keyspan_usa18x_pre_product_id		0x0105
 122#define keyspan_usa19_pre_product_id		0x0103
 123#define keyspan_usa19qi_pre_product_id		0x010b
 124#define keyspan_mpr_pre_product_id		0x011b
 125#define keyspan_usa19qw_pre_product_id		0x0118
 126#define keyspan_usa19w_pre_product_id		0x0106
 127#define keyspan_usa28_pre_product_id		0x0101
 128#define keyspan_usa28x_pre_product_id		0x0102
 129#define keyspan_usa28xa_pre_product_id		0x0114
 130#define keyspan_usa28xb_pre_product_id		0x0113
 131#define keyspan_usa49w_pre_product_id		0x0109
 132#define keyspan_usa49wlc_pre_product_id		0x011a
 133
 134/*
 135 * Product IDs post-renumeration.  Note that the 28x and 28xb have the same
 136 * id's post-renumeration but behave identically so it's not an issue. As
 137 * such, the 28xb is not listed in any of the device tables.
 138 */
 139#define keyspan_usa18x_product_id		0x0112
 140#define keyspan_usa19_product_id		0x0107
 141#define keyspan_usa19qi_product_id		0x010c
 142#define keyspan_usa19hs_product_id		0x0121
 143#define keyspan_mpr_product_id			0x011c
 144#define keyspan_usa19qw_product_id		0x0119
 145#define keyspan_usa19w_product_id		0x0108
 146#define keyspan_usa28_product_id		0x010f
 147#define keyspan_usa28x_product_id		0x0110
 148#define keyspan_usa28xa_product_id		0x0115
 149#define keyspan_usa28xb_product_id		0x0110
 150#define keyspan_usa28xg_product_id		0x0135
 151#define keyspan_usa49w_product_id		0x010a
 152#define keyspan_usa49wlc_product_id		0x012a
 153#define keyspan_usa49wg_product_id		0x0131
 154
 155struct keyspan_device_details {
 156	/* product ID value */
 157	int	product_id;
 158
 159	enum	{msg_usa26, msg_usa28, msg_usa49, msg_usa90, msg_usa67} msg_format;
 160
 161		/* Number of physical ports */
 162	int	num_ports;
 163
 164		/* 1 if endpoint flipping used on input, 0 if not */
 165	int	indat_endp_flip;
 166
 167		/* 1 if endpoint flipping used on output, 0 if not */
 168	int	outdat_endp_flip;
 169
 170		/*
 171		 * Table mapping input data endpoint IDs to physical port
 172		 * number and flip if used
 173		 */
 174	int	indat_endpoints[KEYSPAN_MAX_NUM_PORTS];
 175
 176		/* Same for output endpoints */
 177	int	outdat_endpoints[KEYSPAN_MAX_NUM_PORTS];
 178
 179		/* Input acknowledge endpoints */
 180	int	inack_endpoints[KEYSPAN_MAX_NUM_PORTS];
 181
 182		/* Output control endpoints */
 183	int	outcont_endpoints[KEYSPAN_MAX_NUM_PORTS];
 184
 185		/* Endpoint used for input status */
 186	int	instat_endpoint;
 187
 188		/* Endpoint used for input data 49WG only */
 189	int	indat_endpoint;
 190
 191		/* Endpoint used for global control functions */
 192	int	glocont_endpoint;
 193
 194	int	(*calculate_baud_rate)(struct usb_serial_port *port,
 195				       u32 baud_rate, u32 baudclk,
 196				       u8 *rate_hi, u8 *rate_low, u8 *prescaler,
 197				       int portnum);
 198	u32	baudclk;
 199};
 200
 201/*
 202 * Now for each device type we setup the device detail structure with the
 203 * appropriate information (provided in Keyspan's documentation)
 204 */
 205
 206static const struct keyspan_device_details usa18x_device_details = {
 207	.product_id		= keyspan_usa18x_product_id,
 208	.msg_format		= msg_usa26,
 209	.num_ports		= 1,
 210	.indat_endp_flip	= 0,
 211	.outdat_endp_flip	= 1,
 212	.indat_endpoints	= {0x81},
 213	.outdat_endpoints	= {0x01},
 214	.inack_endpoints	= {0x85},
 215	.outcont_endpoints	= {0x05},
 216	.instat_endpoint	= 0x87,
 217	.indat_endpoint		= -1,
 218	.glocont_endpoint	= 0x07,
 219	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 220	.baudclk		= KEYSPAN_USA18X_BAUDCLK,
 221};
 222
 223static const struct keyspan_device_details usa19_device_details = {
 224	.product_id		= keyspan_usa19_product_id,
 225	.msg_format		= msg_usa28,
 226	.num_ports		= 1,
 227	.indat_endp_flip	= 1,
 228	.outdat_endp_flip	= 1,
 229	.indat_endpoints	= {0x81},
 230	.outdat_endpoints	= {0x01},
 231	.inack_endpoints	= {0x83},
 232	.outcont_endpoints	= {0x03},
 233	.instat_endpoint	= 0x84,
 234	.indat_endpoint		= -1,
 235	.glocont_endpoint	= -1,
 236	.calculate_baud_rate	= keyspan_usa19_calc_baud,
 237	.baudclk		= KEYSPAN_USA19_BAUDCLK,
 238};
 239
 240static const struct keyspan_device_details usa19qi_device_details = {
 241	.product_id		= keyspan_usa19qi_product_id,
 242	.msg_format		= msg_usa28,
 243	.num_ports		= 1,
 244	.indat_endp_flip	= 1,
 245	.outdat_endp_flip	= 1,
 246	.indat_endpoints	= {0x81},
 247	.outdat_endpoints	= {0x01},
 248	.inack_endpoints	= {0x83},
 249	.outcont_endpoints	= {0x03},
 250	.instat_endpoint	= 0x84,
 251	.indat_endpoint		= -1,
 252	.glocont_endpoint	= -1,
 253	.calculate_baud_rate	= keyspan_usa28_calc_baud,
 254	.baudclk		= KEYSPAN_USA19_BAUDCLK,
 255};
 256
 257static const struct keyspan_device_details mpr_device_details = {
 258	.product_id		= keyspan_mpr_product_id,
 259	.msg_format		= msg_usa28,
 260	.num_ports		= 1,
 261	.indat_endp_flip	= 1,
 262	.outdat_endp_flip	= 1,
 263	.indat_endpoints	= {0x81},
 264	.outdat_endpoints	= {0x01},
 265	.inack_endpoints	= {0x83},
 266	.outcont_endpoints	= {0x03},
 267	.instat_endpoint	= 0x84,
 268	.indat_endpoint		= -1,
 269	.glocont_endpoint	= -1,
 270	.calculate_baud_rate	= keyspan_usa28_calc_baud,
 271	.baudclk		= KEYSPAN_USA19_BAUDCLK,
 272};
 273
 274static const struct keyspan_device_details usa19qw_device_details = {
 275	.product_id		= keyspan_usa19qw_product_id,
 276	.msg_format		= msg_usa26,
 277	.num_ports		= 1,
 278	.indat_endp_flip	= 0,
 279	.outdat_endp_flip	= 1,
 280	.indat_endpoints	= {0x81},
 281	.outdat_endpoints	= {0x01},
 282	.inack_endpoints	= {0x85},
 283	.outcont_endpoints	= {0x05},
 284	.instat_endpoint	= 0x87,
 285	.indat_endpoint		= -1,
 286	.glocont_endpoint	= 0x07,
 287	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 288	.baudclk		= KEYSPAN_USA19W_BAUDCLK,
 289};
 290
 291static const struct keyspan_device_details usa19w_device_details = {
 292	.product_id		= keyspan_usa19w_product_id,
 293	.msg_format		= msg_usa26,
 294	.num_ports		= 1,
 295	.indat_endp_flip	= 0,
 296	.outdat_endp_flip	= 1,
 297	.indat_endpoints	= {0x81},
 298	.outdat_endpoints	= {0x01},
 299	.inack_endpoints	= {0x85},
 300	.outcont_endpoints	= {0x05},
 301	.instat_endpoint	= 0x87,
 302	.indat_endpoint		= -1,
 303	.glocont_endpoint	= 0x07,
 304	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 305	.baudclk		= KEYSPAN_USA19W_BAUDCLK,
 306};
 307
 308static const struct keyspan_device_details usa19hs_device_details = {
 309	.product_id		= keyspan_usa19hs_product_id,
 310	.msg_format		= msg_usa90,
 311	.num_ports		= 1,
 312	.indat_endp_flip	= 0,
 313	.outdat_endp_flip	= 0,
 314	.indat_endpoints	= {0x81},
 315	.outdat_endpoints	= {0x01},
 316	.inack_endpoints	= {-1},
 317	.outcont_endpoints	= {0x02},
 318	.instat_endpoint	= 0x82,
 319	.indat_endpoint		= -1,
 320	.glocont_endpoint	= -1,
 321	.calculate_baud_rate	= keyspan_usa19hs_calc_baud,
 322	.baudclk		= KEYSPAN_USA19HS_BAUDCLK,
 323};
 324
 325static const struct keyspan_device_details usa28_device_details = {
 326	.product_id		= keyspan_usa28_product_id,
 327	.msg_format		= msg_usa28,
 328	.num_ports		= 2,
 329	.indat_endp_flip	= 1,
 330	.outdat_endp_flip	= 1,
 331	.indat_endpoints	= {0x81, 0x83},
 332	.outdat_endpoints	= {0x01, 0x03},
 333	.inack_endpoints	= {0x85, 0x86},
 334	.outcont_endpoints	= {0x05, 0x06},
 335	.instat_endpoint	= 0x87,
 336	.indat_endpoint		= -1,
 337	.glocont_endpoint	= 0x07,
 338	.calculate_baud_rate	= keyspan_usa28_calc_baud,
 339	.baudclk		= KEYSPAN_USA28_BAUDCLK,
 340};
 341
 342static const struct keyspan_device_details usa28x_device_details = {
 343	.product_id		= keyspan_usa28x_product_id,
 344	.msg_format		= msg_usa26,
 345	.num_ports		= 2,
 346	.indat_endp_flip	= 0,
 347	.outdat_endp_flip	= 1,
 348	.indat_endpoints	= {0x81, 0x83},
 349	.outdat_endpoints	= {0x01, 0x03},
 350	.inack_endpoints	= {0x85, 0x86},
 351	.outcont_endpoints	= {0x05, 0x06},
 352	.instat_endpoint	= 0x87,
 353	.indat_endpoint		= -1,
 354	.glocont_endpoint	= 0x07,
 355	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 356	.baudclk		= KEYSPAN_USA28X_BAUDCLK,
 357};
 358
 359static const struct keyspan_device_details usa28xa_device_details = {
 360	.product_id		= keyspan_usa28xa_product_id,
 361	.msg_format		= msg_usa26,
 362	.num_ports		= 2,
 363	.indat_endp_flip	= 0,
 364	.outdat_endp_flip	= 1,
 365	.indat_endpoints	= {0x81, 0x83},
 366	.outdat_endpoints	= {0x01, 0x03},
 367	.inack_endpoints	= {0x85, 0x86},
 368	.outcont_endpoints	= {0x05, 0x06},
 369	.instat_endpoint	= 0x87,
 370	.indat_endpoint		= -1,
 371	.glocont_endpoint	= 0x07,
 372	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 373	.baudclk		= KEYSPAN_USA28X_BAUDCLK,
 374};
 375
 376static const struct keyspan_device_details usa28xg_device_details = {
 377	.product_id		= keyspan_usa28xg_product_id,
 378	.msg_format		= msg_usa67,
 379	.num_ports		= 2,
 380	.indat_endp_flip	= 0,
 381	.outdat_endp_flip	= 0,
 382	.indat_endpoints	= {0x84, 0x88},
 383	.outdat_endpoints	= {0x02, 0x06},
 384	.inack_endpoints	= {-1, -1},
 385	.outcont_endpoints	= {-1, -1},
 386	.instat_endpoint	= 0x81,
 387	.indat_endpoint		= -1,
 388	.glocont_endpoint	= 0x01,
 389	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 390	.baudclk		= KEYSPAN_USA28X_BAUDCLK,
 391};
 392/*
 393 * We don't need a separate entry for the usa28xb as it appears as a 28x
 394 * anyway.
 395 */
 396
 397static const struct keyspan_device_details usa49w_device_details = {
 398	.product_id		= keyspan_usa49w_product_id,
 399	.msg_format		= msg_usa49,
 400	.num_ports		= 4,
 401	.indat_endp_flip	= 0,
 402	.outdat_endp_flip	= 0,
 403	.indat_endpoints	= {0x81, 0x82, 0x83, 0x84},
 404	.outdat_endpoints	= {0x01, 0x02, 0x03, 0x04},
 405	.inack_endpoints	= {-1, -1, -1, -1},
 406	.outcont_endpoints	= {-1, -1, -1, -1},
 407	.instat_endpoint	= 0x87,
 408	.indat_endpoint		= -1,
 409	.glocont_endpoint	= 0x07,
 410	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 411	.baudclk		= KEYSPAN_USA49W_BAUDCLK,
 412};
 413
 414static const struct keyspan_device_details usa49wlc_device_details = {
 415	.product_id		= keyspan_usa49wlc_product_id,
 416	.msg_format		= msg_usa49,
 417	.num_ports		= 4,
 418	.indat_endp_flip	= 0,
 419	.outdat_endp_flip	= 0,
 420	.indat_endpoints	= {0x81, 0x82, 0x83, 0x84},
 421	.outdat_endpoints	= {0x01, 0x02, 0x03, 0x04},
 422	.inack_endpoints	= {-1, -1, -1, -1},
 423	.outcont_endpoints	= {-1, -1, -1, -1},
 424	.instat_endpoint	= 0x87,
 425	.indat_endpoint		= -1,
 426	.glocont_endpoint	= 0x07,
 427	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 428	.baudclk		= KEYSPAN_USA19W_BAUDCLK,
 429};
 430
 431static const struct keyspan_device_details usa49wg_device_details = {
 432	.product_id		= keyspan_usa49wg_product_id,
 433	.msg_format		= msg_usa49,
 434	.num_ports		= 4,
 435	.indat_endp_flip	= 0,
 436	.outdat_endp_flip	= 0,
 437	.indat_endpoints	= {-1, -1, -1, -1},	/* single 'global' data in EP */
 438	.outdat_endpoints	= {0x01, 0x02, 0x04, 0x06},
 439	.inack_endpoints	= {-1, -1, -1, -1},
 440	.outcont_endpoints	= {-1, -1, -1, -1},
 441	.instat_endpoint	= 0x81,
 442	.indat_endpoint		= 0x88,
 443	.glocont_endpoint	= 0x00,			/* uses control EP */
 444	.calculate_baud_rate	= keyspan_usa19w_calc_baud,
 445	.baudclk		= KEYSPAN_USA19W_BAUDCLK,
 446};
 447
 448static const struct keyspan_device_details *keyspan_devices[] = {
 449	&usa18x_device_details,
 450	&usa19_device_details,
 451	&usa19qi_device_details,
 452	&mpr_device_details,
 453	&usa19qw_device_details,
 454	&usa19w_device_details,
 455	&usa19hs_device_details,
 456	&usa28_device_details,
 457	&usa28x_device_details,
 458	&usa28xa_device_details,
 459	&usa28xg_device_details,
 460	/* 28xb not required as it renumerates as a 28x */
 461	&usa49w_device_details,
 462	&usa49wlc_device_details,
 463	&usa49wg_device_details,
 464	NULL,
 465};
 466
 467static const struct usb_device_id keyspan_ids_combined[] = {
 468	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_pre_product_id) },
 469	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_pre_product_id) },
 470	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_pre_product_id) },
 471	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_pre_product_id) },
 472	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_pre_product_id) },
 473	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_pre_product_id) },
 474	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_pre_product_id) },
 475	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_pre_product_id) },
 476	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_pre_product_id) },
 477	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xb_pre_product_id) },
 478	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_pre_product_id) },
 479	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_pre_product_id) },
 480	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_product_id) },
 481	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_product_id) },
 482	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_product_id) },
 483	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_product_id) },
 484	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_product_id) },
 485	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19hs_product_id) },
 486	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_product_id) },
 487	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_product_id) },
 488	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_product_id) },
 489	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_product_id) },
 490	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xg_product_id) },
 491	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_product_id)},
 492	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_product_id)},
 493	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wg_product_id)},
 494	{ } /* Terminating entry */
 495};
 496
 497MODULE_DEVICE_TABLE(usb, keyspan_ids_combined);
 498
 499/* usb_device_id table for the pre-firmware download keyspan devices */
 500static const struct usb_device_id keyspan_pre_ids[] = {
 501	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_pre_product_id) },
 502	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_pre_product_id) },
 503	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_pre_product_id) },
 504	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_pre_product_id) },
 505	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_pre_product_id) },
 506	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_pre_product_id) },
 507	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_pre_product_id) },
 508	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_pre_product_id) },
 509	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_pre_product_id) },
 510	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xb_pre_product_id) },
 511	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_pre_product_id) },
 512	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_pre_product_id) },
 513	{ } /* Terminating entry */
 514};
 515
 516static const struct usb_device_id keyspan_1port_ids[] = {
 517	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_product_id) },
 518	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_product_id) },
 519	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_product_id) },
 520	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_product_id) },
 521	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_product_id) },
 522	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19hs_product_id) },
 523	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_product_id) },
 524	{ } /* Terminating entry */
 525};
 526
 527static const struct usb_device_id keyspan_2port_ids[] = {
 528	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_product_id) },
 529	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_product_id) },
 530	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_product_id) },
 531	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xg_product_id) },
 532	{ } /* Terminating entry */
 533};
 534
 535static const struct usb_device_id keyspan_4port_ids[] = {
 536	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_product_id) },
 537	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_product_id)},
 538	{ USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wg_product_id)},
 539	{ } /* Terminating entry */
 540};
 541
 542#define INSTAT_BUFLEN	32
 543#define GLOCONT_BUFLEN	64
 544#define INDAT49W_BUFLEN	512
 545#define IN_BUFLEN	64
 546#define OUT_BUFLEN	64
 547#define INACK_BUFLEN	1
 548#define OUTCONT_BUFLEN	64
 549
 550	/* Per device and per port private data */
 551struct keyspan_serial_private {
 552	const struct keyspan_device_details	*device_details;
 553
 554	struct urb	*instat_urb;
 555	char		*instat_buf;
 556
 557	/* added to support 49wg, where data from all 4 ports comes in
 558	   on 1 EP and high-speed supported */
 559	struct urb	*indat_urb;
 560	char		*indat_buf;
 561
 562	/* XXX this one probably will need a lock */
 563	struct urb	*glocont_urb;
 564	char		*glocont_buf;
 565	char		*ctrl_buf;	/* for EP0 control message */
 566};
 567
 568struct keyspan_port_private {
 569	/* Keep track of which input & output endpoints to use */
 570	int		in_flip;
 571	int		out_flip;
 572
 573	/* Keep duplicate of device details in each port
 574	   structure as well - simplifies some of the
 575	   callback functions etc. */
 576	const struct keyspan_device_details	*device_details;
 577
 578	/* Input endpoints and buffer for this port */
 579	struct urb	*in_urbs[2];
 580	char		*in_buffer[2];
 581	/* Output endpoints and buffer for this port */
 582	struct urb	*out_urbs[2];
 583	char		*out_buffer[2];
 584
 585	/* Input ack endpoint */
 586	struct urb	*inack_urb;
 587	char		*inack_buffer;
 588
 589	/* Output control endpoint */
 590	struct urb	*outcont_urb;
 591	char		*outcont_buffer;
 592
 593	/* Settings for the port */
 594	int		baud;
 595	int		old_baud;
 596	unsigned int	cflag;
 597	unsigned int	old_cflag;
 598	enum		{flow_none, flow_cts, flow_xon} flow_control;
 599	int		rts_state;	/* Handshaking pins (outputs) */
 600	int		dtr_state;
 601	int		cts_state;	/* Handshaking pins (inputs) */
 602	int		dsr_state;
 603	int		dcd_state;
 604	int		ri_state;
 605	int		break_on;
 606
 607	unsigned long	tx_start_time[2];
 608	int		resend_cont;	/* need to resend control packet */
 609};
 610
 611/* Include Keyspan message headers.  All current Keyspan Adapters
 612   make use of one of five message formats which are referred
 613   to as USA-26, USA-28, USA-49, USA-90, USA-67 by Keyspan and
 614   within this driver. */
 615#include "keyspan_usa26msg.h"
 616#include "keyspan_usa28msg.h"
 617#include "keyspan_usa49msg.h"
 618#include "keyspan_usa90msg.h"
 619#include "keyspan_usa67msg.h"
 620
 621
 
 
 622static void keyspan_break_ctl(struct tty_struct *tty, int break_state)
 623{
 624	struct usb_serial_port *port = tty->driver_data;
 625	struct keyspan_port_private 	*p_priv;
 626
 627	p_priv = usb_get_serial_port_data(port);
 628
 629	if (break_state == -1)
 630		p_priv->break_on = 1;
 631	else
 632		p_priv->break_on = 0;
 633
 634	keyspan_send_setup(port, 0);
 635}
 636
 637
 638static void keyspan_set_termios(struct tty_struct *tty,
 639		struct usb_serial_port *port, struct ktermios *old_termios)
 640{
 641	int				baud_rate, device_port;
 642	struct keyspan_port_private 	*p_priv;
 643	const struct keyspan_device_details	*d_details;
 644	unsigned int 			cflag;
 645
 646	p_priv = usb_get_serial_port_data(port);
 647	d_details = p_priv->device_details;
 648	cflag = tty->termios.c_cflag;
 649	device_port = port->port_number;
 650
 651	/* Baud rate calculation takes baud rate as an integer
 652	   so other rates can be generated if desired. */
 653	baud_rate = tty_get_baud_rate(tty);
 654	/* If no match or invalid, don't change */
 655	if (d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
 656				NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
 657		/* FIXME - more to do here to ensure rate changes cleanly */
 658		/* FIXME - calculate exact rate from divisor ? */
 659		p_priv->baud = baud_rate;
 660	} else
 661		baud_rate = tty_termios_baud_rate(old_termios);
 662
 663	tty_encode_baud_rate(tty, baud_rate, baud_rate);
 664	/* set CTS/RTS handshake etc. */
 665	p_priv->cflag = cflag;
 666	p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
 667
 668	/* Mark/Space not supported */
 669	tty->termios.c_cflag &= ~CMSPAR;
 670
 671	keyspan_send_setup(port, 0);
 672}
 673
 674static int keyspan_tiocmget(struct tty_struct *tty)
 675{
 676	struct usb_serial_port *port = tty->driver_data;
 677	struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
 678	unsigned int			value;
 679
 680	value = ((p_priv->rts_state) ? TIOCM_RTS : 0) |
 681		((p_priv->dtr_state) ? TIOCM_DTR : 0) |
 682		((p_priv->cts_state) ? TIOCM_CTS : 0) |
 683		((p_priv->dsr_state) ? TIOCM_DSR : 0) |
 684		((p_priv->dcd_state) ? TIOCM_CAR : 0) |
 685		((p_priv->ri_state) ? TIOCM_RNG : 0);
 686
 687	return value;
 688}
 689
 690static int keyspan_tiocmset(struct tty_struct *tty,
 691			    unsigned int set, unsigned int clear)
 692{
 693	struct usb_serial_port *port = tty->driver_data;
 694	struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
 695
 696	if (set & TIOCM_RTS)
 697		p_priv->rts_state = 1;
 698	if (set & TIOCM_DTR)
 699		p_priv->dtr_state = 1;
 700	if (clear & TIOCM_RTS)
 701		p_priv->rts_state = 0;
 702	if (clear & TIOCM_DTR)
 703		p_priv->dtr_state = 0;
 704	keyspan_send_setup(port, 0);
 705	return 0;
 706}
 707
 708/* Write function is similar for the four protocols used
 709   with only a minor change for usa90 (usa19hs) required */
 710static int keyspan_write(struct tty_struct *tty,
 711	struct usb_serial_port *port, const unsigned char *buf, int count)
 712{
 713	struct keyspan_port_private 	*p_priv;
 714	const struct keyspan_device_details	*d_details;
 715	int				flip;
 716	int 				left, todo;
 717	struct urb			*this_urb;
 718	int 				err, maxDataLen, dataOffset;
 719
 720	p_priv = usb_get_serial_port_data(port);
 721	d_details = p_priv->device_details;
 722
 723	if (d_details->msg_format == msg_usa90) {
 724		maxDataLen = 64;
 725		dataOffset = 0;
 726	} else {
 727		maxDataLen = 63;
 728		dataOffset = 1;
 729	}
 730
 731	dev_dbg(&port->dev, "%s - %d chars, flip=%d\n", __func__, count,
 732		p_priv->out_flip);
 733
 734	for (left = count; left > 0; left -= todo) {
 735		todo = left;
 736		if (todo > maxDataLen)
 737			todo = maxDataLen;
 738
 739		flip = p_priv->out_flip;
 740
 741		/* Check we have a valid urb/endpoint before we use it... */
 742		this_urb = p_priv->out_urbs[flip];
 743		if (this_urb == NULL) {
 744			/* no bulk out, so return 0 bytes written */
 745			dev_dbg(&port->dev, "%s - no output urb :(\n", __func__);
 746			return count;
 747		}
 748
 749		dev_dbg(&port->dev, "%s - endpoint %x flip %d\n",
 750			__func__, usb_pipeendpoint(this_urb->pipe), flip);
 751
 752		if (this_urb->status == -EINPROGRESS) {
 753			if (time_before(jiffies,
 754					p_priv->tx_start_time[flip] + 10 * HZ))
 755				break;
 756			usb_unlink_urb(this_urb);
 757			break;
 758		}
 759
 760		/* First byte in buffer is "last flag" (except for usa19hx)
 761		   - unused so for now so set to zero */
 762		((char *)this_urb->transfer_buffer)[0] = 0;
 763
 764		memcpy(this_urb->transfer_buffer + dataOffset, buf, todo);
 765		buf += todo;
 766
 767		/* send the data out the bulk port */
 768		this_urb->transfer_buffer_length = todo + dataOffset;
 769
 770		err = usb_submit_urb(this_urb, GFP_ATOMIC);
 771		if (err != 0)
 772			dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed (%d)\n", err);
 773		p_priv->tx_start_time[flip] = jiffies;
 774
 775		/* Flip for next time if usa26 or usa28 interface
 776		   (not used on usa49) */
 777		p_priv->out_flip = (flip + 1) & d_details->outdat_endp_flip;
 778	}
 779
 780	return count - left;
 781}
 782
 783static void	usa26_indat_callback(struct urb *urb)
 784{
 785	int			i, err;
 786	int			endpoint;
 787	struct usb_serial_port	*port;
 788	unsigned char 		*data = urb->transfer_buffer;
 789	int status = urb->status;
 790
 791	endpoint = usb_pipeendpoint(urb->pipe);
 792
 793	if (status) {
 794		dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
 795			__func__, status, endpoint);
 796		return;
 797	}
 798
 799	port =  urb->context;
 800	if (urb->actual_length) {
 801		/* 0x80 bit is error flag */
 802		if ((data[0] & 0x80) == 0) {
 803			/* no errors on individual bytes, only
 804			   possible overrun err */
 805			if (data[0] & RXERROR_OVERRUN) {
 806				tty_insert_flip_char(&port->port, 0,
 807								TTY_OVERRUN);
 808			}
 809			for (i = 1; i < urb->actual_length ; ++i)
 810				tty_insert_flip_char(&port->port, data[i],
 811								TTY_NORMAL);
 812		} else {
 813			/* some bytes had errors, every byte has status */
 814			dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
 815			for (i = 0; i + 1 < urb->actual_length; i += 2) {
 816				int stat = data[i];
 817				int flag = TTY_NORMAL;
 818
 819				if (stat & RXERROR_OVERRUN) {
 820					tty_insert_flip_char(&port->port, 0,
 821								TTY_OVERRUN);
 822				}
 823				/* XXX should handle break (0x10) */
 824				if (stat & RXERROR_PARITY)
 825					flag = TTY_PARITY;
 826				else if (stat & RXERROR_FRAMING)
 827					flag = TTY_FRAME;
 828
 829				tty_insert_flip_char(&port->port, data[i+1],
 830						flag);
 831			}
 832		}
 833		tty_flip_buffer_push(&port->port);
 834	}
 835
 836	/* Resubmit urb so we continue receiving */
 837	err = usb_submit_urb(urb, GFP_ATOMIC);
 838	if (err != 0)
 839		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 840}
 841
 842/* Outdat handling is common for all devices */
 843static void	usa2x_outdat_callback(struct urb *urb)
 844{
 845	struct usb_serial_port *port;
 846	struct keyspan_port_private *p_priv;
 847
 848	port =  urb->context;
 849	p_priv = usb_get_serial_port_data(port);
 850	dev_dbg(&port->dev, "%s - urb %d\n", __func__, urb == p_priv->out_urbs[1]);
 851
 852	usb_serial_port_softint(port);
 853}
 854
 855static void	usa26_inack_callback(struct urb *urb)
 856{
 857}
 858
 859static void	usa26_outcont_callback(struct urb *urb)
 860{
 861	struct usb_serial_port *port;
 862	struct keyspan_port_private *p_priv;
 863
 864	port =  urb->context;
 865	p_priv = usb_get_serial_port_data(port);
 866
 867	if (p_priv->resend_cont) {
 868		dev_dbg(&port->dev, "%s - sending setup\n", __func__);
 869		keyspan_usa26_send_setup(port->serial, port,
 870						p_priv->resend_cont - 1);
 871	}
 872}
 873
 874static void	usa26_instat_callback(struct urb *urb)
 875{
 876	unsigned char 				*data = urb->transfer_buffer;
 877	struct keyspan_usa26_portStatusMessage	*msg;
 878	struct usb_serial			*serial;
 879	struct usb_serial_port			*port;
 880	struct keyspan_port_private	 	*p_priv;
 881	int old_dcd_state, err;
 882	int status = urb->status;
 883
 884	serial =  urb->context;
 885
 886	if (status) {
 887		dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
 888				__func__, status);
 889		return;
 890	}
 891	if (urb->actual_length != 9) {
 892		dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
 893		goto exit;
 894	}
 895
 896	msg = (struct keyspan_usa26_portStatusMessage *)data;
 897
 898	/* Check port number from message and retrieve private data */
 899	if (msg->port >= serial->num_ports) {
 900		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
 901		goto exit;
 902	}
 903	port = serial->port[msg->port];
 904	p_priv = usb_get_serial_port_data(port);
 905	if (!p_priv)
 906		goto resubmit;
 907
 908	/* Update handshaking pin state information */
 909	old_dcd_state = p_priv->dcd_state;
 910	p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
 911	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
 912	p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
 913	p_priv->ri_state = ((msg->ri) ? 1 : 0);
 914
 915	if (old_dcd_state != p_priv->dcd_state)
 916		tty_port_tty_hangup(&port->port, true);
 917resubmit:
 918	/* Resubmit urb so we continue receiving */
 919	err = usb_submit_urb(urb, GFP_ATOMIC);
 920	if (err != 0)
 921		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
 922exit: ;
 923}
 924
 925static void	usa26_glocont_callback(struct urb *urb)
 926{
 927}
 928
 929
 930static void usa28_indat_callback(struct urb *urb)
 931{
 932	int                     err;
 933	struct usb_serial_port  *port;
 934	unsigned char           *data;
 935	struct keyspan_port_private             *p_priv;
 936	int status = urb->status;
 937
 938	port =  urb->context;
 939	p_priv = usb_get_serial_port_data(port);
 940	data = urb->transfer_buffer;
 941
 942	if (urb != p_priv->in_urbs[p_priv->in_flip])
 943		return;
 944
 945	do {
 946		if (status) {
 947			dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
 948				__func__, status, usb_pipeendpoint(urb->pipe));
 949			return;
 950		}
 951
 952		port =  urb->context;
 953		p_priv = usb_get_serial_port_data(port);
 954		data = urb->transfer_buffer;
 955
 956		if (urb->actual_length) {
 957			tty_insert_flip_string(&port->port, data,
 958					urb->actual_length);
 959			tty_flip_buffer_push(&port->port);
 960		}
 961
 962		/* Resubmit urb so we continue receiving */
 963		err = usb_submit_urb(urb, GFP_ATOMIC);
 964		if (err != 0)
 965			dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n",
 966							__func__, err);
 967		p_priv->in_flip ^= 1;
 968
 969		urb = p_priv->in_urbs[p_priv->in_flip];
 970	} while (urb->status != -EINPROGRESS);
 971}
 972
 973static void	usa28_inack_callback(struct urb *urb)
 974{
 975}
 976
 977static void	usa28_outcont_callback(struct urb *urb)
 978{
 979	struct usb_serial_port *port;
 980	struct keyspan_port_private *p_priv;
 981
 982	port =  urb->context;
 983	p_priv = usb_get_serial_port_data(port);
 984
 985	if (p_priv->resend_cont) {
 986		dev_dbg(&port->dev, "%s - sending setup\n", __func__);
 987		keyspan_usa28_send_setup(port->serial, port,
 988						p_priv->resend_cont - 1);
 989	}
 990}
 991
 992static void	usa28_instat_callback(struct urb *urb)
 993{
 994	int					err;
 995	unsigned char 				*data = urb->transfer_buffer;
 996	struct keyspan_usa28_portStatusMessage	*msg;
 997	struct usb_serial			*serial;
 998	struct usb_serial_port			*port;
 999	struct keyspan_port_private	 	*p_priv;
1000	int old_dcd_state;
1001	int status = urb->status;
1002
1003	serial =  urb->context;
1004
1005	if (status) {
1006		dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1007				__func__, status);
1008		return;
1009	}
1010
1011	if (urb->actual_length != sizeof(struct keyspan_usa28_portStatusMessage)) {
1012		dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1013		goto exit;
1014	}
1015
1016	msg = (struct keyspan_usa28_portStatusMessage *)data;
1017
1018	/* Check port number from message and retrieve private data */
1019	if (msg->port >= serial->num_ports) {
1020		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
1021		goto exit;
1022	}
1023	port = serial->port[msg->port];
1024	p_priv = usb_get_serial_port_data(port);
1025	if (!p_priv)
1026		goto resubmit;
1027
1028	/* Update handshaking pin state information */
1029	old_dcd_state = p_priv->dcd_state;
1030	p_priv->cts_state = ((msg->cts) ? 1 : 0);
1031	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1032	p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1033	p_priv->ri_state = ((msg->ri) ? 1 : 0);
1034
1035	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1036		tty_port_tty_hangup(&port->port, true);
1037resubmit:
1038		/* Resubmit urb so we continue receiving */
1039	err = usb_submit_urb(urb, GFP_ATOMIC);
1040	if (err != 0)
1041		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1042exit: ;
1043}
1044
1045static void	usa28_glocont_callback(struct urb *urb)
1046{
1047}
1048
1049
1050static void	usa49_glocont_callback(struct urb *urb)
1051{
1052	struct usb_serial *serial;
1053	struct usb_serial_port *port;
1054	struct keyspan_port_private *p_priv;
1055	int i;
1056
1057	serial =  urb->context;
1058	for (i = 0; i < serial->num_ports; ++i) {
1059		port = serial->port[i];
1060		p_priv = usb_get_serial_port_data(port);
1061
1062		if (p_priv->resend_cont) {
1063			dev_dbg(&port->dev, "%s - sending setup\n", __func__);
1064			keyspan_usa49_send_setup(serial, port,
1065						p_priv->resend_cont - 1);
1066			break;
1067		}
1068	}
1069}
1070
1071	/* This is actually called glostat in the Keyspan
1072	   doco */
1073static void	usa49_instat_callback(struct urb *urb)
1074{
1075	int					err;
1076	unsigned char 				*data = urb->transfer_buffer;
1077	struct keyspan_usa49_portStatusMessage	*msg;
1078	struct usb_serial			*serial;
1079	struct usb_serial_port			*port;
1080	struct keyspan_port_private	 	*p_priv;
1081	int old_dcd_state;
1082	int status = urb->status;
1083
1084	serial =  urb->context;
1085
1086	if (status) {
1087		dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1088				__func__, status);
1089		return;
1090	}
1091
1092	if (urb->actual_length !=
1093			sizeof(struct keyspan_usa49_portStatusMessage)) {
1094		dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1095		goto exit;
1096	}
1097
1098	msg = (struct keyspan_usa49_portStatusMessage *)data;
1099
1100	/* Check port number from message and retrieve private data */
1101	if (msg->portNumber >= serial->num_ports) {
1102		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
1103			__func__, msg->portNumber);
1104		goto exit;
1105	}
1106	port = serial->port[msg->portNumber];
1107	p_priv = usb_get_serial_port_data(port);
1108	if (!p_priv)
1109		goto resubmit;
1110
1111	/* Update handshaking pin state information */
1112	old_dcd_state = p_priv->dcd_state;
1113	p_priv->cts_state = ((msg->cts) ? 1 : 0);
1114	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1115	p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1116	p_priv->ri_state = ((msg->ri) ? 1 : 0);
1117
1118	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1119		tty_port_tty_hangup(&port->port, true);
1120resubmit:
1121	/* Resubmit urb so we continue receiving */
1122	err = usb_submit_urb(urb, GFP_ATOMIC);
1123	if (err != 0)
1124		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1125exit:	;
1126}
1127
1128static void	usa49_inack_callback(struct urb *urb)
1129{
1130}
1131
1132static void	usa49_indat_callback(struct urb *urb)
1133{
1134	int			i, err;
1135	int			endpoint;
1136	struct usb_serial_port	*port;
1137	unsigned char 		*data = urb->transfer_buffer;
1138	int status = urb->status;
1139
1140	endpoint = usb_pipeendpoint(urb->pipe);
1141
1142	if (status) {
1143		dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
1144			__func__, status, endpoint);
1145		return;
1146	}
1147
1148	port =  urb->context;
1149	if (urb->actual_length) {
1150		/* 0x80 bit is error flag */
1151		if ((data[0] & 0x80) == 0) {
1152			/* no error on any byte */
1153			tty_insert_flip_string(&port->port, data + 1,
1154						urb->actual_length - 1);
1155		} else {
1156			/* some bytes had errors, every byte has status */
1157			for (i = 0; i + 1 < urb->actual_length; i += 2) {
1158				int stat = data[i];
1159				int flag = TTY_NORMAL;
1160
1161				if (stat & RXERROR_OVERRUN) {
1162					tty_insert_flip_char(&port->port, 0,
1163								TTY_OVERRUN);
1164				}
1165				/* XXX should handle break (0x10) */
1166				if (stat & RXERROR_PARITY)
1167					flag = TTY_PARITY;
1168				else if (stat & RXERROR_FRAMING)
1169					flag = TTY_FRAME;
1170
1171				tty_insert_flip_char(&port->port, data[i+1],
1172						flag);
1173			}
1174		}
1175		tty_flip_buffer_push(&port->port);
1176	}
1177
1178	/* Resubmit urb so we continue receiving */
1179	err = usb_submit_urb(urb, GFP_ATOMIC);
1180	if (err != 0)
1181		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1182}
1183
1184static void usa49wg_indat_callback(struct urb *urb)
1185{
1186	int			i, len, x, err;
1187	struct usb_serial	*serial;
1188	struct usb_serial_port	*port;
1189	unsigned char 		*data = urb->transfer_buffer;
1190	int status = urb->status;
1191
1192	serial = urb->context;
1193
1194	if (status) {
1195		dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1196				__func__, status);
1197		return;
1198	}
1199
1200	/* inbound data is in the form P#, len, status, data */
1201	i = 0;
1202	len = 0;
1203
1204	while (i < urb->actual_length) {
1205
1206		/* Check port number from message */
1207		if (data[i] >= serial->num_ports) {
1208			dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
1209				__func__, data[i]);
1210			return;
1211		}
1212		port = serial->port[data[i++]];
1213		len = data[i++];
1214
1215		/* 0x80 bit is error flag */
1216		if ((data[i] & 0x80) == 0) {
1217			/* no error on any byte */
1218			i++;
1219			for (x = 1; x < len && i < urb->actual_length; ++x)
1220				tty_insert_flip_char(&port->port,
1221						data[i++], 0);
1222		} else {
1223			/*
1224			 * some bytes had errors, every byte has status
1225			 */
1226			for (x = 0; x + 1 < len &&
1227				    i + 1 < urb->actual_length; x += 2) {
1228				int stat = data[i];
1229				int flag = TTY_NORMAL;
1230
1231				if (stat & RXERROR_OVERRUN) {
1232					tty_insert_flip_char(&port->port, 0,
1233								TTY_OVERRUN);
1234				}
 
 
1235				/* XXX should handle break (0x10) */
1236				if (stat & RXERROR_PARITY)
1237					flag = TTY_PARITY;
1238				else if (stat & RXERROR_FRAMING)
1239					flag = TTY_FRAME;
1240
1241				tty_insert_flip_char(&port->port, data[i+1],
1242						     flag);
1243				i += 2;
1244			}
1245		}
1246		tty_flip_buffer_push(&port->port);
1247	}
1248
1249	/* Resubmit urb so we continue receiving */
1250	err = usb_submit_urb(urb, GFP_ATOMIC);
1251	if (err != 0)
1252		dev_dbg(&urb->dev->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1253}
1254
1255/* not used, usa-49 doesn't have per-port control endpoints */
1256static void usa49_outcont_callback(struct urb *urb)
1257{
1258}
1259
1260static void usa90_indat_callback(struct urb *urb)
1261{
1262	int			i, err;
1263	int			endpoint;
1264	struct usb_serial_port	*port;
1265	struct keyspan_port_private	 	*p_priv;
1266	unsigned char 		*data = urb->transfer_buffer;
1267	int status = urb->status;
1268
1269	endpoint = usb_pipeendpoint(urb->pipe);
1270
1271	if (status) {
1272		dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
1273			__func__, status, endpoint);
1274		return;
1275	}
1276
1277	port =  urb->context;
1278	p_priv = usb_get_serial_port_data(port);
1279
1280	if (urb->actual_length) {
1281		/* if current mode is DMA, looks like usa28 format
1282		   otherwise looks like usa26 data format */
1283
1284		if (p_priv->baud > 57600)
1285			tty_insert_flip_string(&port->port, data,
1286					urb->actual_length);
1287		else {
1288			/* 0x80 bit is error flag */
1289			if ((data[0] & 0x80) == 0) {
1290				/* no errors on individual bytes, only
1291				   possible overrun err*/
1292				if (data[0] & RXERROR_OVERRUN) {
1293					tty_insert_flip_char(&port->port, 0,
1294								TTY_OVERRUN);
1295				}
1296				for (i = 1; i < urb->actual_length ; ++i)
1297					tty_insert_flip_char(&port->port,
1298							data[i], TTY_NORMAL);
1299			}  else {
1300			/* some bytes had errors, every byte has status */
1301				dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
1302				for (i = 0; i + 1 < urb->actual_length; i += 2) {
1303					int stat = data[i];
1304					int flag = TTY_NORMAL;
1305
1306					if (stat & RXERROR_OVERRUN) {
1307						tty_insert_flip_char(
1308								&port->port, 0,
1309								TTY_OVERRUN);
1310					}
1311					/* XXX should handle break (0x10) */
1312					if (stat & RXERROR_PARITY)
1313						flag = TTY_PARITY;
1314					else if (stat & RXERROR_FRAMING)
1315						flag = TTY_FRAME;
1316
1317					tty_insert_flip_char(&port->port,
1318							data[i+1], flag);
1319				}
1320			}
1321		}
1322		tty_flip_buffer_push(&port->port);
1323	}
1324
1325	/* Resubmit urb so we continue receiving */
1326	err = usb_submit_urb(urb, GFP_ATOMIC);
1327	if (err != 0)
1328		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1329}
1330
1331
1332static void	usa90_instat_callback(struct urb *urb)
1333{
1334	unsigned char 				*data = urb->transfer_buffer;
1335	struct keyspan_usa90_portStatusMessage	*msg;
1336	struct usb_serial			*serial;
1337	struct usb_serial_port			*port;
1338	struct keyspan_port_private	 	*p_priv;
1339	int old_dcd_state, err;
1340	int status = urb->status;
1341
1342	serial =  urb->context;
1343
1344	if (status) {
1345		dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1346				__func__, status);
1347		return;
1348	}
1349	if (urb->actual_length < 14) {
1350		dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
1351		goto exit;
1352	}
1353
1354	msg = (struct keyspan_usa90_portStatusMessage *)data;
1355
1356	/* Now do something useful with the data */
1357
1358	port = serial->port[0];
1359	p_priv = usb_get_serial_port_data(port);
1360	if (!p_priv)
1361		goto resubmit;
1362
1363	/* Update handshaking pin state information */
1364	old_dcd_state = p_priv->dcd_state;
1365	p_priv->cts_state = ((msg->cts) ? 1 : 0);
1366	p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1367	p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1368	p_priv->ri_state = ((msg->ri) ? 1 : 0);
1369
1370	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1371		tty_port_tty_hangup(&port->port, true);
1372resubmit:
1373	/* Resubmit urb so we continue receiving */
1374	err = usb_submit_urb(urb, GFP_ATOMIC);
1375	if (err != 0)
1376		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1377exit:
1378	;
1379}
1380
1381static void	usa90_outcont_callback(struct urb *urb)
1382{
1383	struct usb_serial_port *port;
1384	struct keyspan_port_private *p_priv;
1385
1386	port =  urb->context;
1387	p_priv = usb_get_serial_port_data(port);
1388
1389	if (p_priv->resend_cont) {
1390		dev_dbg(&urb->dev->dev, "%s - sending setup\n", __func__);
1391		keyspan_usa90_send_setup(port->serial, port,
1392						p_priv->resend_cont - 1);
1393	}
1394}
1395
1396/* Status messages from the 28xg */
1397static void	usa67_instat_callback(struct urb *urb)
1398{
1399	int					err;
1400	unsigned char 				*data = urb->transfer_buffer;
1401	struct keyspan_usa67_portStatusMessage	*msg;
1402	struct usb_serial			*serial;
1403	struct usb_serial_port			*port;
1404	struct keyspan_port_private	 	*p_priv;
1405	int old_dcd_state;
1406	int status = urb->status;
1407
1408	serial = urb->context;
1409
1410	if (status) {
1411		dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1412				__func__, status);
1413		return;
1414	}
1415
1416	if (urb->actual_length !=
1417			sizeof(struct keyspan_usa67_portStatusMessage)) {
1418		dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1419		return;
1420	}
1421
1422
1423	/* Now do something useful with the data */
1424	msg = (struct keyspan_usa67_portStatusMessage *)data;
1425
1426	/* Check port number from message and retrieve private data */
1427	if (msg->port >= serial->num_ports) {
1428		dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
1429		return;
1430	}
1431
1432	port = serial->port[msg->port];
1433	p_priv = usb_get_serial_port_data(port);
1434	if (!p_priv)
1435		goto resubmit;
1436
1437	/* Update handshaking pin state information */
1438	old_dcd_state = p_priv->dcd_state;
1439	p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
1440	p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
1441
1442	if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1443		tty_port_tty_hangup(&port->port, true);
1444resubmit:
1445	/* Resubmit urb so we continue receiving */
1446	err = usb_submit_urb(urb, GFP_ATOMIC);
1447	if (err != 0)
1448		dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1449}
1450
1451static void usa67_glocont_callback(struct urb *urb)
1452{
1453	struct usb_serial *serial;
1454	struct usb_serial_port *port;
1455	struct keyspan_port_private *p_priv;
1456	int i;
1457
1458	serial = urb->context;
1459	for (i = 0; i < serial->num_ports; ++i) {
1460		port = serial->port[i];
1461		p_priv = usb_get_serial_port_data(port);
1462
1463		if (p_priv->resend_cont) {
1464			dev_dbg(&port->dev, "%s - sending setup\n", __func__);
1465			keyspan_usa67_send_setup(serial, port,
1466						p_priv->resend_cont - 1);
1467			break;
1468		}
1469	}
1470}
1471
1472static int keyspan_write_room(struct tty_struct *tty)
1473{
1474	struct usb_serial_port *port = tty->driver_data;
1475	struct keyspan_port_private	*p_priv;
1476	const struct keyspan_device_details	*d_details;
1477	int				flip;
1478	int				data_len;
1479	struct urb			*this_urb;
1480
1481	p_priv = usb_get_serial_port_data(port);
1482	d_details = p_priv->device_details;
1483
1484	/* FIXME: locking */
1485	if (d_details->msg_format == msg_usa90)
1486		data_len = 64;
1487	else
1488		data_len = 63;
1489
1490	flip = p_priv->out_flip;
1491
1492	/* Check both endpoints to see if any are available. */
1493	this_urb = p_priv->out_urbs[flip];
1494	if (this_urb != NULL) {
1495		if (this_urb->status != -EINPROGRESS)
1496			return data_len;
1497		flip = (flip + 1) & d_details->outdat_endp_flip;
1498		this_urb = p_priv->out_urbs[flip];
1499		if (this_urb != NULL) {
1500			if (this_urb->status != -EINPROGRESS)
1501				return data_len;
1502		}
1503	}
1504	return 0;
1505}
1506
1507
1508static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port)
1509{
1510	struct keyspan_port_private 	*p_priv;
1511	const struct keyspan_device_details	*d_details;
1512	int				i, err;
1513	int				baud_rate, device_port;
1514	struct urb			*urb;
1515	unsigned int			cflag = 0;
1516
1517	p_priv = usb_get_serial_port_data(port);
1518	d_details = p_priv->device_details;
1519
1520	/* Set some sane defaults */
1521	p_priv->rts_state = 1;
1522	p_priv->dtr_state = 1;
1523	p_priv->baud = 9600;
1524
1525	/* force baud and lcr to be set on open */
1526	p_priv->old_baud = 0;
1527	p_priv->old_cflag = 0;
1528
1529	p_priv->out_flip = 0;
1530	p_priv->in_flip = 0;
1531
1532	/* Reset low level data toggle and start reading from endpoints */
1533	for (i = 0; i < 2; i++) {
1534		urb = p_priv->in_urbs[i];
1535		if (urb == NULL)
1536			continue;
1537
1538		/* make sure endpoint data toggle is synchronized
1539		   with the device */
1540		usb_clear_halt(urb->dev, urb->pipe);
1541		err = usb_submit_urb(urb, GFP_KERNEL);
1542		if (err != 0)
1543			dev_dbg(&port->dev, "%s - submit urb %d failed (%d)\n", __func__, i, err);
1544	}
1545
1546	/* Reset low level data toggle on out endpoints */
1547	for (i = 0; i < 2; i++) {
1548		urb = p_priv->out_urbs[i];
1549		if (urb == NULL)
1550			continue;
1551		/* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1552						usb_pipeout(urb->pipe), 0); */
1553	}
1554
1555	/* get the terminal config for the setup message now so we don't
1556	 * need to send 2 of them */
1557
1558	device_port = port->port_number;
1559	if (tty) {
1560		cflag = tty->termios.c_cflag;
1561		/* Baud rate calculation takes baud rate as an integer
1562		   so other rates can be generated if desired. */
1563		baud_rate = tty_get_baud_rate(tty);
1564		/* If no match or invalid, leave as default */
1565		if (baud_rate >= 0
1566		    && d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
1567					NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
1568			p_priv->baud = baud_rate;
1569		}
1570	}
1571	/* set CTS/RTS handshake etc. */
1572	p_priv->cflag = cflag;
1573	p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
1574
1575	keyspan_send_setup(port, 1);
1576	/* mdelay(100); */
1577	/* keyspan_set_termios(port, NULL); */
1578
1579	return 0;
1580}
1581
 
 
 
 
 
 
1582static void keyspan_dtr_rts(struct usb_serial_port *port, int on)
1583{
1584	struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
1585
1586	p_priv->rts_state = on;
1587	p_priv->dtr_state = on;
1588	keyspan_send_setup(port, 0);
1589}
1590
1591static void keyspan_close(struct usb_serial_port *port)
1592{
1593	int			i;
1594	struct keyspan_port_private 	*p_priv;
1595
1596	p_priv = usb_get_serial_port_data(port);
1597
1598	p_priv->rts_state = 0;
1599	p_priv->dtr_state = 0;
1600
1601	keyspan_send_setup(port, 2);
1602	/* pilot-xfer seems to work best with this delay */
1603	mdelay(100);
1604
1605	p_priv->out_flip = 0;
1606	p_priv->in_flip = 0;
1607
1608	usb_kill_urb(p_priv->inack_urb);
1609	for (i = 0; i < 2; i++) {
1610		usb_kill_urb(p_priv->in_urbs[i]);
1611		usb_kill_urb(p_priv->out_urbs[i]);
1612	}
1613}
1614
1615/* download the firmware to a pre-renumeration device */
1616static int keyspan_fake_startup(struct usb_serial *serial)
1617{
1618	char	*fw_name;
1619
1620	dev_dbg(&serial->dev->dev, "Keyspan startup version %04x product %04x\n",
1621		le16_to_cpu(serial->dev->descriptor.bcdDevice),
1622		le16_to_cpu(serial->dev->descriptor.idProduct));
1623
1624	if ((le16_to_cpu(serial->dev->descriptor.bcdDevice) & 0x8000)
1625								!= 0x8000) {
1626		dev_dbg(&serial->dev->dev, "Firmware already loaded.  Quitting.\n");
1627		return 1;
1628	}
1629
1630		/* Select firmware image on the basis of idProduct */
1631	switch (le16_to_cpu(serial->dev->descriptor.idProduct)) {
1632	case keyspan_usa28_pre_product_id:
1633		fw_name = "keyspan/usa28.fw";
1634		break;
1635
1636	case keyspan_usa28x_pre_product_id:
1637		fw_name = "keyspan/usa28x.fw";
1638		break;
1639
1640	case keyspan_usa28xa_pre_product_id:
1641		fw_name = "keyspan/usa28xa.fw";
1642		break;
1643
1644	case keyspan_usa28xb_pre_product_id:
1645		fw_name = "keyspan/usa28xb.fw";
1646		break;
1647
1648	case keyspan_usa19_pre_product_id:
1649		fw_name = "keyspan/usa19.fw";
1650		break;
1651
1652	case keyspan_usa19qi_pre_product_id:
1653		fw_name = "keyspan/usa19qi.fw";
1654		break;
1655
1656	case keyspan_mpr_pre_product_id:
1657		fw_name = "keyspan/mpr.fw";
1658		break;
1659
1660	case keyspan_usa19qw_pre_product_id:
1661		fw_name = "keyspan/usa19qw.fw";
1662		break;
1663
1664	case keyspan_usa18x_pre_product_id:
1665		fw_name = "keyspan/usa18x.fw";
1666		break;
1667
1668	case keyspan_usa19w_pre_product_id:
1669		fw_name = "keyspan/usa19w.fw";
1670		break;
1671
1672	case keyspan_usa49w_pre_product_id:
1673		fw_name = "keyspan/usa49w.fw";
1674		break;
1675
1676	case keyspan_usa49wlc_pre_product_id:
1677		fw_name = "keyspan/usa49wlc.fw";
1678		break;
1679
1680	default:
1681		dev_err(&serial->dev->dev, "Unknown product ID (%04x)\n",
1682			le16_to_cpu(serial->dev->descriptor.idProduct));
1683		return 1;
1684	}
1685
1686	dev_dbg(&serial->dev->dev, "Uploading Keyspan %s firmware.\n", fw_name);
1687
1688	if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
1689		dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
1690			fw_name);
1691		return -ENOENT;
1692	}
1693
1694	/* after downloading firmware Renumeration will occur in a
1695	  moment and the new device will bind to the real driver */
1696
1697	/* we don't want this device to have a driver assigned to it. */
1698	return 1;
1699}
1700
1701/* Helper functions used by keyspan_setup_urbs */
1702static struct usb_endpoint_descriptor const *find_ep(struct usb_serial const *serial,
1703						     int endpoint)
1704{
1705	struct usb_host_interface *iface_desc;
1706	struct usb_endpoint_descriptor *ep;
1707	int i;
1708
1709	iface_desc = serial->interface->cur_altsetting;
1710	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1711		ep = &iface_desc->endpoint[i].desc;
1712		if (ep->bEndpointAddress == endpoint)
1713			return ep;
1714	}
1715	dev_warn(&serial->interface->dev, "found no endpoint descriptor for endpoint %x\n",
1716			endpoint);
1717	return NULL;
1718}
1719
1720static struct urb *keyspan_setup_urb(struct usb_serial *serial, int endpoint,
1721				      int dir, void *ctx, char *buf, int len,
1722				      void (*callback)(struct urb *))
1723{
1724	struct urb *urb;
1725	struct usb_endpoint_descriptor const *ep_desc;
1726	char const *ep_type_name;
1727
1728	if (endpoint == -1)
1729		return NULL;		/* endpoint not needed */
1730
1731	dev_dbg(&serial->interface->dev, "%s - alloc for endpoint %x\n",
1732			__func__, endpoint);
1733	urb = usb_alloc_urb(0, GFP_KERNEL);		/* No ISO */
1734	if (!urb)
1735		return NULL;
1736
1737	if (endpoint == 0) {
1738		/* control EP filled in when used */
1739		return urb;
1740	}
1741
1742	ep_desc = find_ep(serial, endpoint);
1743	if (!ep_desc) {
1744		/* leak the urb, something's wrong and the callers don't care */
1745		return urb;
1746	}
1747	if (usb_endpoint_xfer_int(ep_desc)) {
1748		ep_type_name = "INT";
1749		usb_fill_int_urb(urb, serial->dev,
1750				 usb_sndintpipe(serial->dev, endpoint) | dir,
1751				 buf, len, callback, ctx,
1752				 ep_desc->bInterval);
1753	} else if (usb_endpoint_xfer_bulk(ep_desc)) {
1754		ep_type_name = "BULK";
1755		usb_fill_bulk_urb(urb, serial->dev,
1756				  usb_sndbulkpipe(serial->dev, endpoint) | dir,
1757				  buf, len, callback, ctx);
1758	} else {
1759		dev_warn(&serial->interface->dev,
1760			 "unsupported endpoint type %x\n",
1761			 usb_endpoint_type(ep_desc));
1762		usb_free_urb(urb);
1763		return NULL;
1764	}
1765
1766	dev_dbg(&serial->interface->dev, "%s - using urb %p for %s endpoint %x\n",
1767	    __func__, urb, ep_type_name, endpoint);
1768	return urb;
1769}
1770
1771static struct callbacks {
1772	void	(*instat_callback)(struct urb *);
1773	void	(*glocont_callback)(struct urb *);
1774	void	(*indat_callback)(struct urb *);
1775	void	(*outdat_callback)(struct urb *);
1776	void	(*inack_callback)(struct urb *);
1777	void	(*outcont_callback)(struct urb *);
1778} keyspan_callbacks[] = {
1779	{
1780		/* msg_usa26 callbacks */
1781		.instat_callback =	usa26_instat_callback,
1782		.glocont_callback =	usa26_glocont_callback,
1783		.indat_callback =	usa26_indat_callback,
1784		.outdat_callback =	usa2x_outdat_callback,
1785		.inack_callback =	usa26_inack_callback,
1786		.outcont_callback =	usa26_outcont_callback,
1787	}, {
1788		/* msg_usa28 callbacks */
1789		.instat_callback =	usa28_instat_callback,
1790		.glocont_callback =	usa28_glocont_callback,
1791		.indat_callback =	usa28_indat_callback,
1792		.outdat_callback =	usa2x_outdat_callback,
1793		.inack_callback =	usa28_inack_callback,
1794		.outcont_callback =	usa28_outcont_callback,
1795	}, {
1796		/* msg_usa49 callbacks */
1797		.instat_callback =	usa49_instat_callback,
1798		.glocont_callback =	usa49_glocont_callback,
1799		.indat_callback =	usa49_indat_callback,
1800		.outdat_callback =	usa2x_outdat_callback,
1801		.inack_callback =	usa49_inack_callback,
1802		.outcont_callback =	usa49_outcont_callback,
1803	}, {
1804		/* msg_usa90 callbacks */
1805		.instat_callback =	usa90_instat_callback,
1806		.glocont_callback =	usa28_glocont_callback,
1807		.indat_callback =	usa90_indat_callback,
1808		.outdat_callback =	usa2x_outdat_callback,
1809		.inack_callback =	usa28_inack_callback,
1810		.outcont_callback =	usa90_outcont_callback,
1811	}, {
1812		/* msg_usa67 callbacks */
1813		.instat_callback =	usa67_instat_callback,
1814		.glocont_callback =	usa67_glocont_callback,
1815		.indat_callback =	usa26_indat_callback,
1816		.outdat_callback =	usa2x_outdat_callback,
1817		.inack_callback =	usa26_inack_callback,
1818		.outcont_callback =	usa26_outcont_callback,
1819	}
1820};
1821
1822	/* Generic setup urbs function that uses
1823	   data in device_details */
1824static void keyspan_setup_urbs(struct usb_serial *serial)
1825{
1826	struct keyspan_serial_private 	*s_priv;
1827	const struct keyspan_device_details	*d_details;
1828	struct callbacks		*cback;
1829
1830	s_priv = usb_get_serial_data(serial);
1831	d_details = s_priv->device_details;
1832
1833	/* Setup values for the various callback routines */
1834	cback = &keyspan_callbacks[d_details->msg_format];
1835
1836	/* Allocate and set up urbs for each one that is in use,
1837	   starting with instat endpoints */
1838	s_priv->instat_urb = keyspan_setup_urb
1839		(serial, d_details->instat_endpoint, USB_DIR_IN,
1840		 serial, s_priv->instat_buf, INSTAT_BUFLEN,
1841		 cback->instat_callback);
1842
1843	s_priv->indat_urb = keyspan_setup_urb
1844		(serial, d_details->indat_endpoint, USB_DIR_IN,
1845		 serial, s_priv->indat_buf, INDAT49W_BUFLEN,
1846		 usa49wg_indat_callback);
1847
1848	s_priv->glocont_urb = keyspan_setup_urb
1849		(serial, d_details->glocont_endpoint, USB_DIR_OUT,
1850		 serial, s_priv->glocont_buf, GLOCONT_BUFLEN,
1851		 cback->glocont_callback);
1852}
1853
1854/* usa19 function doesn't require prescaler */
1855static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
1856				   u32 baud_rate, u32 baudclk, u8 *rate_hi,
1857				   u8 *rate_low, u8 *prescaler, int portnum)
1858{
1859	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1860		div,	/* divisor */
1861		cnt;	/* inverse of divisor (programmed into 8051) */
1862
1863	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1864
1865	/* prevent divide by zero...  */
1866	b16 = baud_rate * 16L;
1867	if (b16 == 0)
1868		return KEYSPAN_INVALID_BAUD_RATE;
1869	/* Any "standard" rate over 57k6 is marginal on the USA-19
1870	   as we run out of divisor resolution. */
1871	if (baud_rate > 57600)
1872		return KEYSPAN_INVALID_BAUD_RATE;
1873
1874	/* calculate the divisor and the counter (its inverse) */
1875	div = baudclk / b16;
1876	if (div == 0)
1877		return KEYSPAN_INVALID_BAUD_RATE;
1878	else
1879		cnt = 0 - div;
1880
1881	if (div > 0xffff)
1882		return KEYSPAN_INVALID_BAUD_RATE;
1883
1884	/* return the counter values if non-null */
1885	if (rate_low)
1886		*rate_low = (u8) (cnt & 0xff);
1887	if (rate_hi)
1888		*rate_hi = (u8) ((cnt >> 8) & 0xff);
1889	if (rate_low && rate_hi)
1890		dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1891				__func__, baud_rate, *rate_hi, *rate_low);
1892	return KEYSPAN_BAUD_RATE_OK;
1893}
1894
1895/* usa19hs function doesn't require prescaler */
1896static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
1897				     u32 baud_rate, u32 baudclk, u8 *rate_hi,
1898				     u8 *rate_low, u8 *prescaler, int portnum)
1899{
1900	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1901			div;	/* divisor */
1902
1903	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1904
1905	/* prevent divide by zero...  */
1906	b16 = baud_rate * 16L;
1907	if (b16 == 0)
1908		return KEYSPAN_INVALID_BAUD_RATE;
1909
1910	/* calculate the divisor */
1911	div = baudclk / b16;
1912	if (div == 0)
1913		return KEYSPAN_INVALID_BAUD_RATE;
1914
1915	if (div > 0xffff)
1916		return KEYSPAN_INVALID_BAUD_RATE;
1917
1918	/* return the counter values if non-null */
1919	if (rate_low)
1920		*rate_low = (u8) (div & 0xff);
1921
1922	if (rate_hi)
1923		*rate_hi = (u8) ((div >> 8) & 0xff);
1924
1925	if (rate_low && rate_hi)
1926		dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1927			__func__, baud_rate, *rate_hi, *rate_low);
1928
1929	return KEYSPAN_BAUD_RATE_OK;
1930}
1931
1932static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
1933				    u32 baud_rate, u32 baudclk, u8 *rate_hi,
1934				    u8 *rate_low, u8 *prescaler, int portnum)
1935{
1936	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
1937		clk,	/* clock with 13/8 prescaler */
1938		div,	/* divisor using 13/8 prescaler */
1939		res,	/* resulting baud rate using 13/8 prescaler */
1940		diff,	/* error using 13/8 prescaler */
1941		smallest_diff;
1942	u8	best_prescaler;
1943	int	i;
1944
1945	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1946
1947	/* prevent divide by zero */
1948	b16 = baud_rate * 16L;
1949	if (b16 == 0)
1950		return KEYSPAN_INVALID_BAUD_RATE;
1951
1952	/* Calculate prescaler by trying them all and looking
1953	   for best fit */
1954
1955	/* start with largest possible difference */
1956	smallest_diff = 0xffffffff;
1957
1958		/* 0 is an invalid prescaler, used as a flag */
1959	best_prescaler = 0;
1960
1961	for (i = 8; i <= 0xff; ++i) {
1962		clk = (baudclk * 8) / (u32) i;
1963
1964		div = clk / b16;
1965		if (div == 0)
1966			continue;
1967
1968		res = clk / div;
1969		diff = (res > b16) ? (res-b16) : (b16-res);
1970
1971		if (diff < smallest_diff) {
1972			best_prescaler = i;
1973			smallest_diff = diff;
1974		}
1975	}
1976
1977	if (best_prescaler == 0)
1978		return KEYSPAN_INVALID_BAUD_RATE;
1979
1980	clk = (baudclk * 8) / (u32) best_prescaler;
1981	div = clk / b16;
1982
1983	/* return the divisor and prescaler if non-null */
1984	if (rate_low)
1985		*rate_low = (u8) (div & 0xff);
1986	if (rate_hi)
1987		*rate_hi = (u8) ((div >> 8) & 0xff);
1988	if (prescaler) {
1989		*prescaler = best_prescaler;
1990		/*  dev_dbg(&port->dev, "%s - %d %d\n", __func__, *prescaler, div); */
1991	}
1992	return KEYSPAN_BAUD_RATE_OK;
1993}
1994
1995	/* USA-28 supports different maximum baud rates on each port */
1996static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
1997				   u32 baud_rate, u32 baudclk, u8 *rate_hi,
1998				   u8 *rate_low, u8 *prescaler, int portnum)
1999{
2000	u32 	b16,	/* baud rate times 16 (actual rate used internally) */
2001		div,	/* divisor */
2002		cnt;	/* inverse of divisor (programmed into 8051) */
2003
2004	dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
2005
2006		/* prevent divide by zero */
2007	b16 = baud_rate * 16L;
2008	if (b16 == 0)
2009		return KEYSPAN_INVALID_BAUD_RATE;
2010
2011	/* calculate the divisor and the counter (its inverse) */
2012	div = KEYSPAN_USA28_BAUDCLK / b16;
2013	if (div == 0)
2014		return KEYSPAN_INVALID_BAUD_RATE;
2015	else
2016		cnt = 0 - div;
2017
2018	/* check for out of range, based on portnum,
2019	   and return result */
2020	if (portnum == 0) {
2021		if (div > 0xffff)
2022			return KEYSPAN_INVALID_BAUD_RATE;
2023	} else {
2024		if (portnum == 1) {
2025			if (div > 0xff)
2026				return KEYSPAN_INVALID_BAUD_RATE;
2027		} else
2028			return KEYSPAN_INVALID_BAUD_RATE;
2029	}
2030
2031		/* return the counter values if not NULL
2032		   (port 1 will ignore retHi) */
2033	if (rate_low)
2034		*rate_low = (u8) (cnt & 0xff);
2035	if (rate_hi)
2036		*rate_hi = (u8) ((cnt >> 8) & 0xff);
2037	dev_dbg(&port->dev, "%s - %d OK.\n", __func__, baud_rate);
2038	return KEYSPAN_BAUD_RATE_OK;
2039}
2040
2041static int keyspan_usa26_send_setup(struct usb_serial *serial,
2042				    struct usb_serial_port *port,
2043				    int reset_port)
2044{
2045	struct keyspan_usa26_portControlMessage	msg;
2046	struct keyspan_serial_private 		*s_priv;
2047	struct keyspan_port_private 		*p_priv;
2048	const struct keyspan_device_details	*d_details;
2049	struct urb				*this_urb;
2050	int 					device_port, err;
2051
2052	dev_dbg(&port->dev, "%s reset=%d\n", __func__, reset_port);
2053
2054	s_priv = usb_get_serial_data(serial);
2055	p_priv = usb_get_serial_port_data(port);
2056	d_details = s_priv->device_details;
2057	device_port = port->port_number;
2058
2059	this_urb = p_priv->outcont_urb;
2060
 
 
2061		/* Make sure we have an urb then send the message */
2062	if (this_urb == NULL) {
2063		dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2064		return -1;
2065	}
2066
2067	dev_dbg(&port->dev, "%s - endpoint %x\n",
2068			__func__, usb_pipeendpoint(this_urb->pipe));
2069
2070	/* Save reset port val for resend.
2071	   Don't overwrite resend for open/close condition. */
2072	if ((reset_port + 1) > p_priv->resend_cont)
2073		p_priv->resend_cont = reset_port + 1;
2074	if (this_urb->status == -EINPROGRESS) {
2075		/*  dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2076		mdelay(5);
2077		return -1;
2078	}
2079
2080	memset(&msg, 0, sizeof(struct keyspan_usa26_portControlMessage));
2081
2082	/* Only set baud rate if it's changed */
2083	if (p_priv->old_baud != p_priv->baud) {
2084		p_priv->old_baud = p_priv->baud;
2085		msg.setClocking = 0xff;
2086		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2087						   &msg.baudHi, &msg.baudLo, &msg.prescaler,
2088						   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2089			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2090				__func__, p_priv->baud);
2091			msg.baudLo = 0;
2092			msg.baudHi = 125;	/* Values for 9600 baud */
2093			msg.prescaler = 10;
2094		}
2095		msg.setPrescaler = 0xff;
2096	}
2097
2098	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2099	switch (p_priv->cflag & CSIZE) {
2100	case CS5:
2101		msg.lcr |= USA_DATABITS_5;
2102		break;
2103	case CS6:
2104		msg.lcr |= USA_DATABITS_6;
2105		break;
2106	case CS7:
2107		msg.lcr |= USA_DATABITS_7;
2108		break;
2109	case CS8:
2110		msg.lcr |= USA_DATABITS_8;
2111		break;
2112	}
2113	if (p_priv->cflag & PARENB) {
2114		/* note USA_PARITY_NONE == 0 */
2115		msg.lcr |= (p_priv->cflag & PARODD) ?
2116			USA_PARITY_ODD : USA_PARITY_EVEN;
2117	}
2118	msg.setLcr = 0xff;
2119
2120	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2121	msg.xonFlowControl = 0;
2122	msg.setFlowControl = 0xff;
2123	msg.forwardingLength = 16;
2124	msg.xonChar = 17;
2125	msg.xoffChar = 19;
2126
2127	/* Opening port */
2128	if (reset_port == 1) {
2129		msg._txOn = 1;
2130		msg._txOff = 0;
2131		msg.txFlush = 0;
2132		msg.txBreak = 0;
2133		msg.rxOn = 1;
2134		msg.rxOff = 0;
2135		msg.rxFlush = 1;
2136		msg.rxForward = 0;
2137		msg.returnStatus = 0;
2138		msg.resetDataToggle = 0xff;
2139	}
2140
2141	/* Closing port */
2142	else if (reset_port == 2) {
2143		msg._txOn = 0;
2144		msg._txOff = 1;
2145		msg.txFlush = 0;
2146		msg.txBreak = 0;
2147		msg.rxOn = 0;
2148		msg.rxOff = 1;
2149		msg.rxFlush = 1;
2150		msg.rxForward = 0;
2151		msg.returnStatus = 0;
2152		msg.resetDataToggle = 0;
2153	}
2154
2155	/* Sending intermediate configs */
2156	else {
2157		msg._txOn = (!p_priv->break_on);
2158		msg._txOff = 0;
2159		msg.txFlush = 0;
2160		msg.txBreak = (p_priv->break_on);
2161		msg.rxOn = 0;
2162		msg.rxOff = 0;
2163		msg.rxFlush = 0;
2164		msg.rxForward = 0;
2165		msg.returnStatus = 0;
2166		msg.resetDataToggle = 0x0;
2167	}
2168
2169	/* Do handshaking outputs */
2170	msg.setTxTriState_setRts = 0xff;
2171	msg.txTriState_rts = p_priv->rts_state;
2172
2173	msg.setHskoa_setDtr = 0xff;
2174	msg.hskoa_dtr = p_priv->dtr_state;
2175
2176	p_priv->resend_cont = 0;
2177	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2178
2179	/* send the data out the device on control endpoint */
2180	this_urb->transfer_buffer_length = sizeof(msg);
2181
2182	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2183	if (err != 0)
2184		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2185	return 0;
2186}
2187
2188static int keyspan_usa28_send_setup(struct usb_serial *serial,
2189				    struct usb_serial_port *port,
2190				    int reset_port)
2191{
2192	struct keyspan_usa28_portControlMessage	msg;
2193	struct keyspan_serial_private	 	*s_priv;
2194	struct keyspan_port_private 		*p_priv;
2195	const struct keyspan_device_details	*d_details;
2196	struct urb				*this_urb;
2197	int 					device_port, err;
2198
2199	s_priv = usb_get_serial_data(serial);
2200	p_priv = usb_get_serial_port_data(port);
2201	d_details = s_priv->device_details;
2202	device_port = port->port_number;
2203
2204	/* only do something if we have a bulk out endpoint */
2205	this_urb = p_priv->outcont_urb;
2206	if (this_urb == NULL) {
2207		dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2208		return -1;
2209	}
2210
2211	/* Save reset port val for resend.
2212	   Don't overwrite resend for open/close condition. */
2213	if ((reset_port + 1) > p_priv->resend_cont)
2214		p_priv->resend_cont = reset_port + 1;
2215	if (this_urb->status == -EINPROGRESS) {
2216		dev_dbg(&port->dev, "%s already writing\n", __func__);
2217		mdelay(5);
2218		return -1;
2219	}
2220
2221	memset(&msg, 0, sizeof(struct keyspan_usa28_portControlMessage));
2222
2223	msg.setBaudRate = 1;
2224	if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2225					   &msg.baudHi, &msg.baudLo, NULL,
2226					   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2227		dev_dbg(&port->dev, "%s - Invalid baud rate requested %d.\n",
2228						__func__, p_priv->baud);
2229		msg.baudLo = 0xff;
2230		msg.baudHi = 0xb2;	/* Values for 9600 baud */
2231	}
2232
2233	/* If parity is enabled, we must calculate it ourselves. */
2234	msg.parity = 0;		/* XXX for now */
2235
2236	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2237	msg.xonFlowControl = 0;
2238
2239	/* Do handshaking outputs, DTR is inverted relative to RTS */
2240	msg.rts = p_priv->rts_state;
2241	msg.dtr = p_priv->dtr_state;
2242
2243	msg.forwardingLength = 16;
2244	msg.forwardMs = 10;
2245	msg.breakThreshold = 45;
2246	msg.xonChar = 17;
2247	msg.xoffChar = 19;
2248
2249	/*msg.returnStatus = 1;
2250	msg.resetDataToggle = 0xff;*/
2251	/* Opening port */
2252	if (reset_port == 1) {
2253		msg._txOn = 1;
2254		msg._txOff = 0;
2255		msg.txFlush = 0;
2256		msg.txForceXoff = 0;
2257		msg.txBreak = 0;
2258		msg.rxOn = 1;
2259		msg.rxOff = 0;
2260		msg.rxFlush = 1;
2261		msg.rxForward = 0;
2262		msg.returnStatus = 0;
2263		msg.resetDataToggle = 0xff;
2264	}
2265	/* Closing port */
2266	else if (reset_port == 2) {
2267		msg._txOn = 0;
2268		msg._txOff = 1;
2269		msg.txFlush = 0;
2270		msg.txForceXoff = 0;
2271		msg.txBreak = 0;
2272		msg.rxOn = 0;
2273		msg.rxOff = 1;
2274		msg.rxFlush = 1;
2275		msg.rxForward = 0;
2276		msg.returnStatus = 0;
2277		msg.resetDataToggle = 0;
2278	}
2279	/* Sending intermediate configs */
2280	else {
2281		msg._txOn = (!p_priv->break_on);
2282		msg._txOff = 0;
2283		msg.txFlush = 0;
2284		msg.txForceXoff = 0;
2285		msg.txBreak = (p_priv->break_on);
2286		msg.rxOn = 0;
2287		msg.rxOff = 0;
2288		msg.rxFlush = 0;
2289		msg.rxForward = 0;
2290		msg.returnStatus = 0;
2291		msg.resetDataToggle = 0x0;
2292	}
2293
2294	p_priv->resend_cont = 0;
2295	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2296
2297	/* send the data out the device on control endpoint */
2298	this_urb->transfer_buffer_length = sizeof(msg);
2299
2300	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2301	if (err != 0)
2302		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed\n", __func__);
2303
2304	return 0;
2305}
2306
2307static int keyspan_usa49_send_setup(struct usb_serial *serial,
2308				    struct usb_serial_port *port,
2309				    int reset_port)
2310{
2311	struct keyspan_usa49_portControlMessage	msg;
2312	struct usb_ctrlrequest 			*dr = NULL;
2313	struct keyspan_serial_private 		*s_priv;
2314	struct keyspan_port_private 		*p_priv;
2315	const struct keyspan_device_details	*d_details;
2316	struct urb				*this_urb;
2317	int 					err, device_port;
2318
2319	s_priv = usb_get_serial_data(serial);
2320	p_priv = usb_get_serial_port_data(port);
2321	d_details = s_priv->device_details;
2322
2323	this_urb = s_priv->glocont_urb;
2324
2325	/* Work out which port within the device is being setup */
2326	device_port = port->port_number;
2327
2328	/* Make sure we have an urb then send the message */
2329	if (this_urb == NULL) {
2330		dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2331		return -1;
2332	}
2333
2334	dev_dbg(&port->dev, "%s - endpoint %x (%d)\n",
2335		__func__, usb_pipeendpoint(this_urb->pipe), device_port);
2336
2337	/* Save reset port val for resend.
2338	   Don't overwrite resend for open/close condition. */
2339	if ((reset_port + 1) > p_priv->resend_cont)
2340		p_priv->resend_cont = reset_port + 1;
2341
2342	if (this_urb->status == -EINPROGRESS) {
2343		/*  dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2344		mdelay(5);
2345		return -1;
2346	}
2347
2348	memset(&msg, 0, sizeof(struct keyspan_usa49_portControlMessage));
2349
2350	msg.portNumber = device_port;
2351
2352	/* Only set baud rate if it's changed */
2353	if (p_priv->old_baud != p_priv->baud) {
2354		p_priv->old_baud = p_priv->baud;
2355		msg.setClocking = 0xff;
2356		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2357						   &msg.baudHi, &msg.baudLo, &msg.prescaler,
2358						   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2359			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2360				__func__, p_priv->baud);
2361			msg.baudLo = 0;
2362			msg.baudHi = 125;	/* Values for 9600 baud */
2363			msg.prescaler = 10;
2364		}
2365		/* msg.setPrescaler = 0xff; */
2366	}
2367
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;
2382	}
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;
2387	}
2388	msg.setLcr = 0xff;
2389
2390	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2391	msg.xonFlowControl = 0;
2392	msg.setFlowControl = 0xff;
2393
2394	msg.forwardingLength = 16;
2395	msg.xonChar = 17;
2396	msg.xoffChar = 19;
2397
2398	/* Opening port */
2399	if (reset_port == 1) {
2400		msg._txOn = 1;
2401		msg._txOff = 0;
2402		msg.txFlush = 0;
2403		msg.txBreak = 0;
2404		msg.rxOn = 1;
2405		msg.rxOff = 0;
2406		msg.rxFlush = 1;
2407		msg.rxForward = 0;
2408		msg.returnStatus = 0;
2409		msg.resetDataToggle = 0xff;
2410		msg.enablePort = 1;
2411		msg.disablePort = 0;
2412	}
2413	/* Closing port */
2414	else if (reset_port == 2) {
2415		msg._txOn = 0;
2416		msg._txOff = 1;
2417		msg.txFlush = 0;
2418		msg.txBreak = 0;
2419		msg.rxOn = 0;
2420		msg.rxOff = 1;
2421		msg.rxFlush = 1;
2422		msg.rxForward = 0;
2423		msg.returnStatus = 0;
2424		msg.resetDataToggle = 0;
2425		msg.enablePort = 0;
2426		msg.disablePort = 1;
2427	}
2428	/* Sending intermediate configs */
2429	else {
2430		msg._txOn = (!p_priv->break_on);
2431		msg._txOff = 0;
2432		msg.txFlush = 0;
2433		msg.txBreak = (p_priv->break_on);
2434		msg.rxOn = 0;
2435		msg.rxOff = 0;
2436		msg.rxFlush = 0;
2437		msg.rxForward = 0;
2438		msg.returnStatus = 0;
2439		msg.resetDataToggle = 0x0;
2440		msg.enablePort = 0;
2441		msg.disablePort = 0;
2442	}
2443
2444	/* Do handshaking outputs */
2445	msg.setRts = 0xff;
2446	msg.rts = p_priv->rts_state;
2447
2448	msg.setDtr = 0xff;
2449	msg.dtr = p_priv->dtr_state;
2450
2451	p_priv->resend_cont = 0;
2452
2453	/* if the device is a 49wg, we send control message on usb
2454	   control EP 0 */
2455
2456	if (d_details->product_id == keyspan_usa49wg_product_id) {
2457		dr = (void *)(s_priv->ctrl_buf);
2458		dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_OUT;
2459		dr->bRequest = 0xB0;	/* 49wg control message */
2460		dr->wValue = 0;
2461		dr->wIndex = 0;
2462		dr->wLength = cpu_to_le16(sizeof(msg));
2463
2464		memcpy(s_priv->glocont_buf, &msg, sizeof(msg));
2465
2466		usb_fill_control_urb(this_urb, serial->dev,
2467				usb_sndctrlpipe(serial->dev, 0),
2468				(unsigned char *)dr, s_priv->glocont_buf,
2469				sizeof(msg), usa49_glocont_callback, serial);
2470
2471	} else {
2472		memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2473
2474		/* send the data out the device on control endpoint */
2475		this_urb->transfer_buffer_length = sizeof(msg);
2476	}
2477	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2478	if (err != 0)
2479		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2480
2481	return 0;
2482}
2483
2484static int keyspan_usa90_send_setup(struct usb_serial *serial,
2485				    struct usb_serial_port *port,
2486				    int reset_port)
2487{
2488	struct keyspan_usa90_portControlMessage	msg;
2489	struct keyspan_serial_private 		*s_priv;
2490	struct keyspan_port_private 		*p_priv;
2491	const struct keyspan_device_details	*d_details;
2492	struct urb				*this_urb;
2493	int 					err;
2494	u8						prescaler;
2495
2496	s_priv = usb_get_serial_data(serial);
2497	p_priv = usb_get_serial_port_data(port);
2498	d_details = s_priv->device_details;
2499
2500	/* only do something if we have a bulk out endpoint */
2501	this_urb = p_priv->outcont_urb;
2502	if (this_urb == NULL) {
2503		dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2504		return -1;
2505	}
2506
2507	/* Save reset port val for resend.
2508	   Don't overwrite resend for open/close condition. */
2509	if ((reset_port + 1) > p_priv->resend_cont)
2510		p_priv->resend_cont = reset_port + 1;
2511	if (this_urb->status == -EINPROGRESS) {
2512		dev_dbg(&port->dev, "%s already writing\n", __func__);
2513		mdelay(5);
2514		return -1;
2515	}
2516
2517	memset(&msg, 0, sizeof(struct keyspan_usa90_portControlMessage));
2518
2519	/* Only set baud rate if it's changed */
2520	if (p_priv->old_baud != p_priv->baud) {
2521		p_priv->old_baud = p_priv->baud;
2522		msg.setClocking = 0x01;
2523		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2524						   &msg.baudHi, &msg.baudLo, &prescaler, 0) == KEYSPAN_INVALID_BAUD_RATE) {
2525			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2526				__func__, p_priv->baud);
2527			p_priv->baud = 9600;
2528			d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2529				&msg.baudHi, &msg.baudLo, &prescaler, 0);
2530		}
2531		msg.setRxMode = 1;
2532		msg.setTxMode = 1;
2533	}
2534
2535	/* modes must always be correctly specified */
2536	if (p_priv->baud > 57600) {
2537		msg.rxMode = RXMODE_DMA;
2538		msg.txMode = TXMODE_DMA;
2539	} else {
2540		msg.rxMode = RXMODE_BYHAND;
2541		msg.txMode = TXMODE_BYHAND;
2542	}
2543
2544	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2545	switch (p_priv->cflag & CSIZE) {
2546	case CS5:
2547		msg.lcr |= USA_DATABITS_5;
2548		break;
2549	case CS6:
2550		msg.lcr |= USA_DATABITS_6;
2551		break;
2552	case CS7:
2553		msg.lcr |= USA_DATABITS_7;
2554		break;
2555	case CS8:
2556		msg.lcr |= USA_DATABITS_8;
2557		break;
2558	}
2559	if (p_priv->cflag & PARENB) {
2560		/* note USA_PARITY_NONE == 0 */
2561		msg.lcr |= (p_priv->cflag & PARODD) ?
2562			USA_PARITY_ODD : USA_PARITY_EVEN;
2563	}
2564	if (p_priv->old_cflag != p_priv->cflag) {
2565		p_priv->old_cflag = p_priv->cflag;
2566		msg.setLcr = 0x01;
2567	}
2568
2569	if (p_priv->flow_control == flow_cts)
2570		msg.txFlowControl = TXFLOW_CTS;
2571	msg.setTxFlowControl = 0x01;
2572	msg.setRxFlowControl = 0x01;
2573
2574	msg.rxForwardingLength = 16;
2575	msg.rxForwardingTimeout = 16;
2576	msg.txAckSetting = 0;
2577	msg.xonChar = 17;
2578	msg.xoffChar = 19;
2579
2580	/* Opening port */
2581	if (reset_port == 1) {
2582		msg.portEnabled = 1;
2583		msg.rxFlush = 1;
2584		msg.txBreak = (p_priv->break_on);
2585	}
2586	/* Closing port */
2587	else if (reset_port == 2)
2588		msg.portEnabled = 0;
2589	/* Sending intermediate configs */
2590	else {
2591		msg.portEnabled = 1;
2592		msg.txBreak = (p_priv->break_on);
2593	}
2594
2595	/* Do handshaking outputs */
2596	msg.setRts = 0x01;
2597	msg.rts = p_priv->rts_state;
2598
2599	msg.setDtr = 0x01;
2600	msg.dtr = p_priv->dtr_state;
2601
2602	p_priv->resend_cont = 0;
2603	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2604
2605	/* send the data out the device on control endpoint */
2606	this_urb->transfer_buffer_length = sizeof(msg);
2607
2608	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2609	if (err != 0)
2610		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2611	return 0;
2612}
2613
2614static int keyspan_usa67_send_setup(struct usb_serial *serial,
2615				    struct usb_serial_port *port,
2616				    int reset_port)
2617{
2618	struct keyspan_usa67_portControlMessage	msg;
2619	struct keyspan_serial_private 		*s_priv;
2620	struct keyspan_port_private 		*p_priv;
2621	const struct keyspan_device_details	*d_details;
2622	struct urb				*this_urb;
2623	int 					err, device_port;
2624
2625	s_priv = usb_get_serial_data(serial);
2626	p_priv = usb_get_serial_port_data(port);
2627	d_details = s_priv->device_details;
2628
2629	this_urb = s_priv->glocont_urb;
2630
2631	/* Work out which port within the device is being setup */
2632	device_port = port->port_number;
2633
2634	/* Make sure we have an urb then send the message */
2635	if (this_urb == NULL) {
2636		dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2637		return -1;
2638	}
2639
2640	/* Save reset port val for resend.
2641	   Don't overwrite resend for open/close condition. */
2642	if ((reset_port + 1) > p_priv->resend_cont)
2643		p_priv->resend_cont = reset_port + 1;
2644	if (this_urb->status == -EINPROGRESS) {
2645		/*  dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2646		mdelay(5);
2647		return -1;
2648	}
2649
2650	memset(&msg, 0, sizeof(struct keyspan_usa67_portControlMessage));
2651
2652	msg.port = device_port;
2653
2654	/* Only set baud rate if it's changed */
2655	if (p_priv->old_baud != p_priv->baud) {
2656		p_priv->old_baud = p_priv->baud;
2657		msg.setClocking = 0xff;
2658		if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2659						   &msg.baudHi, &msg.baudLo, &msg.prescaler,
2660						   device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2661			dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2662				__func__, p_priv->baud);
2663			msg.baudLo = 0;
2664			msg.baudHi = 125;	/* Values for 9600 baud */
2665			msg.prescaler = 10;
2666		}
2667		msg.setPrescaler = 0xff;
2668	}
2669
2670	msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2671	switch (p_priv->cflag & CSIZE) {
2672	case CS5:
2673		msg.lcr |= USA_DATABITS_5;
2674		break;
2675	case CS6:
2676		msg.lcr |= USA_DATABITS_6;
2677		break;
2678	case CS7:
2679		msg.lcr |= USA_DATABITS_7;
2680		break;
2681	case CS8:
2682		msg.lcr |= USA_DATABITS_8;
2683		break;
2684	}
2685	if (p_priv->cflag & PARENB) {
2686		/* note USA_PARITY_NONE == 0 */
2687		msg.lcr |= (p_priv->cflag & PARODD) ?
2688					USA_PARITY_ODD : USA_PARITY_EVEN;
2689	}
2690	msg.setLcr = 0xff;
2691
2692	msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2693	msg.xonFlowControl = 0;
2694	msg.setFlowControl = 0xff;
2695	msg.forwardingLength = 16;
2696	msg.xonChar = 17;
2697	msg.xoffChar = 19;
2698
2699	if (reset_port == 1) {
2700		/* Opening port */
2701		msg._txOn = 1;
2702		msg._txOff = 0;
2703		msg.txFlush = 0;
2704		msg.txBreak = 0;
2705		msg.rxOn = 1;
2706		msg.rxOff = 0;
2707		msg.rxFlush = 1;
2708		msg.rxForward = 0;
2709		msg.returnStatus = 0;
2710		msg.resetDataToggle = 0xff;
2711	} else if (reset_port == 2) {
2712		/* Closing port */
2713		msg._txOn = 0;
2714		msg._txOff = 1;
2715		msg.txFlush = 0;
2716		msg.txBreak = 0;
2717		msg.rxOn = 0;
2718		msg.rxOff = 1;
2719		msg.rxFlush = 1;
2720		msg.rxForward = 0;
2721		msg.returnStatus = 0;
2722		msg.resetDataToggle = 0;
2723	} else {
2724		/* Sending intermediate configs */
2725		msg._txOn = (!p_priv->break_on);
2726		msg._txOff = 0;
2727		msg.txFlush = 0;
2728		msg.txBreak = (p_priv->break_on);
2729		msg.rxOn = 0;
2730		msg.rxOff = 0;
2731		msg.rxFlush = 0;
2732		msg.rxForward = 0;
2733		msg.returnStatus = 0;
2734		msg.resetDataToggle = 0x0;
2735	}
2736
2737	/* Do handshaking outputs */
2738	msg.setTxTriState_setRts = 0xff;
2739	msg.txTriState_rts = p_priv->rts_state;
2740
2741	msg.setHskoa_setDtr = 0xff;
2742	msg.hskoa_dtr = p_priv->dtr_state;
2743
2744	p_priv->resend_cont = 0;
2745
2746	memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2747
2748	/* send the data out the device on control endpoint */
2749	this_urb->transfer_buffer_length = sizeof(msg);
2750
2751	err = usb_submit_urb(this_urb, GFP_ATOMIC);
2752	if (err != 0)
2753		dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2754	return 0;
2755}
2756
2757static void keyspan_send_setup(struct usb_serial_port *port, int reset_port)
2758{
2759	struct usb_serial *serial = port->serial;
2760	struct keyspan_serial_private *s_priv;
2761	const struct keyspan_device_details *d_details;
2762
2763	s_priv = usb_get_serial_data(serial);
2764	d_details = s_priv->device_details;
2765
2766	switch (d_details->msg_format) {
2767	case msg_usa26:
2768		keyspan_usa26_send_setup(serial, port, reset_port);
2769		break;
2770	case msg_usa28:
2771		keyspan_usa28_send_setup(serial, port, reset_port);
2772		break;
2773	case msg_usa49:
2774		keyspan_usa49_send_setup(serial, port, reset_port);
2775		break;
2776	case msg_usa90:
2777		keyspan_usa90_send_setup(serial, port, reset_port);
2778		break;
2779	case msg_usa67:
2780		keyspan_usa67_send_setup(serial, port, reset_port);
2781		break;
2782	}
2783}
2784
2785
2786/* Gets called by the "real" driver (ie once firmware is loaded
2787   and renumeration has taken place. */
2788static int keyspan_startup(struct usb_serial *serial)
2789{
2790	int				i, err;
2791	struct keyspan_serial_private 	*s_priv;
2792	const struct keyspan_device_details	*d_details;
2793
2794	for (i = 0; (d_details = keyspan_devices[i]) != NULL; ++i)
2795		if (d_details->product_id ==
2796				le16_to_cpu(serial->dev->descriptor.idProduct))
2797			break;
2798	if (d_details == NULL) {
2799		dev_err(&serial->dev->dev, "%s - unknown product id %x\n",
2800		    __func__, le16_to_cpu(serial->dev->descriptor.idProduct));
2801		return -ENODEV;
2802	}
2803
2804	/* Setup private data for serial driver */
2805	s_priv = kzalloc(sizeof(struct keyspan_serial_private), GFP_KERNEL);
2806	if (!s_priv)
2807		return -ENOMEM;
2808
2809	s_priv->instat_buf = kzalloc(INSTAT_BUFLEN, GFP_KERNEL);
2810	if (!s_priv->instat_buf)
2811		goto err_instat_buf;
2812
2813	s_priv->indat_buf = kzalloc(INDAT49W_BUFLEN, GFP_KERNEL);
2814	if (!s_priv->indat_buf)
2815		goto err_indat_buf;
2816
2817	s_priv->glocont_buf = kzalloc(GLOCONT_BUFLEN, GFP_KERNEL);
2818	if (!s_priv->glocont_buf)
2819		goto err_glocont_buf;
2820
2821	s_priv->ctrl_buf = kzalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
2822	if (!s_priv->ctrl_buf)
2823		goto err_ctrl_buf;
2824
2825	s_priv->device_details = d_details;
2826	usb_set_serial_data(serial, s_priv);
2827
2828	keyspan_setup_urbs(serial);
2829
2830	if (s_priv->instat_urb != NULL) {
2831		err = usb_submit_urb(s_priv->instat_urb, GFP_KERNEL);
2832		if (err != 0)
2833			dev_dbg(&serial->dev->dev, "%s - submit instat urb failed %d\n", __func__, err);
2834	}
2835	if (s_priv->indat_urb != NULL) {
2836		err = usb_submit_urb(s_priv->indat_urb, GFP_KERNEL);
2837		if (err != 0)
2838			dev_dbg(&serial->dev->dev, "%s - submit indat urb failed %d\n", __func__, err);
2839	}
2840
2841	return 0;
2842
2843err_ctrl_buf:
2844	kfree(s_priv->glocont_buf);
2845err_glocont_buf:
2846	kfree(s_priv->indat_buf);
2847err_indat_buf:
2848	kfree(s_priv->instat_buf);
2849err_instat_buf:
2850	kfree(s_priv);
2851
2852	return -ENOMEM;
2853}
2854
2855static void keyspan_disconnect(struct usb_serial *serial)
2856{
2857	struct keyspan_serial_private *s_priv;
2858
2859	s_priv = usb_get_serial_data(serial);
2860
2861	usb_kill_urb(s_priv->instat_urb);
2862	usb_kill_urb(s_priv->glocont_urb);
2863	usb_kill_urb(s_priv->indat_urb);
2864}
2865
2866static void keyspan_release(struct usb_serial *serial)
2867{
2868	struct keyspan_serial_private *s_priv;
2869
2870	s_priv = usb_get_serial_data(serial);
2871
2872	/* Make sure to unlink the URBs submitted in attach. */
2873	usb_kill_urb(s_priv->instat_urb);
2874	usb_kill_urb(s_priv->indat_urb);
2875
2876	usb_free_urb(s_priv->instat_urb);
2877	usb_free_urb(s_priv->indat_urb);
2878	usb_free_urb(s_priv->glocont_urb);
2879
2880	kfree(s_priv->ctrl_buf);
2881	kfree(s_priv->glocont_buf);
2882	kfree(s_priv->indat_buf);
2883	kfree(s_priv->instat_buf);
2884
2885	kfree(s_priv);
2886}
2887
2888static int keyspan_port_probe(struct usb_serial_port *port)
2889{
2890	struct usb_serial *serial = port->serial;
2891	struct keyspan_serial_private *s_priv;
2892	struct keyspan_port_private *p_priv;
2893	const struct keyspan_device_details *d_details;
2894	struct callbacks *cback;
2895	int endp;
2896	int port_num;
2897	int i;
2898
2899	s_priv = usb_get_serial_data(serial);
2900	d_details = s_priv->device_details;
2901
2902	p_priv = kzalloc(sizeof(*p_priv), GFP_KERNEL);
2903	if (!p_priv)
2904		return -ENOMEM;
2905
2906	for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i) {
2907		p_priv->in_buffer[i] = kzalloc(IN_BUFLEN, GFP_KERNEL);
2908		if (!p_priv->in_buffer[i])
2909			goto err_in_buffer;
2910	}
2911
2912	for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i) {
2913		p_priv->out_buffer[i] = kzalloc(OUT_BUFLEN, GFP_KERNEL);
2914		if (!p_priv->out_buffer[i])
2915			goto err_out_buffer;
2916	}
2917
2918	p_priv->inack_buffer = kzalloc(INACK_BUFLEN, GFP_KERNEL);
2919	if (!p_priv->inack_buffer)
2920		goto err_inack_buffer;
2921
2922	p_priv->outcont_buffer = kzalloc(OUTCONT_BUFLEN, GFP_KERNEL);
2923	if (!p_priv->outcont_buffer)
2924		goto err_outcont_buffer;
2925
2926	p_priv->device_details = d_details;
2927
2928	/* Setup values for the various callback routines */
2929	cback = &keyspan_callbacks[d_details->msg_format];
2930
2931	port_num = port->port_number;
2932
2933	/* Do indat endpoints first, once for each flip */
2934	endp = d_details->indat_endpoints[port_num];
2935	for (i = 0; i <= d_details->indat_endp_flip; ++i, ++endp) {
2936		p_priv->in_urbs[i] = keyspan_setup_urb(serial, endp,
2937						USB_DIR_IN, port,
2938						p_priv->in_buffer[i],
2939						IN_BUFLEN,
2940						cback->indat_callback);
2941	}
2942	/* outdat endpoints also have flip */
2943	endp = d_details->outdat_endpoints[port_num];
2944	for (i = 0; i <= d_details->outdat_endp_flip; ++i, ++endp) {
2945		p_priv->out_urbs[i] = keyspan_setup_urb(serial, endp,
2946						USB_DIR_OUT, port,
2947						p_priv->out_buffer[i],
2948						OUT_BUFLEN,
2949						cback->outdat_callback);
2950	}
2951	/* inack endpoint */
2952	p_priv->inack_urb = keyspan_setup_urb(serial,
2953					d_details->inack_endpoints[port_num],
2954					USB_DIR_IN, port,
2955					p_priv->inack_buffer,
2956					INACK_BUFLEN,
2957					cback->inack_callback);
2958	/* outcont endpoint */
2959	p_priv->outcont_urb = keyspan_setup_urb(serial,
2960					d_details->outcont_endpoints[port_num],
2961					USB_DIR_OUT, port,
2962					p_priv->outcont_buffer,
2963					OUTCONT_BUFLEN,
2964					 cback->outcont_callback);
2965
2966	usb_set_serial_port_data(port, p_priv);
2967
2968	return 0;
2969
2970err_outcont_buffer:
2971	kfree(p_priv->inack_buffer);
2972err_inack_buffer:
2973	for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
2974		kfree(p_priv->out_buffer[i]);
2975err_out_buffer:
2976	for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
2977		kfree(p_priv->in_buffer[i]);
2978err_in_buffer:
2979	kfree(p_priv);
2980
2981	return -ENOMEM;
2982}
2983
2984static int keyspan_port_remove(struct usb_serial_port *port)
2985{
2986	struct keyspan_port_private *p_priv;
2987	int i;
2988
2989	p_priv = usb_get_serial_port_data(port);
2990
2991	usb_kill_urb(p_priv->inack_urb);
2992	usb_kill_urb(p_priv->outcont_urb);
2993	for (i = 0; i < 2; i++) {
2994		usb_kill_urb(p_priv->in_urbs[i]);
2995		usb_kill_urb(p_priv->out_urbs[i]);
2996	}
2997
2998	usb_free_urb(p_priv->inack_urb);
2999	usb_free_urb(p_priv->outcont_urb);
3000	for (i = 0; i < 2; i++) {
3001		usb_free_urb(p_priv->in_urbs[i]);
3002		usb_free_urb(p_priv->out_urbs[i]);
3003	}
3004
3005	kfree(p_priv->outcont_buffer);
3006	kfree(p_priv->inack_buffer);
3007	for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
3008		kfree(p_priv->out_buffer[i]);
3009	for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
3010		kfree(p_priv->in_buffer[i]);
3011
3012	kfree(p_priv);
3013
3014	return 0;
3015}
3016
3017/* Structs for the devices, pre and post renumeration. */
3018static struct usb_serial_driver keyspan_pre_device = {
3019	.driver = {
3020		.owner		= THIS_MODULE,
3021		.name		= "keyspan_no_firm",
3022	},
3023	.description		= "Keyspan - (without firmware)",
3024	.id_table		= keyspan_pre_ids,
3025	.num_ports		= 1,
3026	.attach			= keyspan_fake_startup,
3027};
3028
3029static struct usb_serial_driver keyspan_1port_device = {
3030	.driver = {
3031		.owner		= THIS_MODULE,
3032		.name		= "keyspan_1",
3033	},
3034	.description		= "Keyspan 1 port adapter",
3035	.id_table		= keyspan_1port_ids,
3036	.num_ports		= 1,
3037	.open			= keyspan_open,
3038	.close			= keyspan_close,
3039	.dtr_rts		= keyspan_dtr_rts,
3040	.write			= keyspan_write,
3041	.write_room		= keyspan_write_room,
3042	.set_termios		= keyspan_set_termios,
3043	.break_ctl		= keyspan_break_ctl,
3044	.tiocmget		= keyspan_tiocmget,
3045	.tiocmset		= keyspan_tiocmset,
3046	.attach			= keyspan_startup,
3047	.disconnect		= keyspan_disconnect,
3048	.release		= keyspan_release,
3049	.port_probe		= keyspan_port_probe,
3050	.port_remove		= keyspan_port_remove,
3051};
3052
3053static struct usb_serial_driver keyspan_2port_device = {
3054	.driver = {
3055		.owner		= THIS_MODULE,
3056		.name		= "keyspan_2",
3057	},
3058	.description		= "Keyspan 2 port adapter",
3059	.id_table		= keyspan_2port_ids,
3060	.num_ports		= 2,
3061	.open			= keyspan_open,
3062	.close			= keyspan_close,
3063	.dtr_rts		= keyspan_dtr_rts,
3064	.write			= keyspan_write,
3065	.write_room		= keyspan_write_room,
3066	.set_termios		= keyspan_set_termios,
3067	.break_ctl		= keyspan_break_ctl,
3068	.tiocmget		= keyspan_tiocmget,
3069	.tiocmset		= keyspan_tiocmset,
3070	.attach			= keyspan_startup,
3071	.disconnect		= keyspan_disconnect,
3072	.release		= keyspan_release,
3073	.port_probe		= keyspan_port_probe,
3074	.port_remove		= keyspan_port_remove,
3075};
3076
3077static struct usb_serial_driver keyspan_4port_device = {
3078	.driver = {
3079		.owner		= THIS_MODULE,
3080		.name		= "keyspan_4",
3081	},
3082	.description		= "Keyspan 4 port adapter",
3083	.id_table		= keyspan_4port_ids,
3084	.num_ports		= 4,
3085	.open			= keyspan_open,
3086	.close			= keyspan_close,
3087	.dtr_rts		= keyspan_dtr_rts,
3088	.write			= keyspan_write,
3089	.write_room		= keyspan_write_room,
3090	.set_termios		= keyspan_set_termios,
3091	.break_ctl		= keyspan_break_ctl,
3092	.tiocmget		= keyspan_tiocmget,
3093	.tiocmset		= keyspan_tiocmset,
3094	.attach			= keyspan_startup,
3095	.disconnect		= keyspan_disconnect,
3096	.release		= keyspan_release,
3097	.port_probe		= keyspan_port_probe,
3098	.port_remove		= keyspan_port_remove,
3099};
3100
3101static struct usb_serial_driver * const serial_drivers[] = {
3102	&keyspan_pre_device, &keyspan_1port_device,
3103	&keyspan_2port_device, &keyspan_4port_device, NULL
3104};
3105
3106module_usb_serial_driver(serial_drivers, keyspan_ids_combined);
3107
3108MODULE_AUTHOR(DRIVER_AUTHOR);
3109MODULE_DESCRIPTION(DRIVER_DESC);
3110MODULE_LICENSE("GPL");
3111
3112MODULE_FIRMWARE("keyspan/usa28.fw");
3113MODULE_FIRMWARE("keyspan/usa28x.fw");
3114MODULE_FIRMWARE("keyspan/usa28xa.fw");
3115MODULE_FIRMWARE("keyspan/usa28xb.fw");
3116MODULE_FIRMWARE("keyspan/usa19.fw");
3117MODULE_FIRMWARE("keyspan/usa19qi.fw");
3118MODULE_FIRMWARE("keyspan/mpr.fw");
3119MODULE_FIRMWARE("keyspan/usa19qw.fw");
3120MODULE_FIRMWARE("keyspan/usa18x.fw");
3121MODULE_FIRMWARE("keyspan/usa19w.fw");
3122MODULE_FIRMWARE("keyspan/usa49w.fw");
3123MODULE_FIRMWARE("keyspan/usa49wlc.fw");