1 /* $NetBSD: uftdi.c,v 1.75 2021/04/24 23:36:59 thorpej 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 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 __KERNEL_RCSID(0, "$NetBSD: uftdi.c,v 1.75 2021/04/24 23:36:59 thorpej Exp $"); 34 35 #ifdef _KERNEL_OPT 36 #include "opt_usb.h" 37 #endif 38 39 #include <sys/param.h> 40 #include <sys/systm.h> 41 #include <sys/kernel.h> 42 #include <sys/device.h> 43 #include <sys/conf.h> 44 #include <sys/tty.h> 45 46 #include <dev/usb/usb.h> 47 48 #include <dev/usb/usbdi.h> 49 #include <dev/usb/usbdi_util.h> 50 #include <dev/usb/usbdevs.h> 51 52 #include <dev/usb/ucomvar.h> 53 54 #include <dev/usb/uftdireg.h> 55 56 #ifdef UFTDI_DEBUG 57 #define DPRINTF(x) if (uftdidebug) printf x 58 #define DPRINTFN(n,x) if (uftdidebug>(n)) printf x 59 int uftdidebug = 0; 60 #else 61 #define DPRINTF(x) 62 #define DPRINTFN(n,x) 63 #endif 64 65 #define UFTDI_CONFIG_NO 1 66 67 /* 68 * These are the default number of bytes transferred per frame if the 69 * endpoint doesn't tell us. The output buffer size is a hard limit 70 * for devices that use a 6-bit size encoding. 71 */ 72 #define UFTDIIBUFSIZE 64 73 #define UFTDIOBUFSIZE 64 74 75 /* 76 * Magic constants! Where do these come from? They're what Linux uses... 77 */ 78 #define UFTDI_MAX_IBUFSIZE 512 79 #define UFTDI_MAX_OBUFSIZE 256 80 81 struct uftdi_softc { 82 device_t sc_dev; /* base device */ 83 struct usbd_device * sc_udev; /* device */ 84 struct usbd_interface * sc_iface; /* interface */ 85 int sc_iface_no; 86 87 enum uftdi_type sc_type; 88 u_int sc_flags; 89 #define FLAGS_BAUDCLK_12M 0x00000001 90 #define FLAGS_ROUNDOFF_232A 0x00000002 91 #define FLAGS_BAUDBITS_HINDEX 0x00000004 92 u_int sc_hdrlen; 93 u_int sc_chiptype; 94 95 u_char sc_msr; 96 u_char sc_lsr; 97 98 device_t sc_subdev; 99 100 bool sc_dying; 101 102 u_int last_lcr; 103 }; 104 105 static void uftdi_get_status(void *, int, u_char *, u_char *); 106 static void uftdi_set(void *, int, int, int); 107 static int uftdi_param(void *, int, struct termios *); 108 static int uftdi_open(void *, int); 109 static void uftdi_read(void *, int, u_char **, uint32_t *); 110 static void uftdi_write(void *, int, u_char *, u_char *, uint32_t *); 111 static void uftdi_break(void *, int, int); 112 113 static const struct ucom_methods uftdi_methods = { 114 .ucom_get_status = uftdi_get_status, 115 .ucom_set = uftdi_set, 116 .ucom_param = uftdi_param, 117 .ucom_open = uftdi_open, 118 .ucom_read = uftdi_read, 119 .ucom_write = uftdi_write, 120 }; 121 122 /* 123 * The devices default to UFTDI_TYPE_8U232AM. 124 * Remember to update uftdi_attach() if it should be UFTDI_TYPE_SIO instead 125 */ 126 static const struct usb_devno uftdi_devs[] = { 127 { USB_VENDOR_BBELECTRONICS, USB_PRODUCT_BBELECTRONICS_USOTL4 }, 128 { USB_VENDOR_FALCOM, USB_PRODUCT_FALCOM_TWIST }, 129 { USB_VENDOR_FALCOM, USB_PRODUCT_FALCOM_SAMBA }, 130 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_230X }, 131 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_232H }, 132 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_232RL }, 133 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_2232C }, 134 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_4232H }, 135 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U100AX }, 136 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U232AM }, 137 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_KW }, 138 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_YS }, 139 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_Y6 }, 140 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_Y8 }, 141 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_IC }, 142 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_DB9 }, 143 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_RS232 }, 144 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MHAM_Y9 }, 145 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_COASTAL_TNCX }, 146 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CTI_485_MINI }, 147 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CTI_NANO_485 }, 148 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SEMC_DSS20 }, 149 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_LK202_24_USB }, 150 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_LK204_24_USB }, 151 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_MX200_USB }, 152 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_MX4_MX5_USB }, 153 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_CFA_631 }, 154 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_CFA_632 }, 155 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_CFA_633 }, 156 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_CFA_634 }, 157 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LCD_CFA_635 }, 158 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_OPENRD_JTAGKEY }, 159 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_BEAGLEBONE }, 160 { USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MAXSTREAM_PKG_U }, 161 { USB_VENDOR_xxFTDI, USB_PRODUCT_xxFTDI_SHEEVAPLUG_JTAG }, 162 { USB_VENDOR_INTREPIDCS, USB_PRODUCT_INTREPIDCS_VALUECAN }, 163 { USB_VENDOR_INTREPIDCS, USB_PRODUCT_INTREPIDCS_NEOVI }, 164 { USB_VENDOR_MELCO, USB_PRODUCT_MELCO_PCOPRS1 }, 165 { USB_VENDOR_RATOC, USB_PRODUCT_RATOC_REXUSB60F }, 166 { USB_VENDOR_RTSYS, USB_PRODUCT_RTSYS_CT57A }, 167 { USB_VENDOR_RTSYS, USB_PRODUCT_RTSYS_RTS03 }, 168 { USB_VENDOR_SEALEVEL, USB_PRODUCT_SEALEVEL_USBSERIAL }, 169 { USB_VENDOR_SEALEVEL, USB_PRODUCT_SEALEVEL_SEAPORT4P1 }, 170 { USB_VENDOR_SEALEVEL, USB_PRODUCT_SEALEVEL_SEAPORT4P2 }, 171 { USB_VENDOR_SEALEVEL, USB_PRODUCT_SEALEVEL_SEAPORT4P3 }, 172 { USB_VENDOR_SEALEVEL, USB_PRODUCT_SEALEVEL_SEAPORT4P4 }, 173 { USB_VENDOR_SIIG2, USB_PRODUCT_SIIG2_US2308 }, 174 { USB_VENDOR_MISC, USB_PRODUCT_MISC_TELLSTICK }, 175 { USB_VENDOR_MISC, USB_PRODUCT_MISC_TELLSTICK_DUO }, 176 }; 177 #define uftdi_lookup(v, p) usb_lookup(uftdi_devs, v, p) 178 179 static int uftdi_match(device_t, cfdata_t, void *); 180 static void uftdi_attach(device_t, device_t, void *); 181 static void uftdi_childdet(device_t, device_t); 182 static int uftdi_detach(device_t, int); 183 184 CFATTACH_DECL2_NEW(uftdi, sizeof(struct uftdi_softc), uftdi_match, 185 uftdi_attach, uftdi_detach, NULL, NULL, uftdi_childdet); 186 187 static int 188 uftdi_match(device_t parent, cfdata_t match, void *aux) 189 { 190 struct usbif_attach_arg *uiaa = aux; 191 192 DPRINTFN(20,("uftdi: vendor=%#x, product=%#x\n", 193 uiaa->uiaa_vendor, uiaa->uiaa_product)); 194 195 if (uiaa->uiaa_configno != UFTDI_CONFIG_NO) 196 return UMATCH_NONE; 197 198 return uftdi_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product) != NULL ? 199 UMATCH_VENDOR_PRODUCT_CONF_IFACE : UMATCH_NONE; 200 } 201 202 static void 203 uftdi_attach(device_t parent, device_t self, void *aux) 204 { 205 struct uftdi_softc *sc = device_private(self); 206 struct usbif_attach_arg *uiaa = aux; 207 struct usbd_device *dev = uiaa->uiaa_device; 208 struct usbd_interface *iface = uiaa->uiaa_iface; 209 usb_device_descriptor_t *ddesc; 210 usb_interface_descriptor_t *id; 211 usb_endpoint_descriptor_t *ed; 212 char *devinfop; 213 int i; 214 struct ucom_attach_args ucaa; 215 216 DPRINTFN(10,("\nuftdi_attach: sc=%p\n", sc)); 217 218 aprint_naive("\n"); 219 aprint_normal("\n"); 220 221 devinfop = usbd_devinfo_alloc(dev, 0); 222 aprint_normal_dev(self, "%s\n", devinfop); 223 usbd_devinfo_free(devinfop); 224 225 sc->sc_dev = self; 226 sc->sc_udev = dev; 227 sc->sc_dying = false; 228 sc->sc_iface_no = uiaa->uiaa_ifaceno; 229 sc->sc_type = UFTDI_TYPE_8U232AM; /* most devices are post-8U232AM */ 230 sc->sc_hdrlen = 0; 231 232 ddesc = usbd_get_device_descriptor(dev); 233 sc->sc_chiptype = UGETW(ddesc->bcdDevice); 234 235 switch (sc->sc_chiptype) { 236 case 0x0200: 237 if (ddesc->iSerialNumber != 0) 238 sc->sc_flags |= FLAGS_ROUNDOFF_232A; 239 ucaa.ucaa_portno = 0; 240 break; 241 case 0x0400: 242 ucaa.ucaa_portno = 0; 243 break; 244 case 0x0500: 245 sc->sc_flags |= FLAGS_BAUDBITS_HINDEX; 246 ucaa.ucaa_portno = FTDI_PIT_SIOA + sc->sc_iface_no; 247 break; 248 case 0x0600: 249 ucaa.ucaa_portno = 0; 250 break; 251 case 0x0700: 252 case 0x0800: 253 case 0x0900: 254 sc->sc_flags |= FLAGS_BAUDCLK_12M; 255 sc->sc_flags |= FLAGS_BAUDBITS_HINDEX; 256 ucaa.ucaa_portno = FTDI_PIT_SIOA + sc->sc_iface_no; 257 break; 258 case 0x1000: 259 sc->sc_flags |= FLAGS_BAUDBITS_HINDEX; 260 ucaa.ucaa_portno = FTDI_PIT_SIOA + sc->sc_iface_no; 261 break; 262 default: 263 if (sc->sc_chiptype < 0x0200) { 264 sc->sc_type = UFTDI_TYPE_SIO; 265 sc->sc_hdrlen = 1; 266 } 267 ucaa.ucaa_portno = 0; 268 break; 269 } 270 271 id = usbd_get_interface_descriptor(iface); 272 273 sc->sc_iface = iface; 274 275 ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1; 276 ucaa.ucaa_ibufsize = ucaa.ucaa_obufsize = 0; 277 for (i = 0; i < id->bNumEndpoints; i++) { 278 int addr, dir, attr; 279 ed = usbd_interface2endpoint_descriptor(iface, i); 280 if (ed == NULL) { 281 aprint_error_dev(self, 282 "could not read endpoint descriptor\n"); 283 goto bad; 284 } 285 286 addr = ed->bEndpointAddress; 287 dir = UE_GET_DIR(ed->bEndpointAddress); 288 attr = ed->bmAttributes & UE_XFERTYPE; 289 if (dir == UE_DIR_IN && attr == UE_BULK) { 290 ucaa.ucaa_bulkin = addr; 291 ucaa.ucaa_ibufsize = UGETW(ed->wMaxPacketSize); 292 if (ucaa.ucaa_ibufsize >= UFTDI_MAX_IBUFSIZE) 293 ucaa.ucaa_ibufsize = UFTDI_MAX_IBUFSIZE; 294 } else if (dir == UE_DIR_OUT && attr == UE_BULK) { 295 ucaa.ucaa_bulkout = addr; 296 ucaa.ucaa_obufsize = UGETW(ed->wMaxPacketSize) 297 - sc->sc_hdrlen; 298 if (ucaa.ucaa_obufsize >= UFTDI_MAX_OBUFSIZE) 299 ucaa.ucaa_obufsize = UFTDI_MAX_OBUFSIZE; 300 /* Limit length if we have a 6-bit header. */ 301 if ((sc->sc_hdrlen > 0) && 302 (ucaa.ucaa_obufsize > UFTDIOBUFSIZE)) 303 ucaa.ucaa_obufsize = UFTDIOBUFSIZE; 304 } else { 305 aprint_error_dev(self, "unexpected endpoint\n"); 306 goto bad; 307 } 308 } 309 if (ucaa.ucaa_bulkin == -1) { 310 aprint_error_dev(self, "Could not find data bulk in\n"); 311 goto bad; 312 } 313 if (ucaa.ucaa_bulkout == -1) { 314 aprint_error_dev(self, "Could not find data bulk out\n"); 315 goto bad; 316 } 317 318 /* ucaa_bulkin, ucaa_bulkout set above */ 319 if (ucaa.ucaa_ibufsize == 0) 320 ucaa.ucaa_ibufsize = UFTDIIBUFSIZE; 321 ucaa.ucaa_ibufsizepad = ucaa.ucaa_ibufsize; 322 if (ucaa.ucaa_obufsize == 0) 323 ucaa.ucaa_obufsize = UFTDIOBUFSIZE - sc->sc_hdrlen; 324 ucaa.ucaa_opkthdrlen = sc->sc_hdrlen; 325 ucaa.ucaa_device = dev; 326 ucaa.ucaa_iface = iface; 327 ucaa.ucaa_methods = &uftdi_methods; 328 ucaa.ucaa_arg = sc; 329 ucaa.ucaa_info = NULL; 330 331 DPRINTF(("uftdi: in=%#x out=%#x isize=%#x osize=%#x\n", 332 ucaa.ucaa_bulkin, ucaa.ucaa_bulkout, 333 ucaa.ucaa_ibufsize, ucaa.ucaa_obufsize)); 334 sc->sc_subdev = config_found(self, &ucaa, ucomprint, 335 CFARG_SUBMATCH, ucomsubmatch, 336 CFARG_EOL); 337 338 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev); 339 340 if (!pmf_device_register(self, NULL, NULL)) 341 aprint_error_dev(self, "couldn't establish power handler\n"); 342 343 return; 344 345 bad: 346 DPRINTF(("uftdi_attach: ATTACH ERROR\n")); 347 sc->sc_dying = true; 348 return; 349 } 350 351 static void 352 uftdi_childdet(device_t self, device_t child) 353 { 354 struct uftdi_softc *sc = device_private(self); 355 356 KASSERT(child == sc->sc_subdev); 357 sc->sc_subdev = NULL; 358 } 359 360 static int 361 uftdi_detach(device_t self, int flags) 362 { 363 struct uftdi_softc *sc = device_private(self); 364 int rv = 0; 365 366 DPRINTF(("uftdi_detach: sc=%p flags=%d\n", sc, flags)); 367 368 sc->sc_dying = true; 369 370 if (sc->sc_subdev != NULL) { 371 rv = config_detach(sc->sc_subdev, flags); 372 sc->sc_subdev = NULL; 373 } 374 375 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev); 376 377 return rv; 378 } 379 380 static int 381 uftdi_open(void *vsc, int portno) 382 { 383 struct uftdi_softc *sc = vsc; 384 usb_device_request_t req; 385 usbd_status err; 386 struct termios t; 387 388 DPRINTF(("uftdi_open: sc=%p\n", sc)); 389 390 if (sc->sc_dying) 391 return EIO; 392 393 /* Perform a full reset on the device */ 394 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 395 req.bRequest = FTDI_SIO_RESET; 396 USETW(req.wValue, FTDI_SIO_RESET_SIO); 397 USETW(req.wIndex, portno); 398 USETW(req.wLength, 0); 399 err = usbd_do_request(sc->sc_udev, &req, NULL); 400 if (err) 401 return EIO; 402 403 /* Set 9600 baud, 2 stop bits, no parity, 8 bits */ 404 t.c_ospeed = 9600; 405 t.c_cflag = CSTOPB | CS8; 406 (void)uftdi_param(sc, portno, &t); 407 408 /* Turn on RTS/CTS flow control */ 409 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 410 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 411 USETW(req.wValue, 0); 412 USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, portno); 413 USETW(req.wLength, 0); 414 err = usbd_do_request(sc->sc_udev, &req, NULL); 415 if (err) 416 return EIO; 417 418 return 0; 419 } 420 421 static void 422 uftdi_read(void *vsc, int portno, u_char **ptr, uint32_t *count) 423 { 424 struct uftdi_softc *sc = vsc; 425 u_char msr, lsr; 426 427 DPRINTFN(15,("uftdi_read: sc=%p, port=%d count=%d\n", sc, portno, 428 *count)); 429 430 msr = FTDI_GET_MSR(*ptr); 431 lsr = FTDI_GET_LSR(*ptr); 432 433 #ifdef UFTDI_DEBUG 434 if (*count != 2) 435 DPRINTFN(10,("uftdi_read: sc=%p, port=%d count=%d data[0]=" 436 "0x%02x\n", sc, portno, *count, (*ptr)[2])); 437 #endif 438 439 if (sc->sc_msr != msr || 440 (sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK)) { 441 DPRINTF(("uftdi_read: status change msr=0x%02x(0x%02x) " 442 "lsr=0x%02x(0x%02x)\n", msr, sc->sc_msr, 443 lsr, sc->sc_lsr)); 444 sc->sc_msr = msr; 445 sc->sc_lsr = lsr; 446 ucom_status_change(device_private(sc->sc_subdev)); 447 } 448 449 /* Adjust buffer pointer to skip status prefix */ 450 *ptr += 2; 451 } 452 453 static void 454 uftdi_write(void *vsc, int portno, u_char *to, u_char *from, uint32_t *count) 455 { 456 struct uftdi_softc *sc = vsc; 457 458 DPRINTFN(10,("uftdi_write: sc=%p, port=%d count=%u data[0]=0x%02x\n", 459 vsc, portno, *count, from[0])); 460 461 /* Make length tag and copy data */ 462 if (sc->sc_hdrlen > 0) 463 *to = FTDI_OUT_TAG(*count, portno); 464 465 memcpy(to + sc->sc_hdrlen, from, *count); 466 *count += sc->sc_hdrlen; 467 } 468 469 static void 470 uftdi_set(void *vsc, int portno, int reg, int onoff) 471 { 472 struct uftdi_softc *sc = vsc; 473 usb_device_request_t req; 474 int ctl; 475 476 DPRINTF(("uftdi_set: sc=%p, port=%d reg=%d onoff=%d\n", vsc, portno, 477 reg, onoff)); 478 479 if (sc->sc_dying) 480 return; 481 482 switch (reg) { 483 case UCOM_SET_DTR: 484 ctl = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW; 485 break; 486 case UCOM_SET_RTS: 487 ctl = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW; 488 break; 489 case UCOM_SET_BREAK: 490 uftdi_break(sc, portno, onoff); 491 return; 492 default: 493 return; 494 } 495 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 496 req.bRequest = FTDI_SIO_MODEM_CTRL; 497 USETW(req.wValue, ctl); 498 USETW(req.wIndex, portno); 499 USETW(req.wLength, 0); 500 DPRINTFN(2,("uftdi_set: reqtype=0x%02x req=0x%02x value=0x%04x " 501 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 502 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 503 (void)usbd_do_request(sc->sc_udev, &req, NULL); 504 } 505 506 /* 507 * Return true if the given speed is within operational tolerance of the target 508 * speed. FTDI recommends that the hardware speed be within 3% of nominal. 509 */ 510 static inline bool 511 uftdi_baud_within_tolerance(uint64_t speed, uint64_t target) 512 { 513 return ((speed >= (target * 100) / 103) && 514 (speed <= (target * 100) / 97)); 515 } 516 517 static int 518 uftdi_encode_baudrate(struct uftdi_softc *sc, int speed, int *rate, int *ratehi) 519 { 520 static const uint8_t encoded_fraction[8] = { 521 0, 3, 2, 4, 1, 5, 6, 7 522 }; 523 static const uint8_t roundoff_232a[16] = { 524 0, 1, 0, 1, 0, -1, 2, 1, 525 0, -1, -2, -3, 4, 3, 2, 1, 526 }; 527 uint32_t clk, divisor, fastclk_flag, frac, hwspeed; 528 529 /* 530 * If this chip has the fast clock capability and the speed is within 531 * range, use the 12MHz clock, otherwise the standard clock is 3MHz. 532 */ 533 if ((sc->sc_flags & FLAGS_BAUDCLK_12M) && speed >= 1200) { 534 clk = 12000000; 535 fastclk_flag = (1 << 17); 536 } else { 537 clk = 3000000; 538 fastclk_flag = 0; 539 } 540 541 /* 542 * Make sure the requested speed is reachable with the available clock 543 * and a 14-bit divisor. 544 */ 545 if (speed < (clk >> 14) || speed > clk) 546 return -1; 547 548 /* 549 * Calculate the divisor, initially yielding a fixed point number with a 550 * 4-bit (1/16ths) fraction, then round it to the nearest fraction the 551 * hardware can handle. When the integral part of the divisor is 552 * greater than one, the fractional part is in 1/8ths of the base clock. 553 * The FT8U232AM chips can handle only 0.125, 0.250, and 0.5 fractions. 554 * Later chips can handle all 1/8th fractions. 555 * 556 * If the integral part of the divisor is 1, a special rule applies: the 557 * fractional part can only be .0 or .5 (this is a limitation of the 558 * hardware). We handle this by truncating the fraction rather than 559 * rounding, because this only applies to the two fastest speeds the 560 * chip can achieve and rounding doesn't matter, either you've asked for 561 * that exact speed or you've asked for something the chip can't do. 562 * 563 * For the FT8U232AM chips, use a roundoff table to adjust the result 564 * to the nearest 1/8th fraction that is supported by the hardware, 565 * leaving a fixed-point number with a 3-bit fraction which exactly 566 * represents the math the hardware divider will do. For later-series 567 * chips that support all 8 fractional divisors, just round 16ths to 568 * 8ths by adding 1 and dividing by 2. 569 */ 570 divisor = (clk << 4) / speed; 571 if ((divisor & 0xf) == 1) 572 divisor &= 0xfffffff8; 573 else if (sc->sc_flags & FLAGS_ROUNDOFF_232A) 574 divisor += roundoff_232a[divisor & 0x0f]; 575 else 576 divisor += 1; /* Rounds odd 16ths up to next 8th. */ 577 divisor >>= 1; 578 579 /* 580 * Ensure the resulting hardware speed will be within operational 581 * tolerance (within 3% of nominal). 582 */ 583 hwspeed = (clk << 3) / divisor; 584 if (!uftdi_baud_within_tolerance(hwspeed, speed)) 585 return -1; 586 587 /* 588 * Re-pack the divisor into hardware format. The lower 14-bits hold the 589 * integral part, while the upper bits specify the fraction by indexing 590 * a table of fractions within the hardware which is laid out as: 591 * {0.0, 0.5, 0.25, 0.125, 0.325, 0.625, 0.725, 0.875} 592 * The A-series chips only have the first four table entries; the 593 * roundoff table logic above ensures that the fractional part for those 594 * chips will be one of the first four values. 595 * 596 * When the divisor is 1 a special encoding applies: 1.0 is encoded as 597 * 0.0, and 1.5 is encoded as 1.0. The rounding logic above has already 598 * ensured that the fraction is either .0 or .5 if the integral is 1. 599 */ 600 frac = divisor & 0x07; 601 divisor >>= 3; 602 if (divisor == 1) { 603 if (frac == 0) 604 divisor = 0; /* 1.0 becomes 0.0 */ 605 else 606 frac = 0; /* 1.5 becomes 1.0 */ 607 } 608 divisor |= (encoded_fraction[frac] << 14) | fastclk_flag; 609 610 *rate = (uint16_t)divisor; 611 *ratehi = (uint16_t)(divisor >> 16); 612 613 /* 614 * If this chip requires the baud bits to be in the high byte of the 615 * index word, move the bits up to that location. 616 */ 617 if (sc->sc_flags & FLAGS_BAUDBITS_HINDEX) 618 *ratehi <<= 8; 619 620 return 0; 621 } 622 623 static int 624 uftdi_param(void *vsc, int portno, struct termios *t) 625 { 626 struct uftdi_softc *sc = vsc; 627 usb_device_request_t req; 628 usbd_status err; 629 int rate, ratehi, rerr, data, flow; 630 631 DPRINTF(("uftdi_param: sc=%p\n", sc)); 632 633 if (sc->sc_dying) 634 return EIO; 635 636 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 637 req.bRequest = FTDI_SIO_SET_BITMODE; 638 USETW(req.wValue, FTDI_BITMODE_RESET << 8 | 0x00); 639 USETW(req.wIndex, portno); 640 USETW(req.wLength, 0); 641 err = usbd_do_request(sc->sc_udev, &req, NULL); 642 if (err) 643 return EIO; 644 645 switch (sc->sc_type) { 646 case UFTDI_TYPE_SIO: 647 switch (t->c_ospeed) { 648 case 300: rate = ftdi_sio_b300; break; 649 case 600: rate = ftdi_sio_b600; break; 650 case 1200: rate = ftdi_sio_b1200; break; 651 case 2400: rate = ftdi_sio_b2400; break; 652 case 4800: rate = ftdi_sio_b4800; break; 653 case 9600: rate = ftdi_sio_b9600; break; 654 case 19200: rate = ftdi_sio_b19200; break; 655 case 38400: rate = ftdi_sio_b38400; break; 656 case 57600: rate = ftdi_sio_b57600; break; 657 case 115200: rate = ftdi_sio_b115200; break; 658 default: 659 return EINVAL; 660 } 661 ratehi = 0; 662 break; 663 case UFTDI_TYPE_8U232AM: 664 rerr = uftdi_encode_baudrate(sc, t->c_ospeed, &rate, &ratehi); 665 if (rerr != 0) 666 return EINVAL; 667 break; 668 default: 669 return EINVAL; 670 } 671 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 672 req.bRequest = FTDI_SIO_SET_BAUD_RATE; 673 USETW(req.wValue, rate); 674 USETW(req.wIndex, portno | ratehi); 675 USETW(req.wLength, 0); 676 DPRINTFN(2,("uftdi_param: reqtype=0x%02x req=0x%02x value=0x%04x " 677 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 678 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 679 err = usbd_do_request(sc->sc_udev, &req, NULL); 680 if (err) 681 return EIO; 682 683 if (ISSET(t->c_cflag, CSTOPB)) 684 data = FTDI_SIO_SET_DATA_STOP_BITS_2; 685 else 686 data = FTDI_SIO_SET_DATA_STOP_BITS_1; 687 if (ISSET(t->c_cflag, PARENB)) { 688 if (ISSET(t->c_cflag, PARODD)) 689 data |= FTDI_SIO_SET_DATA_PARITY_ODD; 690 else 691 data |= FTDI_SIO_SET_DATA_PARITY_EVEN; 692 } else 693 data |= FTDI_SIO_SET_DATA_PARITY_NONE; 694 switch (ISSET(t->c_cflag, CSIZE)) { 695 case CS5: 696 data |= FTDI_SIO_SET_DATA_BITS(5); 697 break; 698 case CS6: 699 data |= FTDI_SIO_SET_DATA_BITS(6); 700 break; 701 case CS7: 702 data |= FTDI_SIO_SET_DATA_BITS(7); 703 break; 704 case CS8: 705 data |= FTDI_SIO_SET_DATA_BITS(8); 706 break; 707 } 708 sc->last_lcr = data; 709 710 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 711 req.bRequest = FTDI_SIO_SET_DATA; 712 USETW(req.wValue, data); 713 USETW(req.wIndex, portno); 714 USETW(req.wLength, 0); 715 DPRINTFN(2,("uftdi_param: reqtype=0x%02x req=0x%02x value=0x%04x " 716 "index=0x%04x len=%d\n", req.bmRequestType, req.bRequest, 717 UGETW(req.wValue), UGETW(req.wIndex), UGETW(req.wLength))); 718 err = usbd_do_request(sc->sc_udev, &req, NULL); 719 if (err) 720 return EIO; 721 722 if (ISSET(t->c_cflag, CRTSCTS)) { 723 flow = FTDI_SIO_RTS_CTS_HS; 724 USETW(req.wValue, 0); 725 } else if (ISSET(t->c_iflag, IXON) && ISSET(t->c_iflag, IXOFF)) { 726 flow = FTDI_SIO_XON_XOFF_HS; 727 USETW2(req.wValue, t->c_cc[VSTOP], t->c_cc[VSTART]); 728 } else { 729 flow = FTDI_SIO_DISABLE_FLOW_CTRL; 730 USETW(req.wValue, 0); 731 } 732 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 733 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 734 USETW2(req.wIndex, flow, portno); 735 USETW(req.wLength, 0); 736 err = usbd_do_request(sc->sc_udev, &req, NULL); 737 if (err) 738 return EIO; 739 740 return 0; 741 } 742 743 static void 744 uftdi_get_status(void *vsc, int portno, u_char *lsr, u_char *msr) 745 { 746 struct uftdi_softc *sc = vsc; 747 748 DPRINTF(("uftdi_status: msr=0x%02x lsr=0x%02x\n", 749 sc->sc_msr, sc->sc_lsr)); 750 751 if (sc->sc_dying) 752 return; 753 754 *msr = sc->sc_msr; 755 *lsr = sc->sc_lsr; 756 } 757 758 static void 759 uftdi_break(void *vsc, int portno, int onoff) 760 { 761 struct uftdi_softc *sc = vsc; 762 usb_device_request_t req; 763 int data; 764 765 DPRINTF(("uftdi_break: sc=%p, port=%d onoff=%d\n", vsc, portno, 766 onoff)); 767 768 if (onoff) { 769 data = sc->last_lcr | FTDI_SIO_SET_BREAK; 770 } else { 771 data = sc->last_lcr; 772 } 773 774 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 775 req.bRequest = FTDI_SIO_SET_DATA; 776 USETW(req.wValue, data); 777 USETW(req.wIndex, portno); 778 USETW(req.wLength, 0); 779 (void)usbd_do_request(sc->sc_udev, &req, NULL); 780 } 781