Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 Keyspan USB to Serial Converter driver
4
5 (C) Copyright (C) 2000-2001 Hugh Blemings <hugh@blemings.org>
6 (C) Copyright (C) 2002 Greg Kroah-Hartman <greg@kroah.com>
7
8 See http://blemings.org/hugh/keyspan.html for more information.
9
10 Code in this driver inspired by and in a number of places taken
11 from Brian Warner's original Keyspan-PDA driver.
12
13 This driver has been put together with the support of Innosys, Inc.
14 and Keyspan, Inc the manufacturers of the Keyspan USB-serial products.
15 Thanks Guys :)
16
17 Thanks to Paulus for miscellaneous tidy ups, some largish chunks
18 of much nicer and/or completely new code and (perhaps most uniquely)
19 having the patience to sit down and explain why and where he'd changed
20 stuff.
21
22 Tip 'o the hat to IBM (and previously Linuxcare :) for supporting
23 staff in their work on open source projects.
24*/
25
26
27#include <linux/kernel.h>
28#include <linux/jiffies.h>
29#include <linux/errno.h>
30#include <linux/slab.h>
31#include <linux/tty.h>
32#include <linux/tty_driver.h>
33#include <linux/tty_flip.h>
34#include <linux/module.h>
35#include <linux/spinlock.h>
36#include <linux/uaccess.h>
37#include <linux/usb.h>
38#include <linux/usb/serial.h>
39#include <linux/usb/ezusb.h>
40
41#define DRIVER_AUTHOR "Hugh Blemings <hugh@misc.nu"
42#define DRIVER_DESC "Keyspan USB to Serial Converter Driver"
43
44/* Function prototypes for Keyspan serial converter */
45static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port);
46static void keyspan_close(struct usb_serial_port *port);
47static void keyspan_dtr_rts(struct usb_serial_port *port, int on);
48static int keyspan_startup(struct usb_serial *serial);
49static void keyspan_disconnect(struct usb_serial *serial);
50static void keyspan_release(struct usb_serial *serial);
51static int keyspan_port_probe(struct usb_serial_port *port);
52static int keyspan_port_remove(struct usb_serial_port *port);
53static int keyspan_write_room(struct tty_struct *tty);
54static int keyspan_write(struct tty_struct *tty, struct usb_serial_port *port,
55 const unsigned char *buf, int count);
56static void keyspan_send_setup(struct usb_serial_port *port, int reset_port);
57static void keyspan_set_termios(struct tty_struct *tty,
58 struct usb_serial_port *port,
59 struct ktermios *old);
60static void keyspan_break_ctl(struct tty_struct *tty, int break_state);
61static int keyspan_tiocmget(struct tty_struct *tty);
62static int keyspan_tiocmset(struct tty_struct *tty, unsigned int set,
63 unsigned int clear);
64static int keyspan_fake_startup(struct usb_serial *serial);
65
66static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
67 u32 baud_rate, u32 baudclk,
68 u8 *rate_hi, u8 *rate_low,
69 u8 *prescaler, int portnum);
70static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
71 u32 baud_rate, u32 baudclk,
72 u8 *rate_hi, u8 *rate_low,
73 u8 *prescaler, int portnum);
74static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
75 u32 baud_rate, u32 baudclk,
76 u8 *rate_hi, u8 *rate_low,
77 u8 *prescaler, int portnum);
78static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
79 u32 baud_rate, u32 baudclk,
80 u8 *rate_hi, u8 *rate_low,
81 u8 *prescaler, int portnum);
82
83static int keyspan_usa28_send_setup(struct usb_serial *serial,
84 struct usb_serial_port *port,
85 int reset_port);
86static int keyspan_usa26_send_setup(struct usb_serial *serial,
87 struct usb_serial_port *port,
88 int reset_port);
89static int keyspan_usa49_send_setup(struct usb_serial *serial,
90 struct usb_serial_port *port,
91 int reset_port);
92static int keyspan_usa90_send_setup(struct usb_serial *serial,
93 struct usb_serial_port *port,
94 int reset_port);
95static int keyspan_usa67_send_setup(struct usb_serial *serial,
96 struct usb_serial_port *port,
97 int reset_port);
98
99/* Values used for baud rate calculation - device specific */
100#define KEYSPAN_INVALID_BAUD_RATE (-1)
101#define KEYSPAN_BAUD_RATE_OK (0)
102#define KEYSPAN_USA18X_BAUDCLK (12000000L) /* a guess */
103#define KEYSPAN_USA19_BAUDCLK (12000000L)
104#define KEYSPAN_USA19W_BAUDCLK (24000000L)
105#define KEYSPAN_USA19HS_BAUDCLK (14769231L)
106#define KEYSPAN_USA28_BAUDCLK (1843200L)
107#define KEYSPAN_USA28X_BAUDCLK (12000000L)
108#define KEYSPAN_USA49W_BAUDCLK (48000000L)
109
110/* Some constants used to characterise each device. */
111#define KEYSPAN_MAX_NUM_PORTS (4)
112#define KEYSPAN_MAX_FLIPS (2)
113
114/*
115 * Device info for the Keyspan serial converter, used by the overall
116 * usb-serial probe function.
117 */
118#define KEYSPAN_VENDOR_ID (0x06cd)
119
120/* Product IDs for the products supported, pre-renumeration */
121#define keyspan_usa18x_pre_product_id 0x0105
122#define keyspan_usa19_pre_product_id 0x0103
123#define keyspan_usa19qi_pre_product_id 0x010b
124#define keyspan_mpr_pre_product_id 0x011b
125#define keyspan_usa19qw_pre_product_id 0x0118
126#define keyspan_usa19w_pre_product_id 0x0106
127#define keyspan_usa28_pre_product_id 0x0101
128#define keyspan_usa28x_pre_product_id 0x0102
129#define keyspan_usa28xa_pre_product_id 0x0114
130#define keyspan_usa28xb_pre_product_id 0x0113
131#define keyspan_usa49w_pre_product_id 0x0109
132#define keyspan_usa49wlc_pre_product_id 0x011a
133
134/*
135 * Product IDs post-renumeration. Note that the 28x and 28xb have the same
136 * id's post-renumeration but behave identically so it's not an issue. As
137 * such, the 28xb is not listed in any of the device tables.
138 */
139#define keyspan_usa18x_product_id 0x0112
140#define keyspan_usa19_product_id 0x0107
141#define keyspan_usa19qi_product_id 0x010c
142#define keyspan_usa19hs_product_id 0x0121
143#define keyspan_mpr_product_id 0x011c
144#define keyspan_usa19qw_product_id 0x0119
145#define keyspan_usa19w_product_id 0x0108
146#define keyspan_usa28_product_id 0x010f
147#define keyspan_usa28x_product_id 0x0110
148#define keyspan_usa28xa_product_id 0x0115
149#define keyspan_usa28xb_product_id 0x0110
150#define keyspan_usa28xg_product_id 0x0135
151#define keyspan_usa49w_product_id 0x010a
152#define keyspan_usa49wlc_product_id 0x012a
153#define keyspan_usa49wg_product_id 0x0131
154
155struct keyspan_device_details {
156 /* product ID value */
157 int product_id;
158
159 enum {msg_usa26, msg_usa28, msg_usa49, msg_usa90, msg_usa67} msg_format;
160
161 /* Number of physical ports */
162 int num_ports;
163
164 /* 1 if endpoint flipping used on input, 0 if not */
165 int indat_endp_flip;
166
167 /* 1 if endpoint flipping used on output, 0 if not */
168 int outdat_endp_flip;
169
170 /*
171 * Table mapping input data endpoint IDs to physical port
172 * number and flip if used
173 */
174 int indat_endpoints[KEYSPAN_MAX_NUM_PORTS];
175
176 /* Same for output endpoints */
177 int outdat_endpoints[KEYSPAN_MAX_NUM_PORTS];
178
179 /* Input acknowledge endpoints */
180 int inack_endpoints[KEYSPAN_MAX_NUM_PORTS];
181
182 /* Output control endpoints */
183 int outcont_endpoints[KEYSPAN_MAX_NUM_PORTS];
184
185 /* Endpoint used for input status */
186 int instat_endpoint;
187
188 /* Endpoint used for input data 49WG only */
189 int indat_endpoint;
190
191 /* Endpoint used for global control functions */
192 int glocont_endpoint;
193
194 int (*calculate_baud_rate)(struct usb_serial_port *port,
195 u32 baud_rate, u32 baudclk,
196 u8 *rate_hi, u8 *rate_low, u8 *prescaler,
197 int portnum);
198 u32 baudclk;
199};
200
201/*
202 * Now for each device type we setup the device detail structure with the
203 * appropriate information (provided in Keyspan's documentation)
204 */
205
206static const struct keyspan_device_details usa18x_device_details = {
207 .product_id = keyspan_usa18x_product_id,
208 .msg_format = msg_usa26,
209 .num_ports = 1,
210 .indat_endp_flip = 0,
211 .outdat_endp_flip = 1,
212 .indat_endpoints = {0x81},
213 .outdat_endpoints = {0x01},
214 .inack_endpoints = {0x85},
215 .outcont_endpoints = {0x05},
216 .instat_endpoint = 0x87,
217 .indat_endpoint = -1,
218 .glocont_endpoint = 0x07,
219 .calculate_baud_rate = keyspan_usa19w_calc_baud,
220 .baudclk = KEYSPAN_USA18X_BAUDCLK,
221};
222
223static const struct keyspan_device_details usa19_device_details = {
224 .product_id = keyspan_usa19_product_id,
225 .msg_format = msg_usa28,
226 .num_ports = 1,
227 .indat_endp_flip = 1,
228 .outdat_endp_flip = 1,
229 .indat_endpoints = {0x81},
230 .outdat_endpoints = {0x01},
231 .inack_endpoints = {0x83},
232 .outcont_endpoints = {0x03},
233 .instat_endpoint = 0x84,
234 .indat_endpoint = -1,
235 .glocont_endpoint = -1,
236 .calculate_baud_rate = keyspan_usa19_calc_baud,
237 .baudclk = KEYSPAN_USA19_BAUDCLK,
238};
239
240static const struct keyspan_device_details usa19qi_device_details = {
241 .product_id = keyspan_usa19qi_product_id,
242 .msg_format = msg_usa28,
243 .num_ports = 1,
244 .indat_endp_flip = 1,
245 .outdat_endp_flip = 1,
246 .indat_endpoints = {0x81},
247 .outdat_endpoints = {0x01},
248 .inack_endpoints = {0x83},
249 .outcont_endpoints = {0x03},
250 .instat_endpoint = 0x84,
251 .indat_endpoint = -1,
252 .glocont_endpoint = -1,
253 .calculate_baud_rate = keyspan_usa28_calc_baud,
254 .baudclk = KEYSPAN_USA19_BAUDCLK,
255};
256
257static const struct keyspan_device_details mpr_device_details = {
258 .product_id = keyspan_mpr_product_id,
259 .msg_format = msg_usa28,
260 .num_ports = 1,
261 .indat_endp_flip = 1,
262 .outdat_endp_flip = 1,
263 .indat_endpoints = {0x81},
264 .outdat_endpoints = {0x01},
265 .inack_endpoints = {0x83},
266 .outcont_endpoints = {0x03},
267 .instat_endpoint = 0x84,
268 .indat_endpoint = -1,
269 .glocont_endpoint = -1,
270 .calculate_baud_rate = keyspan_usa28_calc_baud,
271 .baudclk = KEYSPAN_USA19_BAUDCLK,
272};
273
274static const struct keyspan_device_details usa19qw_device_details = {
275 .product_id = keyspan_usa19qw_product_id,
276 .msg_format = msg_usa26,
277 .num_ports = 1,
278 .indat_endp_flip = 0,
279 .outdat_endp_flip = 1,
280 .indat_endpoints = {0x81},
281 .outdat_endpoints = {0x01},
282 .inack_endpoints = {0x85},
283 .outcont_endpoints = {0x05},
284 .instat_endpoint = 0x87,
285 .indat_endpoint = -1,
286 .glocont_endpoint = 0x07,
287 .calculate_baud_rate = keyspan_usa19w_calc_baud,
288 .baudclk = KEYSPAN_USA19W_BAUDCLK,
289};
290
291static const struct keyspan_device_details usa19w_device_details = {
292 .product_id = keyspan_usa19w_product_id,
293 .msg_format = msg_usa26,
294 .num_ports = 1,
295 .indat_endp_flip = 0,
296 .outdat_endp_flip = 1,
297 .indat_endpoints = {0x81},
298 .outdat_endpoints = {0x01},
299 .inack_endpoints = {0x85},
300 .outcont_endpoints = {0x05},
301 .instat_endpoint = 0x87,
302 .indat_endpoint = -1,
303 .glocont_endpoint = 0x07,
304 .calculate_baud_rate = keyspan_usa19w_calc_baud,
305 .baudclk = KEYSPAN_USA19W_BAUDCLK,
306};
307
308static const struct keyspan_device_details usa19hs_device_details = {
309 .product_id = keyspan_usa19hs_product_id,
310 .msg_format = msg_usa90,
311 .num_ports = 1,
312 .indat_endp_flip = 0,
313 .outdat_endp_flip = 0,
314 .indat_endpoints = {0x81},
315 .outdat_endpoints = {0x01},
316 .inack_endpoints = {-1},
317 .outcont_endpoints = {0x02},
318 .instat_endpoint = 0x82,
319 .indat_endpoint = -1,
320 .glocont_endpoint = -1,
321 .calculate_baud_rate = keyspan_usa19hs_calc_baud,
322 .baudclk = KEYSPAN_USA19HS_BAUDCLK,
323};
324
325static const struct keyspan_device_details usa28_device_details = {
326 .product_id = keyspan_usa28_product_id,
327 .msg_format = msg_usa28,
328 .num_ports = 2,
329 .indat_endp_flip = 1,
330 .outdat_endp_flip = 1,
331 .indat_endpoints = {0x81, 0x83},
332 .outdat_endpoints = {0x01, 0x03},
333 .inack_endpoints = {0x85, 0x86},
334 .outcont_endpoints = {0x05, 0x06},
335 .instat_endpoint = 0x87,
336 .indat_endpoint = -1,
337 .glocont_endpoint = 0x07,
338 .calculate_baud_rate = keyspan_usa28_calc_baud,
339 .baudclk = KEYSPAN_USA28_BAUDCLK,
340};
341
342static const struct keyspan_device_details usa28x_device_details = {
343 .product_id = keyspan_usa28x_product_id,
344 .msg_format = msg_usa26,
345 .num_ports = 2,
346 .indat_endp_flip = 0,
347 .outdat_endp_flip = 1,
348 .indat_endpoints = {0x81, 0x83},
349 .outdat_endpoints = {0x01, 0x03},
350 .inack_endpoints = {0x85, 0x86},
351 .outcont_endpoints = {0x05, 0x06},
352 .instat_endpoint = 0x87,
353 .indat_endpoint = -1,
354 .glocont_endpoint = 0x07,
355 .calculate_baud_rate = keyspan_usa19w_calc_baud,
356 .baudclk = KEYSPAN_USA28X_BAUDCLK,
357};
358
359static const struct keyspan_device_details usa28xa_device_details = {
360 .product_id = keyspan_usa28xa_product_id,
361 .msg_format = msg_usa26,
362 .num_ports = 2,
363 .indat_endp_flip = 0,
364 .outdat_endp_flip = 1,
365 .indat_endpoints = {0x81, 0x83},
366 .outdat_endpoints = {0x01, 0x03},
367 .inack_endpoints = {0x85, 0x86},
368 .outcont_endpoints = {0x05, 0x06},
369 .instat_endpoint = 0x87,
370 .indat_endpoint = -1,
371 .glocont_endpoint = 0x07,
372 .calculate_baud_rate = keyspan_usa19w_calc_baud,
373 .baudclk = KEYSPAN_USA28X_BAUDCLK,
374};
375
376static const struct keyspan_device_details usa28xg_device_details = {
377 .product_id = keyspan_usa28xg_product_id,
378 .msg_format = msg_usa67,
379 .num_ports = 2,
380 .indat_endp_flip = 0,
381 .outdat_endp_flip = 0,
382 .indat_endpoints = {0x84, 0x88},
383 .outdat_endpoints = {0x02, 0x06},
384 .inack_endpoints = {-1, -1},
385 .outcont_endpoints = {-1, -1},
386 .instat_endpoint = 0x81,
387 .indat_endpoint = -1,
388 .glocont_endpoint = 0x01,
389 .calculate_baud_rate = keyspan_usa19w_calc_baud,
390 .baudclk = KEYSPAN_USA28X_BAUDCLK,
391};
392/*
393 * We don't need a separate entry for the usa28xb as it appears as a 28x
394 * anyway.
395 */
396
397static const struct keyspan_device_details usa49w_device_details = {
398 .product_id = keyspan_usa49w_product_id,
399 .msg_format = msg_usa49,
400 .num_ports = 4,
401 .indat_endp_flip = 0,
402 .outdat_endp_flip = 0,
403 .indat_endpoints = {0x81, 0x82, 0x83, 0x84},
404 .outdat_endpoints = {0x01, 0x02, 0x03, 0x04},
405 .inack_endpoints = {-1, -1, -1, -1},
406 .outcont_endpoints = {-1, -1, -1, -1},
407 .instat_endpoint = 0x87,
408 .indat_endpoint = -1,
409 .glocont_endpoint = 0x07,
410 .calculate_baud_rate = keyspan_usa19w_calc_baud,
411 .baudclk = KEYSPAN_USA49W_BAUDCLK,
412};
413
414static const struct keyspan_device_details usa49wlc_device_details = {
415 .product_id = keyspan_usa49wlc_product_id,
416 .msg_format = msg_usa49,
417 .num_ports = 4,
418 .indat_endp_flip = 0,
419 .outdat_endp_flip = 0,
420 .indat_endpoints = {0x81, 0x82, 0x83, 0x84},
421 .outdat_endpoints = {0x01, 0x02, 0x03, 0x04},
422 .inack_endpoints = {-1, -1, -1, -1},
423 .outcont_endpoints = {-1, -1, -1, -1},
424 .instat_endpoint = 0x87,
425 .indat_endpoint = -1,
426 .glocont_endpoint = 0x07,
427 .calculate_baud_rate = keyspan_usa19w_calc_baud,
428 .baudclk = KEYSPAN_USA19W_BAUDCLK,
429};
430
431static const struct keyspan_device_details usa49wg_device_details = {
432 .product_id = keyspan_usa49wg_product_id,
433 .msg_format = msg_usa49,
434 .num_ports = 4,
435 .indat_endp_flip = 0,
436 .outdat_endp_flip = 0,
437 .indat_endpoints = {-1, -1, -1, -1}, /* single 'global' data in EP */
438 .outdat_endpoints = {0x01, 0x02, 0x04, 0x06},
439 .inack_endpoints = {-1, -1, -1, -1},
440 .outcont_endpoints = {-1, -1, -1, -1},
441 .instat_endpoint = 0x81,
442 .indat_endpoint = 0x88,
443 .glocont_endpoint = 0x00, /* uses control EP */
444 .calculate_baud_rate = keyspan_usa19w_calc_baud,
445 .baudclk = KEYSPAN_USA19W_BAUDCLK,
446};
447
448static const struct keyspan_device_details *keyspan_devices[] = {
449 &usa18x_device_details,
450 &usa19_device_details,
451 &usa19qi_device_details,
452 &mpr_device_details,
453 &usa19qw_device_details,
454 &usa19w_device_details,
455 &usa19hs_device_details,
456 &usa28_device_details,
457 &usa28x_device_details,
458 &usa28xa_device_details,
459 &usa28xg_device_details,
460 /* 28xb not required as it renumerates as a 28x */
461 &usa49w_device_details,
462 &usa49wlc_device_details,
463 &usa49wg_device_details,
464 NULL,
465};
466
467static const struct usb_device_id keyspan_ids_combined[] = {
468 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_pre_product_id) },
469 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_pre_product_id) },
470 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_pre_product_id) },
471 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_pre_product_id) },
472 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_pre_product_id) },
473 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_pre_product_id) },
474 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_pre_product_id) },
475 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_pre_product_id) },
476 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_pre_product_id) },
477 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xb_pre_product_id) },
478 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_pre_product_id) },
479 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_pre_product_id) },
480 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_product_id) },
481 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_product_id) },
482 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_product_id) },
483 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_product_id) },
484 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_product_id) },
485 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19hs_product_id) },
486 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_product_id) },
487 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_product_id) },
488 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_product_id) },
489 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_product_id) },
490 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xg_product_id) },
491 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_product_id)},
492 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_product_id)},
493 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wg_product_id)},
494 { } /* Terminating entry */
495};
496
497MODULE_DEVICE_TABLE(usb, keyspan_ids_combined);
498
499/* usb_device_id table for the pre-firmware download keyspan devices */
500static const struct usb_device_id keyspan_pre_ids[] = {
501 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_pre_product_id) },
502 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_pre_product_id) },
503 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_pre_product_id) },
504 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_pre_product_id) },
505 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_pre_product_id) },
506 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_pre_product_id) },
507 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_pre_product_id) },
508 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_pre_product_id) },
509 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_pre_product_id) },
510 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xb_pre_product_id) },
511 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_pre_product_id) },
512 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_pre_product_id) },
513 { } /* Terminating entry */
514};
515
516static const struct usb_device_id keyspan_1port_ids[] = {
517 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_product_id) },
518 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_product_id) },
519 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_product_id) },
520 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_product_id) },
521 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_product_id) },
522 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19hs_product_id) },
523 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_product_id) },
524 { } /* Terminating entry */
525};
526
527static const struct usb_device_id keyspan_2port_ids[] = {
528 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_product_id) },
529 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_product_id) },
530 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_product_id) },
531 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xg_product_id) },
532 { } /* Terminating entry */
533};
534
535static const struct usb_device_id keyspan_4port_ids[] = {
536 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_product_id) },
537 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_product_id)},
538 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wg_product_id)},
539 { } /* Terminating entry */
540};
541
542#define INSTAT_BUFLEN 32
543#define GLOCONT_BUFLEN 64
544#define INDAT49W_BUFLEN 512
545#define IN_BUFLEN 64
546#define OUT_BUFLEN 64
547#define INACK_BUFLEN 1
548#define OUTCONT_BUFLEN 64
549
550 /* Per device and per port private data */
551struct keyspan_serial_private {
552 const struct keyspan_device_details *device_details;
553
554 struct urb *instat_urb;
555 char *instat_buf;
556
557 /* added to support 49wg, where data from all 4 ports comes in
558 on 1 EP and high-speed supported */
559 struct urb *indat_urb;
560 char *indat_buf;
561
562 /* XXX this one probably will need a lock */
563 struct urb *glocont_urb;
564 char *glocont_buf;
565 char *ctrl_buf; /* for EP0 control message */
566};
567
568struct keyspan_port_private {
569 /* Keep track of which input & output endpoints to use */
570 int in_flip;
571 int out_flip;
572
573 /* Keep duplicate of device details in each port
574 structure as well - simplifies some of the
575 callback functions etc. */
576 const struct keyspan_device_details *device_details;
577
578 /* Input endpoints and buffer for this port */
579 struct urb *in_urbs[2];
580 char *in_buffer[2];
581 /* Output endpoints and buffer for this port */
582 struct urb *out_urbs[2];
583 char *out_buffer[2];
584
585 /* Input ack endpoint */
586 struct urb *inack_urb;
587 char *inack_buffer;
588
589 /* Output control endpoint */
590 struct urb *outcont_urb;
591 char *outcont_buffer;
592
593 /* Settings for the port */
594 int baud;
595 int old_baud;
596 unsigned int cflag;
597 unsigned int old_cflag;
598 enum {flow_none, flow_cts, flow_xon} flow_control;
599 int rts_state; /* Handshaking pins (outputs) */
600 int dtr_state;
601 int cts_state; /* Handshaking pins (inputs) */
602 int dsr_state;
603 int dcd_state;
604 int ri_state;
605 int break_on;
606
607 unsigned long tx_start_time[2];
608 int resend_cont; /* need to resend control packet */
609};
610
611/* Include Keyspan message headers. All current Keyspan Adapters
612 make use of one of five message formats which are referred
613 to as USA-26, USA-28, USA-49, USA-90, USA-67 by Keyspan and
614 within this driver. */
615#include "keyspan_usa26msg.h"
616#include "keyspan_usa28msg.h"
617#include "keyspan_usa49msg.h"
618#include "keyspan_usa90msg.h"
619#include "keyspan_usa67msg.h"
620
621
622static void keyspan_break_ctl(struct tty_struct *tty, int break_state)
623{
624 struct usb_serial_port *port = tty->driver_data;
625 struct keyspan_port_private *p_priv;
626
627 p_priv = usb_get_serial_port_data(port);
628
629 if (break_state == -1)
630 p_priv->break_on = 1;
631 else
632 p_priv->break_on = 0;
633
634 keyspan_send_setup(port, 0);
635}
636
637
638static void keyspan_set_termios(struct tty_struct *tty,
639 struct usb_serial_port *port, struct ktermios *old_termios)
640{
641 int baud_rate, device_port;
642 struct keyspan_port_private *p_priv;
643 const struct keyspan_device_details *d_details;
644 unsigned int cflag;
645
646 p_priv = usb_get_serial_port_data(port);
647 d_details = p_priv->device_details;
648 cflag = tty->termios.c_cflag;
649 device_port = port->port_number;
650
651 /* Baud rate calculation takes baud rate as an integer
652 so other rates can be generated if desired. */
653 baud_rate = tty_get_baud_rate(tty);
654 /* If no match or invalid, don't change */
655 if (d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
656 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
657 /* FIXME - more to do here to ensure rate changes cleanly */
658 /* FIXME - calculate exact rate from divisor ? */
659 p_priv->baud = baud_rate;
660 } else
661 baud_rate = tty_termios_baud_rate(old_termios);
662
663 tty_encode_baud_rate(tty, baud_rate, baud_rate);
664 /* set CTS/RTS handshake etc. */
665 p_priv->cflag = cflag;
666 p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
667
668 /* Mark/Space not supported */
669 tty->termios.c_cflag &= ~CMSPAR;
670
671 keyspan_send_setup(port, 0);
672}
673
674static int keyspan_tiocmget(struct tty_struct *tty)
675{
676 struct usb_serial_port *port = tty->driver_data;
677 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
678 unsigned int value;
679
680 value = ((p_priv->rts_state) ? TIOCM_RTS : 0) |
681 ((p_priv->dtr_state) ? TIOCM_DTR : 0) |
682 ((p_priv->cts_state) ? TIOCM_CTS : 0) |
683 ((p_priv->dsr_state) ? TIOCM_DSR : 0) |
684 ((p_priv->dcd_state) ? TIOCM_CAR : 0) |
685 ((p_priv->ri_state) ? TIOCM_RNG : 0);
686
687 return value;
688}
689
690static int keyspan_tiocmset(struct tty_struct *tty,
691 unsigned int set, unsigned int clear)
692{
693 struct usb_serial_port *port = tty->driver_data;
694 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
695
696 if (set & TIOCM_RTS)
697 p_priv->rts_state = 1;
698 if (set & TIOCM_DTR)
699 p_priv->dtr_state = 1;
700 if (clear & TIOCM_RTS)
701 p_priv->rts_state = 0;
702 if (clear & TIOCM_DTR)
703 p_priv->dtr_state = 0;
704 keyspan_send_setup(port, 0);
705 return 0;
706}
707
708/* Write function is similar for the four protocols used
709 with only a minor change for usa90 (usa19hs) required */
710static int keyspan_write(struct tty_struct *tty,
711 struct usb_serial_port *port, const unsigned char *buf, int count)
712{
713 struct keyspan_port_private *p_priv;
714 const struct keyspan_device_details *d_details;
715 int flip;
716 int left, todo;
717 struct urb *this_urb;
718 int err, maxDataLen, dataOffset;
719
720 p_priv = usb_get_serial_port_data(port);
721 d_details = p_priv->device_details;
722
723 if (d_details->msg_format == msg_usa90) {
724 maxDataLen = 64;
725 dataOffset = 0;
726 } else {
727 maxDataLen = 63;
728 dataOffset = 1;
729 }
730
731 dev_dbg(&port->dev, "%s - %d chars, flip=%d\n", __func__, count,
732 p_priv->out_flip);
733
734 for (left = count; left > 0; left -= todo) {
735 todo = left;
736 if (todo > maxDataLen)
737 todo = maxDataLen;
738
739 flip = p_priv->out_flip;
740
741 /* Check we have a valid urb/endpoint before we use it... */
742 this_urb = p_priv->out_urbs[flip];
743 if (this_urb == NULL) {
744 /* no bulk out, so return 0 bytes written */
745 dev_dbg(&port->dev, "%s - no output urb :(\n", __func__);
746 return count;
747 }
748
749 dev_dbg(&port->dev, "%s - endpoint %x flip %d\n",
750 __func__, usb_pipeendpoint(this_urb->pipe), flip);
751
752 if (this_urb->status == -EINPROGRESS) {
753 if (time_before(jiffies,
754 p_priv->tx_start_time[flip] + 10 * HZ))
755 break;
756 usb_unlink_urb(this_urb);
757 break;
758 }
759
760 /* First byte in buffer is "last flag" (except for usa19hx)
761 - unused so for now so set to zero */
762 ((char *)this_urb->transfer_buffer)[0] = 0;
763
764 memcpy(this_urb->transfer_buffer + dataOffset, buf, todo);
765 buf += todo;
766
767 /* send the data out the bulk port */
768 this_urb->transfer_buffer_length = todo + dataOffset;
769
770 err = usb_submit_urb(this_urb, GFP_ATOMIC);
771 if (err != 0)
772 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed (%d)\n", err);
773 p_priv->tx_start_time[flip] = jiffies;
774
775 /* Flip for next time if usa26 or usa28 interface
776 (not used on usa49) */
777 p_priv->out_flip = (flip + 1) & d_details->outdat_endp_flip;
778 }
779
780 return count - left;
781}
782
783static void usa26_indat_callback(struct urb *urb)
784{
785 int i, err;
786 int endpoint;
787 struct usb_serial_port *port;
788 unsigned char *data = urb->transfer_buffer;
789 int status = urb->status;
790
791 endpoint = usb_pipeendpoint(urb->pipe);
792
793 if (status) {
794 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
795 __func__, status, endpoint);
796 return;
797 }
798
799 port = urb->context;
800 if (urb->actual_length) {
801 /* 0x80 bit is error flag */
802 if ((data[0] & 0x80) == 0) {
803 /* no errors on individual bytes, only
804 possible overrun err */
805 if (data[0] & RXERROR_OVERRUN) {
806 tty_insert_flip_char(&port->port, 0,
807 TTY_OVERRUN);
808 }
809 for (i = 1; i < urb->actual_length ; ++i)
810 tty_insert_flip_char(&port->port, data[i],
811 TTY_NORMAL);
812 } else {
813 /* some bytes had errors, every byte has status */
814 dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
815 for (i = 0; i + 1 < urb->actual_length; i += 2) {
816 int stat = data[i];
817 int flag = TTY_NORMAL;
818
819 if (stat & RXERROR_OVERRUN) {
820 tty_insert_flip_char(&port->port, 0,
821 TTY_OVERRUN);
822 }
823 /* XXX should handle break (0x10) */
824 if (stat & RXERROR_PARITY)
825 flag = TTY_PARITY;
826 else if (stat & RXERROR_FRAMING)
827 flag = TTY_FRAME;
828
829 tty_insert_flip_char(&port->port, data[i+1],
830 flag);
831 }
832 }
833 tty_flip_buffer_push(&port->port);
834 }
835
836 /* Resubmit urb so we continue receiving */
837 err = usb_submit_urb(urb, GFP_ATOMIC);
838 if (err != 0)
839 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
840}
841
842/* Outdat handling is common for all devices */
843static void usa2x_outdat_callback(struct urb *urb)
844{
845 struct usb_serial_port *port;
846 struct keyspan_port_private *p_priv;
847
848 port = urb->context;
849 p_priv = usb_get_serial_port_data(port);
850 dev_dbg(&port->dev, "%s - urb %d\n", __func__, urb == p_priv->out_urbs[1]);
851
852 usb_serial_port_softint(port);
853}
854
855static void usa26_inack_callback(struct urb *urb)
856{
857}
858
859static void usa26_outcont_callback(struct urb *urb)
860{
861 struct usb_serial_port *port;
862 struct keyspan_port_private *p_priv;
863
864 port = urb->context;
865 p_priv = usb_get_serial_port_data(port);
866
867 if (p_priv->resend_cont) {
868 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
869 keyspan_usa26_send_setup(port->serial, port,
870 p_priv->resend_cont - 1);
871 }
872}
873
874static void usa26_instat_callback(struct urb *urb)
875{
876 unsigned char *data = urb->transfer_buffer;
877 struct keyspan_usa26_portStatusMessage *msg;
878 struct usb_serial *serial;
879 struct usb_serial_port *port;
880 struct keyspan_port_private *p_priv;
881 int old_dcd_state, err;
882 int status = urb->status;
883
884 serial = urb->context;
885
886 if (status) {
887 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
888 __func__, status);
889 return;
890 }
891 if (urb->actual_length != 9) {
892 dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
893 goto exit;
894 }
895
896 msg = (struct keyspan_usa26_portStatusMessage *)data;
897
898 /* Check port number from message and retrieve private data */
899 if (msg->port >= serial->num_ports) {
900 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
901 goto exit;
902 }
903 port = serial->port[msg->port];
904 p_priv = usb_get_serial_port_data(port);
905 if (!p_priv)
906 goto resubmit;
907
908 /* Update handshaking pin state information */
909 old_dcd_state = p_priv->dcd_state;
910 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
911 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
912 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
913 p_priv->ri_state = ((msg->ri) ? 1 : 0);
914
915 if (old_dcd_state != p_priv->dcd_state)
916 tty_port_tty_hangup(&port->port, true);
917resubmit:
918 /* Resubmit urb so we continue receiving */
919 err = usb_submit_urb(urb, GFP_ATOMIC);
920 if (err != 0)
921 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
922exit: ;
923}
924
925static void usa26_glocont_callback(struct urb *urb)
926{
927}
928
929
930static void usa28_indat_callback(struct urb *urb)
931{
932 int err;
933 struct usb_serial_port *port;
934 unsigned char *data;
935 struct keyspan_port_private *p_priv;
936 int status = urb->status;
937
938 port = urb->context;
939 p_priv = usb_get_serial_port_data(port);
940 data = urb->transfer_buffer;
941
942 if (urb != p_priv->in_urbs[p_priv->in_flip])
943 return;
944
945 do {
946 if (status) {
947 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
948 __func__, status, usb_pipeendpoint(urb->pipe));
949 return;
950 }
951
952 port = urb->context;
953 p_priv = usb_get_serial_port_data(port);
954 data = urb->transfer_buffer;
955
956 if (urb->actual_length) {
957 tty_insert_flip_string(&port->port, data,
958 urb->actual_length);
959 tty_flip_buffer_push(&port->port);
960 }
961
962 /* Resubmit urb so we continue receiving */
963 err = usb_submit_urb(urb, GFP_ATOMIC);
964 if (err != 0)
965 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n",
966 __func__, err);
967 p_priv->in_flip ^= 1;
968
969 urb = p_priv->in_urbs[p_priv->in_flip];
970 } while (urb->status != -EINPROGRESS);
971}
972
973static void usa28_inack_callback(struct urb *urb)
974{
975}
976
977static void usa28_outcont_callback(struct urb *urb)
978{
979 struct usb_serial_port *port;
980 struct keyspan_port_private *p_priv;
981
982 port = urb->context;
983 p_priv = usb_get_serial_port_data(port);
984
985 if (p_priv->resend_cont) {
986 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
987 keyspan_usa28_send_setup(port->serial, port,
988 p_priv->resend_cont - 1);
989 }
990}
991
992static void usa28_instat_callback(struct urb *urb)
993{
994 int err;
995 unsigned char *data = urb->transfer_buffer;
996 struct keyspan_usa28_portStatusMessage *msg;
997 struct usb_serial *serial;
998 struct usb_serial_port *port;
999 struct keyspan_port_private *p_priv;
1000 int old_dcd_state;
1001 int status = urb->status;
1002
1003 serial = urb->context;
1004
1005 if (status) {
1006 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1007 __func__, status);
1008 return;
1009 }
1010
1011 if (urb->actual_length != sizeof(struct keyspan_usa28_portStatusMessage)) {
1012 dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1013 goto exit;
1014 }
1015
1016 msg = (struct keyspan_usa28_portStatusMessage *)data;
1017
1018 /* Check port number from message and retrieve private data */
1019 if (msg->port >= serial->num_ports) {
1020 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
1021 goto exit;
1022 }
1023 port = serial->port[msg->port];
1024 p_priv = usb_get_serial_port_data(port);
1025 if (!p_priv)
1026 goto resubmit;
1027
1028 /* Update handshaking pin state information */
1029 old_dcd_state = p_priv->dcd_state;
1030 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1031 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1032 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1033 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1034
1035 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1036 tty_port_tty_hangup(&port->port, true);
1037resubmit:
1038 /* Resubmit urb so we continue receiving */
1039 err = usb_submit_urb(urb, GFP_ATOMIC);
1040 if (err != 0)
1041 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1042exit: ;
1043}
1044
1045static void usa28_glocont_callback(struct urb *urb)
1046{
1047}
1048
1049
1050static void usa49_glocont_callback(struct urb *urb)
1051{
1052 struct usb_serial *serial;
1053 struct usb_serial_port *port;
1054 struct keyspan_port_private *p_priv;
1055 int i;
1056
1057 serial = urb->context;
1058 for (i = 0; i < serial->num_ports; ++i) {
1059 port = serial->port[i];
1060 p_priv = usb_get_serial_port_data(port);
1061 if (!p_priv)
1062 continue;
1063
1064 if (p_priv->resend_cont) {
1065 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
1066 keyspan_usa49_send_setup(serial, port,
1067 p_priv->resend_cont - 1);
1068 break;
1069 }
1070 }
1071}
1072
1073 /* This is actually called glostat in the Keyspan
1074 doco */
1075static void usa49_instat_callback(struct urb *urb)
1076{
1077 int err;
1078 unsigned char *data = urb->transfer_buffer;
1079 struct keyspan_usa49_portStatusMessage *msg;
1080 struct usb_serial *serial;
1081 struct usb_serial_port *port;
1082 struct keyspan_port_private *p_priv;
1083 int old_dcd_state;
1084 int status = urb->status;
1085
1086 serial = urb->context;
1087
1088 if (status) {
1089 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1090 __func__, status);
1091 return;
1092 }
1093
1094 if (urb->actual_length !=
1095 sizeof(struct keyspan_usa49_portStatusMessage)) {
1096 dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1097 goto exit;
1098 }
1099
1100 msg = (struct keyspan_usa49_portStatusMessage *)data;
1101
1102 /* Check port number from message and retrieve private data */
1103 if (msg->portNumber >= serial->num_ports) {
1104 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
1105 __func__, msg->portNumber);
1106 goto exit;
1107 }
1108 port = serial->port[msg->portNumber];
1109 p_priv = usb_get_serial_port_data(port);
1110 if (!p_priv)
1111 goto resubmit;
1112
1113 /* Update handshaking pin state information */
1114 old_dcd_state = p_priv->dcd_state;
1115 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1116 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1117 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1118 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1119
1120 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1121 tty_port_tty_hangup(&port->port, true);
1122resubmit:
1123 /* Resubmit urb so we continue receiving */
1124 err = usb_submit_urb(urb, GFP_ATOMIC);
1125 if (err != 0)
1126 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1127exit: ;
1128}
1129
1130static void usa49_inack_callback(struct urb *urb)
1131{
1132}
1133
1134static void usa49_indat_callback(struct urb *urb)
1135{
1136 int i, err;
1137 int endpoint;
1138 struct usb_serial_port *port;
1139 unsigned char *data = urb->transfer_buffer;
1140 int status = urb->status;
1141
1142 endpoint = usb_pipeendpoint(urb->pipe);
1143
1144 if (status) {
1145 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
1146 __func__, status, endpoint);
1147 return;
1148 }
1149
1150 port = urb->context;
1151 if (urb->actual_length) {
1152 /* 0x80 bit is error flag */
1153 if ((data[0] & 0x80) == 0) {
1154 /* no error on any byte */
1155 tty_insert_flip_string(&port->port, data + 1,
1156 urb->actual_length - 1);
1157 } else {
1158 /* some bytes had errors, every byte has status */
1159 for (i = 0; i + 1 < urb->actual_length; i += 2) {
1160 int stat = data[i];
1161 int flag = TTY_NORMAL;
1162
1163 if (stat & RXERROR_OVERRUN) {
1164 tty_insert_flip_char(&port->port, 0,
1165 TTY_OVERRUN);
1166 }
1167 /* XXX should handle break (0x10) */
1168 if (stat & RXERROR_PARITY)
1169 flag = TTY_PARITY;
1170 else if (stat & RXERROR_FRAMING)
1171 flag = TTY_FRAME;
1172
1173 tty_insert_flip_char(&port->port, data[i+1],
1174 flag);
1175 }
1176 }
1177 tty_flip_buffer_push(&port->port);
1178 }
1179
1180 /* Resubmit urb so we continue receiving */
1181 err = usb_submit_urb(urb, GFP_ATOMIC);
1182 if (err != 0)
1183 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1184}
1185
1186static void usa49wg_indat_callback(struct urb *urb)
1187{
1188 int i, len, x, err;
1189 struct usb_serial *serial;
1190 struct usb_serial_port *port;
1191 unsigned char *data = urb->transfer_buffer;
1192 int status = urb->status;
1193
1194 serial = urb->context;
1195
1196 if (status) {
1197 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1198 __func__, status);
1199 return;
1200 }
1201
1202 /* inbound data is in the form P#, len, status, data */
1203 i = 0;
1204 len = 0;
1205
1206 while (i < urb->actual_length) {
1207
1208 /* Check port number from message */
1209 if (data[i] >= serial->num_ports) {
1210 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
1211 __func__, data[i]);
1212 return;
1213 }
1214 port = serial->port[data[i++]];
1215 len = data[i++];
1216
1217 /* 0x80 bit is error flag */
1218 if ((data[i] & 0x80) == 0) {
1219 /* no error on any byte */
1220 i++;
1221 for (x = 1; x < len && i < urb->actual_length; ++x)
1222 tty_insert_flip_char(&port->port,
1223 data[i++], 0);
1224 } else {
1225 /*
1226 * some bytes had errors, every byte has status
1227 */
1228 for (x = 0; x + 1 < len &&
1229 i + 1 < urb->actual_length; x += 2) {
1230 int stat = data[i];
1231 int flag = TTY_NORMAL;
1232
1233 if (stat & RXERROR_OVERRUN) {
1234 tty_insert_flip_char(&port->port, 0,
1235 TTY_OVERRUN);
1236 }
1237 /* XXX should handle break (0x10) */
1238 if (stat & RXERROR_PARITY)
1239 flag = TTY_PARITY;
1240 else if (stat & RXERROR_FRAMING)
1241 flag = TTY_FRAME;
1242
1243 tty_insert_flip_char(&port->port, data[i+1],
1244 flag);
1245 i += 2;
1246 }
1247 }
1248 tty_flip_buffer_push(&port->port);
1249 }
1250
1251 /* Resubmit urb so we continue receiving */
1252 err = usb_submit_urb(urb, GFP_ATOMIC);
1253 if (err != 0)
1254 dev_dbg(&urb->dev->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1255}
1256
1257/* not used, usa-49 doesn't have per-port control endpoints */
1258static void usa49_outcont_callback(struct urb *urb)
1259{
1260}
1261
1262static void usa90_indat_callback(struct urb *urb)
1263{
1264 int i, err;
1265 int endpoint;
1266 struct usb_serial_port *port;
1267 struct keyspan_port_private *p_priv;
1268 unsigned char *data = urb->transfer_buffer;
1269 int status = urb->status;
1270
1271 endpoint = usb_pipeendpoint(urb->pipe);
1272
1273 if (status) {
1274 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
1275 __func__, status, endpoint);
1276 return;
1277 }
1278
1279 port = urb->context;
1280 p_priv = usb_get_serial_port_data(port);
1281
1282 if (urb->actual_length) {
1283 /* if current mode is DMA, looks like usa28 format
1284 otherwise looks like usa26 data format */
1285
1286 if (p_priv->baud > 57600)
1287 tty_insert_flip_string(&port->port, data,
1288 urb->actual_length);
1289 else {
1290 /* 0x80 bit is error flag */
1291 if ((data[0] & 0x80) == 0) {
1292 /* no errors on individual bytes, only
1293 possible overrun err*/
1294 if (data[0] & RXERROR_OVERRUN) {
1295 tty_insert_flip_char(&port->port, 0,
1296 TTY_OVERRUN);
1297 }
1298 for (i = 1; i < urb->actual_length ; ++i)
1299 tty_insert_flip_char(&port->port,
1300 data[i], TTY_NORMAL);
1301 } else {
1302 /* some bytes had errors, every byte has status */
1303 dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
1304 for (i = 0; i + 1 < urb->actual_length; i += 2) {
1305 int stat = data[i];
1306 int flag = TTY_NORMAL;
1307
1308 if (stat & RXERROR_OVERRUN) {
1309 tty_insert_flip_char(
1310 &port->port, 0,
1311 TTY_OVERRUN);
1312 }
1313 /* XXX should handle break (0x10) */
1314 if (stat & RXERROR_PARITY)
1315 flag = TTY_PARITY;
1316 else if (stat & RXERROR_FRAMING)
1317 flag = TTY_FRAME;
1318
1319 tty_insert_flip_char(&port->port,
1320 data[i+1], flag);
1321 }
1322 }
1323 }
1324 tty_flip_buffer_push(&port->port);
1325 }
1326
1327 /* Resubmit urb so we continue receiving */
1328 err = usb_submit_urb(urb, GFP_ATOMIC);
1329 if (err != 0)
1330 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1331}
1332
1333
1334static void usa90_instat_callback(struct urb *urb)
1335{
1336 unsigned char *data = urb->transfer_buffer;
1337 struct keyspan_usa90_portStatusMessage *msg;
1338 struct usb_serial *serial;
1339 struct usb_serial_port *port;
1340 struct keyspan_port_private *p_priv;
1341 int old_dcd_state, err;
1342 int status = urb->status;
1343
1344 serial = urb->context;
1345
1346 if (status) {
1347 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1348 __func__, status);
1349 return;
1350 }
1351 if (urb->actual_length < 14) {
1352 dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
1353 goto exit;
1354 }
1355
1356 msg = (struct keyspan_usa90_portStatusMessage *)data;
1357
1358 /* Now do something useful with the data */
1359
1360 port = serial->port[0];
1361 p_priv = usb_get_serial_port_data(port);
1362 if (!p_priv)
1363 goto resubmit;
1364
1365 /* Update handshaking pin state information */
1366 old_dcd_state = p_priv->dcd_state;
1367 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1368 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1369 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1370 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1371
1372 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1373 tty_port_tty_hangup(&port->port, true);
1374resubmit:
1375 /* Resubmit urb so we continue receiving */
1376 err = usb_submit_urb(urb, GFP_ATOMIC);
1377 if (err != 0)
1378 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1379exit:
1380 ;
1381}
1382
1383static void usa90_outcont_callback(struct urb *urb)
1384{
1385 struct usb_serial_port *port;
1386 struct keyspan_port_private *p_priv;
1387
1388 port = urb->context;
1389 p_priv = usb_get_serial_port_data(port);
1390
1391 if (p_priv->resend_cont) {
1392 dev_dbg(&urb->dev->dev, "%s - sending setup\n", __func__);
1393 keyspan_usa90_send_setup(port->serial, port,
1394 p_priv->resend_cont - 1);
1395 }
1396}
1397
1398/* Status messages from the 28xg */
1399static void usa67_instat_callback(struct urb *urb)
1400{
1401 int err;
1402 unsigned char *data = urb->transfer_buffer;
1403 struct keyspan_usa67_portStatusMessage *msg;
1404 struct usb_serial *serial;
1405 struct usb_serial_port *port;
1406 struct keyspan_port_private *p_priv;
1407 int old_dcd_state;
1408 int status = urb->status;
1409
1410 serial = urb->context;
1411
1412 if (status) {
1413 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1414 __func__, status);
1415 return;
1416 }
1417
1418 if (urb->actual_length !=
1419 sizeof(struct keyspan_usa67_portStatusMessage)) {
1420 dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1421 return;
1422 }
1423
1424
1425 /* Now do something useful with the data */
1426 msg = (struct keyspan_usa67_portStatusMessage *)data;
1427
1428 /* Check port number from message and retrieve private data */
1429 if (msg->port >= serial->num_ports) {
1430 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
1431 return;
1432 }
1433
1434 port = serial->port[msg->port];
1435 p_priv = usb_get_serial_port_data(port);
1436 if (!p_priv)
1437 goto resubmit;
1438
1439 /* Update handshaking pin state information */
1440 old_dcd_state = p_priv->dcd_state;
1441 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
1442 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
1443
1444 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1445 tty_port_tty_hangup(&port->port, true);
1446resubmit:
1447 /* Resubmit urb so we continue receiving */
1448 err = usb_submit_urb(urb, GFP_ATOMIC);
1449 if (err != 0)
1450 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1451}
1452
1453static void usa67_glocont_callback(struct urb *urb)
1454{
1455 struct usb_serial *serial;
1456 struct usb_serial_port *port;
1457 struct keyspan_port_private *p_priv;
1458 int i;
1459
1460 serial = urb->context;
1461 for (i = 0; i < serial->num_ports; ++i) {
1462 port = serial->port[i];
1463 p_priv = usb_get_serial_port_data(port);
1464 if (!p_priv)
1465 continue;
1466
1467 if (p_priv->resend_cont) {
1468 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
1469 keyspan_usa67_send_setup(serial, port,
1470 p_priv->resend_cont - 1);
1471 break;
1472 }
1473 }
1474}
1475
1476static int keyspan_write_room(struct tty_struct *tty)
1477{
1478 struct usb_serial_port *port = tty->driver_data;
1479 struct keyspan_port_private *p_priv;
1480 const struct keyspan_device_details *d_details;
1481 int flip;
1482 int data_len;
1483 struct urb *this_urb;
1484
1485 p_priv = usb_get_serial_port_data(port);
1486 d_details = p_priv->device_details;
1487
1488 /* FIXME: locking */
1489 if (d_details->msg_format == msg_usa90)
1490 data_len = 64;
1491 else
1492 data_len = 63;
1493
1494 flip = p_priv->out_flip;
1495
1496 /* Check both endpoints to see if any are available. */
1497 this_urb = p_priv->out_urbs[flip];
1498 if (this_urb != NULL) {
1499 if (this_urb->status != -EINPROGRESS)
1500 return data_len;
1501 flip = (flip + 1) & d_details->outdat_endp_flip;
1502 this_urb = p_priv->out_urbs[flip];
1503 if (this_urb != NULL) {
1504 if (this_urb->status != -EINPROGRESS)
1505 return data_len;
1506 }
1507 }
1508 return 0;
1509}
1510
1511
1512static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port)
1513{
1514 struct keyspan_port_private *p_priv;
1515 const struct keyspan_device_details *d_details;
1516 int i, err;
1517 int baud_rate, device_port;
1518 struct urb *urb;
1519 unsigned int cflag = 0;
1520
1521 p_priv = usb_get_serial_port_data(port);
1522 d_details = p_priv->device_details;
1523
1524 /* Set some sane defaults */
1525 p_priv->rts_state = 1;
1526 p_priv->dtr_state = 1;
1527 p_priv->baud = 9600;
1528
1529 /* force baud and lcr to be set on open */
1530 p_priv->old_baud = 0;
1531 p_priv->old_cflag = 0;
1532
1533 p_priv->out_flip = 0;
1534 p_priv->in_flip = 0;
1535
1536 /* Reset low level data toggle and start reading from endpoints */
1537 for (i = 0; i < 2; i++) {
1538 urb = p_priv->in_urbs[i];
1539 if (urb == NULL)
1540 continue;
1541
1542 /* make sure endpoint data toggle is synchronized
1543 with the device */
1544 usb_clear_halt(urb->dev, urb->pipe);
1545 err = usb_submit_urb(urb, GFP_KERNEL);
1546 if (err != 0)
1547 dev_dbg(&port->dev, "%s - submit urb %d failed (%d)\n", __func__, i, err);
1548 }
1549
1550 /* Reset low level data toggle on out endpoints */
1551 for (i = 0; i < 2; i++) {
1552 urb = p_priv->out_urbs[i];
1553 if (urb == NULL)
1554 continue;
1555 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1556 usb_pipeout(urb->pipe), 0); */
1557 }
1558
1559 /* get the terminal config for the setup message now so we don't
1560 * need to send 2 of them */
1561
1562 device_port = port->port_number;
1563 if (tty) {
1564 cflag = tty->termios.c_cflag;
1565 /* Baud rate calculation takes baud rate as an integer
1566 so other rates can be generated if desired. */
1567 baud_rate = tty_get_baud_rate(tty);
1568 /* If no match or invalid, leave as default */
1569 if (baud_rate >= 0
1570 && d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
1571 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
1572 p_priv->baud = baud_rate;
1573 }
1574 }
1575 /* set CTS/RTS handshake etc. */
1576 p_priv->cflag = cflag;
1577 p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
1578
1579 keyspan_send_setup(port, 1);
1580 /* mdelay(100); */
1581 /* keyspan_set_termios(port, NULL); */
1582
1583 return 0;
1584}
1585
1586static void keyspan_dtr_rts(struct usb_serial_port *port, int on)
1587{
1588 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
1589
1590 p_priv->rts_state = on;
1591 p_priv->dtr_state = on;
1592 keyspan_send_setup(port, 0);
1593}
1594
1595static void keyspan_close(struct usb_serial_port *port)
1596{
1597 int i;
1598 struct keyspan_port_private *p_priv;
1599
1600 p_priv = usb_get_serial_port_data(port);
1601
1602 p_priv->rts_state = 0;
1603 p_priv->dtr_state = 0;
1604
1605 keyspan_send_setup(port, 2);
1606 /* pilot-xfer seems to work best with this delay */
1607 mdelay(100);
1608
1609 p_priv->out_flip = 0;
1610 p_priv->in_flip = 0;
1611
1612 usb_kill_urb(p_priv->inack_urb);
1613 for (i = 0; i < 2; i++) {
1614 usb_kill_urb(p_priv->in_urbs[i]);
1615 usb_kill_urb(p_priv->out_urbs[i]);
1616 }
1617}
1618
1619/* download the firmware to a pre-renumeration device */
1620static int keyspan_fake_startup(struct usb_serial *serial)
1621{
1622 char *fw_name;
1623
1624 dev_dbg(&serial->dev->dev, "Keyspan startup version %04x product %04x\n",
1625 le16_to_cpu(serial->dev->descriptor.bcdDevice),
1626 le16_to_cpu(serial->dev->descriptor.idProduct));
1627
1628 if ((le16_to_cpu(serial->dev->descriptor.bcdDevice) & 0x8000)
1629 != 0x8000) {
1630 dev_dbg(&serial->dev->dev, "Firmware already loaded. Quitting.\n");
1631 return 1;
1632 }
1633
1634 /* Select firmware image on the basis of idProduct */
1635 switch (le16_to_cpu(serial->dev->descriptor.idProduct)) {
1636 case keyspan_usa28_pre_product_id:
1637 fw_name = "keyspan/usa28.fw";
1638 break;
1639
1640 case keyspan_usa28x_pre_product_id:
1641 fw_name = "keyspan/usa28x.fw";
1642 break;
1643
1644 case keyspan_usa28xa_pre_product_id:
1645 fw_name = "keyspan/usa28xa.fw";
1646 break;
1647
1648 case keyspan_usa28xb_pre_product_id:
1649 fw_name = "keyspan/usa28xb.fw";
1650 break;
1651
1652 case keyspan_usa19_pre_product_id:
1653 fw_name = "keyspan/usa19.fw";
1654 break;
1655
1656 case keyspan_usa19qi_pre_product_id:
1657 fw_name = "keyspan/usa19qi.fw";
1658 break;
1659
1660 case keyspan_mpr_pre_product_id:
1661 fw_name = "keyspan/mpr.fw";
1662 break;
1663
1664 case keyspan_usa19qw_pre_product_id:
1665 fw_name = "keyspan/usa19qw.fw";
1666 break;
1667
1668 case keyspan_usa18x_pre_product_id:
1669 fw_name = "keyspan/usa18x.fw";
1670 break;
1671
1672 case keyspan_usa19w_pre_product_id:
1673 fw_name = "keyspan/usa19w.fw";
1674 break;
1675
1676 case keyspan_usa49w_pre_product_id:
1677 fw_name = "keyspan/usa49w.fw";
1678 break;
1679
1680 case keyspan_usa49wlc_pre_product_id:
1681 fw_name = "keyspan/usa49wlc.fw";
1682 break;
1683
1684 default:
1685 dev_err(&serial->dev->dev, "Unknown product ID (%04x)\n",
1686 le16_to_cpu(serial->dev->descriptor.idProduct));
1687 return 1;
1688 }
1689
1690 dev_dbg(&serial->dev->dev, "Uploading Keyspan %s firmware.\n", fw_name);
1691
1692 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
1693 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
1694 fw_name);
1695 return -ENOENT;
1696 }
1697
1698 /* after downloading firmware Renumeration will occur in a
1699 moment and the new device will bind to the real driver */
1700
1701 /* we don't want this device to have a driver assigned to it. */
1702 return 1;
1703}
1704
1705/* Helper functions used by keyspan_setup_urbs */
1706static struct usb_endpoint_descriptor const *find_ep(struct usb_serial const *serial,
1707 int endpoint)
1708{
1709 struct usb_host_interface *iface_desc;
1710 struct usb_endpoint_descriptor *ep;
1711 int i;
1712
1713 iface_desc = serial->interface->cur_altsetting;
1714 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1715 ep = &iface_desc->endpoint[i].desc;
1716 if (ep->bEndpointAddress == endpoint)
1717 return ep;
1718 }
1719 dev_warn(&serial->interface->dev, "found no endpoint descriptor for endpoint %x\n",
1720 endpoint);
1721 return NULL;
1722}
1723
1724static struct urb *keyspan_setup_urb(struct usb_serial *serial, int endpoint,
1725 int dir, void *ctx, char *buf, int len,
1726 void (*callback)(struct urb *))
1727{
1728 struct urb *urb;
1729 struct usb_endpoint_descriptor const *ep_desc;
1730 char const *ep_type_name;
1731
1732 if (endpoint == -1)
1733 return NULL; /* endpoint not needed */
1734
1735 dev_dbg(&serial->interface->dev, "%s - alloc for endpoint %x\n",
1736 __func__, endpoint);
1737 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
1738 if (!urb)
1739 return NULL;
1740
1741 if (endpoint == 0) {
1742 /* control EP filled in when used */
1743 return urb;
1744 }
1745
1746 ep_desc = find_ep(serial, endpoint);
1747 if (!ep_desc) {
1748 usb_free_urb(urb);
1749 return NULL;
1750 }
1751 if (usb_endpoint_xfer_int(ep_desc)) {
1752 ep_type_name = "INT";
1753 usb_fill_int_urb(urb, serial->dev,
1754 usb_sndintpipe(serial->dev, endpoint) | dir,
1755 buf, len, callback, ctx,
1756 ep_desc->bInterval);
1757 } else if (usb_endpoint_xfer_bulk(ep_desc)) {
1758 ep_type_name = "BULK";
1759 usb_fill_bulk_urb(urb, serial->dev,
1760 usb_sndbulkpipe(serial->dev, endpoint) | dir,
1761 buf, len, callback, ctx);
1762 } else {
1763 dev_warn(&serial->interface->dev,
1764 "unsupported endpoint type %x\n",
1765 usb_endpoint_type(ep_desc));
1766 usb_free_urb(urb);
1767 return NULL;
1768 }
1769
1770 dev_dbg(&serial->interface->dev, "%s - using urb %p for %s endpoint %x\n",
1771 __func__, urb, ep_type_name, endpoint);
1772 return urb;
1773}
1774
1775static struct callbacks {
1776 void (*instat_callback)(struct urb *);
1777 void (*glocont_callback)(struct urb *);
1778 void (*indat_callback)(struct urb *);
1779 void (*outdat_callback)(struct urb *);
1780 void (*inack_callback)(struct urb *);
1781 void (*outcont_callback)(struct urb *);
1782} keyspan_callbacks[] = {
1783 {
1784 /* msg_usa26 callbacks */
1785 .instat_callback = usa26_instat_callback,
1786 .glocont_callback = usa26_glocont_callback,
1787 .indat_callback = usa26_indat_callback,
1788 .outdat_callback = usa2x_outdat_callback,
1789 .inack_callback = usa26_inack_callback,
1790 .outcont_callback = usa26_outcont_callback,
1791 }, {
1792 /* msg_usa28 callbacks */
1793 .instat_callback = usa28_instat_callback,
1794 .glocont_callback = usa28_glocont_callback,
1795 .indat_callback = usa28_indat_callback,
1796 .outdat_callback = usa2x_outdat_callback,
1797 .inack_callback = usa28_inack_callback,
1798 .outcont_callback = usa28_outcont_callback,
1799 }, {
1800 /* msg_usa49 callbacks */
1801 .instat_callback = usa49_instat_callback,
1802 .glocont_callback = usa49_glocont_callback,
1803 .indat_callback = usa49_indat_callback,
1804 .outdat_callback = usa2x_outdat_callback,
1805 .inack_callback = usa49_inack_callback,
1806 .outcont_callback = usa49_outcont_callback,
1807 }, {
1808 /* msg_usa90 callbacks */
1809 .instat_callback = usa90_instat_callback,
1810 .glocont_callback = usa28_glocont_callback,
1811 .indat_callback = usa90_indat_callback,
1812 .outdat_callback = usa2x_outdat_callback,
1813 .inack_callback = usa28_inack_callback,
1814 .outcont_callback = usa90_outcont_callback,
1815 }, {
1816 /* msg_usa67 callbacks */
1817 .instat_callback = usa67_instat_callback,
1818 .glocont_callback = usa67_glocont_callback,
1819 .indat_callback = usa26_indat_callback,
1820 .outdat_callback = usa2x_outdat_callback,
1821 .inack_callback = usa26_inack_callback,
1822 .outcont_callback = usa26_outcont_callback,
1823 }
1824};
1825
1826 /* Generic setup urbs function that uses
1827 data in device_details */
1828static void keyspan_setup_urbs(struct usb_serial *serial)
1829{
1830 struct keyspan_serial_private *s_priv;
1831 const struct keyspan_device_details *d_details;
1832 struct callbacks *cback;
1833
1834 s_priv = usb_get_serial_data(serial);
1835 d_details = s_priv->device_details;
1836
1837 /* Setup values for the various callback routines */
1838 cback = &keyspan_callbacks[d_details->msg_format];
1839
1840 /* Allocate and set up urbs for each one that is in use,
1841 starting with instat endpoints */
1842 s_priv->instat_urb = keyspan_setup_urb
1843 (serial, d_details->instat_endpoint, USB_DIR_IN,
1844 serial, s_priv->instat_buf, INSTAT_BUFLEN,
1845 cback->instat_callback);
1846
1847 s_priv->indat_urb = keyspan_setup_urb
1848 (serial, d_details->indat_endpoint, USB_DIR_IN,
1849 serial, s_priv->indat_buf, INDAT49W_BUFLEN,
1850 usa49wg_indat_callback);
1851
1852 s_priv->glocont_urb = keyspan_setup_urb
1853 (serial, d_details->glocont_endpoint, USB_DIR_OUT,
1854 serial, s_priv->glocont_buf, GLOCONT_BUFLEN,
1855 cback->glocont_callback);
1856}
1857
1858/* usa19 function doesn't require prescaler */
1859static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
1860 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1861 u8 *rate_low, u8 *prescaler, int portnum)
1862{
1863 u32 b16, /* baud rate times 16 (actual rate used internally) */
1864 div, /* divisor */
1865 cnt; /* inverse of divisor (programmed into 8051) */
1866
1867 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1868
1869 /* prevent divide by zero... */
1870 b16 = baud_rate * 16L;
1871 if (b16 == 0)
1872 return KEYSPAN_INVALID_BAUD_RATE;
1873 /* Any "standard" rate over 57k6 is marginal on the USA-19
1874 as we run out of divisor resolution. */
1875 if (baud_rate > 57600)
1876 return KEYSPAN_INVALID_BAUD_RATE;
1877
1878 /* calculate the divisor and the counter (its inverse) */
1879 div = baudclk / b16;
1880 if (div == 0)
1881 return KEYSPAN_INVALID_BAUD_RATE;
1882 else
1883 cnt = 0 - div;
1884
1885 if (div > 0xffff)
1886 return KEYSPAN_INVALID_BAUD_RATE;
1887
1888 /* return the counter values if non-null */
1889 if (rate_low)
1890 *rate_low = (u8) (cnt & 0xff);
1891 if (rate_hi)
1892 *rate_hi = (u8) ((cnt >> 8) & 0xff);
1893 if (rate_low && rate_hi)
1894 dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1895 __func__, baud_rate, *rate_hi, *rate_low);
1896 return KEYSPAN_BAUD_RATE_OK;
1897}
1898
1899/* usa19hs function doesn't require prescaler */
1900static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
1901 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1902 u8 *rate_low, u8 *prescaler, int portnum)
1903{
1904 u32 b16, /* baud rate times 16 (actual rate used internally) */
1905 div; /* divisor */
1906
1907 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1908
1909 /* prevent divide by zero... */
1910 b16 = baud_rate * 16L;
1911 if (b16 == 0)
1912 return KEYSPAN_INVALID_BAUD_RATE;
1913
1914 /* calculate the divisor */
1915 div = baudclk / b16;
1916 if (div == 0)
1917 return KEYSPAN_INVALID_BAUD_RATE;
1918
1919 if (div > 0xffff)
1920 return KEYSPAN_INVALID_BAUD_RATE;
1921
1922 /* return the counter values if non-null */
1923 if (rate_low)
1924 *rate_low = (u8) (div & 0xff);
1925
1926 if (rate_hi)
1927 *rate_hi = (u8) ((div >> 8) & 0xff);
1928
1929 if (rate_low && rate_hi)
1930 dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1931 __func__, baud_rate, *rate_hi, *rate_low);
1932
1933 return KEYSPAN_BAUD_RATE_OK;
1934}
1935
1936static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
1937 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1938 u8 *rate_low, u8 *prescaler, int portnum)
1939{
1940 u32 b16, /* baud rate times 16 (actual rate used internally) */
1941 clk, /* clock with 13/8 prescaler */
1942 div, /* divisor using 13/8 prescaler */
1943 res, /* resulting baud rate using 13/8 prescaler */
1944 diff, /* error using 13/8 prescaler */
1945 smallest_diff;
1946 u8 best_prescaler;
1947 int i;
1948
1949 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1950
1951 /* prevent divide by zero */
1952 b16 = baud_rate * 16L;
1953 if (b16 == 0)
1954 return KEYSPAN_INVALID_BAUD_RATE;
1955
1956 /* Calculate prescaler by trying them all and looking
1957 for best fit */
1958
1959 /* start with largest possible difference */
1960 smallest_diff = 0xffffffff;
1961
1962 /* 0 is an invalid prescaler, used as a flag */
1963 best_prescaler = 0;
1964
1965 for (i = 8; i <= 0xff; ++i) {
1966 clk = (baudclk * 8) / (u32) i;
1967
1968 div = clk / b16;
1969 if (div == 0)
1970 continue;
1971
1972 res = clk / div;
1973 diff = (res > b16) ? (res-b16) : (b16-res);
1974
1975 if (diff < smallest_diff) {
1976 best_prescaler = i;
1977 smallest_diff = diff;
1978 }
1979 }
1980
1981 if (best_prescaler == 0)
1982 return KEYSPAN_INVALID_BAUD_RATE;
1983
1984 clk = (baudclk * 8) / (u32) best_prescaler;
1985 div = clk / b16;
1986
1987 /* return the divisor and prescaler if non-null */
1988 if (rate_low)
1989 *rate_low = (u8) (div & 0xff);
1990 if (rate_hi)
1991 *rate_hi = (u8) ((div >> 8) & 0xff);
1992 if (prescaler) {
1993 *prescaler = best_prescaler;
1994 /* dev_dbg(&port->dev, "%s - %d %d\n", __func__, *prescaler, div); */
1995 }
1996 return KEYSPAN_BAUD_RATE_OK;
1997}
1998
1999 /* USA-28 supports different maximum baud rates on each port */
2000static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
2001 u32 baud_rate, u32 baudclk, u8 *rate_hi,
2002 u8 *rate_low, u8 *prescaler, int portnum)
2003{
2004 u32 b16, /* baud rate times 16 (actual rate used internally) */
2005 div, /* divisor */
2006 cnt; /* inverse of divisor (programmed into 8051) */
2007
2008 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
2009
2010 /* prevent divide by zero */
2011 b16 = baud_rate * 16L;
2012 if (b16 == 0)
2013 return KEYSPAN_INVALID_BAUD_RATE;
2014
2015 /* calculate the divisor and the counter (its inverse) */
2016 div = KEYSPAN_USA28_BAUDCLK / b16;
2017 if (div == 0)
2018 return KEYSPAN_INVALID_BAUD_RATE;
2019 else
2020 cnt = 0 - div;
2021
2022 /* check for out of range, based on portnum,
2023 and return result */
2024 if (portnum == 0) {
2025 if (div > 0xffff)
2026 return KEYSPAN_INVALID_BAUD_RATE;
2027 } else {
2028 if (portnum == 1) {
2029 if (div > 0xff)
2030 return KEYSPAN_INVALID_BAUD_RATE;
2031 } else
2032 return KEYSPAN_INVALID_BAUD_RATE;
2033 }
2034
2035 /* return the counter values if not NULL
2036 (port 1 will ignore retHi) */
2037 if (rate_low)
2038 *rate_low = (u8) (cnt & 0xff);
2039 if (rate_hi)
2040 *rate_hi = (u8) ((cnt >> 8) & 0xff);
2041 dev_dbg(&port->dev, "%s - %d OK.\n", __func__, baud_rate);
2042 return KEYSPAN_BAUD_RATE_OK;
2043}
2044
2045static int keyspan_usa26_send_setup(struct usb_serial *serial,
2046 struct usb_serial_port *port,
2047 int reset_port)
2048{
2049 struct keyspan_usa26_portControlMessage msg;
2050 struct keyspan_serial_private *s_priv;
2051 struct keyspan_port_private *p_priv;
2052 const struct keyspan_device_details *d_details;
2053 struct urb *this_urb;
2054 int device_port, err;
2055
2056 dev_dbg(&port->dev, "%s reset=%d\n", __func__, reset_port);
2057
2058 s_priv = usb_get_serial_data(serial);
2059 p_priv = usb_get_serial_port_data(port);
2060 d_details = s_priv->device_details;
2061 device_port = port->port_number;
2062
2063 this_urb = p_priv->outcont_urb;
2064
2065 /* Make sure we have an urb then send the message */
2066 if (this_urb == NULL) {
2067 dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2068 return -1;
2069 }
2070
2071 dev_dbg(&port->dev, "%s - endpoint %x\n",
2072 __func__, usb_pipeendpoint(this_urb->pipe));
2073
2074 /* Save reset port val for resend.
2075 Don't overwrite resend for open/close condition. */
2076 if ((reset_port + 1) > p_priv->resend_cont)
2077 p_priv->resend_cont = reset_port + 1;
2078 if (this_urb->status == -EINPROGRESS) {
2079 /* dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2080 mdelay(5);
2081 return -1;
2082 }
2083
2084 memset(&msg, 0, sizeof(struct keyspan_usa26_portControlMessage));
2085
2086 /* Only set baud rate if it's changed */
2087 if (p_priv->old_baud != p_priv->baud) {
2088 p_priv->old_baud = p_priv->baud;
2089 msg.setClocking = 0xff;
2090 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2091 &msg.baudHi, &msg.baudLo, &msg.prescaler,
2092 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2093 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2094 __func__, p_priv->baud);
2095 msg.baudLo = 0;
2096 msg.baudHi = 125; /* Values for 9600 baud */
2097 msg.prescaler = 10;
2098 }
2099 msg.setPrescaler = 0xff;
2100 }
2101
2102 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2103 switch (p_priv->cflag & CSIZE) {
2104 case CS5:
2105 msg.lcr |= USA_DATABITS_5;
2106 break;
2107 case CS6:
2108 msg.lcr |= USA_DATABITS_6;
2109 break;
2110 case CS7:
2111 msg.lcr |= USA_DATABITS_7;
2112 break;
2113 case CS8:
2114 msg.lcr |= USA_DATABITS_8;
2115 break;
2116 }
2117 if (p_priv->cflag & PARENB) {
2118 /* note USA_PARITY_NONE == 0 */
2119 msg.lcr |= (p_priv->cflag & PARODD) ?
2120 USA_PARITY_ODD : USA_PARITY_EVEN;
2121 }
2122 msg.setLcr = 0xff;
2123
2124 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2125 msg.xonFlowControl = 0;
2126 msg.setFlowControl = 0xff;
2127 msg.forwardingLength = 16;
2128 msg.xonChar = 17;
2129 msg.xoffChar = 19;
2130
2131 /* Opening port */
2132 if (reset_port == 1) {
2133 msg._txOn = 1;
2134 msg._txOff = 0;
2135 msg.txFlush = 0;
2136 msg.txBreak = 0;
2137 msg.rxOn = 1;
2138 msg.rxOff = 0;
2139 msg.rxFlush = 1;
2140 msg.rxForward = 0;
2141 msg.returnStatus = 0;
2142 msg.resetDataToggle = 0xff;
2143 }
2144
2145 /* Closing port */
2146 else if (reset_port == 2) {
2147 msg._txOn = 0;
2148 msg._txOff = 1;
2149 msg.txFlush = 0;
2150 msg.txBreak = 0;
2151 msg.rxOn = 0;
2152 msg.rxOff = 1;
2153 msg.rxFlush = 1;
2154 msg.rxForward = 0;
2155 msg.returnStatus = 0;
2156 msg.resetDataToggle = 0;
2157 }
2158
2159 /* Sending intermediate configs */
2160 else {
2161 msg._txOn = (!p_priv->break_on);
2162 msg._txOff = 0;
2163 msg.txFlush = 0;
2164 msg.txBreak = (p_priv->break_on);
2165 msg.rxOn = 0;
2166 msg.rxOff = 0;
2167 msg.rxFlush = 0;
2168 msg.rxForward = 0;
2169 msg.returnStatus = 0;
2170 msg.resetDataToggle = 0x0;
2171 }
2172
2173 /* Do handshaking outputs */
2174 msg.setTxTriState_setRts = 0xff;
2175 msg.txTriState_rts = p_priv->rts_state;
2176
2177 msg.setHskoa_setDtr = 0xff;
2178 msg.hskoa_dtr = p_priv->dtr_state;
2179
2180 p_priv->resend_cont = 0;
2181 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2182
2183 /* send the data out the device on control endpoint */
2184 this_urb->transfer_buffer_length = sizeof(msg);
2185
2186 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2187 if (err != 0)
2188 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2189 return 0;
2190}
2191
2192static int keyspan_usa28_send_setup(struct usb_serial *serial,
2193 struct usb_serial_port *port,
2194 int reset_port)
2195{
2196 struct keyspan_usa28_portControlMessage msg;
2197 struct keyspan_serial_private *s_priv;
2198 struct keyspan_port_private *p_priv;
2199 const struct keyspan_device_details *d_details;
2200 struct urb *this_urb;
2201 int device_port, err;
2202
2203 s_priv = usb_get_serial_data(serial);
2204 p_priv = usb_get_serial_port_data(port);
2205 d_details = s_priv->device_details;
2206 device_port = port->port_number;
2207
2208 /* only do something if we have a bulk out endpoint */
2209 this_urb = p_priv->outcont_urb;
2210 if (this_urb == NULL) {
2211 dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2212 return -1;
2213 }
2214
2215 /* Save reset port val for resend.
2216 Don't overwrite resend for open/close condition. */
2217 if ((reset_port + 1) > p_priv->resend_cont)
2218 p_priv->resend_cont = reset_port + 1;
2219 if (this_urb->status == -EINPROGRESS) {
2220 dev_dbg(&port->dev, "%s already writing\n", __func__);
2221 mdelay(5);
2222 return -1;
2223 }
2224
2225 memset(&msg, 0, sizeof(struct keyspan_usa28_portControlMessage));
2226
2227 msg.setBaudRate = 1;
2228 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2229 &msg.baudHi, &msg.baudLo, NULL,
2230 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2231 dev_dbg(&port->dev, "%s - Invalid baud rate requested %d.\n",
2232 __func__, p_priv->baud);
2233 msg.baudLo = 0xff;
2234 msg.baudHi = 0xb2; /* Values for 9600 baud */
2235 }
2236
2237 /* If parity is enabled, we must calculate it ourselves. */
2238 msg.parity = 0; /* XXX for now */
2239
2240 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2241 msg.xonFlowControl = 0;
2242
2243 /* Do handshaking outputs, DTR is inverted relative to RTS */
2244 msg.rts = p_priv->rts_state;
2245 msg.dtr = p_priv->dtr_state;
2246
2247 msg.forwardingLength = 16;
2248 msg.forwardMs = 10;
2249 msg.breakThreshold = 45;
2250 msg.xonChar = 17;
2251 msg.xoffChar = 19;
2252
2253 /*msg.returnStatus = 1;
2254 msg.resetDataToggle = 0xff;*/
2255 /* Opening port */
2256 if (reset_port == 1) {
2257 msg._txOn = 1;
2258 msg._txOff = 0;
2259 msg.txFlush = 0;
2260 msg.txForceXoff = 0;
2261 msg.txBreak = 0;
2262 msg.rxOn = 1;
2263 msg.rxOff = 0;
2264 msg.rxFlush = 1;
2265 msg.rxForward = 0;
2266 msg.returnStatus = 0;
2267 msg.resetDataToggle = 0xff;
2268 }
2269 /* Closing port */
2270 else if (reset_port == 2) {
2271 msg._txOn = 0;
2272 msg._txOff = 1;
2273 msg.txFlush = 0;
2274 msg.txForceXoff = 0;
2275 msg.txBreak = 0;
2276 msg.rxOn = 0;
2277 msg.rxOff = 1;
2278 msg.rxFlush = 1;
2279 msg.rxForward = 0;
2280 msg.returnStatus = 0;
2281 msg.resetDataToggle = 0;
2282 }
2283 /* Sending intermediate configs */
2284 else {
2285 msg._txOn = (!p_priv->break_on);
2286 msg._txOff = 0;
2287 msg.txFlush = 0;
2288 msg.txForceXoff = 0;
2289 msg.txBreak = (p_priv->break_on);
2290 msg.rxOn = 0;
2291 msg.rxOff = 0;
2292 msg.rxFlush = 0;
2293 msg.rxForward = 0;
2294 msg.returnStatus = 0;
2295 msg.resetDataToggle = 0x0;
2296 }
2297
2298 p_priv->resend_cont = 0;
2299 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2300
2301 /* send the data out the device on control endpoint */
2302 this_urb->transfer_buffer_length = sizeof(msg);
2303
2304 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2305 if (err != 0)
2306 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed\n", __func__);
2307
2308 return 0;
2309}
2310
2311static int keyspan_usa49_send_setup(struct usb_serial *serial,
2312 struct usb_serial_port *port,
2313 int reset_port)
2314{
2315 struct keyspan_usa49_portControlMessage msg;
2316 struct usb_ctrlrequest *dr = NULL;
2317 struct keyspan_serial_private *s_priv;
2318 struct keyspan_port_private *p_priv;
2319 const struct keyspan_device_details *d_details;
2320 struct urb *this_urb;
2321 int err, device_port;
2322
2323 s_priv = usb_get_serial_data(serial);
2324 p_priv = usb_get_serial_port_data(port);
2325 d_details = s_priv->device_details;
2326
2327 this_urb = s_priv->glocont_urb;
2328
2329 /* Work out which port within the device is being setup */
2330 device_port = port->port_number;
2331
2332 /* Make sure we have an urb then send the message */
2333 if (this_urb == NULL) {
2334 dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2335 return -1;
2336 }
2337
2338 dev_dbg(&port->dev, "%s - endpoint %x (%d)\n",
2339 __func__, usb_pipeendpoint(this_urb->pipe), device_port);
2340
2341 /* Save reset port val for resend.
2342 Don't overwrite resend for open/close condition. */
2343 if ((reset_port + 1) > p_priv->resend_cont)
2344 p_priv->resend_cont = reset_port + 1;
2345
2346 if (this_urb->status == -EINPROGRESS) {
2347 /* dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2348 mdelay(5);
2349 return -1;
2350 }
2351
2352 memset(&msg, 0, sizeof(struct keyspan_usa49_portControlMessage));
2353
2354 msg.portNumber = device_port;
2355
2356 /* Only set baud rate if it's changed */
2357 if (p_priv->old_baud != p_priv->baud) {
2358 p_priv->old_baud = p_priv->baud;
2359 msg.setClocking = 0xff;
2360 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2361 &msg.baudHi, &msg.baudLo, &msg.prescaler,
2362 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2363 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2364 __func__, p_priv->baud);
2365 msg.baudLo = 0;
2366 msg.baudHi = 125; /* Values for 9600 baud */
2367 msg.prescaler = 10;
2368 }
2369 /* msg.setPrescaler = 0xff; */
2370 }
2371
2372 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2373 switch (p_priv->cflag & CSIZE) {
2374 case CS5:
2375 msg.lcr |= USA_DATABITS_5;
2376 break;
2377 case CS6:
2378 msg.lcr |= USA_DATABITS_6;
2379 break;
2380 case CS7:
2381 msg.lcr |= USA_DATABITS_7;
2382 break;
2383 case CS8:
2384 msg.lcr |= USA_DATABITS_8;
2385 break;
2386 }
2387 if (p_priv->cflag & PARENB) {
2388 /* note USA_PARITY_NONE == 0 */
2389 msg.lcr |= (p_priv->cflag & PARODD) ?
2390 USA_PARITY_ODD : USA_PARITY_EVEN;
2391 }
2392 msg.setLcr = 0xff;
2393
2394 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2395 msg.xonFlowControl = 0;
2396 msg.setFlowControl = 0xff;
2397
2398 msg.forwardingLength = 16;
2399 msg.xonChar = 17;
2400 msg.xoffChar = 19;
2401
2402 /* Opening port */
2403 if (reset_port == 1) {
2404 msg._txOn = 1;
2405 msg._txOff = 0;
2406 msg.txFlush = 0;
2407 msg.txBreak = 0;
2408 msg.rxOn = 1;
2409 msg.rxOff = 0;
2410 msg.rxFlush = 1;
2411 msg.rxForward = 0;
2412 msg.returnStatus = 0;
2413 msg.resetDataToggle = 0xff;
2414 msg.enablePort = 1;
2415 msg.disablePort = 0;
2416 }
2417 /* Closing port */
2418 else if (reset_port == 2) {
2419 msg._txOn = 0;
2420 msg._txOff = 1;
2421 msg.txFlush = 0;
2422 msg.txBreak = 0;
2423 msg.rxOn = 0;
2424 msg.rxOff = 1;
2425 msg.rxFlush = 1;
2426 msg.rxForward = 0;
2427 msg.returnStatus = 0;
2428 msg.resetDataToggle = 0;
2429 msg.enablePort = 0;
2430 msg.disablePort = 1;
2431 }
2432 /* Sending intermediate configs */
2433 else {
2434 msg._txOn = (!p_priv->break_on);
2435 msg._txOff = 0;
2436 msg.txFlush = 0;
2437 msg.txBreak = (p_priv->break_on);
2438 msg.rxOn = 0;
2439 msg.rxOff = 0;
2440 msg.rxFlush = 0;
2441 msg.rxForward = 0;
2442 msg.returnStatus = 0;
2443 msg.resetDataToggle = 0x0;
2444 msg.enablePort = 0;
2445 msg.disablePort = 0;
2446 }
2447
2448 /* Do handshaking outputs */
2449 msg.setRts = 0xff;
2450 msg.rts = p_priv->rts_state;
2451
2452 msg.setDtr = 0xff;
2453 msg.dtr = p_priv->dtr_state;
2454
2455 p_priv->resend_cont = 0;
2456
2457 /* if the device is a 49wg, we send control message on usb
2458 control EP 0 */
2459
2460 if (d_details->product_id == keyspan_usa49wg_product_id) {
2461 dr = (void *)(s_priv->ctrl_buf);
2462 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_OUT;
2463 dr->bRequest = 0xB0; /* 49wg control message */
2464 dr->wValue = 0;
2465 dr->wIndex = 0;
2466 dr->wLength = cpu_to_le16(sizeof(msg));
2467
2468 memcpy(s_priv->glocont_buf, &msg, sizeof(msg));
2469
2470 usb_fill_control_urb(this_urb, serial->dev,
2471 usb_sndctrlpipe(serial->dev, 0),
2472 (unsigned char *)dr, s_priv->glocont_buf,
2473 sizeof(msg), usa49_glocont_callback, serial);
2474
2475 } else {
2476 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2477
2478 /* send the data out the device on control endpoint */
2479 this_urb->transfer_buffer_length = sizeof(msg);
2480 }
2481 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2482 if (err != 0)
2483 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2484
2485 return 0;
2486}
2487
2488static int keyspan_usa90_send_setup(struct usb_serial *serial,
2489 struct usb_serial_port *port,
2490 int reset_port)
2491{
2492 struct keyspan_usa90_portControlMessage msg;
2493 struct keyspan_serial_private *s_priv;
2494 struct keyspan_port_private *p_priv;
2495 const struct keyspan_device_details *d_details;
2496 struct urb *this_urb;
2497 int err;
2498 u8 prescaler;
2499
2500 s_priv = usb_get_serial_data(serial);
2501 p_priv = usb_get_serial_port_data(port);
2502 d_details = s_priv->device_details;
2503
2504 /* only do something if we have a bulk out endpoint */
2505 this_urb = p_priv->outcont_urb;
2506 if (this_urb == NULL) {
2507 dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2508 return -1;
2509 }
2510
2511 /* Save reset port val for resend.
2512 Don't overwrite resend for open/close condition. */
2513 if ((reset_port + 1) > p_priv->resend_cont)
2514 p_priv->resend_cont = reset_port + 1;
2515 if (this_urb->status == -EINPROGRESS) {
2516 dev_dbg(&port->dev, "%s already writing\n", __func__);
2517 mdelay(5);
2518 return -1;
2519 }
2520
2521 memset(&msg, 0, sizeof(struct keyspan_usa90_portControlMessage));
2522
2523 /* Only set baud rate if it's changed */
2524 if (p_priv->old_baud != p_priv->baud) {
2525 p_priv->old_baud = p_priv->baud;
2526 msg.setClocking = 0x01;
2527 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2528 &msg.baudHi, &msg.baudLo, &prescaler, 0) == KEYSPAN_INVALID_BAUD_RATE) {
2529 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2530 __func__, p_priv->baud);
2531 p_priv->baud = 9600;
2532 d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2533 &msg.baudHi, &msg.baudLo, &prescaler, 0);
2534 }
2535 msg.setRxMode = 1;
2536 msg.setTxMode = 1;
2537 }
2538
2539 /* modes must always be correctly specified */
2540 if (p_priv->baud > 57600) {
2541 msg.rxMode = RXMODE_DMA;
2542 msg.txMode = TXMODE_DMA;
2543 } else {
2544 msg.rxMode = RXMODE_BYHAND;
2545 msg.txMode = TXMODE_BYHAND;
2546 }
2547
2548 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2549 switch (p_priv->cflag & CSIZE) {
2550 case CS5:
2551 msg.lcr |= USA_DATABITS_5;
2552 break;
2553 case CS6:
2554 msg.lcr |= USA_DATABITS_6;
2555 break;
2556 case CS7:
2557 msg.lcr |= USA_DATABITS_7;
2558 break;
2559 case CS8:
2560 msg.lcr |= USA_DATABITS_8;
2561 break;
2562 }
2563 if (p_priv->cflag & PARENB) {
2564 /* note USA_PARITY_NONE == 0 */
2565 msg.lcr |= (p_priv->cflag & PARODD) ?
2566 USA_PARITY_ODD : USA_PARITY_EVEN;
2567 }
2568 if (p_priv->old_cflag != p_priv->cflag) {
2569 p_priv->old_cflag = p_priv->cflag;
2570 msg.setLcr = 0x01;
2571 }
2572
2573 if (p_priv->flow_control == flow_cts)
2574 msg.txFlowControl = TXFLOW_CTS;
2575 msg.setTxFlowControl = 0x01;
2576 msg.setRxFlowControl = 0x01;
2577
2578 msg.rxForwardingLength = 16;
2579 msg.rxForwardingTimeout = 16;
2580 msg.txAckSetting = 0;
2581 msg.xonChar = 17;
2582 msg.xoffChar = 19;
2583
2584 /* Opening port */
2585 if (reset_port == 1) {
2586 msg.portEnabled = 1;
2587 msg.rxFlush = 1;
2588 msg.txBreak = (p_priv->break_on);
2589 }
2590 /* Closing port */
2591 else if (reset_port == 2)
2592 msg.portEnabled = 0;
2593 /* Sending intermediate configs */
2594 else {
2595 msg.portEnabled = 1;
2596 msg.txBreak = (p_priv->break_on);
2597 }
2598
2599 /* Do handshaking outputs */
2600 msg.setRts = 0x01;
2601 msg.rts = p_priv->rts_state;
2602
2603 msg.setDtr = 0x01;
2604 msg.dtr = p_priv->dtr_state;
2605
2606 p_priv->resend_cont = 0;
2607 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2608
2609 /* send the data out the device on control endpoint */
2610 this_urb->transfer_buffer_length = sizeof(msg);
2611
2612 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2613 if (err != 0)
2614 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2615 return 0;
2616}
2617
2618static int keyspan_usa67_send_setup(struct usb_serial *serial,
2619 struct usb_serial_port *port,
2620 int reset_port)
2621{
2622 struct keyspan_usa67_portControlMessage msg;
2623 struct keyspan_serial_private *s_priv;
2624 struct keyspan_port_private *p_priv;
2625 const struct keyspan_device_details *d_details;
2626 struct urb *this_urb;
2627 int err, device_port;
2628
2629 s_priv = usb_get_serial_data(serial);
2630 p_priv = usb_get_serial_port_data(port);
2631 d_details = s_priv->device_details;
2632
2633 this_urb = s_priv->glocont_urb;
2634
2635 /* Work out which port within the device is being setup */
2636 device_port = port->port_number;
2637
2638 /* Make sure we have an urb then send the message */
2639 if (this_urb == NULL) {
2640 dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2641 return -1;
2642 }
2643
2644 /* Save reset port val for resend.
2645 Don't overwrite resend for open/close condition. */
2646 if ((reset_port + 1) > p_priv->resend_cont)
2647 p_priv->resend_cont = reset_port + 1;
2648 if (this_urb->status == -EINPROGRESS) {
2649 /* dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2650 mdelay(5);
2651 return -1;
2652 }
2653
2654 memset(&msg, 0, sizeof(struct keyspan_usa67_portControlMessage));
2655
2656 msg.port = device_port;
2657
2658 /* Only set baud rate if it's changed */
2659 if (p_priv->old_baud != p_priv->baud) {
2660 p_priv->old_baud = p_priv->baud;
2661 msg.setClocking = 0xff;
2662 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2663 &msg.baudHi, &msg.baudLo, &msg.prescaler,
2664 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2665 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2666 __func__, p_priv->baud);
2667 msg.baudLo = 0;
2668 msg.baudHi = 125; /* Values for 9600 baud */
2669 msg.prescaler = 10;
2670 }
2671 msg.setPrescaler = 0xff;
2672 }
2673
2674 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2675 switch (p_priv->cflag & CSIZE) {
2676 case CS5:
2677 msg.lcr |= USA_DATABITS_5;
2678 break;
2679 case CS6:
2680 msg.lcr |= USA_DATABITS_6;
2681 break;
2682 case CS7:
2683 msg.lcr |= USA_DATABITS_7;
2684 break;
2685 case CS8:
2686 msg.lcr |= USA_DATABITS_8;
2687 break;
2688 }
2689 if (p_priv->cflag & PARENB) {
2690 /* note USA_PARITY_NONE == 0 */
2691 msg.lcr |= (p_priv->cflag & PARODD) ?
2692 USA_PARITY_ODD : USA_PARITY_EVEN;
2693 }
2694 msg.setLcr = 0xff;
2695
2696 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2697 msg.xonFlowControl = 0;
2698 msg.setFlowControl = 0xff;
2699 msg.forwardingLength = 16;
2700 msg.xonChar = 17;
2701 msg.xoffChar = 19;
2702
2703 if (reset_port == 1) {
2704 /* Opening port */
2705 msg._txOn = 1;
2706 msg._txOff = 0;
2707 msg.txFlush = 0;
2708 msg.txBreak = 0;
2709 msg.rxOn = 1;
2710 msg.rxOff = 0;
2711 msg.rxFlush = 1;
2712 msg.rxForward = 0;
2713 msg.returnStatus = 0;
2714 msg.resetDataToggle = 0xff;
2715 } else if (reset_port == 2) {
2716 /* Closing port */
2717 msg._txOn = 0;
2718 msg._txOff = 1;
2719 msg.txFlush = 0;
2720 msg.txBreak = 0;
2721 msg.rxOn = 0;
2722 msg.rxOff = 1;
2723 msg.rxFlush = 1;
2724 msg.rxForward = 0;
2725 msg.returnStatus = 0;
2726 msg.resetDataToggle = 0;
2727 } else {
2728 /* Sending intermediate configs */
2729 msg._txOn = (!p_priv->break_on);
2730 msg._txOff = 0;
2731 msg.txFlush = 0;
2732 msg.txBreak = (p_priv->break_on);
2733 msg.rxOn = 0;
2734 msg.rxOff = 0;
2735 msg.rxFlush = 0;
2736 msg.rxForward = 0;
2737 msg.returnStatus = 0;
2738 msg.resetDataToggle = 0x0;
2739 }
2740
2741 /* Do handshaking outputs */
2742 msg.setTxTriState_setRts = 0xff;
2743 msg.txTriState_rts = p_priv->rts_state;
2744
2745 msg.setHskoa_setDtr = 0xff;
2746 msg.hskoa_dtr = p_priv->dtr_state;
2747
2748 p_priv->resend_cont = 0;
2749
2750 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2751
2752 /* send the data out the device on control endpoint */
2753 this_urb->transfer_buffer_length = sizeof(msg);
2754
2755 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2756 if (err != 0)
2757 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2758 return 0;
2759}
2760
2761static void keyspan_send_setup(struct usb_serial_port *port, int reset_port)
2762{
2763 struct usb_serial *serial = port->serial;
2764 struct keyspan_serial_private *s_priv;
2765 const struct keyspan_device_details *d_details;
2766
2767 s_priv = usb_get_serial_data(serial);
2768 d_details = s_priv->device_details;
2769
2770 switch (d_details->msg_format) {
2771 case msg_usa26:
2772 keyspan_usa26_send_setup(serial, port, reset_port);
2773 break;
2774 case msg_usa28:
2775 keyspan_usa28_send_setup(serial, port, reset_port);
2776 break;
2777 case msg_usa49:
2778 keyspan_usa49_send_setup(serial, port, reset_port);
2779 break;
2780 case msg_usa90:
2781 keyspan_usa90_send_setup(serial, port, reset_port);
2782 break;
2783 case msg_usa67:
2784 keyspan_usa67_send_setup(serial, port, reset_port);
2785 break;
2786 }
2787}
2788
2789
2790/* Gets called by the "real" driver (ie once firmware is loaded
2791 and renumeration has taken place. */
2792static int keyspan_startup(struct usb_serial *serial)
2793{
2794 int i, err;
2795 struct keyspan_serial_private *s_priv;
2796 const struct keyspan_device_details *d_details;
2797
2798 for (i = 0; (d_details = keyspan_devices[i]) != NULL; ++i)
2799 if (d_details->product_id ==
2800 le16_to_cpu(serial->dev->descriptor.idProduct))
2801 break;
2802 if (d_details == NULL) {
2803 dev_err(&serial->dev->dev, "%s - unknown product id %x\n",
2804 __func__, le16_to_cpu(serial->dev->descriptor.idProduct));
2805 return -ENODEV;
2806 }
2807
2808 /* Setup private data for serial driver */
2809 s_priv = kzalloc(sizeof(struct keyspan_serial_private), GFP_KERNEL);
2810 if (!s_priv)
2811 return -ENOMEM;
2812
2813 s_priv->instat_buf = kzalloc(INSTAT_BUFLEN, GFP_KERNEL);
2814 if (!s_priv->instat_buf)
2815 goto err_instat_buf;
2816
2817 s_priv->indat_buf = kzalloc(INDAT49W_BUFLEN, GFP_KERNEL);
2818 if (!s_priv->indat_buf)
2819 goto err_indat_buf;
2820
2821 s_priv->glocont_buf = kzalloc(GLOCONT_BUFLEN, GFP_KERNEL);
2822 if (!s_priv->glocont_buf)
2823 goto err_glocont_buf;
2824
2825 s_priv->ctrl_buf = kzalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
2826 if (!s_priv->ctrl_buf)
2827 goto err_ctrl_buf;
2828
2829 s_priv->device_details = d_details;
2830 usb_set_serial_data(serial, s_priv);
2831
2832 keyspan_setup_urbs(serial);
2833
2834 if (s_priv->instat_urb != NULL) {
2835 err = usb_submit_urb(s_priv->instat_urb, GFP_KERNEL);
2836 if (err != 0)
2837 dev_dbg(&serial->dev->dev, "%s - submit instat urb failed %d\n", __func__, err);
2838 }
2839 if (s_priv->indat_urb != NULL) {
2840 err = usb_submit_urb(s_priv->indat_urb, GFP_KERNEL);
2841 if (err != 0)
2842 dev_dbg(&serial->dev->dev, "%s - submit indat urb failed %d\n", __func__, err);
2843 }
2844
2845 return 0;
2846
2847err_ctrl_buf:
2848 kfree(s_priv->glocont_buf);
2849err_glocont_buf:
2850 kfree(s_priv->indat_buf);
2851err_indat_buf:
2852 kfree(s_priv->instat_buf);
2853err_instat_buf:
2854 kfree(s_priv);
2855
2856 return -ENOMEM;
2857}
2858
2859static void keyspan_disconnect(struct usb_serial *serial)
2860{
2861 struct keyspan_serial_private *s_priv;
2862
2863 s_priv = usb_get_serial_data(serial);
2864
2865 usb_kill_urb(s_priv->instat_urb);
2866 usb_kill_urb(s_priv->glocont_urb);
2867 usb_kill_urb(s_priv->indat_urb);
2868}
2869
2870static void keyspan_release(struct usb_serial *serial)
2871{
2872 struct keyspan_serial_private *s_priv;
2873
2874 s_priv = usb_get_serial_data(serial);
2875
2876 /* Make sure to unlink the URBs submitted in attach. */
2877 usb_kill_urb(s_priv->instat_urb);
2878 usb_kill_urb(s_priv->indat_urb);
2879
2880 usb_free_urb(s_priv->instat_urb);
2881 usb_free_urb(s_priv->indat_urb);
2882 usb_free_urb(s_priv->glocont_urb);
2883
2884 kfree(s_priv->ctrl_buf);
2885 kfree(s_priv->glocont_buf);
2886 kfree(s_priv->indat_buf);
2887 kfree(s_priv->instat_buf);
2888
2889 kfree(s_priv);
2890}
2891
2892static int keyspan_port_probe(struct usb_serial_port *port)
2893{
2894 struct usb_serial *serial = port->serial;
2895 struct keyspan_serial_private *s_priv;
2896 struct keyspan_port_private *p_priv;
2897 const struct keyspan_device_details *d_details;
2898 struct callbacks *cback;
2899 int endp;
2900 int port_num;
2901 int i;
2902
2903 s_priv = usb_get_serial_data(serial);
2904 d_details = s_priv->device_details;
2905
2906 p_priv = kzalloc(sizeof(*p_priv), GFP_KERNEL);
2907 if (!p_priv)
2908 return -ENOMEM;
2909
2910 for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i) {
2911 p_priv->in_buffer[i] = kzalloc(IN_BUFLEN, GFP_KERNEL);
2912 if (!p_priv->in_buffer[i])
2913 goto err_in_buffer;
2914 }
2915
2916 for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i) {
2917 p_priv->out_buffer[i] = kzalloc(OUT_BUFLEN, GFP_KERNEL);
2918 if (!p_priv->out_buffer[i])
2919 goto err_out_buffer;
2920 }
2921
2922 p_priv->inack_buffer = kzalloc(INACK_BUFLEN, GFP_KERNEL);
2923 if (!p_priv->inack_buffer)
2924 goto err_inack_buffer;
2925
2926 p_priv->outcont_buffer = kzalloc(OUTCONT_BUFLEN, GFP_KERNEL);
2927 if (!p_priv->outcont_buffer)
2928 goto err_outcont_buffer;
2929
2930 p_priv->device_details = d_details;
2931
2932 /* Setup values for the various callback routines */
2933 cback = &keyspan_callbacks[d_details->msg_format];
2934
2935 port_num = port->port_number;
2936
2937 /* Do indat endpoints first, once for each flip */
2938 endp = d_details->indat_endpoints[port_num];
2939 for (i = 0; i <= d_details->indat_endp_flip; ++i, ++endp) {
2940 p_priv->in_urbs[i] = keyspan_setup_urb(serial, endp,
2941 USB_DIR_IN, port,
2942 p_priv->in_buffer[i],
2943 IN_BUFLEN,
2944 cback->indat_callback);
2945 }
2946 /* outdat endpoints also have flip */
2947 endp = d_details->outdat_endpoints[port_num];
2948 for (i = 0; i <= d_details->outdat_endp_flip; ++i, ++endp) {
2949 p_priv->out_urbs[i] = keyspan_setup_urb(serial, endp,
2950 USB_DIR_OUT, port,
2951 p_priv->out_buffer[i],
2952 OUT_BUFLEN,
2953 cback->outdat_callback);
2954 }
2955 /* inack endpoint */
2956 p_priv->inack_urb = keyspan_setup_urb(serial,
2957 d_details->inack_endpoints[port_num],
2958 USB_DIR_IN, port,
2959 p_priv->inack_buffer,
2960 INACK_BUFLEN,
2961 cback->inack_callback);
2962 /* outcont endpoint */
2963 p_priv->outcont_urb = keyspan_setup_urb(serial,
2964 d_details->outcont_endpoints[port_num],
2965 USB_DIR_OUT, port,
2966 p_priv->outcont_buffer,
2967 OUTCONT_BUFLEN,
2968 cback->outcont_callback);
2969
2970 usb_set_serial_port_data(port, p_priv);
2971
2972 return 0;
2973
2974err_outcont_buffer:
2975 kfree(p_priv->inack_buffer);
2976err_inack_buffer:
2977 for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
2978 kfree(p_priv->out_buffer[i]);
2979err_out_buffer:
2980 for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
2981 kfree(p_priv->in_buffer[i]);
2982err_in_buffer:
2983 kfree(p_priv);
2984
2985 return -ENOMEM;
2986}
2987
2988static int keyspan_port_remove(struct usb_serial_port *port)
2989{
2990 struct keyspan_port_private *p_priv;
2991 int i;
2992
2993 p_priv = usb_get_serial_port_data(port);
2994
2995 usb_kill_urb(p_priv->inack_urb);
2996 usb_kill_urb(p_priv->outcont_urb);
2997 for (i = 0; i < 2; i++) {
2998 usb_kill_urb(p_priv->in_urbs[i]);
2999 usb_kill_urb(p_priv->out_urbs[i]);
3000 }
3001
3002 usb_free_urb(p_priv->inack_urb);
3003 usb_free_urb(p_priv->outcont_urb);
3004 for (i = 0; i < 2; i++) {
3005 usb_free_urb(p_priv->in_urbs[i]);
3006 usb_free_urb(p_priv->out_urbs[i]);
3007 }
3008
3009 kfree(p_priv->outcont_buffer);
3010 kfree(p_priv->inack_buffer);
3011 for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
3012 kfree(p_priv->out_buffer[i]);
3013 for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
3014 kfree(p_priv->in_buffer[i]);
3015
3016 kfree(p_priv);
3017
3018 return 0;
3019}
3020
3021/* Structs for the devices, pre and post renumeration. */
3022static struct usb_serial_driver keyspan_pre_device = {
3023 .driver = {
3024 .owner = THIS_MODULE,
3025 .name = "keyspan_no_firm",
3026 },
3027 .description = "Keyspan - (without firmware)",
3028 .id_table = keyspan_pre_ids,
3029 .num_ports = 1,
3030 .attach = keyspan_fake_startup,
3031};
3032
3033static struct usb_serial_driver keyspan_1port_device = {
3034 .driver = {
3035 .owner = THIS_MODULE,
3036 .name = "keyspan_1",
3037 },
3038 .description = "Keyspan 1 port adapter",
3039 .id_table = keyspan_1port_ids,
3040 .num_ports = 1,
3041 .open = keyspan_open,
3042 .close = keyspan_close,
3043 .dtr_rts = keyspan_dtr_rts,
3044 .write = keyspan_write,
3045 .write_room = keyspan_write_room,
3046 .set_termios = keyspan_set_termios,
3047 .break_ctl = keyspan_break_ctl,
3048 .tiocmget = keyspan_tiocmget,
3049 .tiocmset = keyspan_tiocmset,
3050 .attach = keyspan_startup,
3051 .disconnect = keyspan_disconnect,
3052 .release = keyspan_release,
3053 .port_probe = keyspan_port_probe,
3054 .port_remove = keyspan_port_remove,
3055};
3056
3057static struct usb_serial_driver keyspan_2port_device = {
3058 .driver = {
3059 .owner = THIS_MODULE,
3060 .name = "keyspan_2",
3061 },
3062 .description = "Keyspan 2 port adapter",
3063 .id_table = keyspan_2port_ids,
3064 .num_ports = 2,
3065 .open = keyspan_open,
3066 .close = keyspan_close,
3067 .dtr_rts = keyspan_dtr_rts,
3068 .write = keyspan_write,
3069 .write_room = keyspan_write_room,
3070 .set_termios = keyspan_set_termios,
3071 .break_ctl = keyspan_break_ctl,
3072 .tiocmget = keyspan_tiocmget,
3073 .tiocmset = keyspan_tiocmset,
3074 .attach = keyspan_startup,
3075 .disconnect = keyspan_disconnect,
3076 .release = keyspan_release,
3077 .port_probe = keyspan_port_probe,
3078 .port_remove = keyspan_port_remove,
3079};
3080
3081static struct usb_serial_driver keyspan_4port_device = {
3082 .driver = {
3083 .owner = THIS_MODULE,
3084 .name = "keyspan_4",
3085 },
3086 .description = "Keyspan 4 port adapter",
3087 .id_table = keyspan_4port_ids,
3088 .num_ports = 4,
3089 .open = keyspan_open,
3090 .close = keyspan_close,
3091 .dtr_rts = keyspan_dtr_rts,
3092 .write = keyspan_write,
3093 .write_room = keyspan_write_room,
3094 .set_termios = keyspan_set_termios,
3095 .break_ctl = keyspan_break_ctl,
3096 .tiocmget = keyspan_tiocmget,
3097 .tiocmset = keyspan_tiocmset,
3098 .attach = keyspan_startup,
3099 .disconnect = keyspan_disconnect,
3100 .release = keyspan_release,
3101 .port_probe = keyspan_port_probe,
3102 .port_remove = keyspan_port_remove,
3103};
3104
3105static struct usb_serial_driver * const serial_drivers[] = {
3106 &keyspan_pre_device, &keyspan_1port_device,
3107 &keyspan_2port_device, &keyspan_4port_device, NULL
3108};
3109
3110module_usb_serial_driver(serial_drivers, keyspan_ids_combined);
3111
3112MODULE_AUTHOR(DRIVER_AUTHOR);
3113MODULE_DESCRIPTION(DRIVER_DESC);
3114MODULE_LICENSE("GPL");
3115
3116MODULE_FIRMWARE("keyspan/usa28.fw");
3117MODULE_FIRMWARE("keyspan/usa28x.fw");
3118MODULE_FIRMWARE("keyspan/usa28xa.fw");
3119MODULE_FIRMWARE("keyspan/usa28xb.fw");
3120MODULE_FIRMWARE("keyspan/usa19.fw");
3121MODULE_FIRMWARE("keyspan/usa19qi.fw");
3122MODULE_FIRMWARE("keyspan/mpr.fw");
3123MODULE_FIRMWARE("keyspan/usa19qw.fw");
3124MODULE_FIRMWARE("keyspan/usa18x.fw");
3125MODULE_FIRMWARE("keyspan/usa19w.fw");
3126MODULE_FIRMWARE("keyspan/usa49w.fw");
3127MODULE_FIRMWARE("keyspan/usa49wlc.fw");
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 Keyspan USB to Serial Converter driver
4
5 (C) Copyright (C) 2000-2001 Hugh Blemings <hugh@blemings.org>
6 (C) Copyright (C) 2002 Greg Kroah-Hartman <greg@kroah.com>
7
8 See http://blemings.org/hugh/keyspan.html for more information.
9
10 Code in this driver inspired by and in a number of places taken
11 from Brian Warner's original Keyspan-PDA driver.
12
13 This driver has been put together with the support of Innosys, Inc.
14 and Keyspan, Inc the manufacturers of the Keyspan USB-serial products.
15 Thanks Guys :)
16
17 Thanks to Paulus for miscellaneous tidy ups, some largish chunks
18 of much nicer and/or completely new code and (perhaps most uniquely)
19 having the patience to sit down and explain why and where he'd changed
20 stuff.
21
22 Tip 'o the hat to IBM (and previously Linuxcare :) for supporting
23 staff in their work on open source projects.
24*/
25
26
27#include <linux/kernel.h>
28#include <linux/jiffies.h>
29#include <linux/errno.h>
30#include <linux/slab.h>
31#include <linux/tty.h>
32#include <linux/tty_driver.h>
33#include <linux/tty_flip.h>
34#include <linux/module.h>
35#include <linux/spinlock.h>
36#include <linux/uaccess.h>
37#include <linux/usb.h>
38#include <linux/usb/serial.h>
39#include <linux/usb/ezusb.h>
40
41#define DRIVER_AUTHOR "Hugh Blemings <hugh@misc.nu"
42#define DRIVER_DESC "Keyspan USB to Serial Converter Driver"
43
44static void keyspan_send_setup(struct usb_serial_port *port, int reset_port);
45
46static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
47 u32 baud_rate, u32 baudclk,
48 u8 *rate_hi, u8 *rate_low,
49 u8 *prescaler, int portnum);
50static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
51 u32 baud_rate, u32 baudclk,
52 u8 *rate_hi, u8 *rate_low,
53 u8 *prescaler, int portnum);
54static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
55 u32 baud_rate, u32 baudclk,
56 u8 *rate_hi, u8 *rate_low,
57 u8 *prescaler, int portnum);
58static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
59 u32 baud_rate, u32 baudclk,
60 u8 *rate_hi, u8 *rate_low,
61 u8 *prescaler, int portnum);
62
63static int keyspan_usa28_send_setup(struct usb_serial *serial,
64 struct usb_serial_port *port,
65 int reset_port);
66static int keyspan_usa26_send_setup(struct usb_serial *serial,
67 struct usb_serial_port *port,
68 int reset_port);
69static int keyspan_usa49_send_setup(struct usb_serial *serial,
70 struct usb_serial_port *port,
71 int reset_port);
72static int keyspan_usa90_send_setup(struct usb_serial *serial,
73 struct usb_serial_port *port,
74 int reset_port);
75static int keyspan_usa67_send_setup(struct usb_serial *serial,
76 struct usb_serial_port *port,
77 int reset_port);
78
79/* Values used for baud rate calculation - device specific */
80#define KEYSPAN_INVALID_BAUD_RATE (-1)
81#define KEYSPAN_BAUD_RATE_OK (0)
82#define KEYSPAN_USA18X_BAUDCLK (12000000L) /* a guess */
83#define KEYSPAN_USA19_BAUDCLK (12000000L)
84#define KEYSPAN_USA19W_BAUDCLK (24000000L)
85#define KEYSPAN_USA19HS_BAUDCLK (14769231L)
86#define KEYSPAN_USA28_BAUDCLK (1843200L)
87#define KEYSPAN_USA28X_BAUDCLK (12000000L)
88#define KEYSPAN_USA49W_BAUDCLK (48000000L)
89
90/* Some constants used to characterise each device. */
91#define KEYSPAN_MAX_NUM_PORTS (4)
92#define KEYSPAN_MAX_FLIPS (2)
93
94/*
95 * Device info for the Keyspan serial converter, used by the overall
96 * usb-serial probe function.
97 */
98#define KEYSPAN_VENDOR_ID (0x06cd)
99
100/* Product IDs for the products supported, pre-renumeration */
101#define keyspan_usa18x_pre_product_id 0x0105
102#define keyspan_usa19_pre_product_id 0x0103
103#define keyspan_usa19qi_pre_product_id 0x010b
104#define keyspan_mpr_pre_product_id 0x011b
105#define keyspan_usa19qw_pre_product_id 0x0118
106#define keyspan_usa19w_pre_product_id 0x0106
107#define keyspan_usa28_pre_product_id 0x0101
108#define keyspan_usa28x_pre_product_id 0x0102
109#define keyspan_usa28xa_pre_product_id 0x0114
110#define keyspan_usa28xb_pre_product_id 0x0113
111#define keyspan_usa49w_pre_product_id 0x0109
112#define keyspan_usa49wlc_pre_product_id 0x011a
113
114/*
115 * Product IDs post-renumeration. Note that the 28x and 28xb have the same
116 * id's post-renumeration but behave identically so it's not an issue. As
117 * such, the 28xb is not listed in any of the device tables.
118 */
119#define keyspan_usa18x_product_id 0x0112
120#define keyspan_usa19_product_id 0x0107
121#define keyspan_usa19qi_product_id 0x010c
122#define keyspan_usa19hs_product_id 0x0121
123#define keyspan_mpr_product_id 0x011c
124#define keyspan_usa19qw_product_id 0x0119
125#define keyspan_usa19w_product_id 0x0108
126#define keyspan_usa28_product_id 0x010f
127#define keyspan_usa28x_product_id 0x0110
128#define keyspan_usa28xa_product_id 0x0115
129#define keyspan_usa28xb_product_id 0x0110
130#define keyspan_usa28xg_product_id 0x0135
131#define keyspan_usa49w_product_id 0x010a
132#define keyspan_usa49wlc_product_id 0x012a
133#define keyspan_usa49wg_product_id 0x0131
134
135struct keyspan_device_details {
136 /* product ID value */
137 int product_id;
138
139 enum {msg_usa26, msg_usa28, msg_usa49, msg_usa90, msg_usa67} msg_format;
140
141 /* Number of physical ports */
142 int num_ports;
143
144 /* 1 if endpoint flipping used on input, 0 if not */
145 int indat_endp_flip;
146
147 /* 1 if endpoint flipping used on output, 0 if not */
148 int outdat_endp_flip;
149
150 /*
151 * Table mapping input data endpoint IDs to physical port
152 * number and flip if used
153 */
154 int indat_endpoints[KEYSPAN_MAX_NUM_PORTS];
155
156 /* Same for output endpoints */
157 int outdat_endpoints[KEYSPAN_MAX_NUM_PORTS];
158
159 /* Input acknowledge endpoints */
160 int inack_endpoints[KEYSPAN_MAX_NUM_PORTS];
161
162 /* Output control endpoints */
163 int outcont_endpoints[KEYSPAN_MAX_NUM_PORTS];
164
165 /* Endpoint used for input status */
166 int instat_endpoint;
167
168 /* Endpoint used for input data 49WG only */
169 int indat_endpoint;
170
171 /* Endpoint used for global control functions */
172 int glocont_endpoint;
173
174 int (*calculate_baud_rate)(struct usb_serial_port *port,
175 u32 baud_rate, u32 baudclk,
176 u8 *rate_hi, u8 *rate_low, u8 *prescaler,
177 int portnum);
178 u32 baudclk;
179};
180
181/*
182 * Now for each device type we setup the device detail structure with the
183 * appropriate information (provided in Keyspan's documentation)
184 */
185
186static const struct keyspan_device_details usa18x_device_details = {
187 .product_id = keyspan_usa18x_product_id,
188 .msg_format = msg_usa26,
189 .num_ports = 1,
190 .indat_endp_flip = 0,
191 .outdat_endp_flip = 1,
192 .indat_endpoints = {0x81},
193 .outdat_endpoints = {0x01},
194 .inack_endpoints = {0x85},
195 .outcont_endpoints = {0x05},
196 .instat_endpoint = 0x87,
197 .indat_endpoint = -1,
198 .glocont_endpoint = 0x07,
199 .calculate_baud_rate = keyspan_usa19w_calc_baud,
200 .baudclk = KEYSPAN_USA18X_BAUDCLK,
201};
202
203static const struct keyspan_device_details usa19_device_details = {
204 .product_id = keyspan_usa19_product_id,
205 .msg_format = msg_usa28,
206 .num_ports = 1,
207 .indat_endp_flip = 1,
208 .outdat_endp_flip = 1,
209 .indat_endpoints = {0x81},
210 .outdat_endpoints = {0x01},
211 .inack_endpoints = {0x83},
212 .outcont_endpoints = {0x03},
213 .instat_endpoint = 0x84,
214 .indat_endpoint = -1,
215 .glocont_endpoint = -1,
216 .calculate_baud_rate = keyspan_usa19_calc_baud,
217 .baudclk = KEYSPAN_USA19_BAUDCLK,
218};
219
220static const struct keyspan_device_details usa19qi_device_details = {
221 .product_id = keyspan_usa19qi_product_id,
222 .msg_format = msg_usa28,
223 .num_ports = 1,
224 .indat_endp_flip = 1,
225 .outdat_endp_flip = 1,
226 .indat_endpoints = {0x81},
227 .outdat_endpoints = {0x01},
228 .inack_endpoints = {0x83},
229 .outcont_endpoints = {0x03},
230 .instat_endpoint = 0x84,
231 .indat_endpoint = -1,
232 .glocont_endpoint = -1,
233 .calculate_baud_rate = keyspan_usa28_calc_baud,
234 .baudclk = KEYSPAN_USA19_BAUDCLK,
235};
236
237static const struct keyspan_device_details mpr_device_details = {
238 .product_id = keyspan_mpr_product_id,
239 .msg_format = msg_usa28,
240 .num_ports = 1,
241 .indat_endp_flip = 1,
242 .outdat_endp_flip = 1,
243 .indat_endpoints = {0x81},
244 .outdat_endpoints = {0x01},
245 .inack_endpoints = {0x83},
246 .outcont_endpoints = {0x03},
247 .instat_endpoint = 0x84,
248 .indat_endpoint = -1,
249 .glocont_endpoint = -1,
250 .calculate_baud_rate = keyspan_usa28_calc_baud,
251 .baudclk = KEYSPAN_USA19_BAUDCLK,
252};
253
254static const struct keyspan_device_details usa19qw_device_details = {
255 .product_id = keyspan_usa19qw_product_id,
256 .msg_format = msg_usa26,
257 .num_ports = 1,
258 .indat_endp_flip = 0,
259 .outdat_endp_flip = 1,
260 .indat_endpoints = {0x81},
261 .outdat_endpoints = {0x01},
262 .inack_endpoints = {0x85},
263 .outcont_endpoints = {0x05},
264 .instat_endpoint = 0x87,
265 .indat_endpoint = -1,
266 .glocont_endpoint = 0x07,
267 .calculate_baud_rate = keyspan_usa19w_calc_baud,
268 .baudclk = KEYSPAN_USA19W_BAUDCLK,
269};
270
271static const struct keyspan_device_details usa19w_device_details = {
272 .product_id = keyspan_usa19w_product_id,
273 .msg_format = msg_usa26,
274 .num_ports = 1,
275 .indat_endp_flip = 0,
276 .outdat_endp_flip = 1,
277 .indat_endpoints = {0x81},
278 .outdat_endpoints = {0x01},
279 .inack_endpoints = {0x85},
280 .outcont_endpoints = {0x05},
281 .instat_endpoint = 0x87,
282 .indat_endpoint = -1,
283 .glocont_endpoint = 0x07,
284 .calculate_baud_rate = keyspan_usa19w_calc_baud,
285 .baudclk = KEYSPAN_USA19W_BAUDCLK,
286};
287
288static const struct keyspan_device_details usa19hs_device_details = {
289 .product_id = keyspan_usa19hs_product_id,
290 .msg_format = msg_usa90,
291 .num_ports = 1,
292 .indat_endp_flip = 0,
293 .outdat_endp_flip = 0,
294 .indat_endpoints = {0x81},
295 .outdat_endpoints = {0x01},
296 .inack_endpoints = {-1},
297 .outcont_endpoints = {0x02},
298 .instat_endpoint = 0x82,
299 .indat_endpoint = -1,
300 .glocont_endpoint = -1,
301 .calculate_baud_rate = keyspan_usa19hs_calc_baud,
302 .baudclk = KEYSPAN_USA19HS_BAUDCLK,
303};
304
305static const struct keyspan_device_details usa28_device_details = {
306 .product_id = keyspan_usa28_product_id,
307 .msg_format = msg_usa28,
308 .num_ports = 2,
309 .indat_endp_flip = 1,
310 .outdat_endp_flip = 1,
311 .indat_endpoints = {0x81, 0x83},
312 .outdat_endpoints = {0x01, 0x03},
313 .inack_endpoints = {0x85, 0x86},
314 .outcont_endpoints = {0x05, 0x06},
315 .instat_endpoint = 0x87,
316 .indat_endpoint = -1,
317 .glocont_endpoint = 0x07,
318 .calculate_baud_rate = keyspan_usa28_calc_baud,
319 .baudclk = KEYSPAN_USA28_BAUDCLK,
320};
321
322static const struct keyspan_device_details usa28x_device_details = {
323 .product_id = keyspan_usa28x_product_id,
324 .msg_format = msg_usa26,
325 .num_ports = 2,
326 .indat_endp_flip = 0,
327 .outdat_endp_flip = 1,
328 .indat_endpoints = {0x81, 0x83},
329 .outdat_endpoints = {0x01, 0x03},
330 .inack_endpoints = {0x85, 0x86},
331 .outcont_endpoints = {0x05, 0x06},
332 .instat_endpoint = 0x87,
333 .indat_endpoint = -1,
334 .glocont_endpoint = 0x07,
335 .calculate_baud_rate = keyspan_usa19w_calc_baud,
336 .baudclk = KEYSPAN_USA28X_BAUDCLK,
337};
338
339static const struct keyspan_device_details usa28xa_device_details = {
340 .product_id = keyspan_usa28xa_product_id,
341 .msg_format = msg_usa26,
342 .num_ports = 2,
343 .indat_endp_flip = 0,
344 .outdat_endp_flip = 1,
345 .indat_endpoints = {0x81, 0x83},
346 .outdat_endpoints = {0x01, 0x03},
347 .inack_endpoints = {0x85, 0x86},
348 .outcont_endpoints = {0x05, 0x06},
349 .instat_endpoint = 0x87,
350 .indat_endpoint = -1,
351 .glocont_endpoint = 0x07,
352 .calculate_baud_rate = keyspan_usa19w_calc_baud,
353 .baudclk = KEYSPAN_USA28X_BAUDCLK,
354};
355
356static const struct keyspan_device_details usa28xg_device_details = {
357 .product_id = keyspan_usa28xg_product_id,
358 .msg_format = msg_usa67,
359 .num_ports = 2,
360 .indat_endp_flip = 0,
361 .outdat_endp_flip = 0,
362 .indat_endpoints = {0x84, 0x88},
363 .outdat_endpoints = {0x02, 0x06},
364 .inack_endpoints = {-1, -1},
365 .outcont_endpoints = {-1, -1},
366 .instat_endpoint = 0x81,
367 .indat_endpoint = -1,
368 .glocont_endpoint = 0x01,
369 .calculate_baud_rate = keyspan_usa19w_calc_baud,
370 .baudclk = KEYSPAN_USA28X_BAUDCLK,
371};
372/*
373 * We don't need a separate entry for the usa28xb as it appears as a 28x
374 * anyway.
375 */
376
377static const struct keyspan_device_details usa49w_device_details = {
378 .product_id = keyspan_usa49w_product_id,
379 .msg_format = msg_usa49,
380 .num_ports = 4,
381 .indat_endp_flip = 0,
382 .outdat_endp_flip = 0,
383 .indat_endpoints = {0x81, 0x82, 0x83, 0x84},
384 .outdat_endpoints = {0x01, 0x02, 0x03, 0x04},
385 .inack_endpoints = {-1, -1, -1, -1},
386 .outcont_endpoints = {-1, -1, -1, -1},
387 .instat_endpoint = 0x87,
388 .indat_endpoint = -1,
389 .glocont_endpoint = 0x07,
390 .calculate_baud_rate = keyspan_usa19w_calc_baud,
391 .baudclk = KEYSPAN_USA49W_BAUDCLK,
392};
393
394static const struct keyspan_device_details usa49wlc_device_details = {
395 .product_id = keyspan_usa49wlc_product_id,
396 .msg_format = msg_usa49,
397 .num_ports = 4,
398 .indat_endp_flip = 0,
399 .outdat_endp_flip = 0,
400 .indat_endpoints = {0x81, 0x82, 0x83, 0x84},
401 .outdat_endpoints = {0x01, 0x02, 0x03, 0x04},
402 .inack_endpoints = {-1, -1, -1, -1},
403 .outcont_endpoints = {-1, -1, -1, -1},
404 .instat_endpoint = 0x87,
405 .indat_endpoint = -1,
406 .glocont_endpoint = 0x07,
407 .calculate_baud_rate = keyspan_usa19w_calc_baud,
408 .baudclk = KEYSPAN_USA19W_BAUDCLK,
409};
410
411static const struct keyspan_device_details usa49wg_device_details = {
412 .product_id = keyspan_usa49wg_product_id,
413 .msg_format = msg_usa49,
414 .num_ports = 4,
415 .indat_endp_flip = 0,
416 .outdat_endp_flip = 0,
417 .indat_endpoints = {-1, -1, -1, -1}, /* single 'global' data in EP */
418 .outdat_endpoints = {0x01, 0x02, 0x04, 0x06},
419 .inack_endpoints = {-1, -1, -1, -1},
420 .outcont_endpoints = {-1, -1, -1, -1},
421 .instat_endpoint = 0x81,
422 .indat_endpoint = 0x88,
423 .glocont_endpoint = 0x00, /* uses control EP */
424 .calculate_baud_rate = keyspan_usa19w_calc_baud,
425 .baudclk = KEYSPAN_USA19W_BAUDCLK,
426};
427
428static const struct keyspan_device_details *keyspan_devices[] = {
429 &usa18x_device_details,
430 &usa19_device_details,
431 &usa19qi_device_details,
432 &mpr_device_details,
433 &usa19qw_device_details,
434 &usa19w_device_details,
435 &usa19hs_device_details,
436 &usa28_device_details,
437 &usa28x_device_details,
438 &usa28xa_device_details,
439 &usa28xg_device_details,
440 /* 28xb not required as it renumerates as a 28x */
441 &usa49w_device_details,
442 &usa49wlc_device_details,
443 &usa49wg_device_details,
444 NULL,
445};
446
447static const struct usb_device_id keyspan_ids_combined[] = {
448 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_pre_product_id) },
449 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_pre_product_id) },
450 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_pre_product_id) },
451 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_pre_product_id) },
452 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_pre_product_id) },
453 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_pre_product_id) },
454 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_pre_product_id) },
455 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_pre_product_id) },
456 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_pre_product_id) },
457 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xb_pre_product_id) },
458 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_pre_product_id) },
459 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_pre_product_id) },
460 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_product_id) },
461 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_product_id) },
462 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_product_id) },
463 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_product_id) },
464 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_product_id) },
465 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19hs_product_id) },
466 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_product_id) },
467 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_product_id) },
468 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_product_id) },
469 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_product_id) },
470 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xg_product_id) },
471 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_product_id)},
472 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_product_id)},
473 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wg_product_id)},
474 { } /* Terminating entry */
475};
476
477MODULE_DEVICE_TABLE(usb, keyspan_ids_combined);
478
479/* usb_device_id table for the pre-firmware download keyspan devices */
480static const struct usb_device_id keyspan_pre_ids[] = {
481 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_pre_product_id) },
482 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_pre_product_id) },
483 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_pre_product_id) },
484 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_pre_product_id) },
485 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_pre_product_id) },
486 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_pre_product_id) },
487 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_pre_product_id) },
488 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_pre_product_id) },
489 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_pre_product_id) },
490 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xb_pre_product_id) },
491 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_pre_product_id) },
492 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_pre_product_id) },
493 { } /* Terminating entry */
494};
495
496static const struct usb_device_id keyspan_1port_ids[] = {
497 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa18x_product_id) },
498 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19_product_id) },
499 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qi_product_id) },
500 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19qw_product_id) },
501 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19w_product_id) },
502 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa19hs_product_id) },
503 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_mpr_product_id) },
504 { } /* Terminating entry */
505};
506
507static const struct usb_device_id keyspan_2port_ids[] = {
508 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28_product_id) },
509 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28x_product_id) },
510 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xa_product_id) },
511 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa28xg_product_id) },
512 { } /* Terminating entry */
513};
514
515static const struct usb_device_id keyspan_4port_ids[] = {
516 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49w_product_id) },
517 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wlc_product_id)},
518 { USB_DEVICE(KEYSPAN_VENDOR_ID, keyspan_usa49wg_product_id)},
519 { } /* Terminating entry */
520};
521
522#define INSTAT_BUFLEN 32
523#define GLOCONT_BUFLEN 64
524#define INDAT49W_BUFLEN 512
525#define IN_BUFLEN 64
526#define OUT_BUFLEN 64
527#define INACK_BUFLEN 1
528#define OUTCONT_BUFLEN 64
529
530 /* Per device and per port private data */
531struct keyspan_serial_private {
532 const struct keyspan_device_details *device_details;
533
534 struct urb *instat_urb;
535 char *instat_buf;
536
537 /* added to support 49wg, where data from all 4 ports comes in
538 on 1 EP and high-speed supported */
539 struct urb *indat_urb;
540 char *indat_buf;
541
542 /* XXX this one probably will need a lock */
543 struct urb *glocont_urb;
544 char *glocont_buf;
545 char *ctrl_buf; /* for EP0 control message */
546};
547
548struct keyspan_port_private {
549 /* Keep track of which input & output endpoints to use */
550 int in_flip;
551 int out_flip;
552
553 /* Keep duplicate of device details in each port
554 structure as well - simplifies some of the
555 callback functions etc. */
556 const struct keyspan_device_details *device_details;
557
558 /* Input endpoints and buffer for this port */
559 struct urb *in_urbs[2];
560 char *in_buffer[2];
561 /* Output endpoints and buffer for this port */
562 struct urb *out_urbs[2];
563 char *out_buffer[2];
564
565 /* Input ack endpoint */
566 struct urb *inack_urb;
567 char *inack_buffer;
568
569 /* Output control endpoint */
570 struct urb *outcont_urb;
571 char *outcont_buffer;
572
573 /* Settings for the port */
574 int baud;
575 int old_baud;
576 unsigned int cflag;
577 unsigned int old_cflag;
578 enum {flow_none, flow_cts, flow_xon} flow_control;
579 int rts_state; /* Handshaking pins (outputs) */
580 int dtr_state;
581 int cts_state; /* Handshaking pins (inputs) */
582 int dsr_state;
583 int dcd_state;
584 int ri_state;
585 int break_on;
586
587 unsigned long tx_start_time[2];
588 int resend_cont; /* need to resend control packet */
589};
590
591/* Include Keyspan message headers. All current Keyspan Adapters
592 make use of one of five message formats which are referred
593 to as USA-26, USA-28, USA-49, USA-90, USA-67 by Keyspan and
594 within this driver. */
595#include "keyspan_usa26msg.h"
596#include "keyspan_usa28msg.h"
597#include "keyspan_usa49msg.h"
598#include "keyspan_usa90msg.h"
599#include "keyspan_usa67msg.h"
600
601
602static void keyspan_break_ctl(struct tty_struct *tty, int break_state)
603{
604 struct usb_serial_port *port = tty->driver_data;
605 struct keyspan_port_private *p_priv;
606
607 p_priv = usb_get_serial_port_data(port);
608
609 if (break_state == -1)
610 p_priv->break_on = 1;
611 else
612 p_priv->break_on = 0;
613
614 keyspan_send_setup(port, 0);
615}
616
617
618static void keyspan_set_termios(struct tty_struct *tty,
619 struct usb_serial_port *port,
620 const struct ktermios *old_termios)
621{
622 int baud_rate, device_port;
623 struct keyspan_port_private *p_priv;
624 const struct keyspan_device_details *d_details;
625 unsigned int cflag;
626
627 p_priv = usb_get_serial_port_data(port);
628 d_details = p_priv->device_details;
629 cflag = tty->termios.c_cflag;
630 device_port = port->port_number;
631
632 /* Baud rate calculation takes baud rate as an integer
633 so other rates can be generated if desired. */
634 baud_rate = tty_get_baud_rate(tty);
635 /* If no match or invalid, don't change */
636 if (d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
637 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
638 /* FIXME - more to do here to ensure rate changes cleanly */
639 /* FIXME - calculate exact rate from divisor ? */
640 p_priv->baud = baud_rate;
641 } else
642 baud_rate = tty_termios_baud_rate(old_termios);
643
644 tty_encode_baud_rate(tty, baud_rate, baud_rate);
645 /* set CTS/RTS handshake etc. */
646 p_priv->cflag = cflag;
647 p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
648
649 /* Mark/Space not supported */
650 tty->termios.c_cflag &= ~CMSPAR;
651
652 keyspan_send_setup(port, 0);
653}
654
655static int keyspan_tiocmget(struct tty_struct *tty)
656{
657 struct usb_serial_port *port = tty->driver_data;
658 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
659 unsigned int value;
660
661 value = ((p_priv->rts_state) ? TIOCM_RTS : 0) |
662 ((p_priv->dtr_state) ? TIOCM_DTR : 0) |
663 ((p_priv->cts_state) ? TIOCM_CTS : 0) |
664 ((p_priv->dsr_state) ? TIOCM_DSR : 0) |
665 ((p_priv->dcd_state) ? TIOCM_CAR : 0) |
666 ((p_priv->ri_state) ? TIOCM_RNG : 0);
667
668 return value;
669}
670
671static int keyspan_tiocmset(struct tty_struct *tty,
672 unsigned int set, unsigned int clear)
673{
674 struct usb_serial_port *port = tty->driver_data;
675 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
676
677 if (set & TIOCM_RTS)
678 p_priv->rts_state = 1;
679 if (set & TIOCM_DTR)
680 p_priv->dtr_state = 1;
681 if (clear & TIOCM_RTS)
682 p_priv->rts_state = 0;
683 if (clear & TIOCM_DTR)
684 p_priv->dtr_state = 0;
685 keyspan_send_setup(port, 0);
686 return 0;
687}
688
689/* Write function is similar for the four protocols used
690 with only a minor change for usa90 (usa19hs) required */
691static int keyspan_write(struct tty_struct *tty,
692 struct usb_serial_port *port, const unsigned char *buf, int count)
693{
694 struct keyspan_port_private *p_priv;
695 const struct keyspan_device_details *d_details;
696 int flip;
697 int left, todo;
698 struct urb *this_urb;
699 int err, maxDataLen, dataOffset;
700
701 p_priv = usb_get_serial_port_data(port);
702 d_details = p_priv->device_details;
703
704 if (d_details->msg_format == msg_usa90) {
705 maxDataLen = 64;
706 dataOffset = 0;
707 } else {
708 maxDataLen = 63;
709 dataOffset = 1;
710 }
711
712 dev_dbg(&port->dev, "%s - %d chars, flip=%d\n", __func__, count,
713 p_priv->out_flip);
714
715 for (left = count; left > 0; left -= todo) {
716 todo = left;
717 if (todo > maxDataLen)
718 todo = maxDataLen;
719
720 flip = p_priv->out_flip;
721
722 /* Check we have a valid urb/endpoint before we use it... */
723 this_urb = p_priv->out_urbs[flip];
724 if (this_urb == NULL) {
725 /* no bulk out, so return 0 bytes written */
726 dev_dbg(&port->dev, "%s - no output urb :(\n", __func__);
727 return count;
728 }
729
730 dev_dbg(&port->dev, "%s - endpoint %x flip %d\n",
731 __func__, usb_pipeendpoint(this_urb->pipe), flip);
732
733 if (this_urb->status == -EINPROGRESS) {
734 if (time_before(jiffies,
735 p_priv->tx_start_time[flip] + 10 * HZ))
736 break;
737 usb_unlink_urb(this_urb);
738 break;
739 }
740
741 /* First byte in buffer is "last flag" (except for usa19hx)
742 - unused so for now so set to zero */
743 ((char *)this_urb->transfer_buffer)[0] = 0;
744
745 memcpy(this_urb->transfer_buffer + dataOffset, buf, todo);
746 buf += todo;
747
748 /* send the data out the bulk port */
749 this_urb->transfer_buffer_length = todo + dataOffset;
750
751 err = usb_submit_urb(this_urb, GFP_ATOMIC);
752 if (err != 0)
753 dev_dbg(&port->dev, "usb_submit_urb(write bulk) failed (%d)\n", err);
754 p_priv->tx_start_time[flip] = jiffies;
755
756 /* Flip for next time if usa26 or usa28 interface
757 (not used on usa49) */
758 p_priv->out_flip = (flip + 1) & d_details->outdat_endp_flip;
759 }
760
761 return count - left;
762}
763
764static void usa26_indat_callback(struct urb *urb)
765{
766 int i, err;
767 int endpoint;
768 struct usb_serial_port *port;
769 unsigned char *data = urb->transfer_buffer;
770 int status = urb->status;
771
772 endpoint = usb_pipeendpoint(urb->pipe);
773
774 if (status) {
775 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
776 __func__, status, endpoint);
777 return;
778 }
779
780 port = urb->context;
781 if (urb->actual_length) {
782 /* 0x80 bit is error flag */
783 if ((data[0] & 0x80) == 0) {
784 /* no errors on individual bytes, only
785 possible overrun err */
786 if (data[0] & RXERROR_OVERRUN) {
787 tty_insert_flip_char(&port->port, 0,
788 TTY_OVERRUN);
789 }
790 for (i = 1; i < urb->actual_length ; ++i)
791 tty_insert_flip_char(&port->port, data[i],
792 TTY_NORMAL);
793 } else {
794 /* some bytes had errors, every byte has status */
795 dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
796 for (i = 0; i + 1 < urb->actual_length; i += 2) {
797 int stat = data[i];
798 int flag = TTY_NORMAL;
799
800 if (stat & RXERROR_OVERRUN) {
801 tty_insert_flip_char(&port->port, 0,
802 TTY_OVERRUN);
803 }
804 /* XXX should handle break (0x10) */
805 if (stat & RXERROR_PARITY)
806 flag = TTY_PARITY;
807 else if (stat & RXERROR_FRAMING)
808 flag = TTY_FRAME;
809
810 tty_insert_flip_char(&port->port, data[i+1],
811 flag);
812 }
813 }
814 tty_flip_buffer_push(&port->port);
815 }
816
817 /* Resubmit urb so we continue receiving */
818 err = usb_submit_urb(urb, GFP_ATOMIC);
819 if (err != 0)
820 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
821}
822
823/* Outdat handling is common for all devices */
824static void usa2x_outdat_callback(struct urb *urb)
825{
826 struct usb_serial_port *port;
827 struct keyspan_port_private *p_priv;
828
829 port = urb->context;
830 p_priv = usb_get_serial_port_data(port);
831 dev_dbg(&port->dev, "%s - urb %d\n", __func__, urb == p_priv->out_urbs[1]);
832
833 usb_serial_port_softint(port);
834}
835
836static void usa26_inack_callback(struct urb *urb)
837{
838}
839
840static void usa26_outcont_callback(struct urb *urb)
841{
842 struct usb_serial_port *port;
843 struct keyspan_port_private *p_priv;
844
845 port = urb->context;
846 p_priv = usb_get_serial_port_data(port);
847
848 if (p_priv->resend_cont) {
849 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
850 keyspan_usa26_send_setup(port->serial, port,
851 p_priv->resend_cont - 1);
852 }
853}
854
855static void usa26_instat_callback(struct urb *urb)
856{
857 unsigned char *data = urb->transfer_buffer;
858 struct keyspan_usa26_portStatusMessage *msg;
859 struct usb_serial *serial;
860 struct usb_serial_port *port;
861 struct keyspan_port_private *p_priv;
862 int old_dcd_state, err;
863 int status = urb->status;
864
865 serial = urb->context;
866
867 if (status) {
868 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
869 __func__, status);
870 return;
871 }
872 if (urb->actual_length != 9) {
873 dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
874 goto exit;
875 }
876
877 msg = (struct keyspan_usa26_portStatusMessage *)data;
878
879 /* Check port number from message and retrieve private data */
880 if (msg->port >= serial->num_ports) {
881 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
882 goto exit;
883 }
884 port = serial->port[msg->port];
885 p_priv = usb_get_serial_port_data(port);
886 if (!p_priv)
887 goto resubmit;
888
889 /* Update handshaking pin state information */
890 old_dcd_state = p_priv->dcd_state;
891 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
892 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
893 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
894 p_priv->ri_state = ((msg->ri) ? 1 : 0);
895
896 if (old_dcd_state != p_priv->dcd_state)
897 tty_port_tty_hangup(&port->port, true);
898resubmit:
899 /* Resubmit urb so we continue receiving */
900 err = usb_submit_urb(urb, GFP_ATOMIC);
901 if (err != 0)
902 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
903exit: ;
904}
905
906static void usa26_glocont_callback(struct urb *urb)
907{
908}
909
910
911static void usa28_indat_callback(struct urb *urb)
912{
913 int err;
914 struct usb_serial_port *port;
915 unsigned char *data;
916 struct keyspan_port_private *p_priv;
917 int status = urb->status;
918
919 port = urb->context;
920 p_priv = usb_get_serial_port_data(port);
921 data = urb->transfer_buffer;
922
923 if (urb != p_priv->in_urbs[p_priv->in_flip])
924 return;
925
926 do {
927 if (status) {
928 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
929 __func__, status, usb_pipeendpoint(urb->pipe));
930 return;
931 }
932
933 port = urb->context;
934 p_priv = usb_get_serial_port_data(port);
935 data = urb->transfer_buffer;
936
937 if (urb->actual_length) {
938 tty_insert_flip_string(&port->port, data,
939 urb->actual_length);
940 tty_flip_buffer_push(&port->port);
941 }
942
943 /* Resubmit urb so we continue receiving */
944 err = usb_submit_urb(urb, GFP_ATOMIC);
945 if (err != 0)
946 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n",
947 __func__, err);
948 p_priv->in_flip ^= 1;
949
950 urb = p_priv->in_urbs[p_priv->in_flip];
951 } while (urb->status != -EINPROGRESS);
952}
953
954static void usa28_inack_callback(struct urb *urb)
955{
956}
957
958static void usa28_outcont_callback(struct urb *urb)
959{
960 struct usb_serial_port *port;
961 struct keyspan_port_private *p_priv;
962
963 port = urb->context;
964 p_priv = usb_get_serial_port_data(port);
965
966 if (p_priv->resend_cont) {
967 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
968 keyspan_usa28_send_setup(port->serial, port,
969 p_priv->resend_cont - 1);
970 }
971}
972
973static void usa28_instat_callback(struct urb *urb)
974{
975 int err;
976 unsigned char *data = urb->transfer_buffer;
977 struct keyspan_usa28_portStatusMessage *msg;
978 struct usb_serial *serial;
979 struct usb_serial_port *port;
980 struct keyspan_port_private *p_priv;
981 int old_dcd_state;
982 int status = urb->status;
983
984 serial = urb->context;
985
986 if (status) {
987 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
988 __func__, status);
989 return;
990 }
991
992 if (urb->actual_length != sizeof(struct keyspan_usa28_portStatusMessage)) {
993 dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
994 goto exit;
995 }
996
997 msg = (struct keyspan_usa28_portStatusMessage *)data;
998
999 /* Check port number from message and retrieve private data */
1000 if (msg->port >= serial->num_ports) {
1001 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
1002 goto exit;
1003 }
1004 port = serial->port[msg->port];
1005 p_priv = usb_get_serial_port_data(port);
1006 if (!p_priv)
1007 goto resubmit;
1008
1009 /* Update handshaking pin state information */
1010 old_dcd_state = p_priv->dcd_state;
1011 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1012 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1013 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1014 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1015
1016 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1017 tty_port_tty_hangup(&port->port, true);
1018resubmit:
1019 /* Resubmit urb so we continue receiving */
1020 err = usb_submit_urb(urb, GFP_ATOMIC);
1021 if (err != 0)
1022 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1023exit: ;
1024}
1025
1026static void usa28_glocont_callback(struct urb *urb)
1027{
1028}
1029
1030
1031static void usa49_glocont_callback(struct urb *urb)
1032{
1033 struct usb_serial *serial;
1034 struct usb_serial_port *port;
1035 struct keyspan_port_private *p_priv;
1036 int i;
1037
1038 serial = urb->context;
1039 for (i = 0; i < serial->num_ports; ++i) {
1040 port = serial->port[i];
1041 p_priv = usb_get_serial_port_data(port);
1042 if (!p_priv)
1043 continue;
1044
1045 if (p_priv->resend_cont) {
1046 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
1047 keyspan_usa49_send_setup(serial, port,
1048 p_priv->resend_cont - 1);
1049 break;
1050 }
1051 }
1052}
1053
1054 /* This is actually called glostat in the Keyspan
1055 doco */
1056static void usa49_instat_callback(struct urb *urb)
1057{
1058 int err;
1059 unsigned char *data = urb->transfer_buffer;
1060 struct keyspan_usa49_portStatusMessage *msg;
1061 struct usb_serial *serial;
1062 struct usb_serial_port *port;
1063 struct keyspan_port_private *p_priv;
1064 int old_dcd_state;
1065 int status = urb->status;
1066
1067 serial = urb->context;
1068
1069 if (status) {
1070 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1071 __func__, status);
1072 return;
1073 }
1074
1075 if (urb->actual_length !=
1076 sizeof(struct keyspan_usa49_portStatusMessage)) {
1077 dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1078 goto exit;
1079 }
1080
1081 msg = (struct keyspan_usa49_portStatusMessage *)data;
1082
1083 /* Check port number from message and retrieve private data */
1084 if (msg->portNumber >= serial->num_ports) {
1085 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
1086 __func__, msg->portNumber);
1087 goto exit;
1088 }
1089 port = serial->port[msg->portNumber];
1090 p_priv = usb_get_serial_port_data(port);
1091 if (!p_priv)
1092 goto resubmit;
1093
1094 /* Update handshaking pin state information */
1095 old_dcd_state = p_priv->dcd_state;
1096 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1097 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1098 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1099 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1100
1101 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1102 tty_port_tty_hangup(&port->port, true);
1103resubmit:
1104 /* Resubmit urb so we continue receiving */
1105 err = usb_submit_urb(urb, GFP_ATOMIC);
1106 if (err != 0)
1107 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1108exit: ;
1109}
1110
1111static void usa49_inack_callback(struct urb *urb)
1112{
1113}
1114
1115static void usa49_indat_callback(struct urb *urb)
1116{
1117 int i, err;
1118 int endpoint;
1119 struct usb_serial_port *port;
1120 unsigned char *data = urb->transfer_buffer;
1121 int status = urb->status;
1122
1123 endpoint = usb_pipeendpoint(urb->pipe);
1124
1125 if (status) {
1126 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
1127 __func__, status, endpoint);
1128 return;
1129 }
1130
1131 port = urb->context;
1132 if (urb->actual_length) {
1133 /* 0x80 bit is error flag */
1134 if ((data[0] & 0x80) == 0) {
1135 /* no error on any byte */
1136 tty_insert_flip_string(&port->port, data + 1,
1137 urb->actual_length - 1);
1138 } else {
1139 /* some bytes had errors, every byte has status */
1140 for (i = 0; i + 1 < urb->actual_length; i += 2) {
1141 int stat = data[i];
1142 int flag = TTY_NORMAL;
1143
1144 if (stat & RXERROR_OVERRUN) {
1145 tty_insert_flip_char(&port->port, 0,
1146 TTY_OVERRUN);
1147 }
1148 /* XXX should handle break (0x10) */
1149 if (stat & RXERROR_PARITY)
1150 flag = TTY_PARITY;
1151 else if (stat & RXERROR_FRAMING)
1152 flag = TTY_FRAME;
1153
1154 tty_insert_flip_char(&port->port, data[i+1],
1155 flag);
1156 }
1157 }
1158 tty_flip_buffer_push(&port->port);
1159 }
1160
1161 /* Resubmit urb so we continue receiving */
1162 err = usb_submit_urb(urb, GFP_ATOMIC);
1163 if (err != 0)
1164 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1165}
1166
1167static void usa49wg_indat_callback(struct urb *urb)
1168{
1169 int i, len, x, err;
1170 struct usb_serial *serial;
1171 struct usb_serial_port *port;
1172 unsigned char *data = urb->transfer_buffer;
1173 int status = urb->status;
1174
1175 serial = urb->context;
1176
1177 if (status) {
1178 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1179 __func__, status);
1180 return;
1181 }
1182
1183 /* inbound data is in the form P#, len, status, data */
1184 i = 0;
1185 len = 0;
1186
1187 while (i < urb->actual_length) {
1188
1189 /* Check port number from message */
1190 if (data[i] >= serial->num_ports) {
1191 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n",
1192 __func__, data[i]);
1193 return;
1194 }
1195 port = serial->port[data[i++]];
1196 len = data[i++];
1197
1198 /* 0x80 bit is error flag */
1199 if ((data[i] & 0x80) == 0) {
1200 /* no error on any byte */
1201 i++;
1202 for (x = 1; x < len && i < urb->actual_length; ++x)
1203 tty_insert_flip_char(&port->port,
1204 data[i++], 0);
1205 } else {
1206 /*
1207 * some bytes had errors, every byte has status
1208 */
1209 for (x = 0; x + 1 < len &&
1210 i + 1 < urb->actual_length; x += 2) {
1211 int stat = data[i];
1212 int flag = TTY_NORMAL;
1213
1214 if (stat & RXERROR_OVERRUN) {
1215 tty_insert_flip_char(&port->port, 0,
1216 TTY_OVERRUN);
1217 }
1218 /* XXX should handle break (0x10) */
1219 if (stat & RXERROR_PARITY)
1220 flag = TTY_PARITY;
1221 else if (stat & RXERROR_FRAMING)
1222 flag = TTY_FRAME;
1223
1224 tty_insert_flip_char(&port->port, data[i+1],
1225 flag);
1226 i += 2;
1227 }
1228 }
1229 tty_flip_buffer_push(&port->port);
1230 }
1231
1232 /* Resubmit urb so we continue receiving */
1233 err = usb_submit_urb(urb, GFP_ATOMIC);
1234 if (err != 0)
1235 dev_dbg(&urb->dev->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1236}
1237
1238/* not used, usa-49 doesn't have per-port control endpoints */
1239static void usa49_outcont_callback(struct urb *urb)
1240{
1241}
1242
1243static void usa90_indat_callback(struct urb *urb)
1244{
1245 int i, err;
1246 int endpoint;
1247 struct usb_serial_port *port;
1248 struct keyspan_port_private *p_priv;
1249 unsigned char *data = urb->transfer_buffer;
1250 int status = urb->status;
1251
1252 endpoint = usb_pipeendpoint(urb->pipe);
1253
1254 if (status) {
1255 dev_dbg(&urb->dev->dev, "%s - nonzero status %d on endpoint %x\n",
1256 __func__, status, endpoint);
1257 return;
1258 }
1259
1260 port = urb->context;
1261 p_priv = usb_get_serial_port_data(port);
1262
1263 if (urb->actual_length) {
1264 /* if current mode is DMA, looks like usa28 format
1265 otherwise looks like usa26 data format */
1266
1267 if (p_priv->baud > 57600)
1268 tty_insert_flip_string(&port->port, data,
1269 urb->actual_length);
1270 else {
1271 /* 0x80 bit is error flag */
1272 if ((data[0] & 0x80) == 0) {
1273 /* no errors on individual bytes, only
1274 possible overrun err*/
1275 if (data[0] & RXERROR_OVERRUN) {
1276 tty_insert_flip_char(&port->port, 0,
1277 TTY_OVERRUN);
1278 }
1279 for (i = 1; i < urb->actual_length ; ++i)
1280 tty_insert_flip_char(&port->port,
1281 data[i], TTY_NORMAL);
1282 } else {
1283 /* some bytes had errors, every byte has status */
1284 dev_dbg(&port->dev, "%s - RX error!!!!\n", __func__);
1285 for (i = 0; i + 1 < urb->actual_length; i += 2) {
1286 int stat = data[i];
1287 int flag = TTY_NORMAL;
1288
1289 if (stat & RXERROR_OVERRUN) {
1290 tty_insert_flip_char(
1291 &port->port, 0,
1292 TTY_OVERRUN);
1293 }
1294 /* XXX should handle break (0x10) */
1295 if (stat & RXERROR_PARITY)
1296 flag = TTY_PARITY;
1297 else if (stat & RXERROR_FRAMING)
1298 flag = TTY_FRAME;
1299
1300 tty_insert_flip_char(&port->port,
1301 data[i+1], flag);
1302 }
1303 }
1304 }
1305 tty_flip_buffer_push(&port->port);
1306 }
1307
1308 /* Resubmit urb so we continue receiving */
1309 err = usb_submit_urb(urb, GFP_ATOMIC);
1310 if (err != 0)
1311 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1312}
1313
1314
1315static void usa90_instat_callback(struct urb *urb)
1316{
1317 unsigned char *data = urb->transfer_buffer;
1318 struct keyspan_usa90_portStatusMessage *msg;
1319 struct usb_serial *serial;
1320 struct usb_serial_port *port;
1321 struct keyspan_port_private *p_priv;
1322 int old_dcd_state, err;
1323 int status = urb->status;
1324
1325 serial = urb->context;
1326
1327 if (status) {
1328 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1329 __func__, status);
1330 return;
1331 }
1332 if (urb->actual_length < 14) {
1333 dev_dbg(&urb->dev->dev, "%s - %d byte report??\n", __func__, urb->actual_length);
1334 goto exit;
1335 }
1336
1337 msg = (struct keyspan_usa90_portStatusMessage *)data;
1338
1339 /* Now do something useful with the data */
1340
1341 port = serial->port[0];
1342 p_priv = usb_get_serial_port_data(port);
1343 if (!p_priv)
1344 goto resubmit;
1345
1346 /* Update handshaking pin state information */
1347 old_dcd_state = p_priv->dcd_state;
1348 p_priv->cts_state = ((msg->cts) ? 1 : 0);
1349 p_priv->dsr_state = ((msg->dsr) ? 1 : 0);
1350 p_priv->dcd_state = ((msg->dcd) ? 1 : 0);
1351 p_priv->ri_state = ((msg->ri) ? 1 : 0);
1352
1353 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1354 tty_port_tty_hangup(&port->port, true);
1355resubmit:
1356 /* Resubmit urb so we continue receiving */
1357 err = usb_submit_urb(urb, GFP_ATOMIC);
1358 if (err != 0)
1359 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1360exit:
1361 ;
1362}
1363
1364static void usa90_outcont_callback(struct urb *urb)
1365{
1366 struct usb_serial_port *port;
1367 struct keyspan_port_private *p_priv;
1368
1369 port = urb->context;
1370 p_priv = usb_get_serial_port_data(port);
1371
1372 if (p_priv->resend_cont) {
1373 dev_dbg(&urb->dev->dev, "%s - sending setup\n", __func__);
1374 keyspan_usa90_send_setup(port->serial, port,
1375 p_priv->resend_cont - 1);
1376 }
1377}
1378
1379/* Status messages from the 28xg */
1380static void usa67_instat_callback(struct urb *urb)
1381{
1382 int err;
1383 unsigned char *data = urb->transfer_buffer;
1384 struct keyspan_usa67_portStatusMessage *msg;
1385 struct usb_serial *serial;
1386 struct usb_serial_port *port;
1387 struct keyspan_port_private *p_priv;
1388 int old_dcd_state;
1389 int status = urb->status;
1390
1391 serial = urb->context;
1392
1393 if (status) {
1394 dev_dbg(&urb->dev->dev, "%s - nonzero status: %d\n",
1395 __func__, status);
1396 return;
1397 }
1398
1399 if (urb->actual_length !=
1400 sizeof(struct keyspan_usa67_portStatusMessage)) {
1401 dev_dbg(&urb->dev->dev, "%s - bad length %d\n", __func__, urb->actual_length);
1402 return;
1403 }
1404
1405
1406 /* Now do something useful with the data */
1407 msg = (struct keyspan_usa67_portStatusMessage *)data;
1408
1409 /* Check port number from message and retrieve private data */
1410 if (msg->port >= serial->num_ports) {
1411 dev_dbg(&urb->dev->dev, "%s - Unexpected port number %d\n", __func__, msg->port);
1412 return;
1413 }
1414
1415 port = serial->port[msg->port];
1416 p_priv = usb_get_serial_port_data(port);
1417 if (!p_priv)
1418 goto resubmit;
1419
1420 /* Update handshaking pin state information */
1421 old_dcd_state = p_priv->dcd_state;
1422 p_priv->cts_state = ((msg->hskia_cts) ? 1 : 0);
1423 p_priv->dcd_state = ((msg->gpia_dcd) ? 1 : 0);
1424
1425 if (old_dcd_state != p_priv->dcd_state && old_dcd_state)
1426 tty_port_tty_hangup(&port->port, true);
1427resubmit:
1428 /* Resubmit urb so we continue receiving */
1429 err = usb_submit_urb(urb, GFP_ATOMIC);
1430 if (err != 0)
1431 dev_dbg(&port->dev, "%s - resubmit read urb failed. (%d)\n", __func__, err);
1432}
1433
1434static void usa67_glocont_callback(struct urb *urb)
1435{
1436 struct usb_serial *serial;
1437 struct usb_serial_port *port;
1438 struct keyspan_port_private *p_priv;
1439 int i;
1440
1441 serial = urb->context;
1442 for (i = 0; i < serial->num_ports; ++i) {
1443 port = serial->port[i];
1444 p_priv = usb_get_serial_port_data(port);
1445 if (!p_priv)
1446 continue;
1447
1448 if (p_priv->resend_cont) {
1449 dev_dbg(&port->dev, "%s - sending setup\n", __func__);
1450 keyspan_usa67_send_setup(serial, port,
1451 p_priv->resend_cont - 1);
1452 break;
1453 }
1454 }
1455}
1456
1457static unsigned int keyspan_write_room(struct tty_struct *tty)
1458{
1459 struct usb_serial_port *port = tty->driver_data;
1460 struct keyspan_port_private *p_priv;
1461 const struct keyspan_device_details *d_details;
1462 int flip;
1463 unsigned int data_len;
1464 struct urb *this_urb;
1465
1466 p_priv = usb_get_serial_port_data(port);
1467 d_details = p_priv->device_details;
1468
1469 /* FIXME: locking */
1470 if (d_details->msg_format == msg_usa90)
1471 data_len = 64;
1472 else
1473 data_len = 63;
1474
1475 flip = p_priv->out_flip;
1476
1477 /* Check both endpoints to see if any are available. */
1478 this_urb = p_priv->out_urbs[flip];
1479 if (this_urb != NULL) {
1480 if (this_urb->status != -EINPROGRESS)
1481 return data_len;
1482 flip = (flip + 1) & d_details->outdat_endp_flip;
1483 this_urb = p_priv->out_urbs[flip];
1484 if (this_urb != NULL) {
1485 if (this_urb->status != -EINPROGRESS)
1486 return data_len;
1487 }
1488 }
1489 return 0;
1490}
1491
1492
1493static int keyspan_open(struct tty_struct *tty, struct usb_serial_port *port)
1494{
1495 struct keyspan_port_private *p_priv;
1496 const struct keyspan_device_details *d_details;
1497 int i, err;
1498 int baud_rate, device_port;
1499 struct urb *urb;
1500 unsigned int cflag = 0;
1501
1502 p_priv = usb_get_serial_port_data(port);
1503 d_details = p_priv->device_details;
1504
1505 /* Set some sane defaults */
1506 p_priv->rts_state = 1;
1507 p_priv->dtr_state = 1;
1508 p_priv->baud = 9600;
1509
1510 /* force baud and lcr to be set on open */
1511 p_priv->old_baud = 0;
1512 p_priv->old_cflag = 0;
1513
1514 p_priv->out_flip = 0;
1515 p_priv->in_flip = 0;
1516
1517 /* Reset low level data toggle and start reading from endpoints */
1518 for (i = 0; i < 2; i++) {
1519 urb = p_priv->in_urbs[i];
1520 if (urb == NULL)
1521 continue;
1522
1523 /* make sure endpoint data toggle is synchronized
1524 with the device */
1525 usb_clear_halt(urb->dev, urb->pipe);
1526 err = usb_submit_urb(urb, GFP_KERNEL);
1527 if (err != 0)
1528 dev_dbg(&port->dev, "%s - submit urb %d failed (%d)\n", __func__, i, err);
1529 }
1530
1531 /* Reset low level data toggle on out endpoints */
1532 for (i = 0; i < 2; i++) {
1533 urb = p_priv->out_urbs[i];
1534 if (urb == NULL)
1535 continue;
1536 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1537 usb_pipeout(urb->pipe), 0); */
1538 }
1539
1540 /* get the terminal config for the setup message now so we don't
1541 * need to send 2 of them */
1542
1543 device_port = port->port_number;
1544 if (tty) {
1545 cflag = tty->termios.c_cflag;
1546 /* Baud rate calculation takes baud rate as an integer
1547 so other rates can be generated if desired. */
1548 baud_rate = tty_get_baud_rate(tty);
1549 /* If no match or invalid, leave as default */
1550 if (baud_rate >= 0
1551 && d_details->calculate_baud_rate(port, baud_rate, d_details->baudclk,
1552 NULL, NULL, NULL, device_port) == KEYSPAN_BAUD_RATE_OK) {
1553 p_priv->baud = baud_rate;
1554 }
1555 }
1556 /* set CTS/RTS handshake etc. */
1557 p_priv->cflag = cflag;
1558 p_priv->flow_control = (cflag & CRTSCTS) ? flow_cts : flow_none;
1559
1560 keyspan_send_setup(port, 1);
1561 /* mdelay(100); */
1562 /* keyspan_set_termios(port, NULL); */
1563
1564 return 0;
1565}
1566
1567static void keyspan_dtr_rts(struct usb_serial_port *port, int on)
1568{
1569 struct keyspan_port_private *p_priv = usb_get_serial_port_data(port);
1570
1571 p_priv->rts_state = on;
1572 p_priv->dtr_state = on;
1573 keyspan_send_setup(port, 0);
1574}
1575
1576static void keyspan_close(struct usb_serial_port *port)
1577{
1578 int i;
1579 struct keyspan_port_private *p_priv;
1580
1581 p_priv = usb_get_serial_port_data(port);
1582
1583 p_priv->rts_state = 0;
1584 p_priv->dtr_state = 0;
1585
1586 keyspan_send_setup(port, 2);
1587 /* pilot-xfer seems to work best with this delay */
1588 mdelay(100);
1589
1590 p_priv->out_flip = 0;
1591 p_priv->in_flip = 0;
1592
1593 usb_kill_urb(p_priv->inack_urb);
1594 for (i = 0; i < 2; i++) {
1595 usb_kill_urb(p_priv->in_urbs[i]);
1596 usb_kill_urb(p_priv->out_urbs[i]);
1597 }
1598}
1599
1600/* download the firmware to a pre-renumeration device */
1601static int keyspan_fake_startup(struct usb_serial *serial)
1602{
1603 char *fw_name;
1604
1605 dev_dbg(&serial->dev->dev, "Keyspan startup version %04x product %04x\n",
1606 le16_to_cpu(serial->dev->descriptor.bcdDevice),
1607 le16_to_cpu(serial->dev->descriptor.idProduct));
1608
1609 if ((le16_to_cpu(serial->dev->descriptor.bcdDevice) & 0x8000)
1610 != 0x8000) {
1611 dev_dbg(&serial->dev->dev, "Firmware already loaded. Quitting.\n");
1612 return 1;
1613 }
1614
1615 /* Select firmware image on the basis of idProduct */
1616 switch (le16_to_cpu(serial->dev->descriptor.idProduct)) {
1617 case keyspan_usa28_pre_product_id:
1618 fw_name = "keyspan/usa28.fw";
1619 break;
1620
1621 case keyspan_usa28x_pre_product_id:
1622 fw_name = "keyspan/usa28x.fw";
1623 break;
1624
1625 case keyspan_usa28xa_pre_product_id:
1626 fw_name = "keyspan/usa28xa.fw";
1627 break;
1628
1629 case keyspan_usa28xb_pre_product_id:
1630 fw_name = "keyspan/usa28xb.fw";
1631 break;
1632
1633 case keyspan_usa19_pre_product_id:
1634 fw_name = "keyspan/usa19.fw";
1635 break;
1636
1637 case keyspan_usa19qi_pre_product_id:
1638 fw_name = "keyspan/usa19qi.fw";
1639 break;
1640
1641 case keyspan_mpr_pre_product_id:
1642 fw_name = "keyspan/mpr.fw";
1643 break;
1644
1645 case keyspan_usa19qw_pre_product_id:
1646 fw_name = "keyspan/usa19qw.fw";
1647 break;
1648
1649 case keyspan_usa18x_pre_product_id:
1650 fw_name = "keyspan/usa18x.fw";
1651 break;
1652
1653 case keyspan_usa19w_pre_product_id:
1654 fw_name = "keyspan/usa19w.fw";
1655 break;
1656
1657 case keyspan_usa49w_pre_product_id:
1658 fw_name = "keyspan/usa49w.fw";
1659 break;
1660
1661 case keyspan_usa49wlc_pre_product_id:
1662 fw_name = "keyspan/usa49wlc.fw";
1663 break;
1664
1665 default:
1666 dev_err(&serial->dev->dev, "Unknown product ID (%04x)\n",
1667 le16_to_cpu(serial->dev->descriptor.idProduct));
1668 return 1;
1669 }
1670
1671 dev_dbg(&serial->dev->dev, "Uploading Keyspan %s firmware.\n", fw_name);
1672
1673 if (ezusb_fx1_ihex_firmware_download(serial->dev, fw_name) < 0) {
1674 dev_err(&serial->dev->dev, "failed to load firmware \"%s\"\n",
1675 fw_name);
1676 return -ENOENT;
1677 }
1678
1679 /* after downloading firmware Renumeration will occur in a
1680 moment and the new device will bind to the real driver */
1681
1682 /* we don't want this device to have a driver assigned to it. */
1683 return 1;
1684}
1685
1686/* Helper functions used by keyspan_setup_urbs */
1687static struct usb_endpoint_descriptor const *find_ep(struct usb_serial const *serial,
1688 int endpoint)
1689{
1690 struct usb_host_interface *iface_desc;
1691 struct usb_endpoint_descriptor *ep;
1692 int i;
1693
1694 iface_desc = serial->interface->cur_altsetting;
1695 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1696 ep = &iface_desc->endpoint[i].desc;
1697 if (ep->bEndpointAddress == endpoint)
1698 return ep;
1699 }
1700 dev_warn(&serial->interface->dev, "found no endpoint descriptor for endpoint %x\n",
1701 endpoint);
1702 return NULL;
1703}
1704
1705static struct urb *keyspan_setup_urb(struct usb_serial *serial, int endpoint,
1706 int dir, void *ctx, char *buf, int len,
1707 void (*callback)(struct urb *))
1708{
1709 struct urb *urb;
1710 struct usb_endpoint_descriptor const *ep_desc;
1711 char const *ep_type_name;
1712
1713 if (endpoint == -1)
1714 return NULL; /* endpoint not needed */
1715
1716 dev_dbg(&serial->interface->dev, "%s - alloc for endpoint %x\n",
1717 __func__, endpoint);
1718 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
1719 if (!urb)
1720 return NULL;
1721
1722 if (endpoint == 0) {
1723 /* control EP filled in when used */
1724 return urb;
1725 }
1726
1727 ep_desc = find_ep(serial, endpoint);
1728 if (!ep_desc) {
1729 usb_free_urb(urb);
1730 return NULL;
1731 }
1732 if (usb_endpoint_xfer_int(ep_desc)) {
1733 ep_type_name = "INT";
1734 usb_fill_int_urb(urb, serial->dev,
1735 usb_sndintpipe(serial->dev, endpoint) | dir,
1736 buf, len, callback, ctx,
1737 ep_desc->bInterval);
1738 } else if (usb_endpoint_xfer_bulk(ep_desc)) {
1739 ep_type_name = "BULK";
1740 usb_fill_bulk_urb(urb, serial->dev,
1741 usb_sndbulkpipe(serial->dev, endpoint) | dir,
1742 buf, len, callback, ctx);
1743 } else {
1744 dev_warn(&serial->interface->dev,
1745 "unsupported endpoint type %x\n",
1746 usb_endpoint_type(ep_desc));
1747 usb_free_urb(urb);
1748 return NULL;
1749 }
1750
1751 dev_dbg(&serial->interface->dev, "%s - using urb %p for %s endpoint %x\n",
1752 __func__, urb, ep_type_name, endpoint);
1753 return urb;
1754}
1755
1756static struct callbacks {
1757 void (*instat_callback)(struct urb *);
1758 void (*glocont_callback)(struct urb *);
1759 void (*indat_callback)(struct urb *);
1760 void (*outdat_callback)(struct urb *);
1761 void (*inack_callback)(struct urb *);
1762 void (*outcont_callback)(struct urb *);
1763} keyspan_callbacks[] = {
1764 {
1765 /* msg_usa26 callbacks */
1766 .instat_callback = usa26_instat_callback,
1767 .glocont_callback = usa26_glocont_callback,
1768 .indat_callback = usa26_indat_callback,
1769 .outdat_callback = usa2x_outdat_callback,
1770 .inack_callback = usa26_inack_callback,
1771 .outcont_callback = usa26_outcont_callback,
1772 }, {
1773 /* msg_usa28 callbacks */
1774 .instat_callback = usa28_instat_callback,
1775 .glocont_callback = usa28_glocont_callback,
1776 .indat_callback = usa28_indat_callback,
1777 .outdat_callback = usa2x_outdat_callback,
1778 .inack_callback = usa28_inack_callback,
1779 .outcont_callback = usa28_outcont_callback,
1780 }, {
1781 /* msg_usa49 callbacks */
1782 .instat_callback = usa49_instat_callback,
1783 .glocont_callback = usa49_glocont_callback,
1784 .indat_callback = usa49_indat_callback,
1785 .outdat_callback = usa2x_outdat_callback,
1786 .inack_callback = usa49_inack_callback,
1787 .outcont_callback = usa49_outcont_callback,
1788 }, {
1789 /* msg_usa90 callbacks */
1790 .instat_callback = usa90_instat_callback,
1791 .glocont_callback = usa28_glocont_callback,
1792 .indat_callback = usa90_indat_callback,
1793 .outdat_callback = usa2x_outdat_callback,
1794 .inack_callback = usa28_inack_callback,
1795 .outcont_callback = usa90_outcont_callback,
1796 }, {
1797 /* msg_usa67 callbacks */
1798 .instat_callback = usa67_instat_callback,
1799 .glocont_callback = usa67_glocont_callback,
1800 .indat_callback = usa26_indat_callback,
1801 .outdat_callback = usa2x_outdat_callback,
1802 .inack_callback = usa26_inack_callback,
1803 .outcont_callback = usa26_outcont_callback,
1804 }
1805};
1806
1807 /* Generic setup urbs function that uses
1808 data in device_details */
1809static void keyspan_setup_urbs(struct usb_serial *serial)
1810{
1811 struct keyspan_serial_private *s_priv;
1812 const struct keyspan_device_details *d_details;
1813 struct callbacks *cback;
1814
1815 s_priv = usb_get_serial_data(serial);
1816 d_details = s_priv->device_details;
1817
1818 /* Setup values for the various callback routines */
1819 cback = &keyspan_callbacks[d_details->msg_format];
1820
1821 /* Allocate and set up urbs for each one that is in use,
1822 starting with instat endpoints */
1823 s_priv->instat_urb = keyspan_setup_urb
1824 (serial, d_details->instat_endpoint, USB_DIR_IN,
1825 serial, s_priv->instat_buf, INSTAT_BUFLEN,
1826 cback->instat_callback);
1827
1828 s_priv->indat_urb = keyspan_setup_urb
1829 (serial, d_details->indat_endpoint, USB_DIR_IN,
1830 serial, s_priv->indat_buf, INDAT49W_BUFLEN,
1831 usa49wg_indat_callback);
1832
1833 s_priv->glocont_urb = keyspan_setup_urb
1834 (serial, d_details->glocont_endpoint, USB_DIR_OUT,
1835 serial, s_priv->glocont_buf, GLOCONT_BUFLEN,
1836 cback->glocont_callback);
1837}
1838
1839/* usa19 function doesn't require prescaler */
1840static int keyspan_usa19_calc_baud(struct usb_serial_port *port,
1841 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1842 u8 *rate_low, u8 *prescaler, int portnum)
1843{
1844 u32 b16, /* baud rate times 16 (actual rate used internally) */
1845 div, /* divisor */
1846 cnt; /* inverse of divisor (programmed into 8051) */
1847
1848 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1849
1850 /* prevent divide by zero... */
1851 b16 = baud_rate * 16L;
1852 if (b16 == 0)
1853 return KEYSPAN_INVALID_BAUD_RATE;
1854 /* Any "standard" rate over 57k6 is marginal on the USA-19
1855 as we run out of divisor resolution. */
1856 if (baud_rate > 57600)
1857 return KEYSPAN_INVALID_BAUD_RATE;
1858
1859 /* calculate the divisor and the counter (its inverse) */
1860 div = baudclk / b16;
1861 if (div == 0)
1862 return KEYSPAN_INVALID_BAUD_RATE;
1863 else
1864 cnt = 0 - div;
1865
1866 if (div > 0xffff)
1867 return KEYSPAN_INVALID_BAUD_RATE;
1868
1869 /* return the counter values if non-null */
1870 if (rate_low)
1871 *rate_low = (u8) (cnt & 0xff);
1872 if (rate_hi)
1873 *rate_hi = (u8) ((cnt >> 8) & 0xff);
1874 if (rate_low && rate_hi)
1875 dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1876 __func__, baud_rate, *rate_hi, *rate_low);
1877 return KEYSPAN_BAUD_RATE_OK;
1878}
1879
1880/* usa19hs function doesn't require prescaler */
1881static int keyspan_usa19hs_calc_baud(struct usb_serial_port *port,
1882 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1883 u8 *rate_low, u8 *prescaler, int portnum)
1884{
1885 u32 b16, /* baud rate times 16 (actual rate used internally) */
1886 div; /* divisor */
1887
1888 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1889
1890 /* prevent divide by zero... */
1891 b16 = baud_rate * 16L;
1892 if (b16 == 0)
1893 return KEYSPAN_INVALID_BAUD_RATE;
1894
1895 /* calculate the divisor */
1896 div = baudclk / b16;
1897 if (div == 0)
1898 return KEYSPAN_INVALID_BAUD_RATE;
1899
1900 if (div > 0xffff)
1901 return KEYSPAN_INVALID_BAUD_RATE;
1902
1903 /* return the counter values if non-null */
1904 if (rate_low)
1905 *rate_low = (u8) (div & 0xff);
1906
1907 if (rate_hi)
1908 *rate_hi = (u8) ((div >> 8) & 0xff);
1909
1910 if (rate_low && rate_hi)
1911 dev_dbg(&port->dev, "%s - %d %02x %02x.\n",
1912 __func__, baud_rate, *rate_hi, *rate_low);
1913
1914 return KEYSPAN_BAUD_RATE_OK;
1915}
1916
1917static int keyspan_usa19w_calc_baud(struct usb_serial_port *port,
1918 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1919 u8 *rate_low, u8 *prescaler, int portnum)
1920{
1921 u32 b16, /* baud rate times 16 (actual rate used internally) */
1922 clk, /* clock with 13/8 prescaler */
1923 div, /* divisor using 13/8 prescaler */
1924 res, /* resulting baud rate using 13/8 prescaler */
1925 diff, /* error using 13/8 prescaler */
1926 smallest_diff;
1927 u8 best_prescaler;
1928 int i;
1929
1930 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1931
1932 /* prevent divide by zero */
1933 b16 = baud_rate * 16L;
1934 if (b16 == 0)
1935 return KEYSPAN_INVALID_BAUD_RATE;
1936
1937 /* Calculate prescaler by trying them all and looking
1938 for best fit */
1939
1940 /* start with largest possible difference */
1941 smallest_diff = 0xffffffff;
1942
1943 /* 0 is an invalid prescaler, used as a flag */
1944 best_prescaler = 0;
1945
1946 for (i = 8; i <= 0xff; ++i) {
1947 clk = (baudclk * 8) / (u32) i;
1948
1949 div = clk / b16;
1950 if (div == 0)
1951 continue;
1952
1953 res = clk / div;
1954 diff = (res > b16) ? (res-b16) : (b16-res);
1955
1956 if (diff < smallest_diff) {
1957 best_prescaler = i;
1958 smallest_diff = diff;
1959 }
1960 }
1961
1962 if (best_prescaler == 0)
1963 return KEYSPAN_INVALID_BAUD_RATE;
1964
1965 clk = (baudclk * 8) / (u32) best_prescaler;
1966 div = clk / b16;
1967
1968 /* return the divisor and prescaler if non-null */
1969 if (rate_low)
1970 *rate_low = (u8) (div & 0xff);
1971 if (rate_hi)
1972 *rate_hi = (u8) ((div >> 8) & 0xff);
1973 if (prescaler) {
1974 *prescaler = best_prescaler;
1975 /* dev_dbg(&port->dev, "%s - %d %d\n", __func__, *prescaler, div); */
1976 }
1977 return KEYSPAN_BAUD_RATE_OK;
1978}
1979
1980 /* USA-28 supports different maximum baud rates on each port */
1981static int keyspan_usa28_calc_baud(struct usb_serial_port *port,
1982 u32 baud_rate, u32 baudclk, u8 *rate_hi,
1983 u8 *rate_low, u8 *prescaler, int portnum)
1984{
1985 u32 b16, /* baud rate times 16 (actual rate used internally) */
1986 div, /* divisor */
1987 cnt; /* inverse of divisor (programmed into 8051) */
1988
1989 dev_dbg(&port->dev, "%s - %d.\n", __func__, baud_rate);
1990
1991 /* prevent divide by zero */
1992 b16 = baud_rate * 16L;
1993 if (b16 == 0)
1994 return KEYSPAN_INVALID_BAUD_RATE;
1995
1996 /* calculate the divisor and the counter (its inverse) */
1997 div = KEYSPAN_USA28_BAUDCLK / b16;
1998 if (div == 0)
1999 return KEYSPAN_INVALID_BAUD_RATE;
2000 else
2001 cnt = 0 - div;
2002
2003 /* check for out of range, based on portnum,
2004 and return result */
2005 if (portnum == 0) {
2006 if (div > 0xffff)
2007 return KEYSPAN_INVALID_BAUD_RATE;
2008 } else {
2009 if (portnum == 1) {
2010 if (div > 0xff)
2011 return KEYSPAN_INVALID_BAUD_RATE;
2012 } else
2013 return KEYSPAN_INVALID_BAUD_RATE;
2014 }
2015
2016 /* return the counter values if not NULL
2017 (port 1 will ignore retHi) */
2018 if (rate_low)
2019 *rate_low = (u8) (cnt & 0xff);
2020 if (rate_hi)
2021 *rate_hi = (u8) ((cnt >> 8) & 0xff);
2022 dev_dbg(&port->dev, "%s - %d OK.\n", __func__, baud_rate);
2023 return KEYSPAN_BAUD_RATE_OK;
2024}
2025
2026static int keyspan_usa26_send_setup(struct usb_serial *serial,
2027 struct usb_serial_port *port,
2028 int reset_port)
2029{
2030 struct keyspan_usa26_portControlMessage msg;
2031 struct keyspan_serial_private *s_priv;
2032 struct keyspan_port_private *p_priv;
2033 const struct keyspan_device_details *d_details;
2034 struct urb *this_urb;
2035 int device_port, err;
2036
2037 dev_dbg(&port->dev, "%s reset=%d\n", __func__, reset_port);
2038
2039 s_priv = usb_get_serial_data(serial);
2040 p_priv = usb_get_serial_port_data(port);
2041 d_details = s_priv->device_details;
2042 device_port = port->port_number;
2043
2044 this_urb = p_priv->outcont_urb;
2045
2046 /* Make sure we have an urb then send the message */
2047 if (this_urb == NULL) {
2048 dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2049 return -1;
2050 }
2051
2052 dev_dbg(&port->dev, "%s - endpoint %x\n",
2053 __func__, usb_pipeendpoint(this_urb->pipe));
2054
2055 /* Save reset port val for resend.
2056 Don't overwrite resend for open/close condition. */
2057 if ((reset_port + 1) > p_priv->resend_cont)
2058 p_priv->resend_cont = reset_port + 1;
2059 if (this_urb->status == -EINPROGRESS) {
2060 /* dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2061 mdelay(5);
2062 return -1;
2063 }
2064
2065 memset(&msg, 0, sizeof(struct keyspan_usa26_portControlMessage));
2066
2067 /* Only set baud rate if it's changed */
2068 if (p_priv->old_baud != p_priv->baud) {
2069 p_priv->old_baud = p_priv->baud;
2070 msg.setClocking = 0xff;
2071 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2072 &msg.baudHi, &msg.baudLo, &msg.prescaler,
2073 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2074 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2075 __func__, p_priv->baud);
2076 msg.baudLo = 0;
2077 msg.baudHi = 125; /* Values for 9600 baud */
2078 msg.prescaler = 10;
2079 }
2080 msg.setPrescaler = 0xff;
2081 }
2082
2083 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2084 switch (p_priv->cflag & CSIZE) {
2085 case CS5:
2086 msg.lcr |= USA_DATABITS_5;
2087 break;
2088 case CS6:
2089 msg.lcr |= USA_DATABITS_6;
2090 break;
2091 case CS7:
2092 msg.lcr |= USA_DATABITS_7;
2093 break;
2094 case CS8:
2095 msg.lcr |= USA_DATABITS_8;
2096 break;
2097 }
2098 if (p_priv->cflag & PARENB) {
2099 /* note USA_PARITY_NONE == 0 */
2100 msg.lcr |= (p_priv->cflag & PARODD) ?
2101 USA_PARITY_ODD : USA_PARITY_EVEN;
2102 }
2103 msg.setLcr = 0xff;
2104
2105 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2106 msg.xonFlowControl = 0;
2107 msg.setFlowControl = 0xff;
2108 msg.forwardingLength = 16;
2109 msg.xonChar = 17;
2110 msg.xoffChar = 19;
2111
2112 /* Opening port */
2113 if (reset_port == 1) {
2114 msg._txOn = 1;
2115 msg._txOff = 0;
2116 msg.txFlush = 0;
2117 msg.txBreak = 0;
2118 msg.rxOn = 1;
2119 msg.rxOff = 0;
2120 msg.rxFlush = 1;
2121 msg.rxForward = 0;
2122 msg.returnStatus = 0;
2123 msg.resetDataToggle = 0xff;
2124 }
2125
2126 /* Closing port */
2127 else if (reset_port == 2) {
2128 msg._txOn = 0;
2129 msg._txOff = 1;
2130 msg.txFlush = 0;
2131 msg.txBreak = 0;
2132 msg.rxOn = 0;
2133 msg.rxOff = 1;
2134 msg.rxFlush = 1;
2135 msg.rxForward = 0;
2136 msg.returnStatus = 0;
2137 msg.resetDataToggle = 0;
2138 }
2139
2140 /* Sending intermediate configs */
2141 else {
2142 msg._txOn = (!p_priv->break_on);
2143 msg._txOff = 0;
2144 msg.txFlush = 0;
2145 msg.txBreak = (p_priv->break_on);
2146 msg.rxOn = 0;
2147 msg.rxOff = 0;
2148 msg.rxFlush = 0;
2149 msg.rxForward = 0;
2150 msg.returnStatus = 0;
2151 msg.resetDataToggle = 0x0;
2152 }
2153
2154 /* Do handshaking outputs */
2155 msg.setTxTriState_setRts = 0xff;
2156 msg.txTriState_rts = p_priv->rts_state;
2157
2158 msg.setHskoa_setDtr = 0xff;
2159 msg.hskoa_dtr = p_priv->dtr_state;
2160
2161 p_priv->resend_cont = 0;
2162 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2163
2164 /* send the data out the device on control endpoint */
2165 this_urb->transfer_buffer_length = sizeof(msg);
2166
2167 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2168 if (err != 0)
2169 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2170 return 0;
2171}
2172
2173static int keyspan_usa28_send_setup(struct usb_serial *serial,
2174 struct usb_serial_port *port,
2175 int reset_port)
2176{
2177 struct keyspan_usa28_portControlMessage msg;
2178 struct keyspan_serial_private *s_priv;
2179 struct keyspan_port_private *p_priv;
2180 const struct keyspan_device_details *d_details;
2181 struct urb *this_urb;
2182 int device_port, err;
2183
2184 s_priv = usb_get_serial_data(serial);
2185 p_priv = usb_get_serial_port_data(port);
2186 d_details = s_priv->device_details;
2187 device_port = port->port_number;
2188
2189 /* only do something if we have a bulk out endpoint */
2190 this_urb = p_priv->outcont_urb;
2191 if (this_urb == NULL) {
2192 dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2193 return -1;
2194 }
2195
2196 /* Save reset port val for resend.
2197 Don't overwrite resend for open/close condition. */
2198 if ((reset_port + 1) > p_priv->resend_cont)
2199 p_priv->resend_cont = reset_port + 1;
2200 if (this_urb->status == -EINPROGRESS) {
2201 dev_dbg(&port->dev, "%s already writing\n", __func__);
2202 mdelay(5);
2203 return -1;
2204 }
2205
2206 memset(&msg, 0, sizeof(struct keyspan_usa28_portControlMessage));
2207
2208 msg.setBaudRate = 1;
2209 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2210 &msg.baudHi, &msg.baudLo, NULL,
2211 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2212 dev_dbg(&port->dev, "%s - Invalid baud rate requested %d.\n",
2213 __func__, p_priv->baud);
2214 msg.baudLo = 0xff;
2215 msg.baudHi = 0xb2; /* Values for 9600 baud */
2216 }
2217
2218 /* If parity is enabled, we must calculate it ourselves. */
2219 msg.parity = 0; /* XXX for now */
2220
2221 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2222 msg.xonFlowControl = 0;
2223
2224 /* Do handshaking outputs, DTR is inverted relative to RTS */
2225 msg.rts = p_priv->rts_state;
2226 msg.dtr = p_priv->dtr_state;
2227
2228 msg.forwardingLength = 16;
2229 msg.forwardMs = 10;
2230 msg.breakThreshold = 45;
2231 msg.xonChar = 17;
2232 msg.xoffChar = 19;
2233
2234 /*msg.returnStatus = 1;
2235 msg.resetDataToggle = 0xff;*/
2236 /* Opening port */
2237 if (reset_port == 1) {
2238 msg._txOn = 1;
2239 msg._txOff = 0;
2240 msg.txFlush = 0;
2241 msg.txForceXoff = 0;
2242 msg.txBreak = 0;
2243 msg.rxOn = 1;
2244 msg.rxOff = 0;
2245 msg.rxFlush = 1;
2246 msg.rxForward = 0;
2247 msg.returnStatus = 0;
2248 msg.resetDataToggle = 0xff;
2249 }
2250 /* Closing port */
2251 else if (reset_port == 2) {
2252 msg._txOn = 0;
2253 msg._txOff = 1;
2254 msg.txFlush = 0;
2255 msg.txForceXoff = 0;
2256 msg.txBreak = 0;
2257 msg.rxOn = 0;
2258 msg.rxOff = 1;
2259 msg.rxFlush = 1;
2260 msg.rxForward = 0;
2261 msg.returnStatus = 0;
2262 msg.resetDataToggle = 0;
2263 }
2264 /* Sending intermediate configs */
2265 else {
2266 msg._txOn = (!p_priv->break_on);
2267 msg._txOff = 0;
2268 msg.txFlush = 0;
2269 msg.txForceXoff = 0;
2270 msg.txBreak = (p_priv->break_on);
2271 msg.rxOn = 0;
2272 msg.rxOff = 0;
2273 msg.rxFlush = 0;
2274 msg.rxForward = 0;
2275 msg.returnStatus = 0;
2276 msg.resetDataToggle = 0x0;
2277 }
2278
2279 p_priv->resend_cont = 0;
2280 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2281
2282 /* send the data out the device on control endpoint */
2283 this_urb->transfer_buffer_length = sizeof(msg);
2284
2285 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2286 if (err != 0)
2287 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed\n", __func__);
2288
2289 return 0;
2290}
2291
2292static int keyspan_usa49_send_setup(struct usb_serial *serial,
2293 struct usb_serial_port *port,
2294 int reset_port)
2295{
2296 struct keyspan_usa49_portControlMessage msg;
2297 struct usb_ctrlrequest *dr = NULL;
2298 struct keyspan_serial_private *s_priv;
2299 struct keyspan_port_private *p_priv;
2300 const struct keyspan_device_details *d_details;
2301 struct urb *this_urb;
2302 int err, device_port;
2303
2304 s_priv = usb_get_serial_data(serial);
2305 p_priv = usb_get_serial_port_data(port);
2306 d_details = s_priv->device_details;
2307
2308 this_urb = s_priv->glocont_urb;
2309
2310 /* Work out which port within the device is being setup */
2311 device_port = port->port_number;
2312
2313 /* Make sure we have an urb then send the message */
2314 if (this_urb == NULL) {
2315 dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2316 return -1;
2317 }
2318
2319 dev_dbg(&port->dev, "%s - endpoint %x (%d)\n",
2320 __func__, usb_pipeendpoint(this_urb->pipe), device_port);
2321
2322 /* Save reset port val for resend.
2323 Don't overwrite resend for open/close condition. */
2324 if ((reset_port + 1) > p_priv->resend_cont)
2325 p_priv->resend_cont = reset_port + 1;
2326
2327 if (this_urb->status == -EINPROGRESS) {
2328 /* dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2329 mdelay(5);
2330 return -1;
2331 }
2332
2333 memset(&msg, 0, sizeof(struct keyspan_usa49_portControlMessage));
2334
2335 msg.portNumber = device_port;
2336
2337 /* Only set baud rate if it's changed */
2338 if (p_priv->old_baud != p_priv->baud) {
2339 p_priv->old_baud = p_priv->baud;
2340 msg.setClocking = 0xff;
2341 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2342 &msg.baudHi, &msg.baudLo, &msg.prescaler,
2343 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2344 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2345 __func__, p_priv->baud);
2346 msg.baudLo = 0;
2347 msg.baudHi = 125; /* Values for 9600 baud */
2348 msg.prescaler = 10;
2349 }
2350 /* msg.setPrescaler = 0xff; */
2351 }
2352
2353 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2354 switch (p_priv->cflag & CSIZE) {
2355 case CS5:
2356 msg.lcr |= USA_DATABITS_5;
2357 break;
2358 case CS6:
2359 msg.lcr |= USA_DATABITS_6;
2360 break;
2361 case CS7:
2362 msg.lcr |= USA_DATABITS_7;
2363 break;
2364 case CS8:
2365 msg.lcr |= USA_DATABITS_8;
2366 break;
2367 }
2368 if (p_priv->cflag & PARENB) {
2369 /* note USA_PARITY_NONE == 0 */
2370 msg.lcr |= (p_priv->cflag & PARODD) ?
2371 USA_PARITY_ODD : USA_PARITY_EVEN;
2372 }
2373 msg.setLcr = 0xff;
2374
2375 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2376 msg.xonFlowControl = 0;
2377 msg.setFlowControl = 0xff;
2378
2379 msg.forwardingLength = 16;
2380 msg.xonChar = 17;
2381 msg.xoffChar = 19;
2382
2383 /* Opening port */
2384 if (reset_port == 1) {
2385 msg._txOn = 1;
2386 msg._txOff = 0;
2387 msg.txFlush = 0;
2388 msg.txBreak = 0;
2389 msg.rxOn = 1;
2390 msg.rxOff = 0;
2391 msg.rxFlush = 1;
2392 msg.rxForward = 0;
2393 msg.returnStatus = 0;
2394 msg.resetDataToggle = 0xff;
2395 msg.enablePort = 1;
2396 msg.disablePort = 0;
2397 }
2398 /* Closing port */
2399 else if (reset_port == 2) {
2400 msg._txOn = 0;
2401 msg._txOff = 1;
2402 msg.txFlush = 0;
2403 msg.txBreak = 0;
2404 msg.rxOn = 0;
2405 msg.rxOff = 1;
2406 msg.rxFlush = 1;
2407 msg.rxForward = 0;
2408 msg.returnStatus = 0;
2409 msg.resetDataToggle = 0;
2410 msg.enablePort = 0;
2411 msg.disablePort = 1;
2412 }
2413 /* Sending intermediate configs */
2414 else {
2415 msg._txOn = (!p_priv->break_on);
2416 msg._txOff = 0;
2417 msg.txFlush = 0;
2418 msg.txBreak = (p_priv->break_on);
2419 msg.rxOn = 0;
2420 msg.rxOff = 0;
2421 msg.rxFlush = 0;
2422 msg.rxForward = 0;
2423 msg.returnStatus = 0;
2424 msg.resetDataToggle = 0x0;
2425 msg.enablePort = 0;
2426 msg.disablePort = 0;
2427 }
2428
2429 /* Do handshaking outputs */
2430 msg.setRts = 0xff;
2431 msg.rts = p_priv->rts_state;
2432
2433 msg.setDtr = 0xff;
2434 msg.dtr = p_priv->dtr_state;
2435
2436 p_priv->resend_cont = 0;
2437
2438 /* if the device is a 49wg, we send control message on usb
2439 control EP 0 */
2440
2441 if (d_details->product_id == keyspan_usa49wg_product_id) {
2442 dr = (void *)(s_priv->ctrl_buf);
2443 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_OUT;
2444 dr->bRequest = 0xB0; /* 49wg control message */
2445 dr->wValue = 0;
2446 dr->wIndex = 0;
2447 dr->wLength = cpu_to_le16(sizeof(msg));
2448
2449 memcpy(s_priv->glocont_buf, &msg, sizeof(msg));
2450
2451 usb_fill_control_urb(this_urb, serial->dev,
2452 usb_sndctrlpipe(serial->dev, 0),
2453 (unsigned char *)dr, s_priv->glocont_buf,
2454 sizeof(msg), usa49_glocont_callback, serial);
2455
2456 } else {
2457 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2458
2459 /* send the data out the device on control endpoint */
2460 this_urb->transfer_buffer_length = sizeof(msg);
2461 }
2462 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2463 if (err != 0)
2464 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2465
2466 return 0;
2467}
2468
2469static int keyspan_usa90_send_setup(struct usb_serial *serial,
2470 struct usb_serial_port *port,
2471 int reset_port)
2472{
2473 struct keyspan_usa90_portControlMessage msg;
2474 struct keyspan_serial_private *s_priv;
2475 struct keyspan_port_private *p_priv;
2476 const struct keyspan_device_details *d_details;
2477 struct urb *this_urb;
2478 int err;
2479 u8 prescaler;
2480
2481 s_priv = usb_get_serial_data(serial);
2482 p_priv = usb_get_serial_port_data(port);
2483 d_details = s_priv->device_details;
2484
2485 /* only do something if we have a bulk out endpoint */
2486 this_urb = p_priv->outcont_urb;
2487 if (this_urb == NULL) {
2488 dev_dbg(&port->dev, "%s - oops no urb.\n", __func__);
2489 return -1;
2490 }
2491
2492 /* Save reset port val for resend.
2493 Don't overwrite resend for open/close condition. */
2494 if ((reset_port + 1) > p_priv->resend_cont)
2495 p_priv->resend_cont = reset_port + 1;
2496 if (this_urb->status == -EINPROGRESS) {
2497 dev_dbg(&port->dev, "%s already writing\n", __func__);
2498 mdelay(5);
2499 return -1;
2500 }
2501
2502 memset(&msg, 0, sizeof(struct keyspan_usa90_portControlMessage));
2503
2504 /* Only set baud rate if it's changed */
2505 if (p_priv->old_baud != p_priv->baud) {
2506 p_priv->old_baud = p_priv->baud;
2507 msg.setClocking = 0x01;
2508 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2509 &msg.baudHi, &msg.baudLo, &prescaler, 0) == KEYSPAN_INVALID_BAUD_RATE) {
2510 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2511 __func__, p_priv->baud);
2512 p_priv->baud = 9600;
2513 d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2514 &msg.baudHi, &msg.baudLo, &prescaler, 0);
2515 }
2516 msg.setRxMode = 1;
2517 msg.setTxMode = 1;
2518 }
2519
2520 /* modes must always be correctly specified */
2521 if (p_priv->baud > 57600) {
2522 msg.rxMode = RXMODE_DMA;
2523 msg.txMode = TXMODE_DMA;
2524 } else {
2525 msg.rxMode = RXMODE_BYHAND;
2526 msg.txMode = TXMODE_BYHAND;
2527 }
2528
2529 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2530 switch (p_priv->cflag & CSIZE) {
2531 case CS5:
2532 msg.lcr |= USA_DATABITS_5;
2533 break;
2534 case CS6:
2535 msg.lcr |= USA_DATABITS_6;
2536 break;
2537 case CS7:
2538 msg.lcr |= USA_DATABITS_7;
2539 break;
2540 case CS8:
2541 msg.lcr |= USA_DATABITS_8;
2542 break;
2543 }
2544 if (p_priv->cflag & PARENB) {
2545 /* note USA_PARITY_NONE == 0 */
2546 msg.lcr |= (p_priv->cflag & PARODD) ?
2547 USA_PARITY_ODD : USA_PARITY_EVEN;
2548 }
2549 if (p_priv->old_cflag != p_priv->cflag) {
2550 p_priv->old_cflag = p_priv->cflag;
2551 msg.setLcr = 0x01;
2552 }
2553
2554 if (p_priv->flow_control == flow_cts)
2555 msg.txFlowControl = TXFLOW_CTS;
2556 msg.setTxFlowControl = 0x01;
2557 msg.setRxFlowControl = 0x01;
2558
2559 msg.rxForwardingLength = 16;
2560 msg.rxForwardingTimeout = 16;
2561 msg.txAckSetting = 0;
2562 msg.xonChar = 17;
2563 msg.xoffChar = 19;
2564
2565 /* Opening port */
2566 if (reset_port == 1) {
2567 msg.portEnabled = 1;
2568 msg.rxFlush = 1;
2569 msg.txBreak = (p_priv->break_on);
2570 }
2571 /* Closing port */
2572 else if (reset_port == 2)
2573 msg.portEnabled = 0;
2574 /* Sending intermediate configs */
2575 else {
2576 msg.portEnabled = 1;
2577 msg.txBreak = (p_priv->break_on);
2578 }
2579
2580 /* Do handshaking outputs */
2581 msg.setRts = 0x01;
2582 msg.rts = p_priv->rts_state;
2583
2584 msg.setDtr = 0x01;
2585 msg.dtr = p_priv->dtr_state;
2586
2587 p_priv->resend_cont = 0;
2588 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2589
2590 /* send the data out the device on control endpoint */
2591 this_urb->transfer_buffer_length = sizeof(msg);
2592
2593 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2594 if (err != 0)
2595 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2596 return 0;
2597}
2598
2599static int keyspan_usa67_send_setup(struct usb_serial *serial,
2600 struct usb_serial_port *port,
2601 int reset_port)
2602{
2603 struct keyspan_usa67_portControlMessage msg;
2604 struct keyspan_serial_private *s_priv;
2605 struct keyspan_port_private *p_priv;
2606 const struct keyspan_device_details *d_details;
2607 struct urb *this_urb;
2608 int err, device_port;
2609
2610 s_priv = usb_get_serial_data(serial);
2611 p_priv = usb_get_serial_port_data(port);
2612 d_details = s_priv->device_details;
2613
2614 this_urb = s_priv->glocont_urb;
2615
2616 /* Work out which port within the device is being setup */
2617 device_port = port->port_number;
2618
2619 /* Make sure we have an urb then send the message */
2620 if (this_urb == NULL) {
2621 dev_dbg(&port->dev, "%s - oops no urb for port.\n", __func__);
2622 return -1;
2623 }
2624
2625 /* Save reset port val for resend.
2626 Don't overwrite resend for open/close condition. */
2627 if ((reset_port + 1) > p_priv->resend_cont)
2628 p_priv->resend_cont = reset_port + 1;
2629 if (this_urb->status == -EINPROGRESS) {
2630 /* dev_dbg(&port->dev, "%s - already writing\n", __func__); */
2631 mdelay(5);
2632 return -1;
2633 }
2634
2635 memset(&msg, 0, sizeof(struct keyspan_usa67_portControlMessage));
2636
2637 msg.port = device_port;
2638
2639 /* Only set baud rate if it's changed */
2640 if (p_priv->old_baud != p_priv->baud) {
2641 p_priv->old_baud = p_priv->baud;
2642 msg.setClocking = 0xff;
2643 if (d_details->calculate_baud_rate(port, p_priv->baud, d_details->baudclk,
2644 &msg.baudHi, &msg.baudLo, &msg.prescaler,
2645 device_port) == KEYSPAN_INVALID_BAUD_RATE) {
2646 dev_dbg(&port->dev, "%s - Invalid baud rate %d requested, using 9600.\n",
2647 __func__, p_priv->baud);
2648 msg.baudLo = 0;
2649 msg.baudHi = 125; /* Values for 9600 baud */
2650 msg.prescaler = 10;
2651 }
2652 msg.setPrescaler = 0xff;
2653 }
2654
2655 msg.lcr = (p_priv->cflag & CSTOPB) ? STOPBITS_678_2 : STOPBITS_5678_1;
2656 switch (p_priv->cflag & CSIZE) {
2657 case CS5:
2658 msg.lcr |= USA_DATABITS_5;
2659 break;
2660 case CS6:
2661 msg.lcr |= USA_DATABITS_6;
2662 break;
2663 case CS7:
2664 msg.lcr |= USA_DATABITS_7;
2665 break;
2666 case CS8:
2667 msg.lcr |= USA_DATABITS_8;
2668 break;
2669 }
2670 if (p_priv->cflag & PARENB) {
2671 /* note USA_PARITY_NONE == 0 */
2672 msg.lcr |= (p_priv->cflag & PARODD) ?
2673 USA_PARITY_ODD : USA_PARITY_EVEN;
2674 }
2675 msg.setLcr = 0xff;
2676
2677 msg.ctsFlowControl = (p_priv->flow_control == flow_cts);
2678 msg.xonFlowControl = 0;
2679 msg.setFlowControl = 0xff;
2680 msg.forwardingLength = 16;
2681 msg.xonChar = 17;
2682 msg.xoffChar = 19;
2683
2684 if (reset_port == 1) {
2685 /* Opening port */
2686 msg._txOn = 1;
2687 msg._txOff = 0;
2688 msg.txFlush = 0;
2689 msg.txBreak = 0;
2690 msg.rxOn = 1;
2691 msg.rxOff = 0;
2692 msg.rxFlush = 1;
2693 msg.rxForward = 0;
2694 msg.returnStatus = 0;
2695 msg.resetDataToggle = 0xff;
2696 } else if (reset_port == 2) {
2697 /* Closing port */
2698 msg._txOn = 0;
2699 msg._txOff = 1;
2700 msg.txFlush = 0;
2701 msg.txBreak = 0;
2702 msg.rxOn = 0;
2703 msg.rxOff = 1;
2704 msg.rxFlush = 1;
2705 msg.rxForward = 0;
2706 msg.returnStatus = 0;
2707 msg.resetDataToggle = 0;
2708 } else {
2709 /* Sending intermediate configs */
2710 msg._txOn = (!p_priv->break_on);
2711 msg._txOff = 0;
2712 msg.txFlush = 0;
2713 msg.txBreak = (p_priv->break_on);
2714 msg.rxOn = 0;
2715 msg.rxOff = 0;
2716 msg.rxFlush = 0;
2717 msg.rxForward = 0;
2718 msg.returnStatus = 0;
2719 msg.resetDataToggle = 0x0;
2720 }
2721
2722 /* Do handshaking outputs */
2723 msg.setTxTriState_setRts = 0xff;
2724 msg.txTriState_rts = p_priv->rts_state;
2725
2726 msg.setHskoa_setDtr = 0xff;
2727 msg.hskoa_dtr = p_priv->dtr_state;
2728
2729 p_priv->resend_cont = 0;
2730
2731 memcpy(this_urb->transfer_buffer, &msg, sizeof(msg));
2732
2733 /* send the data out the device on control endpoint */
2734 this_urb->transfer_buffer_length = sizeof(msg);
2735
2736 err = usb_submit_urb(this_urb, GFP_ATOMIC);
2737 if (err != 0)
2738 dev_dbg(&port->dev, "%s - usb_submit_urb(setup) failed (%d)\n", __func__, err);
2739 return 0;
2740}
2741
2742static void keyspan_send_setup(struct usb_serial_port *port, int reset_port)
2743{
2744 struct usb_serial *serial = port->serial;
2745 struct keyspan_serial_private *s_priv;
2746 const struct keyspan_device_details *d_details;
2747
2748 s_priv = usb_get_serial_data(serial);
2749 d_details = s_priv->device_details;
2750
2751 switch (d_details->msg_format) {
2752 case msg_usa26:
2753 keyspan_usa26_send_setup(serial, port, reset_port);
2754 break;
2755 case msg_usa28:
2756 keyspan_usa28_send_setup(serial, port, reset_port);
2757 break;
2758 case msg_usa49:
2759 keyspan_usa49_send_setup(serial, port, reset_port);
2760 break;
2761 case msg_usa90:
2762 keyspan_usa90_send_setup(serial, port, reset_port);
2763 break;
2764 case msg_usa67:
2765 keyspan_usa67_send_setup(serial, port, reset_port);
2766 break;
2767 }
2768}
2769
2770
2771/* Gets called by the "real" driver (ie once firmware is loaded
2772 and renumeration has taken place. */
2773static int keyspan_startup(struct usb_serial *serial)
2774{
2775 int i, err;
2776 struct keyspan_serial_private *s_priv;
2777 const struct keyspan_device_details *d_details;
2778
2779 for (i = 0; (d_details = keyspan_devices[i]) != NULL; ++i)
2780 if (d_details->product_id ==
2781 le16_to_cpu(serial->dev->descriptor.idProduct))
2782 break;
2783 if (d_details == NULL) {
2784 dev_err(&serial->dev->dev, "%s - unknown product id %x\n",
2785 __func__, le16_to_cpu(serial->dev->descriptor.idProduct));
2786 return -ENODEV;
2787 }
2788
2789 /* Setup private data for serial driver */
2790 s_priv = kzalloc(sizeof(struct keyspan_serial_private), GFP_KERNEL);
2791 if (!s_priv)
2792 return -ENOMEM;
2793
2794 s_priv->instat_buf = kzalloc(INSTAT_BUFLEN, GFP_KERNEL);
2795 if (!s_priv->instat_buf)
2796 goto err_instat_buf;
2797
2798 s_priv->indat_buf = kzalloc(INDAT49W_BUFLEN, GFP_KERNEL);
2799 if (!s_priv->indat_buf)
2800 goto err_indat_buf;
2801
2802 s_priv->glocont_buf = kzalloc(GLOCONT_BUFLEN, GFP_KERNEL);
2803 if (!s_priv->glocont_buf)
2804 goto err_glocont_buf;
2805
2806 s_priv->ctrl_buf = kzalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
2807 if (!s_priv->ctrl_buf)
2808 goto err_ctrl_buf;
2809
2810 s_priv->device_details = d_details;
2811 usb_set_serial_data(serial, s_priv);
2812
2813 keyspan_setup_urbs(serial);
2814
2815 if (s_priv->instat_urb != NULL) {
2816 err = usb_submit_urb(s_priv->instat_urb, GFP_KERNEL);
2817 if (err != 0)
2818 dev_dbg(&serial->dev->dev, "%s - submit instat urb failed %d\n", __func__, err);
2819 }
2820 if (s_priv->indat_urb != NULL) {
2821 err = usb_submit_urb(s_priv->indat_urb, GFP_KERNEL);
2822 if (err != 0)
2823 dev_dbg(&serial->dev->dev, "%s - submit indat urb failed %d\n", __func__, err);
2824 }
2825
2826 return 0;
2827
2828err_ctrl_buf:
2829 kfree(s_priv->glocont_buf);
2830err_glocont_buf:
2831 kfree(s_priv->indat_buf);
2832err_indat_buf:
2833 kfree(s_priv->instat_buf);
2834err_instat_buf:
2835 kfree(s_priv);
2836
2837 return -ENOMEM;
2838}
2839
2840static void keyspan_disconnect(struct usb_serial *serial)
2841{
2842 struct keyspan_serial_private *s_priv;
2843
2844 s_priv = usb_get_serial_data(serial);
2845
2846 usb_kill_urb(s_priv->instat_urb);
2847 usb_kill_urb(s_priv->glocont_urb);
2848 usb_kill_urb(s_priv->indat_urb);
2849}
2850
2851static void keyspan_release(struct usb_serial *serial)
2852{
2853 struct keyspan_serial_private *s_priv;
2854
2855 s_priv = usb_get_serial_data(serial);
2856
2857 /* Make sure to unlink the URBs submitted in attach. */
2858 usb_kill_urb(s_priv->instat_urb);
2859 usb_kill_urb(s_priv->indat_urb);
2860
2861 usb_free_urb(s_priv->instat_urb);
2862 usb_free_urb(s_priv->indat_urb);
2863 usb_free_urb(s_priv->glocont_urb);
2864
2865 kfree(s_priv->ctrl_buf);
2866 kfree(s_priv->glocont_buf);
2867 kfree(s_priv->indat_buf);
2868 kfree(s_priv->instat_buf);
2869
2870 kfree(s_priv);
2871}
2872
2873static int keyspan_port_probe(struct usb_serial_port *port)
2874{
2875 struct usb_serial *serial = port->serial;
2876 struct keyspan_serial_private *s_priv;
2877 struct keyspan_port_private *p_priv;
2878 const struct keyspan_device_details *d_details;
2879 struct callbacks *cback;
2880 int endp;
2881 int port_num;
2882 int i;
2883
2884 s_priv = usb_get_serial_data(serial);
2885 d_details = s_priv->device_details;
2886
2887 p_priv = kzalloc(sizeof(*p_priv), GFP_KERNEL);
2888 if (!p_priv)
2889 return -ENOMEM;
2890
2891 for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i) {
2892 p_priv->in_buffer[i] = kzalloc(IN_BUFLEN, GFP_KERNEL);
2893 if (!p_priv->in_buffer[i])
2894 goto err_free_in_buffer;
2895 }
2896
2897 for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i) {
2898 p_priv->out_buffer[i] = kzalloc(OUT_BUFLEN, GFP_KERNEL);
2899 if (!p_priv->out_buffer[i])
2900 goto err_free_out_buffer;
2901 }
2902
2903 p_priv->inack_buffer = kzalloc(INACK_BUFLEN, GFP_KERNEL);
2904 if (!p_priv->inack_buffer)
2905 goto err_free_out_buffer;
2906
2907 p_priv->outcont_buffer = kzalloc(OUTCONT_BUFLEN, GFP_KERNEL);
2908 if (!p_priv->outcont_buffer)
2909 goto err_free_inack_buffer;
2910
2911 p_priv->device_details = d_details;
2912
2913 /* Setup values for the various callback routines */
2914 cback = &keyspan_callbacks[d_details->msg_format];
2915
2916 port_num = port->port_number;
2917
2918 /* Do indat endpoints first, once for each flip */
2919 endp = d_details->indat_endpoints[port_num];
2920 for (i = 0; i <= d_details->indat_endp_flip; ++i, ++endp) {
2921 p_priv->in_urbs[i] = keyspan_setup_urb(serial, endp,
2922 USB_DIR_IN, port,
2923 p_priv->in_buffer[i],
2924 IN_BUFLEN,
2925 cback->indat_callback);
2926 }
2927 /* outdat endpoints also have flip */
2928 endp = d_details->outdat_endpoints[port_num];
2929 for (i = 0; i <= d_details->outdat_endp_flip; ++i, ++endp) {
2930 p_priv->out_urbs[i] = keyspan_setup_urb(serial, endp,
2931 USB_DIR_OUT, port,
2932 p_priv->out_buffer[i],
2933 OUT_BUFLEN,
2934 cback->outdat_callback);
2935 }
2936 /* inack endpoint */
2937 p_priv->inack_urb = keyspan_setup_urb(serial,
2938 d_details->inack_endpoints[port_num],
2939 USB_DIR_IN, port,
2940 p_priv->inack_buffer,
2941 INACK_BUFLEN,
2942 cback->inack_callback);
2943 /* outcont endpoint */
2944 p_priv->outcont_urb = keyspan_setup_urb(serial,
2945 d_details->outcont_endpoints[port_num],
2946 USB_DIR_OUT, port,
2947 p_priv->outcont_buffer,
2948 OUTCONT_BUFLEN,
2949 cback->outcont_callback);
2950
2951 usb_set_serial_port_data(port, p_priv);
2952
2953 return 0;
2954
2955err_free_inack_buffer:
2956 kfree(p_priv->inack_buffer);
2957err_free_out_buffer:
2958 for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
2959 kfree(p_priv->out_buffer[i]);
2960err_free_in_buffer:
2961 for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
2962 kfree(p_priv->in_buffer[i]);
2963 kfree(p_priv);
2964
2965 return -ENOMEM;
2966}
2967
2968static void keyspan_port_remove(struct usb_serial_port *port)
2969{
2970 struct keyspan_port_private *p_priv;
2971 int i;
2972
2973 p_priv = usb_get_serial_port_data(port);
2974
2975 usb_kill_urb(p_priv->inack_urb);
2976 usb_kill_urb(p_priv->outcont_urb);
2977 for (i = 0; i < 2; i++) {
2978 usb_kill_urb(p_priv->in_urbs[i]);
2979 usb_kill_urb(p_priv->out_urbs[i]);
2980 }
2981
2982 usb_free_urb(p_priv->inack_urb);
2983 usb_free_urb(p_priv->outcont_urb);
2984 for (i = 0; i < 2; i++) {
2985 usb_free_urb(p_priv->in_urbs[i]);
2986 usb_free_urb(p_priv->out_urbs[i]);
2987 }
2988
2989 kfree(p_priv->outcont_buffer);
2990 kfree(p_priv->inack_buffer);
2991 for (i = 0; i < ARRAY_SIZE(p_priv->out_buffer); ++i)
2992 kfree(p_priv->out_buffer[i]);
2993 for (i = 0; i < ARRAY_SIZE(p_priv->in_buffer); ++i)
2994 kfree(p_priv->in_buffer[i]);
2995
2996 kfree(p_priv);
2997}
2998
2999/* Structs for the devices, pre and post renumeration. */
3000static struct usb_serial_driver keyspan_pre_device = {
3001 .driver = {
3002 .owner = THIS_MODULE,
3003 .name = "keyspan_no_firm",
3004 },
3005 .description = "Keyspan - (without firmware)",
3006 .id_table = keyspan_pre_ids,
3007 .num_ports = 1,
3008 .attach = keyspan_fake_startup,
3009};
3010
3011static struct usb_serial_driver keyspan_1port_device = {
3012 .driver = {
3013 .owner = THIS_MODULE,
3014 .name = "keyspan_1",
3015 },
3016 .description = "Keyspan 1 port adapter",
3017 .id_table = keyspan_1port_ids,
3018 .num_ports = 1,
3019 .open = keyspan_open,
3020 .close = keyspan_close,
3021 .dtr_rts = keyspan_dtr_rts,
3022 .write = keyspan_write,
3023 .write_room = keyspan_write_room,
3024 .set_termios = keyspan_set_termios,
3025 .break_ctl = keyspan_break_ctl,
3026 .tiocmget = keyspan_tiocmget,
3027 .tiocmset = keyspan_tiocmset,
3028 .attach = keyspan_startup,
3029 .disconnect = keyspan_disconnect,
3030 .release = keyspan_release,
3031 .port_probe = keyspan_port_probe,
3032 .port_remove = keyspan_port_remove,
3033};
3034
3035static struct usb_serial_driver keyspan_2port_device = {
3036 .driver = {
3037 .owner = THIS_MODULE,
3038 .name = "keyspan_2",
3039 },
3040 .description = "Keyspan 2 port adapter",
3041 .id_table = keyspan_2port_ids,
3042 .num_ports = 2,
3043 .open = keyspan_open,
3044 .close = keyspan_close,
3045 .dtr_rts = keyspan_dtr_rts,
3046 .write = keyspan_write,
3047 .write_room = keyspan_write_room,
3048 .set_termios = keyspan_set_termios,
3049 .break_ctl = keyspan_break_ctl,
3050 .tiocmget = keyspan_tiocmget,
3051 .tiocmset = keyspan_tiocmset,
3052 .attach = keyspan_startup,
3053 .disconnect = keyspan_disconnect,
3054 .release = keyspan_release,
3055 .port_probe = keyspan_port_probe,
3056 .port_remove = keyspan_port_remove,
3057};
3058
3059static struct usb_serial_driver keyspan_4port_device = {
3060 .driver = {
3061 .owner = THIS_MODULE,
3062 .name = "keyspan_4",
3063 },
3064 .description = "Keyspan 4 port adapter",
3065 .id_table = keyspan_4port_ids,
3066 .num_ports = 4,
3067 .open = keyspan_open,
3068 .close = keyspan_close,
3069 .dtr_rts = keyspan_dtr_rts,
3070 .write = keyspan_write,
3071 .write_room = keyspan_write_room,
3072 .set_termios = keyspan_set_termios,
3073 .break_ctl = keyspan_break_ctl,
3074 .tiocmget = keyspan_tiocmget,
3075 .tiocmset = keyspan_tiocmset,
3076 .attach = keyspan_startup,
3077 .disconnect = keyspan_disconnect,
3078 .release = keyspan_release,
3079 .port_probe = keyspan_port_probe,
3080 .port_remove = keyspan_port_remove,
3081};
3082
3083static struct usb_serial_driver * const serial_drivers[] = {
3084 &keyspan_pre_device, &keyspan_1port_device,
3085 &keyspan_2port_device, &keyspan_4port_device, NULL
3086};
3087
3088module_usb_serial_driver(serial_drivers, keyspan_ids_combined);
3089
3090MODULE_AUTHOR(DRIVER_AUTHOR);
3091MODULE_DESCRIPTION(DRIVER_DESC);
3092MODULE_LICENSE("GPL");
3093
3094MODULE_FIRMWARE("keyspan/usa28.fw");
3095MODULE_FIRMWARE("keyspan/usa28x.fw");
3096MODULE_FIRMWARE("keyspan/usa28xa.fw");
3097MODULE_FIRMWARE("keyspan/usa28xb.fw");
3098MODULE_FIRMWARE("keyspan/usa19.fw");
3099MODULE_FIRMWARE("keyspan/usa19qi.fw");
3100MODULE_FIRMWARE("keyspan/mpr.fw");
3101MODULE_FIRMWARE("keyspan/usa19qw.fw");
3102MODULE_FIRMWARE("keyspan/usa18x.fw");
3103MODULE_FIRMWARE("keyspan/usa19w.fw");
3104MODULE_FIRMWARE("keyspan/usa49w.fw");
3105MODULE_FIRMWARE("keyspan/usa49wlc.fw");