xref: /freebsd/sys/dev/usb/serial/uftdi.c (revision 6829dae12bb055451fa467da4589c43bd03b1e64)
1 /*	$NetBSD: uftdi.c,v 1.13 2002/09/23 05:51:23 simonb Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
5  *
6  * Copyright (c) 2000 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Lennart Augustsson (lennart@augustsson.net).
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 /*
38  * NOTE: all function names beginning like "uftdi_cfg_" can only
39  * be called from within the config thread function !
40  */
41 
42 /*
43  * FTDI FT232x, FT2232x, FT4232x, FT8U100AX and FT8U232xM serial adapters.
44  *
45  * Note that we specifically do not do a reset or otherwise alter the state of
46  * the chip during attach, detach, open, and close, because it could be
47  * pre-initialized (via an attached serial eeprom) to power-on into a mode such
48  * as bitbang in which the pins are being driven to a specific state which we
49  * must not perturb.  The device gets reset at power-on, and doesn't need to be
50  * reset again after that to function, except as directed by ioctl() calls.
51  */
52 
53 #include <sys/stdint.h>
54 #include <sys/stddef.h>
55 #include <sys/param.h>
56 #include <sys/queue.h>
57 #include <sys/types.h>
58 #include <sys/systm.h>
59 #include <sys/kernel.h>
60 #include <sys/bus.h>
61 #include <sys/module.h>
62 #include <sys/lock.h>
63 #include <sys/mutex.h>
64 #include <sys/condvar.h>
65 #include <sys/sysctl.h>
66 #include <sys/sx.h>
67 #include <sys/unistd.h>
68 #include <sys/callout.h>
69 #include <sys/malloc.h>
70 #include <sys/priv.h>
71 
72 #include <dev/usb/usb.h>
73 #include <dev/usb/usbdi.h>
74 #include <dev/usb/usbdi_util.h>
75 #include <dev/usb/usb_core.h>
76 #include <dev/usb/usb_ioctl.h>
77 #include "usbdevs.h"
78 
79 #define	USB_DEBUG_VAR uftdi_debug
80 #include <dev/usb/usb_debug.h>
81 #include <dev/usb/usb_process.h>
82 
83 #include <dev/usb/serial/usb_serial.h>
84 #include <dev/usb/serial/uftdi_reg.h>
85 #include <dev/usb/uftdiio.h>
86 
87 static SYSCTL_NODE(_hw_usb, OID_AUTO, uftdi, CTLFLAG_RW, 0, "USB uftdi");
88 
89 #ifdef USB_DEBUG
90 static int uftdi_debug = 0;
91 SYSCTL_INT(_hw_usb_uftdi, OID_AUTO, debug, CTLFLAG_RWTUN,
92     &uftdi_debug, 0, "Debug level");
93 #endif
94 
95 #define	UFTDI_CONFIG_INDEX	0
96 
97 /*
98  * IO buffer sizes and FTDI device procotol sizes.
99  *
100  * Note that the output packet size in the following defines is not the usb
101  * protocol packet size based on bus speed, it is the size dictated by the FTDI
102  * device itself, and is used only on older chips.
103  *
104  * We allocate buffers bigger than the hardware's packet size, and process
105  * multiple packets within each buffer.  This allows the controller to make
106  * optimal use of the usb bus by conducting multiple transfers with the device
107  * during a single bus timeslice to fill or drain the chip's fifos.
108  *
109  * The output data on newer chips has no packet header, and we are able to pack
110  * any number of output bytes into a buffer.  On some older chips, each output
111  * packet contains a 1-byte header and up to 63 bytes of payload.  The size is
112  * encoded in 6 bits of the header, hence the 64-byte limit on packet size.  We
113  * loop to fill the buffer with many of these header+payload packets.
114  *
115  * The input data on all chips consists of packets which contain a 2-byte header
116  * followed by data payload.  The total size of the packet is wMaxPacketSize
117  * which can change based on the bus speed (e.g., 64 for full speed, 512 for
118  * high speed).  We loop to extract the headers and payloads from the packets
119  * packed into an input buffer.
120  */
121 #define	UFTDI_IBUFSIZE	2048
122 #define	UFTDI_IHDRSIZE	   2
123 #define	UFTDI_OBUFSIZE	2048
124 #define	UFTDI_OPKTSIZE	  64
125 
126 enum {
127 	UFTDI_BULK_DT_WR,
128 	UFTDI_BULK_DT_RD,
129 	UFTDI_N_TRANSFER,
130 };
131 
132 enum {
133 	DEVT_SIO,
134 	DEVT_232A,
135 	DEVT_232B,
136 	DEVT_2232D,	/* Includes 2232C */
137 	DEVT_232R,
138 	DEVT_2232H,
139 	DEVT_4232H,
140 	DEVT_232H,
141 	DEVT_230X,
142 };
143 
144 #define	DEVF_BAUDBITS_HINDEX	0x01	/* Baud bits in high byte of index. */
145 #define	DEVF_BAUDCLK_12M	0X02	/* Base baud clock is 12MHz. */
146 
147 struct uftdi_softc {
148 	struct ucom_super_softc sc_super_ucom;
149 	struct ucom_softc sc_ucom;
150 
151 	struct usb_device *sc_udev;
152 	struct usb_xfer *sc_xfer[UFTDI_N_TRANSFER];
153 	device_t sc_dev;
154 	struct mtx sc_mtx;
155 
156 	uint32_t sc_unit;
157 
158 	uint16_t sc_last_lcr;
159 	uint16_t sc_bcdDevice;
160 
161 	uint8_t sc_devtype;
162 	uint8_t sc_devflags;
163 	uint8_t	sc_hdrlen;
164 	uint8_t	sc_msr;
165 	uint8_t	sc_lsr;
166 	uint8_t sc_bitmode;
167 };
168 
169 struct uftdi_param_config {
170 	uint16_t baud_lobits;
171 	uint16_t baud_hibits;
172 	uint16_t lcr;
173 	uint8_t	v_start;
174 	uint8_t	v_stop;
175 	uint8_t	v_flow;
176 };
177 
178 /* prototypes */
179 
180 static device_probe_t uftdi_probe;
181 static device_attach_t uftdi_attach;
182 static device_detach_t uftdi_detach;
183 static void uftdi_free_softc(struct uftdi_softc *);
184 
185 static usb_callback_t uftdi_write_callback;
186 static usb_callback_t uftdi_read_callback;
187 
188 static void	uftdi_free(struct ucom_softc *);
189 static void	uftdi_cfg_open(struct ucom_softc *);
190 static void	uftdi_cfg_close(struct ucom_softc *);
191 static void	uftdi_cfg_set_dtr(struct ucom_softc *, uint8_t);
192 static void	uftdi_cfg_set_rts(struct ucom_softc *, uint8_t);
193 static void	uftdi_cfg_set_break(struct ucom_softc *, uint8_t);
194 static int	uftdi_set_parm_soft(struct ucom_softc *, struct termios *,
195 		    struct uftdi_param_config *);
196 static int	uftdi_pre_param(struct ucom_softc *, struct termios *);
197 static void	uftdi_cfg_param(struct ucom_softc *, struct termios *);
198 static void	uftdi_cfg_get_status(struct ucom_softc *, uint8_t *,
199 		    uint8_t *);
200 static int	uftdi_reset(struct ucom_softc *, int);
201 static int	uftdi_set_bitmode(struct ucom_softc *, uint8_t, uint8_t);
202 static int	uftdi_get_bitmode(struct ucom_softc *, uint8_t *, uint8_t *);
203 static int	uftdi_set_latency(struct ucom_softc *, int);
204 static int	uftdi_get_latency(struct ucom_softc *, int *);
205 static int	uftdi_set_event_char(struct ucom_softc *, int);
206 static int	uftdi_set_error_char(struct ucom_softc *, int);
207 static int	uftdi_ioctl(struct ucom_softc *, uint32_t, caddr_t, int,
208 		    struct thread *);
209 static void	uftdi_start_read(struct ucom_softc *);
210 static void	uftdi_stop_read(struct ucom_softc *);
211 static void	uftdi_start_write(struct ucom_softc *);
212 static void	uftdi_stop_write(struct ucom_softc *);
213 static void	uftdi_poll(struct ucom_softc *ucom);
214 
215 static const struct usb_config uftdi_config[UFTDI_N_TRANSFER] = {
216 
217 	[UFTDI_BULK_DT_WR] = {
218 		.type = UE_BULK,
219 		.endpoint = UE_ADDR_ANY,
220 		.direction = UE_DIR_OUT,
221 		.bufsize = UFTDI_OBUFSIZE,
222 		.flags = {.pipe_bof = 1,},
223 		.callback = &uftdi_write_callback,
224 	},
225 
226 	[UFTDI_BULK_DT_RD] = {
227 		.type = UE_BULK,
228 		.endpoint = UE_ADDR_ANY,
229 		.direction = UE_DIR_IN,
230 		.bufsize = UFTDI_IBUFSIZE,
231 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
232 		.callback = &uftdi_read_callback,
233 	},
234 };
235 
236 static const struct ucom_callback uftdi_callback = {
237 	.ucom_cfg_get_status = &uftdi_cfg_get_status,
238 	.ucom_cfg_set_dtr = &uftdi_cfg_set_dtr,
239 	.ucom_cfg_set_rts = &uftdi_cfg_set_rts,
240 	.ucom_cfg_set_break = &uftdi_cfg_set_break,
241 	.ucom_cfg_param = &uftdi_cfg_param,
242 	.ucom_cfg_open = &uftdi_cfg_open,
243 	.ucom_cfg_close = &uftdi_cfg_close,
244 	.ucom_pre_param = &uftdi_pre_param,
245 	.ucom_ioctl = &uftdi_ioctl,
246 	.ucom_start_read = &uftdi_start_read,
247 	.ucom_stop_read = &uftdi_stop_read,
248 	.ucom_start_write = &uftdi_start_write,
249 	.ucom_stop_write = &uftdi_stop_write,
250 	.ucom_poll = &uftdi_poll,
251 	.ucom_free = &uftdi_free,
252 };
253 
254 static device_method_t uftdi_methods[] = {
255 	/* Device interface */
256 	DEVMETHOD(device_probe, uftdi_probe),
257 	DEVMETHOD(device_attach, uftdi_attach),
258 	DEVMETHOD(device_detach, uftdi_detach),
259 	DEVMETHOD_END
260 };
261 
262 static devclass_t uftdi_devclass;
263 
264 static driver_t uftdi_driver = {
265 	.name = "uftdi",
266 	.methods = uftdi_methods,
267 	.size = sizeof(struct uftdi_softc),
268 };
269 
270 static const STRUCT_USB_HOST_ID uftdi_devs[] = {
271 #define	UFTDI_DEV(v, p, i) \
272   { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
273 	UFTDI_DEV(ACTON, SPECTRAPRO, 0),
274 	UFTDI_DEV(ALTI2, N3, 0),
275 	UFTDI_DEV(ANALOGDEVICES, GNICE, UFTDI_JTAG_IFACE(0)),
276 	UFTDI_DEV(ANALOGDEVICES, GNICEPLUS, UFTDI_JTAG_IFACE(0)),
277 	UFTDI_DEV(ATMEL, STK541, 0),
278 	UFTDI_DEV(BAYER, CONTOUR_CABLE, 0),
279 	UFTDI_DEV(BBELECTRONICS, 232USB9M, 0),
280 	UFTDI_DEV(BBELECTRONICS, 485USB9F_2W, 0),
281 	UFTDI_DEV(BBELECTRONICS, 485USB9F_4W, 0),
282 	UFTDI_DEV(BBELECTRONICS, 485USBTB_2W, 0),
283 	UFTDI_DEV(BBELECTRONICS, 485USBTB_4W, 0),
284 	UFTDI_DEV(BBELECTRONICS, TTL3USB9M, 0),
285 	UFTDI_DEV(BBELECTRONICS, TTL5USB9M, 0),
286 	UFTDI_DEV(BBELECTRONICS, USO9ML2, 0),
287 	UFTDI_DEV(BBELECTRONICS, USO9ML2DR, 0),
288 	UFTDI_DEV(BBELECTRONICS, USO9ML2DR_2, 0),
289 	UFTDI_DEV(BBELECTRONICS, USOPTL4, 0),
290 	UFTDI_DEV(BBELECTRONICS, USOPTL4DR, 0),
291 	UFTDI_DEV(BBELECTRONICS, USOPTL4DR2, 0),
292 	UFTDI_DEV(BBELECTRONICS, USOTL4, 0),
293 	UFTDI_DEV(BBELECTRONICS, USPTL4, 0),
294 	UFTDI_DEV(BBELECTRONICS, USTL4, 0),
295 	UFTDI_DEV(BBELECTRONICS, ZZ_PROG1_USB, 0),
296 	UFTDI_DEV(CONTEC, COM1USBH, 0),
297 	UFTDI_DEV(DRESDENELEKTRONIK, SENSORTERMINALBOARD, 0),
298 	UFTDI_DEV(DRESDENELEKTRONIK, WIRELESSHANDHELDTERMINAL, 0),
299 	UFTDI_DEV(DRESDENELEKTRONIK, DE_RFNODE, 0),
300 	UFTDI_DEV(DRESDENELEKTRONIK, LEVELSHIFTERSTICKLOWCOST, 0),
301 	UFTDI_DEV(ELEKTOR, FT323R, 0),
302 	UFTDI_DEV(EVOLUTION, ER1, 0),
303 	UFTDI_DEV(EVOLUTION, HYBRID, 0),
304 	UFTDI_DEV(EVOLUTION, RCM4, 0),
305 	UFTDI_DEV(FALCOM, SAMBA, 0),
306 	UFTDI_DEV(FALCOM, TWIST, 0),
307 	UFTDI_DEV(FIC, NEO1973_DEBUG, UFTDI_JTAG_IFACE(0)),
308 	UFTDI_DEV(FIC, NEO1973_DEBUG, UFTDI_JTAG_IFACE(0)),
309 	UFTDI_DEV(FTDI, 232EX, 0),
310 	UFTDI_DEV(FTDI, 232H, 0),
311 	UFTDI_DEV(FTDI, 232RL, 0),
312 	UFTDI_DEV(FTDI, 4N_GALAXY_DE_1, 0),
313 	UFTDI_DEV(FTDI, 4N_GALAXY_DE_2, 0),
314 	UFTDI_DEV(FTDI, 4N_GALAXY_DE_3, 0),
315 	UFTDI_DEV(FTDI, 8U232AM_ALT, 0),
316 	UFTDI_DEV(FTDI, ACCESSO, 0),
317 	UFTDI_DEV(FTDI, ACG_HFDUAL, 0),
318 	UFTDI_DEV(FTDI, ACTIVE_ROBOTS, 0),
319 	UFTDI_DEV(FTDI, ACTZWAVE, 0),
320 	UFTDI_DEV(FTDI, AMC232, 0),
321 	UFTDI_DEV(FTDI, ARTEMIS, 0),
322 	UFTDI_DEV(FTDI, ASK_RDR400, 0),
323 	UFTDI_DEV(FTDI, ATIK_ATK16, 0),
324 	UFTDI_DEV(FTDI, ATIK_ATK16C, 0),
325 	UFTDI_DEV(FTDI, ATIK_ATK16HR, 0),
326 	UFTDI_DEV(FTDI, ATIK_ATK16HRC, 0),
327 	UFTDI_DEV(FTDI, ATIK_ATK16IC, 0),
328 	UFTDI_DEV(FTDI, BCS_SE923, 0),
329 	UFTDI_DEV(FTDI, CANDAPTER, 0),
330 	UFTDI_DEV(FTDI, CANUSB, 0),
331 	UFTDI_DEV(FTDI, CCSICDU20_0, 0),
332 	UFTDI_DEV(FTDI, CCSICDU40_1, 0),
333 	UFTDI_DEV(FTDI, CCSICDU64_4, 0),
334 	UFTDI_DEV(FTDI, CCSLOAD_N_GO_3, 0),
335 	UFTDI_DEV(FTDI, CCSMACHX_2, 0),
336 	UFTDI_DEV(FTDI, CCSPRIME8_5, 0),
337 	UFTDI_DEV(FTDI, CFA_631, 0),
338 	UFTDI_DEV(FTDI, CFA_632, 0),
339 	UFTDI_DEV(FTDI, CFA_633, 0),
340 	UFTDI_DEV(FTDI, CFA_634, 0),
341 	UFTDI_DEV(FTDI, CFA_635, 0),
342 	UFTDI_DEV(FTDI, CHAMSYS_24_MASTER_WING, 0),
343 	UFTDI_DEV(FTDI, CHAMSYS_MAXI_WING, 0),
344 	UFTDI_DEV(FTDI, CHAMSYS_MEDIA_WING, 0),
345 	UFTDI_DEV(FTDI, CHAMSYS_MIDI_TIMECODE, 0),
346 	UFTDI_DEV(FTDI, CHAMSYS_MINI_WING, 0),
347 	UFTDI_DEV(FTDI, CHAMSYS_PC_WING, 0),
348 	UFTDI_DEV(FTDI, CHAMSYS_USB_DMX, 0),
349 	UFTDI_DEV(FTDI, CHAMSYS_WING, 0),
350 	UFTDI_DEV(FTDI, COM4SM, 0),
351 	UFTDI_DEV(FTDI, CONVERTER_0, 0),
352 	UFTDI_DEV(FTDI, CONVERTER_1, 0),
353 	UFTDI_DEV(FTDI, CONVERTER_2, 0),
354 	UFTDI_DEV(FTDI, CONVERTER_3, 0),
355 	UFTDI_DEV(FTDI, CONVERTER_4, 0),
356 	UFTDI_DEV(FTDI, CONVERTER_5, 0),
357 	UFTDI_DEV(FTDI, CONVERTER_6, 0),
358 	UFTDI_DEV(FTDI, CONVERTER_7, 0),
359 	UFTDI_DEV(FTDI, CTI_USB_MINI_485, 0),
360 	UFTDI_DEV(FTDI, CTI_USB_NANO_485, 0),
361 	UFTDI_DEV(FTDI, DMX4ALL, 0),
362 	UFTDI_DEV(FTDI, DOMINTELL_DGQG, 0),
363 	UFTDI_DEV(FTDI, DOMINTELL_DUSB, 0),
364 	UFTDI_DEV(FTDI, DOTEC, 0),
365 	UFTDI_DEV(FTDI, ECLO_COM_1WIRE, 0),
366 	UFTDI_DEV(FTDI, ECO_PRO_CDS, 0),
367 	UFTDI_DEV(FTDI, EISCOU, 0),
368 	UFTDI_DEV(FTDI, ELSTER_UNICOM, 0),
369 	UFTDI_DEV(FTDI, ELV_ALC8500, 0),
370 	UFTDI_DEV(FTDI, ELV_CLI7000, 0),
371 	UFTDI_DEV(FTDI, ELV_CSI8, 0),
372 	UFTDI_DEV(FTDI, ELV_EC3000, 0),
373 	UFTDI_DEV(FTDI, ELV_EM1000DL, 0),
374 	UFTDI_DEV(FTDI, ELV_EM1010PC, 0),
375 	UFTDI_DEV(FTDI, ELV_FEM, 0),
376 	UFTDI_DEV(FTDI, ELV_FHZ1000PC, 0),
377 	UFTDI_DEV(FTDI, ELV_FHZ1300PC, 0),
378 	UFTDI_DEV(FTDI, ELV_FM3RX, 0),
379 	UFTDI_DEV(FTDI, ELV_FS20SIG, 0),
380 	UFTDI_DEV(FTDI, ELV_HS485, 0),
381 	UFTDI_DEV(FTDI, ELV_KL100, 0),
382 	UFTDI_DEV(FTDI, ELV_MSM1, 0),
383 	UFTDI_DEV(FTDI, ELV_PCD200, 0),
384 	UFTDI_DEV(FTDI, ELV_PCK100, 0),
385 	UFTDI_DEV(FTDI, ELV_PPS7330, 0),
386 	UFTDI_DEV(FTDI, ELV_RFP500, 0),
387 	UFTDI_DEV(FTDI, ELV_T1100, 0),
388 	UFTDI_DEV(FTDI, ELV_TFD128, 0),
389 	UFTDI_DEV(FTDI, ELV_TFM100, 0),
390 	UFTDI_DEV(FTDI, ELV_TWS550, 0),
391 	UFTDI_DEV(FTDI, ELV_UAD8, 0),
392 	UFTDI_DEV(FTDI, ELV_UDA7, 0),
393 	UFTDI_DEV(FTDI, ELV_UDF77, 0),
394 	UFTDI_DEV(FTDI, ELV_UIO88, 0),
395 	UFTDI_DEV(FTDI, ELV_ULA200, 0),
396 	UFTDI_DEV(FTDI, ELV_UM100, 0),
397 	UFTDI_DEV(FTDI, ELV_UMS100, 0),
398 	UFTDI_DEV(FTDI, ELV_UO100, 0),
399 	UFTDI_DEV(FTDI, ELV_UR100, 0),
400 	UFTDI_DEV(FTDI, ELV_USI2, 0),
401 	UFTDI_DEV(FTDI, ELV_USR, 0),
402 	UFTDI_DEV(FTDI, ELV_UTP8, 0),
403 	UFTDI_DEV(FTDI, ELV_WS300PC, 0),
404 	UFTDI_DEV(FTDI, ELV_WS444PC, 0),
405 	UFTDI_DEV(FTDI, ELV_WS500, 0),
406 	UFTDI_DEV(FTDI, ELV_WS550, 0),
407 	UFTDI_DEV(FTDI, ELV_WS777, 0),
408 	UFTDI_DEV(FTDI, ELV_WS888, 0),
409 	UFTDI_DEV(FTDI, EMCU2D, 0),
410 	UFTDI_DEV(FTDI, EMCU2H, 0),
411 	UFTDI_DEV(FTDI, FUTURE_0, 0),
412 	UFTDI_DEV(FTDI, FUTURE_1, 0),
413 	UFTDI_DEV(FTDI, FUTURE_2, 0),
414 	UFTDI_DEV(FTDI, GAMMASCOUT, 0),
415 	UFTDI_DEV(FTDI, GENERIC, 0),
416 	UFTDI_DEV(FTDI, GUDEADS_E808, 0),
417 	UFTDI_DEV(FTDI, GUDEADS_E809, 0),
418 	UFTDI_DEV(FTDI, GUDEADS_E80A, 0),
419 	UFTDI_DEV(FTDI, GUDEADS_E80B, 0),
420 	UFTDI_DEV(FTDI, GUDEADS_E80C, 0),
421 	UFTDI_DEV(FTDI, GUDEADS_E80D, 0),
422 	UFTDI_DEV(FTDI, GUDEADS_E80E, 0),
423 	UFTDI_DEV(FTDI, GUDEADS_E80F, 0),
424 	UFTDI_DEV(FTDI, GUDEADS_E88D, 0),
425 	UFTDI_DEV(FTDI, GUDEADS_E88E, 0),
426 	UFTDI_DEV(FTDI, GUDEADS_E88F, 0),
427 	UFTDI_DEV(FTDI, HD_RADIO, 0),
428 	UFTDI_DEV(FTDI, HO720, 0),
429 	UFTDI_DEV(FTDI, HO730, 0),
430 	UFTDI_DEV(FTDI, HO820, 0),
431 	UFTDI_DEV(FTDI, HO870, 0),
432 	UFTDI_DEV(FTDI, IBS_APP70, 0),
433 	UFTDI_DEV(FTDI, IBS_PCMCIA, 0),
434 	UFTDI_DEV(FTDI, IBS_PEDO, 0),
435 	UFTDI_DEV(FTDI, IBS_PICPRO, 0),
436 	UFTDI_DEV(FTDI, IBS_PK1, 0),
437 	UFTDI_DEV(FTDI, IBS_PROD, 0),
438 	UFTDI_DEV(FTDI, IBS_RS232MON, 0),
439 	UFTDI_DEV(FTDI, IBS_US485, 0),
440 	UFTDI_DEV(FTDI, IPLUS, 0),
441 	UFTDI_DEV(FTDI, IPLUS2, 0),
442 	UFTDI_DEV(FTDI, IRTRANS, 0),
443 	UFTDI_DEV(FTDI, KBS, 0),
444 	UFTDI_DEV(FTDI, KTLINK, UFTDI_JTAG_IFACE(0)),
445 	UFTDI_DEV(FTDI, LENZ_LIUSB, 0),
446 	UFTDI_DEV(FTDI, LK202, 0),
447 	UFTDI_DEV(FTDI, LK204, 0),
448 	UFTDI_DEV(FTDI, LM3S_DEVEL_BOARD, UFTDI_JTAG_IFACE(0)),
449 	UFTDI_DEV(FTDI, LM3S_EVAL_BOARD, UFTDI_JTAG_IFACE(0)),
450 	UFTDI_DEV(FTDI, LM3S_ICDI_B_BOARD, UFTDI_JTAG_IFACE(0)),
451 	UFTDI_DEV(FTDI, MASTERDEVEL2, 0),
452 	UFTDI_DEV(FTDI, MAXSTREAM, 0),
453 	UFTDI_DEV(FTDI, MHAM_DB9, 0),
454 	UFTDI_DEV(FTDI, MHAM_IC, 0),
455 	UFTDI_DEV(FTDI, MHAM_KW, 0),
456 	UFTDI_DEV(FTDI, MHAM_RS232, 0),
457 	UFTDI_DEV(FTDI, MHAM_Y6, 0),
458 	UFTDI_DEV(FTDI, MHAM_Y8, 0),
459 	UFTDI_DEV(FTDI, MHAM_Y9, 0),
460 	UFTDI_DEV(FTDI, MHAM_YS, 0),
461 	UFTDI_DEV(FTDI, MICRO_CHAMELEON, 0),
462 	UFTDI_DEV(FTDI, MTXORB_5, 0),
463 	UFTDI_DEV(FTDI, MTXORB_6, 0),
464 	UFTDI_DEV(FTDI, MX2_3, 0),
465 	UFTDI_DEV(FTDI, MX4_5, 0),
466 	UFTDI_DEV(FTDI, NXTCAM, 0),
467 	UFTDI_DEV(FTDI, OCEANIC, 0),
468 	UFTDI_DEV(FTDI, OOCDLINK, UFTDI_JTAG_IFACE(0)),
469 	UFTDI_DEV(FTDI, OPENDCC, 0),
470 	UFTDI_DEV(FTDI, OPENDCC_GATEWAY, 0),
471 	UFTDI_DEV(FTDI, OPENDCC_GBM, 0),
472 	UFTDI_DEV(FTDI, OPENDCC_SNIFFER, 0),
473 	UFTDI_DEV(FTDI, OPENDCC_THROTTLE, 0),
474 	UFTDI_DEV(FTDI, PCDJ_DAC2, 0),
475 	UFTDI_DEV(FTDI, PCMSFU, 0),
476 	UFTDI_DEV(FTDI, PERLE_ULTRAPORT, 0),
477 	UFTDI_DEV(FTDI, PHI_FISCO, 0),
478 	UFTDI_DEV(FTDI, PIEGROUP, 0),
479 	UFTDI_DEV(FTDI, PROPOX_JTAGCABLEII, 0),
480 	UFTDI_DEV(FTDI, R2000KU_TRUE_RNG, 0),
481 	UFTDI_DEV(FTDI, R2X0, 0),
482 	UFTDI_DEV(FTDI, RELAIS, 0),
483 	UFTDI_DEV(FTDI, REU_TINY, 0),
484 	UFTDI_DEV(FTDI, RMP200, 0),
485 	UFTDI_DEV(FTDI, RM_CANVIEW, 0),
486 	UFTDI_DEV(FTDI, RRCIRKITS_LOCOBUFFER, 0),
487 	UFTDI_DEV(FTDI, SCIENCESCOPE_HS_LOGBOOK, 0),
488 	UFTDI_DEV(FTDI, SCIENCESCOPE_LOGBOOKML, 0),
489 	UFTDI_DEV(FTDI, SCIENCESCOPE_LS_LOGBOOK, 0),
490 	UFTDI_DEV(FTDI, SCS_DEVICE_0, 0),
491 	UFTDI_DEV(FTDI, SCS_DEVICE_1, 0),
492 	UFTDI_DEV(FTDI, SCS_DEVICE_2, 0),
493 	UFTDI_DEV(FTDI, SCS_DEVICE_3, 0),
494 	UFTDI_DEV(FTDI, SCS_DEVICE_4, 0),
495 	UFTDI_DEV(FTDI, SCS_DEVICE_5, 0),
496 	UFTDI_DEV(FTDI, SCS_DEVICE_6, 0),
497 	UFTDI_DEV(FTDI, SCS_DEVICE_7, 0),
498 	UFTDI_DEV(FTDI, SCX8_USB_PHOENIX, 0),
499 	UFTDI_DEV(FTDI, SDMUSBQSS, 0),
500 	UFTDI_DEV(FTDI, SEMC_DSS20, 0),
501 	UFTDI_DEV(FTDI, SERIAL_2232C, UFTDI_JTAG_CHECK_STRING),
502 	UFTDI_DEV(FTDI, SERIAL_2232D, 0),
503 	UFTDI_DEV(FTDI, SERIAL_232RL, 0),
504 	UFTDI_DEV(FTDI, SERIAL_4232H, 0),
505 	UFTDI_DEV(FTDI, SERIAL_8U100AX, 0),
506 	UFTDI_DEV(FTDI, SERIAL_8U232AM, 0),
507 	UFTDI_DEV(FTDI, SERIAL_8U232AM4, 0),
508 	UFTDI_DEV(FTDI, SIGNALYZER_SH2, UFTDI_JTAG_IFACE(0)),
509 	UFTDI_DEV(FTDI, SIGNALYZER_SH4, UFTDI_JTAG_IFACE(0)),
510 	UFTDI_DEV(FTDI, SIGNALYZER_SLITE, UFTDI_JTAG_IFACE(0)),
511 	UFTDI_DEV(FTDI, SIGNALYZER_ST, UFTDI_JTAG_IFACE(0)),
512 	UFTDI_DEV(FTDI, SPECIAL_1, 0),
513 	UFTDI_DEV(FTDI, SPECIAL_3, 0),
514 	UFTDI_DEV(FTDI, SPECIAL_4, 0),
515 	UFTDI_DEV(FTDI, SPROG_II, 0),
516 	UFTDI_DEV(FTDI, SR_RADIO, 0),
517 	UFTDI_DEV(FTDI, SUUNTO_SPORTS, 0),
518 	UFTDI_DEV(FTDI, TACTRIX_OPENPORT_13M, 0),
519 	UFTDI_DEV(FTDI, TACTRIX_OPENPORT_13S, 0),
520 	UFTDI_DEV(FTDI, TACTRIX_OPENPORT_13U, 0),
521 	UFTDI_DEV(FTDI, TAVIR_STK500, 0),
522 	UFTDI_DEV(FTDI, TERATRONIK_D2XX, 0),
523 	UFTDI_DEV(FTDI, TERATRONIK_VCP, 0),
524 	UFTDI_DEV(FTDI, THORLABS, 0),
525 	UFTDI_DEV(FTDI, TIAO, 0),
526 	UFTDI_DEV(FTDI, TNC_X, 0),
527 	UFTDI_DEV(FTDI, TTUSB, 0),
528 	UFTDI_DEV(FTDI, TURTELIZER2, UFTDI_JTAG_IFACE(0)),
529 	UFTDI_DEV(FTDI, UOPTBR, 0),
530 	UFTDI_DEV(FTDI, USBSERIAL, 0),
531 	UFTDI_DEV(FTDI, USBX_707, 0),
532 	UFTDI_DEV(FTDI, USB_UIRT, 0),
533 	UFTDI_DEV(FTDI, USINT_CAT, 0),
534 	UFTDI_DEV(FTDI, USINT_RS232, 0),
535 	UFTDI_DEV(FTDI, USINT_WKEY, 0),
536 	UFTDI_DEV(FTDI, VARDAAN, 0),
537 	UFTDI_DEV(FTDI, VNHCPCUSB_D, 0),
538 	UFTDI_DEV(FTDI, WESTREX_MODEL_777, 0),
539 	UFTDI_DEV(FTDI, WESTREX_MODEL_8900F, 0),
540 	UFTDI_DEV(FTDI, XDS100V2, UFTDI_JTAG_IFACE(0)),
541 	UFTDI_DEV(FTDI, XDS100V3, UFTDI_JTAG_IFACE(0)),
542 	UFTDI_DEV(FTDI, XF_547, 0),
543 	UFTDI_DEV(FTDI, XF_640, 0),
544 	UFTDI_DEV(FTDI, XF_642, 0),
545 	UFTDI_DEV(FTDI, XM_RADIO, 0),
546 	UFTDI_DEV(FTDI, YEI_SERVOCENTER31, 0),
547 	UFTDI_DEV(GNOTOMETRICS, USB, 0),
548 	UFTDI_DEV(ICOM, SP1, 0),
549 	UFTDI_DEV(ICOM, OPC_U_UC, 0),
550 	UFTDI_DEV(ICOM, RP2C1, 0),
551 	UFTDI_DEV(ICOM, RP2C2, 0),
552 	UFTDI_DEV(ICOM, RP2D, 0),
553 	UFTDI_DEV(ICOM, RP2KVR, 0),
554 	UFTDI_DEV(ICOM, RP2KVT, 0),
555 	UFTDI_DEV(ICOM, RP2VR, 0),
556 	UFTDI_DEV(ICOM, RP2VT, 0),
557 	UFTDI_DEV(ICOM, RP4KVR, 0),
558 	UFTDI_DEV(ICOM, RP4KVT, 0),
559 	UFTDI_DEV(IDTECH, IDT1221U, 0),
560 	UFTDI_DEV(INTERBIOMETRICS, IOBOARD, 0),
561 	UFTDI_DEV(INTERBIOMETRICS, MINI_IOBOARD, 0),
562 	UFTDI_DEV(INTREPIDCS, NEOVI, 0),
563 	UFTDI_DEV(INTREPIDCS, VALUECAN, 0),
564 	UFTDI_DEV(IONICS, PLUGCOMPUTER, UFTDI_JTAG_IFACE(0)),
565 	UFTDI_DEV(JETI, SPC1201, 0),
566 	UFTDI_DEV(KOBIL, CONV_B1, 0),
567 	UFTDI_DEV(KOBIL, CONV_KAAN, 0),
568 	UFTDI_DEV(LARSENBRUSGAARD, ALTITRACK, 0),
569 	UFTDI_DEV(MARVELL, SHEEVAPLUG, UFTDI_JTAG_IFACE(0)),
570 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0100, 0),
571 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0101, 0),
572 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0102, 0),
573 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0103, 0),
574 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0104, 0),
575 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0105, 0),
576 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0106, 0),
577 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0107, 0),
578 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0108, 0),
579 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0109, 0),
580 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_010A, 0),
581 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_010B, 0),
582 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_010C, 0),
583 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_010D, 0),
584 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_010E, 0),
585 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_010F, 0),
586 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0110, 0),
587 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0111, 0),
588 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0112, 0),
589 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0113, 0),
590 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0114, 0),
591 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0115, 0),
592 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0116, 0),
593 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0117, 0),
594 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0118, 0),
595 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0119, 0),
596 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_011A, 0),
597 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_011B, 0),
598 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_011C, 0),
599 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_011D, 0),
600 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_011E, 0),
601 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_011F, 0),
602 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0120, 0),
603 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0121, 0),
604 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0122, 0),
605 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0123, 0),
606 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0124, 0),
607 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0125, 0),
608 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0126, 0),
609 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0128, 0),
610 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0129, 0),
611 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_012A, 0),
612 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_012B, 0),
613 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_012D, 0),
614 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_012E, 0),
615 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_012F, 0),
616 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0130, 0),
617 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0131, 0),
618 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0132, 0),
619 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0133, 0),
620 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0134, 0),
621 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0135, 0),
622 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0136, 0),
623 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0137, 0),
624 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0138, 0),
625 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0139, 0),
626 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_013A, 0),
627 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_013B, 0),
628 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_013C, 0),
629 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_013D, 0),
630 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_013E, 0),
631 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_013F, 0),
632 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0140, 0),
633 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0141, 0),
634 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0142, 0),
635 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0143, 0),
636 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0144, 0),
637 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0145, 0),
638 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0146, 0),
639 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0147, 0),
640 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0148, 0),
641 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0149, 0),
642 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_014A, 0),
643 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_014B, 0),
644 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_014C, 0),
645 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_014D, 0),
646 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_014E, 0),
647 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_014F, 0),
648 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0150, 0),
649 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0151, 0),
650 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0152, 0),
651 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0159, 0),
652 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_015A, 0),
653 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_015B, 0),
654 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_015C, 0),
655 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_015D, 0),
656 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_015E, 0),
657 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_015F, 0),
658 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0160, 0),
659 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0161, 0),
660 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0162, 0),
661 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0163, 0),
662 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0164, 0),
663 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0165, 0),
664 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0166, 0),
665 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0167, 0),
666 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0168, 0),
667 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0169, 0),
668 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_016A, 0),
669 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_016B, 0),
670 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_016C, 0),
671 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_016D, 0),
672 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_016E, 0),
673 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_016F, 0),
674 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0170, 0),
675 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0171, 0),
676 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0172, 0),
677 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0173, 0),
678 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0174, 0),
679 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0175, 0),
680 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0176, 0),
681 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0177, 0),
682 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0178, 0),
683 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0179, 0),
684 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_017A, 0),
685 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_017B, 0),
686 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_017C, 0),
687 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_017D, 0),
688 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_017E, 0),
689 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_017F, 0),
690 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0180, 0),
691 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0181, 0),
692 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0182, 0),
693 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0183, 0),
694 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0184, 0),
695 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0185, 0),
696 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0186, 0),
697 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0187, 0),
698 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0188, 0),
699 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0189, 0),
700 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_018A, 0),
701 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_018B, 0),
702 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_018C, 0),
703 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_018D, 0),
704 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_018E, 0),
705 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_018F, 0),
706 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0190, 0),
707 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0191, 0),
708 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0192, 0),
709 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0193, 0),
710 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0194, 0),
711 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0195, 0),
712 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0196, 0),
713 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0197, 0),
714 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0198, 0),
715 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_0199, 0),
716 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_019A, 0),
717 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_019B, 0),
718 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_019C, 0),
719 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_019D, 0),
720 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_019E, 0),
721 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_019F, 0),
722 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A0, 0),
723 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A1, 0),
724 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A2, 0),
725 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A3, 0),
726 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A4, 0),
727 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A5, 0),
728 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A6, 0),
729 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A7, 0),
730 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A8, 0),
731 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01A9, 0),
732 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01AA, 0),
733 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01AB, 0),
734 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01AC, 0),
735 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01AD, 0),
736 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01AE, 0),
737 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01AF, 0),
738 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B0, 0),
739 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B1, 0),
740 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B2, 0),
741 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B3, 0),
742 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B4, 0),
743 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B5, 0),
744 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B6, 0),
745 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B7, 0),
746 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B8, 0),
747 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01B9, 0),
748 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01BA, 0),
749 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01BB, 0),
750 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01BC, 0),
751 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01BD, 0),
752 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01BE, 0),
753 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01BF, 0),
754 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C0, 0),
755 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C1, 0),
756 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C2, 0),
757 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C3, 0),
758 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C4, 0),
759 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C5, 0),
760 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C6, 0),
761 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C7, 0),
762 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C8, 0),
763 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01C9, 0),
764 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01CA, 0),
765 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01CB, 0),
766 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01CC, 0),
767 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01CD, 0),
768 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01CE, 0),
769 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01CF, 0),
770 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D0, 0),
771 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D1, 0),
772 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D2, 0),
773 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D3, 0),
774 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D4, 0),
775 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D5, 0),
776 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D6, 0),
777 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D7, 0),
778 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D8, 0),
779 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01D9, 0),
780 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01DA, 0),
781 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01DB, 0),
782 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01DC, 0),
783 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01DD, 0),
784 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01DE, 0),
785 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01DF, 0),
786 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E0, 0),
787 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E1, 0),
788 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E2, 0),
789 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E3, 0),
790 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E4, 0),
791 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E5, 0),
792 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E6, 0),
793 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E7, 0),
794 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E8, 0),
795 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01E9, 0),
796 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01EA, 0),
797 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01EB, 0),
798 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01EC, 0),
799 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01ED, 0),
800 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01EE, 0),
801 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01EF, 0),
802 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F0, 0),
803 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F1, 0),
804 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F2, 0),
805 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F3, 0),
806 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F4, 0),
807 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F5, 0),
808 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F6, 0),
809 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F7, 0),
810 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F8, 0),
811 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01F9, 0),
812 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01FA, 0),
813 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01FB, 0),
814 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01FC, 0),
815 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01FD, 0),
816 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01FE, 0),
817 	UFTDI_DEV(MATRIXORBITAL, FTDI_RANGE_01FF, 0),
818 	UFTDI_DEV(MATRIXORBITAL, MOUA, 0),
819 	UFTDI_DEV(MELCO, PCOPRS1, 0),
820 	UFTDI_DEV(METAGEEK, TELLSTICK, 0),
821 	UFTDI_DEV(MOBILITY, USB_SERIAL, 0),
822 	UFTDI_DEV(OLIMEX, ARM_USB_OCD, UFTDI_JTAG_IFACE(0)),
823 	UFTDI_DEV(OLIMEX, ARM_USB_OCD_H, UFTDI_JTAG_IFACE(0)),
824 	UFTDI_DEV(OPTO, CRD7734, 0),
825 	UFTDI_DEV(OPTO, CRD7734_1, 0),
826 	UFTDI_DEV(PAPOUCH, AD4USB, 0),
827 	UFTDI_DEV(PAPOUCH, AP485, 0),
828 	UFTDI_DEV(PAPOUCH, AP485_2, 0),
829 	UFTDI_DEV(PAPOUCH, DRAK5, 0),
830 	UFTDI_DEV(PAPOUCH, DRAK6, 0),
831 	UFTDI_DEV(PAPOUCH, GMSR, 0),
832 	UFTDI_DEV(PAPOUCH, GMUX, 0),
833 	UFTDI_DEV(PAPOUCH, IRAMP, 0),
834 	UFTDI_DEV(PAPOUCH, LEC, 0),
835 	UFTDI_DEV(PAPOUCH, MU, 0),
836 	UFTDI_DEV(PAPOUCH, QUIDO10X1, 0),
837 	UFTDI_DEV(PAPOUCH, QUIDO2X16, 0),
838 	UFTDI_DEV(PAPOUCH, QUIDO2X2, 0),
839 	UFTDI_DEV(PAPOUCH, QUIDO30X3, 0),
840 	UFTDI_DEV(PAPOUCH, QUIDO3X32, 0),
841 	UFTDI_DEV(PAPOUCH, QUIDO4X4, 0),
842 	UFTDI_DEV(PAPOUCH, QUIDO60X3, 0),
843 	UFTDI_DEV(PAPOUCH, QUIDO8X8, 0),
844 	UFTDI_DEV(PAPOUCH, SB232, 0),
845 	UFTDI_DEV(PAPOUCH, SB422, 0),
846 	UFTDI_DEV(PAPOUCH, SB422_2, 0),
847 	UFTDI_DEV(PAPOUCH, SB485, 0),
848 	UFTDI_DEV(PAPOUCH, SB485C, 0),
849 	UFTDI_DEV(PAPOUCH, SB485S, 0),
850 	UFTDI_DEV(PAPOUCH, SB485_2, 0),
851 	UFTDI_DEV(PAPOUCH, SIMUKEY, 0),
852 	UFTDI_DEV(PAPOUCH, TMU, 0),
853 	UFTDI_DEV(PAPOUCH, UPSUSB, 0),
854 	UFTDI_DEV(POSIFLEX, PP7000, 0),
855 	UFTDI_DEV(QIHARDWARE, JTAGSERIAL, UFTDI_JTAG_IFACE(0)),
856 	UFTDI_DEV(RATOC, REXUSB60F, 0),
857 	UFTDI_DEV(RTSYSTEMS, CT29B, 0),
858 	UFTDI_DEV(RTSYSTEMS, SERIAL_VX7, 0),
859 	UFTDI_DEV(SEALEVEL, 2101, 0),
860 	UFTDI_DEV(SEALEVEL, 2102, 0),
861 	UFTDI_DEV(SEALEVEL, 2103, 0),
862 	UFTDI_DEV(SEALEVEL, 2104, 0),
863 	UFTDI_DEV(SEALEVEL, 2106, 0),
864 	UFTDI_DEV(SEALEVEL, 2201_1, 0),
865 	UFTDI_DEV(SEALEVEL, 2201_2, 0),
866 	UFTDI_DEV(SEALEVEL, 2202_1, 0),
867 	UFTDI_DEV(SEALEVEL, 2202_2, 0),
868 	UFTDI_DEV(SEALEVEL, 2203_1, 0),
869 	UFTDI_DEV(SEALEVEL, 2203_2, 0),
870 	UFTDI_DEV(SEALEVEL, 2401_1, 0),
871 	UFTDI_DEV(SEALEVEL, 2401_2, 0),
872 	UFTDI_DEV(SEALEVEL, 2401_3, 0),
873 	UFTDI_DEV(SEALEVEL, 2401_4, 0),
874 	UFTDI_DEV(SEALEVEL, 2402_1, 0),
875 	UFTDI_DEV(SEALEVEL, 2402_2, 0),
876 	UFTDI_DEV(SEALEVEL, 2402_3, 0),
877 	UFTDI_DEV(SEALEVEL, 2402_4, 0),
878 	UFTDI_DEV(SEALEVEL, 2403_1, 0),
879 	UFTDI_DEV(SEALEVEL, 2403_2, 0),
880 	UFTDI_DEV(SEALEVEL, 2403_3, 0),
881 	UFTDI_DEV(SEALEVEL, 2403_4, 0),
882 	UFTDI_DEV(SEALEVEL, 2801_1, 0),
883 	UFTDI_DEV(SEALEVEL, 2801_2, 0),
884 	UFTDI_DEV(SEALEVEL, 2801_3, 0),
885 	UFTDI_DEV(SEALEVEL, 2801_4, 0),
886 	UFTDI_DEV(SEALEVEL, 2801_5, 0),
887 	UFTDI_DEV(SEALEVEL, 2801_6, 0),
888 	UFTDI_DEV(SEALEVEL, 2801_7, 0),
889 	UFTDI_DEV(SEALEVEL, 2801_8, 0),
890 	UFTDI_DEV(SEALEVEL, 2802_1, 0),
891 	UFTDI_DEV(SEALEVEL, 2802_2, 0),
892 	UFTDI_DEV(SEALEVEL, 2802_3, 0),
893 	UFTDI_DEV(SEALEVEL, 2802_4, 0),
894 	UFTDI_DEV(SEALEVEL, 2802_5, 0),
895 	UFTDI_DEV(SEALEVEL, 2802_6, 0),
896 	UFTDI_DEV(SEALEVEL, 2802_7, 0),
897 	UFTDI_DEV(SEALEVEL, 2802_8, 0),
898 	UFTDI_DEV(SEALEVEL, 2803_1, 0),
899 	UFTDI_DEV(SEALEVEL, 2803_2, 0),
900 	UFTDI_DEV(SEALEVEL, 2803_3, 0),
901 	UFTDI_DEV(SEALEVEL, 2803_4, 0),
902 	UFTDI_DEV(SEALEVEL, 2803_5, 0),
903 	UFTDI_DEV(SEALEVEL, 2803_6, 0),
904 	UFTDI_DEV(SEALEVEL, 2803_7, 0),
905 	UFTDI_DEV(SEALEVEL, 2803_8, 0),
906 	UFTDI_DEV(SIIG2, DK201, 0),
907 	UFTDI_DEV(SIIG2, US2308, 0),
908 	UFTDI_DEV(TESTO, USB_INTERFACE, 0),
909 	UFTDI_DEV(TML, USB_SERIAL, 0),
910 	UFTDI_DEV(TTI, QL355P, 0),
911 	UFTDI_DEV(UNKNOWN4, NF_RIC, 0),
912 #undef UFTDI_DEV
913 };
914 
915 DRIVER_MODULE(uftdi, uhub, uftdi_driver, uftdi_devclass, NULL, NULL);
916 MODULE_DEPEND(uftdi, ucom, 1, 1, 1);
917 MODULE_DEPEND(uftdi, usb, 1, 1, 1);
918 MODULE_VERSION(uftdi, 1);
919 USB_PNP_HOST_INFO(uftdi_devs);
920 
921 /*
922  * Jtag product name strings table.  Some products have one or more interfaces
923  * dedicated to jtag or gpio, but use a product ID that's the same as other
924  * products which don't.  They are marked with a flag in the table above, and
925  * the following string table is checked for flagged products.  The string check
926  * is done with strstr(); in effect there is an implicit wildcard at the
927  * beginning and end of each product name string in table.
928  */
929 static const struct jtag_by_name {
930 	const char *	product_name;
931 	uint32_t	jtag_interfaces;
932 } jtag_products_by_name[] = {
933         /* TI Beaglebone and TI XDS100Vn jtag product line. */
934 	{"XDS100V",	UFTDI_JTAG_IFACE(0)},
935 };
936 
937 /*
938  * Set up a sysctl and tunable to en/disable the feature of skipping the
939  * creation of tty devices for jtag interfaces.  Enabled by default.
940  */
941 static int skip_jtag_interfaces = 1;
942 SYSCTL_INT(_hw_usb_uftdi, OID_AUTO, skip_jtag_interfaces, CTLFLAG_RWTUN,
943     &skip_jtag_interfaces, 1, "Skip creating tty devices for jtag interfaces");
944 
945 static boolean_t
946 is_jtag_interface(struct usb_attach_arg *uaa, const struct usb_device_id *id)
947 {
948 	int i, iface_bit;
949 	const char * product_name;
950 	const struct jtag_by_name *jbn;
951 
952 	/* We only allocate 8 flag bits for jtag interface flags. */
953 	if (uaa->info.bIfaceIndex >= UFTDI_JTAG_IFACES_MAX)
954 		return (0);
955 	iface_bit = UFTDI_JTAG_IFACE(uaa->info.bIfaceIndex);
956 
957 	/*
958 	 * If requested, search the name strings table and use the interface
959 	 * bits from that table when the product name string matches, else use
960 	 * the jtag interface bits from the main ID table.
961 	 */
962 	if ((id->driver_info & UFTDI_JTAG_MASK) == UFTDI_JTAG_CHECK_STRING) {
963 		product_name = usb_get_product(uaa->device);
964 		for (i = 0; i < nitems(jtag_products_by_name); i++) {
965 			jbn = &jtag_products_by_name[i];
966 			if (strstr(product_name, jbn->product_name) != NULL &&
967 			    (jbn->jtag_interfaces & iface_bit) != 0)
968 				return (1);
969 		}
970 	} else if ((id->driver_info & iface_bit) != 0)
971 		return (1);
972 
973 	return (0);
974 }
975 
976 /*
977  * Set up softc fields whose value depends on the device type.
978  *
979  * Note that the 2232C and 2232D devices are the same for our purposes.  In the
980  * silicon the difference is that the D series has CPU FIFO mode and C doesn't.
981  * I haven't found any way of determining the C/D difference from info provided
982  * by the chip other than trying to set CPU FIFO mode and having it work or not.
983  *
984  * Due to a hardware bug, a 232B chip without an eeprom reports itself as a
985  * 232A, but if the serial number is also zero we know it's really a 232B.
986  */
987 static void
988 uftdi_devtype_setup(struct uftdi_softc *sc, struct usb_attach_arg *uaa)
989 {
990 	struct usb_device_descriptor *dd;
991 
992 	sc->sc_bcdDevice = uaa->info.bcdDevice;
993 
994 	switch (uaa->info.bcdDevice) {
995 	case 0x200:
996 		dd = usbd_get_device_descriptor(sc->sc_udev);
997 		if (dd->iSerialNumber == 0) {
998 			sc->sc_devtype = DEVT_232B;
999 		} else {
1000 			sc->sc_devtype = DEVT_232A;
1001 		}
1002 		sc->sc_ucom.sc_portno = 0;
1003 		break;
1004 	case 0x400:
1005 		sc->sc_devtype = DEVT_232B;
1006 		sc->sc_ucom.sc_portno = 0;
1007 		break;
1008 	case 0x500:
1009 		sc->sc_devtype = DEVT_2232D;
1010 		sc->sc_devflags |= DEVF_BAUDBITS_HINDEX;
1011 		sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
1012 		break;
1013 	case 0x600:
1014 		sc->sc_devtype = DEVT_232R;
1015 		sc->sc_ucom.sc_portno = 0;
1016 		break;
1017 	case 0x700:
1018 		sc->sc_devtype = DEVT_2232H;
1019 		sc->sc_devflags |= DEVF_BAUDBITS_HINDEX | DEVF_BAUDCLK_12M;
1020 		sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
1021 		break;
1022 	case 0x800:
1023 		sc->sc_devtype = DEVT_4232H;
1024 		sc->sc_devflags |= DEVF_BAUDBITS_HINDEX | DEVF_BAUDCLK_12M;
1025 		sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
1026 		break;
1027 	case 0x900:
1028 		sc->sc_devtype = DEVT_232H;
1029 		sc->sc_devflags |= DEVF_BAUDBITS_HINDEX | DEVF_BAUDCLK_12M;
1030 		sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
1031 		break;
1032 	case 0x1000:
1033 		sc->sc_devtype = DEVT_230X;
1034 		sc->sc_devflags |= DEVF_BAUDBITS_HINDEX;
1035 		sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
1036 		break;
1037 	default:
1038 		if (uaa->info.bcdDevice < 0x200) {
1039 			sc->sc_devtype = DEVT_SIO;
1040 			sc->sc_hdrlen = 1;
1041 		} else {
1042 			sc->sc_devtype = DEVT_232R;
1043 			device_printf(sc->sc_dev, "Warning: unknown FTDI "
1044 			    "device type, bcdDevice=0x%04x, assuming 232R\n",
1045 			    uaa->info.bcdDevice);
1046 		}
1047 		sc->sc_ucom.sc_portno = 0;
1048 		break;
1049 	}
1050 }
1051 
1052 static int
1053 uftdi_probe(device_t dev)
1054 {
1055 	struct usb_attach_arg *uaa = device_get_ivars(dev);
1056 	const struct usb_device_id *id;
1057 
1058 	if (uaa->usb_mode != USB_MODE_HOST) {
1059 		return (ENXIO);
1060 	}
1061 	if (uaa->info.bConfigIndex != UFTDI_CONFIG_INDEX) {
1062 		return (ENXIO);
1063 	}
1064 
1065 	/*
1066 	 * Attach to all present interfaces unless this is a JTAG one, which
1067 	 * we leave for userland.
1068 	 */
1069 	id = usbd_lookup_id_by_info(uftdi_devs, sizeof(uftdi_devs),
1070 	    &uaa->info);
1071 	if (id == NULL)
1072 		return (ENXIO);
1073 	if (skip_jtag_interfaces && is_jtag_interface(uaa, id)) {
1074 		printf("%s: skipping JTAG interface #%d for '%s' at %u.%u\n",
1075 		    device_get_name(dev),
1076 		    uaa->info.bIfaceIndex,
1077 		    usb_get_product(uaa->device),
1078 		    usbd_get_bus_index(uaa->device),
1079 		    usbd_get_device_index(uaa->device));
1080 		return (ENXIO);
1081 	}
1082 	uaa->driver_info = id->driver_info;
1083 	return (BUS_PROBE_SPECIFIC);
1084 }
1085 
1086 static int
1087 uftdi_attach(device_t dev)
1088 {
1089 	struct usb_attach_arg *uaa = device_get_ivars(dev);
1090 	struct uftdi_softc *sc = device_get_softc(dev);
1091 	int error;
1092 
1093 	DPRINTF("\n");
1094 
1095 	sc->sc_udev = uaa->device;
1096 	sc->sc_dev = dev;
1097 	sc->sc_unit = device_get_unit(dev);
1098 	sc->sc_bitmode = UFTDI_BITMODE_NONE;
1099 
1100 	device_set_usb_desc(dev);
1101 	mtx_init(&sc->sc_mtx, "uftdi", NULL, MTX_DEF);
1102 	ucom_ref(&sc->sc_super_ucom);
1103 
1104 
1105 	uftdi_devtype_setup(sc, uaa);
1106 
1107 	error = usbd_transfer_setup(uaa->device,
1108 	    &uaa->info.bIfaceIndex, sc->sc_xfer, uftdi_config,
1109 	    UFTDI_N_TRANSFER, sc, &sc->sc_mtx);
1110 
1111 	if (error) {
1112 		device_printf(dev, "allocating USB "
1113 		    "transfers failed\n");
1114 		goto detach;
1115 	}
1116 	/* clear stall at first run */
1117 	mtx_lock(&sc->sc_mtx);
1118 	usbd_xfer_set_stall(sc->sc_xfer[UFTDI_BULK_DT_WR]);
1119 	usbd_xfer_set_stall(sc->sc_xfer[UFTDI_BULK_DT_RD]);
1120 	mtx_unlock(&sc->sc_mtx);
1121 
1122 	/* set a valid "lcr" value */
1123 
1124 	sc->sc_last_lcr =
1125 	    (FTDI_SIO_SET_DATA_STOP_BITS_2 |
1126 	    FTDI_SIO_SET_DATA_PARITY_NONE |
1127 	    FTDI_SIO_SET_DATA_BITS(8));
1128 
1129 	/* Indicate tx bits in sc_lsr can be used to determine busy vs idle. */
1130 	ucom_use_lsr_txbits(&sc->sc_ucom);
1131 
1132 	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
1133 	    &uftdi_callback, &sc->sc_mtx);
1134 	if (error) {
1135 		goto detach;
1136 	}
1137 	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
1138 
1139 	return (0);			/* success */
1140 
1141 detach:
1142 	uftdi_detach(dev);
1143 	return (ENXIO);
1144 }
1145 
1146 static int
1147 uftdi_detach(device_t dev)
1148 {
1149 	struct uftdi_softc *sc = device_get_softc(dev);
1150 
1151 	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
1152 	usbd_transfer_unsetup(sc->sc_xfer, UFTDI_N_TRANSFER);
1153 
1154 	device_claim_softc(dev);
1155 
1156 	uftdi_free_softc(sc);
1157 
1158 	return (0);
1159 }
1160 
1161 UCOM_UNLOAD_DRAIN(uftdi);
1162 
1163 static void
1164 uftdi_free_softc(struct uftdi_softc *sc)
1165 {
1166 	if (ucom_unref(&sc->sc_super_ucom)) {
1167 		mtx_destroy(&sc->sc_mtx);
1168 		device_free_softc(sc);
1169 	}
1170 }
1171 
1172 static void
1173 uftdi_free(struct ucom_softc *ucom)
1174 {
1175 	uftdi_free_softc(ucom->sc_parent);
1176 }
1177 
1178 static void
1179 uftdi_cfg_open(struct ucom_softc *ucom)
1180 {
1181 
1182 	/*
1183 	 * This do-nothing open routine exists for the sole purpose of this
1184 	 * DPRINTF() so that you can see the point at which open gets called
1185 	 * when debugging is enabled.
1186 	 */
1187 	DPRINTF("\n");
1188 }
1189 
1190 static void
1191 uftdi_cfg_close(struct ucom_softc *ucom)
1192 {
1193 
1194 	/*
1195 	 * This do-nothing close routine exists for the sole purpose of this
1196 	 * DPRINTF() so that you can see the point at which close gets called
1197 	 * when debugging is enabled.
1198 	 */
1199 	DPRINTF("\n");
1200 }
1201 
1202 static void
1203 uftdi_write_callback(struct usb_xfer *xfer, usb_error_t error)
1204 {
1205 	struct uftdi_softc *sc = usbd_xfer_softc(xfer);
1206 	struct usb_page_cache *pc;
1207 	uint32_t pktlen;
1208 	uint32_t buflen;
1209 	uint8_t buf[1];
1210 
1211 	DPRINTFN(3, "\n");
1212 
1213 	switch (USB_GET_STATE(xfer)) {
1214 	default:			/* Error */
1215 		if (error != USB_ERR_CANCELLED) {
1216 			/* try to clear stall first */
1217 			usbd_xfer_set_stall(xfer);
1218 		}
1219 		/* FALLTHROUGH */
1220 	case USB_ST_SETUP:
1221 	case USB_ST_TRANSFERRED:
1222 		/*
1223 		 * If output packets don't require headers (the common case) we
1224 		 * can just load the buffer up with payload bytes all at once.
1225 		 * Otherwise, loop to format packets into the buffer while there
1226 		 * is data available, and room for a packet header and at least
1227 		 * one byte of payload.
1228 		 *
1229 		 * NOTE: The FTDI chip doesn't accept zero length
1230 		 * packets. This cannot happen because the "pktlen"
1231 		 * will always be non-zero when "ucom_get_data()"
1232 		 * returns non-zero which we check below.
1233 		 */
1234 		pc = usbd_xfer_get_frame(xfer, 0);
1235 		if (sc->sc_hdrlen == 0) {
1236 			if (ucom_get_data(&sc->sc_ucom, pc, 0, UFTDI_OBUFSIZE,
1237 			    &buflen) == 0)
1238 				break;
1239 		} else {
1240 			buflen = 0;
1241 			while (buflen < UFTDI_OBUFSIZE - sc->sc_hdrlen - 1 &&
1242 			    ucom_get_data(&sc->sc_ucom, pc, buflen +
1243 			    sc->sc_hdrlen, UFTDI_OPKTSIZE - sc->sc_hdrlen,
1244 			    &pktlen) != 0) {
1245 				buf[0] = FTDI_OUT_TAG(pktlen,
1246 				    sc->sc_ucom.sc_portno);
1247 				usbd_copy_in(pc, buflen, buf, 1);
1248 				buflen += pktlen + sc->sc_hdrlen;
1249 			}
1250 		}
1251 		if (buflen != 0) {
1252 			usbd_xfer_set_frame_len(xfer, 0, buflen);
1253 			usbd_transfer_submit(xfer);
1254 		}
1255 		break;
1256 	}
1257 }
1258 
1259 static void
1260 uftdi_read_callback(struct usb_xfer *xfer, usb_error_t error)
1261 {
1262 	struct uftdi_softc *sc = usbd_xfer_softc(xfer);
1263 	struct usb_page_cache *pc;
1264 	uint8_t buf[2];
1265 	uint8_t ftdi_msr;
1266 	uint8_t msr;
1267 	uint8_t lsr;
1268 	int buflen;
1269 	int pktlen;
1270 	int pktmax;
1271 	int offset;
1272 
1273 	DPRINTFN(3, "\n");
1274 
1275 	usbd_xfer_status(xfer, &buflen, NULL, NULL, NULL);
1276 
1277 	switch (USB_GET_STATE(xfer)) {
1278 	case USB_ST_TRANSFERRED:
1279 		if (buflen < UFTDI_IHDRSIZE)
1280 			goto tr_setup;
1281 		pc = usbd_xfer_get_frame(xfer, 0);
1282 		pktmax = xfer->max_packet_size - UFTDI_IHDRSIZE;
1283 		lsr = 0;
1284 		msr = 0;
1285 		offset = 0;
1286 		/*
1287 		 * Extract packet headers and payload bytes from the buffer.
1288 		 * Feed payload bytes to ucom/tty layer; OR-accumulate the
1289 		 * receiver-related header status bits which are transient and
1290 		 * could toggle with each packet, but for transmitter-related
1291 		 * bits keep only the ones from the last packet.
1292 		 *
1293 		 * After processing all packets in the buffer, process the
1294 		 * accumulated transient MSR and LSR values along with the
1295 		 * non-transient bits from the last packet header.
1296 		 */
1297 		while (buflen >= UFTDI_IHDRSIZE) {
1298 			usbd_copy_out(pc, offset, buf, UFTDI_IHDRSIZE);
1299 			offset += UFTDI_IHDRSIZE;
1300 			buflen -= UFTDI_IHDRSIZE;
1301 			lsr &= ~(ULSR_TXRDY | ULSR_TSRE);
1302 			lsr |= FTDI_GET_LSR(buf);
1303 			if (FTDI_GET_MSR(buf) & FTDI_SIO_RI_MASK)
1304 				msr |= SER_RI;
1305 			pktlen = min(buflen, pktmax);
1306 			if (pktlen != 0) {
1307 				ucom_put_data(&sc->sc_ucom, pc, offset,
1308 				    pktlen);
1309 				offset += pktlen;
1310 				buflen -= pktlen;
1311 			}
1312 		}
1313 		ftdi_msr = FTDI_GET_MSR(buf);
1314 
1315 		if (ftdi_msr & FTDI_SIO_CTS_MASK)
1316 			msr |= SER_CTS;
1317 		if (ftdi_msr & FTDI_SIO_DSR_MASK)
1318 			msr |= SER_DSR;
1319 		if (ftdi_msr & FTDI_SIO_RI_MASK)
1320 			msr |= SER_RI;
1321 		if (ftdi_msr & FTDI_SIO_RLSD_MASK)
1322 			msr |= SER_DCD;
1323 
1324 		if (sc->sc_msr != msr || sc->sc_lsr != lsr) {
1325 			DPRINTF("status change msr=0x%02x (0x%02x) "
1326 			    "lsr=0x%02x (0x%02x)\n", msr, sc->sc_msr,
1327 			    lsr, sc->sc_lsr);
1328 
1329 			sc->sc_msr = msr;
1330 			sc->sc_lsr = lsr;
1331 
1332 			ucom_status_change(&sc->sc_ucom);
1333 		}
1334 		/* FALLTHROUGH */
1335 	case USB_ST_SETUP:
1336 tr_setup:
1337 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1338 		usbd_transfer_submit(xfer);
1339 		return;
1340 
1341 	default:			/* Error */
1342 		if (error != USB_ERR_CANCELLED) {
1343 			/* try to clear stall first */
1344 			usbd_xfer_set_stall(xfer);
1345 			goto tr_setup;
1346 		}
1347 		return;
1348 	}
1349 }
1350 
1351 static void
1352 uftdi_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
1353 {
1354 	struct uftdi_softc *sc = ucom->sc_parent;
1355 	uint16_t wIndex = ucom->sc_portno;
1356 	uint16_t wValue;
1357 	struct usb_device_request req;
1358 
1359 	DPRINTFN(2, "DTR=%u\n", onoff);
1360 
1361 	wValue = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW;
1362 
1363 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1364 	req.bRequest = FTDI_SIO_MODEM_CTRL;
1365 	USETW(req.wValue, wValue);
1366 	USETW(req.wIndex, wIndex);
1367 	USETW(req.wLength, 0);
1368 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1369 	    &req, NULL, 0, 1000);
1370 }
1371 
1372 static void
1373 uftdi_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
1374 {
1375 	struct uftdi_softc *sc = ucom->sc_parent;
1376 	uint16_t wIndex = ucom->sc_portno;
1377 	uint16_t wValue;
1378 	struct usb_device_request req;
1379 
1380 	DPRINTFN(2, "RTS=%u\n", onoff);
1381 
1382 	wValue = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW;
1383 
1384 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1385 	req.bRequest = FTDI_SIO_MODEM_CTRL;
1386 	USETW(req.wValue, wValue);
1387 	USETW(req.wIndex, wIndex);
1388 	USETW(req.wLength, 0);
1389 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1390 	    &req, NULL, 0, 1000);
1391 }
1392 
1393 static void
1394 uftdi_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
1395 {
1396 	struct uftdi_softc *sc = ucom->sc_parent;
1397 	uint16_t wIndex = ucom->sc_portno;
1398 	uint16_t wValue;
1399 	struct usb_device_request req;
1400 
1401 	DPRINTFN(2, "BREAK=%u\n", onoff);
1402 
1403 	if (onoff) {
1404 		sc->sc_last_lcr |= FTDI_SIO_SET_BREAK;
1405 	} else {
1406 		sc->sc_last_lcr &= ~FTDI_SIO_SET_BREAK;
1407 	}
1408 
1409 	wValue = sc->sc_last_lcr;
1410 
1411 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1412 	req.bRequest = FTDI_SIO_SET_DATA;
1413 	USETW(req.wValue, wValue);
1414 	USETW(req.wIndex, wIndex);
1415 	USETW(req.wLength, 0);
1416 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1417 	    &req, NULL, 0, 1000);
1418 }
1419 
1420 /*
1421  * Return true if the given speed is within operational tolerance of the target
1422  * speed.  FTDI recommends that the hardware speed be within 3% of nominal.
1423  */
1424 static inline boolean_t
1425 uftdi_baud_within_tolerance(uint64_t speed, uint64_t target)
1426 {
1427 	return ((speed >= (target * 100) / 103) &&
1428 	    (speed <= (target * 100) / 97));
1429 }
1430 
1431 static int
1432 uftdi_sio_encode_baudrate(struct uftdi_softc *sc, speed_t speed,
1433 	struct uftdi_param_config *cfg)
1434 {
1435 	u_int i;
1436 	const speed_t sio_speeds[] = {
1437 		300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200
1438 	};
1439 
1440 	/*
1441 	 * The original SIO chips were limited to a small choice of speeds
1442 	 * listed in an internal table of speeds chosen by an index value.
1443 	 */
1444 	for (i = 0; i < nitems(sio_speeds); ++i) {
1445 		if (speed == sio_speeds[i]) {
1446 			cfg->baud_lobits = i;
1447 			cfg->baud_hibits = 0;
1448 			return (0);
1449 		}
1450 	}
1451 	return (ERANGE);
1452 }
1453 
1454 static int
1455 uftdi_encode_baudrate(struct uftdi_softc *sc, speed_t speed,
1456 	struct uftdi_param_config *cfg)
1457 {
1458 	static const uint8_t encoded_fraction[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1459 	static const uint8_t roundoff_232a[16] = {
1460 		0,  1,  0,  1,  0, -1,  2,  1,
1461 		0, -1, -2, -3,  4,  3,  2,  1,
1462 	};
1463 	uint32_t clk, divisor, fastclk_flag, frac, hwspeed;
1464 
1465 	/*
1466 	 * If this chip has the fast clock capability and the speed is within
1467 	 * range, use the 12MHz clock, otherwise the standard clock is 3MHz.
1468 	 */
1469 	if ((sc->sc_devflags & DEVF_BAUDCLK_12M) && speed >= 1200) {
1470 		clk = 12000000;
1471 		fastclk_flag = (1 << 17);
1472 	} else {
1473 		clk = 3000000;
1474 		fastclk_flag = 0;
1475 	}
1476 
1477 	/*
1478 	 * Make sure the requested speed is reachable with the available clock
1479 	 * and a 14-bit divisor.
1480 	 */
1481 	if (speed < (clk >> 14) || speed > clk)
1482 		return (ERANGE);
1483 
1484 	/*
1485 	 * Calculate the divisor, initially yielding a fixed point number with a
1486 	 * 4-bit (1/16ths) fraction, then round it to the nearest fraction the
1487 	 * hardware can handle.  When the integral part of the divisor is
1488 	 * greater than one, the fractional part is in 1/8ths of the base clock.
1489 	 * The FT8U232AM chips can handle only 0.125, 0.250, and 0.5 fractions.
1490 	 * Later chips can handle all 1/8th fractions.
1491 	 *
1492 	 * If the integral part of the divisor is 1, a special rule applies: the
1493 	 * fractional part can only be .0 or .5 (this is a limitation of the
1494 	 * hardware).  We handle this by truncating the fraction rather than
1495 	 * rounding, because this only applies to the two fastest speeds the
1496 	 * chip can achieve and rounding doesn't matter, either you've asked for
1497 	 * that exact speed or you've asked for something the chip can't do.
1498 	 *
1499 	 * For the FT8U232AM chips, use a roundoff table to adjust the result
1500 	 * to the nearest 1/8th fraction that is supported by the hardware,
1501 	 * leaving a fixed-point number with a 3-bit fraction which exactly
1502 	 * represents the math the hardware divider will do.  For later-series
1503 	 * chips that support all 8 fractional divisors, just round 16ths to
1504 	 * 8ths by adding 1 and dividing by 2.
1505 	 */
1506 	divisor = (clk << 4) / speed;
1507 	if ((divisor & 0xf) == 1)
1508 		divisor &= 0xfffffff8;
1509 	else if (sc->sc_devtype == DEVT_232A)
1510 		divisor += roundoff_232a[divisor & 0x0f];
1511 	else
1512 		divisor += 1;  /* Rounds odd 16ths up to next 8th. */
1513 	divisor >>= 1;
1514 
1515 	/*
1516 	 * Ensure the resulting hardware speed will be within operational
1517 	 * tolerance (within 3% of nominal).
1518 	 */
1519 	hwspeed = (clk << 3) / divisor;
1520 	if (!uftdi_baud_within_tolerance(hwspeed, speed))
1521 		return (ERANGE);
1522 
1523 	/*
1524 	 * Re-pack the divisor into hardware format. The lower 14-bits hold the
1525 	 * integral part, while the upper bits specify the fraction by indexing
1526 	 * a table of fractions within the hardware which is laid out as:
1527 	 *    {0.0, 0.5, 0.25, 0.125, 0.325, 0.625, 0.725, 0.875}
1528 	 * The A-series chips only have the first four table entries; the
1529 	 * roundoff table logic above ensures that the fractional part for those
1530 	 * chips will be one of the first four values.
1531 	 *
1532 	 * When the divisor is 1 a special encoding applies:  1.0 is encoded as
1533 	 * 0.0, and 1.5 is encoded as 1.0.  The rounding logic above has already
1534 	 * ensured that the fraction is either .0 or .5 if the integral is 1.
1535 	 */
1536 	frac = divisor & 0x07;
1537 	divisor >>= 3;
1538 	if (divisor == 1) {
1539 		if (frac == 0)
1540 			divisor = 0;  /* 1.0 becomes 0.0 */
1541 		else
1542 			frac = 0;     /* 1.5 becomes 1.0 */
1543 	}
1544 	divisor |= (encoded_fraction[frac] << 14) | fastclk_flag;
1545 
1546 	cfg->baud_lobits = (uint16_t)divisor;
1547 	cfg->baud_hibits = (uint16_t)(divisor >> 16);
1548 
1549 	/*
1550 	 * If this chip requires the baud bits to be in the high byte of the
1551 	 * index word, move the bits up to that location.
1552 	 */
1553 	if (sc->sc_devflags & DEVF_BAUDBITS_HINDEX) {
1554 		cfg->baud_hibits <<= 8;
1555 	}
1556 
1557 	return (0);
1558 }
1559 
1560 static int
1561 uftdi_set_parm_soft(struct ucom_softc *ucom, struct termios *t,
1562     struct uftdi_param_config *cfg)
1563 {
1564 	struct uftdi_softc *sc = ucom->sc_parent;
1565 	int err;
1566 
1567 	memset(cfg, 0, sizeof(*cfg));
1568 
1569 	if (sc->sc_devtype == DEVT_SIO)
1570 		err = uftdi_sio_encode_baudrate(sc, t->c_ospeed, cfg);
1571 	else
1572 		err = uftdi_encode_baudrate(sc, t->c_ospeed, cfg);
1573 	if (err != 0)
1574 		return (err);
1575 
1576 	if (t->c_cflag & CSTOPB)
1577 		cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_2;
1578 	else
1579 		cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_1;
1580 
1581 	if (t->c_cflag & PARENB) {
1582 		if (t->c_cflag & PARODD) {
1583 			cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_ODD;
1584 		} else {
1585 			cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_EVEN;
1586 		}
1587 	} else {
1588 		cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_NONE;
1589 	}
1590 
1591 	switch (t->c_cflag & CSIZE) {
1592 	case CS5:
1593 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(5);
1594 		break;
1595 
1596 	case CS6:
1597 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(6);
1598 		break;
1599 
1600 	case CS7:
1601 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(7);
1602 		break;
1603 
1604 	case CS8:
1605 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(8);
1606 		break;
1607 	}
1608 
1609 	if (t->c_cflag & CRTSCTS) {
1610 		cfg->v_flow = FTDI_SIO_RTS_CTS_HS;
1611 	} else if (t->c_iflag & (IXON | IXOFF)) {
1612 		cfg->v_flow = FTDI_SIO_XON_XOFF_HS;
1613 		cfg->v_start = t->c_cc[VSTART];
1614 		cfg->v_stop = t->c_cc[VSTOP];
1615 	} else {
1616 		cfg->v_flow = FTDI_SIO_DISABLE_FLOW_CTRL;
1617 	}
1618 
1619 	return (0);
1620 }
1621 
1622 static int
1623 uftdi_pre_param(struct ucom_softc *ucom, struct termios *t)
1624 {
1625 	struct uftdi_param_config cfg;
1626 
1627 	DPRINTF("\n");
1628 
1629 	return (uftdi_set_parm_soft(ucom, t, &cfg));
1630 }
1631 
1632 static void
1633 uftdi_cfg_param(struct ucom_softc *ucom, struct termios *t)
1634 {
1635 	struct uftdi_softc *sc = ucom->sc_parent;
1636 	uint16_t wIndex = ucom->sc_portno;
1637 	struct uftdi_param_config cfg;
1638 	struct usb_device_request req;
1639 
1640 	DPRINTF("\n");
1641 
1642 	if (uftdi_set_parm_soft(ucom, t, &cfg)) {
1643 		/* should not happen */
1644 		return;
1645 	}
1646 	sc->sc_last_lcr = cfg.lcr;
1647 
1648 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1649 	req.bRequest = FTDI_SIO_SET_BAUD_RATE;
1650 	USETW(req.wValue, cfg.baud_lobits);
1651 	USETW(req.wIndex, cfg.baud_hibits | wIndex);
1652 	USETW(req.wLength, 0);
1653 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1654 	    &req, NULL, 0, 1000);
1655 
1656 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1657 	req.bRequest = FTDI_SIO_SET_DATA;
1658 	USETW(req.wValue, cfg.lcr);
1659 	USETW(req.wIndex, wIndex);
1660 	USETW(req.wLength, 0);
1661 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1662 	    &req, NULL, 0, 1000);
1663 
1664 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1665 	req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
1666 	USETW2(req.wValue, cfg.v_stop, cfg.v_start);
1667 	USETW2(req.wIndex, cfg.v_flow, wIndex);
1668 	USETW(req.wLength, 0);
1669 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1670 	    &req, NULL, 0, 1000);
1671 }
1672 
1673 static void
1674 uftdi_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
1675 {
1676 	struct uftdi_softc *sc = ucom->sc_parent;
1677 
1678 	DPRINTFN(3, "msr=0x%02x lsr=0x%02x\n", sc->sc_msr, sc->sc_lsr);
1679 
1680 	*msr = sc->sc_msr;
1681 	*lsr = sc->sc_lsr;
1682 }
1683 
1684 static int
1685 uftdi_reset(struct ucom_softc *ucom, int reset_type)
1686 {
1687 	struct uftdi_softc *sc = ucom->sc_parent;
1688 	usb_device_request_t req;
1689 
1690 	DPRINTFN(2, "\n");
1691 
1692 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1693 	req.bRequest = FTDI_SIO_RESET;
1694 
1695 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1696 	USETW(req.wLength, 0);
1697 	USETW(req.wValue, reset_type);
1698 
1699 	return (usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL));
1700 }
1701 
1702 static int
1703 uftdi_set_bitmode(struct ucom_softc *ucom, uint8_t bitmode, uint8_t iomask)
1704 {
1705 	struct uftdi_softc *sc = ucom->sc_parent;
1706 	usb_device_request_t req;
1707 	int rv;
1708 
1709 	DPRINTFN(2, "\n");
1710 
1711 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1712 	req.bRequest = FTDI_SIO_SET_BITMODE;
1713 
1714 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1715 	USETW(req.wLength, 0);
1716 
1717 	if (bitmode == UFTDI_BITMODE_NONE)
1718 	    USETW2(req.wValue, 0, 0);
1719 	else
1720 	    USETW2(req.wValue, (1 << bitmode), iomask);
1721 
1722 	rv = usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL);
1723 	if (rv == USB_ERR_NORMAL_COMPLETION)
1724 		sc->sc_bitmode = bitmode;
1725 
1726 	return (rv);
1727 }
1728 
1729 static int
1730 uftdi_get_bitmode(struct ucom_softc *ucom, uint8_t *bitmode, uint8_t *iomask)
1731 {
1732 	struct uftdi_softc *sc = ucom->sc_parent;
1733 	usb_device_request_t req;
1734 
1735 	DPRINTFN(2, "\n");
1736 
1737 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
1738 	req.bRequest = FTDI_SIO_GET_BITMODE;
1739 
1740 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1741 	USETW(req.wLength, 1);
1742 	USETW(req.wValue,  0);
1743 
1744 	*bitmode = sc->sc_bitmode;
1745 	return (usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, iomask));
1746 }
1747 
1748 static int
1749 uftdi_set_latency(struct ucom_softc *ucom, int latency)
1750 {
1751 	struct uftdi_softc *sc = ucom->sc_parent;
1752 	usb_device_request_t req;
1753 
1754 	DPRINTFN(2, "\n");
1755 
1756 	if (latency < 0 || latency > 255)
1757 		return (USB_ERR_INVAL);
1758 
1759 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1760 	req.bRequest = FTDI_SIO_SET_LATENCY;
1761 
1762 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1763 	USETW(req.wLength, 0);
1764 	USETW2(req.wValue, 0, latency);
1765 
1766 	return (usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL));
1767 }
1768 
1769 static int
1770 uftdi_get_latency(struct ucom_softc *ucom, int *latency)
1771 {
1772 	struct uftdi_softc *sc = ucom->sc_parent;
1773 	usb_device_request_t req;
1774 	usb_error_t err;
1775 	uint8_t buf;
1776 
1777 	DPRINTFN(2, "\n");
1778 
1779 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
1780 	req.bRequest = FTDI_SIO_GET_LATENCY;
1781 
1782 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1783 	USETW(req.wLength, 1);
1784 	USETW(req.wValue, 0);
1785 
1786 	err = usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, &buf);
1787 	*latency = buf;
1788 
1789 	return (err);
1790 }
1791 
1792 static int
1793 uftdi_set_event_char(struct ucom_softc *ucom, int echar)
1794 {
1795 	struct uftdi_softc *sc = ucom->sc_parent;
1796 	usb_device_request_t req;
1797 	uint8_t enable;
1798 
1799 	DPRINTFN(2, "\n");
1800 
1801 	enable = (echar == -1) ? 0 : 1;
1802 
1803 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1804 	req.bRequest = FTDI_SIO_SET_EVENT_CHAR;
1805 
1806 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1807 	USETW(req.wLength, 0);
1808 	USETW2(req.wValue, enable, echar & 0xff);
1809 
1810 	return (usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL));
1811 }
1812 
1813 static int
1814 uftdi_set_error_char(struct ucom_softc *ucom, int echar)
1815 {
1816 	struct uftdi_softc *sc = ucom->sc_parent;
1817 	usb_device_request_t req;
1818 	uint8_t enable;
1819 
1820 	DPRINTFN(2, "\n");
1821 
1822 	enable = (echar == -1) ? 0 : 1;
1823 
1824 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1825 	req.bRequest = FTDI_SIO_SET_ERROR_CHAR;
1826 
1827 	USETW(req.wIndex, sc->sc_ucom.sc_portno);
1828 	USETW(req.wLength, 0);
1829 	USETW2(req.wValue, enable, echar & 0xff);
1830 
1831 	return (usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL));
1832 }
1833 
1834 static int
1835 uftdi_read_eeprom(struct ucom_softc *ucom, struct uftdi_eeio *eeio)
1836 {
1837 	struct uftdi_softc *sc = ucom->sc_parent;
1838 	usb_device_request_t req;
1839 	usb_error_t err;
1840 	uint16_t widx, wlength, woffset;
1841 
1842 	DPRINTFN(3, "\n");
1843 
1844 	/* Offset and length must both be evenly divisible by two. */
1845 	if ((eeio->offset | eeio->length) & 0x01)
1846 		return (EINVAL);
1847 
1848 	woffset = eeio->offset / 2U;
1849 	wlength = eeio->length / 2U;
1850 	for (widx = 0; widx < wlength; widx++) {
1851 		req.bmRequestType = UT_READ_VENDOR_DEVICE;
1852 		req.bRequest = FTDI_SIO_READ_EEPROM;
1853 		USETW(req.wIndex, widx + woffset);
1854 		USETW(req.wLength, 2);
1855 		USETW(req.wValue, 0);
1856 		err = usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req,
1857 		    &eeio->data[widx]);
1858 		if (err != USB_ERR_NORMAL_COMPLETION)
1859 			return (err);
1860 	}
1861 	return (USB_ERR_NORMAL_COMPLETION);
1862 }
1863 
1864 static int
1865 uftdi_write_eeprom(struct ucom_softc *ucom, struct uftdi_eeio *eeio)
1866 {
1867 	struct uftdi_softc *sc = ucom->sc_parent;
1868 	usb_device_request_t req;
1869 	usb_error_t err;
1870 	uint16_t widx, wlength, woffset;
1871 
1872 	DPRINTFN(3, "\n");
1873 
1874 	/* Offset and length must both be evenly divisible by two. */
1875 	if ((eeio->offset | eeio->length) & 0x01)
1876 		return (EINVAL);
1877 
1878 	woffset = eeio->offset / 2U;
1879 	wlength = eeio->length / 2U;
1880 	for (widx = 0; widx < wlength; widx++) {
1881 		req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1882 		req.bRequest = FTDI_SIO_WRITE_EEPROM;
1883 		USETW(req.wIndex, widx + woffset);
1884 		USETW(req.wLength, 0);
1885 		USETW(req.wValue, eeio->data[widx]);
1886 		err = usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL);
1887 		if (err != USB_ERR_NORMAL_COMPLETION)
1888 			return (err);
1889 	}
1890 	return (USB_ERR_NORMAL_COMPLETION);
1891 }
1892 
1893 static int
1894 uftdi_erase_eeprom(struct ucom_softc *ucom, int confirmation)
1895 {
1896 	struct uftdi_softc *sc = ucom->sc_parent;
1897 	usb_device_request_t req;
1898 	usb_error_t err;
1899 
1900 	DPRINTFN(2, "\n");
1901 
1902 	/* Small effort to prevent accidental erasure. */
1903 	if (confirmation != UFTDI_CONFIRM_ERASE)
1904 		return (EINVAL);
1905 
1906 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1907 	req.bRequest = FTDI_SIO_ERASE_EEPROM;
1908 	USETW(req.wIndex, 0);
1909 	USETW(req.wLength, 0);
1910 	USETW(req.wValue, 0);
1911 	err = usbd_do_request(sc->sc_udev, &sc->sc_mtx, &req, NULL);
1912 
1913 	return (err);
1914 }
1915 
1916 static int
1917 uftdi_ioctl(struct ucom_softc *ucom, uint32_t cmd, caddr_t data,
1918     int flag, struct thread *td)
1919 {
1920 	struct uftdi_softc *sc = ucom->sc_parent;
1921 	int err;
1922 	struct uftdi_bitmode * mode;
1923 
1924 	switch (cmd) {
1925 	case UFTDIIOC_RESET_IO:
1926 	case UFTDIIOC_RESET_RX:
1927 	case UFTDIIOC_RESET_TX:
1928 		err = uftdi_reset(ucom,
1929 		    cmd == UFTDIIOC_RESET_IO ? FTDI_SIO_RESET_SIO :
1930 		    (cmd == UFTDIIOC_RESET_RX ? FTDI_SIO_RESET_PURGE_RX :
1931 		    FTDI_SIO_RESET_PURGE_TX));
1932 		break;
1933 	case UFTDIIOC_SET_BITMODE:
1934 		mode = (struct uftdi_bitmode *)data;
1935 		err = uftdi_set_bitmode(ucom, mode->mode, mode->iomask);
1936 		break;
1937 	case UFTDIIOC_GET_BITMODE:
1938 		mode = (struct uftdi_bitmode *)data;
1939 		err = uftdi_get_bitmode(ucom, &mode->mode, &mode->iomask);
1940 		break;
1941 	case UFTDIIOC_SET_LATENCY:
1942 		err = uftdi_set_latency(ucom, *((int *)data));
1943 		break;
1944 	case UFTDIIOC_GET_LATENCY:
1945 		err = uftdi_get_latency(ucom, (int *)data);
1946 		break;
1947 	case UFTDIIOC_SET_ERROR_CHAR:
1948 		err = uftdi_set_error_char(ucom, *(int *)data);
1949 		break;
1950 	case UFTDIIOC_SET_EVENT_CHAR:
1951 		err = uftdi_set_event_char(ucom, *(int *)data);
1952 		break;
1953 	case UFTDIIOC_GET_HWREV:
1954 		*(int *)data = sc->sc_bcdDevice;
1955 		err = 0;
1956 		break;
1957 	case UFTDIIOC_READ_EEPROM:
1958 		err = uftdi_read_eeprom(ucom, (struct uftdi_eeio *)data);
1959 		break;
1960 	case UFTDIIOC_WRITE_EEPROM:
1961 		err = uftdi_write_eeprom(ucom, (struct uftdi_eeio *)data);
1962 		break;
1963 	case UFTDIIOC_ERASE_EEPROM:
1964 		err = uftdi_erase_eeprom(ucom, *(int *)data);
1965 		break;
1966 	default:
1967 		return (ENOIOCTL);
1968 	}
1969 	if (err != USB_ERR_NORMAL_COMPLETION)
1970 		return (EIO);
1971 	return (0);
1972 }
1973 
1974 static void
1975 uftdi_start_read(struct ucom_softc *ucom)
1976 {
1977 	struct uftdi_softc *sc = ucom->sc_parent;
1978 
1979 	usbd_transfer_start(sc->sc_xfer[UFTDI_BULK_DT_RD]);
1980 }
1981 
1982 static void
1983 uftdi_stop_read(struct ucom_softc *ucom)
1984 {
1985 	struct uftdi_softc *sc = ucom->sc_parent;
1986 
1987 	usbd_transfer_stop(sc->sc_xfer[UFTDI_BULK_DT_RD]);
1988 }
1989 
1990 static void
1991 uftdi_start_write(struct ucom_softc *ucom)
1992 {
1993 	struct uftdi_softc *sc = ucom->sc_parent;
1994 
1995 	usbd_transfer_start(sc->sc_xfer[UFTDI_BULK_DT_WR]);
1996 }
1997 
1998 static void
1999 uftdi_stop_write(struct ucom_softc *ucom)
2000 {
2001 	struct uftdi_softc *sc = ucom->sc_parent;
2002 
2003 	usbd_transfer_stop(sc->sc_xfer[UFTDI_BULK_DT_WR]);
2004 }
2005 
2006 static void
2007 uftdi_poll(struct ucom_softc *ucom)
2008 {
2009 	struct uftdi_softc *sc = ucom->sc_parent;
2010 
2011 	usbd_transfer_poll(sc->sc_xfer, UFTDI_N_TRANSFER);
2012 }
2013