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