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