whiteheat.c 41.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * USB ConnectTech WhiteHEAT driver
 *
 *	Copyright (C) 2002
 *	    Connect Tech Inc.
 *
 *	Copyright (C) 1999 - 2001
 *	    Greg Kroah-Hartman (greg@kroah.com)
 *
 *	This program is free software; you can redistribute it and/or modify
 *	it under the terms of the GNU General Public License as published by
 *	the Free Software Foundation; either version 2 of the License, or
 *	(at your option) any later version.
 *
A
Alan Cox 已提交
15 16
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
L
Linus Torvalds 已提交
17 18 19 20 21 22 23 24 25 26 27
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/spinlock.h>
O
Oliver Neukum 已提交
28
#include <linux/mutex.h>
A
Alan Cox 已提交
29
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
30 31 32 33
#include <asm/termbits.h>
#include <linux/usb.h>
#include <linux/serial_reg.h>
#include <linux/serial.h>
34
#include <linux/usb/serial.h>
35 36
#include <linux/firmware.h>
#include <linux/ihex.h>
L
Linus Torvalds 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#include "whiteheat.h"			/* WhiteHEAT specific commands */

static int debug;

#ifndef CMSPAR
#define CMSPAR 0
#endif

/*
 * Version Information
 */
#define DRIVER_VERSION "v2.0"
#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
#define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"

#define CONNECT_TECH_VENDOR_ID		0x0710
#define CONNECT_TECH_FAKE_WHITE_HEAT_ID	0x0001
#define CONNECT_TECH_WHITE_HEAT_ID	0x8001

/*
   ID tables for whiteheat are unusual, because we want to different
   things for different versions of the device.  Eventually, this
   will be doable from a single table.  But, for now, we define two
   separate ID tables, and then a third table that combines them
   just for the purpose of exporting the autoloading information.
*/
63
static const struct usb_device_id id_table_std[] = {
L
Linus Torvalds 已提交
64 65 66 67
	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
	{ }						/* Terminating entry */
};

68
static const struct usb_device_id id_table_prerenumeration[] = {
L
Linus Torvalds 已提交
69 70 71 72
	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
	{ }						/* Terminating entry */
};

73
static const struct usb_device_id id_table_combined[] = {
L
Linus Torvalds 已提交
74 75 76 77 78
	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
	{ }						/* Terminating entry */
};

A
Alan Cox 已提交
79
MODULE_DEVICE_TABLE(usb, id_table_combined);
L
Linus Torvalds 已提交
80 81 82 83 84 85

static struct usb_driver whiteheat_driver = {
	.name =		"whiteheat",
	.probe =	usb_serial_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	id_table_combined,
86
	.no_dynamic_id = 	1,
L
Linus Torvalds 已提交
87 88 89
};

/* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
A
Alan Cox 已提交
90 91 92
static int  whiteheat_firmware_download(struct usb_serial *serial,
					const struct usb_device_id *id);
static int  whiteheat_firmware_attach(struct usb_serial *serial);
L
Linus Torvalds 已提交
93 94

/* function prototypes for the Connect Tech WhiteHEAT serial converter */
A
Alan Cox 已提交
95
static int  whiteheat_attach(struct usb_serial *serial);
96
static void whiteheat_release(struct usb_serial *serial);
A
Alan Cox 已提交
97
static int  whiteheat_open(struct tty_struct *tty,
98
			struct usb_serial_port *port);
99
static void whiteheat_close(struct usb_serial_port *port);
A
Alan Cox 已提交
100 101 102 103
static int  whiteheat_write(struct tty_struct *tty,
			struct usb_serial_port *port,
			const unsigned char *buf, int count);
static int  whiteheat_write_room(struct tty_struct *tty);
104
static int  whiteheat_ioctl(struct tty_struct *tty,
A
Alan Cox 已提交
105 106 107
			unsigned int cmd, unsigned long arg);
static void whiteheat_set_termios(struct tty_struct *tty,
			struct usb_serial_port *port, struct ktermios *old);
108
static int  whiteheat_tiocmget(struct tty_struct *tty);
109
static int  whiteheat_tiocmset(struct tty_struct *tty,
A
Alan Cox 已提交
110 111 112 113 114 115 116
			unsigned int set, unsigned int clear);
static void whiteheat_break_ctl(struct tty_struct *tty, int break_state);
static int  whiteheat_chars_in_buffer(struct tty_struct *tty);
static void whiteheat_throttle(struct tty_struct *tty);
static void whiteheat_unthrottle(struct tty_struct *tty);
static void whiteheat_read_callback(struct urb *urb);
static void whiteheat_write_callback(struct urb *urb);
L
Linus Torvalds 已提交
117

118
static struct usb_serial_driver whiteheat_fake_device = {
119 120
	.driver = {
		.owner =	THIS_MODULE,
121
		.name =		"whiteheatnofirm",
122
	},
123
	.description =		"Connect Tech - WhiteHEAT - (prerenumeration)",
124
	.usb_driver =		&whiteheat_driver,
L
Linus Torvalds 已提交
125 126 127 128 129 130
	.id_table =		id_table_prerenumeration,
	.num_ports =		1,
	.probe =		whiteheat_firmware_download,
	.attach =		whiteheat_firmware_attach,
};

131
static struct usb_serial_driver whiteheat_device = {
132 133
	.driver = {
		.owner =	THIS_MODULE,
134
		.name =		"whiteheat",
135
	},
136
	.description =		"Connect Tech - WhiteHEAT",
137
	.usb_driver =		&whiteheat_driver,
L
Linus Torvalds 已提交
138 139 140
	.id_table =		id_table_std,
	.num_ports =		4,
	.attach =		whiteheat_attach,
141
	.release =		whiteheat_release,
L
Linus Torvalds 已提交
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
	.open =			whiteheat_open,
	.close =		whiteheat_close,
	.write =		whiteheat_write,
	.write_room =		whiteheat_write_room,
	.ioctl =		whiteheat_ioctl,
	.set_termios =		whiteheat_set_termios,
	.break_ctl =		whiteheat_break_ctl,
	.tiocmget =		whiteheat_tiocmget,
	.tiocmset =		whiteheat_tiocmset,
	.chars_in_buffer =	whiteheat_chars_in_buffer,
	.throttle =		whiteheat_throttle,
	.unthrottle =		whiteheat_unthrottle,
	.read_bulk_callback =	whiteheat_read_callback,
	.write_bulk_callback =	whiteheat_write_callback,
};


struct whiteheat_command_private {
O
Oliver Neukum 已提交
160
	struct mutex		mutex;
L
Linus Torvalds 已提交
161 162
	__u8			port_running;
	__u8			command_finished;
A
Alan Cox 已提交
163 164 165
	wait_queue_head_t	wait_command; /* for handling sleeping whilst
						 waiting for a command to
						 finish */
L
Linus Torvalds 已提交
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
	__u8			result_buffer[64];
};


#define THROTTLED		0x01
#define ACTUALLY_THROTTLED	0x02

static int urb_pool_size = 8;

struct whiteheat_urb_wrap {
	struct list_head	list;
	struct urb		*urb;
};

struct whiteheat_private {
	spinlock_t		lock;
	__u8			flags;
183
	__u8			mcr;		/* FIXME: no locking on mcr */
L
Linus Torvalds 已提交
184 185 186 187
	struct list_head	rx_urbs_free;
	struct list_head	rx_urbs_submitted;
	struct list_head	rx_urb_q;
	struct work_struct	rx_work;
D
David Howells 已提交
188
	struct usb_serial_port	*port;
L
Linus Torvalds 已提交
189 190
	struct list_head	tx_urbs_free;
	struct list_head	tx_urbs_submitted;
O
Oliver Neukum 已提交
191
	struct mutex		deathwarrant;
L
Linus Torvalds 已提交
192 193 194 195 196 197
};


