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