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