/* local function prototypes */
static int start_command_port(struct usb_serial *serial);
static void stop_command_port(struct usb_serial *serial);
198 199
static void command_port_write_callback(struct urb *urb);
static void command_port_read_callback(struct urb *urb);
L
Linus Torvalds 已提交
200 201

static int start_port_read(struct usb_serial_port *port);
A
Alan Cox 已提交
202 203
static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb,
						struct list_head *head);
L
Linus Torvalds 已提交
204
static struct list_head *list_first(struct list_head *head);
D
David Howells 已提交
205
static void rx_data_softint(struct work_struct *work);
L
Linus Torvalds 已提交
206

A
Alan Cox 已提交
207 208
static int firm_send_command(struct usb_serial_port *port, __u8 command,
						__u8 *data, __u8 datasize);
L
Linus Torvalds 已提交
209 210
static int firm_open(struct usb_serial_port *port);
static int firm_close(struct usb_serial_port *port);
A
Alan Cox 已提交
211
static void firm_setup_port(struct tty_struct *tty);
L
Linus Torvalds 已提交
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
static int firm_get_dtr_rts(struct usb_serial_port *port);
static int firm_report_tx_done(struct usb_serial_port *port);


#define COMMAND_PORT		4
#define COMMAND_TIMEOUT		(2*HZ)	/* 2 second timeout for a command */
#define	COMMAND_TIMEOUT_MS	2000
#define CLOSING_DELAY		(30 * HZ)


/*****************************************************************************
 * Connect Tech's White Heat prerenumeration driver functions
 *****************************************************************************/

/* steps to download the firmware to the WhiteHEAT device:
 - hold the reset (by writing to the reset bit of the CPUCS register)
 - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
 - release the reset (by writing to the CPUCS register)
 - download the WH.HEX file for all addresses greater than 0x1b3f using
   VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
 - hold the reset
 - download the WH.HEX file for all addresses less than 0x1b40 using
   VENDOR_REQUEST_ANCHOR_LOAD
 - release the reset
 - device renumerated itself and comes up as new device id with all
   firmware download completed.
*/
A
Alan Cox 已提交
243 244
static int whiteheat_firmware_download(struct usb_serial *serial,
					const struct usb_device_id *id)
L
Linus Torvalds 已提交
245
{
246 247 248 249
	int response, ret = -ENOENT;
	const struct firmware *loader_fw = NULL, *firmware_fw = NULL;
	const struct ihex_binrec *record;

250
	dbg("%s", __func__);
251 252 253

	if (request_ihex_firmware(&firmware_fw, "whiteheat.fw",
				  &serial->dev->dev)) {
254 255
		dev_err(&serial->dev->dev,
			"%s - request \"whiteheat.fw\" failed\n", __func__);
256 257 258 259
		goto out;
	}
	if (request_ihex_firmware(&loader_fw, "whiteheat_loader.fw",
			     &serial->dev->dev)) {
260 261 262
		dev_err(&serial->dev->dev,
			"%s - request \"whiteheat_loader.fw\" failed\n",
			__func__);
263 264 265
		goto out;
	}
	ret = 0;
L
Linus Torvalds 已提交
266 267
	response = ezusb_set_reset (serial, 1);

268 269 270 271 272
	record = (const struct ihex_binrec *)loader_fw->data;
	while (record) {
		response = ezusb_writememory (serial, be32_to_cpu(record->addr),
					      (unsigned char *)record->data,
					      be16_to_cpu(record->len), 0xa0);
L
Linus Torvalds 已提交
273
		if (response < 0) {
274 275 276 277
			dev_err(&serial->dev->dev, "%s - ezusb_writememory "
				"failed for loader (%d %04X %p %d)\n",
				__func__, response, be32_to_cpu(record->addr),
				record->data, be16_to_cpu(record->len));
L
Linus Torvalds 已提交
278 279
			break;
		}
280
		record = ihex_next_binrec(record);
L
Linus Torvalds 已提交
281 282
	}

A
Alan Cox 已提交
283
	response = ezusb_set_reset(serial, 0);
L
Linus Torvalds 已提交
284

285 286 287 288 289 290 291
	record = (const struct ihex_binrec *)firmware_fw->data;
	while (record && be32_to_cpu(record->addr) < 0x1b40)
		record = ihex_next_binrec(record);
	while (record) {
		response = ezusb_writememory (serial, be32_to_cpu(record->addr),
					      (unsigned char *)record->data,
					      be16_to_cpu(record->len), 0xa3);
L
Linus Torvalds 已提交
292
		if (response < 0) {
293 294 295 296 297
			dev_err(&serial->dev->dev, "%s - ezusb_writememory "
				"failed for first firmware step "
				"(%d %04X %p %d)\n", __func__, response,
				be32_to_cpu(record->addr), record->data,
				be16_to_cpu(record->len));
L
Linus Torvalds 已提交
298 299 300 301
			break;
		}
		++record;
	}
A
Alan Cox 已提交
302 303

	response = ezusb_set_reset(serial, 1);
L
Linus Torvalds 已提交
304

305 306 307 308 309
	record = (const struct ihex_binrec *)firmware_fw->data;
	while (record && be32_to_cpu(record->addr) < 0x1b40) {
		response = ezusb_writememory (serial, be32_to_cpu(record->addr),
					      (unsigned char *)record->data,
					      be16_to_cpu(record->len), 0xa0);
L
Linus Torvalds 已提交
310
		if (response < 0) {
311 312 313 314 315
			dev_err(&serial->dev->dev, "%s - ezusb_writememory "
				"failed for second firmware step "
				"(%d %04X %p %d)\n", __func__, response,
				be32_to_cpu(record->addr), record->data,
				be16_to_cpu(record->len));
L
Linus Torvalds 已提交
316 317 318 319
			break;
		}
		++record;
	}
320
	ret = 0;
L
Linus Torvalds 已提交
321
	response = ezusb_set_reset (serial, 0);
322 323 324 325
 out:
	release_firmware(loader_fw);
	release_firmware(firmware_fw);
	return ret;
L
Linus Torvalds 已提交
326 327 328
}


A
Alan Cox 已提交
329
static int whiteheat_firmware_attach(struct usb_serial *serial)
L
Linus Torvalds 已提交
330 331 332 333 334 335 336 337 338
{
	/* We want this device to fail to have a driver assigned to it */
	return 1;
}


/*****************************************************************************
 * Connect Tech's White Heat serial driver functions
 *****************************************************************************/
A
Alan Cox 已提交
339
static int whiteheat_attach(struct usb_serial *serial)
L
Linus Torvalds 已提交
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
{
	struct usb_serial_port *command_port;
	struct whiteheat_command_private *command_info;
	struct usb_serial_port *port;
	struct whiteheat_private *info;
	struct whiteheat_hw_info *hw_info;
	int pipe;
	int ret;
	int alen;
	__u8 *command;
	__u8 *result;
	int i;
	int j;
	struct urb *urb;
	int buf_size;
	struct whiteheat_urb_wrap *wrap;
	struct list_head *tmp;

	command_port = serial->port[COMMAND_PORT];

A
Alan Cox 已提交
360 361
	pipe = usb_sndbulkpipe(serial->dev,
			command_port->bulk_out_endpointAddress);
L
Linus Torvalds 已提交
362 363 364 365 366
	command = kmalloc(2, GFP_KERNEL);
	if (!command)
		goto no_command_buffer;
	command[0] = WHITEHEAT_GET_HW_INFO;
	command[1] = 0;
A
Alan Cox 已提交
367

L
Linus Torvalds 已提交
368 369 370 371 372 373
	result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
	if (!result)
		goto no_result_buffer;
	/*
	 * When the module is reloaded the firmware is still there and
	 * the endpoints are still in the usb core unchanged. This is the
A
Alan Cox 已提交
374 375
	 * unlinking bug in disguise. Same for the call below.
	 */
L
Linus Torvalds 已提交
376
	usb_clear_halt(serial->dev, pipe);
A
Alan Cox 已提交
377 378
	ret = usb_bulk_msg(serial->dev, pipe, command, 2,
						&alen, COMMAND_TIMEOUT_MS);
L
Linus Torvalds 已提交
379
	if (ret) {
380 381
		dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n",
			serial->type->description, ret);
L
Linus Torvalds 已提交
382
		goto no_firmware;
383
	} else if (alen != 2) {
384 385
		dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n",
			serial->type->description, alen);
