uftdi.c revision 1.18
1 /* $NetBSD: uftdi.c,v 1.18 2004/01/05 13:29:27 augustss 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 (at) 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.18 2004/01/05 13:29:27 augustss 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 return (UMATCH_VENDOR_PRODUCT); 145 146 return (UMATCH_NONE); 147 } 148 149 USB_ATTACH(uftdi) 150 { 151 USB_ATTACH_START(uftdi, sc, uaa); 152 usbd_device_handle dev = uaa->device; 153 usbd_interface_handle iface; 154 usb_interface_descriptor_t *id; 155 usb_endpoint_descriptor_t *ed; 156 char devinfo[1024]; 157 char *devname = USBDEVNAME(sc->sc_dev); 158 int i; 159 usbd_status err; 160 struct ucom_attach_args uca; 161 162 DPRINTFN(10,("\nuftdi_attach: sc=%p\n", sc)); 163 164 /* Move the device into the configured state. */ 165 err = usbd_set_config_index(dev, UFTDI_CONFIG_INDEX, 1); 166 if (err) { 167 printf("\n%s: failed to set configuration, err=%s\n", 168 devname, usbd_errstr(err)); 169 goto bad; 170 } 171 172 err = usbd_device2interface_handle(dev, UFTDI_IFACE_INDEX, &iface); 173 if (err) { 174 printf("\n%s: failed to get interface, err=%s\n", 175 devname, usbd_errstr(err)); 176 goto bad; 177 } 178 179 usbd_devinfo(dev, 0, devinfo); 180 USB_ATTACH_SETUP; 181 printf("%s: %s\n", devname, devinfo); 182 183 id = usbd_get_interface_descriptor(iface); 184 185 sc->sc_udev = dev; 186 sc->sc_iface = iface; 187 188 switch (uaa->product) { 189 case USB_PRODUCT_FTDI_SERIAL_8U100AX: 190 sc->sc_type = UFTDI_TYPE_SIO; 191 sc->sc_hdrlen = 1; 192 break; 193 194 case USB_PRODUCT_FTDI_SEMC_DSS20: 195 case USB_PRODUCT_FTDI_SERIAL_8U232AM: 196 case USB_PRODUCT_FTDI_LCD_LK202_24_USB: 197 sc->sc_type = UFTDI_TYPE_8U232AM; 198 sc->sc_hdrlen = 0; 199 break; 200 201 default: /* Can't happen */ 202 goto bad; 203 } 204 205 uca.bulkin = uca.bulkout = -1; 206 for (i = 0; i < id->bNumEndpoints; i++) { 207 int addr, dir, attr; 208 ed = usbd_interface2endpoint_descriptor(iface, i); 209 if (ed == NULL) { 210 printf("%s: could not read endpoint descriptor" 211 ": %s\n", devname, usbd_errstr(err)); 212 goto bad; 213 } 214 215 addr = ed->bEndpointAddress; 216 dir = UE_GET_DIR(ed->bEndpointAddress); 217 attr = ed->bmAttributes & UE_XFERTYPE; 218 if (dir == UE_DIR_IN && attr == UE_BULK) 219 uca.bulkin = addr; 220 else if (dir == UE_DIR_OUT && attr == UE_BULK) 221 uca.bulkout = addr; 222 else { 223 printf("%s: unexpected endpoint\n", devname); 224 goto bad; 225 } 226 } 227 if (uca.bulkin == -1) { 228 printf("%s: Could not find data bulk in\n", 229 USBDEVNAME(sc->sc_dev)); 230 goto bad; 231 } 232 if (uca.bulkout == -1) { 233 printf("%s: Could not find data bulk out\n", 234 USBDEVNAME(sc->sc_dev)); 235 goto bad; 236 } 237 238 uca.portno = FTDI_PIT_SIOA; 239 /* bulkin, bulkout set above */ 240 uca.ibufsize = UFTDIIBUFSIZE; 241 uca.obufsize = UFTDIOBUFSIZE - sc->sc_hdrlen; 242 uca.ibufsizepad = UFTDIIBUFSIZE; 243 uca.opkthdrlen = sc->sc_hdrlen; 244 uca.device = dev; 245 uca.iface = iface; 246 uca.methods = &uftdi_methods; 247 uca.arg = sc; 248 uca.info = NULL; 249 250 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 251 USBDEV(sc->sc_dev)); 252 253 DPRINTF(("uftdi: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout)); 254 sc->sc_subdev = config_found_sm(self, &uca, ucomprint, ucomsubmatch); 255 256 USB_ATTACH_SUCCESS_RETURN; 257 258 bad: 259 DPRINTF(("uftdi_attach: ATTACH ERROR\n")); 260 sc->sc_dying = 1; 261 USB_ATTACH_ERROR_RETURN; 262 } 263 264 int 265 uftdi_activate(device_ptr_t self, enum devact act) 266 { 267 struct uftdi_softc *sc = (struct uftdi_softc *)self; 268 int rv = 0; 269 270 switch (act) { 271 case DVACT_ACTIVATE: 272 return (EOPNOTSUPP); 273 274 case DVACT_DEACTIVATE: 275 if (sc->sc_subdev != NULL) 276 rv = config_deactivate(sc->sc_subdev); 277 sc->sc_dying = 1; 278 break; 279 } 280 return (rv); 281 } 282 283 int 284 uftdi_detach(device_ptr_t self, int flags) 285 { 286 struct uftdi_softc *sc = (struct uftdi_softc *)self; 287 288 DPRINTF(("uftdi_detach: sc=%p flags=%d\n", sc, flags)); 289 sc->sc_dying = 1; 290 if (sc->sc_subdev != NULL) { 291 config_detach(sc->sc_subdev, flags); 292 sc->sc_subdev = NULL; 293 } 294 295 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 296 USBDEV(sc->sc_dev)); 297 298 return (0); 299 } 300 301 Static int 302 uftdi_open(void *vsc, int portno) 303 { 304 struct uftdi_softc *sc = vsc; 305 usb_device_request_t req; 306 usbd_status err; 307 struct termios t; 308 309 DPRINTF(("uftdi_open: sc=%p\n", sc)); 310 311 if (sc->sc_dying) 312 return (EIO); 313 314 /* Perform a full reset on the device */ 315 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 316 req.bRequest = FTDI_SIO_RESET; 317 USETW(req.wValue, FTDI_SIO_RESET_SIO); 318 USETW(req.wIndex, portno); 319 USETW(req.wLength, 0); 320 err = usbd_do_request(sc->sc_udev, &req, NULL); 321 if (err) 322 return (EIO); 323 324 /* Set 9600 baud, 2 stop bits, no parity, 8 bits */ 325 t.c_ospeed = 9600; 326 t.c_cflag = CSTOPB | CS8; 327 (void)uftdi_param(sc, portno, &t); 328 329 /* Turn on RTS/CTS flow control */ 330 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 331 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 332 USETW(req.wValue, 0); 333 USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, portno); 334 USETW(req.wLength, 0); 335 err = usbd_do_request(sc->sc_udev, &req, NULL); 336 if (err) 337 return (EIO); 338 339 return (0); 340 } 341 342 Static void 343 uftdi_read(void *vsc, int portno, u_char **ptr, u_int32_t *count) 344 { 345 struct uftdi_softc *sc = vsc; 346 u_char msr, lsr; 347 348 DPRINTFN(15,("uftdi_read: sc=%p, port=%d count=%d\n", sc, portno, 349 *count)); 350 351 msr = FTDI_GET_MSR(*ptr); 352 lsr = FTDI_GET_LSR(*ptr); 353 354 #ifdef UFTDI_DEBUG 355 if (*count != 2) 356 DPRINTFN(10,("uftdi_read: sc=%p, port=%d count=%d data[0]=" 357 "0x%02x\n", sc, portno, *count, (*ptr)[2])); 358 #endif 359 360 if (sc->sc_msr != msr || 361 (sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK)) { 362 DPRINTF(("uftdi_read: status change msr=0x%02x(0x%02x) " 363 "lsr=0x%02x(0x%02x)\n", msr, sc->sc_msr, 364 lsr, sc->sc_lsr)); 365 sc->sc_msr = msr; 366 sc->sc_lsr = lsr; 367 ucom_status_change((struct ucom_softc *)sc->sc_subdev); 368 } 369 370 /* Pick up status and adjust data part. */ 371 *ptr += 2; 372 *count -= 2; 373 } 374 375 Static void 376 uftdi_write(void *vsc, int portno, u_char *to, u_char *from, u_int32_t *count) 377 { 378 struct uftdi_softc *sc = vsc; 379 380 DPRINTFN(10,("uftdi_write: sc=%p, port=%d count=%u data[0]=0x%02x\n", 381 vsc, portno, *count, from[0])); 382 383 /* Make length tag and copy data */ 384 if (sc->sc_hdrlen > 0) 385 *to = FTDI_OUT_TAG(*count, portno); 386 387 memcpy(to + sc->sc_hdrlen, from, *count); 388 *count += sc->sc_hdrlen; 389 } 390 391 Static void 392 uftdi_set(void *vsc, int portno, int reg, int onoff) 393 { 394 struct uftdi_softc *sc = vsc; 395 usb_device_request_t req; 396 int ctl; 397 398 DPRINTF(("uftdi_set: sc=%p, port=%d reg=%d onoff=%d\n", vsc, portno, 399 reg, onoff)); 400 401 switch (reg) { 402 case UCOM_SET_DTR: 403 ctl = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW; 404 break; 405 case UCOM_SET_RTS: 406 ctl = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW; 407 break; 408 case UCOM_SET_BREAK: 409 uftdi_break(sc, portno, onoff); 410 return; 411 default: 412 return; 413 } 414 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 415 req.bRequest = FTDI_SIO_MODEM_CTRL; 416 USETW(req.wValue, ctl); 417 USETW(req.wIndex, portno); 418 USETW(req.wLength, 0); 419 DPRINTFN(2,("uftdi_set: reqtype=0x%02x req=0x%02x value=0x%04x " 420 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 421 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 422 (void)usbd_do_request(sc->sc_udev, &req, NULL); 423 } 424 425 Static int 426 uftdi_param(void *vsc, int portno, struct termios *t) 427 { 428 struct uftdi_softc *sc = vsc; 429 usb_device_request_t req; 430 usbd_status err; 431 int rate, data, flow; 432 433 DPRINTF(("uftdi_param: sc=%p\n", sc)); 434 435 if (sc->sc_dying) 436 return (EIO); 437 438 switch (sc->sc_type) { 439 case UFTDI_TYPE_SIO: 440 switch (t->c_ospeed) { 441 case 300: rate = ftdi_sio_b300; break; 442 case 600: rate = ftdi_sio_b600; break; 443 case 1200: rate = ftdi_sio_b1200; break; 444 case 2400: rate = ftdi_sio_b2400; break; 445 case 4800: rate = ftdi_sio_b4800; break; 446 case 9600: rate = ftdi_sio_b9600; break; 447 case 19200: rate = ftdi_sio_b19200; break; 448 case 38400: rate = ftdi_sio_b38400; break; 449 case 57600: rate = ftdi_sio_b57600; break; 450 case 115200: rate = ftdi_sio_b115200; break; 451 default: 452 return (EINVAL); 453 } 454 break; 455 456 case UFTDI_TYPE_8U232AM: 457 switch(t->c_ospeed) { 458 case 300: rate = ftdi_8u232am_b300; break; 459 case 600: rate = ftdi_8u232am_b600; break; 460 case 1200: rate = ftdi_8u232am_b1200; break; 461 case 2400: rate = ftdi_8u232am_b2400; break; 462 case 4800: rate = ftdi_8u232am_b4800; break; 463 case 9600: rate = ftdi_8u232am_b9600; break; 464 case 19200: rate = ftdi_8u232am_b19200; break; 465 case 38400: rate = ftdi_8u232am_b38400; break; 466 case 57600: rate = ftdi_8u232am_b57600; break; 467 case 115200: rate = ftdi_8u232am_b115200; break; 468 case 230400: rate = ftdi_8u232am_b230400; break; 469 case 460800: rate = ftdi_8u232am_b460800; break; 470 case 921600: rate = ftdi_8u232am_b921600; break; 471 default: 472 return (EINVAL); 473 } 474 break; 475 476 default: 477 return (EINVAL); 478 } 479 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 480 req.bRequest = FTDI_SIO_SET_BAUD_RATE; 481 USETW(req.wValue, rate); 482 USETW(req.wIndex, portno); 483 USETW(req.wLength, 0); 484 DPRINTFN(2,("uftdi_param: reqtype=0x%02x req=0x%02x value=0x%04x " 485 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 486 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 487 err = usbd_do_request(sc->sc_udev, &req, NULL); 488 if (err) 489 return (EIO); 490 491 if (ISSET(t->c_cflag, CSTOPB)) 492 data = FTDI_SIO_SET_DATA_STOP_BITS_2; 493 else 494 data = FTDI_SIO_SET_DATA_STOP_BITS_1; 495 if (ISSET(t->c_cflag, PARENB)) { 496 if (ISSET(t->c_cflag, PARODD)) 497 data |= FTDI_SIO_SET_DATA_PARITY_ODD; 498 else 499 data |= FTDI_SIO_SET_DATA_PARITY_EVEN; 500 } else 501 data |= FTDI_SIO_SET_DATA_PARITY_NONE; 502 switch (ISSET(t->c_cflag, CSIZE)) { 503 case CS5: 504 data |= FTDI_SIO_SET_DATA_BITS(5); 505 break; 506 case CS6: 507 data |= FTDI_SIO_SET_DATA_BITS(6); 508 break; 509 case CS7: 510 data |= FTDI_SIO_SET_DATA_BITS(7); 511 break; 512 case CS8: 513 data |= FTDI_SIO_SET_DATA_BITS(8); 514 break; 515 } 516 sc->last_lcr = data; 517 518 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 519 req.bRequest = FTDI_SIO_SET_DATA; 520 USETW(req.wValue, data); 521 USETW(req.wIndex, portno); 522 USETW(req.wLength, 0); 523 DPRINTFN(2,("uftdi_param: reqtype=0x%02x req=0x%02x value=0x%04x " 524 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 525 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 526 err = usbd_do_request(sc->sc_udev, &req, NULL); 527 if (err) 528 return (EIO); 529 530 if (ISSET(t->c_cflag, CRTSCTS)) { 531 flow = FTDI_SIO_RTS_CTS_HS; 532 USETW(req.wValue, 0); 533 } else if (ISSET(t->c_iflag, IXON|IXOFF)) { 534 flow = FTDI_SIO_XON_XOFF_HS; 535 USETW2(req.wValue, t->c_cc[VSTOP], t->c_cc[VSTART]); 536 } else { 537 flow = FTDI_SIO_DISABLE_FLOW_CTRL; 538 USETW(req.wValue, 0); 539 } 540 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 541 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 542 USETW2(req.wIndex, flow, portno); 543 USETW(req.wLength, 0); 544 err = usbd_do_request(sc->sc_udev, &req, NULL); 545 if (err) 546 return (EIO); 547 548 return (0); 549 } 550 551 void 552 uftdi_get_status(void *vsc, int portno, u_char *lsr, u_char *msr) 553 { 554 struct uftdi_softc *sc = vsc; 555 556 DPRINTF(("uftdi_status: msr=0x%02x lsr=0x%02x\n", 557 sc->sc_msr, sc->sc_lsr)); 558 559 if (msr != NULL) 560 *msr = sc->sc_msr; 561 if (lsr != NULL) 562 *lsr = sc->sc_lsr; 563 } 564 565 void 566 uftdi_break(void *vsc, int portno, int onoff) 567 { 568 struct uftdi_softc *sc = vsc; 569 usb_device_request_t req; 570 int data; 571 572 DPRINTF(("uftdi_break: sc=%p, port=%d onoff=%d\n", vsc, portno, 573 onoff)); 574 575 if (onoff) { 576 data = sc->last_lcr | FTDI_SIO_SET_BREAK; 577 } else { 578 data = sc->last_lcr; 579 } 580 581 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 582 req.bRequest = FTDI_SIO_SET_DATA; 583 USETW(req.wValue, data); 584 USETW(req.wIndex, portno); 585 USETW(req.wLength, 0); 586 (void)usbd_do_request(sc->sc_udev, &req, NULL); 587 } 588
Indexes created Tue Sep 30 17:09:57 GMT 2025