blob: 64d3840673aa975ea3f7ad3d8168f4fbe0631eca [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Alan Cox80359a92008-07-22 11:09:16 +010015 * See Documentation/usb/usb-serial.txt for more information on using this
16 * driver
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/kernel.h>
20#include <linux/errno.h>
21#include <linux/init.h>
22#include <linux/slab.h>
23#include <linux/tty.h>
24#include <linux/tty_driver.h>
25#include <linux/tty_flip.h>
26#include <linux/module.h>
27#include <linux/spinlock.h>
Oliver Neukum08a2b3b2007-05-24 13:52:51 +020028#include <linux/mutex.h>
Alan Cox80359a92008-07-22 11:09:16 +010029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <asm/termbits.h>
31#include <linux/usb.h>
32#include <linux/serial_reg.h>
33#include <linux/serial.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070034#include <linux/usb/serial.h>
David Woodhouseec6752f2008-05-31 01:35:29 +030035#include <linux/firmware.h>
36#include <linux/ihex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include "whiteheat.h" /* WhiteHEAT specific commands */
38
Rusty Russell90ab5ee2012-01-13 09:32:20 +103039static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41#ifndef CMSPAR
42#define CMSPAR 0
43#endif
44
45/*
46 * Version Information
47 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
49#define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
50
51#define CONNECT_TECH_VENDOR_ID 0x0710
52#define CONNECT_TECH_FAKE_WHITE_HEAT_ID 0x0001
53#define CONNECT_TECH_WHITE_HEAT_ID 0x8001
54
55/*
56 ID tables for whiteheat are unusual, because we want to different
57 things for different versions of the device. Eventually, this
58 will be doable from a single table. But, for now, we define two
59 separate ID tables, and then a third table that combines them
60 just for the purpose of exporting the autoloading information.
61*/
Németh Márton7d40d7e2010-01-10 15:34:24 +010062static const struct usb_device_id id_table_std[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
64 { } /* Terminating entry */
65};
66
Németh Márton7d40d7e2010-01-10 15:34:24 +010067static const struct usb_device_id id_table_prerenumeration[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
69 { } /* Terminating entry */
70};
71
Németh Márton7d40d7e2010-01-10 15:34:24 +010072static const struct usb_device_id id_table_combined[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
74 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
75 { } /* Terminating entry */
76};
77
Alan Cox80359a92008-07-22 11:09:16 +010078MODULE_DEVICE_TABLE(usb, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
Alan Cox80359a92008-07-22 11:09:16 +010082static int whiteheat_firmware_download(struct usb_serial *serial,
83 const struct usb_device_id *id);
84static int whiteheat_firmware_attach(struct usb_serial *serial);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86/* function prototypes for the Connect Tech WhiteHEAT serial converter */
Alan Cox80359a92008-07-22 11:09:16 +010087static int whiteheat_attach(struct usb_serial *serial);
Alan Sternf9c99bb2009-06-02 11:53:55 -040088static void whiteheat_release(struct usb_serial *serial);
Alan Cox80359a92008-07-22 11:09:16 +010089static int whiteheat_open(struct tty_struct *tty,
Alan Coxa509a7e2009-09-19 13:13:26 -070090 struct usb_serial_port *port);
Alan Cox335f8512009-06-11 12:26:29 +010091static void whiteheat_close(struct usb_serial_port *port);
Alan Cox00a0d0d2011-02-14 16:27:06 +000092static int whiteheat_ioctl(struct tty_struct *tty,
Alan Cox80359a92008-07-22 11:09:16 +010093 unsigned int cmd, unsigned long arg);
94static void whiteheat_set_termios(struct tty_struct *tty,
95 struct usb_serial_port *port, struct ktermios *old);
Alan Cox60b33c12011-02-14 16:26:14 +000096static int whiteheat_tiocmget(struct tty_struct *tty);
Alan Cox20b9d172011-02-14 16:26:50 +000097static int whiteheat_tiocmset(struct tty_struct *tty,
Alan Cox80359a92008-07-22 11:09:16 +010098 unsigned int set, unsigned int clear);
99static void whiteheat_break_ctl(struct tty_struct *tty, int break_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700101static struct usb_serial_driver whiteheat_fake_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700102 .driver = {
103 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700104 .name = "whiteheatnofirm",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700105 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700106 .description = "Connect Tech - WhiteHEAT - (prerenumeration)",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 .id_table = id_table_prerenumeration,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 .num_ports = 1,
109 .probe = whiteheat_firmware_download,
110 .attach = whiteheat_firmware_attach,
111};
112
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -0700113static struct usb_serial_driver whiteheat_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700114 .driver = {
115 .owner = THIS_MODULE,
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700116 .name = "whiteheat",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -0700117 },
Greg Kroah-Hartman269bda12005-06-20 21:15:16 -0700118 .description = "Connect Tech - WhiteHEAT",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 .id_table = id_table_std,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 .num_ports = 4,
121 .attach = whiteheat_attach,
Alan Sternf9c99bb2009-06-02 11:53:55 -0400122 .release = whiteheat_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 .open = whiteheat_open,
124 .close = whiteheat_close,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 .ioctl = whiteheat_ioctl,
126 .set_termios = whiteheat_set_termios,
127 .break_ctl = whiteheat_break_ctl,
128 .tiocmget = whiteheat_tiocmget,
129 .tiocmset = whiteheat_tiocmset,
Johan Hovold5c0c7582012-03-22 16:50:55 +0100130 .throttle = usb_serial_generic_throttle,
131 .unthrottle = usb_serial_generic_unthrottle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132};
133
Alan Stern29618e92012-02-23 14:57:32 -0500134static struct usb_serial_driver * const serial_drivers[] = {
135 &whiteheat_fake_device, &whiteheat_device, NULL
136};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138struct whiteheat_command_private {
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200139 struct mutex mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 __u8 port_running;
141 __u8 command_finished;
Alan Cox80359a92008-07-22 11:09:16 +0100142 wait_queue_head_t wait_command; /* for handling sleeping whilst
143 waiting for a command to
144 finish */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 __u8 result_buffer[64];
146};
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148struct whiteheat_private {
Alan Coxa5b6f602008-04-08 17:16:06 +0100149 __u8 mcr; /* FIXME: no locking on mcr */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150};
151
152
153/* local function prototypes */
154static int start_command_port(struct usb_serial *serial);
155static void stop_command_port(struct usb_serial *serial);
David Howells7d12e782006-10-05 14:55:46 +0100156static void command_port_write_callback(struct urb *urb);
157static void command_port_read_callback(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Alan Cox80359a92008-07-22 11:09:16 +0100159static int firm_send_command(struct usb_serial_port *port, __u8 command,
160 __u8 *data, __u8 datasize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161static int firm_open(struct usb_serial_port *port);
162static int firm_close(struct usb_serial_port *port);
Alan Coxfe1ae7f2009-09-19 13:13:33 -0700163static void firm_setup_port(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
165static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
166static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
167static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
168static int firm_get_dtr_rts(struct usb_serial_port *port);
169static 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*/
Alan Cox80359a92008-07-22 11:09:16 +0100195static int whiteheat_firmware_download(struct usb_serial *serial,
196 const struct usb_device_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
David Woodhouseec6752f2008-05-31 01:35:29 +0300198 int response, ret = -ENOENT;
199 const struct firmware *loader_fw = NULL, *firmware_fw = NULL;
200 const struct ihex_binrec *record;
201
David Woodhouseec6752f2008-05-31 01:35:29 +0300202 if (request_ihex_firmware(&firmware_fw, "whiteheat.fw",
203 &serial->dev->dev)) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700204 dev_err(&serial->dev->dev,
205 "%s - request \"whiteheat.fw\" failed\n", __func__);
David Woodhouseec6752f2008-05-31 01:35:29 +0300206 goto out;
207 }
208 if (request_ihex_firmware(&loader_fw, "whiteheat_loader.fw",
209 &serial->dev->dev)) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700210 dev_err(&serial->dev->dev,
211 "%s - request \"whiteheat_loader.fw\" failed\n",
212 __func__);
David Woodhouseec6752f2008-05-31 01:35:29 +0300213 goto out;
214 }
215 ret = 0;
Rene Buergel99495c72012-09-13 22:14:38 +0200216 response = ezusb_set_reset(serial->dev, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
David Woodhouseec6752f2008-05-31 01:35:29 +0300218 record = (const struct ihex_binrec *)loader_fw->data;
219 while (record) {
Rene Buergel99495c72012-09-13 22:14:38 +0200220 response = ezusb_writememory(serial->dev, be32_to_cpu(record->addr),
221 (unsigned char *)record->data,
222 be16_to_cpu(record->len), 0xa0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 if (response < 0) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700224 dev_err(&serial->dev->dev, "%s - ezusb_writememory "
225 "failed for loader (%d %04X %p %d)\n",
226 __func__, response, be32_to_cpu(record->addr),
227 record->data, be16_to_cpu(record->len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 break;
229 }
David Woodhouseec6752f2008-05-31 01:35:29 +0300230 record = ihex_next_binrec(record);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 }
232
Rene Buergel99495c72012-09-13 22:14:38 +0200233 response = ezusb_set_reset(serial->dev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
David Woodhouseec6752f2008-05-31 01:35:29 +0300235 record = (const struct ihex_binrec *)firmware_fw->data;
236 while (record && be32_to_cpu(record->addr) < 0x1b40)
237 record = ihex_next_binrec(record);
238 while (record) {
Rene Buergel99495c72012-09-13 22:14:38 +0200239 response = ezusb_writememory(serial->dev, be32_to_cpu(record->addr),
240 (unsigned char *)record->data,
241 be16_to_cpu(record->len), 0xa3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 if (response < 0) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700243 dev_err(&serial->dev->dev, "%s - ezusb_writememory "
244 "failed for first firmware step "
245 "(%d %04X %p %d)\n", __func__, response,
246 be32_to_cpu(record->addr), record->data,
247 be16_to_cpu(record->len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 break;
249 }
250 ++record;
251 }
Alan Cox80359a92008-07-22 11:09:16 +0100252
Rene Buergel99495c72012-09-13 22:14:38 +0200253 response = ezusb_set_reset(serial->dev, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
David Woodhouseec6752f2008-05-31 01:35:29 +0300255 record = (const struct ihex_binrec *)firmware_fw->data;
256 while (record && be32_to_cpu(record->addr) < 0x1b40) {
Rene Buergel99495c72012-09-13 22:14:38 +0200257 response = ezusb_writememory(serial->dev, be32_to_cpu(record->addr),
258 (unsigned char *)record->data,
259 be16_to_cpu(record->len), 0xa0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 if (response < 0) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700261 dev_err(&serial->dev->dev, "%s - ezusb_writememory "
262 "failed for second firmware step "
263 "(%d %04X %p %d)\n", __func__, response,
264 be32_to_cpu(record->addr), record->data,
265 be16_to_cpu(record->len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 break;
267 }
268 ++record;
269 }
David Woodhouseec6752f2008-05-31 01:35:29 +0300270 ret = 0;
Rene Buergel99495c72012-09-13 22:14:38 +0200271 response = ezusb_set_reset(serial->dev, 0);
David Woodhouseec6752f2008-05-31 01:35:29 +0300272 out:
273 release_firmware(loader_fw);
274 release_firmware(firmware_fw);
275 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276}
277
278
Alan Cox80359a92008-07-22 11:09:16 +0100279static int whiteheat_firmware_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
281 /* We want this device to fail to have a driver assigned to it */
282 return 1;
283}
284
285
286/*****************************************************************************
287 * Connect Tech's White Heat serial driver functions
288 *****************************************************************************/
Alan Cox80359a92008-07-22 11:09:16 +0100289static int whiteheat_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 struct usb_serial_port *command_port;
292 struct whiteheat_command_private *command_info;
293 struct usb_serial_port *port;
294 struct whiteheat_private *info;
295 struct whiteheat_hw_info *hw_info;
296 int pipe;
297 int ret;
298 int alen;
299 __u8 *command;
300 __u8 *result;
301 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303 command_port = serial->port[COMMAND_PORT];
304
Alan Cox80359a92008-07-22 11:09:16 +0100305 pipe = usb_sndbulkpipe(serial->dev,
306 command_port->bulk_out_endpointAddress);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 command = kmalloc(2, GFP_KERNEL);
308 if (!command)
309 goto no_command_buffer;
310 command[0] = WHITEHEAT_GET_HW_INFO;
311 command[1] = 0;
Alan Cox80359a92008-07-22 11:09:16 +0100312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
314 if (!result)
315 goto no_result_buffer;
316 /*
317 * When the module is reloaded the firmware is still there and
318 * the endpoints are still in the usb core unchanged. This is the
Alan Cox80359a92008-07-22 11:09:16 +0100319 * unlinking bug in disguise. Same for the call below.
320 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 usb_clear_halt(serial->dev, pipe);
Alan Cox80359a92008-07-22 11:09:16 +0100322 ret = usb_bulk_msg(serial->dev, pipe, command, 2,
323 &alen, COMMAND_TIMEOUT_MS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 if (ret) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700325 dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n",
326 serial->type->description, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 goto no_firmware;
Stuart MacDonald09fd6bc2006-05-31 13:28:40 -0400328 } else if (alen != 2) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700329 dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n",
330 serial->type->description, alen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 goto no_firmware;
332 }
333
Alan Cox80359a92008-07-22 11:09:16 +0100334 pipe = usb_rcvbulkpipe(serial->dev,
335 command_port->bulk_in_endpointAddress);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 /* See the comment on the usb_clear_halt() above */
337 usb_clear_halt(serial->dev, pipe);
Alan Cox80359a92008-07-22 11:09:16 +0100338 ret = usb_bulk_msg(serial->dev, pipe, result,
339 sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 if (ret) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700341 dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n",
342 serial->type->description, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 goto no_firmware;
Stuart MacDonald09fd6bc2006-05-31 13:28:40 -0400344 } else if (alen != sizeof(*hw_info) + 1) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700345 dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n",
346 serial->type->description, alen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 goto no_firmware;
348 } else if (result[0] != command[0]) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700349 dev_err(&serial->dev->dev, "%s: Command failed [%d]\n",
350 serial->type->description, result[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 goto no_firmware;
352 }
353
354 hw_info = (struct whiteheat_hw_info *)&result[1];
355
Johan Hovolda6765cb2012-03-22 16:50:54 +0100356 dev_info(&serial->dev->dev, "%s: Firmware v%d.%02d\n",
357 serial->type->description,
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -0700358 hw_info->sw_major_rev, hw_info->sw_minor_rev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 for (i = 0; i < serial->num_ports; i++) {
361 port = serial->port[i];
362
Robert P. J. Day5cbded52006-12-13 00:35:56 -0800363 info = kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 if (info == NULL) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700365 dev_err(&port->dev,
366 "%s: Out of memory for port structures\n",
367 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 goto no_private;
369 }
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 info->mcr = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373 usb_set_serial_port_data(port, info);
374 }
375
Alan Cox80359a92008-07-22 11:09:16 +0100376 command_info = kmalloc(sizeof(struct whiteheat_command_private),
377 GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 if (command_info == NULL) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700379 dev_err(&serial->dev->dev,
380 "%s: Out of memory for port structures\n",
381 serial->type->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 goto no_command_private;
383 }
384
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200385 mutex_init(&command_info->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 command_info->port_running = 0;
387 init_waitqueue_head(&command_info->wait_command);
388 usb_set_serial_port_data(command_port, command_info);
389 command_port->write_urb->complete = command_port_write_callback;
390 command_port->read_urb->complete = command_port_read_callback;
391 kfree(result);
392 kfree(command);
393
394 return 0;
395
396no_firmware:
397 /* Firmware likely not running */
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700398 dev_err(&serial->dev->dev,
399 "%s: Unable to retrieve firmware version, try replugging\n",
400 serial->type->description);
401 dev_err(&serial->dev->dev,
402 "%s: If the firmware is not running (status led not blinking)\n",
403 serial->type->description);
404 dev_err(&serial->dev->dev,
405 "%s: please contact support@connecttech.com\n",
406 serial->type->description);
Jesper Juhl67ca0282006-04-23 19:59:23 +0200407 kfree(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 return -ENODEV;
409
410no_command_private:
411 for (i = serial->num_ports - 1; i >= 0; i--) {
412 port = serial->port[i];
413 info = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 kfree(info);
415no_private:
416 ;
417 }
418 kfree(result);
419no_result_buffer:
420 kfree(command);
421no_command_buffer:
422 return -ENOMEM;
423}
424
425
Alan Sternf9c99bb2009-06-02 11:53:55 -0400426static void whiteheat_release(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427{
428 struct usb_serial_port *command_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 struct whiteheat_private *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 int i;
431
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 /* free up our private data for our command port */
433 command_port = serial->port[COMMAND_PORT];
Alan Cox80359a92008-07-22 11:09:16 +0100434 kfree(usb_get_serial_port_data(command_port));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436 for (i = 0; i < serial->num_ports; i++) {
Johan Hovold5c0c7582012-03-22 16:50:55 +0100437 info = usb_get_serial_port_data(serial->port[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 kfree(info);
439 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440}
441
Alan Coxa509a7e2009-09-19 13:13:26 -0700442static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
Johan Hovold5c0c7582012-03-22 16:50:55 +0100444 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 retval = start_command_port(port->serial);
447 if (retval)
448 goto exit;
449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 /* send an open port command */
451 retval = firm_open(port);
452 if (retval) {
453 stop_command_port(port->serial);
454 goto exit;
455 }
456
457 retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
458 if (retval) {
459 firm_close(port);
460 stop_command_port(port->serial);
461 goto exit;
462 }
463
Alan Cox72e27412008-07-22 11:09:29 +0100464 if (tty)
465 firm_setup_port(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
467 /* Work around HCD bugs */
468 usb_clear_halt(port->serial->dev, port->read_urb->pipe);
469 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
470
Johan Hovold5c0c7582012-03-22 16:50:55 +0100471 retval = usb_serial_generic_open(tty, port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 firm_close(port);
474 stop_command_port(port->serial);
475 goto exit;
476 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 return retval;
479}
480
481
Alan Cox335f8512009-06-11 12:26:29 +0100482static void whiteheat_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 firm_report_tx_done(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 firm_close(port);
486
Johan Hovold5c0c7582012-03-22 16:50:55 +0100487 usb_serial_generic_close(port);
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 stop_command_port(port->serial);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
Alan Cox60b33c12011-02-14 16:26:14 +0000492static int whiteheat_tiocmget(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
Alan Cox95da3102008-07-22 11:09:07 +0100494 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 struct whiteheat_private *info = usb_get_serial_port_data(port);
496 unsigned int modem_signals = 0;
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 firm_get_dtr_rts(port);
499 if (info->mcr & UART_MCR_DTR)
500 modem_signals |= TIOCM_DTR;
501 if (info->mcr & UART_MCR_RTS)
502 modem_signals |= TIOCM_RTS;
503
504 return modem_signals;
505}
506
Alan Cox20b9d172011-02-14 16:26:50 +0000507static int whiteheat_tiocmset(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 unsigned int set, unsigned int clear)
509{
Alan Cox95da3102008-07-22 11:09:07 +0100510 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 struct whiteheat_private *info = usb_get_serial_port_data(port);
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 if (set & TIOCM_RTS)
514 info->mcr |= UART_MCR_RTS;
515 if (set & TIOCM_DTR)
516 info->mcr |= UART_MCR_DTR;
517
518 if (clear & TIOCM_RTS)
519 info->mcr &= ~UART_MCR_RTS;
520 if (clear & TIOCM_DTR)
521 info->mcr &= ~UART_MCR_DTR;
522
523 firm_set_dtr(port, info->mcr & UART_MCR_DTR);
524 firm_set_rts(port, info->mcr & UART_MCR_RTS);
525 return 0;
526}
527
528
Alan Cox00a0d0d2011-02-14 16:27:06 +0000529static int whiteheat_ioctl(struct tty_struct *tty,
Alan Cox80359a92008-07-22 11:09:16 +0100530 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Alan Cox95da3102008-07-22 11:09:07 +0100532 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 struct serial_struct serstruct;
534 void __user *user_arg = (void __user *)arg;
535
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700536 dev_dbg(&port->dev, "%s - cmd 0x%.4x\n", __func__, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
538 switch (cmd) {
Alan Cox80359a92008-07-22 11:09:16 +0100539 case TIOCGSERIAL:
540 memset(&serstruct, 0, sizeof(serstruct));
541 serstruct.type = PORT_16654;
542 serstruct.line = port->serial->minor;
543 serstruct.port = port->number;
544 serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
Johan Hovold5c0c7582012-03-22 16:50:55 +0100545 serstruct.xmit_fifo_size = kfifo_size(&port->write_fifo);
Alan Cox80359a92008-07-22 11:09:16 +0100546 serstruct.custom_divisor = 0;
547 serstruct.baud_base = 460800;
548 serstruct.close_delay = CLOSING_DELAY;
549 serstruct.closing_wait = CLOSING_DELAY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Alan Cox80359a92008-07-22 11:09:16 +0100551 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
552 return -EFAULT;
553 break;
554 default:
555 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 }
557
558 return -ENOIOCTLCMD;
559}
560
561
Alan Cox80359a92008-07-22 11:09:16 +0100562static void whiteheat_set_termios(struct tty_struct *tty,
563 struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
Alan Cox95da3102008-07-22 11:09:07 +0100565 firm_setup_port(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566}
567
Alan Cox80359a92008-07-22 11:09:16 +0100568static void whiteheat_break_ctl(struct tty_struct *tty, int break_state)
569{
Alan Cox95da3102008-07-22 11:09:07 +0100570 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 firm_set_break(port, break_state);
572}
573
574
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575/*****************************************************************************
576 * Connect Tech's White Heat callback routines
577 *****************************************************************************/
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200578static void command_port_write_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
Greg Kroah-Hartman05400012007-06-15 15:44:13 -0700580 int status = urb->status;
581
Greg Kroah-Hartman05400012007-06-15 15:44:13 -0700582 if (status) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700583 dev_dbg(&urb->dev->dev, "nonzero urb status: %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return;
585 }
586}
587
588
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200589static void command_port_read_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Ming Leicdc97792008-02-24 18:41:47 +0800591 struct usb_serial_port *command_port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 struct whiteheat_command_private *command_info;
Greg Kroah-Hartman05400012007-06-15 15:44:13 -0700593 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 unsigned char *data = urb->transfer_buffer;
595 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 command_info = usb_get_serial_port_data(command_port);
598 if (!command_info) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700599 dev_dbg(&urb->dev->dev, "%s - command_info is NULL, exiting.\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return;
601 }
Greg Kroah-Hartman05400012007-06-15 15:44:13 -0700602 if (status) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700603 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n", __func__, status);
Greg Kroah-Hartman05400012007-06-15 15:44:13 -0700604 if (status != -ENOENT)
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200605 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
606 wake_up(&command_info->wait_command);
607 return;
608 }
609
Greg Kroah-Hartman59d33f22012-09-18 09:58:57 +0100610 usb_serial_debug_data(&command_port->dev, __func__, urb->actual_length, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612 if (data[0] == WHITEHEAT_CMD_COMPLETE) {
613 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200614 wake_up(&command_info->wait_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 } else if (data[0] == WHITEHEAT_CMD_FAILURE) {
616 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200617 wake_up(&command_info->wait_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 } else if (data[0] == WHITEHEAT_EVENT) {
Alan Cox80359a92008-07-22 11:09:16 +0100619 /* These are unsolicited reports from the firmware, hence no
620 waiting command to wakeup */
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700621 dev_dbg(&urb->dev->dev, "%s - event received\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 } else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
Alan Cox80359a92008-07-22 11:09:16 +0100623 memcpy(command_info->result_buffer, &data[1],
624 urb->actual_length - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200626 wake_up(&command_info->wait_command);
Alan Cox80359a92008-07-22 11:09:16 +0100627 } else
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700628 dev_dbg(&urb->dev->dev, "%s - bad reply from firmware\n", __func__);
Alan Cox80359a92008-07-22 11:09:16 +0100629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 /* Continue trying to always read */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 if (result)
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700633 dev_dbg(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n",
Alan Cox80359a92008-07-22 11:09:16 +0100634 __func__, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
636
637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638/*****************************************************************************
639 * Connect Tech's White Heat firmware interface
640 *****************************************************************************/
Alan Cox80359a92008-07-22 11:09:16 +0100641static int firm_send_command(struct usb_serial_port *port, __u8 command,
642 __u8 *data, __u8 datasize)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
644 struct usb_serial_port *command_port;
645 struct whiteheat_command_private *command_info;
646 struct whiteheat_private *info;
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700647 struct device *dev = &port->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 __u8 *transfer_buffer;
649 int retval = 0;
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200650 int t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700652 dev_dbg(dev, "%s - command %d\n", __func__, command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 command_port = port->serial->port[COMMAND_PORT];
655 command_info = usb_get_serial_port_data(command_port);
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200656 mutex_lock(&command_info->mutex);
Richard Knutsson38c3cb52007-03-26 22:00:28 -0800657 command_info->command_finished = false;
Alan Cox80359a92008-07-22 11:09:16 +0100658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
660 transfer_buffer[0] = command;
Alan Cox80359a92008-07-22 11:09:16 +0100661 memcpy(&transfer_buffer[1], data, datasize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 command_port->write_urb->transfer_buffer_length = datasize + 1;
Alan Cox80359a92008-07-22 11:09:16 +0100663 retval = usb_submit_urb(command_port->write_urb, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 if (retval) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700665 dev_dbg(dev, "%s - submit urb failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 goto exit;
667 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
669 /* wait for the command to complete */
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200670 t = wait_event_timeout(command_info->wait_command,
Richard Knutsson38c3cb52007-03-26 22:00:28 -0800671 (bool)command_info->command_finished, COMMAND_TIMEOUT);
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200672 if (!t)
673 usb_kill_urb(command_port->write_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Richard Knutsson38c3cb52007-03-26 22:00:28 -0800675 if (command_info->command_finished == false) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700676 dev_dbg(dev, "%s - command timed out.\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 retval = -ETIMEDOUT;
678 goto exit;
679 }
680
681 if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700682 dev_dbg(dev, "%s - command failed.\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 retval = -EIO;
684 goto exit;
685 }
686
687 if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700688 dev_dbg(dev, "%s - command completed.\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 switch (command) {
Alan Cox80359a92008-07-22 11:09:16 +0100690 case WHITEHEAT_GET_DTR_RTS:
691 info = usb_get_serial_port_data(port);
692 memcpy(&info->mcr, command_info->result_buffer,
693 sizeof(struct whiteheat_dr_info));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 break;
695 }
696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697exit:
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200698 mutex_unlock(&command_info->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return retval;
700}
701
702
Alan Cox80359a92008-07-22 11:09:16 +0100703static int firm_open(struct usb_serial_port *port)
704{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 struct whiteheat_simple open_command;
706
707 open_command.port = port->number - port->serial->minor + 1;
Alan Cox80359a92008-07-22 11:09:16 +0100708 return firm_send_command(port, WHITEHEAT_OPEN,
709 (__u8 *)&open_command, sizeof(open_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710}
711
712
Alan Cox80359a92008-07-22 11:09:16 +0100713static int firm_close(struct usb_serial_port *port)
714{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 struct whiteheat_simple close_command;
716
717 close_command.port = port->number - port->serial->minor + 1;
Alan Cox80359a92008-07-22 11:09:16 +0100718 return firm_send_command(port, WHITEHEAT_CLOSE,
719 (__u8 *)&close_command, sizeof(close_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720}
721
722
Alan Coxfe1ae7f2009-09-19 13:13:33 -0700723static void firm_setup_port(struct tty_struct *tty)
Alan Cox80359a92008-07-22 11:09:16 +0100724{
Alan Cox95da3102008-07-22 11:09:07 +0100725 struct usb_serial_port *port = tty->driver_data;
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700726 struct device *dev = &port->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 struct whiteheat_port_settings port_settings;
Alan Cox95da3102008-07-22 11:09:07 +0100728 unsigned int cflag = tty->termios->c_cflag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 port_settings.port = port->number + 1;
731
732 /* get the byte size */
733 switch (cflag & CSIZE) {
Alan Cox80359a92008-07-22 11:09:16 +0100734 case CS5: port_settings.bits = 5; break;
735 case CS6: port_settings.bits = 6; break;
736 case CS7: port_settings.bits = 7; break;
737 default:
738 case CS8: port_settings.bits = 8; break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 }
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700740 dev_dbg(dev, "%s - data bits = %d\n", __func__, port_settings.bits);
Alan Cox80359a92008-07-22 11:09:16 +0100741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 /* determine the parity */
743 if (cflag & PARENB)
744 if (cflag & CMSPAR)
745 if (cflag & PARODD)
746 port_settings.parity = WHITEHEAT_PAR_MARK;
747 else
748 port_settings.parity = WHITEHEAT_PAR_SPACE;
749 else
750 if (cflag & PARODD)
751 port_settings.parity = WHITEHEAT_PAR_ODD;
752 else
753 port_settings.parity = WHITEHEAT_PAR_EVEN;
754 else
755 port_settings.parity = WHITEHEAT_PAR_NONE;
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700756 dev_dbg(dev, "%s - parity = %c\n", __func__, port_settings.parity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
758 /* figure out the stop bits requested */
759 if (cflag & CSTOPB)
760 port_settings.stop = 2;
761 else
762 port_settings.stop = 1;
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700763 dev_dbg(dev, "%s - stop bits = %d\n", __func__, port_settings.stop);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
765 /* figure out the flow control settings */
766 if (cflag & CRTSCTS)
Alan Cox80359a92008-07-22 11:09:16 +0100767 port_settings.hflow = (WHITEHEAT_HFLOW_CTS |
768 WHITEHEAT_HFLOW_RTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 else
770 port_settings.hflow = WHITEHEAT_HFLOW_NONE;
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700771 dev_dbg(dev, "%s - hardware flow control = %s %s %s %s\n", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
773 (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
774 (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
775 (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
Alan Cox80359a92008-07-22 11:09:16 +0100776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 /* determine software flow control */
Alan Cox95da3102008-07-22 11:09:07 +0100778 if (I_IXOFF(tty))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
780 else
781 port_settings.sflow = WHITEHEAT_SFLOW_NONE;
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700782 dev_dbg(dev, "%s - software flow control = %c\n", __func__, port_settings.sflow);
Alan Cox80359a92008-07-22 11:09:16 +0100783
Alan Cox95da3102008-07-22 11:09:07 +0100784 port_settings.xon = START_CHAR(tty);
785 port_settings.xoff = STOP_CHAR(tty);
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700786 dev_dbg(dev, "%s - XON = %2x, XOFF = %2x\n", __func__, port_settings.xon, port_settings.xoff);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788 /* get the baud rate wanted */
Alan Cox95da3102008-07-22 11:09:07 +0100789 port_settings.baud = tty_get_baud_rate(tty);
Greg Kroah-Hartman255b7032012-09-14 11:50:35 -0700790 dev_dbg(dev, "%s - baud rate = %d\n", __func__, port_settings.baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Alan Cox01d1df22007-10-18 01:24:23 -0700792 /* fixme: should set validated settings */
Alan Cox95da3102008-07-22 11:09:07 +0100793 tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 /* handle any settings that aren't specified in the tty structure */
795 port_settings.lloop = 0;
Alan Cox80359a92008-07-22 11:09:16 +0100796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 /* now send the message to the device */
Alan Coxfe1ae7f2009-09-19 13:13:33 -0700798 firm_send_command(port, WHITEHEAT_SETUP_PORT,
Alan Cox80359a92008-07-22 11:09:16 +0100799 (__u8 *)&port_settings, sizeof(port_settings));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
802
Alan Cox80359a92008-07-22 11:09:16 +0100803static int firm_set_rts(struct usb_serial_port *port, __u8 onoff)
804{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 struct whiteheat_set_rdb rts_command;
806
807 rts_command.port = port->number - port->serial->minor + 1;
808 rts_command.state = onoff;
Alan Cox80359a92008-07-22 11:09:16 +0100809 return firm_send_command(port, WHITEHEAT_SET_RTS,
810 (__u8 *)&rts_command, sizeof(rts_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811}
812
813
Alan Cox80359a92008-07-22 11:09:16 +0100814static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff)
815{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 struct whiteheat_set_rdb dtr_command;
817
818 dtr_command.port = port->number - port->serial->minor + 1;
819 dtr_command.state = onoff;
Alan Cox72e27412008-07-22 11:09:29 +0100820 return firm_send_command(port, WHITEHEAT_SET_DTR,
Alan Cox80359a92008-07-22 11:09:16 +0100821 (__u8 *)&dtr_command, sizeof(dtr_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822}
823
824
Alan Cox80359a92008-07-22 11:09:16 +0100825static int firm_set_break(struct usb_serial_port *port, __u8 onoff)
826{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 struct whiteheat_set_rdb break_command;
828
829 break_command.port = port->number - port->serial->minor + 1;
830 break_command.state = onoff;
Alan Cox72e27412008-07-22 11:09:29 +0100831 return firm_send_command(port, WHITEHEAT_SET_BREAK,
Alan Cox80359a92008-07-22 11:09:16 +0100832 (__u8 *)&break_command, sizeof(break_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
834
835
Alan Cox80359a92008-07-22 11:09:16 +0100836static int firm_purge(struct usb_serial_port *port, __u8 rxtx)
837{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 struct whiteheat_purge purge_command;
839
840 purge_command.port = port->number - port->serial->minor + 1;
841 purge_command.what = rxtx;
Alan Cox80359a92008-07-22 11:09:16 +0100842 return firm_send_command(port, WHITEHEAT_PURGE,
843 (__u8 *)&purge_command, sizeof(purge_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844}
845
846
Alan Cox80359a92008-07-22 11:09:16 +0100847static int firm_get_dtr_rts(struct usb_serial_port *port)
848{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 struct whiteheat_simple get_dr_command;
850
851 get_dr_command.port = port->number - port->serial->minor + 1;
Alan Cox80359a92008-07-22 11:09:16 +0100852 return firm_send_command(port, WHITEHEAT_GET_DTR_RTS,
853 (__u8 *)&get_dr_command, sizeof(get_dr_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854}
855
856
Alan Cox80359a92008-07-22 11:09:16 +0100857static int firm_report_tx_done(struct usb_serial_port *port)
858{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 struct whiteheat_simple close_command;
860
861 close_command.port = port->number - port->serial->minor + 1;
Alan Cox80359a92008-07-22 11:09:16 +0100862 return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE,
863 (__u8 *)&close_command, sizeof(close_command));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864}
865
866
867/*****************************************************************************
868 * Connect Tech's White Heat utility functions
869 *****************************************************************************/
870static int start_command_port(struct usb_serial *serial)
871{
872 struct usb_serial_port *command_port;
873 struct whiteheat_command_private *command_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 int retval = 0;
Alan Cox80359a92008-07-22 11:09:16 +0100875
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 command_port = serial->port[COMMAND_PORT];
877 command_info = usb_get_serial_port_data(command_port);
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200878 mutex_lock(&command_info->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 if (!command_info->port_running) {
880 /* Work around HCD bugs */
881 usb_clear_halt(serial->dev, command_port->read_urb->pipe);
882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
884 if (retval) {
Greg Kroah-Hartman194343d2008-08-20 16:56:34 -0700885 dev_err(&serial->dev->dev,
886 "%s - failed submitting read urb, error %d\n",
887 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 goto exit;
889 }
890 }
891 command_info->port_running++;
892
893exit:
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200894 mutex_unlock(&command_info->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 return retval;
896}
897
898
899static void stop_command_port(struct usb_serial *serial)
900{
901 struct usb_serial_port *command_port;
902 struct whiteheat_command_private *command_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904 command_port = serial->port[COMMAND_PORT];
905 command_info = usb_get_serial_port_data(command_port);
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200906 mutex_lock(&command_info->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 command_info->port_running--;
908 if (!command_info->port_running)
909 usb_kill_urb(command_port->read_urb);
Oliver Neukum08a2b3b2007-05-24 13:52:51 +0200910 mutex_unlock(&command_info->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911}
912
Greg Kroah-Hartman68e24112012-05-08 15:46:14 -0700913module_usb_serial_driver(serial_drivers, id_table_combined);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
Alan Cox80359a92008-07-22 11:09:16 +0100915MODULE_AUTHOR(DRIVER_AUTHOR);
916MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917MODULE_LICENSE("GPL");
918
David Woodhouseec6752f2008-05-31 01:35:29 +0300919MODULE_FIRMWARE("whiteheat.fw");
920MODULE_FIRMWARE("whiteheat_loader.fw");
921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922module_param(debug, bool, S_IRUGO | S_IWUSR);
923MODULE_PARM_DESC(debug, "Debug enabled or not");