xref: /linux/drivers/usb/serial/whiteheat.c (revision 93d90ad708b8da6efc0e487b66111aa9db7f70c7)
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 
19 #include <linux/kernel.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
22 #include <linux/tty.h>
23 #include <linux/tty_driver.h>
24 #include <linux/tty_flip.h>
25 #include <linux/module.h>
26 #include <linux/spinlock.h>
27 #include <linux/mutex.h>
28 #include <linux/uaccess.h>
29 #include <asm/termbits.h>
30 #include <linux/usb.h>
31 #include <linux/serial_reg.h>
32 #include <linux/serial.h>
33 #include <linux/usb/serial.h>
34 #include <linux/usb/ezusb.h>
35 #include "whiteheat.h"			/* WhiteHEAT specific commands */
36 
37 #ifndef CMSPAR
38 #define CMSPAR 0
39 #endif
40 
41 /*
42  * Version Information
43  */
44 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
45 #define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
46 
47 #define CONNECT_TECH_VENDOR_ID		0x0710
48 #define CONNECT_TECH_FAKE_WHITE_HEAT_ID	0x0001
49 #define CONNECT_TECH_WHITE_HEAT_ID	0x8001
50 
51 /*
52    ID tables for whiteheat are unusual, because we want to different
53    things for different versions of the device.  Eventually, this
54    will be doable from a single table.  But, for now, we define two
55    separate ID tables, and then a third table that combines them
56    just for the purpose of exporting the autoloading information.
57 */
58 static const struct usb_device_id id_table_std[] = {
59 	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
60 	{ }						/* Terminating entry */
61 };
62 
63 static const struct usb_device_id id_table_prerenumeration[] = {
64 	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
65 	{ }						/* Terminating entry */
66 };
67 
68 static const struct usb_device_id id_table_combined[] = {
69 	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
70 	{ USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
71 	{ }						/* Terminating entry */
72 };
73 
74 MODULE_DEVICE_TABLE(usb, id_table_combined);
75 
76 
77 /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
78 static int  whiteheat_firmware_download(struct usb_serial *serial,
79 					const struct usb_device_id *id);
80 static int  whiteheat_firmware_attach(struct usb_serial *serial);
81 
82 /* function prototypes for the Connect Tech WhiteHEAT serial converter */
83 static int  whiteheat_attach(struct usb_serial *serial);
84 static void whiteheat_release(struct usb_serial *serial);
85 static int  whiteheat_port_probe(struct usb_serial_port *port);
86 static int  whiteheat_port_remove(struct usb_serial_port *port);
87 static int  whiteheat_open(struct tty_struct *tty,
88 			struct usb_serial_port *port);
89 static void whiteheat_close(struct usb_serial_port *port);
90 static int  whiteheat_ioctl(struct tty_struct *tty,
91 			unsigned int cmd, unsigned long arg);
92 static void whiteheat_set_termios(struct tty_struct *tty,
93 			struct usb_serial_port *port, struct ktermios *old);
94 static int  whiteheat_tiocmget(struct tty_struct *tty);
95 static int  whiteheat_tiocmset(struct tty_struct *tty,
96 			unsigned int set, unsigned int clear);
97 static void whiteheat_break_ctl(struct tty_struct *tty, int break_state);
98 
99 static struct usb_serial_driver whiteheat_fake_device = {
100 	.driver = {
101 		.owner =	THIS_MODULE,
102 		.name =		"whiteheatnofirm",
103 	},
104 	.description =		"Connect Tech - WhiteHEAT - (prerenumeration)",
105 	.id_table =		id_table_prerenumeration,
106 	.num_ports =		1,
107 	.probe =		whiteheat_firmware_download,
108 	.attach =		whiteheat_firmware_attach,
109 };
110 
111 static struct usb_serial_driver whiteheat_device = {
112 	.driver = {
113 		.owner =	THIS_MODULE,
114 		.name =		"whiteheat",
115 	},
116 	.description =		"Connect Tech - WhiteHEAT",
117 	.id_table =		id_table_std,
118 	.num_ports =		4,
119 	.attach =		whiteheat_attach,
120 	.release =		whiteheat_release,
121 	.port_probe =		whiteheat_port_probe,
122 	.port_remove =		whiteheat_port_remove,
123 	.open =			whiteheat_open,
124 	.close =		whiteheat_close,
125 	.ioctl =		whiteheat_ioctl,
126 	.set_termios =		whiteheat_set_termios,
127 	.break_ctl =		whiteheat_break_ctl,
128 	.tiocmget =		whiteheat_tiocmget,
129 	.tiocmset =		whiteheat_tiocmset,
130 	.throttle =		usb_serial_generic_throttle,
131 	.unthrottle =		usb_serial_generic_unthrottle,
132 };
133 
134 static struct usb_serial_driver * const serial_drivers[] = {
135 	&whiteheat_fake_device, &whiteheat_device, NULL
136 };
137 
138 struct whiteheat_command_private {
139 	struct mutex		mutex;
140 	__u8			port_running;
141 	__u8			command_finished;
142 	wait_queue_head_t	wait_command; /* for handling sleeping whilst
143 						 waiting for a command to
144 						 finish */
145 	__u8			result_buffer[64];
146 };
147 
148 struct whiteheat_private {
149 	__u8			mcr;		/* FIXME: no locking on mcr */
150 };
151 
152 
153 /* local function prototypes */
154 static int start_command_port(struct usb_serial *serial);
155 static void stop_command_port(struct usb_serial *serial);
156 static void command_port_write_callback(struct urb *urb);
157 static void command_port_read_callback(struct urb *urb);
158 
159 static int firm_send_command(struct usb_serial_port *port, __u8 command,
160 						__u8 *data, __u8 datasize);
161 static int firm_open(struct usb_serial_port *port);
162 static int firm_close(struct usb_serial_port *port);
163 static void firm_setup_port(struct tty_struct *tty);
164 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
165 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
166 static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
167 static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
168 static int firm_get_dtr_rts(struct usb_serial_port *port);
169 static int firm_report_tx_done(struct usb_serial_port *port);
170 
171 
172 #define COMMAND_PORT		4
173 #define COMMAND_TIMEOUT		(2*HZ)	/* 2 second timeout for a command */
174 #define	COMMAND_TIMEOUT_MS	2000
175 #define CLOSING_DELAY		(30 * HZ)
176 
177 
178 /*****************************************************************************
179  * Connect Tech's White Heat prerenumeration driver functions
180  *****************************************************************************/
181 
182 /* steps to download the firmware to the WhiteHEAT device:
183  - hold the reset (by writing to the reset bit of the CPUCS register)
184  - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
185  - release the reset (by writing to the CPUCS register)
186  - download the WH.HEX file for all addresses greater than 0x1b3f using
187    VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
188  - hold the reset
189  - download the WH.HEX file for all addresses less than 0x1b40 using
190    VENDOR_REQUEST_ANCHOR_LOAD
191  - release the reset
192  - device renumerated itself and comes up as new device id with all
193    firmware download completed.
194 */
195 static int whiteheat_firmware_download(struct usb_serial *serial,
196 					const struct usb_device_id *id)
197 {
198 	int response;
199 
200 	response = ezusb_fx1_ihex_firmware_download(serial->dev, "whiteheat_loader.fw");
201 	if (response >= 0) {
202 		response = ezusb_fx1_ihex_firmware_download(serial->dev, "whiteheat.fw");
203 		if (response >= 0)
204 			return 0;
205 	}
206 	return -ENOENT;
207 }
208 
209 
210 static int whiteheat_firmware_attach(struct usb_serial *serial)
211 {
212 	/* We want this device to fail to have a driver assigned to it */
213 	return 1;
214 }
215 
216 
217 /*****************************************************************************
218  * Connect Tech's White Heat serial driver functions
219  *****************************************************************************/
220 static int whiteheat_attach(struct usb_serial *serial)
221 {
222 	struct usb_serial_port *command_port;
223 	struct whiteheat_command_private *command_info;
224 	struct whiteheat_hw_info *hw_info;
225 	int pipe;
226 	int ret;
227 	int alen;
228 	__u8 *command;
229 	__u8 *result;
230 
231 	command_port = serial->port[COMMAND_PORT];
232 
233 	pipe = usb_sndbulkpipe(serial->dev,
234 			command_port->bulk_out_endpointAddress);
235 	command = kmalloc(2, GFP_KERNEL);
236 	if (!command)
237 		goto no_command_buffer;
238 	command[0] = WHITEHEAT_GET_HW_INFO;
239 	command[1] = 0;
240 
241 	result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
242 	if (!result)
243 		goto no_result_buffer;
244 	/*
245 	 * When the module is reloaded the firmware is still there and
246 	 * the endpoints are still in the usb core unchanged. This is the
247 	 * unlinking bug in disguise. Same for the call below.
248 	 */
249 	usb_clear_halt(serial->dev, pipe);
250 	ret = usb_bulk_msg(serial->dev, pipe, command, 2,
251 						&alen, COMMAND_TIMEOUT_MS);
252 	if (ret) {
253 		dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n",
254 			serial->type->description, ret);
255 		goto no_firmware;
256 	} else if (alen != 2) {
257 		dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n",
258 			serial->type->description, alen);
259 		goto no_firmware;
260 	}
261 
262 	pipe = usb_rcvbulkpipe(serial->dev,
263 				command_port->bulk_in_endpointAddress);
264 	/* See the comment on the usb_clear_halt() above */
265 	usb_clear_halt(serial->dev, pipe);
266 	ret = usb_bulk_msg(serial->dev, pipe, result,
267 			sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
268 	if (ret) {
269 		dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n",
270 			serial->type->description, ret);
271 		goto no_firmware;
272 	} else if (alen != sizeof(*hw_info) + 1) {
273 		dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n",
274 			serial->type->description, alen);
275 		goto no_firmware;
276 	} else if (result[0] != command[0]) {
277 		dev_err(&serial->dev->dev, "%s: Command failed [%d]\n",
278 			serial->type->description, result[0]);
279 		goto no_firmware;
280 	}
281 
282 	hw_info = (struct whiteheat_hw_info *)&result[1];
283 
284 	dev_info(&serial->dev->dev, "%s: Firmware v%d.%02d\n",
285 		 serial->type->description,
286 		 hw_info->sw_major_rev, hw_info->sw_minor_rev);
287 
288 	command_info = kmalloc(sizeof(struct whiteheat_command_private),
289 								GFP_KERNEL);
290 	if (!command_info)
291 		goto no_command_private;
292 
293 	mutex_init(&command_info->mutex);
294 	command_info->port_running = 0;
295 	init_waitqueue_head(&command_info->wait_command);
296 	usb_set_serial_port_data(command_port, command_info);
297 	command_port->write_urb->complete = command_port_write_callback;
298 	command_port->read_urb->complete = command_port_read_callback;
299 	kfree(result);
300 	kfree(command);
301 
302 	return 0;
303 
304 no_firmware:
305 	/* Firmware likely not running */
306 	dev_err(&serial->dev->dev,
307 		"%s: Unable to retrieve firmware version, try replugging\n",
308 		serial->type->description);
309 	dev_err(&serial->dev->dev,
310 		"%s: If the firmware is not running (status led not blinking)\n",
311 		serial->type->description);
312 	dev_err(&serial->dev->dev,
313 		"%s: please contact support@connecttech.com\n",
314 		serial->type->description);
315 	kfree(result);
316 	kfree(command);
317 	return -ENODEV;
318 
319 no_command_private:
320 	kfree(result);
321 no_result_buffer:
322 	kfree(command);
323 no_command_buffer:
324 	return -ENOMEM;
325 }
326 
327 static void whiteheat_release(struct usb_serial *serial)
328 {
329 	struct usb_serial_port *command_port;
330 
331 	/* free up our private data for our command port */
332 	command_port = serial->port[COMMAND_PORT];
333 	kfree(usb_get_serial_port_data(command_port));
334 }
335 
336 static int whiteheat_port_probe(struct usb_serial_port *port)
337 {
338 	struct whiteheat_private *info;
339 
340 	info = kzalloc(sizeof(*info), GFP_KERNEL);
341 	if (!info)
342 		return -ENOMEM;
343 
344 	usb_set_serial_port_data(port, info);
345 
346 	return 0;
347 }
348 
349 static int whiteheat_port_remove(struct usb_serial_port *port)
350 {
351 	struct whiteheat_private *info;
352 
353 	info = usb_get_serial_port_data(port);
354 	kfree(info);
355 
356 	return 0;
357 }
358 
359 static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port)
360 {
361 	int retval;
362 
363 	retval = start_command_port(port->serial);
364 	if (retval)
365 		goto exit;
366 
367 	/* send an open port command */
368 	retval = firm_open(port);
369 	if (retval) {
370 		stop_command_port(port->serial);
371 		goto exit;
372 	}
373 
374 	retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
375 	if (retval) {
376 		firm_close(port);
377 		stop_command_port(port->serial);
378 		goto exit;
379 	}
380 
381 	if (tty)
382 		firm_setup_port(tty);
383 
384 	/* Work around HCD bugs */
385 	usb_clear_halt(port->serial->dev, port->read_urb->pipe);
386 	usb_clear_halt(port->serial->dev, port->write_urb->pipe);
387 
388 	retval = usb_serial_generic_open(tty, port);
389 	if (retval) {
390 		firm_close(port);
391 		stop_command_port(port->serial);
392 		goto exit;
393 	}
394 exit:
395 	return retval;
396 }
397 
398 
399 static void whiteheat_close(struct usb_serial_port *port)
400 {
401 	firm_report_tx_done(port);
402 	firm_close(port);
403 
404 	usb_serial_generic_close(port);
405 
406 	stop_command_port(port->serial);
407 }
408 
409 static int whiteheat_tiocmget(struct tty_struct *tty)
410 {
411 	struct usb_serial_port *port = tty->driver_data;
412 	struct whiteheat_private *info = usb_get_serial_port_data(port);
413 	unsigned int modem_signals = 0;
414 
415 	firm_get_dtr_rts(port);
416 	if (info->mcr & UART_MCR_DTR)
417 		modem_signals |= TIOCM_DTR;
418 	if (info->mcr & UART_MCR_RTS)
419 		modem_signals |= TIOCM_RTS;
420 
421 	return modem_signals;
422 }
423 
424 static int whiteheat_tiocmset(struct tty_struct *tty,
425 			       unsigned int set, unsigned int clear)
426 {
427 	struct usb_serial_port *port = tty->driver_data;
428 	struct whiteheat_private *info = usb_get_serial_port_data(port);
429 
430 	if (set & TIOCM_RTS)
431 		info->mcr |= UART_MCR_RTS;
432 	if (set & TIOCM_DTR)
433 		info->mcr |= UART_MCR_DTR;
434 
435 	if (clear & TIOCM_RTS)
436 		info->mcr &= ~UART_MCR_RTS;
437 	if (clear & TIOCM_DTR)
438 		info->mcr &= ~UART_MCR_DTR;
439 
440 	firm_set_dtr(port, info->mcr & UART_MCR_DTR);
441 	firm_set_rts(port, info->mcr & UART_MCR_RTS);
442 	return 0;
443 }
444 
445 
446 static int whiteheat_ioctl(struct tty_struct *tty,
447 					unsigned int cmd, unsigned long arg)
448 {
449 	struct usb_serial_port *port = tty->driver_data;
450 	struct serial_struct serstruct;
451 	void __user *user_arg = (void __user *)arg;
452 
453 	switch (cmd) {
454 	case TIOCGSERIAL:
455 		memset(&serstruct, 0, sizeof(serstruct));
456 		serstruct.type = PORT_16654;
457 		serstruct.line = port->minor;
458 		serstruct.port = port->port_number;
459 		serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
460 		serstruct.xmit_fifo_size = kfifo_size(&port->write_fifo);
461 		serstruct.custom_divisor = 0;
462 		serstruct.baud_base = 460800;
463 		serstruct.close_delay = CLOSING_DELAY;
464 		serstruct.closing_wait = CLOSING_DELAY;
465 
466 		if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
467 			return -EFAULT;
468 		break;
469 	default:
470 		break;
471 	}
472 
473 	return -ENOIOCTLCMD;
474 }
475 
476 
477 static void whiteheat_set_termios(struct tty_struct *tty,
478 	struct usb_serial_port *port, struct ktermios *old_termios)
479 {
480 	firm_setup_port(tty);
481 }
482 
483 static void whiteheat_break_ctl(struct tty_struct *tty, int break_state)
484 {
485 	struct usb_serial_port *port = tty->driver_data;
486 	firm_set_break(port, break_state);
487 }
488 
489 
490 /*****************************************************************************
491  * Connect Tech's White Heat callback routines
492  *****************************************************************************/
493 static void command_port_write_callback(struct urb *urb)
494 {
495 	int status = urb->status;
496 
497 	if (status) {
498 		dev_dbg(&urb->dev->dev, "nonzero urb status: %d\n", status);
499 		return;
500 	}
501 }
502 
503 
504 static void command_port_read_callback(struct urb *urb)
505 {
506 	struct usb_serial_port *command_port = urb->context;
507 	struct whiteheat_command_private *command_info;
508 	int status = urb->status;
509 	unsigned char *data = urb->transfer_buffer;
510 	int result;
511 
512 	command_info = usb_get_serial_port_data(command_port);
513 	if (!command_info) {
514 		dev_dbg(&urb->dev->dev, "%s - command_info is NULL, exiting.\n", __func__);
515 		return;
516 	}
517 	if (!urb->actual_length) {
518 		dev_dbg(&urb->dev->dev, "%s - empty response, exiting.\n", __func__);
519 		return;
520 	}
521 	if (status) {
522 		dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n", __func__, status);
523 		if (status != -ENOENT)
524 			command_info->command_finished = WHITEHEAT_CMD_FAILURE;
525 		wake_up(&command_info->wait_command);
526 		return;
527 	}
528 
529 	usb_serial_debug_data(&command_port->dev, __func__, urb->actual_length, data);
530 
531 	if (data[0] == WHITEHEAT_CMD_COMPLETE) {
532 		command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
533 		wake_up(&command_info->wait_command);
534 	} else if (data[0] == WHITEHEAT_CMD_FAILURE) {
535 		command_info->command_finished = WHITEHEAT_CMD_FAILURE;
536 		wake_up(&command_info->wait_command);
537 	} else if (data[0] == WHITEHEAT_EVENT) {
538 		/* These are unsolicited reports from the firmware, hence no
539 		   waiting command to wakeup */
540 		dev_dbg(&urb->dev->dev, "%s - event received\n", __func__);
541 	} else if ((data[0] == WHITEHEAT_GET_DTR_RTS) &&
542 		(urb->actual_length - 1 <= sizeof(command_info->result_buffer))) {
543 		memcpy(command_info->result_buffer, &data[1],
544 						urb->actual_length - 1);
545 		command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
546 		wake_up(&command_info->wait_command);
547 	} else
548 		dev_dbg(&urb->dev->dev, "%s - bad reply from firmware\n", __func__);
549 
550 	/* Continue trying to always read */
551 	result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
552 	if (result)
553 		dev_dbg(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n",
554 			__func__, result);
555 }
556 
557 
558 /*****************************************************************************
559  * Connect Tech's White Heat firmware interface
560  *****************************************************************************/
561 static int firm_send_command(struct usb_serial_port *port, __u8 command,
562 						__u8 *data, __u8 datasize)
563 {
564 	struct usb_serial_port *command_port;
565 	struct whiteheat_command_private *command_info;
566 	struct whiteheat_private *info;
567 	struct device *dev = &port->dev;
568 	__u8 *transfer_buffer;
569 	int retval = 0;
570 	int t;
571 
572 	dev_dbg(dev, "%s - command %d\n", __func__, command);
573 
574 	command_port = port->serial->port[COMMAND_PORT];
575 	command_info = usb_get_serial_port_data(command_port);
576 	mutex_lock(&command_info->mutex);
577 	command_info->command_finished = false;
578 
579 	transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
580 	transfer_buffer[0] = command;
581 	memcpy(&transfer_buffer[1], data, datasize);
582 	command_port->write_urb->transfer_buffer_length = datasize + 1;
583 	retval = usb_submit_urb(command_port->write_urb, GFP_NOIO);
584 	if (retval) {
585 		dev_dbg(dev, "%s - submit urb failed\n", __func__);
586 		goto exit;
587 	}
588 
589 	/* wait for the command to complete */
590 	t = wait_event_timeout(command_info->wait_command,
591 		(bool)command_info->command_finished, COMMAND_TIMEOUT);
592 	if (!t)
593 		usb_kill_urb(command_port->write_urb);
594 
595 	if (command_info->command_finished == false) {
596 		dev_dbg(dev, "%s - command timed out.\n", __func__);
597 		retval = -ETIMEDOUT;
598 		goto exit;
599 	}
600 
601 	if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
602 		dev_dbg(dev, "%s - command failed.\n", __func__);
603 		retval = -EIO;
604 		goto exit;
605 	}
606 
607 	if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
608 		dev_dbg(dev, "%s - command completed.\n", __func__);
609 		switch (command) {
610 		case WHITEHEAT_GET_DTR_RTS:
611 			info = usb_get_serial_port_data(port);
612 			memcpy(&info->mcr, command_info->result_buffer,
613 					sizeof(struct whiteheat_dr_info));
614 				break;
615 		}
616 	}
617 exit:
618 	mutex_unlock(&command_info->mutex);
619 	return retval;
620 }
621 
622 
623 static int firm_open(struct usb_serial_port *port)
624 {
625 	struct whiteheat_simple open_command;
626 
627 	open_command.port = port->port_number + 1;
628 	return firm_send_command(port, WHITEHEAT_OPEN,
629 		(__u8 *)&open_command, sizeof(open_command));
630 }
631 
632 
633 static int firm_close(struct usb_serial_port *port)
634 {
635 	struct whiteheat_simple close_command;
636 
637 	close_command.port = port->port_number + 1;
638 	return firm_send_command(port, WHITEHEAT_CLOSE,
639 			(__u8 *)&close_command, sizeof(close_command));
640 }
641 
642 
643 static void firm_setup_port(struct tty_struct *tty)
644 {
645 	struct usb_serial_port *port = tty->driver_data;
646 	struct device *dev = &port->dev;
647 	struct whiteheat_port_settings port_settings;
648 	unsigned int cflag = tty->termios.c_cflag;
649 
650 	port_settings.port = port->port_number + 1;
651 
652 	/* get the byte size */
653 	switch (cflag & CSIZE) {
654 	case CS5:	port_settings.bits = 5;   break;
655 	case CS6:	port_settings.bits = 6;   break;
656 	case CS7:	port_settings.bits = 7;   break;
657 	default:
658 	case CS8:	port_settings.bits = 8;   break;
659 	}
660 	dev_dbg(dev, "%s - data bits = %d\n", __func__, port_settings.bits);
661 
662 	/* determine the parity */
663 	if (cflag & PARENB)
664 		if (cflag & CMSPAR)
665 			if (cflag & PARODD)
666 				port_settings.parity = WHITEHEAT_PAR_MARK;
667 			else
668 				port_settings.parity = WHITEHEAT_PAR_SPACE;
669 		else
670 			if (cflag & PARODD)
671 				port_settings.parity = WHITEHEAT_PAR_ODD;
672 			else
673 				port_settings.parity = WHITEHEAT_PAR_EVEN;
674 	else
675 		port_settings.parity = WHITEHEAT_PAR_NONE;
676 	dev_dbg(dev, "%s - parity = %c\n", __func__, port_settings.parity);
677 
678 	/* figure out the stop bits requested */
679 	if (cflag & CSTOPB)
680 		port_settings.stop = 2;
681 	else
682 		port_settings.stop = 1;
683 	dev_dbg(dev, "%s - stop bits = %d\n", __func__, port_settings.stop);
684 
685 	/* figure out the flow control settings */
686 	if (cflag & CRTSCTS)
687 		port_settings.hflow = (WHITEHEAT_HFLOW_CTS |
688 						WHITEHEAT_HFLOW_RTS);
689 	else
690 		port_settings.hflow = WHITEHEAT_HFLOW_NONE;
691 	dev_dbg(dev, "%s - hardware flow control = %s %s %s %s\n", __func__,
692 	    (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
693 	    (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
694 	    (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
695 	    (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
696 
697 	/* determine software flow control */
698 	if (I_IXOFF(tty))
699 		port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
700 	else
701 		port_settings.sflow = WHITEHEAT_SFLOW_NONE;
702 	dev_dbg(dev, "%s - software flow control = %c\n", __func__, port_settings.sflow);
703 
704 	port_settings.xon = START_CHAR(tty);
705 	port_settings.xoff = STOP_CHAR(tty);
706 	dev_dbg(dev, "%s - XON = %2x, XOFF = %2x\n", __func__, port_settings.xon, port_settings.xoff);
707 
708 	/* get the baud rate wanted */
709 	port_settings.baud = tty_get_baud_rate(tty);
710 	dev_dbg(dev, "%s - baud rate = %d\n", __func__, port_settings.baud);
711 
712 	/* fixme: should set validated settings */
713 	tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud);
714 	/* handle any settings that aren't specified in the tty structure */
715 	port_settings.lloop = 0;
716 
717 	/* now send the message to the device */
718 	firm_send_command(port, WHITEHEAT_SETUP_PORT,
719 			(__u8 *)&port_settings, sizeof(port_settings));
720 }
721 
722 
723 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff)
724 {
725 	struct whiteheat_set_rdb rts_command;
726 
727 	rts_command.port = port->port_number + 1;
728 	rts_command.state = onoff;
729 	return firm_send_command(port, WHITEHEAT_SET_RTS,
730 			(__u8 *)&rts_command, sizeof(rts_command));
731 }
732 
733 
734 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff)
735 {
736 	struct whiteheat_set_rdb dtr_command;
737 
738 	dtr_command.port = port->port_number + 1;
739 	dtr_command.state = onoff;
740 	return firm_send_command(port, WHITEHEAT_SET_DTR,
741 			(__u8 *)&dtr_command, sizeof(dtr_command));
742 }
743 
744 
745 static int firm_set_break(struct usb_serial_port *port, __u8 onoff)
746 {
747 	struct whiteheat_set_rdb break_command;
748 
749 	break_command.port = port->port_number + 1;
750 	break_command.state = onoff;
751 	return firm_send_command(port, WHITEHEAT_SET_BREAK,
752 			(__u8 *)&break_command, sizeof(break_command));
753 }
754 
755 
756 static int firm_purge(struct usb_serial_port *port, __u8 rxtx)
757 {
758 	struct whiteheat_purge purge_command;
759 
760 	purge_command.port = port->port_number + 1;
761 	purge_command.what = rxtx;
762 	return firm_send_command(port, WHITEHEAT_PURGE,
763 			(__u8 *)&purge_command, sizeof(purge_command));
764 }
765 
766 
767 static int firm_get_dtr_rts(struct usb_serial_port *port)
768 {
769 	struct whiteheat_simple get_dr_command;
770 
771 	get_dr_command.port = port->port_number + 1;
772 	return firm_send_command(port, WHITEHEAT_GET_DTR_RTS,
773 			(__u8 *)&get_dr_command, sizeof(get_dr_command));
774 }
775 
776 
777 static int firm_report_tx_done(struct usb_serial_port *port)
778 {
779 	struct whiteheat_simple close_command;
780 
781 	close_command.port = port->port_number + 1;
782 	return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE,
783 			(__u8 *)&close_command, sizeof(close_command));
784 }
785 
786 
787 /*****************************************************************************
788  * Connect Tech's White Heat utility functions
789  *****************************************************************************/
790 static int start_command_port(struct usb_serial *serial)
791 {
792 	struct usb_serial_port *command_port;
793 	struct whiteheat_command_private *command_info;
794 	int retval = 0;
795 
796 	command_port = serial->port[COMMAND_PORT];
797 	command_info = usb_get_serial_port_data(command_port);
798 	mutex_lock(&command_info->mutex);
799 	if (!command_info->port_running) {
800 		/* Work around HCD bugs */
801 		usb_clear_halt(serial->dev, command_port->read_urb->pipe);
802 
803 		retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
804 		if (retval) {
805 			dev_err(&serial->dev->dev,
806 				"%s - failed submitting read urb, error %d\n",
807 				__func__, retval);
808 			goto exit;
809 		}
810 	}
811 	command_info->port_running++;
812 
813 exit:
814 	mutex_unlock(&command_info->mutex);
815 	return retval;
816 }
817 
818 
819 static void stop_command_port(struct usb_serial *serial)
820 {
821 	struct usb_serial_port *command_port;
822 	struct whiteheat_command_private *command_info;
823 
824 	command_port = serial->port[COMMAND_PORT];
825 	command_info = usb_get_serial_port_data(command_port);
826 	mutex_lock(&command_info->mutex);
827 	command_info->port_running--;
828 	if (!command_info->port_running)
829 		usb_kill_urb(command_port->read_urb);
830 	mutex_unlock(&command_info->mutex);
831 }
832 
833 module_usb_serial_driver(serial_drivers, id_table_combined);
834 
835 MODULE_AUTHOR(DRIVER_AUTHOR);
836 MODULE_DESCRIPTION(DRIVER_DESC);
837 MODULE_LICENSE("GPL");
838 
839 MODULE_FIRMWARE("whiteheat.fw");
840 MODULE_FIRMWARE("whiteheat_loader.fw");
841