xref: /dragonfly/sys/bus/u4b/serial/uftdi.c (revision 9f7604d7)
1 /*	$NetBSD: uftdi.c,v 1.13 2002/09/23 05:51:23 simonb Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net).
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * NOTE: all function names beginning like "uftdi_cfg_" can only
34  * be called from within the config thread function !
35  */
36 
37 /*
38  * FTDI FT8U100AX serial adapter driver
39  */
40 
41 #include <sys/stdint.h>
42 #include <sys/param.h>
43 #include <sys/queue.h>
44 #include <sys/types.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/bus.h>
48 #include <sys/module.h>
49 #include <sys/lock.h>
50 #include <sys/condvar.h>
51 #include <sys/sysctl.h>
52 #include <sys/unistd.h>
53 #include <sys/callout.h>
54 #include <sys/malloc.h>
55 #include <sys/priv.h>
56 
57 #include <bus/u4b/usb.h>
58 #include <bus/u4b/usbdi.h>
59 #include <bus/u4b/usbdi_util.h>
60 #include <bus/u4b/usbdevs.h>
61 
62 #define	USB_DEBUG_VAR uftdi_debug
63 #include <bus/u4b/usb_debug.h>
64 #include <bus/u4b/usb_process.h>
65 
66 #include <bus/u4b/serial/usb_serial.h>
67 #include <bus/u4b/serial/uftdi_reg.h>
68 
69 #ifdef USB_DEBUG
70 static int uftdi_debug = 0;
71 
72 static SYSCTL_NODE(_hw_usb, OID_AUTO, uftdi, CTLFLAG_RW, 0, "USB uftdi");
73 SYSCTL_INT(_hw_usb_uftdi, OID_AUTO, debug, CTLFLAG_RW,
74     &uftdi_debug, 0, "Debug level");
75 #endif
76 
77 #define	UFTDI_CONFIG_INDEX	0
78 #define	UFTDI_IFACE_INDEX	0
79 
80 #define	UFTDI_OBUFSIZE 64		/* bytes, cannot be increased due to
81 					 * do size encoding */
82 
83 enum {
84 	UFTDI_BULK_DT_WR,
85 	UFTDI_BULK_DT_RD,
86 	UFTDI_N_TRANSFER,
87 };
88 
89 struct uftdi_softc {
90 	struct ucom_super_softc sc_super_ucom;
91 	struct ucom_softc sc_ucom;
92 
93 	struct usb_device *sc_udev;
94 	struct usb_xfer *sc_xfer[UFTDI_N_TRANSFER];
95 	device_t sc_dev;
96 	struct lock sc_lock;
97 
98 	uint32_t sc_unit;
99 	enum uftdi_type sc_type;
100 
101 	uint16_t sc_last_lcr;
102 
103 	uint8_t	sc_iface_index;
104 	uint8_t	sc_hdrlen;
105 	uint8_t	sc_msr;
106 	uint8_t	sc_lsr;
107 
108 	uint8_t	sc_name[16];
109 };
110 
111 struct uftdi_param_config {
112 	uint16_t rate;
113 	uint16_t lcr;
114 	uint8_t	v_start;
115 	uint8_t	v_stop;
116 	uint8_t	v_flow;
117 };
118 
119 /* prototypes */
120 
121 static device_probe_t uftdi_probe;
122 static device_attach_t uftdi_attach;
123 static device_detach_t uftdi_detach;
124 
125 static usb_callback_t uftdi_write_callback;
126 static usb_callback_t uftdi_read_callback;
127 
128 static void	uftdi_cfg_open(struct ucom_softc *);
129 static void	uftdi_cfg_set_dtr(struct ucom_softc *, uint8_t);
130 static void	uftdi_cfg_set_rts(struct ucom_softc *, uint8_t);
131 static void	uftdi_cfg_set_break(struct ucom_softc *, uint8_t);
132 static int	uftdi_set_parm_soft(struct termios *,
133 		    struct uftdi_param_config *, uint8_t);
134 static int	uftdi_pre_param(struct ucom_softc *, struct termios *);
135 static void	uftdi_cfg_param(struct ucom_softc *, struct termios *);
136 static void	uftdi_cfg_get_status(struct ucom_softc *, uint8_t *,
137 		    uint8_t *);
138 static void	uftdi_start_read(struct ucom_softc *);
139 static void	uftdi_stop_read(struct ucom_softc *);
140 static void	uftdi_start_write(struct ucom_softc *);
141 static void	uftdi_stop_write(struct ucom_softc *);
142 static uint8_t	uftdi_8u232am_getrate(uint32_t, uint16_t *);
143 static void	uftdi_poll(struct ucom_softc *ucom);
144 
145 static const struct usb_config uftdi_config[UFTDI_N_TRANSFER] = {
146 
147 	[UFTDI_BULK_DT_WR] = {
148 		.type = UE_BULK,
149 		.endpoint = UE_ADDR_ANY,
150 		.direction = UE_DIR_OUT,
151 		.bufsize = UFTDI_OBUFSIZE,
152 		.flags = {.pipe_bof = 1,},
153 		.callback = &uftdi_write_callback,
154 	},
155 
156 	[UFTDI_BULK_DT_RD] = {
157 		.type = UE_BULK,
158 		.endpoint = UE_ADDR_ANY,
159 		.direction = UE_DIR_IN,
160 		.bufsize = 0,		/* use wMaxPacketSize */
161 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
162 		.callback = &uftdi_read_callback,
163 	},
164 };
165 
166 static const struct ucom_callback uftdi_callback = {
167 	.ucom_cfg_get_status = &uftdi_cfg_get_status,
168 	.ucom_cfg_set_dtr = &uftdi_cfg_set_dtr,
169 	.ucom_cfg_set_rts = &uftdi_cfg_set_rts,
170 	.ucom_cfg_set_break = &uftdi_cfg_set_break,
171 	.ucom_cfg_param = &uftdi_cfg_param,
172 	.ucom_cfg_open = &uftdi_cfg_open,
173 	.ucom_pre_param = &uftdi_pre_param,
174 	.ucom_start_read = &uftdi_start_read,
175 	.ucom_stop_read = &uftdi_stop_read,
176 	.ucom_start_write = &uftdi_start_write,
177 	.ucom_stop_write = &uftdi_stop_write,
178 	.ucom_poll = &uftdi_poll,
179 };
180 
181 static device_method_t uftdi_methods[] = {
182 	/* Device interface */
183 	DEVMETHOD(device_probe, uftdi_probe),
184 	DEVMETHOD(device_attach, uftdi_attach),
185 	DEVMETHOD(device_detach, uftdi_detach),
186 
187 	DEVMETHOD_END
188 };
189 
190 static devclass_t uftdi_devclass;
191 
192 static driver_t uftdi_driver = {
193 	.name = "uftdi",
194 	.methods = uftdi_methods,
195 	.size = sizeof(struct uftdi_softc),
196 };
197 
198 DRIVER_MODULE(uftdi, uhub, uftdi_driver, uftdi_devclass, NULL, 0);
199 MODULE_DEPEND(uftdi, ucom, 1, 1, 1);
200 MODULE_DEPEND(uftdi, usb, 1, 1, 1);
201 MODULE_VERSION(uftdi, 1);
202 
203 static STRUCT_USB_HOST_ID uftdi_devs[] = {
204 #define	UFTDI_DEV(v,p,t) \
205   { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, UFTDI_TYPE_##t) }
206 	UFTDI_DEV(ATMEL, STK541, 8U232AM),
207 	UFTDI_DEV(DRESDENELEKTRONIK, SENSORTERMINALBOARD, 8U232AM),
208 	UFTDI_DEV(DRESDENELEKTRONIK, WIRELESSHANDHELDTERMINAL, 8U232AM),
209 	UFTDI_DEV(FALCOM, TWIST, 8U232AM),
210 	UFTDI_DEV(FTDI, GAMMASCOUT, 8U232AM),
211 	UFTDI_DEV(FTDI, SERIAL_8U100AX, SIO),
212 	UFTDI_DEV(FTDI, SERIAL_2232C, 8U232AM),
213 	UFTDI_DEV(FTDI, SERIAL_2232D, 8U232AM),
214 	UFTDI_DEV(FTDI, BEAGLEBONE, 8U232AM),
215 	UFTDI_DEV(FTDI, SERIAL_4232H, 8U232AM),
216 	UFTDI_DEV(FTDI, SERIAL_8U232AM, 8U232AM),
217 	UFTDI_DEV(FTDI, SERIAL_8U232AM4, 8U232AM),
218 	UFTDI_DEV(FTDI, SEMC_DSS20, 8U232AM),
219 	UFTDI_DEV(FTDI, CFA_631, 8U232AM),
220 	UFTDI_DEV(FTDI, CFA_632, 8U232AM),
221 	UFTDI_DEV(FTDI, CFA_633, 8U232AM),
222 	UFTDI_DEV(FTDI, CFA_634, 8U232AM),
223 	UFTDI_DEV(FTDI, CFA_635, 8U232AM),
224 	UFTDI_DEV(FTDI, USB_UIRT, 8U232AM),
225 	UFTDI_DEV(FTDI, USBSERIAL, 8U232AM),
226 	UFTDI_DEV(FTDI, KBS, 8U232AM),
227 	UFTDI_DEV(FTDI, MX2_3, 8U232AM),
228 	UFTDI_DEV(FTDI, MX4_5, 8U232AM),
229 	UFTDI_DEV(FTDI, LK202, 8U232AM),
230 	UFTDI_DEV(FTDI, LK204, 8U232AM),
231 	UFTDI_DEV(FTDI, TACTRIX_OPENPORT_13M, 8U232AM),
232 	UFTDI_DEV(FTDI, TACTRIX_OPENPORT_13S, 8U232AM),
233 	UFTDI_DEV(FTDI, TACTRIX_OPENPORT_13U, 8U232AM),
234 	UFTDI_DEV(FTDI, EISCOU, 8U232AM),
235 	UFTDI_DEV(FTDI, UOPTBR, 8U232AM),
236 	UFTDI_DEV(FTDI, EMCU2D, 8U232AM),
237 	UFTDI_DEV(FTDI, PCMSFU, 8U232AM),
238 	UFTDI_DEV(FTDI, EMCU2H, 8U232AM),
239 	UFTDI_DEV(FTDI, MAXSTREAM, 8U232AM),
240 	UFTDI_DEV(FTDI, CTI_USB_NANO_485, 8U232AM),
241 	UFTDI_DEV(FTDI, CTI_USB_MINI_485, 8U232AM),
242 	UFTDI_DEV(SIIG2, US2308, 8U232AM),
243 	UFTDI_DEV(INTREPIDCS, VALUECAN, 8U232AM),
244 	UFTDI_DEV(INTREPIDCS, NEOVI, 8U232AM),
245 	UFTDI_DEV(BBELECTRONICS, USOTL4, 8U232AM),
246 	UFTDI_DEV(MATRIXORBITAL, MOUA, 8U232AM),
247 	UFTDI_DEV(MARVELL, SHEEVAPLUG, 8U232AM),
248 	UFTDI_DEV(MELCO, PCOPRS1, 8U232AM),
249 	UFTDI_DEV(RATOC, REXUSB60F, 8U232AM),
250 #undef UFTDI_DEV
251 };
252 
253 static int
254 uftdi_probe(device_t dev)
255 {
256 	struct usb_attach_arg *uaa = device_get_ivars(dev);
257 
258 	if (uaa->usb_mode != USB_MODE_HOST) {
259 		return (ENXIO);
260 	}
261 	if (uaa->info.bConfigIndex != UFTDI_CONFIG_INDEX) {
262 		return (ENXIO);
263 	}
264 	/* attach to all present interfaces */
265 
266 	return (usbd_lookup_id_by_uaa(uftdi_devs, sizeof(uftdi_devs), uaa));
267 }
268 
269 static int
270 uftdi_attach(device_t dev)
271 {
272 	struct usb_attach_arg *uaa = device_get_ivars(dev);
273 	struct uftdi_softc *sc = device_get_softc(dev);
274 	int error;
275 
276 	sc->sc_udev = uaa->device;
277 	sc->sc_dev = dev;
278 	sc->sc_unit = device_get_unit(dev);
279 
280 	device_set_usb_desc(dev);
281 	lockinit(&sc->sc_lock, "uftdi", 0, LK_CANRECURSE);
282 
283 	ksnprintf(sc->sc_name, sizeof(sc->sc_name),
284 	    "%s", device_get_nameunit(dev));
285 
286 	DPRINTF("\n");
287 
288 	sc->sc_iface_index = uaa->info.bIfaceIndex;
289 	sc->sc_type = USB_GET_DRIVER_INFO(uaa);
290 
291 	switch (sc->sc_type) {
292 	case UFTDI_TYPE_SIO:
293 		sc->sc_hdrlen = 1;
294 		break;
295 	case UFTDI_TYPE_8U232AM:
296 	default:
297 		sc->sc_hdrlen = 0;
298 		break;
299 	}
300 
301 	error = usbd_transfer_setup(uaa->device,
302 	    &sc->sc_iface_index, sc->sc_xfer, uftdi_config,
303 	    UFTDI_N_TRANSFER, sc, &sc->sc_lock);
304 
305 	if (error) {
306 		device_printf(dev, "allocating USB "
307 		    "transfers failed\n");
308 		goto detach;
309 	}
310 	sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
311 
312 	/* clear stall at first run */
313 	lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
314 	usbd_xfer_set_stall(sc->sc_xfer[UFTDI_BULK_DT_WR]);
315 	usbd_xfer_set_stall(sc->sc_xfer[UFTDI_BULK_DT_RD]);
316 	lockmgr(&sc->sc_lock, LK_RELEASE);
317 
318 	/* set a valid "lcr" value */
319 
320 	sc->sc_last_lcr =
321 	    (FTDI_SIO_SET_DATA_STOP_BITS_2 |
322 	    FTDI_SIO_SET_DATA_PARITY_NONE |
323 	    FTDI_SIO_SET_DATA_BITS(8));
324 
325 	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
326 	    &uftdi_callback, &sc->sc_lock);
327 	if (error) {
328 		goto detach;
329 	}
330 	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
331 
332 	return (0);			/* success */
333 
334 detach:
335 	uftdi_detach(dev);
336 	return (ENXIO);
337 }
338 
339 static int
340 uftdi_detach(device_t dev)
341 {
342 	struct uftdi_softc *sc = device_get_softc(dev);
343 
344 	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
345 	usbd_transfer_unsetup(sc->sc_xfer, UFTDI_N_TRANSFER);
346 	lockuninit(&sc->sc_lock);
347 
348 	return (0);
349 }
350 
351 static void
352 uftdi_cfg_open(struct ucom_softc *ucom)
353 {
354 	struct uftdi_softc *sc = ucom->sc_parent;
355 	uint16_t wIndex = ucom->sc_portno;
356 	struct usb_device_request req;
357 
358 	DPRINTF("");
359 
360 	/* perform a full reset on the device */
361 
362 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
363 	req.bRequest = FTDI_SIO_RESET;
364 	USETW(req.wValue, FTDI_SIO_RESET_SIO);
365 	USETW(req.wIndex, wIndex);
366 	USETW(req.wLength, 0);
367 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
368 	    &req, NULL, 0, 1000);
369 
370 	/* turn on RTS/CTS flow control */
371 
372 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
373 	req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
374 	USETW(req.wValue, 0);
375 	USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, wIndex);
376 	USETW(req.wLength, 0);
377 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
378 	    &req, NULL, 0, 1000);
379 
380 	/*
381 	 * NOTE: with the new UCOM layer there will always be a
382 	 * "uftdi_cfg_param()" call after "open()", so there is no need for
383 	 * "open()" to configure anything
384 	 */
385 }
386 
387 static void
388 uftdi_write_callback(struct usb_xfer *xfer, usb_error_t error)
389 {
390 	struct uftdi_softc *sc = usbd_xfer_softc(xfer);
391 	struct usb_page_cache *pc;
392 	uint32_t actlen;
393 	uint8_t buf[1];
394 
395 	switch (USB_GET_STATE(xfer)) {
396 	case USB_ST_SETUP:
397 	case USB_ST_TRANSFERRED:
398 tr_setup:
399 		pc = usbd_xfer_get_frame(xfer, 0);
400 		if (ucom_get_data(&sc->sc_ucom, pc,
401 		    sc->sc_hdrlen, UFTDI_OBUFSIZE - sc->sc_hdrlen,
402 		    &actlen)) {
403 
404 			if (sc->sc_hdrlen > 0) {
405 				buf[0] =
406 				    FTDI_OUT_TAG(actlen, sc->sc_ucom.sc_portno);
407 				usbd_copy_in(pc, 0, buf, 1);
408 			}
409 			usbd_xfer_set_frame_len(xfer, 0, actlen + sc->sc_hdrlen);
410 			usbd_transfer_submit(xfer);
411 		}
412 		return;
413 
414 	default:			/* Error */
415 		if (error != USB_ERR_CANCELLED) {
416 			/* try to clear stall first */
417 			usbd_xfer_set_stall(xfer);
418 			goto tr_setup;
419 		}
420 		return;
421 	}
422 }
423 
424 static void
425 uftdi_read_callback(struct usb_xfer *xfer, usb_error_t error)
426 {
427 	struct uftdi_softc *sc = usbd_xfer_softc(xfer);
428 	struct usb_page_cache *pc;
429 	uint8_t buf[2];
430 	uint8_t ftdi_msr;
431 	uint8_t msr;
432 	uint8_t lsr;
433 	int actlen;
434 
435 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
436 
437 	switch (USB_GET_STATE(xfer)) {
438 	case USB_ST_TRANSFERRED:
439 
440 		if (actlen < 2) {
441 			goto tr_setup;
442 		}
443 		pc = usbd_xfer_get_frame(xfer, 0);
444 		usbd_copy_out(pc, 0, buf, 2);
445 
446 		ftdi_msr = FTDI_GET_MSR(buf);
447 		lsr = FTDI_GET_LSR(buf);
448 
449 		msr = 0;
450 		if (ftdi_msr & FTDI_SIO_CTS_MASK)
451 			msr |= SER_CTS;
452 		if (ftdi_msr & FTDI_SIO_DSR_MASK)
453 			msr |= SER_DSR;
454 		if (ftdi_msr & FTDI_SIO_RI_MASK)
455 			msr |= SER_RI;
456 		if (ftdi_msr & FTDI_SIO_RLSD_MASK)
457 			msr |= SER_DCD;
458 
459 		if ((sc->sc_msr != msr) ||
460 		    ((sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK))) {
461 			DPRINTF("status change msr=0x%02x (0x%02x) "
462 			    "lsr=0x%02x (0x%02x)\n", msr, sc->sc_msr,
463 			    lsr, sc->sc_lsr);
464 
465 			sc->sc_msr = msr;
466 			sc->sc_lsr = lsr;
467 
468 			ucom_status_change(&sc->sc_ucom);
469 		}
470 		actlen -= 2;
471 
472 		if (actlen > 0) {
473 			ucom_put_data(&sc->sc_ucom, pc, 2, actlen);
474 		}
475 	case USB_ST_SETUP:
476 tr_setup:
477 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
478 		usbd_transfer_submit(xfer);
479 		return;
480 
481 	default:			/* Error */
482 		if (error != USB_ERR_CANCELLED) {
483 			/* try to clear stall first */
484 			usbd_xfer_set_stall(xfer);
485 			goto tr_setup;
486 		}
487 		return;
488 	}
489 }
490 
491 static void
492 uftdi_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
493 {
494 	struct uftdi_softc *sc = ucom->sc_parent;
495 	uint16_t wIndex = ucom->sc_portno;
496 	uint16_t wValue;
497 	struct usb_device_request req;
498 
499 	wValue = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW;
500 
501 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
502 	req.bRequest = FTDI_SIO_MODEM_CTRL;
503 	USETW(req.wValue, wValue);
504 	USETW(req.wIndex, wIndex);
505 	USETW(req.wLength, 0);
506 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
507 	    &req, NULL, 0, 1000);
508 }
509 
510 static void
511 uftdi_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
512 {
513 	struct uftdi_softc *sc = ucom->sc_parent;
514 	uint16_t wIndex = ucom->sc_portno;
515 	uint16_t wValue;
516 	struct usb_device_request req;
517 
518 	wValue = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW;
519 
520 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
521 	req.bRequest = FTDI_SIO_MODEM_CTRL;
522 	USETW(req.wValue, wValue);
523 	USETW(req.wIndex, wIndex);
524 	USETW(req.wLength, 0);
525 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
526 	    &req, NULL, 0, 1000);
527 }
528 
529 static void
530 uftdi_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
531 {
532 	struct uftdi_softc *sc = ucom->sc_parent;
533 	uint16_t wIndex = ucom->sc_portno;
534 	uint16_t wValue;
535 	struct usb_device_request req;
536 
537 	if (onoff) {
538 		sc->sc_last_lcr |= FTDI_SIO_SET_BREAK;
539 	} else {
540 		sc->sc_last_lcr &= ~FTDI_SIO_SET_BREAK;
541 	}
542 
543 	wValue = sc->sc_last_lcr;
544 
545 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
546 	req.bRequest = FTDI_SIO_SET_DATA;
547 	USETW(req.wValue, wValue);
548 	USETW(req.wIndex, wIndex);
549 	USETW(req.wLength, 0);
550 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
551 	    &req, NULL, 0, 1000);
552 }
553 
554 static int
555 uftdi_set_parm_soft(struct termios *t,
556     struct uftdi_param_config *cfg, uint8_t type)
557 {
558 	memset(cfg, 0, sizeof(*cfg));
559 
560 	switch (type) {
561 	case UFTDI_TYPE_SIO:
562 		switch (t->c_ospeed) {
563 		case 300:
564 			cfg->rate = ftdi_sio_b300;
565 			break;
566 		case 600:
567 			cfg->rate = ftdi_sio_b600;
568 			break;
569 		case 1200:
570 			cfg->rate = ftdi_sio_b1200;
571 			break;
572 		case 2400:
573 			cfg->rate = ftdi_sio_b2400;
574 			break;
575 		case 4800:
576 			cfg->rate = ftdi_sio_b4800;
577 			break;
578 		case 9600:
579 			cfg->rate = ftdi_sio_b9600;
580 			break;
581 		case 19200:
582 			cfg->rate = ftdi_sio_b19200;
583 			break;
584 		case 38400:
585 			cfg->rate = ftdi_sio_b38400;
586 			break;
587 		case 57600:
588 			cfg->rate = ftdi_sio_b57600;
589 			break;
590 		case 115200:
591 			cfg->rate = ftdi_sio_b115200;
592 			break;
593 		default:
594 			return (EINVAL);
595 		}
596 		break;
597 
598 	case UFTDI_TYPE_8U232AM:
599 		if (uftdi_8u232am_getrate(t->c_ospeed, &cfg->rate)) {
600 			return (EINVAL);
601 		}
602 		break;
603 	}
604 
605 	if (t->c_cflag & CSTOPB)
606 		cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_2;
607 	else
608 		cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_1;
609 
610 	if (t->c_cflag & PARENB) {
611 		if (t->c_cflag & PARODD) {
612 			cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_ODD;
613 		} else {
614 			cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_EVEN;
615 		}
616 	} else {
617 		cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_NONE;
618 	}
619 
620 	switch (t->c_cflag & CSIZE) {
621 	case CS5:
622 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(5);
623 		break;
624 
625 	case CS6:
626 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(6);
627 		break;
628 
629 	case CS7:
630 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(7);
631 		break;
632 
633 	case CS8:
634 		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(8);
635 		break;
636 	}
637 
638 	if (t->c_cflag & CRTSCTS) {
639 		cfg->v_flow = FTDI_SIO_RTS_CTS_HS;
640 	} else if (t->c_iflag & (IXON | IXOFF)) {
641 		cfg->v_flow = FTDI_SIO_XON_XOFF_HS;
642 		cfg->v_start = t->c_cc[VSTART];
643 		cfg->v_stop = t->c_cc[VSTOP];
644 	} else {
645 		cfg->v_flow = FTDI_SIO_DISABLE_FLOW_CTRL;
646 	}
647 
648 	return (0);
649 }
650 
651 static int
652 uftdi_pre_param(struct ucom_softc *ucom, struct termios *t)
653 {
654 	struct uftdi_softc *sc = ucom->sc_parent;
655 	struct uftdi_param_config cfg;
656 
657 	DPRINTF("\n");
658 
659 	return (uftdi_set_parm_soft(t, &cfg, sc->sc_type));
660 }
661 
662 static void
663 uftdi_cfg_param(struct ucom_softc *ucom, struct termios *t)
664 {
665 	struct uftdi_softc *sc = ucom->sc_parent;
666 	uint16_t wIndex = ucom->sc_portno;
667 	struct uftdi_param_config cfg;
668 	struct usb_device_request req;
669 
670 	if (uftdi_set_parm_soft(t, &cfg, sc->sc_type)) {
671 		/* should not happen */
672 		return;
673 	}
674 	sc->sc_last_lcr = cfg.lcr;
675 
676 	DPRINTF("\n");
677 
678 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
679 	req.bRequest = FTDI_SIO_SET_BAUD_RATE;
680 	USETW(req.wValue, cfg.rate);
681 	USETW(req.wIndex, wIndex);
682 	USETW(req.wLength, 0);
683 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
684 	    &req, NULL, 0, 1000);
685 
686 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
687 	req.bRequest = FTDI_SIO_SET_DATA;
688 	USETW(req.wValue, cfg.lcr);
689 	USETW(req.wIndex, wIndex);
690 	USETW(req.wLength, 0);
691 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
692 	    &req, NULL, 0, 1000);
693 
694 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
695 	req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
696 	USETW2(req.wValue, cfg.v_stop, cfg.v_start);
697 	USETW2(req.wIndex, cfg.v_flow, wIndex);
698 	USETW(req.wLength, 0);
699 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
700 	    &req, NULL, 0, 1000);
701 }
702 
703 static void
704 uftdi_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
705 {
706 	struct uftdi_softc *sc = ucom->sc_parent;
707 
708 	DPRINTF("msr=0x%02x lsr=0x%02x\n",
709 	    sc->sc_msr, sc->sc_lsr);
710 
711 	*msr = sc->sc_msr;
712 	*lsr = sc->sc_lsr;
713 }
714 
715 static void
716 uftdi_start_read(struct ucom_softc *ucom)
717 {
718 	struct uftdi_softc *sc = ucom->sc_parent;
719 
720 	usbd_transfer_start(sc->sc_xfer[UFTDI_BULK_DT_RD]);
721 }
722 
723 static void
724 uftdi_stop_read(struct ucom_softc *ucom)
725 {
726 	struct uftdi_softc *sc = ucom->sc_parent;
727 
728 	usbd_transfer_stop(sc->sc_xfer[UFTDI_BULK_DT_RD]);
729 }
730 
731 static void
732 uftdi_start_write(struct ucom_softc *ucom)
733 {
734 	struct uftdi_softc *sc = ucom->sc_parent;
735 
736 	usbd_transfer_start(sc->sc_xfer[UFTDI_BULK_DT_WR]);
737 }
738 
739 static void
740 uftdi_stop_write(struct ucom_softc *ucom)
741 {
742 	struct uftdi_softc *sc = ucom->sc_parent;
743 
744 	usbd_transfer_stop(sc->sc_xfer[UFTDI_BULK_DT_WR]);
745 }
746 
747 /*------------------------------------------------------------------------*
748  *	uftdi_8u232am_getrate
749  *
750  * Return values:
751  *    0: Success
752  * Else: Failure
753  *------------------------------------------------------------------------*/
754 static uint8_t
755 uftdi_8u232am_getrate(uint32_t speed, uint16_t *rate)
756 {
757 	/* Table of the nearest even powers-of-2 for values 0..15. */
758 	static const uint8_t roundoff[16] = {
759 		0, 2, 2, 4, 4, 4, 8, 8,
760 		8, 8, 8, 8, 16, 16, 16, 16,
761 	};
762 	uint32_t d;
763 	uint32_t freq;
764 	uint16_t result;
765 
766 	if ((speed < 178) || (speed > ((3000000 * 100) / 97)))
767 		return (1);		/* prevent numerical overflow */
768 
769 	/* Special cases for 2M and 3M. */
770 	if ((speed >= ((3000000 * 100) / 103)) &&
771 	    (speed <= ((3000000 * 100) / 97))) {
772 		result = 0;
773 		goto done;
774 	}
775 	if ((speed >= ((2000000 * 100) / 103)) &&
776 	    (speed <= ((2000000 * 100) / 97))) {
777 		result = 1;
778 		goto done;
779 	}
780 	d = (FTDI_8U232AM_FREQ << 4) / speed;
781 	d = (d & ~15) + roundoff[d & 15];
782 
783 	if (d < FTDI_8U232AM_MIN_DIV)
784 		d = FTDI_8U232AM_MIN_DIV;
785 	else if (d > FTDI_8U232AM_MAX_DIV)
786 		d = FTDI_8U232AM_MAX_DIV;
787 
788 	/*
789 	 * Calculate the frequency needed for "d" to exactly divide down to
790 	 * our target "speed", and check that the actual frequency is within
791 	 * 3% of this.
792 	 */
793 	freq = (speed * d);
794 	if ((freq < ((FTDI_8U232AM_FREQ * 1600ULL) / 103)) ||
795 	    (freq > ((FTDI_8U232AM_FREQ * 1600ULL) / 97)))
796 		return (1);
797 
798 	/*
799 	 * Pack the divisor into the resultant value.  The lower 14-bits
800 	 * hold the integral part, while the upper 2 bits encode the
801 	 * fractional component: either 0, 0.5, 0.25, or 0.125.
802 	 */
803 	result = (d >> 4);
804 	if (d & 8)
805 		result |= 0x4000;
806 	else if (d & 4)
807 		result |= 0x8000;
808 	else if (d & 2)
809 		result |= 0xc000;
810 
811 done:
812 	*rate = result;
813 	return (0);
814 }
815 
816 static void
817 uftdi_poll(struct ucom_softc *ucom)
818 {
819 	struct uftdi_softc *sc = ucom->sc_parent;
820 	usbd_transfer_poll(sc->sc_xfer, UFTDI_N_TRANSFER);
821 }
822