L
Linus Torvalds 已提交
386 387 388
		goto no_firmware;
	}

A
Alan Cox 已提交
389 390
	pipe = usb_rcvbulkpipe(serial->dev,
				command_port->bulk_in_endpointAddress);
L
Linus Torvalds 已提交
391 392
	/* See the comment on the usb_clear_halt() above */
	usb_clear_halt(serial->dev, pipe);
A
Alan Cox 已提交
393 394
	ret = usb_bulk_msg(serial->dev, pipe, result,
			sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
L
Linus Torvalds 已提交
395
	if (ret) {
396 397
		dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n",
			serial->type->description, ret);
L
Linus Torvalds 已提交
398
		goto no_firmware;
399
	} else if (alen != sizeof(*hw_info) + 1) {
400 401
		dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n",
			serial->type->description, alen);
L
Linus Torvalds 已提交
402 403
		goto no_firmware;
	} else if (result[0] != command[0]) {
404 405
		dev_err(&serial->dev->dev, "%s: Command failed [%d]\n",
			serial->type->description, result[0]);
L
Linus Torvalds 已提交
406 407 408 409 410
		goto no_firmware;
	}

	hw_info = (struct whiteheat_hw_info *)&result[1];

411 412 413
	dev_info(&serial->dev->dev, "%s: Driver %s: Firmware v%d.%02d\n",
		 serial->type->description, DRIVER_VERSION,
		 hw_info->sw_major_rev, hw_info->sw_minor_rev);
L
Linus Torvalds 已提交
414 415 416 417

	for (i = 0; i < serial->num_ports; i++) {
		port = serial->port[i];

418
		info = kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
L
Linus Torvalds 已提交
419
		if (info == NULL) {
420 421 422
			dev_err(&port->dev,
				"%s: Out of memory for port structures\n",
				serial->type->description);
L
Linus Torvalds 已提交
423 424 425 426
			goto no_private;
		}

		spin_lock_init(&info->lock);
O
Oliver Neukum 已提交
427
		mutex_init(&info->deathwarrant);
L
Linus Torvalds 已提交
428 429
		info->flags = 0;
		info->mcr = 0;
D
David Howells 已提交
430 431
		INIT_WORK(&info->rx_work, rx_data_softint);
		info->port = port;
L
Linus Torvalds 已提交
432 433 434 435 436 437 438 439 440 441

		INIT_LIST_HEAD(&info->rx_urbs_free);
		INIT_LIST_HEAD(&info->rx_urbs_submitted);
		INIT_LIST_HEAD(&info->rx_urb_q);
		INIT_LIST_HEAD(&info->tx_urbs_free);
		INIT_LIST_HEAD(&info->tx_urbs_submitted);

		for (j = 0; j < urb_pool_size; j++) {
			urb = usb_alloc_urb(0, GFP_KERNEL);
			if (!urb) {
442
				dev_err(&port->dev, "No free urbs available\n");
L
Linus Torvalds 已提交
443 444 445 446 447
				goto no_rx_urb;
			}
			buf_size = port->read_urb->transfer_buffer_length;
			urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
			if (!urb->transfer_buffer) {
448 449
				dev_err(&port->dev,
					"Couldn't allocate urb buffer\n");
L
Linus Torvalds 已提交
450 451 452 453
				goto no_rx_buf;
			}
			wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
			if (!wrap) {
454 455
				dev_err(&port->dev,
					"Couldn't allocate urb wrapper\n");
L
Linus Torvalds 已提交
456 457 458 459 460 461 462 463 464 465 466 467
				goto no_rx_wrap;
			}
			usb_fill_bulk_urb(urb, serial->dev,
					usb_rcvbulkpipe(serial->dev,
						port->bulk_in_endpointAddress),
					urb->transfer_buffer, buf_size,
					whiteheat_read_callback, port);
			wrap->urb = urb;
			list_add(&wrap->list, &info->rx_urbs_free);

			urb = usb_alloc_urb(0, GFP_KERNEL);
			if (!urb) {
468
				dev_err(&port->dev, "No free urbs available\n");
L
Linus Torvalds 已提交
469 470 471 472 473
				goto no_tx_urb;
			}
			buf_size = port->write_urb->transfer_buffer_length;
			urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
			if (!urb->transfer_buffer) {
474 475
				dev_err(&port->dev,
					"Couldn't allocate urb buffer\n");
L
Linus Torvalds 已提交
476 477 478 479
				goto no_tx_buf;
			}
			wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
			if (!wrap) {
480 481
				dev_err(&port->dev,
					"Couldn't allocate urb wrapper\n");
L
Linus Torvalds 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495
				goto no_tx_wrap;
			}
			usb_fill_bulk_urb(urb, serial->dev,
					usb_sndbulkpipe(serial->dev,
						port->bulk_out_endpointAddress),
					urb->transfer_buffer, buf_size,
					whiteheat_write_callback, port);
			wrap->urb = urb;
			list_add(&wrap->list, &info->tx_urbs_free);
		}

		usb_set_serial_port_data(port, info);
	}

A
Alan Cox 已提交
496 497
	command_info = kmalloc(sizeof(struct whiteheat_command_private),
								GFP_KERNEL);
L
Linus Torvalds 已提交
498
	if (command_info == NULL) {
499 500 501
		dev_err(&serial->dev->dev,
			"%s: Out of memory for port structures\n",
			serial->type->description);
L
Linus Torvalds 已提交
502 503 504
		goto no_command_private;
	}

O
Oliver Neukum 已提交
505
	mutex_init(&command_info->mutex);
L
Linus Torvalds 已提交
506 507 508 509 510 511 512 513 514 515 516 517
	command_info->port_running = 0;
	init_waitqueue_head(&command_info->wait_command);
	usb_set_serial_port_data(command_port, command_info);
	command_port->write_urb->complete = command_port_write_callback;
	command_port->read_urb->complete = command_port_read_callback;
	kfree(result);
	kfree(command);

	return 0;

no_firmware:
	/* Firmware likely not running */
518 519 520 521 522 523 524 525 526
	dev_err(&serial->dev->dev,
		"%s: Unable to retrieve firmware version, try replugging\n",
		serial->type->description);
	dev_err(&serial->dev->dev,
		"%s: If the firmware is not running (status led not blinking)\n",
		serial->type->description);
	dev_err(&serial->dev->dev,
		"%s: please contact support@connecttech.com\n",
		serial->type->description);
527
	kfree(result);
L
Linus Torvalds 已提交
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
	return -ENODEV;

no_command_private:
	for (i = serial->num_ports - 1; i >= 0; i--) {
		port = serial->port[i];
		info = usb_get_serial_port_data(port);
		for (j = urb_pool_size - 1; j >= 0; j--) {
			tmp = list_first(&info->tx_urbs_free);
			list_del(tmp);
			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
			urb = wrap->urb;
			kfree(wrap);
no_tx_wrap:
			kfree(urb->transfer_buffer);
no_tx_buf:
			usb_free_urb(urb);
no_tx_urb:
			tmp = list_first(&info->rx_urbs_free);
			list_del(tmp);
			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
			urb = wrap->urb;
			kfree(wrap);
no_rx_wrap:
			kfree(urb->transfer_buffer);
no_rx_buf:
			usb_free_urb(urb);
no_rx_urb:
			;
		}
		kfree(info);
no_private:
		;
	}
	kfree(result);
no_result_buffer:
	kfree(command);
