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