• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /netgear-R7000-V1.0.7.12_1.2.5/components/opensource/linux/linux-2.6.36/drivers/usb/serial/
1/*
2 * USB ConnectTech WhiteHEAT driver
3 *
4 *	Copyright (C) 2002
5 *	    Connect Tech Inc.
6 *
7 *	Copyright (C) 1999 - 2001
8 *	    Greg Kroah-Hartman (greg@kroah.com)
9 *
10 *	This program is free software; you can redistribute it and/or modify
11 *	it under the terms of the GNU General Public License as published by
12 *	the Free Software Foundation; either version 2 of the License, or
13 *	(at your option) any later version.
14 *
15 * See Documentation/usb/usb-serial.txt for more information on using this
16 * driver
17 *
18 * (10/09/2002) Stuart MacDonald (stuartm@connecttech.com)
19 *	Upgrade to full working driver
20 *
21 * (05/30/2001) gkh
22 *	switched from using spinlock to a semaphore, which fixes lots of
23 *	problems.
24 *
25 * (04/08/2001) gb
26 *	Identify version on module load.
27 *
28 * 2001_Mar_19 gkh
29 *	Fixed MOD_INC and MOD_DEC logic, the ability to open a port more
30 *	than once, and the got the proper usb_device_id table entries so
31 *	the driver works again.
32 *
33 * (11/01/2000) Adam J. Richter
34 *	usb_device_id table support
35 *
36 * (10/05/2000) gkh
37 *	Fixed bug with urb->dev not being set properly, now that the usb
38 *	core needs it.
39 *
40 * (10/03/2000) smd
41 *	firmware is improved to guard against crap sent to device
42 *	firmware now replies CMD_FAILURE on bad things
43 *	read_callback fix you provided for private info struct
44 *	command_finished now indicates success or fail
45 *	setup_port struct now packed to avoid gcc padding
46 *	firmware uses 1 based port numbering, driver now handles that
47 *
48 * (09/11/2000) gkh
49 *	Removed DEBUG #ifdefs with call to usb_serial_debug_data
50 *
51 * (07/19/2000) gkh
52 *	Added module_init and module_exit functions to handle the fact that this
53 *	driver is a loadable module now.
54 *	Fixed bug with port->minor that was found by Al Borchers
55 *
56 * (07/04/2000) gkh
57 *	Added support for port settings. Baud rate can now be changed. Line
58 *	signals are not transferred to and from the tty layer yet, but things
59 *	seem to be working well now.
60 *
61 * (05/04/2000) gkh
62 *	First cut at open and close commands. Data can flow through the ports at
63 *	default speeds now.
64 *
65 * (03/26/2000) gkh
66 *	Split driver up into device specific pieces.
67 *
68 */
69
70#include <linux/kernel.h>
71#include <linux/errno.h>
72#include <linux/init.h>
73#include <linux/slab.h>
74#include <linux/tty.h>
75#include <linux/tty_driver.h>
76#include <linux/tty_flip.h>
77#include <linux/module.h>
78#include <linux/spinlock.h>
79#include <linux/mutex.h>
80#include <linux/uaccess.h>
81#include <asm/termbits.h>
82#include <linux/usb.h>
83#include <linux/serial_reg.h>
84#include <linux/serial.h>
85#include <linux/usb/serial.h>
86#include <linux/firmware.h>
87#include <linux/ihex.h>
88#include "whiteheat.h"			/* WhiteHEAT specific commands */
89
90static int debug;
91
92#ifndef CMSPAR
93#define CMSPAR 0
94#endif
95
96/*
97 * Version Information
98 */
99#define DRIVER_VERSION "v2.0"
100#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
101#define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
102
103#define CONNECT_TECH_VENDOR_ID		0x0710
104#define CONNECT_TECH_FAKE_WHITE_HEAT_ID	0x0001
105#define CONNECT_TECH_WHITE_HEAT_ID	0x8001
106
107/*
108   ID tables for whiteheat are unusual, because we want to different
109   things for different versions of the device.  Eventually, this
110   will be doable from a single table.  But, for now, we define two
111   separate ID tables, and then a third table that combines them
112   just for the purpose of exporting the autoloading information.
113*/
114static const struct usb_device_id id_table_std[] = {
115	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
116	{ }						/* Terminating entry */
117};
118
119static const struct usb_device_id id_table_prerenumeration[] = {
120	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
121	{ }						/* Terminating entry */
122};
123
124static const struct usb_device_id id_table_combined[] = {
125	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
126	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
127	{ }						/* Terminating entry */
128};
129
130MODULE_DEVICE_TABLE(usb, id_table_combined);
131
132static struct usb_driver whiteheat_driver = {
133	.name =		"whiteheat",
134	.probe =	usb_serial_probe,
135	.disconnect =	usb_serial_disconnect,
136	.id_table =	id_table_combined,
137	.no_dynamic_id = 	1,
138};
139
140/* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
141static int  whiteheat_firmware_download(struct usb_serial *serial,
142					const struct usb_device_id *id);
143static int  whiteheat_firmware_attach(struct usb_serial *serial);
144
145/* function prototypes for the Connect Tech WhiteHEAT serial converter */
146static int  whiteheat_attach(struct usb_serial *serial);
147static void whiteheat_release(struct usb_serial *serial);
148static int  whiteheat_open(struct tty_struct *tty,
149			struct usb_serial_port *port);
150static void whiteheat_close(struct usb_serial_port *port);
151static int  whiteheat_write(struct tty_struct *tty,
152			struct usb_serial_port *port,
153			const unsigned char *buf, int count);
154static int  whiteheat_write_room(struct tty_struct *tty);
155static int  whiteheat_ioctl(struct tty_struct *tty, struct file *file,
156			unsigned int cmd, unsigned long arg);
157static void whiteheat_set_termios(struct tty_struct *tty,
158			struct usb_serial_port *port, struct ktermios *old);
159static int  whiteheat_tiocmget(struct tty_struct *tty, struct file *file);
160static int  whiteheat_tiocmset(struct tty_struct *tty, struct file *file,
161			unsigned int set, unsigned int clear);
162static void whiteheat_break_ctl(struct tty_struct *tty, int break_state);
163static int  whiteheat_chars_in_buffer(struct tty_struct *tty);
164static void whiteheat_throttle(struct tty_struct *tty);
165static void whiteheat_unthrottle(struct tty_struct *tty);
166static void whiteheat_read_callback(struct urb *urb);
167static void whiteheat_write_callback(struct urb *urb);
168
169static struct usb_serial_driver whiteheat_fake_device = {
170	.driver = {
171		.owner =	THIS_MODULE,
172		.name =		"whiteheatnofirm",
173	},
174	.description =		"Connect Tech - WhiteHEAT - (prerenumeration)",
175	.usb_driver =		&whiteheat_driver,
176	.id_table =		id_table_prerenumeration,
177	.num_ports =		1,
178	.probe =		whiteheat_firmware_download,
179	.attach =		whiteheat_firmware_attach,
180};
181
182static struct usb_serial_driver whiteheat_device = {
183	.driver = {
184		.owner =	THIS_MODULE,
185		.name =		"whiteheat",
186	},
187	.description =		"Connect Tech - WhiteHEAT",
188	.usb_driver =		&whiteheat_driver,
189	.id_table =		id_table_std,
190	.num_ports =		4,
191	.attach =		whiteheat_attach,
192	.release =		whiteheat_release,
193	.open =			whiteheat_open,
194	.close =		whiteheat_close,
195	.write =		whiteheat_write,
196	.write_room =		whiteheat_write_room,
197	.ioctl =		whiteheat_ioctl,
198	.set_termios =		whiteheat_set_termios,
199	.break_ctl =		whiteheat_break_ctl,
200	.tiocmget =		whiteheat_tiocmget,
201	.tiocmset =		whiteheat_tiocmset,
202	.chars_in_buffer =	whiteheat_chars_in_buffer,
203	.throttle =		whiteheat_throttle,
204	.unthrottle =		whiteheat_unthrottle,
205	.read_bulk_callback =	whiteheat_read_callback,
206	.write_bulk_callback =	whiteheat_write_callback,
207};
208
209
210struct whiteheat_command_private {
211	struct mutex		mutex;
212	__u8			port_running;
213	__u8			command_finished;
214	wait_queue_head_t	wait_command; /* for handling sleeping whilst
215						 waiting for a command to
216						 finish */
217	__u8			result_buffer[64];
218};
219
220
221#define THROTTLED		0x01
222#define ACTUALLY_THROTTLED	0x02
223
224static int urb_pool_size = 8;
225
226struct whiteheat_urb_wrap {
227	struct list_head	list;
228	struct urb		*urb;
229};
230
231struct whiteheat_private {
232	spinlock_t		lock;
233	__u8			flags;
234	__u8			mcr;
235	struct list_head	rx_urbs_free;
236	struct list_head	rx_urbs_submitted;
237	struct list_head	rx_urb_q;
238	struct work_struct	rx_work;
239	struct usb_serial_port	*port;
240	struct list_head	tx_urbs_free;
241	struct list_head	tx_urbs_submitted;
242	struct mutex		deathwarrant;
243};
244
245
246/* local function prototypes */
247static int start_command_port(struct usb_serial *serial);
248static void stop_command_port(struct usb_serial *serial);
249static void command_port_write_callback(struct urb *urb);
250static void command_port_read_callback(struct urb *urb);
251
252static int start_port_read(struct usb_serial_port *port);
253static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb,
254						struct list_head *head);
255static struct list_head *list_first(struct list_head *head);
256static void rx_data_softint(struct work_struct *work);
257
258static int firm_send_command(struct usb_serial_port *port, __u8 command,
259						__u8 *data, __u8 datasize);
260static int firm_open(struct usb_serial_port *port);
261static int firm_close(struct usb_serial_port *port);
262static void firm_setup_port(struct tty_struct *tty);
263static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
264static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
265static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
266static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
267static int firm_get_dtr_rts(struct usb_serial_port *port);
268static int firm_report_tx_done(struct usb_serial_port *port);
269
270
271#define COMMAND_PORT		4
272#define COMMAND_TIMEOUT		(2*HZ)	/* 2 second timeout for a command */
273#define	COMMAND_TIMEOUT_MS	2000
274#define CLOSING_DELAY		(30 * HZ)
275
276
277/*****************************************************************************
278 * Connect Tech's White Heat prerenumeration driver functions
279 *****************************************************************************/
280
281/* steps to download the firmware to the WhiteHEAT device:
282 - hold the reset (by writing to the reset bit of the CPUCS register)
283 - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
284 - release the reset (by writing to the CPUCS register)
285 - download the WH.HEX file for all addresses greater than 0x1b3f using
286   VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
287 - hold the reset
288 - download the WH.HEX file for all addresses less than 0x1b40 using
289   VENDOR_REQUEST_ANCHOR_LOAD
290 - release the reset
291 - device renumerated itself and comes up as new device id with all
292   firmware download completed.
293*/
294static int whiteheat_firmware_download(struct usb_serial *serial,
295					const struct usb_device_id *id)
296{
297	int response, ret = -ENOENT;
298	const struct firmware *loader_fw = NULL, *firmware_fw = NULL;
299	const struct ihex_binrec *record;
300
301	dbg("%s", __func__);
302
303	if (request_ihex_firmware(&firmware_fw, "whiteheat.fw",
304				  &serial->dev->dev)) {
305		dev_err(&serial->dev->dev,
306			"%s - request \"whiteheat.fw\" failed\n", __func__);
307		goto out;
308	}
309	if (request_ihex_firmware(&loader_fw, "whiteheat_loader.fw",
310			     &serial->dev->dev)) {
311		dev_err(&serial->dev->dev,
312			"%s - request \"whiteheat_loader.fw\" failed\n",
313			__func__);
314		goto out;
315	}
316	ret = 0;
317	response = ezusb_set_reset (serial, 1);
318
319	record = (const struct ihex_binrec *)loader_fw->data;
320	while (record) {
321		response = ezusb_writememory (serial, be32_to_cpu(record->addr),
322					      (unsigned char *)record->data,
323					      be16_to_cpu(record->len), 0xa0);
324		if (response < 0) {
325			dev_err(&serial->dev->dev, "%s - ezusb_writememory "
326				"failed for loader (%d %04X %p %d)\n",
327				__func__, response, be32_to_cpu(record->addr),
328				record->data, be16_to_cpu(record->len));
329			break;
330		}
331		record = ihex_next_binrec(record);
332	}
333
334	response = ezusb_set_reset(serial, 0);
335
336	record = (const struct ihex_binrec *)firmware_fw->data;
337	while (record && be32_to_cpu(record->addr) < 0x1b40)
338		record = ihex_next_binrec(record);
339	while (record) {
340		response = ezusb_writememory (serial, be32_to_cpu(record->addr),
341					      (unsigned char *)record->data,
342					      be16_to_cpu(record->len), 0xa3);
343		if (response < 0) {
344			dev_err(&serial->dev->dev, "%s - ezusb_writememory "
345				"failed for first firmware step "
346				"(%d %04X %p %d)\n", __func__, response,
347				be32_to_cpu(record->addr), record->data,
348				be16_to_cpu(record->len));
349			break;
350		}
351		++record;
352	}
353
354	response = ezusb_set_reset(serial, 1);
355
356	record = (const struct ihex_binrec *)firmware_fw->data;
357	while (record && be32_to_cpu(record->addr) < 0x1b40) {
358		response = ezusb_writememory (serial, be32_to_cpu(record->addr),
359					      (unsigned char *)record->data,
360					      be16_to_cpu(record->len), 0xa0);
361		if (response < 0) {
362			dev_err(&serial->dev->dev, "%s - ezusb_writememory "
363				"failed for second firmware step "
364				"(%d %04X %p %d)\n", __func__, response,
365				be32_to_cpu(record->addr), record->data,
366				be16_to_cpu(record->len));
367			break;
368		}
369		++record;
370	}
371	ret = 0;
372	response = ezusb_set_reset (serial, 0);
373 out:
374	release_firmware(loader_fw);
375	release_firmware(firmware_fw);
376	return ret;
377}
378
379
380static int whiteheat_firmware_attach(struct usb_serial *serial)
381{
382	/* We want this device to fail to have a driver assigned to it */
383	return 1;
384}
385
386
387/*****************************************************************************
388 * Connect Tech's White Heat serial driver functions
389 *****************************************************************************/
390static int whiteheat_attach(struct usb_serial *serial)
391{
392	struct usb_serial_port *command_port;
393	struct whiteheat_command_private *command_info;
394	struct usb_serial_port *port;
395	struct whiteheat_private *info;
396	struct whiteheat_hw_info *hw_info;
397	int pipe;
398	int ret;
399	int alen;
400	__u8 *command;
401	__u8 *result;
402	int i;
403	int j;
404	struct urb *urb;
405	int buf_size;
406	struct whiteheat_urb_wrap *wrap;
407	struct list_head *tmp;
408
409	command_port = serial->port[COMMAND_PORT];
410
411	pipe = usb_sndbulkpipe(serial->dev,
412			command_port->bulk_out_endpointAddress);
413	command = kmalloc(2, GFP_KERNEL);
414	if (!command)
415		goto no_command_buffer;
416	command[0] = WHITEHEAT_GET_HW_INFO;
417	command[1] = 0;
418
419	result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
420	if (!result)
421		goto no_result_buffer;
422	/*
423	 * When the module is reloaded the firmware is still there and
424	 * the endpoints are still in the usb core unchanged. This is the
425	 * unlinking bug in disguise. Same for the call below.
426	 */
427	usb_clear_halt(serial->dev, pipe);
428	ret = usb_bulk_msg(serial->dev, pipe, command, 2,
429						&alen, COMMAND_TIMEOUT_MS);
430	if (ret) {
431		dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n",
432			serial->type->description, ret);
433		goto no_firmware;
434	} else if (alen != 2) {
435		dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n",
436			serial->type->description, alen);
437		goto no_firmware;
438	}
439
440	pipe = usb_rcvbulkpipe(serial->dev,
441				command_port->bulk_in_endpointAddress);
442	/* See the comment on the usb_clear_halt() above */
443	usb_clear_halt(serial->dev, pipe);
444	ret = usb_bulk_msg(serial->dev, pipe, result,
445			sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
446	if (ret) {
447		dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n",
448			serial->type->description, ret);
449		goto no_firmware;
450	} else if (alen != sizeof(*hw_info) + 1) {
451		dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n",
452			serial->type->description, alen);
453		goto no_firmware;
454	} else if (result[0] != command[0]) {
455		dev_err(&serial->dev->dev, "%s: Command failed [%d]\n",
456			serial->type->description, result[0]);
457		goto no_firmware;
458	}
459
460	hw_info = (struct whiteheat_hw_info *)&result[1];
461
462	dev_info(&serial->dev->dev, "%s: Driver %s: Firmware v%d.%02d\n",
463		 serial->type->description, DRIVER_VERSION,
464		 hw_info->sw_major_rev, hw_info->sw_minor_rev);
465
466	for (i = 0; i < serial->num_ports; i++) {
467		port = serial->port[i];
468
469		info = kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
470		if (info == NULL) {
471			dev_err(&port->dev,
472				"%s: Out of memory for port structures\n",
473				serial->type->description);
474			goto no_private;
475		}
476
477		spin_lock_init(&info->lock);
478		mutex_init(&info->deathwarrant);
479		info->flags = 0;
480		info->mcr = 0;
481		INIT_WORK(&info->rx_work, rx_data_softint);
482		info->port = port;
483
484		INIT_LIST_HEAD(&info->rx_urbs_free);
485		INIT_LIST_HEAD(&info->rx_urbs_submitted);
486		INIT_LIST_HEAD(&info->rx_urb_q);
487		INIT_LIST_HEAD(&info->tx_urbs_free);
488		INIT_LIST_HEAD(&info->tx_urbs_submitted);
489
490		for (j = 0; j < urb_pool_size; j++) {
491			urb = usb_alloc_urb(0, GFP_KERNEL);
492			if (!urb) {
493				dev_err(&port->dev, "No free urbs available\n");
494				goto no_rx_urb;
495			}
496			buf_size = port->read_urb->transfer_buffer_length;
497			urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
498			if (!urb->transfer_buffer) {
499				dev_err(&port->dev,
500					"Couldn't allocate urb buffer\n");
501				goto no_rx_buf;
502			}
503			wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
504			if (!wrap) {
505				dev_err(&port->dev,
506					"Couldn't allocate urb wrapper\n");
507				goto no_rx_wrap;
508			}
509			usb_fill_bulk_urb(urb, serial->dev,
510					usb_rcvbulkpipe(serial->dev,
511						port->bulk_in_endpointAddress),
512					urb->transfer_buffer, buf_size,
513					whiteheat_read_callback, port);
514			wrap->urb = urb;
515			list_add(&wrap->list, &info->rx_urbs_free);
516
517			urb = usb_alloc_urb(0, GFP_KERNEL);
518			if (!urb) {
519				dev_err(&port->dev, "No free urbs available\n");
520				goto no_tx_urb;
521			}
522			buf_size = port->write_urb->transfer_buffer_length;
523			urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
524			if (!urb->transfer_buffer) {
525				dev_err(&port->dev,
526					"Couldn't allocate urb buffer\n");
527				goto no_tx_buf;
528			}
529			wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
530			if (!wrap) {
531				dev_err(&port->dev,
532					"Couldn't allocate urb wrapper\n");
533				goto no_tx_wrap;
534			}
535			usb_fill_bulk_urb(urb, serial->dev,
536					usb_sndbulkpipe(serial->dev,
537						port->bulk_out_endpointAddress),
538					urb->transfer_buffer, buf_size,
539					whiteheat_write_callback, port);
540			wrap->urb = urb;
541			list_add(&wrap->list, &info->tx_urbs_free);
542		}
543
544		usb_set_serial_port_data(port, info);
545	}
546
547	command_info = kmalloc(sizeof(struct whiteheat_command_private),
548								GFP_KERNEL);
549	if (command_info == NULL) {
550		dev_err(&serial->dev->dev,
551			"%s: Out of memory for port structures\n",
552			serial->type->description);
553		goto no_command_private;
554	}
555
556	mutex_init(&command_info->mutex);
557	command_info->port_running = 0;
558	init_waitqueue_head(&command_info->wait_command);
559	usb_set_serial_port_data(command_port, command_info);
560	command_port->write_urb->complete = command_port_write_callback;
561	command_port->read_urb->complete = command_port_read_callback;
562	kfree(result);
563	kfree(command);
564
565	return 0;
566
567no_firmware:
568	/* Firmware likely not running */
569	dev_err(&serial->dev->dev,
570		"%s: Unable to retrieve firmware version, try replugging\n",
571		serial->type->description);
572	dev_err(&serial->dev->dev,
573		"%s: If the firmware is not running (status led not blinking)\n",
574		serial->type->description);
575	dev_err(&serial->dev->dev,
576		"%s: please contact support@connecttech.com\n",
577		serial->type->description);
578	kfree(result);
579	return -ENODEV;
580
581no_command_private:
582	for (i = serial->num_ports - 1; i >= 0; i--) {
583		port = serial->port[i];
584		info = usb_get_serial_port_data(port);
585		for (j = urb_pool_size - 1; j >= 0; j--) {
586			tmp = list_first(&info->tx_urbs_free);
587			list_del(tmp);
588			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
589			urb = wrap->urb;
590			kfree(wrap);
591no_tx_wrap:
592			kfree(urb->transfer_buffer);
593no_tx_buf:
594			usb_free_urb(urb);
595no_tx_urb:
596			tmp = list_first(&info->rx_urbs_free);
597			list_del(tmp);
598			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
599			urb = wrap->urb;
600			kfree(wrap);
601no_rx_wrap:
602			kfree(urb->transfer_buffer);
603no_rx_buf:
604			usb_free_urb(urb);
605no_rx_urb:
606			;
607		}
608		kfree(info);
609no_private:
610		;
611	}
612	kfree(result);
613no_result_buffer:
614	kfree(command);
615no_command_buffer:
616	return -ENOMEM;
617}
618
619
620static void whiteheat_release(struct usb_serial *serial)
621{
622	struct usb_serial_port *command_port;
623	struct usb_serial_port *port;
624	struct whiteheat_private *info;
625	struct whiteheat_urb_wrap *wrap;
626	struct urb *urb;
627	struct list_head *tmp;
628	struct list_head *tmp2;
629	int i;
630
631	dbg("%s", __func__);
632
633	/* free up our private data for our command port */
634	command_port = serial->port[COMMAND_PORT];
635	kfree(usb_get_serial_port_data(command_port));
636
637	for (i = 0; i < serial->num_ports; i++) {
638		port = serial->port[i];
639		info = usb_get_serial_port_data(port);
640		list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
641			list_del(tmp);
642			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
643			urb = wrap->urb;
644			kfree(wrap);
645			kfree(urb->transfer_buffer);
646			usb_free_urb(urb);
647		}
648		list_for_each_safe(tmp, tmp2, &info->tx_urbs_free) {
649			list_del(tmp);
650			wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
651			urb = wrap->urb;
652			kfree(wrap);
653			kfree(urb->transfer_buffer);
654			usb_free_urb(urb);
655		}
656		kfree(info);
657	}
658
659	return;
660}
661
662static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port)
663{
664	int		retval = 0;
665
666	dbg("%s - port %d", __func__, port->number);
667
668	retval = start_command_port(port->serial);
669	if (retval)
670		goto exit;
671
672	if (tty)
673		tty->low_latency = 1;
674
675	/* send an open port command */
676	retval = firm_open(port);
677	if (retval) {
678		stop_command_port(port->serial);
679		goto exit;
680	}
681
682	retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
683	if (retval) {
684		firm_close(port);
685		stop_command_port(port->serial);
686		goto exit;
687	}
688
689	if (tty)
690		firm_setup_port(tty);
691
692	usb_clear_halt(port->serial->dev, port->read_urb->pipe);
693	usb_clear_halt(port->serial->dev, port->write_urb->pipe);
694
695	/* Start reading from the device */
696	retval = start_port_read(port);
697	if (retval) {
698		dev_err(&port->dev,
699			"%s - failed submitting read urb, error %d\n",
700			__func__, retval);
701		firm_close(port);
702		stop_command_port(port->serial);
703		goto exit;
704	}
705
706exit:
707	dbg("%s - exit, retval = %d", __func__, retval);
708	return retval;
709}
710
711
712static void whiteheat_close(struct usb_serial_port *port)
713{
714	struct whiteheat_private *info = usb_get_serial_port_data(port);
715	struct whiteheat_urb_wrap *wrap;
716	struct urb *urb;
717	struct list_head *tmp;
718	struct list_head *tmp2;
719
720	dbg("%s - port %d", __func__, port->number);
721
722	firm_report_tx_done(port);
723	firm_close(port);
724
725	/* shutdown our bulk reads and writes */
726	mutex_lock(&info->deathwarrant);
727	spin_lock_irq(&info->lock);
728	list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
729		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
730		urb = wrap->urb;
731		list_del(tmp);
732		spin_unlock_irq(&info->lock);
733		usb_kill_urb(urb);
734		spin_lock_irq(&info->lock);
735		list_add(tmp, &info->rx_urbs_free);
736	}
737	list_for_each_safe(tmp, tmp2, &info->rx_urb_q)
738		list_move(tmp, &info->rx_urbs_free);
739	list_for_each_safe(tmp, tmp2, &info->tx_urbs_submitted) {
740		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
741		urb = wrap->urb;
742		list_del(tmp);
743		spin_unlock_irq(&info->lock);
744		usb_kill_urb(urb);
745		spin_lock_irq(&info->lock);
746		list_add(tmp, &info->tx_urbs_free);
747	}
748	spin_unlock_irq(&info->lock);
749	mutex_unlock(&info->deathwarrant);
750	stop_command_port(port->serial);
751}
752
753
754static int whiteheat_write(struct tty_struct *tty,
755	struct usb_serial_port *port, const unsigned char *buf, int count)
756{
757	struct usb_serial *serial = port->serial;
758	struct whiteheat_private *info = usb_get_serial_port_data(port);
759	struct whiteheat_urb_wrap *wrap;
760	struct urb *urb;
761	int result;
762	int bytes;
763	int sent = 0;
764	unsigned long flags;
765	struct list_head *tmp;
766
767	dbg("%s - port %d", __func__, port->number);
768
769	if (count == 0) {
770		dbg("%s - write request of 0 bytes", __func__);
771		return (0);
772	}
773
774	while (count) {
775		spin_lock_irqsave(&info->lock, flags);
776		if (list_empty(&info->tx_urbs_free)) {
777			spin_unlock_irqrestore(&info->lock, flags);
778			break;
779		}
780		tmp = list_first(&info->tx_urbs_free);
781		list_del(tmp);
782		spin_unlock_irqrestore(&info->lock, flags);
783
784		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
785		urb = wrap->urb;
786		bytes = (count > port->bulk_out_size) ?
787					port->bulk_out_size : count;
788		memcpy(urb->transfer_buffer, buf + sent, bytes);
789
790		usb_serial_debug_data(debug, &port->dev,
791				__func__, bytes, urb->transfer_buffer);
792
793		urb->dev = serial->dev;
794		urb->transfer_buffer_length = bytes;
795		result = usb_submit_urb(urb, GFP_ATOMIC);
796		if (result) {
797			dev_err(&port->dev,
798				"%s - failed submitting write urb, error %d\n",
799				__func__, result);
800			sent = result;
801			spin_lock_irqsave(&info->lock, flags);
802			list_add(tmp, &info->tx_urbs_free);
803			spin_unlock_irqrestore(&info->lock, flags);
804			break;
805		} else {
806			sent += bytes;
807			count -= bytes;
808			spin_lock_irqsave(&info->lock, flags);
809			list_add(tmp, &info->tx_urbs_submitted);
810			spin_unlock_irqrestore(&info->lock, flags);
811		}
812	}
813
814	return sent;
815}
816
817static int whiteheat_write_room(struct tty_struct *tty)
818{
819	struct usb_serial_port *port = tty->driver_data;
820	struct whiteheat_private *info = usb_get_serial_port_data(port);
821	struct list_head *tmp;
822	int room = 0;
823	unsigned long flags;
824
825	dbg("%s - port %d", __func__, port->number);
826
827	spin_lock_irqsave(&info->lock, flags);
828	list_for_each(tmp, &info->tx_urbs_free)
829		room++;
830	spin_unlock_irqrestore(&info->lock, flags);
831	room *= port->bulk_out_size;
832
833	dbg("%s - returns %d", __func__, room);
834	return (room);
835}
836
837static int whiteheat_tiocmget(struct tty_struct *tty, struct file *file)
838{
839	struct usb_serial_port *port = tty->driver_data;
840	struct whiteheat_private *info = usb_get_serial_port_data(port);
841	unsigned int modem_signals = 0;
842
843	dbg("%s - port %d", __func__, port->number);
844
845	firm_get_dtr_rts(port);
846	if (info->mcr & UART_MCR_DTR)
847		modem_signals |= TIOCM_DTR;
848	if (info->mcr & UART_MCR_RTS)
849		modem_signals |= TIOCM_RTS;
850
851	return modem_signals;
852}
853
854static int whiteheat_tiocmset(struct tty_struct *tty, struct file *file,
855			       unsigned int set, unsigned int clear)
856{
857	struct usb_serial_port *port = tty->driver_data;
858	struct whiteheat_private *info = usb_get_serial_port_data(port);
859
860	dbg("%s - port %d", __func__, port->number);
861
862	if (set & TIOCM_RTS)
863		info->mcr |= UART_MCR_RTS;
864	if (set & TIOCM_DTR)
865		info->mcr |= UART_MCR_DTR;
866
867	if (clear & TIOCM_RTS)
868		info->mcr &= ~UART_MCR_RTS;
869	if (clear & TIOCM_DTR)
870		info->mcr &= ~UART_MCR_DTR;
871
872	firm_set_dtr(port, info->mcr & UART_MCR_DTR);
873	firm_set_rts(port, info->mcr & UART_MCR_RTS);
874	return 0;
875}
876
877
878static int whiteheat_ioctl(struct tty_struct *tty, struct file *file,
879					unsigned int cmd, unsigned long arg)
880{
881	struct usb_serial_port *port = tty->driver_data;
882	struct serial_struct serstruct;
883	void __user *user_arg = (void __user *)arg;
884
885	dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
886
887	switch (cmd) {
888	case TIOCGSERIAL:
889		memset(&serstruct, 0, sizeof(serstruct));
890		serstruct.type = PORT_16654;
891		serstruct.line = port->serial->minor;
892		serstruct.port = port->number;
893		serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
894		serstruct.xmit_fifo_size = port->bulk_out_size;
895		serstruct.custom_divisor = 0;
896		serstruct.baud_base = 460800;
897		serstruct.close_delay = CLOSING_DELAY;
898		serstruct.closing_wait = CLOSING_DELAY;
899
900		if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
901			return -EFAULT;
902		break;
903	default:
904		break;
905	}
906
907	return -ENOIOCTLCMD;
908}
909
910
911static void whiteheat_set_termios(struct tty_struct *tty,
912	struct usb_serial_port *port, struct ktermios *old_termios)
913{
914	firm_setup_port(tty);
915}
916
917static void whiteheat_break_ctl(struct tty_struct *tty, int break_state)
918{
919	struct usb_serial_port *port = tty->driver_data;
920	firm_set_break(port, break_state);
921}
922
923
924static int whiteheat_chars_in_buffer(struct tty_struct *tty)
925{
926	struct usb_serial_port *port = tty->driver_data;
927	struct whiteheat_private *info = usb_get_serial_port_data(port);
928	struct list_head *tmp;
929	struct whiteheat_urb_wrap *wrap;
930	int chars = 0;
931	unsigned long flags;
932
933	dbg("%s - port %d", __func__, port->number);
934
935	spin_lock_irqsave(&info->lock, flags);
936	list_for_each(tmp, &info->tx_urbs_submitted) {
937		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
938		chars += wrap->urb->transfer_buffer_length;
939	}
940	spin_unlock_irqrestore(&info->lock, flags);
941
942	dbg("%s - returns %d", __func__, chars);
943	return chars;
944}
945
946
947static void whiteheat_throttle(struct tty_struct *tty)
948{
949	struct usb_serial_port *port = tty->driver_data;
950	struct whiteheat_private *info = usb_get_serial_port_data(port);
951
952	dbg("%s - port %d", __func__, port->number);
953
954	spin_lock_irq(&info->lock);
955	info->flags |= THROTTLED;
956	spin_unlock_irq(&info->lock);
957
958	return;
959}
960
961
962static void whiteheat_unthrottle(struct tty_struct *tty)
963{
964	struct usb_serial_port *port = tty->driver_data;
965	struct whiteheat_private *info = usb_get_serial_port_data(port);
966	int actually_throttled;
967
968	dbg("%s - port %d", __func__, port->number);
969
970	spin_lock_irq(&info->lock);
971	actually_throttled = info->flags & ACTUALLY_THROTTLED;
972	info->flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
973	spin_unlock_irq(&info->lock);
974
975	if (actually_throttled)
976		rx_data_softint(&info->rx_work);
977
978	return;
979}
980
981
982/*****************************************************************************
983 * Connect Tech's White Heat callback routines
984 *****************************************************************************/
985static void command_port_write_callback(struct urb *urb)
986{
987	int status = urb->status;
988
989	dbg("%s", __func__);
990
991	if (status) {
992		dbg("nonzero urb status: %d", status);
993		return;
994	}
995}
996
997
998static void command_port_read_callback(struct urb *urb)
999{
1000	struct usb_serial_port *command_port = urb->context;
1001	struct whiteheat_command_private *command_info;
1002	int status = urb->status;
1003	unsigned char *data = urb->transfer_buffer;
1004	int result;
1005
1006	dbg("%s", __func__);
1007
1008	command_info = usb_get_serial_port_data(command_port);
1009	if (!command_info) {
1010		dbg("%s - command_info is NULL, exiting.", __func__);
1011		return;
1012	}
1013	if (status) {
1014		dbg("%s - nonzero urb status: %d", __func__, status);
1015		if (status != -ENOENT)
1016			command_info->command_finished = WHITEHEAT_CMD_FAILURE;
1017		wake_up(&command_info->wait_command);
1018		return;
1019	}
1020
1021	usb_serial_debug_data(debug, &command_port->dev,
1022				__func__, urb->actual_length, data);
1023
1024	if (data[0] == WHITEHEAT_CMD_COMPLETE) {
1025		command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1026		wake_up(&command_info->wait_command);
1027	} else if (data[0] == WHITEHEAT_CMD_FAILURE) {
1028		command_info->command_finished = WHITEHEAT_CMD_FAILURE;
1029		wake_up(&command_info->wait_command);
1030	} else if (data[0] == WHITEHEAT_EVENT) {
1031		/* These are unsolicited reports from the firmware, hence no
1032		   waiting command to wakeup */
1033		dbg("%s - event received", __func__);
1034	} else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
1035		memcpy(command_info->result_buffer, &data[1],
1036						urb->actual_length - 1);
1037		command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1038		wake_up(&command_info->wait_command);
1039	} else
1040		dbg("%s - bad reply from firmware", __func__);
1041
1042	/* Continue trying to always read */
1043	command_port->read_urb->dev = command_port->serial->dev;
1044	result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
1045	if (result)
1046		dbg("%s - failed resubmitting read urb, error %d",
1047			__func__, result);
1048}
1049
1050
1051static void whiteheat_read_callback(struct urb *urb)
1052{
1053	struct usb_serial_port *port = urb->context;
1054	struct whiteheat_urb_wrap *wrap;
1055	unsigned char *data = urb->transfer_buffer;
1056	struct whiteheat_private *info = usb_get_serial_port_data(port);
1057	int status = urb->status;
1058
1059	dbg("%s - port %d", __func__, port->number);
1060
1061	spin_lock(&info->lock);
1062	wrap = urb_to_wrap(urb, &info->rx_urbs_submitted);
1063	if (!wrap) {
1064		spin_unlock(&info->lock);
1065		dev_err(&port->dev, "%s - Not my urb!\n", __func__);
1066		return;
1067	}
1068	list_del(&wrap->list);
1069	spin_unlock(&info->lock);
1070
1071	if (status) {
1072		dbg("%s - nonzero read bulk status received: %d",
1073		    __func__, status);
1074		spin_lock(&info->lock);
1075		list_add(&wrap->list, &info->rx_urbs_free);
1076		spin_unlock(&info->lock);
1077		return;
1078	}
1079
1080	usb_serial_debug_data(debug, &port->dev,
1081				__func__, urb->actual_length, data);
1082
1083	spin_lock(&info->lock);
1084	list_add_tail(&wrap->list, &info->rx_urb_q);
1085	if (info->flags & THROTTLED) {
1086		info->flags |= ACTUALLY_THROTTLED;
1087		spin_unlock(&info->lock);
1088		return;
1089	}
1090	spin_unlock(&info->lock);
1091
1092	schedule_work(&info->rx_work);
1093}
1094
1095
1096static void whiteheat_write_callback(struct urb *urb)
1097{
1098	struct usb_serial_port *port = urb->context;
1099	struct whiteheat_private *info = usb_get_serial_port_data(port);
1100	struct whiteheat_urb_wrap *wrap;
1101	int status = urb->status;
1102
1103	dbg("%s - port %d", __func__, port->number);
1104
1105	spin_lock(&info->lock);
1106	wrap = urb_to_wrap(urb, &info->tx_urbs_submitted);
1107	if (!wrap) {
1108		spin_unlock(&info->lock);
1109		dev_err(&port->dev, "%s - Not my urb!\n", __func__);
1110		return;
1111	}
1112	list_move(&wrap->list, &info->tx_urbs_free);
1113	spin_unlock(&info->lock);
1114
1115	if (status) {
1116		dbg("%s - nonzero write bulk status received: %d",
1117		    __func__, status);
1118		return;
1119	}
1120
1121	usb_serial_port_softint(port);
1122}
1123
1124
1125/*****************************************************************************
1126 * Connect Tech's White Heat firmware interface
1127 *****************************************************************************/
1128static int firm_send_command(struct usb_serial_port *port, __u8 command,
1129						__u8 *data, __u8 datasize)
1130{
1131	struct usb_serial_port *command_port;
1132	struct whiteheat_command_private *command_info;
1133	struct whiteheat_private *info;
1134	__u8 *transfer_buffer;
1135	int retval = 0;
1136	int t;
1137
1138	dbg("%s - command %d", __func__, command);
1139
1140	command_port = port->serial->port[COMMAND_PORT];
1141	command_info = usb_get_serial_port_data(command_port);
1142	mutex_lock(&command_info->mutex);
1143	command_info->command_finished = false;
1144
1145	transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
1146	transfer_buffer[0] = command;
1147	memcpy(&transfer_buffer[1], data, datasize);
1148	command_port->write_urb->transfer_buffer_length = datasize + 1;
1149	command_port->write_urb->dev = port->serial->dev;
1150	retval = usb_submit_urb(command_port->write_urb, GFP_NOIO);
1151	if (retval) {
1152		dbg("%s - submit urb failed", __func__);
1153		goto exit;
1154	}
1155
1156	/* wait for the command to complete */
1157	t = wait_event_timeout(command_info->wait_command,
1158		(bool)command_info->command_finished, COMMAND_TIMEOUT);
1159	if (!t)
1160		usb_kill_urb(command_port->write_urb);
1161
1162	if (command_info->command_finished == false) {
1163		dbg("%s - command timed out.", __func__);
1164		retval = -ETIMEDOUT;
1165		goto exit;
1166	}
1167
1168	if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
1169		dbg("%s - command failed.", __func__);
1170		retval = -EIO;
1171		goto exit;
1172	}
1173
1174	if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
1175		dbg("%s - command completed.", __func__);
1176		switch (command) {
1177		case WHITEHEAT_GET_DTR_RTS:
1178			info = usb_get_serial_port_data(port);
1179			memcpy(&info->mcr, command_info->result_buffer,
1180					sizeof(struct whiteheat_dr_info));
1181				break;
1182		}
1183	}
1184exit:
1185	mutex_unlock(&command_info->mutex);
1186	return retval;
1187}
1188
1189
1190static int firm_open(struct usb_serial_port *port)
1191{
1192	struct whiteheat_simple open_command;
1193
1194	open_command.port = port->number - port->serial->minor + 1;
1195	return firm_send_command(port, WHITEHEAT_OPEN,
1196		(__u8 *)&open_command, sizeof(open_command));
1197}
1198
1199
1200static int firm_close(struct usb_serial_port *port)
1201{
1202	struct whiteheat_simple close_command;
1203
1204	close_command.port = port->number - port->serial->minor + 1;
1205	return firm_send_command(port, WHITEHEAT_CLOSE,
1206			(__u8 *)&close_command, sizeof(close_command));
1207}
1208
1209
1210static void firm_setup_port(struct tty_struct *tty)
1211{
1212	struct usb_serial_port *port = tty->driver_data;
1213	struct whiteheat_port_settings port_settings;
1214	unsigned int cflag = tty->termios->c_cflag;
1215
1216	port_settings.port = port->number + 1;
1217
1218	/* get the byte size */
1219	switch (cflag & CSIZE) {
1220	case CS5:	port_settings.bits = 5;   break;
1221	case CS6:	port_settings.bits = 6;   break;
1222	case CS7:	port_settings.bits = 7;   break;
1223	default:
1224	case CS8:	port_settings.bits = 8;   break;
1225	}
1226	dbg("%s - data bits = %d", __func__, port_settings.bits);
1227
1228	/* determine the parity */
1229	if (cflag & PARENB)
1230		if (cflag & CMSPAR)
1231			if (cflag & PARODD)
1232				port_settings.parity = WHITEHEAT_PAR_MARK;
1233			else
1234				port_settings.parity = WHITEHEAT_PAR_SPACE;
1235		else
1236			if (cflag & PARODD)
1237				port_settings.parity = WHITEHEAT_PAR_ODD;
1238			else
1239				port_settings.parity = WHITEHEAT_PAR_EVEN;
1240	else
1241		port_settings.parity = WHITEHEAT_PAR_NONE;
1242	dbg("%s - parity = %c", __func__, port_settings.parity);
1243
1244	/* figure out the stop bits requested */
1245	if (cflag & CSTOPB)
1246		port_settings.stop = 2;
1247	else
1248		port_settings.stop = 1;
1249	dbg("%s - stop bits = %d", __func__, port_settings.stop);
1250
1251	/* figure out the flow control settings */
1252	if (cflag & CRTSCTS)
1253		port_settings.hflow = (WHITEHEAT_HFLOW_CTS |
1254						WHITEHEAT_HFLOW_RTS);
1255	else
1256		port_settings.hflow = WHITEHEAT_HFLOW_NONE;
1257	dbg("%s - hardware flow control = %s %s %s %s", __func__,
1258	    (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
1259	    (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
1260	    (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
1261	    (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
1262
1263	/* determine software flow control */
1264	if (I_IXOFF(tty))
1265		port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
1266	else
1267		port_settings.sflow = WHITEHEAT_SFLOW_NONE;
1268	dbg("%s - software flow control = %c", __func__, port_settings.sflow);
1269
1270	port_settings.xon = START_CHAR(tty);
1271	port_settings.xoff = STOP_CHAR(tty);
1272	dbg("%s - XON = %2x, XOFF = %2x",
1273			__func__, port_settings.xon, port_settings.xoff);
1274
1275	/* get the baud rate wanted */
1276	port_settings.baud = tty_get_baud_rate(tty);
1277	dbg("%s - baud rate = %d", __func__, port_settings.baud);
1278
1279	tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud);
1280	/* handle any settings that aren't specified in the tty structure */
1281	port_settings.lloop = 0;
1282
1283	/* now send the message to the device */
1284	firm_send_command(port, WHITEHEAT_SETUP_PORT,
1285			(__u8 *)&port_settings, sizeof(port_settings));
1286}
1287
1288
1289static int firm_set_rts(struct usb_serial_port *port, __u8 onoff)
1290{
1291	struct whiteheat_set_rdb rts_command;
1292
1293	rts_command.port = port->number - port->serial->minor + 1;
1294	rts_command.state = onoff;
1295	return firm_send_command(port, WHITEHEAT_SET_RTS,
1296			(__u8 *)&rts_command, sizeof(rts_command));
1297}
1298
1299
1300static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff)
1301{
1302	struct whiteheat_set_rdb dtr_command;
1303
1304	dtr_command.port = port->number - port->serial->minor + 1;
1305	dtr_command.state = onoff;
1306	return firm_send_command(port, WHITEHEAT_SET_DTR,
1307			(__u8 *)&dtr_command, sizeof(dtr_command));
1308}
1309
1310
1311static int firm_set_break(struct usb_serial_port *port, __u8 onoff)
1312{
1313	struct whiteheat_set_rdb break_command;
1314
1315	break_command.port = port->number - port->serial->minor + 1;
1316	break_command.state = onoff;
1317	return firm_send_command(port, WHITEHEAT_SET_BREAK,
1318			(__u8 *)&break_command, sizeof(break_command));
1319}
1320
1321
1322static int firm_purge(struct usb_serial_port *port, __u8 rxtx)
1323{
1324	struct whiteheat_purge purge_command;
1325
1326	purge_command.port = port->number - port->serial->minor + 1;
1327	purge_command.what = rxtx;
1328	return firm_send_command(port, WHITEHEAT_PURGE,
1329			(__u8 *)&purge_command, sizeof(purge_command));
1330}
1331
1332
1333static int firm_get_dtr_rts(struct usb_serial_port *port)
1334{
1335	struct whiteheat_simple get_dr_command;
1336
1337	get_dr_command.port = port->number - port->serial->minor + 1;
1338	return firm_send_command(port, WHITEHEAT_GET_DTR_RTS,
1339			(__u8 *)&get_dr_command, sizeof(get_dr_command));
1340}
1341
1342
1343static int firm_report_tx_done(struct usb_serial_port *port)
1344{
1345	struct whiteheat_simple close_command;
1346
1347	close_command.port = port->number - port->serial->minor + 1;
1348	return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE,
1349			(__u8 *)&close_command, sizeof(close_command));
1350}
1351
1352
1353/*****************************************************************************
1354 * Connect Tech's White Heat utility functions
1355 *****************************************************************************/
1356static int start_command_port(struct usb_serial *serial)
1357{
1358	struct usb_serial_port *command_port;
1359	struct whiteheat_command_private *command_info;
1360	int retval = 0;
1361
1362	command_port = serial->port[COMMAND_PORT];
1363	command_info = usb_get_serial_port_data(command_port);
1364	mutex_lock(&command_info->mutex);
1365	if (!command_info->port_running) {
1366		usb_clear_halt(serial->dev, command_port->read_urb->pipe);
1367
1368		command_port->read_urb->dev = serial->dev;
1369		retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
1370		if (retval) {
1371			dev_err(&serial->dev->dev,
1372				"%s - failed submitting read urb, error %d\n",
1373				__func__, retval);
1374			goto exit;
1375		}
1376	}
1377	command_info->port_running++;
1378
1379exit:
1380	mutex_unlock(&command_info->mutex);
1381	return retval;
1382}
1383
1384
1385static void stop_command_port(struct usb_serial *serial)
1386{
1387	struct usb_serial_port *command_port;
1388	struct whiteheat_command_private *command_info;
1389
1390	command_port = serial->port[COMMAND_PORT];
1391	command_info = usb_get_serial_port_data(command_port);
1392	mutex_lock(&command_info->mutex);
1393	command_info->port_running--;
1394	if (!command_info->port_running)
1395		usb_kill_urb(command_port->read_urb);
1396	mutex_unlock(&command_info->mutex);
1397}
1398
1399
1400static int start_port_read(struct usb_serial_port *port)
1401{
1402	struct whiteheat_private *info = usb_get_serial_port_data(port);
1403	struct whiteheat_urb_wrap *wrap;
1404	struct urb *urb;
1405	int retval = 0;
1406	unsigned long flags;
1407	struct list_head *tmp;
1408	struct list_head *tmp2;
1409
1410	spin_lock_irqsave(&info->lock, flags);
1411
1412	list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
1413		list_del(tmp);
1414		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1415		urb = wrap->urb;
1416		urb->dev = port->serial->dev;
1417		spin_unlock_irqrestore(&info->lock, flags);
1418		retval = usb_submit_urb(urb, GFP_KERNEL);
1419		if (retval) {
1420			spin_lock_irqsave(&info->lock, flags);
1421			list_add(tmp, &info->rx_urbs_free);
1422			list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
1423				wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1424				urb = wrap->urb;
1425				list_del(tmp);
1426				spin_unlock_irqrestore(&info->lock, flags);
1427				usb_kill_urb(urb);
1428				spin_lock_irqsave(&info->lock, flags);
1429				list_add(tmp, &info->rx_urbs_free);
1430			}
1431			break;
1432		}
1433		spin_lock_irqsave(&info->lock, flags);
1434		list_add(tmp, &info->rx_urbs_submitted);
1435	}
1436
1437	spin_unlock_irqrestore(&info->lock, flags);
1438
1439	return retval;
1440}
1441
1442
1443static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb,
1444						struct list_head *head)
1445{
1446	struct whiteheat_urb_wrap *wrap;
1447	struct list_head *tmp;
1448
1449	list_for_each(tmp, head) {
1450		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1451		if (wrap->urb == urb)
1452			return wrap;
1453	}
1454
1455	return NULL;
1456}
1457
1458
1459static struct list_head *list_first(struct list_head *head)
1460{
1461	return head->next;
1462}
1463
1464
1465static void rx_data_softint(struct work_struct *work)
1466{
1467	struct whiteheat_private *info =
1468		container_of(work, struct whiteheat_private, rx_work);
1469	struct usb_serial_port *port = info->port;
1470	struct tty_struct *tty = tty_port_tty_get(&port->port);
1471	struct whiteheat_urb_wrap *wrap;
1472	struct urb *urb;
1473	unsigned long flags;
1474	struct list_head *tmp;
1475	struct list_head *tmp2;
1476	int result;
1477	int sent = 0;
1478
1479	spin_lock_irqsave(&info->lock, flags);
1480	if (info->flags & THROTTLED) {
1481		spin_unlock_irqrestore(&info->lock, flags);
1482		goto out;
1483	}
1484
1485	list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
1486		list_del(tmp);
1487		spin_unlock_irqrestore(&info->lock, flags);
1488
1489		wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1490		urb = wrap->urb;
1491
1492		if (tty && urb->actual_length)
1493			sent += tty_insert_flip_string(tty,
1494				urb->transfer_buffer, urb->actual_length);
1495
1496		urb->dev = port->serial->dev;
1497		result = usb_submit_urb(urb, GFP_ATOMIC);
1498		if (result) {
1499			dev_err(&port->dev,
1500				"%s - failed resubmitting read urb, error %d\n",
1501				__func__, result);
1502			spin_lock_irqsave(&info->lock, flags);
1503			list_add(tmp, &info->rx_urbs_free);
1504			continue;
1505		}
1506
1507		spin_lock_irqsave(&info->lock, flags);
1508		list_add(tmp, &info->rx_urbs_submitted);
1509	}
1510	spin_unlock_irqrestore(&info->lock, flags);
1511
1512	if (sent)
1513		tty_flip_buffer_push(tty);
1514out:
1515	tty_kref_put(tty);
1516}
1517
1518
1519/*****************************************************************************
1520 * Connect Tech's White Heat module functions
1521 *****************************************************************************/
1522static int __init whiteheat_init(void)
1523{
1524	int retval;
1525	retval = usb_serial_register(&whiteheat_fake_device);
1526	if (retval)
1527		goto failed_fake_register;
1528	retval = usb_serial_register(&whiteheat_device);
1529	if (retval)
1530		goto failed_device_register;
1531	retval = usb_register(&whiteheat_driver);
1532	if (retval)
1533		goto failed_usb_register;
1534	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1535	       DRIVER_DESC "\n");
1536	return 0;
1537failed_usb_register:
1538	usb_serial_deregister(&whiteheat_device);
1539failed_device_register:
1540	usb_serial_deregister(&whiteheat_fake_device);
1541failed_fake_register:
1542	return retval;
1543}
1544
1545
1546static void __exit whiteheat_exit(void)
1547{
1548	usb_deregister(&whiteheat_driver);
1549	usb_serial_deregister(&whiteheat_fake_device);
1550	usb_serial_deregister(&whiteheat_device);
1551}
1552
1553
1554module_init(whiteheat_init);
1555module_exit(whiteheat_exit);
1556
1557MODULE_AUTHOR(DRIVER_AUTHOR);
1558MODULE_DESCRIPTION(DRIVER_DESC);
1559MODULE_LICENSE("GPL");
1560
1561MODULE_FIRMWARE("whiteheat.fw");
1562MODULE_FIRMWARE("whiteheat_loader.fw");
1563
1564module_param(urb_pool_size, int, 0);
1565MODULE_PARM_DESC(urb_pool_size, "Number of urbs to use for buffering");
1566
1567module_param(debug, bool, S_IRUGO | S_IWUSR);
1568MODULE_PARM_DESC(debug, "Debug enabled or not");
1569