no_command_buffer:
	return -ENOMEM;
}


569
static void whiteheat_release(struct usb_serial *serial)
L
Linus Torvalds 已提交
570 571 572 573 574 575 576 577 578 579
{
	struct usb_serial_port *command_port;
	struct usb_serial_port *port;
	struct whiteheat_private *info;
	struct whiteheat_urb_wrap *wrap;
	struct urb *urb;
	struct list_head *tmp;
	struct list_head *tmp2;
	int i;

580
	dbg("%s", __func__);
L
Linus Torvalds 已提交
581 582 583

	/* free up our private data for our command port */
	command_port = serial->port[COMMAND_PORT];
A
Alan Cox 已提交
584
	kfree(usb_get_serial_port_data(command_port));
L
Linus Torvalds 已提交
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608

	for (i = 0; i < serial->num_ports; i++) {
		port = serial->port[i];
		info = usb_get_serial_port_data(port);
		list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
			list_del(tmp);
			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
			urb = wrap->urb;
			kfree(wrap);
			kfree(urb->transfer_buffer);
			usb_free_urb(urb);
		}
		list_for_each_safe(tmp, tmp2, &info->tx_urbs_free) {
			list_del(tmp);
			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
			urb = wrap->urb;
			kfree(wrap);
			kfree(urb->transfer_buffer);
			usb_free_urb(urb);
		}
		kfree(info);
	}
}

609
static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port)
L
Linus Torvalds 已提交
610 611 612
{
	int		retval = 0;

613
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
614 615 616 617 618

	retval = start_command_port(port->serial);
	if (retval)
		goto exit;

A
Alan Cox 已提交
619 620
	if (tty)
		tty->low_latency = 1;
L
Linus Torvalds 已提交
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635

	/* send an open port command */
	retval = firm_open(port);
	if (retval) {
		stop_command_port(port->serial);
		goto exit;
	}

	retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
	if (retval) {
		firm_close(port);
		stop_command_port(port->serial);
		goto exit;
	}

636 637
	if (tty)
		firm_setup_port(tty);
L
Linus Torvalds 已提交
638 639 640 641 642 643 644 645

	/* Work around HCD bugs */
	usb_clear_halt(port->serial->dev, port->read_urb->pipe);
	usb_clear_halt(port->serial->dev, port->write_urb->pipe);

	/* Start reading from the device */
	retval = start_port_read(port);
	if (retval) {
646 647 648
		dev_err(&port->dev,
			"%s - failed submitting read urb, error %d\n",
			__func__, retval);
L
Linus Torvalds 已提交
649 650 651 652 653 654
		firm_close(port);
		stop_command_port(port->serial);
		goto exit;
	}

exit:
655
	dbg("%s - exit, retval = %d", __func__, retval);
L
Linus Torvalds 已提交
656 657 658 659
	return retval;
}


660
static void whiteheat_close(struct usb_serial_port *port)
L
Linus Torvalds 已提交
661 662 663 664 665 666 667
{
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	struct whiteheat_urb_wrap *wrap;
	struct urb *urb;
	struct list_head *tmp;
	struct list_head *tmp2;

668
	dbg("%s - port %d", __func__, port->number);
669

L
Linus Torvalds 已提交
670 671 672 673
	firm_report_tx_done(port);
	firm_close(port);

	/* shutdown our bulk reads and writes */
O
Oliver Neukum 已提交
674 675
	mutex_lock(&info->deathwarrant);
	spin_lock_irq(&info->lock);
L
Linus Torvalds 已提交
676 677 678
	list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		urb = wrap->urb;
O
Oliver Neukum 已提交
679 680
		list_del(tmp);
		spin_unlock_irq(&info->lock);
L
Linus Torvalds 已提交
681
		usb_kill_urb(urb);
O
Oliver Neukum 已提交
682 683
		spin_lock_irq(&info->lock);
		list_add(tmp, &info->rx_urbs_free);
L
Linus Torvalds 已提交
684
	}
A
Akinobu Mita 已提交
685 686
	list_for_each_safe(tmp, tmp2, &info->rx_urb_q)
		list_move(tmp, &info->rx_urbs_free);
L
Linus Torvalds 已提交
687 688 689
	list_for_each_safe(tmp, tmp2, &info->tx_urbs_submitted) {
		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		urb = wrap->urb;
O
Oliver Neukum 已提交
690 691
		list_del(tmp);
		spin_unlock_irq(&info->lock);
L
Linus Torvalds 已提交
692
		usb_kill_urb(urb);
O
Oliver Neukum 已提交
693 694
		spin_lock_irq(&info->lock);
		list_add(tmp, &info->tx_urbs_free);
L
Linus Torvalds 已提交
695
	}
O
Oliver Neukum 已提交
696 697
	spin_unlock_irq(&info->lock);
	mutex_unlock(&info->deathwarrant);
L
Linus Torvalds 已提交
698 699 700 701
	stop_command_port(port->serial);
}


A
Alan Cox 已提交
702 703
static int whiteheat_write(struct tty_struct *tty,
	struct usb_serial_port *port, const unsigned char *buf, int count)
L
Linus Torvalds 已提交
704 705 706 707 708 709 710 711 712 713
{
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	struct whiteheat_urb_wrap *wrap;
	struct urb *urb;
	int result;
	int bytes;
	int sent = 0;
	unsigned long flags;
	struct list_head *tmp;

714
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
715 716

	if (count == 0) {
717
		dbg("%s - write request of 0 bytes", __func__);
L
Linus Torvalds 已提交
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
		return (0);
	}

	while (count) {
		spin_lock_irqsave(&info->lock, flags);
		if (list_empty(&info->tx_urbs_free)) {
			spin_unlock_irqrestore(&info->lock, flags);
			break;
		}
		tmp = list_first(&info->tx_urbs_free);
		list_del(tmp);
		spin_unlock_irqrestore(&info->lock, flags);

		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		urb = wrap->urb;
A
Alan Cox 已提交
733 734 735
		bytes = (count > port->bulk_out_size) ?
					port->bulk_out_size : count;
		memcpy(urb->transfer_buffer, buf + sent, bytes);
L
Linus Torvalds 已提交
736

A
Alan Cox 已提交
737 738
		usb_serial_debug_data(debug, &port->dev,
				__func__, bytes, urb->transfer_buffer);
L
Linus Torvalds 已提交
739 740 741 742

		urb->transfer_buffer_length = bytes;
		result = usb_submit_urb(urb, GFP_ATOMIC);
		if (result) {
743 744 745
			dev_err(&port->dev,
				"%s - failed submitting write urb, error %d\n",
				__func__, result);
L
Linus Torvalds 已提交
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
			sent = result;
			spin_lock_irqsave(&info->lock, flags);
			list_add(tmp, &info->tx_urbs_free);
			spin_unlock_irqrestore(&info->lock, flags);
			break;
		} else {
			sent += bytes;
			count -= bytes;
			spin_lock_irqsave(&info->lock, flags);
			list_add(tmp, &info->tx_urbs_submitted);
			spin_unlock_irqrestore(&info->lock, flags);
		}
	}

	return sent;
}

A
Alan Cox 已提交
763
static int whiteheat_write_room(struct tty_struct *tty)
L
Linus Torvalds 已提交
764
{
A
Alan Cox 已提交
765
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
766 767 768 769 770
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	struct list_head *tmp;
	int room = 0;
	unsigned long flags;

771
	dbg("%s - port %d", __func__, port->number);
A
Alan Cox 已提交
772

L
Linus Torvalds 已提交
773 774 775 776 777 778
	spin_lock_irqsave(&info->lock, flags);
	list_for_each(tmp, &info->tx_urbs_free)
		room++;
	spin_unlock_irqrestore(&info->lock, flags);
	room *= port->bulk_out_size;

779
	dbg("%s - returns %d", __func__, room);
L
Linus Torvalds 已提交
780 781 782
	return (room);
}

