uftdi.c revision 184610
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 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *        This product includes software developed by the NetBSD
21 *        Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 *    contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39#include <sys/cdefs.h>
40__FBSDID("$FreeBSD: head/sys/dev/usb2/serial/uftdi2.c 184610 2008-11-04 02:31:03Z alfred $");
41
42/*
43 * NOTE: all function names beginning like "uftdi_cfg_" can only
44 * be called from within the config thread function !
45 */
46
47/*
48 * FTDI FT8U100AX serial adapter driver
49 */
50
51#include <dev/usb2/include/usb2_devid.h>
52#include <dev/usb2/include/usb2_standard.h>
53#include <dev/usb2/include/usb2_mfunc.h>
54#include <dev/usb2/include/usb2_error.h>
55#include <dev/usb2/include/usb2_cdc.h>
56
57#define	USB_DEBUG_VAR uftdi_debug
58
59#include <dev/usb2/core/usb2_core.h>
60#include <dev/usb2/core/usb2_debug.h>
61#include <dev/usb2/core/usb2_process.h>
62#include <dev/usb2/core/usb2_config_td.h>
63#include <dev/usb2/core/usb2_request.h>
64#include <dev/usb2/core/usb2_lookup.h>
65#include <dev/usb2/core/usb2_util.h>
66#include <dev/usb2/core/usb2_busdma.h>
67
68#include <dev/usb2/serial/usb2_serial.h>
69#include <dev/usb2/serial/uftdi2_reg.h>
70
71#if USB_DEBUG
72static int uftdi_debug = 0;
73
74SYSCTL_NODE(_hw_usb2, OID_AUTO, uftdi, CTLFLAG_RW, 0, "USB uftdi");
75SYSCTL_INT(_hw_usb2_uftdi, OID_AUTO, debug, CTLFLAG_RW,
76    &uftdi_debug, 0, "Debug level");
77#endif
78
79#define	UFTDI_CONFIG_INDEX	0
80#define	UFTDI_IFACE_INDEX	0
81#define	UFTDI_ENDPT_MAX		4
82
83#define	UFTDI_IBUFSIZE 64		/* bytes, maximum number of bytes per
84					 * frame */
85#define	UFTDI_OBUFSIZE 64		/* bytes, cannot be increased due to
86					 * do size encoding */
87
88struct uftdi_softc {
89	struct usb2_com_super_softc sc_super_ucom;
90	struct usb2_com_softc sc_ucom;
91
92	struct usb2_device *sc_udev;
93	struct usb2_xfer *sc_xfer[UFTDI_ENDPT_MAX];
94	device_t sc_dev;
95
96	uint32_t sc_unit;
97	enum uftdi_type sc_type;
98
99	uint16_t sc_last_lcr;
100
101	uint8_t	sc_iface_index;
102	uint8_t	sc_hdrlen;
103
104	uint8_t	sc_msr;
105	uint8_t	sc_lsr;
106
107	uint8_t	sc_flag;
108#define	UFTDI_FLAG_WRITE_STALL  0x01
109#define	UFTDI_FLAG_READ_STALL   0x02
110
111	uint8_t	sc_name[16];
112};
113
114struct uftdi_param_config {
115	uint16_t rate;
116	uint16_t lcr;
117	uint8_t	v_start;
118	uint8_t	v_stop;
119	uint8_t	v_flow;
120};
121
122/* prototypes */
123
124static device_probe_t uftdi_probe;
125static device_attach_t uftdi_attach;
126static device_detach_t uftdi_detach;
127
128static usb2_callback_t uftdi_write_callback;
129static usb2_callback_t uftdi_write_clear_stall_callback;
130static usb2_callback_t uftdi_read_callback;
131static usb2_callback_t uftdi_read_clear_stall_callback;
132
133static void uftdi_cfg_do_request(struct uftdi_softc *sc, struct usb2_device_request *req, void *data);
134static void uftdi_cfg_open(struct usb2_com_softc *ucom);
135static void uftdi_cfg_set_dtr(struct usb2_com_softc *ucom, uint8_t onoff);
136static void uftdi_cfg_set_rts(struct usb2_com_softc *ucom, uint8_t onoff);
137static void uftdi_cfg_set_break(struct usb2_com_softc *ucom, uint8_t onoff);
138static int uftdi_set_parm_soft(struct termios *t, struct uftdi_param_config *cfg, uint8_t type);
139static int uftdi_pre_param(struct usb2_com_softc *ucom, struct termios *t);
140static void uftdi_cfg_param(struct usb2_com_softc *ucom, struct termios *t);
141static void uftdi_cfg_get_status(struct usb2_com_softc *ucom, uint8_t *lsr, uint8_t *msr);
142static void uftdi_start_read(struct usb2_com_softc *ucom);
143static void uftdi_stop_read(struct usb2_com_softc *ucom);
144static void uftdi_start_write(struct usb2_com_softc *ucom);
145static void uftdi_stop_write(struct usb2_com_softc *ucom);
146static uint8_t uftdi_8u232am_getrate(uint32_t speed, uint16_t *rate);
147
148static const struct usb2_config uftdi_config[UFTDI_ENDPT_MAX] = {
149
150	[0] = {
151		.type = UE_BULK,
152		.endpoint = UE_ADDR_ANY,
153		.direction = UE_DIR_OUT,
154		.mh.bufsize = UFTDI_OBUFSIZE,
155		.mh.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
156		.mh.callback = &uftdi_write_callback,
157	},
158
159	[1] = {
160		.type = UE_BULK,
161		.endpoint = UE_ADDR_ANY,
162		.direction = UE_DIR_IN,
163		.mh.bufsize = UFTDI_IBUFSIZE,
164		.mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
165		.mh.callback = &uftdi_read_callback,
166	},
167
168	[2] = {
169		.type = UE_CONTROL,
170		.endpoint = 0x00,	/* Control pipe */
171		.direction = UE_DIR_ANY,
172		.mh.bufsize = sizeof(struct usb2_device_request),
173		.mh.flags = {},
174		.mh.callback = &uftdi_write_clear_stall_callback,
175		.mh.timeout = 1000,	/* 1 second */
176		.mh.interval = 50,	/* 50ms */
177	},
178
179	[3] = {
180		.type = UE_CONTROL,
181		.endpoint = 0x00,	/* Control pipe */
182		.direction = UE_DIR_ANY,
183		.mh.bufsize = sizeof(struct usb2_device_request),
184		.mh.flags = {},
185		.mh.callback = &uftdi_read_clear_stall_callback,
186		.mh.timeout = 1000,	/* 1 second */
187		.mh.interval = 50,	/* 50ms */
188	},
189};
190
191static const struct usb2_com_callback uftdi_callback = {
192	.usb2_com_cfg_get_status = &uftdi_cfg_get_status,
193	.usb2_com_cfg_set_dtr = &uftdi_cfg_set_dtr,
194	.usb2_com_cfg_set_rts = &uftdi_cfg_set_rts,
195	.usb2_com_cfg_set_break = &uftdi_cfg_set_break,
196	.usb2_com_cfg_param = &uftdi_cfg_param,
197	.usb2_com_cfg_open = &uftdi_cfg_open,
198	.usb2_com_pre_param = &uftdi_pre_param,
199	.usb2_com_start_read = &uftdi_start_read,
200	.usb2_com_stop_read = &uftdi_stop_read,
201	.usb2_com_start_write = &uftdi_start_write,
202	.usb2_com_stop_write = &uftdi_stop_write,
203};
204
205static device_method_t uftdi_methods[] = {
206	/* Device interface */
207	DEVMETHOD(device_probe, uftdi_probe),
208	DEVMETHOD(device_attach, uftdi_attach),
209	DEVMETHOD(device_detach, uftdi_detach),
210
211	{0, 0}
212};
213
214static devclass_t uftdi_devclass;
215
216static driver_t uftdi_driver = {
217	.name = "uftdi",
218	.methods = uftdi_methods,
219	.size = sizeof(struct uftdi_softc),
220};
221
222DRIVER_MODULE(uftdi, ushub, uftdi_driver, uftdi_devclass, NULL, 0);
223MODULE_DEPEND(uftdi, usb2_serial, 1, 1, 1);
224MODULE_DEPEND(uftdi, usb2_core, 1, 1, 1);
225MODULE_DEPEND(uftdi, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
226
227static struct usb2_device_id uftdi_devs[] = {
228	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U100AX, UFTDI_TYPE_SIO)},
229	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_2232C, UFTDI_TYPE_8U232AM)},
230	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U232AM, UFTDI_TYPE_8U232AM)},
231	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SEMC_DSS20, UFTDI_TYPE_8U232AM)},
232	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_631, UFTDI_TYPE_8U232AM)},
233	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_632, UFTDI_TYPE_8U232AM)},
234	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_633, UFTDI_TYPE_8U232AM)},
235	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_634, UFTDI_TYPE_8U232AM)},
236	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_635, UFTDI_TYPE_8U232AM)},
237	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_USBSERIAL, UFTDI_TYPE_8U232AM)},
238	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MX2_3, UFTDI_TYPE_8U232AM)},
239	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MX4_5, UFTDI_TYPE_8U232AM)},
240	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LK202, UFTDI_TYPE_8U232AM)},
241	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LK204, UFTDI_TYPE_8U232AM)},
242	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_TACTRIX_OPENPORT_13M, UFTDI_TYPE_8U232AM)},
243	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_TACTRIX_OPENPORT_13S, UFTDI_TYPE_8U232AM)},
244	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_TACTRIX_OPENPORT_13U, UFTDI_TYPE_8U232AM)},
245	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_EISCOU, UFTDI_TYPE_8U232AM)},
246	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_UOPTBR, UFTDI_TYPE_8U232AM)},
247	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_EMCU2D, UFTDI_TYPE_8U232AM)},
248	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_PCMSFU, UFTDI_TYPE_8U232AM)},
249	{USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_EMCU2H, UFTDI_TYPE_8U232AM)},
250	{USB_VPI(USB_VENDOR_SIIG2, USB_PRODUCT_SIIG2_US2308, UFTDI_TYPE_8U232AM)},
251	{USB_VPI(USB_VENDOR_INTREPIDCS, USB_PRODUCT_INTREPIDCS_VALUECAN, UFTDI_TYPE_8U232AM)},
252	{USB_VPI(USB_VENDOR_INTREPIDCS, USB_PRODUCT_INTREPIDCS_NEOVI, UFTDI_TYPE_8U232AM)},
253	{USB_VPI(USB_VENDOR_BBELECTRONICS, USB_PRODUCT_BBELECTRONICS_USOTL4, UFTDI_TYPE_8U232AM)},
254	{USB_VPI(USB_VENDOR_MELCO, USB_PRODUCT_MELCO_PCOPRS1, UFTDI_TYPE_8U232AM)},
255};
256
257static int
258uftdi_probe(device_t dev)
259{
260	struct usb2_attach_arg *uaa = device_get_ivars(dev);
261
262	if (uaa->usb2_mode != USB_MODE_HOST) {
263		return (ENXIO);
264	}
265	if (uaa->info.bConfigIndex != UFTDI_CONFIG_INDEX) {
266		return (ENXIO);
267	}
268	/* attach to all present interfaces */
269
270	return (usb2_lookup_id_by_uaa(uftdi_devs, sizeof(uftdi_devs), uaa));
271}
272
273static int
274uftdi_attach(device_t dev)
275{
276	struct usb2_attach_arg *uaa = device_get_ivars(dev);
277	struct uftdi_softc *sc = device_get_softc(dev);
278	int error;
279
280	if (sc == NULL) {
281		return (ENOMEM);
282	}
283	sc->sc_udev = uaa->device;
284	sc->sc_dev = dev;
285	sc->sc_unit = device_get_unit(dev);
286
287	device_set_usb2_desc(dev);
288
289	snprintf(sc->sc_name, sizeof(sc->sc_name),
290	    "%s", device_get_nameunit(dev));
291
292	DPRINTF("\n");
293
294	sc->sc_iface_index = uaa->info.bIfaceIndex;
295	sc->sc_type = USB_GET_DRIVER_INFO(uaa);
296
297	switch (sc->sc_type) {
298	case UFTDI_TYPE_SIO:
299		sc->sc_hdrlen = 1;
300		break;
301	case UFTDI_TYPE_8U232AM:
302	default:
303		sc->sc_hdrlen = 0;
304		break;
305	}
306
307	error = usb2_transfer_setup(uaa->device,
308	    &sc->sc_iface_index, sc->sc_xfer, uftdi_config,
309	    UFTDI_ENDPT_MAX, sc, &Giant);
310
311	if (error) {
312		device_printf(dev, "allocating USB "
313		    "transfers failed!\n");
314		goto detach;
315	}
316	sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum;
317
318	/* clear stall at first run */
319
320	sc->sc_flag |= (UFTDI_FLAG_WRITE_STALL |
321	    UFTDI_FLAG_READ_STALL);
322
323	/* set a valid "lcr" value */
324
325	sc->sc_last_lcr =
326	    (FTDI_SIO_SET_DATA_STOP_BITS_2 |
327	    FTDI_SIO_SET_DATA_PARITY_NONE |
328	    FTDI_SIO_SET_DATA_BITS(8));
329
330	error = usb2_com_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
331	    &uftdi_callback, &Giant);
332	if (error) {
333		goto detach;
334	}
335	return (0);			/* success */
336
337detach:
338	uftdi_detach(dev);
339	return (ENXIO);
340}
341
342static int
343uftdi_detach(device_t dev)
344{
345	struct uftdi_softc *sc = device_get_softc(dev);
346
347	usb2_com_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1);
348
349	usb2_transfer_unsetup(sc->sc_xfer, UFTDI_ENDPT_MAX);
350
351	return (0);
352}
353
354static void
355uftdi_cfg_do_request(struct uftdi_softc *sc, struct usb2_device_request *req,
356    void *data)
357{
358	uint16_t length;
359	usb2_error_t err;
360
361	if (usb2_com_cfg_is_gone(&sc->sc_ucom)) {
362		goto error;
363	}
364	err = usb2_do_request_flags
365	    (sc->sc_udev, &Giant, req, data, 0, NULL, 1000);
366
367	if (err) {
368
369		DPRINTFN(0, "device request failed, err=%s "
370		    "(ignored)\n", usb2_errstr(err));
371
372error:
373		length = UGETW(req->wLength);
374
375		if ((req->bmRequestType & UT_READ) && length) {
376			bzero(data, length);
377		}
378	}
379	return;
380}
381
382static void
383uftdi_cfg_open(struct usb2_com_softc *ucom)
384{
385	struct uftdi_softc *sc = ucom->sc_parent;
386	uint16_t wIndex = ucom->sc_portno;
387	struct usb2_device_request req;
388
389	DPRINTF("");
390
391	/* perform a full reset on the device */
392
393	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
394	req.bRequest = FTDI_SIO_RESET;
395	USETW(req.wValue, FTDI_SIO_RESET_SIO);
396	USETW(req.wIndex, wIndex);
397	USETW(req.wLength, 0);
398	uftdi_cfg_do_request(sc, &req, NULL);
399
400	/* turn on RTS/CTS flow control */
401
402	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
403	req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
404	USETW(req.wValue, 0);
405	USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, wIndex);
406	USETW(req.wLength, 0);
407	uftdi_cfg_do_request(sc, &req, NULL);
408
409	/*
410	 * NOTE: with the new UCOM layer there will always be a
411	 * "uftdi_cfg_param()" call after "open()", so there is no need for
412	 * "open()" to configure anything
413	 */
414	return;
415}
416
417static void
418uftdi_write_callback(struct usb2_xfer *xfer)
419{
420	struct uftdi_softc *sc = xfer->priv_sc;
421	uint32_t actlen;
422	uint8_t buf[1];
423
424	switch (USB_GET_STATE(xfer)) {
425	case USB_ST_SETUP:
426	case USB_ST_TRANSFERRED:
427		if (sc->sc_flag & UFTDI_FLAG_WRITE_STALL) {
428			usb2_transfer_start(sc->sc_xfer[2]);
429			return;
430		}
431		if (usb2_com_get_data(&sc->sc_ucom, xfer->frbuffers,
432		    sc->sc_hdrlen, UFTDI_OBUFSIZE - sc->sc_hdrlen,
433		    &actlen)) {
434
435			if (sc->sc_hdrlen > 0) {
436				buf[0] =
437				    FTDI_OUT_TAG(actlen, sc->sc_ucom.sc_portno);
438				usb2_copy_in(xfer->frbuffers, 0, buf, 1);
439			}
440			xfer->frlengths[0] = actlen + sc->sc_hdrlen;
441			usb2_start_hardware(xfer);
442		}
443		return;
444
445	default:			/* Error */
446		if (xfer->error != USB_ERR_CANCELLED) {
447			sc->sc_flag |= UFTDI_FLAG_WRITE_STALL;
448			usb2_transfer_start(sc->sc_xfer[2]);
449		}
450		return;
451
452	}
453}
454
455static void
456uftdi_write_clear_stall_callback(struct usb2_xfer *xfer)
457{
458	struct uftdi_softc *sc = xfer->priv_sc;
459	struct usb2_xfer *xfer_other = sc->sc_xfer[0];
460
461	if (usb2_clear_stall_callback(xfer, xfer_other)) {
462		DPRINTF("stall cleared\n");
463		sc->sc_flag &= ~UFTDI_FLAG_WRITE_STALL;
464		usb2_transfer_start(xfer_other);
465	}
466	return;
467}
468
469static void
470uftdi_read_callback(struct usb2_xfer *xfer)
471{
472	struct uftdi_softc *sc = xfer->priv_sc;
473	uint8_t buf[2];
474	uint8_t msr;
475	uint8_t lsr;
476
477	switch (USB_GET_STATE(xfer)) {
478	case USB_ST_TRANSFERRED:
479
480		if (xfer->actlen < 2) {
481			goto tr_setup;
482		}
483		usb2_copy_out(xfer->frbuffers, 0, buf, 2);
484
485		msr = FTDI_GET_MSR(buf);
486		lsr = FTDI_GET_LSR(buf);
487
488		if ((sc->sc_msr != msr) ||
489		    ((sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK))) {
490			DPRINTF("status change msr=0x%02x (0x%02x) "
491			    "lsr=0x%02x (0x%02x)\n", msr, sc->sc_msr,
492			    lsr, sc->sc_lsr);
493
494			sc->sc_msr = msr;
495			sc->sc_lsr = lsr;
496
497			usb2_com_status_change(&sc->sc_ucom);
498		}
499		xfer->actlen -= 2;
500
501		if (xfer->actlen > 0) {
502			usb2_com_put_data(&sc->sc_ucom, xfer->frbuffers, 2,
503			    xfer->actlen);
504		}
505	case USB_ST_SETUP:
506tr_setup:
507		if (sc->sc_flag & UFTDI_FLAG_READ_STALL) {
508			usb2_transfer_start(sc->sc_xfer[3]);
509		} else {
510			xfer->frlengths[0] = xfer->max_data_length;
511			usb2_start_hardware(xfer);
512		}
513		return;
514
515	default:			/* Error */
516		if (xfer->error != USB_ERR_CANCELLED) {
517			sc->sc_flag |= UFTDI_FLAG_READ_STALL;
518			usb2_transfer_start(sc->sc_xfer[3]);
519		}
520		return;
521
522	}
523}
524
525static void
526uftdi_read_clear_stall_callback(struct usb2_xfer *xfer)
527{
528	struct uftdi_softc *sc = xfer->priv_sc;
529	struct usb2_xfer *xfer_other = sc->sc_xfer[1];
530
531	if (usb2_clear_stall_callback(xfer, xfer_other)) {
532		DPRINTF("stall cleared\n");
533		sc->sc_flag &= ~UFTDI_FLAG_READ_STALL;
534		usb2_transfer_start(xfer_other);
535	}
536	return;
537}
538
539static void
540uftdi_cfg_set_dtr(struct usb2_com_softc *ucom, uint8_t onoff)
541{
542	struct uftdi_softc *sc = ucom->sc_parent;
543	uint16_t wIndex = ucom->sc_portno;
544	uint16_t wValue;
545	struct usb2_device_request req;
546
547	wValue = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW;
548
549	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
550	req.bRequest = FTDI_SIO_MODEM_CTRL;
551	USETW(req.wValue, wValue);
552	USETW(req.wIndex, wIndex);
553	USETW(req.wLength, 0);
554	uftdi_cfg_do_request(sc, &req, NULL);
555	return;
556}
557
558static void
559uftdi_cfg_set_rts(struct usb2_com_softc *ucom, uint8_t onoff)
560{
561	struct uftdi_softc *sc = ucom->sc_parent;
562	uint16_t wIndex = ucom->sc_portno;
563	uint16_t wValue;
564	struct usb2_device_request req;
565
566	wValue = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW;
567
568	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
569	req.bRequest = FTDI_SIO_MODEM_CTRL;
570	USETW(req.wValue, wValue);
571	USETW(req.wIndex, wIndex);
572	USETW(req.wLength, 0);
573	uftdi_cfg_do_request(sc, &req, NULL);
574	return;
575}
576
577static void
578uftdi_cfg_set_break(struct usb2_com_softc *ucom, uint8_t onoff)
579{
580	struct uftdi_softc *sc = ucom->sc_parent;
581	uint16_t wIndex = ucom->sc_portno;
582	uint16_t wValue;
583	struct usb2_device_request req;
584
585	if (onoff) {
586		sc->sc_last_lcr |= FTDI_SIO_SET_BREAK;
587	} else {
588		sc->sc_last_lcr &= ~FTDI_SIO_SET_BREAK;
589	}
590
591	wValue = sc->sc_last_lcr;
592
593	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
594	req.bRequest = FTDI_SIO_SET_DATA;
595	USETW(req.wValue, wValue);
596	USETW(req.wIndex, wIndex);
597	USETW(req.wLength, 0);
598	uftdi_cfg_do_request(sc, &req, NULL);
599	return;
600}
601
602static int
603uftdi_set_parm_soft(struct termios *t,
604    struct uftdi_param_config *cfg, uint8_t type)
605{
606	bzero(cfg, sizeof(*cfg));
607
608	switch (type) {
609	case UFTDI_TYPE_SIO:
610		switch (t->c_ospeed) {
611		case 300:
612			cfg->rate = ftdi_sio_b300;
613			break;
614		case 600:
615			cfg->rate = ftdi_sio_b600;
616			break;
617		case 1200:
618			cfg->rate = ftdi_sio_b1200;
619			break;
620		case 2400:
621			cfg->rate = ftdi_sio_b2400;
622			break;
623		case 4800:
624			cfg->rate = ftdi_sio_b4800;
625			break;
626		case 9600:
627			cfg->rate = ftdi_sio_b9600;
628			break;
629		case 19200:
630			cfg->rate = ftdi_sio_b19200;
631			break;
632		case 38400:
633			cfg->rate = ftdi_sio_b38400;
634			break;
635		case 57600:
636			cfg->rate = ftdi_sio_b57600;
637			break;
638		case 115200:
639			cfg->rate = ftdi_sio_b115200;
640			break;
641		default:
642			return (EINVAL);
643		}
644		break;
645
646	case UFTDI_TYPE_8U232AM:
647		if (uftdi_8u232am_getrate(t->c_ospeed, &cfg->rate)) {
648			return (EINVAL);
649		}
650		break;
651	}
652
653	if (t->c_cflag & CSTOPB)
654		cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_2;
655	else
656		cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_1;
657
658	if (t->c_cflag & PARENB) {
659		if (t->c_cflag & PARODD) {
660			cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_ODD;
661		} else {
662			cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_EVEN;
663		}
664	} else {
665		cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_NONE;
666	}
667
668	switch (t->c_cflag & CSIZE) {
669	case CS5:
670		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(5);
671		break;
672
673	case CS6:
674		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(6);
675		break;
676
677	case CS7:
678		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(7);
679		break;
680
681	case CS8:
682		cfg->lcr |= FTDI_SIO_SET_DATA_BITS(8);
683		break;
684	}
685
686	if (t->c_cflag & CRTSCTS) {
687		cfg->v_flow = FTDI_SIO_RTS_CTS_HS;
688	} else if (t->c_iflag & (IXON | IXOFF)) {
689		cfg->v_flow = FTDI_SIO_XON_XOFF_HS;
690		cfg->v_start = t->c_cc[VSTART];
691		cfg->v_stop = t->c_cc[VSTOP];
692	} else {
693		cfg->v_flow = FTDI_SIO_DISABLE_FLOW_CTRL;
694	}
695
696	return (0);
697}
698
699static int
700uftdi_pre_param(struct usb2_com_softc *ucom, struct termios *t)
701{
702	struct uftdi_softc *sc = ucom->sc_parent;
703	struct uftdi_param_config cfg;
704
705	DPRINTF("\n");
706
707	return (uftdi_set_parm_soft(t, &cfg, sc->sc_type));
708}
709
710static void
711uftdi_cfg_param(struct usb2_com_softc *ucom, struct termios *t)
712{
713	struct uftdi_softc *sc = ucom->sc_parent;
714	uint16_t wIndex = ucom->sc_portno;
715	struct uftdi_param_config cfg;
716	struct usb2_device_request req;
717
718	if (uftdi_set_parm_soft(t, &cfg, sc->sc_type)) {
719		/* should not happen */
720		return;
721	}
722	sc->sc_last_lcr = cfg.lcr;
723
724	DPRINTF("\n");
725
726	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
727	req.bRequest = FTDI_SIO_SET_BAUD_RATE;
728	USETW(req.wValue, cfg.rate);
729	USETW(req.wIndex, wIndex);
730	USETW(req.wLength, 0);
731	uftdi_cfg_do_request(sc, &req, NULL);
732
733	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
734	req.bRequest = FTDI_SIO_SET_DATA;
735	USETW(req.wValue, cfg.lcr);
736	USETW(req.wIndex, wIndex);
737	USETW(req.wLength, 0);
738	uftdi_cfg_do_request(sc, &req, NULL);
739
740	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
741	req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
742	USETW2(req.wValue, cfg.v_stop, cfg.v_start);
743	USETW2(req.wIndex, cfg.v_flow, wIndex);
744	USETW(req.wLength, 0);
745	uftdi_cfg_do_request(sc, &req, NULL);
746
747	return;
748}
749
750static void
751uftdi_cfg_get_status(struct usb2_com_softc *ucom, uint8_t *lsr, uint8_t *msr)
752{
753	struct uftdi_softc *sc = ucom->sc_parent;
754
755	DPRINTF("msr=0x%02x lsr=0x%02x\n",
756	    sc->sc_msr, sc->sc_lsr);
757
758	*msr = sc->sc_msr;
759	*lsr = sc->sc_lsr;
760	return;
761}
762
763static void
764uftdi_start_read(struct usb2_com_softc *ucom)
765{
766	struct uftdi_softc *sc = ucom->sc_parent;
767
768	usb2_transfer_start(sc->sc_xfer[1]);
769	return;
770}
771
772static void
773uftdi_stop_read(struct usb2_com_softc *ucom)
774{
775	struct uftdi_softc *sc = ucom->sc_parent;
776
777	usb2_transfer_stop(sc->sc_xfer[3]);
778	usb2_transfer_stop(sc->sc_xfer[1]);
779	return;
780}
781
782static void
783uftdi_start_write(struct usb2_com_softc *ucom)
784{
785	struct uftdi_softc *sc = ucom->sc_parent;
786
787	usb2_transfer_start(sc->sc_xfer[0]);
788	return;
789}
790
791static void
792uftdi_stop_write(struct usb2_com_softc *ucom)
793{
794	struct uftdi_softc *sc = ucom->sc_parent;
795
796	usb2_transfer_stop(sc->sc_xfer[2]);
797	usb2_transfer_stop(sc->sc_xfer[0]);
798	return;
799}
800
801/*------------------------------------------------------------------------*
802 *	uftdi_8u232am_getrate
803 *
804 * Return values:
805 *    0: Success
806 * Else: Failure
807 *------------------------------------------------------------------------*/
808static uint8_t
809uftdi_8u232am_getrate(uint32_t speed, uint16_t *rate)
810{
811	/* Table of the nearest even powers-of-2 for values 0..15. */
812	static const uint8_t roundoff[16] = {
813		0, 2, 2, 4, 4, 4, 8, 8,
814		8, 8, 8, 8, 16, 16, 16, 16,
815	};
816	uint32_t d;
817	uint32_t freq;
818	uint16_t result;
819
820	if ((speed < 178) || (speed > ((3000000 * 100) / 97)))
821		return (1);		/* prevent numerical overflow */
822
823	/* Special cases for 2M and 3M. */
824	if ((speed >= ((3000000 * 100) / 103)) &&
825	    (speed <= ((3000000 * 100) / 97))) {
826		result = 0;
827		goto done;
828	}
829	if ((speed >= ((2000000 * 100) / 103)) &&
830	    (speed <= ((2000000 * 100) / 97))) {
831		result = 1;
832		goto done;
833	}
834	d = (FTDI_8U232AM_FREQ << 4) / speed;
835	d = (d & ~15) + roundoff[d & 15];
836
837	if (d < FTDI_8U232AM_MIN_DIV)
838		d = FTDI_8U232AM_MIN_DIV;
839	else if (d > FTDI_8U232AM_MAX_DIV)
840		d = FTDI_8U232AM_MAX_DIV;
841
842	/*
843	 * Calculate the frequency needed for "d" to exactly divide down to
844	 * our target "speed", and check that the actual frequency is within
845	 * 3% of this.
846	 */
847	freq = (speed * d);
848	if ((freq < ((FTDI_8U232AM_FREQ * 1600ULL) / 103)) ||
849	    (freq > ((FTDI_8U232AM_FREQ * 1600ULL) / 97)))
850		return (1);
851
852	/*
853	 * Pack the divisor into the resultant value.  The lower 14-bits
854	 * hold the integral part, while the upper 2 bits encode the
855	 * fractional component: either 0, 0.5, 0.25, or 0.125.
856	 */
857	result = (d >> 4);
858	if (d & 8)
859		result |= 0x4000;
860	else if (d & 4)
861		result |= 0x8000;
862	else if (d & 2)
863		result |= 0xc000;
864
865done:
866	*rate = result;
867	return (0);
868}
869