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