783
static int whiteheat_tiocmget(struct tty_struct *tty)
L
Linus Torvalds 已提交
784
{
A
Alan Cox 已提交
785
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
786 787 788
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	unsigned int modem_signals = 0;

789
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
790 791 792 793 794 795 796 797 798 799

	firm_get_dtr_rts(port);
	if (info->mcr & UART_MCR_DTR)
		modem_signals |= TIOCM_DTR;
	if (info->mcr & UART_MCR_RTS)
		modem_signals |= TIOCM_RTS;

	return modem_signals;
}

800
static int whiteheat_tiocmset(struct tty_struct *tty,
L
Linus Torvalds 已提交
801 802
			       unsigned int set, unsigned int clear)
{
A
Alan Cox 已提交
803
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
804 805
	struct whiteheat_private *info = usb_get_serial_port_data(port);

806
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

	if (set & TIOCM_RTS)
		info->mcr |= UART_MCR_RTS;
	if (set & TIOCM_DTR)
		info->mcr |= UART_MCR_DTR;

	if (clear & TIOCM_RTS)
		info->mcr &= ~UART_MCR_RTS;
	if (clear & TIOCM_DTR)
		info->mcr &= ~UART_MCR_DTR;

	firm_set_dtr(port, info->mcr & UART_MCR_DTR);
	firm_set_rts(port, info->mcr & UART_MCR_RTS);
	return 0;
}


824
static int whiteheat_ioctl(struct tty_struct *tty,
A
Alan Cox 已提交
825
					unsigned int cmd, unsigned long arg)
L
Linus Torvalds 已提交
826
{
A
Alan Cox 已提交
827
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
828 829 830
	struct serial_struct serstruct;
	void __user *user_arg = (void __user *)arg;

831
	dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
L
Linus Torvalds 已提交
832 833

	switch (cmd) {
A
Alan Cox 已提交
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
	case TIOCGSERIAL:
		memset(&serstruct, 0, sizeof(serstruct));
		serstruct.type = PORT_16654;
		serstruct.line = port->serial->minor;
		serstruct.port = port->number;
		serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
		serstruct.xmit_fifo_size = port->bulk_out_size;
		serstruct.custom_divisor = 0;
		serstruct.baud_base = 460800;
		serstruct.close_delay = CLOSING_DELAY;
		serstruct.closing_wait = CLOSING_DELAY;

		if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
			return -EFAULT;
		break;
	default:
		break;
L
Linus Torvalds 已提交
851 852 853 854 855 856
	}

	return -ENOIOCTLCMD;
}


A
Alan Cox 已提交
857 858
static void whiteheat_set_termios(struct tty_struct *tty,
	struct usb_serial_port *port, struct ktermios *old_termios)
L
Linus Torvalds 已提交
859
{
A
Alan Cox 已提交
860
	firm_setup_port(tty);
L
Linus Torvalds 已提交
861 862
}

A
Alan Cox 已提交
863 864
static void whiteheat_break_ctl(struct tty_struct *tty, int break_state)
{
A
Alan Cox 已提交
865
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
866 867 868 869
	firm_set_break(port, break_state);
}


A
Alan Cox 已提交
870
static int whiteheat_chars_in_buffer(struct tty_struct *tty)
L
Linus Torvalds 已提交
871
{
A
Alan Cox 已提交
872
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
873 874 875 876 877 878
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	struct list_head *tmp;
	struct whiteheat_urb_wrap *wrap;
	int chars = 0;
	unsigned long flags;

879
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
880 881 882 883 884 885 886 887

	spin_lock_irqsave(&info->lock, flags);
	list_for_each(tmp, &info->tx_urbs_submitted) {
		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		chars += wrap->urb->transfer_buffer_length;
	}
	spin_unlock_irqrestore(&info->lock, flags);

A
Alan Cox 已提交
888
	dbg("%s - returns %d", __func__, chars);
O
Oliver Neukum 已提交
889
	return chars;
L
Linus Torvalds 已提交
890 891 892
}


A
Alan Cox 已提交
893
static void whiteheat_throttle(struct tty_struct *tty)
L
Linus Torvalds 已提交
894
{
A
Alan Cox 已提交
895
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
896 897
	struct whiteheat_private *info = usb_get_serial_port_data(port);

898
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
899

900
	spin_lock_irq(&info->lock);
L
Linus Torvalds 已提交
901
	info->flags |= THROTTLED;
902
	spin_unlock_irq(&info->lock);
L
Linus Torvalds 已提交
903 904 905
}


A
Alan Cox 已提交
906
static void whiteheat_unthrottle(struct tty_struct *tty)
L
Linus Torvalds 已提交
907
{
A
Alan Cox 已提交
908
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
909 910 911
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	int actually_throttled;

912
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
913

914
	spin_lock_irq(&info->lock);
L
Linus Torvalds 已提交
915 916
	actually_throttled = info->flags & ACTUALLY_THROTTLED;
	info->flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
917
	spin_unlock_irq(&info->lock);
L
Linus Torvalds 已提交
918 919

	if (actually_throttled)
D
David Howells 已提交
920
		rx_data_softint(&info->rx_work);
L
Linus Torvalds 已提交
921 922 923 924 925 926
}


/*****************************************************************************
 * Connect Tech's White Heat callback routines
 *****************************************************************************/
O
Oliver Neukum 已提交
927
static void command_port_write_callback(struct urb *urb)
L
Linus Torvalds 已提交
928
{
929 930
	int status = urb->status;

931
	dbg("%s", __func__);
L
Linus Torvalds 已提交
932

933 934
	if (status) {
		dbg("nonzero urb status: %d", status);
L
Linus Torvalds 已提交
935 936 937 938 939
		return;
	}
}


O
Oliver Neukum 已提交
940
static void command_port_read_callback(struct urb *urb)
L
Linus Torvalds 已提交
941
{
942
	struct usb_serial_port *command_port = urb->context;
L
Linus Torvalds 已提交
943
	struct whiteheat_command_private *command_info;
944
	int status = urb->status;
L
Linus Torvalds 已提交
945 946 947
	unsigned char *data = urb->transfer_buffer;
	int result;

948
	dbg("%s", __func__);
L
Linus Torvalds 已提交
949

O
Oliver Neukum 已提交
950 951
	command_info = usb_get_serial_port_data(command_port);
	if (!command_info) {
A
Alan Cox 已提交
952
		dbg("%s - command_info is NULL, exiting.", __func__);
O
Oliver Neukum 已提交
953 954
		return;
	}
955
	if (status) {
956
		dbg("%s - nonzero urb status: %d", __func__, status);
957
		if (status != -ENOENT)
O
Oliver Neukum 已提交
958 959
			command_info->command_finished = WHITEHEAT_CMD_FAILURE;
		wake_up(&command_info->wait_command);
L
Linus Torvalds 已提交
960 961 962
		return;
	}

A
Alan Cox 已提交
963 964
	usb_serial_debug_data(debug, &command_port->dev,
				__func__, urb->actual_length, data);
L
Linus Torvalds 已提交
965 966 967

	if (data[0] == WHITEHEAT_CMD_COMPLETE) {
		command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
O
Oliver Neukum 已提交
968
		wake_up(&command_info->wait_command);
L
Linus Torvalds 已提交
969 970
	} else if (data[0] == WHITEHEAT_CMD_FAILURE) {
		command_info->command_finished = WHITEHEAT_CMD_FAILURE;
O
Oliver Neukum 已提交
971
		wake_up(&command_info->wait_command);
L
Linus Torvalds 已提交
972
	} else if (data[0] == WHITEHEAT_EVENT) {
A
Alan Cox 已提交
973 974
		/* These are unsolicited reports from the firmware, hence no
		   waiting command to wakeup */
975
		dbg("%s - event received", __func__);
L
Linus Torvalds 已提交
976
	} else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
A
Alan Cox 已提交
977 978
		memcpy(command_info->result_buffer, &data[1],
						urb->actual_length - 1);
L
Linus Torvalds 已提交
979
		command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
O
Oliver Neukum 已提交
980
		wake_up(&command_info->wait_command);
A
Alan Cox 已提交
981
	} else
