2 * $NetBSD: uftdi.c,v 1.13 2002/09/23 05:51:23 simonb Exp $
3 * $FreeBSD: src/sys/dev/usb/uftdi.c,v 1.10 2003/08/24 17:55:55 obrien Exp $
4 * $DragonFly: src/sys/dev/usbmisc/uftdi/uftdi.c,v 1.14 2007/07/01 21:24:03 hasso Exp $
8 * Copyright (c) 2000 The NetBSD Foundation, Inc.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Lennart Augustsson (lennart@augustsson.net).
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. All advertising materials mentioning features or use of this software
23 * must display the following acknowledgement:
24 * This product includes software developed by the NetBSD
25 * Foundation, Inc. and its contributors.
26 * 4. Neither the name of The NetBSD Foundation nor the names of its
27 * contributors may be used to endorse or promote products derived
28 * from this software without specific prior written permission.
30 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
31 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
32 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
33 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
34 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
38 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40 * POSSIBILITY OF SUCH DAMAGE.
44 * FTDI FT8U100AX serial adapter driver
47 #include <sys/cdefs.h>
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/malloc.h>
54 #include <sys/ioccom.h>
55 #include <sys/fcntl.h>
60 #include <sys/select.h>
62 #include <sys/sysctl.h>
64 #include <bus/usb/usb.h>
65 #include <bus/usb/usbhid.h>
67 #include <bus/usb/usbdi.h>
68 #include <bus/usb/usbdi_util.h>
69 #include <bus/usb/usbdevs.h>
71 #include "../ucom/ucomvar.h"
76 static int uftdidebug = 0;
77 SYSCTL_NODE(_hw_usb, OID_AUTO, uftdi, CTLFLAG_RW, 0, "USB uftdi");
78 SYSCTL_INT(_hw_usb_uftdi, OID_AUTO, debug, CTLFLAG_RW,
79 &uftdidebug, 0, "uftdi debug level");
80 #define DPRINTF(x) do { \
85 #define DPRINTFN(n, x) do { \
86 if (uftdidebug > (n)) \
95 #define UFTDI_CONFIG_INDEX 0
96 #define UFTDI_IFACE_INDEX 0
100 * These are the maximum number of bytes transferred per frame.
101 * The output buffer size cannot be increased due to the size encoding.
103 #define UFTDIIBUFSIZE 64
104 #define UFTDIOBUFSIZE 64
107 struct ucom_softc sc_ucom;
109 usbd_interface_handle sc_iface; /* interface */
111 enum uftdi_type sc_type;
120 static void uftdi_get_status(void *, int portno, u_char *lsr, u_char *msr);
121 static void uftdi_set(void *, int, int, int);
122 static int uftdi_param(void *, int, struct termios *);
123 static int uftdi_open(void *sc, int portno);
124 static void uftdi_read(void *sc, int portno, u_char **ptr,u_int32_t *count);
125 static void uftdi_write(void *sc, int portno, u_char *to, u_char *from,
127 static void uftdi_break(void *sc, int portno, int onoff);
129 struct ucom_callback uftdi_callback = {
141 uftdi_match(device_t self)
143 struct usb_attach_arg *uaa = device_get_ivars(self);
145 if (uaa->iface != NULL)
146 return (UMATCH_NONE);
148 DPRINTFN(20,("uftdi: vendor=0x%x, product=0x%x\n",
149 uaa->vendor, uaa->product));
151 if (uaa->vendor == USB_VENDOR_FTDI &&
152 (uaa->product == USB_PRODUCT_FTDI_SERIAL_8U100AX ||
153 uaa->product == USB_PRODUCT_FTDI_SERIAL_8U232AM))
154 return (UMATCH_VENDOR_PRODUCT);
156 return (UMATCH_NONE);
160 uftdi_attach(device_t self)
162 struct uftdi_softc *sc = device_get_softc(self);
163 struct usb_attach_arg *uaa = device_get_ivars(self);
164 usbd_device_handle dev = uaa->device;
165 usbd_interface_handle iface;
166 usb_interface_descriptor_t *id;
167 usb_endpoint_descriptor_t *ed;
172 struct ucom_softc *ucom = &sc->sc_ucom;
173 DPRINTFN(10,("\nuftdi_attach: sc=%p\n", sc));
174 devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT);
179 devname = device_get_nameunit(ucom->sc_dev);
181 /* Move the device into the configured state. */
182 err = usbd_set_config_index(dev, UFTDI_CONFIG_INDEX, 1);
184 kprintf("\n%s: failed to set configuration, err=%s\n",
185 devname, usbd_errstr(err));
189 err = usbd_device2interface_handle(dev, UFTDI_IFACE_INDEX, &iface);
191 kprintf("\n%s: failed to get interface, err=%s\n",
192 devname, usbd_errstr(err));
196 usbd_devinfo(dev, 0, devinfo);
197 /* USB_ATTACH_SETUP;*/
198 kprintf("%s: %s\n", devname, devinfo);
200 id = usbd_get_interface_descriptor(iface);
201 ucom->sc_iface = iface;
202 switch( uaa->product ){
203 case USB_PRODUCT_FTDI_SERIAL_8U100AX:
204 sc->sc_type = UFTDI_TYPE_SIO;
207 case USB_PRODUCT_FTDI_SERIAL_8U232AM:
208 sc->sc_type = UFTDI_TYPE_8U232AM;
212 default: /* Can't happen */
216 ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
218 for (i = 0; i < id->bNumEndpoints; i++) {
220 ed = usbd_interface2endpoint_descriptor(iface, i);
222 kprintf("%s: could not read endpoint descriptor"
223 ": %s\n", devname, usbd_errstr(err));
227 addr = ed->bEndpointAddress;
228 dir = UE_GET_DIR(ed->bEndpointAddress);
229 attr = ed->bmAttributes & UE_XFERTYPE;
230 if (dir == UE_DIR_IN && attr == UE_BULK)
231 ucom->sc_bulkin_no = addr;
232 else if (dir == UE_DIR_OUT && attr == UE_BULK)
233 ucom->sc_bulkout_no = addr;
235 kprintf("%s: unexpected endpoint\n", devname);
239 if (ucom->sc_bulkin_no == -1) {
240 kprintf("%s: Could not find data bulk in\n",
244 if (ucom->sc_bulkout_no == -1) {
245 kprintf("%s: Could not find data bulk out\n",
249 ucom->sc_parent = sc;
250 ucom->sc_portno = FTDI_PIT_SIOA;
251 /* bulkin, bulkout set above */
253 ucom->sc_ibufsize = UFTDIIBUFSIZE;
254 ucom->sc_obufsize = UFTDIOBUFSIZE - sc->sc_hdrlen;
255 ucom->sc_ibufsizepad = UFTDIIBUFSIZE;
256 ucom->sc_opkthdrlen = sc->sc_hdrlen;
259 ucom->sc_callback = &uftdi_callback;
261 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, ucom->sc_udev,
264 DPRINTF(("uftdi: in=0x%x out=0x%x\n", ucom->sc_bulkin_no, ucom->sc_bulkout_no));
265 ucom_attach(&sc->sc_ucom);
266 kfree(devinfo, M_USBDEV);
271 DPRINTF(("uftdi_attach: ATTACH ERROR\n"));
273 kfree(devinfo, M_USBDEV);
279 uftdi_activate(device_t self, enum devact act)
281 struct uftdi_softc *sc = (struct uftdi_softc *)self;
288 case DVACT_DEACTIVATE:
289 if (sc->sc_subdev != NULL)
290 rv = config_deactivate(sc->sc_subdev);
291 sc->sc_ucom.sc_dying = 1;
299 uftdi_detach(device_t self)
301 struct uftdi_softc *sc = device_get_softc(self);
305 DPRINTF(("uftdi_detach: sc=%p\n", sc));
306 sc->sc_ucom.sc_dying = 1;
307 rv = ucom_detach(&sc->sc_ucom);
313 uftdi_open(void *vsc, int portno)
315 struct uftdi_softc *sc = vsc;
316 struct ucom_softc *ucom = &sc->sc_ucom;
317 usb_device_request_t req;
321 DPRINTF(("uftdi_open: sc=%p\n", sc));
326 /* Perform a full reset on the device */
327 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
328 req.bRequest = FTDI_SIO_RESET;
329 USETW(req.wValue, FTDI_SIO_RESET_SIO);
330 USETW(req.wIndex, portno);
331 USETW(req.wLength, 0);
332 err = usbd_do_request(ucom->sc_udev, &req, NULL);
336 /* Set 9600 baud, 2 stop bits, no parity, 8 bits */
338 t.c_cflag = CSTOPB | CS8;
339 (void)uftdi_param(sc, portno, &t);
341 /* Turn on RTS/CTS flow control */
342 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
343 req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
344 USETW(req.wValue, 0);
345 USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, portno);
346 USETW(req.wLength, 0);
347 err = usbd_do_request(ucom->sc_udev, &req, NULL);
355 uftdi_read(void *vsc, int portno, u_char **ptr, u_int32_t *count)
357 struct uftdi_softc *sc = vsc;
360 DPRINTFN(15,("uftdi_read: sc=%p, port=%d count=%d\n", sc, portno,
363 msr = FTDI_GET_MSR(*ptr);
364 lsr = FTDI_GET_LSR(*ptr);
368 DPRINTFN(10,("uftdi_read: sc=%p, port=%d count=%d data[0]="
369 "0x%02x\n", sc, portno, *count, (*ptr)[2]));
372 if (sc->sc_msr != msr ||
373 (sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK)) {
374 DPRINTF(("uftdi_read: status change msr=0x%02x(0x%02x) "
375 "lsr=0x%02x(0x%02x)\n", msr, sc->sc_msr,
379 ucom_status_change(&sc->sc_ucom);
382 /* Pick up status and adjust data part. */
388 uftdi_write(void *vsc, int portno, u_char *to, u_char *from, u_int32_t *count)
390 struct uftdi_softc *sc = vsc;
392 DPRINTFN(10,("uftdi_write: sc=%p, port=%d count=%u data[0]=0x%02x\n",
393 vsc, portno, *count, from[0]));
395 /* Make length tag and copy data */
396 if (sc->sc_hdrlen > 0)
397 *to = FTDI_OUT_TAG(*count, portno);
399 memcpy(to + sc->sc_hdrlen, from, *count);
400 *count += sc->sc_hdrlen;
404 uftdi_set(void *vsc, int portno, int reg, int onoff)
406 struct uftdi_softc *sc = vsc;
407 struct ucom_softc *ucom = vsc;
408 usb_device_request_t req;
411 DPRINTF(("uftdi_set: sc=%p, port=%d reg=%d onoff=%d\n", vsc, portno,
416 ctl = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW;
419 ctl = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW;
422 uftdi_break(sc, portno, onoff);
427 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
428 req.bRequest = FTDI_SIO_MODEM_CTRL;
429 USETW(req.wValue, ctl);
430 USETW(req.wIndex, portno);
431 USETW(req.wLength, 0);
432 DPRINTFN(2,("uftdi_set: reqtype=0x%02x req=0x%02x value=0x%04x "
433 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest,
434 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength)));
435 (void)usbd_do_request(ucom->sc_udev, &req, NULL);
439 uftdi_param(void *vsc, int portno, struct termios *t)
441 struct uftdi_softc *sc = vsc;
442 struct ucom_softc *ucom = &sc->sc_ucom;
443 usb_device_request_t req;
445 int rate=0, data, flow;
447 DPRINTF(("uftdi_param: sc=%p\n", sc));
452 switch (sc->sc_type) {
454 switch (t->c_ospeed) {
455 case 300: rate = ftdi_sio_b300; break;
456 case 600: rate = ftdi_sio_b600; break;
457 case 1200: rate = ftdi_sio_b1200; break;
458 case 2400: rate = ftdi_sio_b2400; break;
459 case 4800: rate = ftdi_sio_b4800; break;
460 case 9600: rate = ftdi_sio_b9600; break;
461 case 19200: rate = ftdi_sio_b19200; break;
462 case 38400: rate = ftdi_sio_b38400; break;
463 case 57600: rate = ftdi_sio_b57600; break;
464 case 115200: rate = ftdi_sio_b115200; break;
470 case UFTDI_TYPE_8U232AM:
471 switch(t->c_ospeed) {
472 case 300: rate = ftdi_8u232am_b300; break;
473 case 600: rate = ftdi_8u232am_b600; break;
474 case 1200: rate = ftdi_8u232am_b1200; break;
475 case 2400: rate = ftdi_8u232am_b2400; break;
476 case 4800: rate = ftdi_8u232am_b4800; break;
477 case 9600: rate = ftdi_8u232am_b9600; break;
478 case 19200: rate = ftdi_8u232am_b19200; break;
479 case 38400: rate = ftdi_8u232am_b38400; break;
480 case 57600: rate = ftdi_8u232am_b57600; break;
481 case 115200: rate = ftdi_8u232am_b115200; break;
482 case 230400: rate = ftdi_8u232am_b230400; break;
483 case 460800: rate = ftdi_8u232am_b460800; break;
484 case 921600: rate = ftdi_8u232am_b921600; break;
490 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
491 req.bRequest = FTDI_SIO_SET_BAUD_RATE;
492 USETW(req.wValue, rate);
493 USETW(req.wIndex, portno);
494 USETW(req.wLength, 0);
495 DPRINTFN(2,("uftdi_param: reqtype=0x%02x req=0x%02x value=0x%04x "
496 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest,
497 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength)));
498 err = usbd_do_request(ucom->sc_udev, &req, NULL);
502 if (ISSET(t->c_cflag, CSTOPB))
503 data = FTDI_SIO_SET_DATA_STOP_BITS_2;
505 data = FTDI_SIO_SET_DATA_STOP_BITS_1;
506 if (ISSET(t->c_cflag, PARENB)) {
507 if (ISSET(t->c_cflag, PARODD))
508 data |= FTDI_SIO_SET_DATA_PARITY_ODD;
510 data |= FTDI_SIO_SET_DATA_PARITY_EVEN;
512 data |= FTDI_SIO_SET_DATA_PARITY_NONE;
513 switch (ISSET(t->c_cflag, CSIZE)) {
515 data |= FTDI_SIO_SET_DATA_BITS(5);
518 data |= FTDI_SIO_SET_DATA_BITS(6);
521 data |= FTDI_SIO_SET_DATA_BITS(7);
524 data |= FTDI_SIO_SET_DATA_BITS(8);
529 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
530 req.bRequest = FTDI_SIO_SET_DATA;
531 USETW(req.wValue, data);
532 USETW(req.wIndex, portno);
533 USETW(req.wLength, 0);
534 DPRINTFN(2,("uftdi_param: reqtype=0x%02x req=0x%02x value=0x%04x "
535 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest,
536 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength)));
537 err = usbd_do_request(ucom->sc_udev, &req, NULL);
541 if (ISSET(t->c_cflag, CRTSCTS)) {
542 flow = FTDI_SIO_RTS_CTS_HS;
543 USETW(req.wValue, 0);
544 } else if (ISSET(t->c_iflag, IXON|IXOFF)) {
545 flow = FTDI_SIO_XON_XOFF_HS;
546 USETW2(req.wValue, t->c_cc[VSTOP], t->c_cc[VSTART]);
548 flow = FTDI_SIO_DISABLE_FLOW_CTRL;
549 USETW(req.wValue, 0);
551 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
552 req.bRequest = FTDI_SIO_SET_FLOW_CTRL;
553 USETW2(req.wIndex, flow, portno);
554 USETW(req.wLength, 0);
555 err = usbd_do_request(ucom->sc_udev, &req, NULL);
563 uftdi_get_status(void *vsc, int portno, u_char *lsr, u_char *msr)
565 struct uftdi_softc *sc = vsc;
567 DPRINTF(("uftdi_status: msr=0x%02x lsr=0x%02x\n",
568 sc->sc_msr, sc->sc_lsr));
577 uftdi_break(void *vsc, int portno, int onoff)
579 struct uftdi_softc *sc = vsc;
580 struct ucom_softc *ucom = vsc;
582 usb_device_request_t req;
585 DPRINTF(("uftdi_break: sc=%p, port=%d onoff=%d\n", vsc, portno,
589 data = sc->last_lcr | FTDI_SIO_SET_BREAK;
594 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
595 req.bRequest = FTDI_SIO_SET_DATA;
596 USETW(req.wValue, data);
597 USETW(req.wIndex, portno);
598 USETW(req.wLength, 0);
599 (void)usbd_do_request(ucom->sc_udev, &req, NULL);
602 static device_method_t uftdi_methods[] = {
603 /* Device interface */
604 DEVMETHOD(device_probe, uftdi_match),
605 DEVMETHOD(device_attach, uftdi_attach),
606 DEVMETHOD(device_detach, uftdi_detach),
611 static driver_t uftdi_driver = {
614 sizeof (struct uftdi_softc)
617 DRIVER_MODULE(uftdi, uhub, uftdi_driver, ucom_devclass, usbd_driver_load, 0);
618 MODULE_DEPEND(uftdi, usb, 1, 1, 1);
619 MODULE_DEPEND(uftdi, ucom,UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);