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