982
		dbg("%s - bad reply from firmware", __func__);
A
Alan Cox 已提交
983

L
Linus Torvalds 已提交
984 985 986
	/* Continue trying to always read */
	result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
	if (result)
A
Alan Cox 已提交
987 988
		dbg("%s - failed resubmitting read urb, error %d",
			__func__, result);
L
Linus Torvalds 已提交
989 990 991
}


992
static void whiteheat_read_callback(struct urb *urb)
L
Linus Torvalds 已提交
993
{
994
	struct usb_serial_port *port = urb->context;
L
Linus Torvalds 已提交
995 996 997
	struct whiteheat_urb_wrap *wrap;
	unsigned char *data = urb->transfer_buffer;
	struct whiteheat_private *info = usb_get_serial_port_data(port);
998
	int status = urb->status;
L
Linus Torvalds 已提交
999

1000
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
1001 1002 1003 1004 1005

	spin_lock(&info->lock);
	wrap = urb_to_wrap(urb, &info->rx_urbs_submitted);
	if (!wrap) {
		spin_unlock(&info->lock);
1006
		dev_err(&port->dev, "%s - Not my urb!\n", __func__);
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011
		return;
	}
	list_del(&wrap->list);
	spin_unlock(&info->lock);

1012 1013
	if (status) {
		dbg("%s - nonzero read bulk status received: %d",
1014
		    __func__, status);
L
Linus Torvalds 已提交
1015 1016 1017 1018 1019 1020
		spin_lock(&info->lock);
		list_add(&wrap->list, &info->rx_urbs_free);
		spin_unlock(&info->lock);
		return;
	}

A
Alan Cox 已提交
1021 1022
	usb_serial_debug_data(debug, &port->dev,
				__func__, urb->actual_length, data);
L
Linus Torvalds 已提交
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036

	spin_lock(&info->lock);
	list_add_tail(&wrap->list, &info->rx_urb_q);
	if (info->flags & THROTTLED) {
		info->flags |= ACTUALLY_THROTTLED;
		spin_unlock(&info->lock);
		return;
	}
	spin_unlock(&info->lock);

	schedule_work(&info->rx_work);
}


1037
static void whiteheat_write_callback(struct urb *urb)
L
Linus Torvalds 已提交
1038
{
1039
	struct usb_serial_port *port = urb->context;
L
Linus Torvalds 已提交
1040 1041
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	struct whiteheat_urb_wrap *wrap;
1042
	int status = urb->status;
L
Linus Torvalds 已提交
1043

1044
	dbg("%s - port %d", __func__, port->number);
L
Linus Torvalds 已提交
1045 1046 1047 1048 1049

	spin_lock(&info->lock);
	wrap = urb_to_wrap(urb, &info->tx_urbs_submitted);
	if (!wrap) {
		spin_unlock(&info->lock);
1050
		dev_err(&port->dev, "%s - Not my urb!\n", __func__);
L
Linus Torvalds 已提交
1051 1052
		return;
	}
A
Akinobu Mita 已提交
1053
	list_move(&wrap->list, &info->tx_urbs_free);
L
Linus Torvalds 已提交
1054 1055
	spin_unlock(&info->lock);

1056 1057
	if (status) {
		dbg("%s - nonzero write bulk status received: %d",
1058
		    __func__, status);
L
Linus Torvalds 已提交
1059 1060 1061
		return;
	}

1062
	usb_serial_port_softint(port);
L
Linus Torvalds 已提交
1063 1064 1065 1066 1067 1068
}


/*****************************************************************************
 * Connect Tech's White Heat firmware interface
 *****************************************************************************/
A
Alan Cox 已提交
1069 1070
static int firm_send_command(struct usb_serial_port *port, __u8 command,
						__u8 *data, __u8 datasize)
L
Linus Torvalds 已提交
1071 1072 1073 1074 1075 1076
{
	struct usb_serial_port *command_port;
	struct whiteheat_command_private *command_info;
	struct whiteheat_private *info;
	__u8 *transfer_buffer;
	int retval = 0;
O
Oliver Neukum 已提交
1077
	int t;
L
Linus Torvalds 已提交
1078

1079
	dbg("%s - command %d", __func__, command);
L
Linus Torvalds 已提交
1080 1081 1082

	command_port = port->serial->port[COMMAND_PORT];
	command_info = usb_get_serial_port_data(command_port);
O
Oliver Neukum 已提交
1083
	mutex_lock(&command_info->mutex);
1084
	command_info->command_finished = false;
A
Alan Cox 已提交
1085

L
Linus Torvalds 已提交
1086 1087
	transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
	transfer_buffer[0] = command;
A
Alan Cox 已提交
1088
	memcpy(&transfer_buffer[1], data, datasize);
L
Linus Torvalds 已提交
1089
	command_port->write_urb->transfer_buffer_length = datasize + 1;
A
Alan Cox 已提交
1090
	retval = usb_submit_urb(command_port->write_urb, GFP_NOIO);
L
Linus Torvalds 已提交
1091
	if (retval) {
1092
		dbg("%s - submit urb failed", __func__);
L
Linus Torvalds 已提交
1093 1094 1095 1096
		goto exit;
	}

	/* wait for the command to complete */
O
Oliver Neukum 已提交
1097
	t = wait_event_timeout(command_info->wait_command,
1098
		(bool)command_info->command_finished, COMMAND_TIMEOUT);
O
Oliver Neukum 已提交
1099 1100
	if (!t)
		usb_kill_urb(command_port->write_urb);
L
Linus Torvalds 已提交
1101

1102
	if (command_info->command_finished == false) {
1103
		dbg("%s - command timed out.", __func__);
L
Linus Torvalds 已提交
1104 1105 1106 1107 1108
		retval = -ETIMEDOUT;
		goto exit;
	}

	if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
1109
		dbg("%s - command failed.", __func__);
L
Linus Torvalds 已提交
1110 1111 1112 1113 1114
		retval = -EIO;
		goto exit;
	}

	if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
1115
		dbg("%s - command completed.", __func__);
L
Linus Torvalds 已提交
1116
		switch (command) {
A
Alan Cox 已提交
1117 1118 1119 1120
		case WHITEHEAT_GET_DTR_RTS:
			info = usb_get_serial_port_data(port);
			memcpy(&info->mcr, command_info->result_buffer,
					sizeof(struct whiteheat_dr_info));
L
Linus Torvalds 已提交
1121 1122 1123 1124
				break;
		}
	}
exit:
O
Oliver Neukum 已提交
1125
	mutex_unlock(&command_info->mutex);
L
Linus Torvalds 已提交
1126 1127 1128 1129
	return retval;
}


A
Alan Cox 已提交
1130 1131
static int firm_open(struct usb_serial_port *port)
{
L
Linus Torvalds 已提交
1132 1133 1134
	struct whiteheat_simple open_command;

	open_command.port = port->number - port->serial->minor + 1;
A
Alan Cox 已提交
1135 1136
	return firm_send_command(port, WHITEHEAT_OPEN,
		(__u8 *)&open_command, sizeof(open_command));
L
Linus Torvalds 已提交
1137 1138 1139
}


A
Alan Cox 已提交
1140 1141
static int firm_close(struct usb_serial_port *port)
{
L
Linus Torvalds 已提交
1142 1143 1144
	struct whiteheat_simple close_command;

	close_command.port = port->number - port->serial->minor + 1;
A
Alan Cox 已提交
1145 1146
	return firm_send_command(port, WHITEHEAT_CLOSE,
			(__u8 *)&close_command, sizeof(close_command));
L
Linus Torvalds 已提交
1147 1148 1149
}


