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