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