A
Alan Cox 已提交
1150
static void firm_setup_port(struct tty_struct *tty)
A
Alan Cox 已提交
1151
{
A
Alan Cox 已提交
1152
	struct usb_serial_port *port = tty->driver_data;
L
Linus Torvalds 已提交
1153
	struct whiteheat_port_settings port_settings;
A
Alan Cox 已提交
1154
	unsigned int cflag = tty->termios->c_cflag;
L
Linus Torvalds 已提交
1155 1156 1157 1158 1159

	port_settings.port = port->number + 1;

	/* get the byte size */
	switch (cflag & CSIZE) {
A
Alan Cox 已提交
1160 1161 1162 1163 1164
	case CS5:	port_settings.bits = 5;   break;
	case CS6:	port_settings.bits = 6;   break;
	case CS7:	port_settings.bits = 7;   break;
	default:
	case CS8:	port_settings.bits = 8;   break;
L
Linus Torvalds 已提交
1165
	}
1166
	dbg("%s - data bits = %d", __func__, port_settings.bits);
A
Alan Cox 已提交
1167

L
Linus Torvalds 已提交
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
	/* determine the parity */
	if (cflag & PARENB)
		if (cflag & CMSPAR)
			if (cflag & PARODD)
				port_settings.parity = WHITEHEAT_PAR_MARK;
			else
				port_settings.parity = WHITEHEAT_PAR_SPACE;
		else
			if (cflag & PARODD)
				port_settings.parity = WHITEHEAT_PAR_ODD;
			else
				port_settings.parity = WHITEHEAT_PAR_EVEN;
	else
		port_settings.parity = WHITEHEAT_PAR_NONE;
1182
	dbg("%s - parity = %c", __func__, port_settings.parity);
L
Linus Torvalds 已提交
1183 1184 1185 1186 1187 1188

	/* figure out the stop bits requested */
	if (cflag & CSTOPB)
		port_settings.stop = 2;
	else
		port_settings.stop = 1;
1189
	dbg("%s - stop bits = %d", __func__, port_settings.stop);
L
Linus Torvalds 已提交
1190 1191 1192

	/* figure out the flow control settings */
	if (cflag & CRTSCTS)
A
Alan Cox 已提交
1193 1194
		port_settings.hflow = (WHITEHEAT_HFLOW_CTS |
						WHITEHEAT_HFLOW_RTS);
L
Linus Torvalds 已提交
1195 1196
	else
		port_settings.hflow = WHITEHEAT_HFLOW_NONE;
1197
	dbg("%s - hardware flow control = %s %s %s %s", __func__,
L
Linus Torvalds 已提交
1198 1199 1200 1201
	    (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
	    (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
	    (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
	    (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
A
Alan Cox 已提交
1202

L
Linus Torvalds 已提交
1203
	/* determine software flow control */
A
Alan Cox 已提交
1204
	if (I_IXOFF(tty))
L
Linus Torvalds 已提交
1205 1206 1207
		port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
	else
		port_settings.sflow = WHITEHEAT_SFLOW_NONE;
1208
	dbg("%s - software flow control = %c", __func__, port_settings.sflow);
A
Alan Cox 已提交
1209

A
Alan Cox 已提交
1210 1211
	port_settings.xon = START_CHAR(tty);
	port_settings.xoff = STOP_CHAR(tty);
A
Alan Cox 已提交
1212 1213
	dbg("%s - XON = %2x, XOFF = %2x",
			__func__, port_settings.xon, port_settings.xoff);
L
Linus Torvalds 已提交
1214 1215

	/* get the baud rate wanted */
A
Alan Cox 已提交
1216
	port_settings.baud = tty_get_baud_rate(tty);
1217
	dbg("%s - baud rate = %d", __func__, port_settings.baud);
L
Linus Torvalds 已提交
1218

1219
	/* fixme: should set validated settings */
A
Alan Cox 已提交
1220
	tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud);
L
Linus Torvalds 已提交
1221 1222
	/* handle any settings that aren't specified in the tty structure */
	port_settings.lloop = 0;
A
Alan Cox 已提交
1223

L
Linus Torvalds 已提交
1224
	/* now send the message to the device */
A
Alan Cox 已提交
1225
	firm_send_command(port, WHITEHEAT_SETUP_PORT,
A
Alan Cox 已提交
1226
			(__u8 *)&port_settings, sizeof(port_settings));
L
Linus Torvalds 已提交
1227 1228 1229
}


A
Alan Cox 已提交
1230 1231
static int firm_set_rts(struct usb_serial_port *port, __u8 onoff)
{
L
Linus Torvalds 已提交
1232 1233 1234 1235
	struct whiteheat_set_rdb rts_command;

	rts_command.port = port->number - port->serial->minor + 1;
	rts_command.state = onoff;
A
Alan Cox 已提交
1236 1237
	return firm_send_command(port, WHITEHEAT_SET_RTS,
			(__u8 *)&rts_command, sizeof(rts_command));
L
Linus Torvalds 已提交
1238 1239 1240
}


A
Alan Cox 已提交
1241 1242
static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff)
{
L
Linus Torvalds 已提交
1243 1244 1245 1246
	struct whiteheat_set_rdb dtr_command;

	dtr_command.port = port->number - port->serial->minor + 1;
	dtr_command.state = onoff;
1247
	return firm_send_command(port, WHITEHEAT_SET_DTR,
A
Alan Cox 已提交
1248
			(__u8 *)&dtr_command, sizeof(dtr_command));
L
Linus Torvalds 已提交
1249 1250 1251
}


A
Alan Cox 已提交
1252 1253
static int firm_set_break(struct usb_serial_port *port, __u8 onoff)
{
L
Linus Torvalds 已提交
1254 1255 1256 1257
	struct whiteheat_set_rdb break_command;

	break_command.port = port->number - port->serial->minor + 1;
	break_command.state = onoff;
1258
	return firm_send_command(port, WHITEHEAT_SET_BREAK,
A
Alan Cox 已提交
1259
			(__u8 *)&break_command, sizeof(break_command));
L
Linus Torvalds 已提交
1260 1261 1262
}


A
Alan Cox 已提交
1263 1264
static int firm_purge(struct usb_serial_port *port, __u8 rxtx)
{
L
Linus Torvalds 已提交
1265 1266 1267 1268
	struct whiteheat_purge purge_command;

	purge_command.port = port->number - port->serial->minor + 1;
	purge_command.what = rxtx;
A
Alan Cox 已提交
1269 1270
	return firm_send_command(port, WHITEHEAT_PURGE,
			(__u8 *)&purge_command, sizeof(purge_command));
L
Linus Torvalds 已提交
1271 1272 1273
}


A
Alan Cox 已提交
1274 1275
static int firm_get_dtr_rts(struct usb_serial_port *port)
{
L
Linus Torvalds 已提交
1276 1277 1278
	struct whiteheat_simple get_dr_command;

	get_dr_command.port = port->number - port->serial->minor + 1;
A
Alan Cox 已提交
1279 1280
	return firm_send_command(port, WHITEHEAT_GET_DTR_RTS,
			(__u8 *)&get_dr_command, sizeof(get_dr_command));
L
Linus Torvalds 已提交
1281 1282 1283
}


A
Alan Cox 已提交
1284 1285
static int firm_report_tx_done(struct usb_serial_port *port)
{
L
Linus Torvalds 已提交
1286 1287 1288
	struct whiteheat_simple close_command;

	close_command.port = port->number - port->serial->minor + 1;
A
Alan Cox 已提交
1289 1290
	return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE,
			(__u8 *)&close_command, sizeof(close_command));
L
Linus Torvalds 已提交
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
}


/*****************************************************************************
 * Connect Tech's White Heat utility functions
 *****************************************************************************/
static int start_command_port(struct usb_serial *serial)
{
	struct usb_serial_port *command_port;
	struct whiteheat_command_private *command_info;
	int retval = 0;
A
Alan Cox 已提交
1302

L
Linus Torvalds 已提交
1303 1304
	command_port = serial->port[COMMAND_PORT];
	command_info = usb_get_serial_port_data(command_port);
O
Oliver Neukum 已提交
1305
	mutex_lock(&command_info->mutex);
L
Linus Torvalds 已提交
1306 1307 1308 1309 1310 1311
	if (!command_info->port_running) {
		/* Work around HCD bugs */
		usb_clear_halt(serial->dev, command_port->read_urb->pipe);

		retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
		if (retval) {
1312 1313 1314
			dev_err(&serial->dev->dev,
				"%s - failed submitting read urb, error %d\n",
				__func__, retval);
L
Linus Torvalds 已提交
1315 1316 1317 1318 1319 1320
			goto exit;
		}
	}
	command_info->port_running++;

exit:
O
Oliver Neukum 已提交
1321
	mutex_unlock(&command_info->mutex);
L
Linus Torvalds 已提交
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
	return retval;
}


static void stop_command_port(struct usb_serial *serial)
{
	struct usb_serial_port *command_port;
	struct whiteheat_command_private *command_info;

	command_port = serial->port[COMMAND_PORT];
	command_info = usb_get_serial_port_data(command_port);
O
Oliver Neukum 已提交
1333
	mutex_lock(&command_info->mutex);
L
Linus Torvalds 已提交
1334 1335 1336
	command_info->port_running--;
	if (!command_info->port_running)
		usb_kill_urb(command_port->read_urb);
O
Oliver Neukum 已提交
1337
	mutex_unlock(&command_info->mutex);
L
Linus Torvalds 已提交
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
}


static int start_port_read(struct usb_serial_port *port)
{
	struct whiteheat_private *info = usb_get_serial_port_data(port);
	struct whiteheat_urb_wrap *wrap;
	struct urb *urb;
	int retval = 0;
	unsigned long flags;
	struct list_head *tmp;
	struct list_head *tmp2;

	spin_lock_irqsave(&info->lock, flags);

	list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
		list_del(tmp);
		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		urb = wrap->urb;
O
Oliver Neukum 已提交
1357
		spin_unlock_irqrestore(&info->lock, flags);
L
Linus Torvalds 已提交
1358 1359
		retval = usb_submit_urb(urb, GFP_KERNEL);
		if (retval) {
O
Oliver Neukum 已提交
1360
			spin_lock_irqsave(&info->lock, flags);
L
Linus Torvalds 已提交
1361 1362 1363 1364
			list_add(tmp, &info->rx_urbs_free);
			list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
				wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
				urb = wrap->urb;
O
Oliver Neukum 已提交
1365 1366
				list_del(tmp);
				spin_unlock_irqrestore(&info->lock, flags);
L
Linus Torvalds 已提交
1367
				usb_kill_urb(urb);
O
Oliver Neukum 已提交
1368 1369
				spin_lock_irqsave(&info->lock, flags);
				list_add(tmp, &info->rx_urbs_free);
L
Linus Torvalds 已提交
1370 1371 1372
			}
			break;
		}
O
Oliver Neukum 已提交
1373
		spin_lock_irqsave(&info->lock, flags);
L
Linus Torvalds 已提交
1374 1375 1376 1377 1378 1379 1380 1381 1382
		list_add(tmp, &info->rx_urbs_submitted);
	}

	spin_unlock_irqrestore(&info->lock, flags);

	return retval;
}


