Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * USB ConnectTech WhiteHEAT driver | |
3 | * | |
4 | * Copyright (C) 2002 | |
5 | * Connect Tech Inc. | |
6 | * | |
7 | * Copyright (C) 1999 - 2001 | |
8 | * Greg Kroah-Hartman (greg@kroah.com) | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License as published by | |
12 | * the Free Software Foundation; either version 2 of the License, or | |
13 | * (at your option) any later version. | |
14 | * | |
80359a9c AC |
15 | * See Documentation/usb/usb-serial.txt for more information on using this |
16 | * driver | |
1da177e4 LT |
17 | */ |
18 | ||
1da177e4 LT |
19 | #include <linux/kernel.h> |
20 | #include <linux/errno.h> | |
21 | #include <linux/init.h> | |
22 | #include <linux/slab.h> | |
23 | #include <linux/tty.h> | |
24 | #include <linux/tty_driver.h> | |
25 | #include <linux/tty_flip.h> | |
26 | #include <linux/module.h> | |
27 | #include <linux/spinlock.h> | |
08a2b3b6 | 28 | #include <linux/mutex.h> |
80359a9c | 29 | #include <linux/uaccess.h> |
1da177e4 LT |
30 | #include <asm/termbits.h> |
31 | #include <linux/usb.h> | |
32 | #include <linux/serial_reg.h> | |
33 | #include <linux/serial.h> | |
a969888c | 34 | #include <linux/usb/serial.h> |
ec6752f5 DW |
35 | #include <linux/firmware.h> |
36 | #include <linux/ihex.h> | |
1da177e4 LT |
37 | #include "whiteheat.h" /* WhiteHEAT specific commands */ |
38 | ||
90ab5ee9 | 39 | static bool debug; |
1da177e4 LT |
40 | |
41 | #ifndef CMSPAR | |
42 | #define CMSPAR 0 | |
43 | #endif | |
44 | ||
45 | /* | |
46 | * Version Information | |
47 | */ | |
1da177e4 LT |
48 | #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>" |
49 | #define DRIVER_DESC "USB ConnectTech WhiteHEAT driver" | |
50 | ||
51 | #define CONNECT_TECH_VENDOR_ID 0x0710 | |
52 | #define CONNECT_TECH_FAKE_WHITE_HEAT_ID 0x0001 | |
53 | #define CONNECT_TECH_WHITE_HEAT_ID 0x8001 | |
54 | ||
55 | /* | |
56 | ID tables for whiteheat are unusual, because we want to different | |
57 | things for different versions of the device. Eventually, this | |
58 | will be doable from a single table. But, for now, we define two | |
59 | separate ID tables, and then a third table that combines them | |
60 | just for the purpose of exporting the autoloading information. | |
61 | */ | |
7d40d7e8 | 62 | static const struct usb_device_id id_table_std[] = { |
1da177e4 LT |
63 | { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) }, |
64 | { } /* Terminating entry */ | |
65 | }; | |
66 | ||
7d40d7e8 | 67 | static const struct usb_device_id id_table_prerenumeration[] = { |
1da177e4 LT |
68 | { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) }, |
69 | { } /* Terminating entry */ | |
70 | }; | |
71 | ||
7d40d7e8 | 72 | static const struct usb_device_id id_table_combined[] = { |
1da177e4 LT |
73 | { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) }, |
74 | { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) }, | |
75 | { } /* Terminating entry */ | |
76 | }; | |
77 | ||
80359a9c | 78 | MODULE_DEVICE_TABLE(usb, id_table_combined); |
1da177e4 | 79 | |
1da177e4 LT |
80 | |
81 | /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */ | |
80359a9c AC |
82 | static int whiteheat_firmware_download(struct usb_serial *serial, |
83 | const struct usb_device_id *id); | |
84 | static int whiteheat_firmware_attach(struct usb_serial *serial); | |
1da177e4 LT |
85 | |
86 | /* function prototypes for the Connect Tech WhiteHEAT serial converter */ | |
80359a9c | 87 | static int whiteheat_attach(struct usb_serial *serial); |
f9c99bb8 | 88 | static void whiteheat_release(struct usb_serial *serial); |
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 LT |
120 | .num_ports = 4, |
121 | .attach = whiteheat_attach, | |
f9c99bb8 | 122 | .release = whiteheat_release, |
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 | { |
ec6752f5 DW |
198 | int response, ret = -ENOENT; |
199 | const struct firmware *loader_fw = NULL, *firmware_fw = NULL; | |
200 | const struct ihex_binrec *record; | |
201 | ||
ec6752f5 DW |
202 | if (request_ihex_firmware(&firmware_fw, "whiteheat.fw", |
203 | &serial->dev->dev)) { | |
194343d9 GKH |
204 | dev_err(&serial->dev->dev, |
205 | "%s - request \"whiteheat.fw\" failed\n", __func__); | |
ec6752f5 DW |
206 | goto out; |
207 | } | |
208 | if (request_ihex_firmware(&loader_fw, "whiteheat_loader.fw", | |
209 | &serial->dev->dev)) { | |
194343d9 GKH |
210 | dev_err(&serial->dev->dev, |
211 | "%s - request \"whiteheat_loader.fw\" failed\n", | |
212 | __func__); | |
ec6752f5 DW |
213 | goto out; |
214 | } | |
215 | ret = 0; | |
1da177e4 LT |
216 | response = ezusb_set_reset (serial, 1); |
217 | ||
ec6752f5 DW |
218 | record = (const struct ihex_binrec *)loader_fw->data; |
219 | while (record) { | |
220 | response = ezusb_writememory (serial, be32_to_cpu(record->addr), | |
221 | (unsigned char *)record->data, | |
222 | be16_to_cpu(record->len), 0xa0); | |
1da177e4 | 223 | if (response < 0) { |
194343d9 GKH |
224 | dev_err(&serial->dev->dev, "%s - ezusb_writememory " |
225 | "failed for loader (%d %04X %p %d)\n", | |
226 | __func__, response, be32_to_cpu(record->addr), | |
227 | record->data, be16_to_cpu(record->len)); | |
1da177e4 LT |
228 | break; |
229 | } | |
ec6752f5 | 230 | record = ihex_next_binrec(record); |
1da177e4 LT |
231 | } |
232 | ||
80359a9c | 233 | response = ezusb_set_reset(serial, 0); |
1da177e4 | 234 | |
ec6752f5 DW |
235 | record = (const struct ihex_binrec *)firmware_fw->data; |
236 | while (record && be32_to_cpu(record->addr) < 0x1b40) | |
237 | record = ihex_next_binrec(record); | |
238 | while (record) { | |
239 | response = ezusb_writememory (serial, be32_to_cpu(record->addr), | |
240 | (unsigned char *)record->data, | |
241 | be16_to_cpu(record->len), 0xa3); | |
1da177e4 | 242 | if (response < 0) { |
194343d9 GKH |
243 | dev_err(&serial->dev->dev, "%s - ezusb_writememory " |
244 | "failed for first firmware step " | |
245 | "(%d %04X %p %d)\n", __func__, response, | |
246 | be32_to_cpu(record->addr), record->data, | |
247 | be16_to_cpu(record->len)); | |
1da177e4 LT |
248 | break; |
249 | } | |
250 | ++record; | |
251 | } | |
80359a9c AC |
252 | |
253 | response = ezusb_set_reset(serial, 1); | |
1da177e4 | 254 | |
ec6752f5 DW |
255 | record = (const struct ihex_binrec *)firmware_fw->data; |
256 | while (record && be32_to_cpu(record->addr) < 0x1b40) { | |
257 | response = ezusb_writememory (serial, be32_to_cpu(record->addr), | |
258 | (unsigned char *)record->data, | |
259 | be16_to_cpu(record->len), 0xa0); | |
1da177e4 | 260 | if (response < 0) { |
194343d9 GKH |
261 | dev_err(&serial->dev->dev, "%s - ezusb_writememory " |
262 | "failed for second firmware step " | |
263 | "(%d %04X %p %d)\n", __func__, response, | |
264 | be32_to_cpu(record->addr), record->data, | |
265 | be16_to_cpu(record->len)); | |
1da177e4 LT |
266 | break; |
267 | } | |
268 | ++record; | |
269 | } | |
ec6752f5 | 270 | ret = 0; |
1da177e4 | 271 | response = ezusb_set_reset (serial, 0); |
ec6752f5 DW |
272 | out: |
273 | release_firmware(loader_fw); | |
274 | release_firmware(firmware_fw); | |
275 | return ret; | |
1da177e4 LT |
276 | } |
277 | ||
278 | ||
80359a9c | 279 | static int whiteheat_firmware_attach(struct usb_serial *serial) |
1da177e4 LT |
280 | { |
281 | /* We want this device to fail to have a driver assigned to it */ | |
282 | return 1; | |
283 | } | |
284 | ||
285 | ||
286 | /***************************************************************************** | |
287 | * Connect Tech's White Heat serial driver functions | |
288 | *****************************************************************************/ | |
80359a9c | 289 | static int whiteheat_attach(struct usb_serial *serial) |
1da177e4 LT |
290 | { |
291 | struct usb_serial_port *command_port; | |
292 | struct whiteheat_command_private *command_info; | |
293 | struct usb_serial_port *port; | |
294 | struct whiteheat_private *info; | |
295 | struct whiteheat_hw_info *hw_info; | |
296 | int pipe; | |
297 | int ret; | |
298 | int alen; | |
299 | __u8 *command; | |
300 | __u8 *result; | |
301 | int i; | |
1da177e4 LT |
302 | |
303 | command_port = serial->port[COMMAND_PORT]; | |
304 | ||
80359a9c AC |
305 | pipe = usb_sndbulkpipe(serial->dev, |
306 | command_port->bulk_out_endpointAddress); | |
1da177e4 LT |
307 | command = kmalloc(2, GFP_KERNEL); |
308 | if (!command) | |
309 | goto no_command_buffer; | |
310 | command[0] = WHITEHEAT_GET_HW_INFO; | |
311 | command[1] = 0; | |
80359a9c | 312 | |
1da177e4 LT |
313 | result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL); |
314 | if (!result) | |
315 | goto no_result_buffer; | |
316 | /* | |
317 | * When the module is reloaded the firmware is still there and | |
318 | * the endpoints are still in the usb core unchanged. This is the | |
80359a9c AC |
319 | * unlinking bug in disguise. Same for the call below. |
320 | */ | |
1da177e4 | 321 | usb_clear_halt(serial->dev, pipe); |
80359a9c AC |
322 | ret = usb_bulk_msg(serial->dev, pipe, command, 2, |
323 | &alen, COMMAND_TIMEOUT_MS); | |
1da177e4 | 324 | if (ret) { |
194343d9 GKH |
325 | dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n", |
326 | serial->type->description, ret); | |
1da177e4 | 327 | goto no_firmware; |
09fd6bc8 | 328 | } else if (alen != 2) { |
194343d9 GKH |
329 | dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n", |
330 | serial->type->description, alen); | |
1da177e4 LT |
331 | goto no_firmware; |
332 | } | |
333 | ||
80359a9c AC |
334 | pipe = usb_rcvbulkpipe(serial->dev, |
335 | command_port->bulk_in_endpointAddress); | |
1da177e4 LT |
336 | /* See the comment on the usb_clear_halt() above */ |
337 | usb_clear_halt(serial->dev, pipe); | |
80359a9c AC |
338 | ret = usb_bulk_msg(serial->dev, pipe, result, |
339 | sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS); | |
1da177e4 | 340 | if (ret) { |
194343d9 GKH |
341 | dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n", |
342 | serial->type->description, ret); | |
1da177e4 | 343 | goto no_firmware; |
09fd6bc8 | 344 | } else if (alen != sizeof(*hw_info) + 1) { |
194343d9 GKH |
345 | dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n", |
346 | serial->type->description, alen); | |
1da177e4 LT |
347 | goto no_firmware; |
348 | } else if (result[0] != command[0]) { | |
194343d9 GKH |
349 | dev_err(&serial->dev->dev, "%s: Command failed [%d]\n", |
350 | serial->type->description, result[0]); | |
1da177e4 LT |
351 | goto no_firmware; |
352 | } | |
353 | ||
354 | hw_info = (struct whiteheat_hw_info *)&result[1]; | |
355 | ||
a6765cba JH |
356 | dev_info(&serial->dev->dev, "%s: Firmware v%d.%02d\n", |
357 | serial->type->description, | |
c197a8db | 358 | hw_info->sw_major_rev, hw_info->sw_minor_rev); |
1da177e4 LT |
359 | |
360 | for (i = 0; i < serial->num_ports; i++) { | |
361 | port = serial->port[i]; | |
362 | ||
5cbded58 | 363 | info = kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL); |
1da177e4 | 364 | if (info == NULL) { |
194343d9 GKH |
365 | dev_err(&port->dev, |
366 | "%s: Out of memory for port structures\n", | |
367 | serial->type->description); | |
1da177e4 LT |
368 | goto no_private; |
369 | } | |
370 | ||
1da177e4 | 371 | info->mcr = 0; |
1da177e4 LT |
372 | |
373 | usb_set_serial_port_data(port, info); | |
374 | } | |
375 | ||
80359a9c AC |
376 | command_info = kmalloc(sizeof(struct whiteheat_command_private), |
377 | GFP_KERNEL); | |
1da177e4 | 378 | if (command_info == NULL) { |
194343d9 GKH |
379 | dev_err(&serial->dev->dev, |
380 | "%s: Out of memory for port structures\n", | |
381 | serial->type->description); | |
1da177e4 LT |
382 | goto no_command_private; |
383 | } | |
384 | ||
08a2b3b6 | 385 | mutex_init(&command_info->mutex); |
1da177e4 LT |
386 | command_info->port_running = 0; |
387 | init_waitqueue_head(&command_info->wait_command); | |
388 | usb_set_serial_port_data(command_port, command_info); | |
389 | command_port->write_urb->complete = command_port_write_callback; | |
390 | command_port->read_urb->complete = command_port_read_callback; | |
391 | kfree(result); | |
392 | kfree(command); | |
393 | ||
394 | return 0; | |
395 | ||
396 | no_firmware: | |
397 | /* Firmware likely not running */ | |
194343d9 GKH |
398 | dev_err(&serial->dev->dev, |
399 | "%s: Unable to retrieve firmware version, try replugging\n", | |
400 | serial->type->description); | |
401 | dev_err(&serial->dev->dev, | |
402 | "%s: If the firmware is not running (status led not blinking)\n", | |
403 | serial->type->description); | |
404 | dev_err(&serial->dev->dev, | |
405 | "%s: please contact support@connecttech.com\n", | |
406 | serial->type->description); | |
67ca0284 | 407 | kfree(result); |
1da177e4 LT |
408 | return -ENODEV; |
409 | ||
410 | no_command_private: | |
411 | for (i = serial->num_ports - 1; i >= 0; i--) { | |
412 | port = serial->port[i]; | |
413 | info = usb_get_serial_port_data(port); | |
1da177e4 LT |
414 | kfree(info); |
415 | no_private: | |
416 | ; | |
417 | } | |
418 | kfree(result); | |
419 | no_result_buffer: | |
420 | kfree(command); | |
421 | no_command_buffer: | |
422 | return -ENOMEM; | |
423 | } | |
424 | ||
425 | ||
f9c99bb8 | 426 | static void whiteheat_release(struct usb_serial *serial) |
1da177e4 LT |
427 | { |
428 | struct usb_serial_port *command_port; | |
1da177e4 | 429 | struct whiteheat_private *info; |
1da177e4 LT |
430 | int i; |
431 | ||
1da177e4 LT |
432 | /* free up our private data for our command port */ |
433 | command_port = serial->port[COMMAND_PORT]; | |
80359a9c | 434 | kfree(usb_get_serial_port_data(command_port)); |
1da177e4 LT |
435 | |
436 | for (i = 0; i < serial->num_ports; i++) { | |
5c0c7582 | 437 | info = usb_get_serial_port_data(serial->port[i]); |
1da177e4 LT |
438 | kfree(info); |
439 | } | |
1da177e4 LT |
440 | } |
441 | ||
a509a7e4 | 442 | static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port) |
1da177e4 | 443 | { |
5c0c7582 | 444 | int retval; |
1da177e4 | 445 | |
1da177e4 LT |
446 | retval = start_command_port(port->serial); |
447 | if (retval) | |
448 | goto exit; | |
449 | ||
1da177e4 LT |
450 | /* send an open port command */ |
451 | retval = firm_open(port); | |
452 | if (retval) { | |
453 | stop_command_port(port->serial); | |
454 | goto exit; | |
455 | } | |
456 | ||
457 | retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX); | |
458 | if (retval) { | |
459 | firm_close(port); | |
460 | stop_command_port(port->serial); | |
461 | goto exit; | |
462 | } | |
463 | ||
72e27412 AC |
464 | if (tty) |
465 | firm_setup_port(tty); | |
1da177e4 LT |
466 | |
467 | /* Work around HCD bugs */ | |
468 | usb_clear_halt(port->serial->dev, port->read_urb->pipe); | |
469 | usb_clear_halt(port->serial->dev, port->write_urb->pipe); | |
470 | ||
5c0c7582 | 471 | retval = usb_serial_generic_open(tty, port); |
1da177e4 | 472 | if (retval) { |
1da177e4 LT |
473 | firm_close(port); |
474 | stop_command_port(port->serial); | |
475 | goto exit; | |
476 | } | |
1da177e4 | 477 | exit: |
1da177e4 LT |
478 | return retval; |
479 | } | |
480 | ||
481 | ||
335f8514 | 482 | static void whiteheat_close(struct usb_serial_port *port) |
1da177e4 | 483 | { |
1da177e4 | 484 | firm_report_tx_done(port); |
1da177e4 LT |
485 | firm_close(port); |
486 | ||
5c0c7582 | 487 | usb_serial_generic_close(port); |
1da177e4 | 488 | |
5c0c7582 | 489 | stop_command_port(port->serial); |
1da177e4 LT |
490 | } |
491 | ||
60b33c13 | 492 | static int whiteheat_tiocmget(struct tty_struct *tty) |
1da177e4 | 493 | { |
95da310e | 494 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
495 | struct whiteheat_private *info = usb_get_serial_port_data(port); |
496 | unsigned int modem_signals = 0; | |
497 | ||
1da177e4 LT |
498 | firm_get_dtr_rts(port); |
499 | if (info->mcr & UART_MCR_DTR) | |
500 | modem_signals |= TIOCM_DTR; | |
501 | if (info->mcr & UART_MCR_RTS) | |
502 | modem_signals |= TIOCM_RTS; | |
503 | ||
504 | return modem_signals; | |
505 | } | |
506 | ||
20b9d177 | 507 | static int whiteheat_tiocmset(struct tty_struct *tty, |
1da177e4 LT |
508 | unsigned int set, unsigned int clear) |
509 | { | |
95da310e | 510 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
511 | struct whiteheat_private *info = usb_get_serial_port_data(port); |
512 | ||
1da177e4 LT |
513 | if (set & TIOCM_RTS) |
514 | info->mcr |= UART_MCR_RTS; | |
515 | if (set & TIOCM_DTR) | |
516 | info->mcr |= UART_MCR_DTR; | |
517 | ||
518 | if (clear & TIOCM_RTS) | |
519 | info->mcr &= ~UART_MCR_RTS; | |
520 | if (clear & TIOCM_DTR) | |
521 | info->mcr &= ~UART_MCR_DTR; | |
522 | ||
523 | firm_set_dtr(port, info->mcr & UART_MCR_DTR); | |
524 | firm_set_rts(port, info->mcr & UART_MCR_RTS); | |
525 | return 0; | |
526 | } | |
527 | ||
528 | ||
00a0d0d6 | 529 | static int whiteheat_ioctl(struct tty_struct *tty, |
80359a9c | 530 | unsigned int cmd, unsigned long arg) |
1da177e4 | 531 | { |
95da310e | 532 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
533 | struct serial_struct serstruct; |
534 | void __user *user_arg = (void __user *)arg; | |
535 | ||
441b62c1 | 536 | dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd); |
1da177e4 LT |
537 | |
538 | switch (cmd) { | |
80359a9c AC |
539 | case TIOCGSERIAL: |
540 | memset(&serstruct, 0, sizeof(serstruct)); | |
541 | serstruct.type = PORT_16654; | |
542 | serstruct.line = port->serial->minor; | |
543 | serstruct.port = port->number; | |
544 | serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ; | |
5c0c7582 | 545 | serstruct.xmit_fifo_size = kfifo_size(&port->write_fifo); |
80359a9c AC |
546 | serstruct.custom_divisor = 0; |
547 | serstruct.baud_base = 460800; | |
548 | serstruct.close_delay = CLOSING_DELAY; | |
549 | serstruct.closing_wait = CLOSING_DELAY; | |
550 | ||
551 | if (copy_to_user(user_arg, &serstruct, sizeof(serstruct))) | |
552 | return -EFAULT; | |
553 | break; | |
554 | default: | |
555 | break; | |
1da177e4 LT |
556 | } |
557 | ||
558 | return -ENOIOCTLCMD; | |
559 | } | |
560 | ||
561 | ||
80359a9c AC |
562 | static void whiteheat_set_termios(struct tty_struct *tty, |
563 | struct usb_serial_port *port, struct ktermios *old_termios) | |
1da177e4 | 564 | { |
95da310e | 565 | firm_setup_port(tty); |
1da177e4 LT |
566 | } |
567 | ||
80359a9c AC |
568 | static void whiteheat_break_ctl(struct tty_struct *tty, int break_state) |
569 | { | |
95da310e | 570 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
571 | firm_set_break(port, break_state); |
572 | } | |
573 | ||
574 | ||
1da177e4 LT |
575 | /***************************************************************************** |
576 | * Connect Tech's White Heat callback routines | |
577 | *****************************************************************************/ | |
08a2b3b6 | 578 | static void command_port_write_callback(struct urb *urb) |
1da177e4 | 579 | { |
05400013 GKH |
580 | int status = urb->status; |
581 | ||
05400013 GKH |
582 | if (status) { |
583 | dbg("nonzero urb status: %d", status); | |
1da177e4 LT |
584 | return; |
585 | } | |
586 | } | |
587 | ||
588 | ||
08a2b3b6 | 589 | static void command_port_read_callback(struct urb *urb) |
1da177e4 | 590 | { |
cdc97792 | 591 | struct usb_serial_port *command_port = urb->context; |
1da177e4 | 592 | struct whiteheat_command_private *command_info; |
05400013 | 593 | int status = urb->status; |
1da177e4 LT |
594 | unsigned char *data = urb->transfer_buffer; |
595 | int result; | |
1da177e4 | 596 | |
08a2b3b6 ON |
597 | command_info = usb_get_serial_port_data(command_port); |
598 | if (!command_info) { | |
80359a9c | 599 | dbg("%s - command_info is NULL, exiting.", __func__); |
08a2b3b6 ON |
600 | return; |
601 | } | |
05400013 | 602 | if (status) { |
441b62c1 | 603 | dbg("%s - nonzero urb status: %d", __func__, status); |
05400013 | 604 | if (status != -ENOENT) |
08a2b3b6 ON |
605 | command_info->command_finished = WHITEHEAT_CMD_FAILURE; |
606 | wake_up(&command_info->wait_command); | |
1da177e4 LT |
607 | return; |
608 | } | |
609 | ||
80359a9c AC |
610 | usb_serial_debug_data(debug, &command_port->dev, |
611 | __func__, urb->actual_length, data); | |
1da177e4 | 612 | |
1da177e4 LT |
613 | if (data[0] == WHITEHEAT_CMD_COMPLETE) { |
614 | command_info->command_finished = WHITEHEAT_CMD_COMPLETE; | |
08a2b3b6 | 615 | wake_up(&command_info->wait_command); |
1da177e4 LT |
616 | } else if (data[0] == WHITEHEAT_CMD_FAILURE) { |
617 | command_info->command_finished = WHITEHEAT_CMD_FAILURE; | |
08a2b3b6 | 618 | wake_up(&command_info->wait_command); |
1da177e4 | 619 | } else if (data[0] == WHITEHEAT_EVENT) { |
80359a9c AC |
620 | /* These are unsolicited reports from the firmware, hence no |
621 | waiting command to wakeup */ | |
441b62c1 | 622 | dbg("%s - event received", __func__); |
1da177e4 | 623 | } else if (data[0] == WHITEHEAT_GET_DTR_RTS) { |
80359a9c AC |
624 | memcpy(command_info->result_buffer, &data[1], |
625 | urb->actual_length - 1); | |
1da177e4 | 626 | command_info->command_finished = WHITEHEAT_CMD_COMPLETE; |
08a2b3b6 | 627 | wake_up(&command_info->wait_command); |
80359a9c | 628 | } else |
441b62c1 | 629 | dbg("%s - bad reply from firmware", __func__); |
80359a9c | 630 | |
1da177e4 | 631 | /* Continue trying to always read */ |
1da177e4 | 632 | result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC); |
1da177e4 | 633 | if (result) |
80359a9c AC |
634 | dbg("%s - failed resubmitting read urb, error %d", |
635 | __func__, result); | |
1da177e4 LT |
636 | } |
637 | ||
638 | ||
1da177e4 LT |
639 | /***************************************************************************** |
640 | * Connect Tech's White Heat firmware interface | |
641 | *****************************************************************************/ | |
80359a9c AC |
642 | static int firm_send_command(struct usb_serial_port *port, __u8 command, |
643 | __u8 *data, __u8 datasize) | |
1da177e4 LT |
644 | { |
645 | struct usb_serial_port *command_port; | |
646 | struct whiteheat_command_private *command_info; | |
647 | struct whiteheat_private *info; | |
648 | __u8 *transfer_buffer; | |
649 | int retval = 0; | |
08a2b3b6 | 650 | int t; |
1da177e4 | 651 | |
441b62c1 | 652 | dbg("%s - command %d", __func__, command); |
1da177e4 LT |
653 | |
654 | command_port = port->serial->port[COMMAND_PORT]; | |
655 | command_info = usb_get_serial_port_data(command_port); | |
08a2b3b6 | 656 | mutex_lock(&command_info->mutex); |
38c3cb5b | 657 | command_info->command_finished = false; |
80359a9c | 658 | |
1da177e4 LT |
659 | transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer; |
660 | transfer_buffer[0] = command; | |
80359a9c | 661 | memcpy(&transfer_buffer[1], data, datasize); |
1da177e4 | 662 | command_port->write_urb->transfer_buffer_length = datasize + 1; |
80359a9c | 663 | retval = usb_submit_urb(command_port->write_urb, GFP_NOIO); |
1da177e4 | 664 | if (retval) { |
441b62c1 | 665 | dbg("%s - submit urb failed", __func__); |
1da177e4 LT |
666 | goto exit; |
667 | } | |
1da177e4 LT |
668 | |
669 | /* wait for the command to complete */ | |
08a2b3b6 | 670 | t = wait_event_timeout(command_info->wait_command, |
38c3cb5b | 671 | (bool)command_info->command_finished, COMMAND_TIMEOUT); |
08a2b3b6 ON |
672 | if (!t) |
673 | usb_kill_urb(command_port->write_urb); | |
1da177e4 | 674 | |
38c3cb5b | 675 | if (command_info->command_finished == false) { |
441b62c1 | 676 | dbg("%s - command timed out.", __func__); |
1da177e4 LT |
677 | retval = -ETIMEDOUT; |
678 | goto exit; | |
679 | } | |
680 | ||
681 | if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) { | |
441b62c1 | 682 | dbg("%s - command failed.", __func__); |
1da177e4 LT |
683 | retval = -EIO; |
684 | goto exit; | |
685 | } | |
686 | ||
687 | if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) { | |
441b62c1 | 688 | dbg("%s - command completed.", __func__); |
1da177e4 | 689 | switch (command) { |
80359a9c AC |
690 | case WHITEHEAT_GET_DTR_RTS: |
691 | info = usb_get_serial_port_data(port); | |
692 | memcpy(&info->mcr, command_info->result_buffer, | |
693 | sizeof(struct whiteheat_dr_info)); | |
1da177e4 LT |
694 | break; |
695 | } | |
696 | } | |
1da177e4 | 697 | exit: |
08a2b3b6 | 698 | mutex_unlock(&command_info->mutex); |
1da177e4 LT |
699 | return retval; |
700 | } | |
701 | ||
702 | ||
80359a9c AC |
703 | static int firm_open(struct usb_serial_port *port) |
704 | { | |
1da177e4 LT |
705 | struct whiteheat_simple open_command; |
706 | ||
707 | open_command.port = port->number - port->serial->minor + 1; | |
80359a9c AC |
708 | return firm_send_command(port, WHITEHEAT_OPEN, |
709 | (__u8 *)&open_command, sizeof(open_command)); | |
1da177e4 LT |
710 | } |
711 | ||
712 | ||
80359a9c AC |
713 | static int firm_close(struct usb_serial_port *port) |
714 | { | |
1da177e4 LT |
715 | struct whiteheat_simple close_command; |
716 | ||
717 | close_command.port = port->number - port->serial->minor + 1; | |
80359a9c AC |
718 | return firm_send_command(port, WHITEHEAT_CLOSE, |
719 | (__u8 *)&close_command, sizeof(close_command)); | |
1da177e4 LT |
720 | } |
721 | ||
722 | ||
fe1ae7fd | 723 | static void firm_setup_port(struct tty_struct *tty) |
80359a9c | 724 | { |
95da310e | 725 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 | 726 | struct whiteheat_port_settings port_settings; |
95da310e | 727 | unsigned int cflag = tty->termios->c_cflag; |
1da177e4 LT |
728 | |
729 | port_settings.port = port->number + 1; | |
730 | ||
731 | /* get the byte size */ | |
732 | switch (cflag & CSIZE) { | |
80359a9c AC |
733 | case CS5: port_settings.bits = 5; break; |
734 | case CS6: port_settings.bits = 6; break; | |
735 | case CS7: port_settings.bits = 7; break; | |
736 | default: | |
737 | case CS8: port_settings.bits = 8; break; | |
1da177e4 | 738 | } |
441b62c1 | 739 | dbg("%s - data bits = %d", __func__, port_settings.bits); |
80359a9c | 740 | |
1da177e4 LT |
741 | /* determine the parity */ |
742 | if (cflag & PARENB) | |
743 | if (cflag & CMSPAR) | |
744 | if (cflag & PARODD) | |
745 | port_settings.parity = WHITEHEAT_PAR_MARK; | |
746 | else | |
747 | port_settings.parity = WHITEHEAT_PAR_SPACE; | |
748 | else | |
749 | if (cflag & PARODD) | |
750 | port_settings.parity = WHITEHEAT_PAR_ODD; | |
751 | else | |
752 | port_settings.parity = WHITEHEAT_PAR_EVEN; | |
753 | else | |
754 | port_settings.parity = WHITEHEAT_PAR_NONE; | |
441b62c1 | 755 | dbg("%s - parity = %c", __func__, port_settings.parity); |
1da177e4 LT |
756 | |
757 | /* figure out the stop bits requested */ | |
758 | if (cflag & CSTOPB) | |
759 | port_settings.stop = 2; | |
760 | else | |
761 | port_settings.stop = 1; | |
441b62c1 | 762 | dbg("%s - stop bits = %d", __func__, port_settings.stop); |
1da177e4 LT |
763 | |
764 | /* figure out the flow control settings */ | |
765 | if (cflag & CRTSCTS) | |
80359a9c AC |
766 | port_settings.hflow = (WHITEHEAT_HFLOW_CTS | |
767 | WHITEHEAT_HFLOW_RTS); | |
1da177e4 LT |
768 | else |
769 | port_settings.hflow = WHITEHEAT_HFLOW_NONE; | |
441b62c1 | 770 | dbg("%s - hardware flow control = %s %s %s %s", __func__, |
1da177e4 LT |
771 | (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "", |
772 | (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "", | |
773 | (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "", | |
774 | (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : ""); | |
80359a9c | 775 | |
1da177e4 | 776 | /* determine software flow control */ |
95da310e | 777 | if (I_IXOFF(tty)) |
1da177e4 LT |
778 | port_settings.sflow = WHITEHEAT_SFLOW_RXTX; |
779 | else | |
780 | port_settings.sflow = WHITEHEAT_SFLOW_NONE; | |
441b62c1 | 781 | dbg("%s - software flow control = %c", __func__, port_settings.sflow); |
80359a9c | 782 | |
95da310e AC |
783 | port_settings.xon = START_CHAR(tty); |
784 | port_settings.xoff = STOP_CHAR(tty); | |
80359a9c AC |
785 | dbg("%s - XON = %2x, XOFF = %2x", |
786 | __func__, port_settings.xon, port_settings.xoff); | |
1da177e4 LT |
787 | |
788 | /* get the baud rate wanted */ | |
95da310e | 789 | port_settings.baud = tty_get_baud_rate(tty); |
441b62c1 | 790 | dbg("%s - baud rate = %d", __func__, port_settings.baud); |
1da177e4 | 791 | |
01d1df29 | 792 | /* fixme: should set validated settings */ |
95da310e | 793 | tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud); |
1da177e4 LT |
794 | /* handle any settings that aren't specified in the tty structure */ |
795 | port_settings.lloop = 0; | |
80359a9c | 796 | |
1da177e4 | 797 | /* now send the message to the device */ |
fe1ae7fd | 798 | firm_send_command(port, WHITEHEAT_SETUP_PORT, |
80359a9c | 799 | (__u8 *)&port_settings, sizeof(port_settings)); |
1da177e4 LT |
800 | } |
801 | ||
802 | ||
80359a9c AC |
803 | static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) |
804 | { | |
1da177e4 LT |
805 | struct whiteheat_set_rdb rts_command; |
806 | ||
807 | rts_command.port = port->number - port->serial->minor + 1; | |
808 | rts_command.state = onoff; | |
80359a9c AC |
809 | return firm_send_command(port, WHITEHEAT_SET_RTS, |
810 | (__u8 *)&rts_command, sizeof(rts_command)); | |
1da177e4 LT |
811 | } |
812 | ||
813 | ||
80359a9c AC |
814 | static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) |
815 | { | |
1da177e4 LT |
816 | struct whiteheat_set_rdb dtr_command; |
817 | ||
818 | dtr_command.port = port->number - port->serial->minor + 1; | |
819 | dtr_command.state = onoff; | |
72e27412 | 820 | return firm_send_command(port, WHITEHEAT_SET_DTR, |
80359a9c | 821 | (__u8 *)&dtr_command, sizeof(dtr_command)); |
1da177e4 LT |
822 | } |
823 | ||
824 | ||
80359a9c AC |
825 | static int firm_set_break(struct usb_serial_port *port, __u8 onoff) |
826 | { | |
1da177e4 LT |
827 | struct whiteheat_set_rdb break_command; |
828 | ||
829 | break_command.port = port->number - port->serial->minor + 1; | |
830 | break_command.state = onoff; | |
72e27412 | 831 | return firm_send_command(port, WHITEHEAT_SET_BREAK, |
80359a9c | 832 | (__u8 *)&break_command, sizeof(break_command)); |
1da177e4 LT |
833 | } |
834 | ||
835 | ||
80359a9c AC |
836 | static int firm_purge(struct usb_serial_port *port, __u8 rxtx) |
837 | { | |
1da177e4 LT |
838 | struct whiteheat_purge purge_command; |
839 | ||
840 | purge_command.port = port->number - port->serial->minor + 1; | |
841 | purge_command.what = rxtx; | |
80359a9c AC |
842 | return firm_send_command(port, WHITEHEAT_PURGE, |
843 | (__u8 *)&purge_command, sizeof(purge_command)); | |
1da177e4 LT |
844 | } |
845 | ||
846 | ||
80359a9c AC |
847 | static int firm_get_dtr_rts(struct usb_serial_port *port) |
848 | { | |
1da177e4 LT |
849 | struct whiteheat_simple get_dr_command; |
850 | ||
851 | get_dr_command.port = port->number - port->serial->minor + 1; | |
80359a9c AC |
852 | return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, |
853 | (__u8 *)&get_dr_command, sizeof(get_dr_command)); | |
1da177e4 LT |
854 | } |
855 | ||
856 | ||
80359a9c AC |
857 | static int firm_report_tx_done(struct usb_serial_port *port) |
858 | { | |
1da177e4 LT |
859 | struct whiteheat_simple close_command; |
860 | ||
861 | close_command.port = port->number - port->serial->minor + 1; | |
80359a9c AC |
862 | return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, |
863 | (__u8 *)&close_command, sizeof(close_command)); | |
1da177e4 LT |
864 | } |
865 | ||
866 | ||
867 | /***************************************************************************** | |
868 | * Connect Tech's White Heat utility functions | |
869 | *****************************************************************************/ | |
870 | static int start_command_port(struct usb_serial *serial) | |
871 | { | |
872 | struct usb_serial_port *command_port; | |
873 | struct whiteheat_command_private *command_info; | |
1da177e4 | 874 | int retval = 0; |
80359a9c | 875 | |
1da177e4 LT |
876 | command_port = serial->port[COMMAND_PORT]; |
877 | command_info = usb_get_serial_port_data(command_port); | |
08a2b3b6 | 878 | mutex_lock(&command_info->mutex); |
1da177e4 LT |
879 | if (!command_info->port_running) { |
880 | /* Work around HCD bugs */ | |
881 | usb_clear_halt(serial->dev, command_port->read_urb->pipe); | |
882 | ||
1da177e4 LT |
883 | retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL); |
884 | if (retval) { | |
194343d9 GKH |
885 | dev_err(&serial->dev->dev, |
886 | "%s - failed submitting read urb, error %d\n", | |
887 | __func__, retval); | |
1da177e4 LT |
888 | goto exit; |
889 | } | |
890 | } | |
891 | command_info->port_running++; | |
892 | ||
893 | exit: | |
08a2b3b6 | 894 | mutex_unlock(&command_info->mutex); |
1da177e4 LT |
895 | return retval; |
896 | } | |
897 | ||
898 | ||
899 | static void stop_command_port(struct usb_serial *serial) | |
900 | { | |
901 | struct usb_serial_port *command_port; | |
902 | struct whiteheat_command_private *command_info; | |
1da177e4 LT |
903 | |
904 | command_port = serial->port[COMMAND_PORT]; | |
905 | command_info = usb_get_serial_port_data(command_port); | |
08a2b3b6 | 906 | mutex_lock(&command_info->mutex); |
1da177e4 LT |
907 | command_info->port_running--; |
908 | if (!command_info->port_running) | |
909 | usb_kill_urb(command_port->read_urb); | |
08a2b3b6 | 910 | mutex_unlock(&command_info->mutex); |
1da177e4 LT |
911 | } |
912 | ||
68e24113 | 913 | module_usb_serial_driver(serial_drivers, id_table_combined); |
1da177e4 | 914 | |
80359a9c AC |
915 | MODULE_AUTHOR(DRIVER_AUTHOR); |
916 | MODULE_DESCRIPTION(DRIVER_DESC); | |
1da177e4 LT |
917 | MODULE_LICENSE("GPL"); |
918 | ||
ec6752f5 DW |
919 | MODULE_FIRMWARE("whiteheat.fw"); |
920 | MODULE_FIRMWARE("whiteheat_loader.fw"); | |
921 | ||
1da177e4 LT |
922 | module_param(debug, bool, S_IRUGO | S_IWUSR); |
923 | MODULE_PARM_DESC(debug, "Debug enabled or not"); |