]>
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> | |
1da177e4 LT |
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> | |
08a2b3b6 | 27 | #include <linux/mutex.h> |
80359a9c | 28 | #include <linux/uaccess.h> |
1da177e4 LT |
29 | #include <asm/termbits.h> |
30 | #include <linux/usb.h> | |
31 | #include <linux/serial_reg.h> | |
32 | #include <linux/serial.h> | |
a969888c | 33 | #include <linux/usb/serial.h> |
cc183e2a | 34 | #include <linux/usb/ezusb.h> |
1da177e4 LT |
35 | #include "whiteheat.h" /* WhiteHEAT specific commands */ |
36 | ||
1da177e4 LT |
37 | #ifndef CMSPAR |
38 | #define CMSPAR 0 | |
39 | #endif | |
40 | ||
41 | /* | |
42 | * Version Information | |
43 | */ | |
1da177e4 LT |
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 | */ | |
7d40d7e8 | 58 | static const struct usb_device_id id_table_std[] = { |
1da177e4 LT |
59 | { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) }, |
60 | { } /* Terminating entry */ | |
61 | }; | |
62 | ||
7d40d7e8 | 63 | static const struct usb_device_id id_table_prerenumeration[] = { |
1da177e4 LT |
64 | { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) }, |
65 | { } /* Terminating entry */ | |
66 | }; | |
67 | ||
7d40d7e8 | 68 | static const struct usb_device_id id_table_combined[] = { |
1da177e4 LT |
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 | ||
80359a9c | 74 | MODULE_DEVICE_TABLE(usb, id_table_combined); |
1da177e4 | 75 | |
1da177e4 LT |
76 | |
77 | /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */ | |
80359a9c AC |
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); | |
1da177e4 LT |
81 | |
82 | /* function prototypes for the Connect Tech WhiteHEAT serial converter */ | |
80359a9c | 83 | static int whiteheat_attach(struct usb_serial *serial); |
f9c99bb8 | 84 | static void whiteheat_release(struct usb_serial *serial); |
c467206e JH |
85 | static int whiteheat_port_probe(struct usb_serial_port *port); |
86 | static int whiteheat_port_remove(struct usb_serial_port *port); | |
80359a9c | 87 | static int whiteheat_open(struct tty_struct *tty, |
a509a7e4 | 88 | struct usb_serial_port *port); |
335f8514 | 89 | static void whiteheat_close(struct usb_serial_port *port); |
00a0d0d6 | 90 | static int whiteheat_ioctl(struct tty_struct *tty, |
80359a9c AC |
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); | |
60b33c13 | 94 | static int whiteheat_tiocmget(struct tty_struct *tty); |
20b9d177 | 95 | static int whiteheat_tiocmset(struct tty_struct *tty, |
80359a9c AC |
96 | unsigned int set, unsigned int clear); |
97 | static void whiteheat_break_ctl(struct tty_struct *tty, int break_state); | |
1da177e4 | 98 | |
ea65370d | 99 | static struct usb_serial_driver whiteheat_fake_device = { |
18fcac35 GKH |
100 | .driver = { |
101 | .owner = THIS_MODULE, | |
269bda1c | 102 | .name = "whiteheatnofirm", |
18fcac35 | 103 | }, |
269bda1c | 104 | .description = "Connect Tech - WhiteHEAT - (prerenumeration)", |
1da177e4 | 105 | .id_table = id_table_prerenumeration, |
1da177e4 LT |
106 | .num_ports = 1, |
107 | .probe = whiteheat_firmware_download, | |
108 | .attach = whiteheat_firmware_attach, | |
109 | }; | |
110 | ||
ea65370d | 111 | static struct usb_serial_driver whiteheat_device = { |
18fcac35 GKH |
112 | .driver = { |
113 | .owner = THIS_MODULE, | |
269bda1c | 114 | .name = "whiteheat", |
18fcac35 | 115 | }, |
269bda1c | 116 | .description = "Connect Tech - WhiteHEAT", |
1da177e4 | 117 | .id_table = id_table_std, |
1da177e4 LT |
118 | .num_ports = 4, |
119 | .attach = whiteheat_attach, | |
f9c99bb8 | 120 | .release = whiteheat_release, |
c467206e JH |
121 | .port_probe = whiteheat_port_probe, |
122 | .port_remove = whiteheat_port_remove, | |
1da177e4 LT |
123 | .open = whiteheat_open, |
124 | .close = whiteheat_close, | |
1da177e4 LT |
125 | .ioctl = whiteheat_ioctl, |
126 | .set_termios = whiteheat_set_termios, | |
127 | .break_ctl = whiteheat_break_ctl, | |
128 | .tiocmget = whiteheat_tiocmget, | |
129 | .tiocmset = whiteheat_tiocmset, | |
5c0c7582 JH |
130 | .throttle = usb_serial_generic_throttle, |
131 | .unthrottle = usb_serial_generic_unthrottle, | |
1da177e4 LT |
132 | }; |
133 | ||
29618e9f AS |
134 | static struct usb_serial_driver * const serial_drivers[] = { |
135 | &whiteheat_fake_device, &whiteheat_device, NULL | |
136 | }; | |
1da177e4 LT |
137 | |
138 | struct whiteheat_command_private { | |
08a2b3b6 | 139 | struct mutex mutex; |
1da177e4 LT |
140 | __u8 port_running; |
141 | __u8 command_finished; | |
80359a9c AC |
142 | wait_queue_head_t wait_command; /* for handling sleeping whilst |
143 | waiting for a command to | |
144 | finish */ | |
1da177e4 LT |
145 | __u8 result_buffer[64]; |
146 | }; | |
147 | ||
1da177e4 | 148 | struct whiteheat_private { |
a5b6f60c | 149 | __u8 mcr; /* FIXME: no locking on mcr */ |
1da177e4 LT |
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); | |
7d12e780 DH |
156 | static void command_port_write_callback(struct urb *urb); |
157 | static void command_port_read_callback(struct urb *urb); | |
1da177e4 | 158 | |
80359a9c AC |
159 | static int firm_send_command(struct usb_serial_port *port, __u8 command, |
160 | __u8 *data, __u8 datasize); | |
1da177e4 LT |
161 | static int firm_open(struct usb_serial_port *port); |
162 | static int firm_close(struct usb_serial_port *port); | |
fe1ae7fd | 163 | static void firm_setup_port(struct tty_struct *tty); |
1da177e4 LT |
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 | */ | |
80359a9c AC |
195 | static int whiteheat_firmware_download(struct usb_serial *serial, |
196 | const struct usb_device_id *id) | |
1da177e4 | 197 | { |
8d733e26 | 198 | int response; |
ec6752f5 | 199 | |
8d733e26 RB |
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; | |
ec6752f5 | 205 | } |
8d733e26 | 206 | return -ENOENT; |
1da177e4 LT |
207 | } |
208 | ||
209 | ||
80359a9c | 210 | static int whiteheat_firmware_attach(struct usb_serial *serial) |
1da177e4 LT |
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 | *****************************************************************************/ | |
80359a9c | 220 | static int whiteheat_attach(struct usb_serial *serial) |
1da177e4 LT |
221 | { |
222 | struct usb_serial_port *command_port; | |
223 | struct whiteheat_command_private *command_info; | |
1da177e4 LT |
224 | struct whiteheat_hw_info *hw_info; |
225 | int pipe; | |
226 | int ret; | |
227 | int alen; | |
228 | __u8 *command; | |
229 | __u8 *result; | |
1da177e4 LT |
230 | |
231 | command_port = serial->port[COMMAND_PORT]; | |
232 | ||
80359a9c AC |
233 | pipe = usb_sndbulkpipe(serial->dev, |
234 | command_port->bulk_out_endpointAddress); | |
1da177e4 LT |
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; | |
80359a9c | 240 | |
1da177e4 LT |
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 | |
80359a9c AC |
247 | * unlinking bug in disguise. Same for the call below. |
248 | */ | |
1da177e4 | 249 | usb_clear_halt(serial->dev, pipe); |
80359a9c AC |
250 | ret = usb_bulk_msg(serial->dev, pipe, command, 2, |
251 | &alen, COMMAND_TIMEOUT_MS); | |
1da177e4 | 252 | if (ret) { |
194343d9 GKH |
253 | dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n", |
254 | serial->type->description, ret); | |
1da177e4 | 255 | goto no_firmware; |
09fd6bc8 | 256 | } else if (alen != 2) { |
194343d9 GKH |
257 | dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n", |
258 | serial->type->description, alen); | |
1da177e4 LT |
259 | goto no_firmware; |
260 | } | |
261 | ||
80359a9c AC |
262 | pipe = usb_rcvbulkpipe(serial->dev, |
263 | command_port->bulk_in_endpointAddress); | |
1da177e4 LT |
264 | /* See the comment on the usb_clear_halt() above */ |
265 | usb_clear_halt(serial->dev, pipe); | |
80359a9c AC |
266 | ret = usb_bulk_msg(serial->dev, pipe, result, |
267 | sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS); | |
1da177e4 | 268 | if (ret) { |
194343d9 GKH |
269 | dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n", |
270 | serial->type->description, ret); | |
1da177e4 | 271 | goto no_firmware; |
09fd6bc8 | 272 | } else if (alen != sizeof(*hw_info) + 1) { |
194343d9 GKH |
273 | dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n", |
274 | serial->type->description, alen); | |
1da177e4 LT |
275 | goto no_firmware; |
276 | } else if (result[0] != command[0]) { | |
194343d9 GKH |
277 | dev_err(&serial->dev->dev, "%s: Command failed [%d]\n", |
278 | serial->type->description, result[0]); | |
1da177e4 LT |
279 | goto no_firmware; |
280 | } | |
281 | ||
282 | hw_info = (struct whiteheat_hw_info *)&result[1]; | |
283 | ||
a6765cba JH |
284 | dev_info(&serial->dev->dev, "%s: Firmware v%d.%02d\n", |
285 | serial->type->description, | |
c197a8db | 286 | hw_info->sw_major_rev, hw_info->sw_minor_rev); |
1da177e4 | 287 | |
80359a9c AC |
288 | command_info = kmalloc(sizeof(struct whiteheat_command_private), |
289 | GFP_KERNEL); | |
10c642d0 | 290 | if (!command_info) |
1da177e4 | 291 | goto no_command_private; |
1da177e4 | 292 | |
08a2b3b6 | 293 | mutex_init(&command_info->mutex); |
1da177e4 LT |
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 */ | |
194343d9 GKH |
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); | |
67ca0284 | 315 | kfree(result); |
c129197c | 316 | kfree(command); |
1da177e4 LT |
317 | return -ENODEV; |
318 | ||
319 | no_command_private: | |
1da177e4 LT |
320 | kfree(result); |
321 | no_result_buffer: | |
322 | kfree(command); | |
323 | no_command_buffer: | |
324 | return -ENOMEM; | |
325 | } | |
326 | ||
f9c99bb8 | 327 | static void whiteheat_release(struct usb_serial *serial) |
1da177e4 LT |
328 | { |
329 | struct usb_serial_port *command_port; | |
1da177e4 | 330 | |
1da177e4 LT |
331 | /* free up our private data for our command port */ |
332 | command_port = serial->port[COMMAND_PORT]; | |
80359a9c | 333 | kfree(usb_get_serial_port_data(command_port)); |
c467206e | 334 | } |
1da177e4 | 335 | |
c467206e JH |
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; | |
1da177e4 LT |
357 | } |
358 | ||
a509a7e4 | 359 | static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port) |
1da177e4 | 360 | { |
5c0c7582 | 361 | int retval; |
1da177e4 | 362 | |
1da177e4 LT |
363 | retval = start_command_port(port->serial); |
364 | if (retval) | |
365 | goto exit; | |
366 | ||
1da177e4 LT |
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 | ||
72e27412 AC |
381 | if (tty) |
382 | firm_setup_port(tty); | |
1da177e4 LT |
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 | ||
5c0c7582 | 388 | retval = usb_serial_generic_open(tty, port); |
1da177e4 | 389 | if (retval) { |
1da177e4 LT |
390 | firm_close(port); |
391 | stop_command_port(port->serial); | |
392 | goto exit; | |
393 | } | |
1da177e4 | 394 | exit: |
1da177e4 LT |
395 | return retval; |
396 | } | |
397 | ||
398 | ||
335f8514 | 399 | static void whiteheat_close(struct usb_serial_port *port) |
1da177e4 | 400 | { |
1da177e4 | 401 | firm_report_tx_done(port); |
1da177e4 LT |
402 | firm_close(port); |
403 | ||
5c0c7582 | 404 | usb_serial_generic_close(port); |
1da177e4 | 405 | |
5c0c7582 | 406 | stop_command_port(port->serial); |
1da177e4 LT |
407 | } |
408 | ||
60b33c13 | 409 | static int whiteheat_tiocmget(struct tty_struct *tty) |
1da177e4 | 410 | { |
95da310e | 411 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
412 | struct whiteheat_private *info = usb_get_serial_port_data(port); |
413 | unsigned int modem_signals = 0; | |
414 | ||
1da177e4 LT |
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 | ||
20b9d177 | 424 | static int whiteheat_tiocmset(struct tty_struct *tty, |
1da177e4 LT |
425 | unsigned int set, unsigned int clear) |
426 | { | |
95da310e | 427 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
428 | struct whiteheat_private *info = usb_get_serial_port_data(port); |
429 | ||
1da177e4 LT |
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 | ||
00a0d0d6 | 446 | static int whiteheat_ioctl(struct tty_struct *tty, |
80359a9c | 447 | unsigned int cmd, unsigned long arg) |
1da177e4 | 448 | { |
95da310e | 449 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
450 | struct serial_struct serstruct; |
451 | void __user *user_arg = (void __user *)arg; | |
452 | ||
1da177e4 | 453 | switch (cmd) { |
80359a9c AC |
454 | case TIOCGSERIAL: |
455 | memset(&serstruct, 0, sizeof(serstruct)); | |
456 | serstruct.type = PORT_16654; | |
e5b1e206 | 457 | serstruct.line = port->minor; |
1143832e | 458 | serstruct.port = port->port_number; |
80359a9c | 459 | serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ; |
5c0c7582 | 460 | serstruct.xmit_fifo_size = kfifo_size(&port->write_fifo); |
80359a9c AC |
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; | |
1da177e4 LT |
471 | } |
472 | ||
473 | return -ENOIOCTLCMD; | |
474 | } | |
475 | ||
476 | ||
80359a9c AC |
477 | static void whiteheat_set_termios(struct tty_struct *tty, |
478 | struct usb_serial_port *port, struct ktermios *old_termios) | |
1da177e4 | 479 | { |
95da310e | 480 | firm_setup_port(tty); |
1da177e4 LT |
481 | } |
482 | ||
80359a9c AC |
483 | static void whiteheat_break_ctl(struct tty_struct *tty, int break_state) |
484 | { | |
95da310e | 485 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
486 | firm_set_break(port, break_state); |
487 | } | |
488 | ||
489 | ||
1da177e4 LT |
490 | /***************************************************************************** |
491 | * Connect Tech's White Heat callback routines | |
492 | *****************************************************************************/ | |
08a2b3b6 | 493 | static void command_port_write_callback(struct urb *urb) |
1da177e4 | 494 | { |
05400013 GKH |
495 | int status = urb->status; |
496 | ||
05400013 | 497 | if (status) { |
255b703a | 498 | dev_dbg(&urb->dev->dev, "nonzero urb status: %d\n", status); |
1da177e4 LT |
499 | return; |
500 | } | |
501 | } | |
502 | ||
503 | ||
08a2b3b6 | 504 | static void command_port_read_callback(struct urb *urb) |
1da177e4 | 505 | { |
cdc97792 | 506 | struct usb_serial_port *command_port = urb->context; |
1da177e4 | 507 | struct whiteheat_command_private *command_info; |
05400013 | 508 | int status = urb->status; |
1da177e4 LT |
509 | unsigned char *data = urb->transfer_buffer; |
510 | int result; | |
1da177e4 | 511 | |
08a2b3b6 ON |
512 | command_info = usb_get_serial_port_data(command_port); |
513 | if (!command_info) { | |
255b703a | 514 | dev_dbg(&urb->dev->dev, "%s - command_info is NULL, exiting.\n", __func__); |
08a2b3b6 ON |
515 | return; |
516 | } | |
05400013 | 517 | if (status) { |
255b703a | 518 | dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n", __func__, status); |
05400013 | 519 | if (status != -ENOENT) |
08a2b3b6 ON |
520 | command_info->command_finished = WHITEHEAT_CMD_FAILURE; |
521 | wake_up(&command_info->wait_command); | |
1da177e4 LT |
522 | return; |
523 | } | |
524 | ||
59d33f2f | 525 | usb_serial_debug_data(&command_port->dev, __func__, urb->actual_length, data); |
1da177e4 | 526 | |
1da177e4 LT |
527 | if (data[0] == WHITEHEAT_CMD_COMPLETE) { |
528 | command_info->command_finished = WHITEHEAT_CMD_COMPLETE; | |
08a2b3b6 | 529 | wake_up(&command_info->wait_command); |
1da177e4 LT |
530 | } else if (data[0] == WHITEHEAT_CMD_FAILURE) { |
531 | command_info->command_finished = WHITEHEAT_CMD_FAILURE; | |
08a2b3b6 | 532 | wake_up(&command_info->wait_command); |
1da177e4 | 533 | } else if (data[0] == WHITEHEAT_EVENT) { |
80359a9c AC |
534 | /* These are unsolicited reports from the firmware, hence no |
535 | waiting command to wakeup */ | |
255b703a | 536 | dev_dbg(&urb->dev->dev, "%s - event received\n", __func__); |
1da177e4 | 537 | } else if (data[0] == WHITEHEAT_GET_DTR_RTS) { |
80359a9c AC |
538 | memcpy(command_info->result_buffer, &data[1], |
539 | urb->actual_length - 1); | |
1da177e4 | 540 | command_info->command_finished = WHITEHEAT_CMD_COMPLETE; |
08a2b3b6 | 541 | wake_up(&command_info->wait_command); |
80359a9c | 542 | } else |
255b703a | 543 | dev_dbg(&urb->dev->dev, "%s - bad reply from firmware\n", __func__); |
80359a9c | 544 | |
1da177e4 | 545 | /* Continue trying to always read */ |
1da177e4 | 546 | result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC); |
1da177e4 | 547 | if (result) |
255b703a | 548 | dev_dbg(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", |
80359a9c | 549 | __func__, result); |
1da177e4 LT |
550 | } |
551 | ||
552 | ||
1da177e4 LT |
553 | /***************************************************************************** |
554 | * Connect Tech's White Heat firmware interface | |
555 | *****************************************************************************/ | |
80359a9c AC |
556 | static int firm_send_command(struct usb_serial_port *port, __u8 command, |
557 | __u8 *data, __u8 datasize) | |
1da177e4 LT |
558 | { |
559 | struct usb_serial_port *command_port; | |
560 | struct whiteheat_command_private *command_info; | |
561 | struct whiteheat_private *info; | |
255b703a | 562 | struct device *dev = &port->dev; |
1da177e4 LT |
563 | __u8 *transfer_buffer; |
564 | int retval = 0; | |
08a2b3b6 | 565 | int t; |
1da177e4 | 566 | |
255b703a | 567 | dev_dbg(dev, "%s - command %d\n", __func__, command); |
1da177e4 LT |
568 | |
569 | command_port = port->serial->port[COMMAND_PORT]; | |
570 | command_info = usb_get_serial_port_data(command_port); | |
08a2b3b6 | 571 | mutex_lock(&command_info->mutex); |
38c3cb5b | 572 | command_info->command_finished = false; |
80359a9c | 573 | |
1da177e4 LT |
574 | transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer; |
575 | transfer_buffer[0] = command; | |
80359a9c | 576 | memcpy(&transfer_buffer[1], data, datasize); |
1da177e4 | 577 | command_port->write_urb->transfer_buffer_length = datasize + 1; |
80359a9c | 578 | retval = usb_submit_urb(command_port->write_urb, GFP_NOIO); |
1da177e4 | 579 | if (retval) { |
255b703a | 580 | dev_dbg(dev, "%s - submit urb failed\n", __func__); |
1da177e4 LT |
581 | goto exit; |
582 | } | |
1da177e4 LT |
583 | |
584 | /* wait for the command to complete */ | |
08a2b3b6 | 585 | t = wait_event_timeout(command_info->wait_command, |
38c3cb5b | 586 | (bool)command_info->command_finished, COMMAND_TIMEOUT); |
08a2b3b6 ON |
587 | if (!t) |
588 | usb_kill_urb(command_port->write_urb); | |
1da177e4 | 589 | |
38c3cb5b | 590 | if (command_info->command_finished == false) { |
255b703a | 591 | dev_dbg(dev, "%s - command timed out.\n", __func__); |
1da177e4 LT |
592 | retval = -ETIMEDOUT; |
593 | goto exit; | |
594 | } | |
595 | ||
596 | if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) { | |
255b703a | 597 | dev_dbg(dev, "%s - command failed.\n", __func__); |
1da177e4 LT |
598 | retval = -EIO; |
599 | goto exit; | |
600 | } | |
601 | ||
602 | if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) { | |
255b703a | 603 | dev_dbg(dev, "%s - command completed.\n", __func__); |
1da177e4 | 604 | switch (command) { |
80359a9c AC |
605 | case WHITEHEAT_GET_DTR_RTS: |
606 | info = usb_get_serial_port_data(port); | |
607 | memcpy(&info->mcr, command_info->result_buffer, | |
608 | sizeof(struct whiteheat_dr_info)); | |
1da177e4 LT |
609 | break; |
610 | } | |
611 | } | |
1da177e4 | 612 | exit: |
08a2b3b6 | 613 | mutex_unlock(&command_info->mutex); |
1da177e4 LT |
614 | return retval; |
615 | } | |
616 | ||
617 | ||
80359a9c AC |
618 | static int firm_open(struct usb_serial_port *port) |
619 | { | |
1da177e4 LT |
620 | struct whiteheat_simple open_command; |
621 | ||
1143832e | 622 | open_command.port = port->port_number + 1; |
80359a9c AC |
623 | return firm_send_command(port, WHITEHEAT_OPEN, |
624 | (__u8 *)&open_command, sizeof(open_command)); | |
1da177e4 LT |
625 | } |
626 | ||
627 | ||
80359a9c AC |
628 | static int firm_close(struct usb_serial_port *port) |
629 | { | |
1da177e4 LT |
630 | struct whiteheat_simple close_command; |
631 | ||
1143832e | 632 | close_command.port = port->port_number + 1; |
80359a9c AC |
633 | return firm_send_command(port, WHITEHEAT_CLOSE, |
634 | (__u8 *)&close_command, sizeof(close_command)); | |
1da177e4 LT |
635 | } |
636 | ||
637 | ||
fe1ae7fd | 638 | static void firm_setup_port(struct tty_struct *tty) |
80359a9c | 639 | { |
95da310e | 640 | struct usb_serial_port *port = tty->driver_data; |
255b703a | 641 | struct device *dev = &port->dev; |
1da177e4 | 642 | struct whiteheat_port_settings port_settings; |
adc8d746 | 643 | unsigned int cflag = tty->termios.c_cflag; |
1da177e4 | 644 | |
1143832e | 645 | port_settings.port = port->port_number + 1; |
1da177e4 LT |
646 | |
647 | /* get the byte size */ | |
648 | switch (cflag & CSIZE) { | |
80359a9c AC |
649 | case CS5: port_settings.bits = 5; break; |
650 | case CS6: port_settings.bits = 6; break; | |
651 | case CS7: port_settings.bits = 7; break; | |
652 | default: | |
653 | case CS8: port_settings.bits = 8; break; | |
1da177e4 | 654 | } |
255b703a | 655 | dev_dbg(dev, "%s - data bits = %d\n", __func__, port_settings.bits); |
80359a9c | 656 | |
1da177e4 LT |
657 | /* determine the parity */ |
658 | if (cflag & PARENB) | |
659 | if (cflag & CMSPAR) | |
660 | if (cflag & PARODD) | |
661 | port_settings.parity = WHITEHEAT_PAR_MARK; | |
662 | else | |
663 | port_settings.parity = WHITEHEAT_PAR_SPACE; | |
664 | else | |
665 | if (cflag & PARODD) | |
666 | port_settings.parity = WHITEHEAT_PAR_ODD; | |
667 | else | |
668 | port_settings.parity = WHITEHEAT_PAR_EVEN; | |
669 | else | |
670 | port_settings.parity = WHITEHEAT_PAR_NONE; | |
255b703a | 671 | dev_dbg(dev, "%s - parity = %c\n", __func__, port_settings.parity); |
1da177e4 LT |
672 | |
673 | /* figure out the stop bits requested */ | |
674 | if (cflag & CSTOPB) | |
675 | port_settings.stop = 2; | |
676 | else | |
677 | port_settings.stop = 1; | |
255b703a | 678 | dev_dbg(dev, "%s - stop bits = %d\n", __func__, port_settings.stop); |
1da177e4 LT |
679 | |
680 | /* figure out the flow control settings */ | |
681 | if (cflag & CRTSCTS) | |
80359a9c AC |
682 | port_settings.hflow = (WHITEHEAT_HFLOW_CTS | |
683 | WHITEHEAT_HFLOW_RTS); | |
1da177e4 LT |
684 | else |
685 | port_settings.hflow = WHITEHEAT_HFLOW_NONE; | |
255b703a | 686 | dev_dbg(dev, "%s - hardware flow control = %s %s %s %s\n", __func__, |
1da177e4 LT |
687 | (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "", |
688 | (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "", | |
689 | (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "", | |
690 | (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : ""); | |
80359a9c | 691 | |
1da177e4 | 692 | /* determine software flow control */ |
95da310e | 693 | if (I_IXOFF(tty)) |
1da177e4 LT |
694 | port_settings.sflow = WHITEHEAT_SFLOW_RXTX; |
695 | else | |
696 | port_settings.sflow = WHITEHEAT_SFLOW_NONE; | |
255b703a | 697 | dev_dbg(dev, "%s - software flow control = %c\n", __func__, port_settings.sflow); |
80359a9c | 698 | |
95da310e AC |
699 | port_settings.xon = START_CHAR(tty); |
700 | port_settings.xoff = STOP_CHAR(tty); | |
255b703a | 701 | dev_dbg(dev, "%s - XON = %2x, XOFF = %2x\n", __func__, port_settings.xon, port_settings.xoff); |
1da177e4 LT |
702 | |
703 | /* get the baud rate wanted */ | |
95da310e | 704 | port_settings.baud = tty_get_baud_rate(tty); |
255b703a | 705 | dev_dbg(dev, "%s - baud rate = %d\n", __func__, port_settings.baud); |
1da177e4 | 706 | |
01d1df29 | 707 | /* fixme: should set validated settings */ |
95da310e | 708 | tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud); |
1da177e4 LT |
709 | /* handle any settings that aren't specified in the tty structure */ |
710 | port_settings.lloop = 0; | |
80359a9c | 711 | |
1da177e4 | 712 | /* now send the message to the device */ |
fe1ae7fd | 713 | firm_send_command(port, WHITEHEAT_SETUP_PORT, |
80359a9c | 714 | (__u8 *)&port_settings, sizeof(port_settings)); |
1da177e4 LT |
715 | } |
716 | ||
717 | ||
80359a9c AC |
718 | static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) |
719 | { | |
1da177e4 LT |
720 | struct whiteheat_set_rdb rts_command; |
721 | ||
1143832e | 722 | rts_command.port = port->port_number + 1; |
1da177e4 | 723 | rts_command.state = onoff; |
80359a9c AC |
724 | return firm_send_command(port, WHITEHEAT_SET_RTS, |
725 | (__u8 *)&rts_command, sizeof(rts_command)); | |
1da177e4 LT |
726 | } |
727 | ||
728 | ||
80359a9c AC |
729 | static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) |
730 | { | |
1da177e4 LT |
731 | struct whiteheat_set_rdb dtr_command; |
732 | ||
1143832e | 733 | dtr_command.port = port->port_number + 1; |
1da177e4 | 734 | dtr_command.state = onoff; |
72e27412 | 735 | return firm_send_command(port, WHITEHEAT_SET_DTR, |
80359a9c | 736 | (__u8 *)&dtr_command, sizeof(dtr_command)); |
1da177e4 LT |
737 | } |
738 | ||
739 | ||
80359a9c AC |
740 | static int firm_set_break(struct usb_serial_port *port, __u8 onoff) |
741 | { | |
1da177e4 LT |
742 | struct whiteheat_set_rdb break_command; |
743 | ||
1143832e | 744 | break_command.port = port->port_number + 1; |
1da177e4 | 745 | break_command.state = onoff; |
72e27412 | 746 | return firm_send_command(port, WHITEHEAT_SET_BREAK, |
80359a9c | 747 | (__u8 *)&break_command, sizeof(break_command)); |
1da177e4 LT |
748 | } |
749 | ||
750 | ||
80359a9c AC |
751 | static int firm_purge(struct usb_serial_port *port, __u8 rxtx) |
752 | { | |
1da177e4 LT |
753 | struct whiteheat_purge purge_command; |
754 | ||
1143832e | 755 | purge_command.port = port->port_number + 1; |
1da177e4 | 756 | purge_command.what = rxtx; |
80359a9c AC |
757 | return firm_send_command(port, WHITEHEAT_PURGE, |
758 | (__u8 *)&purge_command, sizeof(purge_command)); | |
1da177e4 LT |
759 | } |
760 | ||
761 | ||
80359a9c AC |
762 | static int firm_get_dtr_rts(struct usb_serial_port *port) |
763 | { | |
1da177e4 LT |
764 | struct whiteheat_simple get_dr_command; |
765 | ||
1143832e | 766 | get_dr_command.port = port->port_number + 1; |
80359a9c AC |
767 | return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, |
768 | (__u8 *)&get_dr_command, sizeof(get_dr_command)); | |
1da177e4 LT |
769 | } |
770 | ||
771 | ||
80359a9c AC |
772 | static int firm_report_tx_done(struct usb_serial_port *port) |
773 | { | |
1da177e4 LT |
774 | struct whiteheat_simple close_command; |
775 | ||
1143832e | 776 | close_command.port = port->port_number + 1; |
80359a9c AC |
777 | return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, |
778 | (__u8 *)&close_command, sizeof(close_command)); | |
1da177e4 LT |
779 | } |
780 | ||
781 | ||
782 | /***************************************************************************** | |
783 | * Connect Tech's White Heat utility functions | |
784 | *****************************************************************************/ | |
785 | static int start_command_port(struct usb_serial *serial) | |
786 | { | |
787 | struct usb_serial_port *command_port; | |
788 | struct whiteheat_command_private *command_info; | |
1da177e4 | 789 | int retval = 0; |
80359a9c | 790 | |
1da177e4 LT |
791 | command_port = serial->port[COMMAND_PORT]; |
792 | command_info = usb_get_serial_port_data(command_port); | |
08a2b3b6 | 793 | mutex_lock(&command_info->mutex); |
1da177e4 LT |
794 | if (!command_info->port_running) { |
795 | /* Work around HCD bugs */ | |
796 | usb_clear_halt(serial->dev, command_port->read_urb->pipe); | |
797 | ||
1da177e4 LT |
798 | retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL); |
799 | if (retval) { | |
194343d9 GKH |
800 | dev_err(&serial->dev->dev, |
801 | "%s - failed submitting read urb, error %d\n", | |
802 | __func__, retval); | |
1da177e4 LT |
803 | goto exit; |
804 | } | |
805 | } | |
806 | command_info->port_running++; | |
807 | ||
808 | exit: | |
08a2b3b6 | 809 | mutex_unlock(&command_info->mutex); |
1da177e4 LT |
810 | return retval; |
811 | } | |
812 | ||
813 | ||
814 | static void stop_command_port(struct usb_serial *serial) | |
815 | { | |
816 | struct usb_serial_port *command_port; | |
817 | struct whiteheat_command_private *command_info; | |
1da177e4 LT |
818 | |
819 | command_port = serial->port[COMMAND_PORT]; | |
820 | command_info = usb_get_serial_port_data(command_port); | |
08a2b3b6 | 821 | mutex_lock(&command_info->mutex); |
1da177e4 LT |
822 | command_info->port_running--; |
823 | if (!command_info->port_running) | |
824 | usb_kill_urb(command_port->read_urb); | |
08a2b3b6 | 825 | mutex_unlock(&command_info->mutex); |
1da177e4 LT |
826 | } |
827 | ||
68e24113 | 828 | module_usb_serial_driver(serial_drivers, id_table_combined); |
1da177e4 | 829 | |
80359a9c AC |
830 | MODULE_AUTHOR(DRIVER_AUTHOR); |
831 | MODULE_DESCRIPTION(DRIVER_DESC); | |
1da177e4 LT |
832 | MODULE_LICENSE("GPL"); |
833 | ||
ec6752f5 DW |
834 | MODULE_FIRMWARE("whiteheat.fw"); |
835 | MODULE_FIRMWARE("whiteheat_loader.fw"); |