1 /* $NetBSD: uftdi.c,v 1.25 2005/12/11 12:24:01 christos 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 /* 40 * FTDI FT8U100AX serial adapter driver 41 */ 42 43 /* 44 * XXX This driver will not support multiple serial ports. 45 * XXX The ucom layer needs to be extended first. 46 */ 47 48 #include <sys/cdefs.h> 49 __KERNEL_RCSID(0, "$NetBSD: uftdi.c,v 1.25 2005/12/11 12:24:01 christos Exp $"); 50 51 #include <sys/param.h> 52 #include <sys/systm.h> 53 #include <sys/kernel.h> 54 #include <sys/device.h> 55 #include <sys/conf.h> 56 #include <sys/tty.h> 57 58 #include <dev/usb/usb.h> 59 #include <dev/usb/usbhid.h> 60 61 #include <dev/usb/usbdi.h> 62 #include <dev/usb/usbdi_util.h> 63 #include <dev/usb/usbdevs.h> 64 65 #include <dev/usb/ucomvar.h> 66 67 #include <dev/usb/uftdireg.h> 68 69 #ifdef UFTDI_DEBUG 70 #define DPRINTF(x) if (uftdidebug) printf x 71 #define DPRINTFN(n,x) if (uftdidebug>(n)) printf x 72 int uftdidebug = 0; 73 #else 74 #define DPRINTF(x) 75 #define DPRINTFN(n,x) 76 #endif 77 78 #define UFTDI_CONFIG_INDEX 0 79 #define UFTDI_IFACE_INDEX 0 80 81 82 /* 83 * These are the maximum number of bytes transferred per frame. 84 * The output buffer size cannot be increased due to the size encoding. 85 */ 86 #define UFTDIIBUFSIZE 64 87 #define UFTDIOBUFSIZE 64 88 89 struct uftdi_softc { 90 USBBASEDEVICE sc_dev; /* base device */ 91 usbd_device_handle sc_udev; /* device */ 92 usbd_interface_handle sc_iface; /* interface */ 93 94 enum uftdi_type sc_type; 95 u_int sc_hdrlen; 96 97 u_char sc_msr; 98 u_char sc_lsr; 99 100 device_ptr_t sc_subdev; 101 102 u_char sc_dying; 103 104 u_int last_lcr; 105 }; 106 107 Static void uftdi_get_status(void *, int portno, u_char *lsr, u_char *msr); 108 Static void uftdi_set(void *, int, int, int); 109 Static int uftdi_param(void *, int, struct termios *); 110 Static int uftdi_open(void *sc, int portno); 111 Static void uftdi_read(void *sc, int portno, u_char **ptr,u_int32_t *count); 112 Static void uftdi_write(void *sc, int portno, u_char *to, u_char *from, 113 u_int32_t *count); 114 Static void uftdi_break(void *sc, int portno, int onoff); 115 116 struct ucom_methods uftdi_methods = { 117 uftdi_get_status, 118 uftdi_set, 119 uftdi_param, 120 NULL, 121 uftdi_open, 122 NULL, 123 uftdi_read, 124 uftdi_write, 125 }; 126 127 USB_DECLARE_DRIVER(uftdi); 128 129 USB_MATCH(uftdi) 130 { 131 USB_MATCH_START(uftdi, uaa); 132 133 if (uaa->iface != NULL) 134 return (UMATCH_NONE); 135 136 DPRINTFN(20,("uftdi: vendor=0x%x, product=0x%x\n", 137 uaa->vendor, uaa->product)); 138 139 if (uaa->vendor == USB_VENDOR_FTDI && 140 (uaa->product == USB_PRODUCT_FTDI_SERIAL_8U100AX || 141 uaa->product == USB_PRODUCT_FTDI_SERIAL_8U232AM || 142 uaa->product == USB_PRODUCT_FTDI_SEMC_DSS20 || 143 uaa->product == USB_PRODUCT_FTDI_LCD_LK202_24_USB || 144 uaa->product == USB_PRODUCT_FTDI_LCD_MX200_USB || 145 uaa->product == USB_PRODUCT_FTDI_CFA_631)) 146 return (UMATCH_VENDOR_PRODUCT); 147 148 if (uaa->vendor == USB_VENDOR_SEALEVEL && 149 uaa->product == USB_PRODUCT_SEALEVEL_USBSERIAL) 150 return (UMATCH_VENDOR_PRODUCT); 151 152 return (UMATCH_NONE); 153 } 154 155 USB_ATTACH(uftdi) 156 { 157 USB_ATTACH_START(uftdi, sc, uaa); 158 usbd_device_handle dev = uaa->device; 159 usbd_interface_handle iface; 160 usb_interface_descriptor_t *id; 161 usb_endpoint_descriptor_t *ed; 162 char *devinfop; 163 char *devname = USBDEVNAME(sc->sc_dev); 164 int i; 165 usbd_status err; 166 struct ucom_attach_args uca; 167 168 DPRINTFN(10,("\nuftdi_attach: sc=%p\n", sc)); 169 170 /* Move the device into the configured state. */ 171 err = usbd_set_config_index(dev, UFTDI_CONFIG_INDEX, 1); 172 if (err) { 173 printf("\n%s: failed to set configuration, err=%s\n", 174 devname, usbd_errstr(err)); 175 goto bad; 176 } 177 178 err = usbd_device2interface_handle(dev, UFTDI_IFACE_INDEX, &iface); 179 if (err) { 180 printf("\n%s: failed to get interface, err=%s\n", 181 devname, usbd_errstr(err)); 182 goto bad; 183 } 184 185 devinfop = usbd_devinfo_alloc(dev, 0); 186 USB_ATTACH_SETUP; 187 printf("%s: %s\n", devname, devinfop); 188 usbd_devinfo_free(devinfop); 189 190 id = usbd_get_interface_descriptor(iface); 191 192 sc->sc_udev = dev; 193 sc->sc_iface = iface; 194 195 switch (uaa->product) { 196 case USB_PRODUCT_FTDI_SERIAL_8U100AX: 197 sc->sc_type = UFTDI_TYPE_SIO; 198 sc->sc_hdrlen = 1; 199 break; 200 201 case USB_PRODUCT_FTDI_SEMC_DSS20: 202 case USB_PRODUCT_FTDI_SERIAL_8U232AM: 203 case USB_PRODUCT_FTDI_LCD_LK202_24_USB: 204 case USB_PRODUCT_FTDI_LCD_MX200_USB: 205 case USB_PRODUCT_FTDI_CFA_631: 206 case USB_PRODUCT_SEALEVEL_USBSERIAL: 207 sc->sc_type = UFTDI_TYPE_8U232AM; 208 sc->sc_hdrlen = 0; 209 break; 210 211 default: /* Can't happen */ 212 goto bad; 213 } 214 215 uca.bulkin = uca.bulkout = -1; 216 for (i = 0; i < id->bNumEndpoints; i++) { 217 int addr, dir, attr; 218 ed = usbd_interface2endpoint_descriptor(iface, i); 219 if (ed == NULL) { 220 printf("%s: could not read endpoint descriptor" 221 ": %s\n", devname, usbd_errstr(err)); 222 goto bad; 223 } 224 225 addr = ed->bEndpointAddress; 226 dir = UE_GET_DIR(ed->bEndpointAddress); 227 attr = ed->bmAttributes & UE_XFERTYPE; 228 if (dir == UE_DIR_IN && attr == UE_BULK) 229 uca.bulkin = addr; 230 else if (dir == UE_DIR_OUT && attr == UE_BULK) 231 uca.bulkout = addr; 232 else { 233 printf("%s: unexpected endpoint\n", devname); 234 goto bad; 235 } 236 } 237 if (uca.bulkin == -1) { 238 printf("%s: Could not find data bulk in\n", 239 USBDEVNAME(sc->sc_dev)); 240 goto bad; 241 } 242 if (uca.bulkout == -1) { 243 printf("%s: Could not find data bulk out\n", 244 USBDEVNAME(sc->sc_dev)); 245 goto bad; 246 } 247 248 uca.portno = FTDI_PIT_SIOA; 249 /* bulkin, bulkout set above */ 250 uca.ibufsize = UFTDIIBUFSIZE; 251 uca.obufsize = UFTDIOBUFSIZE - sc->sc_hdrlen; 252 uca.ibufsizepad = UFTDIIBUFSIZE; 253 uca.opkthdrlen = sc->sc_hdrlen; 254 uca.device = dev; 255 uca.iface = iface; 256 uca.methods = &uftdi_methods; 257 uca.arg = sc; 258 uca.info = NULL; 259 260 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 261 USBDEV(sc->sc_dev)); 262 263 DPRINTF(("uftdi: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout)); 264 sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca, 265 ucomprint, ucomsubmatch); 266 267 USB_ATTACH_SUCCESS_RETURN; 268 269 bad: 270 DPRINTF(("uftdi_attach: ATTACH ERROR\n")); 271 sc->sc_dying = 1; 272 USB_ATTACH_ERROR_RETURN; 273 } 274 275 int 276 uftdi_activate(device_ptr_t self, enum devact act) 277 { 278 struct uftdi_softc *sc = (struct uftdi_softc *)self; 279 int rv = 0; 280 281 switch (act) { 282 case DVACT_ACTIVATE: 283 return (EOPNOTSUPP); 284 285 case DVACT_DEACTIVATE: 286 if (sc->sc_subdev != NULL) 287 rv = config_deactivate(sc->sc_subdev); 288 sc->sc_dying = 1; 289 break; 290 } 291 return (rv); 292 } 293 294 int 295 uftdi_detach(device_ptr_t self, int flags) 296 { 297 struct uftdi_softc *sc = (struct uftdi_softc *)self; 298 299 DPRINTF(("uftdi_detach: sc=%p flags=%d\n", sc, flags)); 300 sc->sc_dying = 1; 301 if (sc->sc_subdev != NULL) { 302 config_detach(sc->sc_subdev, flags); 303 sc->sc_subdev = NULL; 304 } 305 306 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 307 USBDEV(sc->sc_dev)); 308 309 return (0); 310 } 311 312 Static int 313 uftdi_open(void *vsc, int portno) 314 { 315 struct uftdi_softc *sc = vsc; 316 usb_device_request_t req; 317 usbd_status err; 318 struct termios t; 319 320 DPRINTF(("uftdi_open: sc=%p\n", sc)); 321 322 if (sc->sc_dying) 323 return (EIO); 324 325 /* Perform a full reset on the device */ 326 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 327 req.bRequest = FTDI_SIO_RESET; 328 USETW(req.wValue, FTDI_SIO_RESET_SIO); 329 USETW(req.wIndex, portno); 330 USETW(req.wLength, 0); 331 err = usbd_do_request(sc->sc_udev, &req, NULL); 332 if (err) 333 return (EIO); 334 335 /* Set 9600 baud, 2 stop bits, no parity, 8 bits */ 336 t.c_ospeed = 9600; 337 t.c_cflag = CSTOPB | CS8; 338 (void)uftdi_param(sc, portno, &t); 339 340 /* Turn on RTS/CTS flow control */ 341 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 342 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 343 USETW(req.wValue, 0); 344 USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, portno); 345 USETW(req.wLength, 0); 346 err = usbd_do_request(sc->sc_udev, &req, NULL); 347 if (err) 348 return (EIO); 349 350 return (0); 351 } 352 353 Static void 354 uftdi_read(void *vsc, int portno, u_char **ptr, u_int32_t *count) 355 { 356 struct uftdi_softc *sc = vsc; 357 u_char msr, lsr; 358 359 DPRINTFN(15,("uftdi_read: sc=%p, port=%d count=%d\n", sc, portno, 360 *count)); 361 362 msr = FTDI_GET_MSR(*ptr); 363 lsr = FTDI_GET_LSR(*ptr); 364 365 #ifdef UFTDI_DEBUG 366 if (*count != 2) 367 DPRINTFN(10,("uftdi_read: sc=%p, port=%d count=%d data[0]=" 368 "0x%02x\n", sc, portno, *count, (*ptr)[2])); 369 #endif 370 371 if (sc->sc_msr != msr || 372 (sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK)) { 373 DPRINTF(("uftdi_read: status change msr=0x%02x(0x%02x) " 374 "lsr=0x%02x(0x%02x)\n", msr, sc->sc_msr, 375 lsr, sc->sc_lsr)); 376 sc->sc_msr = msr; 377 sc->sc_lsr = lsr; 378 ucom_status_change((struct ucom_softc *)sc->sc_subdev); 379 } 380 381 /* Pick up status and adjust data part. */ 382 *ptr += 2; 383 *count -= 2; 384 } 385 386 Static void 387 uftdi_write(void *vsc, int portno, u_char *to, u_char *from, u_int32_t *count) 388 { 389 struct uftdi_softc *sc = vsc; 390 391 DPRINTFN(10,("uftdi_write: sc=%p, port=%d count=%u data[0]=0x%02x\n", 392 vsc, portno, *count, from[0])); 393 394 /* Make length tag and copy data */ 395 if (sc->sc_hdrlen > 0) 396 *to = FTDI_OUT_TAG(*count, portno); 397 398 memcpy(to + sc->sc_hdrlen, from, *count); 399 *count += sc->sc_hdrlen; 400 } 401 402 Static void 403 uftdi_set(void *vsc, int portno, int reg, int onoff) 404 { 405 struct uftdi_softc *sc = vsc; 406 usb_device_request_t req; 407 int ctl; 408 409 DPRINTF(("uftdi_set: sc=%p, port=%d reg=%d onoff=%d\n", vsc, portno, 410 reg, onoff)); 411 412 switch (reg) { 413 case UCOM_SET_DTR: 414 ctl = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW; 415 break; 416 case UCOM_SET_RTS: 417 ctl = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW; 418 break; 419 case UCOM_SET_BREAK: 420 uftdi_break(sc, portno, onoff); 421 return; 422 default: 423 return; 424 } 425 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 426 req.bRequest = FTDI_SIO_MODEM_CTRL; 427 USETW(req.wValue, ctl); 428 USETW(req.wIndex, portno); 429 USETW(req.wLength, 0); 430 DPRINTFN(2,("uftdi_set: reqtype=0x%02x req=0x%02x value=0x%04x " 431 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 432 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 433 (void)usbd_do_request(sc->sc_udev, &req, NULL); 434 } 435 436 Static int 437 uftdi_param(void *vsc, int portno, struct termios *t) 438 { 439 struct uftdi_softc *sc = vsc; 440 usb_device_request_t req; 441 usbd_status err; 442 int rate, data, flow; 443 444 DPRINTF(("uftdi_param: sc=%p\n", sc)); 445 446 if (sc->sc_dying) 447 return (EIO); 448 449 switch (sc->sc_type) { 450 case UFTDI_TYPE_SIO: 451 switch (t->c_ospeed) { 452 case 300: rate = ftdi_sio_b300; break; 453 case 600: rate = ftdi_sio_b600; break; 454 case 1200: rate = ftdi_sio_b1200; break; 455 case 2400: rate = ftdi_sio_b2400; break; 456 case 4800: rate = ftdi_sio_b4800; break; 457 case 9600: rate = ftdi_sio_b9600; break; 458 case 19200: rate = ftdi_sio_b19200; break; 459 case 38400: rate = ftdi_sio_b38400; break; 460 case 57600: rate = ftdi_sio_b57600; break; 461 case 115200: rate = ftdi_sio_b115200; break; 462 default: 463 return (EINVAL); 464 } 465 break; 466 467 case UFTDI_TYPE_8U232AM: 468 switch(t->c_ospeed) { 469 case 300: rate = ftdi_8u232am_b300; break; 470 case 600: rate = ftdi_8u232am_b600; break; 471 case 1200: rate = ftdi_8u232am_b1200; break; 472 case 2400: rate = ftdi_8u232am_b2400; break; 473 case 4800: rate = ftdi_8u232am_b4800; break; 474 case 9600: rate = ftdi_8u232am_b9600; break; 475 case 19200: rate = ftdi_8u232am_b19200; break; 476 case 38400: rate = ftdi_8u232am_b38400; break; 477 case 57600: rate = ftdi_8u232am_b57600; break; 478 case 115200: rate = ftdi_8u232am_b115200; break; 479 case 230400: rate = ftdi_8u232am_b230400; break; 480 case 460800: rate = ftdi_8u232am_b460800; break; 481 case 921600: rate = ftdi_8u232am_b921600; break; 482 default: 483 return (EINVAL); 484 } 485 break; 486 487 default: 488 return (EINVAL); 489 } 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(sc->sc_udev, &req, NULL); 499 if (err) 500 return (EIO); 501 502 if (ISSET(t->c_cflag, CSTOPB)) 503 data = FTDI_SIO_SET_DATA_STOP_BITS_2; 504 else 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; 509 else 510 data |= FTDI_SIO_SET_DATA_PARITY_EVEN; 511 } else 512 data |= FTDI_SIO_SET_DATA_PARITY_NONE; 513 switch (ISSET(t->c_cflag, CSIZE)) { 514 case CS5: 515 data |= FTDI_SIO_SET_DATA_BITS(5); 516 break; 517 case CS6: 518 data |= FTDI_SIO_SET_DATA_BITS(6); 519 break; 520 case CS7: 521 data |= FTDI_SIO_SET_DATA_BITS(7); 522 break; 523 case CS8: 524 data |= FTDI_SIO_SET_DATA_BITS(8); 525 break; 526 } 527 sc->last_lcr = data; 528 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(sc->sc_udev, &req, NULL); 538 if (err) 539 return (EIO); 540 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]); 547 } else { 548 flow = FTDI_SIO_DISABLE_FLOW_CTRL; 549 USETW(req.wValue, 0); 550 } 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(sc->sc_udev, &req, NULL); 556 if (err) 557 return (EIO); 558 559 return (0); 560 } 561 562 void 563 uftdi_get_status(void *vsc, int portno, u_char *lsr, u_char *msr) 564 { 565 struct uftdi_softc *sc = vsc; 566 567 DPRINTF(("uftdi_status: msr=0x%02x lsr=0x%02x\n", 568 sc->sc_msr, sc->sc_lsr)); 569 570 if (msr != NULL) 571 *msr = sc->sc_msr; 572 if (lsr != NULL) 573 *lsr = sc->sc_lsr; 574 } 575 576 void 577 uftdi_break(void *vsc, int portno, int onoff) 578 { 579 struct uftdi_softc *sc = vsc; 580 usb_device_request_t req; 581 int data; 582 583 DPRINTF(("uftdi_break: sc=%p, port=%d onoff=%d\n", vsc, portno, 584 onoff)); 585 586 if (onoff) { 587 data = sc->last_lcr | FTDI_SIO_SET_BREAK; 588 } else { 589 data = sc->last_lcr; 590 } 591 592 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 593 req.bRequest = FTDI_SIO_SET_DATA; 594 USETW(req.wValue, data); 595 USETW(req.wIndex, portno); 596 USETW(req.wLength, 0); 597 (void)usbd_do_request(sc->sc_udev, &req, NULL); 598 } 599