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