A
Alan Cox 已提交
1383 1384
static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb,
						struct list_head *head)
L
Linus Torvalds 已提交
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
{
	struct whiteheat_urb_wrap *wrap;
	struct list_head *tmp;

	list_for_each(tmp, head) {
		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		if (wrap->urb == urb)
			return wrap;
	}

	return NULL;
}


static struct list_head *list_first(struct list_head *head)
{
	return head->next;
}


D
David Howells 已提交
1405
static void rx_data_softint(struct work_struct *work)
L
Linus Torvalds 已提交
1406
{
D
David Howells 已提交
1407 1408 1409
	struct whiteheat_private *info =
		container_of(work, struct whiteheat_private, rx_work);
	struct usb_serial_port *port = info->port;
A
Alan Cox 已提交
1410
	struct tty_struct *tty = tty_port_tty_get(&port->port);
L
Linus Torvalds 已提交
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
	struct whiteheat_urb_wrap *wrap;
	struct urb *urb;
	unsigned long flags;
	struct list_head *tmp;
	struct list_head *tmp2;
	int result;
	int sent = 0;

	spin_lock_irqsave(&info->lock, flags);
	if (info->flags & THROTTLED) {
		spin_unlock_irqrestore(&info->lock, flags);
A
Alan Cox 已提交
1422
		goto out;
L
Linus Torvalds 已提交
1423 1424 1425 1426 1427 1428 1429 1430 1431
	}

	list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
		list_del(tmp);
		spin_unlock_irqrestore(&info->lock, flags);

		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
		urb = wrap->urb;

1432 1433 1434
		if (tty && urb->actual_length)
			sent += tty_insert_flip_string(tty,
				urb->transfer_buffer, urb->actual_length);
L
Linus Torvalds 已提交
1435 1436 1437

		result = usb_submit_urb(urb, GFP_ATOMIC);
		if (result) {
1438 1439
			dev_err(&port->dev,
				"%s - failed resubmitting read urb, error %d\n",
A
Alan Cox 已提交
1440
				__func__, result);
L
Linus Torvalds 已提交
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
			spin_lock_irqsave(&info->lock, flags);
			list_add(tmp, &info->rx_urbs_free);
			continue;
		}

		spin_lock_irqsave(&info->lock, flags);
		list_add(tmp, &info->rx_urbs_submitted);
	}
	spin_unlock_irqrestore(&info->lock, flags);

	if (sent)
		tty_flip_buffer_push(tty);
A
Alan Cox 已提交
1453 1454
out:
	tty_kref_put(tty);
L
Linus Torvalds 已提交
1455 1456 1457 1458 1459 1460
}


/*****************************************************************************
 * Connect Tech's White Heat module functions
 *****************************************************************************/
A
Alan Cox 已提交
1461
static int __init whiteheat_init(void)
L
Linus Torvalds 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
{
	int retval;
	retval = usb_serial_register(&whiteheat_fake_device);
	if (retval)
		goto failed_fake_register;
	retval = usb_serial_register(&whiteheat_device);
	if (retval)
		goto failed_device_register;
	retval = usb_register(&whiteheat_driver);
	if (retval)
		goto failed_usb_register;
1473 1474
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
	       DRIVER_DESC "\n");
L
Linus Torvalds 已提交
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
	return 0;
failed_usb_register:
	usb_serial_deregister(&whiteheat_device);
failed_device_register:
	usb_serial_deregister(&whiteheat_fake_device);
failed_fake_register:
	return retval;
}


A
Alan Cox 已提交
1485
static void __exit whiteheat_exit(void)
L
Linus Torvalds 已提交
1486
{
A
Alan Cox 已提交
1487 1488 1489
	usb_deregister(&whiteheat_driver);
	usb_serial_deregister(&whiteheat_fake_device);
	usb_serial_deregister(&whiteheat_device);
L
Linus Torvalds 已提交
1490 1491 1492 1493 1494 1495
}


module_init(whiteheat_init);
module_exit(whiteheat_exit);

A
Alan Cox 已提交
1496 1497
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
L
Linus Torvalds 已提交
1498 1499
MODULE_LICENSE("GPL");

1500 1501 1502
MODULE_FIRMWARE("whiteheat.fw");
MODULE_FIRMWARE("whiteheat_loader.fw");

L
Linus Torvalds 已提交
1503 1504 1505 1506 1507
module_param(urb_pool_size, int, 0);
MODULE_PARM_DESC(urb_pool_size, "Number of urbs to use for buffering");

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled or not");