1 /* $NetBSD: uftdi.c,v 1.13 2002/09/23 05:51:23 simonb 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 #include <sys/cdefs.h> 40 __FBSDID("$FreeBSD$"); 41 42 /* 43 * NOTE: all function names beginning like "uftdi_cfg_" can only 44 * be called from within the config thread function ! 45 */ 46 47 /* 48 * FTDI FT8U100AX serial adapter driver 49 */ 50 51 #include <sys/stdint.h> 52 #include <sys/stddef.h> 53 #include <sys/param.h> 54 #include <sys/queue.h> 55 #include <sys/types.h> 56 #include <sys/systm.h> 57 #include <sys/kernel.h> 58 #include <sys/bus.h> 59 #include <sys/linker_set.h> 60 #include <sys/module.h> 61 #include <sys/lock.h> 62 #include <sys/mutex.h> 63 #include <sys/condvar.h> 64 #include <sys/sysctl.h> 65 #include <sys/sx.h> 66 #include <sys/unistd.h> 67 #include <sys/callout.h> 68 #include <sys/malloc.h> 69 #include <sys/priv.h> 70 71 #include <dev/usb/usb.h> 72 #include <dev/usb/usbdi.h> 73 #include <dev/usb/usbdi_util.h> 74 #include "usbdevs.h" 75 76 #define USB_DEBUG_VAR uftdi_debug 77 #include <dev/usb/usb_debug.h> 78 #include <dev/usb/usb_process.h> 79 80 #include <dev/usb/serial/usb_serial.h> 81 #include <dev/usb/serial/uftdi_reg.h> 82 83 #if USB_DEBUG 84 static int uftdi_debug = 0; 85 86 SYSCTL_NODE(_hw_usb, OID_AUTO, uftdi, CTLFLAG_RW, 0, "USB uftdi"); 87 SYSCTL_INT(_hw_usb_uftdi, OID_AUTO, debug, CTLFLAG_RW, 88 &uftdi_debug, 0, "Debug level"); 89 #endif 90 91 #define UFTDI_CONFIG_INDEX 0 92 #define UFTDI_IFACE_INDEX 0 93 94 #define UFTDI_IBUFSIZE 64 /* bytes, maximum number of bytes per 95 * frame */ 96 #define UFTDI_OBUFSIZE 64 /* bytes, cannot be increased due to 97 * do size encoding */ 98 99 enum { 100 UFTDI_BULK_DT_WR, 101 UFTDI_BULK_DT_RD, 102 UFTDI_N_TRANSFER, 103 }; 104 105 struct uftdi_softc { 106 struct ucom_super_softc sc_super_ucom; 107 struct ucom_softc sc_ucom; 108 109 struct usb_device *sc_udev; 110 struct usb_xfer *sc_xfer[UFTDI_N_TRANSFER]; 111 device_t sc_dev; 112 struct mtx sc_mtx; 113 114 uint32_t sc_unit; 115 enum uftdi_type sc_type; 116 117 uint16_t sc_last_lcr; 118 119 uint8_t sc_iface_index; 120 uint8_t sc_hdrlen; 121 uint8_t sc_msr; 122 uint8_t sc_lsr; 123 124 uint8_t sc_name[16]; 125 }; 126 127 struct uftdi_param_config { 128 uint16_t rate; 129 uint16_t lcr; 130 uint8_t v_start; 131 uint8_t v_stop; 132 uint8_t v_flow; 133 }; 134 135 /* prototypes */ 136 137 static device_probe_t uftdi_probe; 138 static device_attach_t uftdi_attach; 139 static device_detach_t uftdi_detach; 140 141 static usb_callback_t uftdi_write_callback; 142 static usb_callback_t uftdi_read_callback; 143 144 static void uftdi_cfg_open(struct ucom_softc *); 145 static void uftdi_cfg_set_dtr(struct ucom_softc *, uint8_t); 146 static void uftdi_cfg_set_rts(struct ucom_softc *, uint8_t); 147 static void uftdi_cfg_set_break(struct ucom_softc *, uint8_t); 148 static int uftdi_set_parm_soft(struct termios *, 149 struct uftdi_param_config *, uint8_t); 150 static int uftdi_pre_param(struct ucom_softc *, struct termios *); 151 static void uftdi_cfg_param(struct ucom_softc *, struct termios *); 152 static void uftdi_cfg_get_status(struct ucom_softc *, uint8_t *, 153 uint8_t *); 154 static void uftdi_start_read(struct ucom_softc *); 155 static void uftdi_stop_read(struct ucom_softc *); 156 static void uftdi_start_write(struct ucom_softc *); 157 static void uftdi_stop_write(struct ucom_softc *); 158 static uint8_t uftdi_8u232am_getrate(uint32_t, uint16_t *); 159 static void uftdi_poll(struct ucom_softc *ucom); 160 161 static const struct usb_config uftdi_config[UFTDI_N_TRANSFER] = { 162 163 [UFTDI_BULK_DT_WR] = { 164 .type = UE_BULK, 165 .endpoint = UE_ADDR_ANY, 166 .direction = UE_DIR_OUT, 167 .bufsize = UFTDI_OBUFSIZE, 168 .flags = {.pipe_bof = 1,}, 169 .callback = &uftdi_write_callback, 170 }, 171 172 [UFTDI_BULK_DT_RD] = { 173 .type = UE_BULK, 174 .endpoint = UE_ADDR_ANY, 175 .direction = UE_DIR_IN, 176 .bufsize = UFTDI_IBUFSIZE, 177 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 178 .callback = &uftdi_read_callback, 179 }, 180 }; 181 182 static const struct ucom_callback uftdi_callback = { 183 .ucom_cfg_get_status = &uftdi_cfg_get_status, 184 .ucom_cfg_set_dtr = &uftdi_cfg_set_dtr, 185 .ucom_cfg_set_rts = &uftdi_cfg_set_rts, 186 .ucom_cfg_set_break = &uftdi_cfg_set_break, 187 .ucom_cfg_param = &uftdi_cfg_param, 188 .ucom_cfg_open = &uftdi_cfg_open, 189 .ucom_pre_param = &uftdi_pre_param, 190 .ucom_start_read = &uftdi_start_read, 191 .ucom_stop_read = &uftdi_stop_read, 192 .ucom_start_write = &uftdi_start_write, 193 .ucom_stop_write = &uftdi_stop_write, 194 .ucom_poll = &uftdi_poll, 195 }; 196 197 static device_method_t uftdi_methods[] = { 198 /* Device interface */ 199 DEVMETHOD(device_probe, uftdi_probe), 200 DEVMETHOD(device_attach, uftdi_attach), 201 DEVMETHOD(device_detach, uftdi_detach), 202 203 {0, 0} 204 }; 205 206 static devclass_t uftdi_devclass; 207 208 static driver_t uftdi_driver = { 209 .name = "uftdi", 210 .methods = uftdi_methods, 211 .size = sizeof(struct uftdi_softc), 212 }; 213 214 DRIVER_MODULE(uftdi, uhub, uftdi_driver, uftdi_devclass, NULL, 0); 215 MODULE_DEPEND(uftdi, ucom, 1, 1, 1); 216 MODULE_DEPEND(uftdi, usb, 1, 1, 1); 217 218 static struct usb_device_id uftdi_devs[] = { 219 {USB_VPI(USB_VENDOR_ATMEL, USB_PRODUCT_ATMEL_STK541, UFTDI_TYPE_8U232AM)}, 220 {USB_VPI(USB_VENDOR_DRESDENELEKTRONIK, USB_PRODUCT_DRESDENELEKTRONIK_SENSORTERMINALBOARD, UFTDI_TYPE_8U232AM)}, 221 {USB_VPI(USB_VENDOR_DRESDENELEKTRONIK, USB_PRODUCT_DRESDENELEKTRONIK_WIRELESSHANDHELDTERMINAL, UFTDI_TYPE_8U232AM)}, 222 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U100AX, UFTDI_TYPE_SIO)}, 223 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_2232C, UFTDI_TYPE_8U232AM)}, 224 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_2232D, UFTDI_TYPE_8U232AM)}, 225 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U232AM, UFTDI_TYPE_8U232AM)}, 226 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SERIAL_8U232AM4, UFTDI_TYPE_8U232AM)}, 227 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_SEMC_DSS20, UFTDI_TYPE_8U232AM)}, 228 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_631, UFTDI_TYPE_8U232AM)}, 229 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_632, UFTDI_TYPE_8U232AM)}, 230 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_633, UFTDI_TYPE_8U232AM)}, 231 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_634, UFTDI_TYPE_8U232AM)}, 232 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CFA_635, UFTDI_TYPE_8U232AM)}, 233 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_USBSERIAL, UFTDI_TYPE_8U232AM)}, 234 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MX2_3, UFTDI_TYPE_8U232AM)}, 235 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MX4_5, UFTDI_TYPE_8U232AM)}, 236 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LK202, UFTDI_TYPE_8U232AM)}, 237 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_LK204, UFTDI_TYPE_8U232AM)}, 238 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_TACTRIX_OPENPORT_13M, UFTDI_TYPE_8U232AM)}, 239 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_TACTRIX_OPENPORT_13S, UFTDI_TYPE_8U232AM)}, 240 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_TACTRIX_OPENPORT_13U, UFTDI_TYPE_8U232AM)}, 241 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_EISCOU, UFTDI_TYPE_8U232AM)}, 242 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_UOPTBR, UFTDI_TYPE_8U232AM)}, 243 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_EMCU2D, UFTDI_TYPE_8U232AM)}, 244 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_PCMSFU, UFTDI_TYPE_8U232AM)}, 245 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_EMCU2H, UFTDI_TYPE_8U232AM)}, 246 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_MAXSTREAM, UFTDI_TYPE_8U232AM)}, 247 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CTI_USB_NANO_485, UFTDI_TYPE_8U232AM)}, 248 {USB_VPI(USB_VENDOR_FTDI, USB_PRODUCT_FTDI_CTI_USB_MINI_485, UFTDI_TYPE_8U232AM)}, 249 {USB_VPI(USB_VENDOR_SIIG2, USB_PRODUCT_SIIG2_US2308, UFTDI_TYPE_8U232AM)}, 250 {USB_VPI(USB_VENDOR_INTREPIDCS, USB_PRODUCT_INTREPIDCS_VALUECAN, UFTDI_TYPE_8U232AM)}, 251 {USB_VPI(USB_VENDOR_INTREPIDCS, USB_PRODUCT_INTREPIDCS_NEOVI, UFTDI_TYPE_8U232AM)}, 252 {USB_VPI(USB_VENDOR_BBELECTRONICS, USB_PRODUCT_BBELECTRONICS_USOTL4, UFTDI_TYPE_8U232AM)}, 253 {USB_VPI(USB_VENDOR_MARVELL, USB_PRODUCT_MARVELL_SHEEVAPLUG, UFTDI_TYPE_8U232AM)}, 254 {USB_VPI(USB_VENDOR_MELCO, USB_PRODUCT_MELCO_PCOPRS1, UFTDI_TYPE_8U232AM)}, 255 }; 256 257 static int 258 uftdi_probe(device_t dev) 259 { 260 struct usb_attach_arg *uaa = device_get_ivars(dev); 261 262 if (uaa->usb_mode != USB_MODE_HOST) { 263 return (ENXIO); 264 } 265 if (uaa->info.bConfigIndex != UFTDI_CONFIG_INDEX) { 266 return (ENXIO); 267 } 268 /* attach to all present interfaces */ 269 270 return (usbd_lookup_id_by_uaa(uftdi_devs, sizeof(uftdi_devs), uaa)); 271 } 272 273 static int 274 uftdi_attach(device_t dev) 275 { 276 struct usb_attach_arg *uaa = device_get_ivars(dev); 277 struct uftdi_softc *sc = device_get_softc(dev); 278 int error; 279 280 sc->sc_udev = uaa->device; 281 sc->sc_dev = dev; 282 sc->sc_unit = device_get_unit(dev); 283 284 device_set_usb_desc(dev); 285 mtx_init(&sc->sc_mtx, "uftdi", NULL, MTX_DEF); 286 287 snprintf(sc->sc_name, sizeof(sc->sc_name), 288 "%s", device_get_nameunit(dev)); 289 290 DPRINTF("\n"); 291 292 sc->sc_iface_index = uaa->info.bIfaceIndex; 293 sc->sc_type = USB_GET_DRIVER_INFO(uaa); 294 295 switch (sc->sc_type) { 296 case UFTDI_TYPE_SIO: 297 sc->sc_hdrlen = 1; 298 break; 299 case UFTDI_TYPE_8U232AM: 300 default: 301 sc->sc_hdrlen = 0; 302 break; 303 } 304 305 error = usbd_transfer_setup(uaa->device, 306 &sc->sc_iface_index, sc->sc_xfer, uftdi_config, 307 UFTDI_N_TRANSFER, sc, &sc->sc_mtx); 308 309 if (error) { 310 device_printf(dev, "allocating USB " 311 "transfers failed\n"); 312 goto detach; 313 } 314 sc->sc_ucom.sc_portno = FTDI_PIT_SIOA + uaa->info.bIfaceNum; 315 316 /* clear stall at first run */ 317 mtx_lock(&sc->sc_mtx); 318 usbd_xfer_set_stall(sc->sc_xfer[UFTDI_BULK_DT_WR]); 319 usbd_xfer_set_stall(sc->sc_xfer[UFTDI_BULK_DT_RD]); 320 mtx_unlock(&sc->sc_mtx); 321 322 /* set a valid "lcr" value */ 323 324 sc->sc_last_lcr = 325 (FTDI_SIO_SET_DATA_STOP_BITS_2 | 326 FTDI_SIO_SET_DATA_PARITY_NONE | 327 FTDI_SIO_SET_DATA_BITS(8)); 328 329 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 330 &uftdi_callback, &sc->sc_mtx); 331 if (error) { 332 goto detach; 333 } 334 return (0); /* success */ 335 336 detach: 337 uftdi_detach(dev); 338 return (ENXIO); 339 } 340 341 static int 342 uftdi_detach(device_t dev) 343 { 344 struct uftdi_softc *sc = device_get_softc(dev); 345 346 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1); 347 usbd_transfer_unsetup(sc->sc_xfer, UFTDI_N_TRANSFER); 348 mtx_destroy(&sc->sc_mtx); 349 350 return (0); 351 } 352 353 static void 354 uftdi_cfg_open(struct ucom_softc *ucom) 355 { 356 struct uftdi_softc *sc = ucom->sc_parent; 357 uint16_t wIndex = ucom->sc_portno; 358 struct usb_device_request req; 359 360 DPRINTF(""); 361 362 /* perform a full reset on the device */ 363 364 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 365 req.bRequest = FTDI_SIO_RESET; 366 USETW(req.wValue, FTDI_SIO_RESET_SIO); 367 USETW(req.wIndex, wIndex); 368 USETW(req.wLength, 0); 369 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 370 &req, NULL, 0, 1000); 371 372 /* turn on RTS/CTS flow control */ 373 374 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 375 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 376 USETW(req.wValue, 0); 377 USETW2(req.wIndex, FTDI_SIO_RTS_CTS_HS, wIndex); 378 USETW(req.wLength, 0); 379 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 380 &req, NULL, 0, 1000); 381 382 /* 383 * NOTE: with the new UCOM layer there will always be a 384 * "uftdi_cfg_param()" call after "open()", so there is no need for 385 * "open()" to configure anything 386 */ 387 } 388 389 static void 390 uftdi_write_callback(struct usb_xfer *xfer, usb_error_t error) 391 { 392 struct uftdi_softc *sc = usbd_xfer_softc(xfer); 393 struct usb_page_cache *pc; 394 uint32_t actlen; 395 uint8_t buf[1]; 396 397 switch (USB_GET_STATE(xfer)) { 398 case USB_ST_SETUP: 399 case USB_ST_TRANSFERRED: 400 tr_setup: 401 pc = usbd_xfer_get_frame(xfer, 0); 402 if (ucom_get_data(&sc->sc_ucom, pc, 403 sc->sc_hdrlen, UFTDI_OBUFSIZE - sc->sc_hdrlen, 404 &actlen)) { 405 406 if (sc->sc_hdrlen > 0) { 407 buf[0] = 408 FTDI_OUT_TAG(actlen, sc->sc_ucom.sc_portno); 409 usbd_copy_in(pc, 0, buf, 1); 410 } 411 usbd_xfer_set_frame_len(xfer, 0, actlen + sc->sc_hdrlen); 412 usbd_transfer_submit(xfer); 413 } 414 return; 415 416 default: /* Error */ 417 if (error != USB_ERR_CANCELLED) { 418 /* try to clear stall first */ 419 usbd_xfer_set_stall(xfer); 420 goto tr_setup; 421 } 422 return; 423 } 424 } 425 426 static void 427 uftdi_read_callback(struct usb_xfer *xfer, usb_error_t error) 428 { 429 struct uftdi_softc *sc = usbd_xfer_softc(xfer); 430 struct usb_page_cache *pc; 431 uint8_t buf[2]; 432 uint8_t ftdi_msr; 433 uint8_t msr; 434 uint8_t lsr; 435 int actlen; 436 437 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 438 439 switch (USB_GET_STATE(xfer)) { 440 case USB_ST_TRANSFERRED: 441 442 if (actlen < 2) { 443 goto tr_setup; 444 } 445 pc = usbd_xfer_get_frame(xfer, 0); 446 usbd_copy_out(pc, 0, buf, 2); 447 448 ftdi_msr = FTDI_GET_MSR(buf); 449 lsr = FTDI_GET_LSR(buf); 450 451 msr = 0; 452 if (ftdi_msr & FTDI_SIO_CTS_MASK) 453 msr |= SER_CTS; 454 if (ftdi_msr & FTDI_SIO_DSR_MASK) 455 msr |= SER_DSR; 456 if (ftdi_msr & FTDI_SIO_RI_MASK) 457 msr |= SER_RI; 458 if (ftdi_msr & FTDI_SIO_RLSD_MASK) 459 msr |= SER_DCD; 460 461 if ((sc->sc_msr != msr) || 462 ((sc->sc_lsr & FTDI_LSR_MASK) != (lsr & FTDI_LSR_MASK))) { 463 DPRINTF("status change msr=0x%02x (0x%02x) " 464 "lsr=0x%02x (0x%02x)\n", msr, sc->sc_msr, 465 lsr, sc->sc_lsr); 466 467 sc->sc_msr = msr; 468 sc->sc_lsr = lsr; 469 470 ucom_status_change(&sc->sc_ucom); 471 } 472 actlen -= 2; 473 474 if (actlen > 0) { 475 ucom_put_data(&sc->sc_ucom, pc, 2, actlen); 476 } 477 case USB_ST_SETUP: 478 tr_setup: 479 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 480 usbd_transfer_submit(xfer); 481 return; 482 483 default: /* Error */ 484 if (error != USB_ERR_CANCELLED) { 485 /* try to clear stall first */ 486 usbd_xfer_set_stall(xfer); 487 goto tr_setup; 488 } 489 return; 490 } 491 } 492 493 static void 494 uftdi_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 495 { 496 struct uftdi_softc *sc = ucom->sc_parent; 497 uint16_t wIndex = ucom->sc_portno; 498 uint16_t wValue; 499 struct usb_device_request req; 500 501 wValue = onoff ? FTDI_SIO_SET_DTR_HIGH : FTDI_SIO_SET_DTR_LOW; 502 503 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 504 req.bRequest = FTDI_SIO_MODEM_CTRL; 505 USETW(req.wValue, wValue); 506 USETW(req.wIndex, wIndex); 507 USETW(req.wLength, 0); 508 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 509 &req, NULL, 0, 1000); 510 } 511 512 static void 513 uftdi_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff) 514 { 515 struct uftdi_softc *sc = ucom->sc_parent; 516 uint16_t wIndex = ucom->sc_portno; 517 uint16_t wValue; 518 struct usb_device_request req; 519 520 wValue = onoff ? FTDI_SIO_SET_RTS_HIGH : FTDI_SIO_SET_RTS_LOW; 521 522 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 523 req.bRequest = FTDI_SIO_MODEM_CTRL; 524 USETW(req.wValue, wValue); 525 USETW(req.wIndex, wIndex); 526 USETW(req.wLength, 0); 527 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 528 &req, NULL, 0, 1000); 529 } 530 531 static void 532 uftdi_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff) 533 { 534 struct uftdi_softc *sc = ucom->sc_parent; 535 uint16_t wIndex = ucom->sc_portno; 536 uint16_t wValue; 537 struct usb_device_request req; 538 539 if (onoff) { 540 sc->sc_last_lcr |= FTDI_SIO_SET_BREAK; 541 } else { 542 sc->sc_last_lcr &= ~FTDI_SIO_SET_BREAK; 543 } 544 545 wValue = sc->sc_last_lcr; 546 547 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 548 req.bRequest = FTDI_SIO_SET_DATA; 549 USETW(req.wValue, wValue); 550 USETW(req.wIndex, wIndex); 551 USETW(req.wLength, 0); 552 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 553 &req, NULL, 0, 1000); 554 } 555 556 static int 557 uftdi_set_parm_soft(struct termios *t, 558 struct uftdi_param_config *cfg, uint8_t type) 559 { 560 bzero(cfg, sizeof(*cfg)); 561 562 switch (type) { 563 case UFTDI_TYPE_SIO: 564 switch (t->c_ospeed) { 565 case 300: 566 cfg->rate = ftdi_sio_b300; 567 break; 568 case 600: 569 cfg->rate = ftdi_sio_b600; 570 break; 571 case 1200: 572 cfg->rate = ftdi_sio_b1200; 573 break; 574 case 2400: 575 cfg->rate = ftdi_sio_b2400; 576 break; 577 case 4800: 578 cfg->rate = ftdi_sio_b4800; 579 break; 580 case 9600: 581 cfg->rate = ftdi_sio_b9600; 582 break; 583 case 19200: 584 cfg->rate = ftdi_sio_b19200; 585 break; 586 case 38400: 587 cfg->rate = ftdi_sio_b38400; 588 break; 589 case 57600: 590 cfg->rate = ftdi_sio_b57600; 591 break; 592 case 115200: 593 cfg->rate = ftdi_sio_b115200; 594 break; 595 default: 596 return (EINVAL); 597 } 598 break; 599 600 case UFTDI_TYPE_8U232AM: 601 if (uftdi_8u232am_getrate(t->c_ospeed, &cfg->rate)) { 602 return (EINVAL); 603 } 604 break; 605 } 606 607 if (t->c_cflag & CSTOPB) 608 cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_2; 609 else 610 cfg->lcr = FTDI_SIO_SET_DATA_STOP_BITS_1; 611 612 if (t->c_cflag & PARENB) { 613 if (t->c_cflag & PARODD) { 614 cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_ODD; 615 } else { 616 cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_EVEN; 617 } 618 } else { 619 cfg->lcr |= FTDI_SIO_SET_DATA_PARITY_NONE; 620 } 621 622 switch (t->c_cflag & CSIZE) { 623 case CS5: 624 cfg->lcr |= FTDI_SIO_SET_DATA_BITS(5); 625 break; 626 627 case CS6: 628 cfg->lcr |= FTDI_SIO_SET_DATA_BITS(6); 629 break; 630 631 case CS7: 632 cfg->lcr |= FTDI_SIO_SET_DATA_BITS(7); 633 break; 634 635 case CS8: 636 cfg->lcr |= FTDI_SIO_SET_DATA_BITS(8); 637 break; 638 } 639 640 if (t->c_cflag & CRTSCTS) { 641 cfg->v_flow = FTDI_SIO_RTS_CTS_HS; 642 } else if (t->c_iflag & (IXON | IXOFF)) { 643 cfg->v_flow = FTDI_SIO_XON_XOFF_HS; 644 cfg->v_start = t->c_cc[VSTART]; 645 cfg->v_stop = t->c_cc[VSTOP]; 646 } else { 647 cfg->v_flow = FTDI_SIO_DISABLE_FLOW_CTRL; 648 } 649 650 return (0); 651 } 652 653 static int 654 uftdi_pre_param(struct ucom_softc *ucom, struct termios *t) 655 { 656 struct uftdi_softc *sc = ucom->sc_parent; 657 struct uftdi_param_config cfg; 658 659 DPRINTF("\n"); 660 661 return (uftdi_set_parm_soft(t, &cfg, sc->sc_type)); 662 } 663 664 static void 665 uftdi_cfg_param(struct ucom_softc *ucom, struct termios *t) 666 { 667 struct uftdi_softc *sc = ucom->sc_parent; 668 uint16_t wIndex = ucom->sc_portno; 669 struct uftdi_param_config cfg; 670 struct usb_device_request req; 671 672 if (uftdi_set_parm_soft(t, &cfg, sc->sc_type)) { 673 /* should not happen */ 674 return; 675 } 676 sc->sc_last_lcr = cfg.lcr; 677 678 DPRINTF("\n"); 679 680 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 681 req.bRequest = FTDI_SIO_SET_BAUD_RATE; 682 USETW(req.wValue, cfg.rate); 683 USETW(req.wIndex, wIndex); 684 USETW(req.wLength, 0); 685 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 686 &req, NULL, 0, 1000); 687 688 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 689 req.bRequest = FTDI_SIO_SET_DATA; 690 USETW(req.wValue, cfg.lcr); 691 USETW(req.wIndex, wIndex); 692 USETW(req.wLength, 0); 693 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 694 &req, NULL, 0, 1000); 695 696 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 697 req.bRequest = FTDI_SIO_SET_FLOW_CTRL; 698 USETW2(req.wValue, cfg.v_stop, cfg.v_start); 699 USETW2(req.wIndex, cfg.v_flow, wIndex); 700 USETW(req.wLength, 0); 701 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 702 &req, NULL, 0, 1000); 703 } 704 705 static void 706 uftdi_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 707 { 708 struct uftdi_softc *sc = ucom->sc_parent; 709 710 DPRINTF("msr=0x%02x lsr=0x%02x\n", 711 sc->sc_msr, sc->sc_lsr); 712 713 *msr = sc->sc_msr; 714 *lsr = sc->sc_lsr; 715 } 716 717 static void 718 uftdi_start_read(struct ucom_softc *ucom) 719 { 720 struct uftdi_softc *sc = ucom->sc_parent; 721 722 usbd_transfer_start(sc->sc_xfer[UFTDI_BULK_DT_RD]); 723 } 724 725 static void 726 uftdi_stop_read(struct ucom_softc *ucom) 727 { 728 struct uftdi_softc *sc = ucom->sc_parent; 729 730 usbd_transfer_stop(sc->sc_xfer[UFTDI_BULK_DT_RD]); 731 } 732 733 static void 734 uftdi_start_write(struct ucom_softc *ucom) 735 { 736 struct uftdi_softc *sc = ucom->sc_parent; 737 738 usbd_transfer_start(sc->sc_xfer[UFTDI_BULK_DT_WR]); 739 } 740 741 static void 742 uftdi_stop_write(struct ucom_softc *ucom) 743 { 744 struct uftdi_softc *sc = ucom->sc_parent; 745 746 usbd_transfer_stop(sc->sc_xfer[UFTDI_BULK_DT_WR]); 747 } 748 749 /*------------------------------------------------------------------------* 750 * uftdi_8u232am_getrate 751 * 752 * Return values: 753 * 0: Success 754 * Else: Failure 755 *------------------------------------------------------------------------*/ 756 static uint8_t 757 uftdi_8u232am_getrate(uint32_t speed, uint16_t *rate) 758 { 759 /* Table of the nearest even powers-of-2 for values 0..15. */ 760 static const uint8_t roundoff[16] = { 761 0, 2, 2, 4, 4, 4, 8, 8, 762 8, 8, 8, 8, 16, 16, 16, 16, 763 }; 764 uint32_t d; 765 uint32_t freq; 766 uint16_t result; 767 768 if ((speed < 178) || (speed > ((3000000 * 100) / 97))) 769 return (1); /* prevent numerical overflow */ 770 771 /* Special cases for 2M and 3M. */ 772 if ((speed >= ((3000000 * 100) / 103)) && 773 (speed <= ((3000000 * 100) / 97))) { 774 result = 0; 775 goto done; 776 } 777 if ((speed >= ((2000000 * 100) / 103)) && 778 (speed <= ((2000000 * 100) / 97))) { 779 result = 1; 780 goto done; 781 } 782 d = (FTDI_8U232AM_FREQ << 4) / speed; 783 d = (d & ~15) + roundoff[d & 15]; 784 785 if (d < FTDI_8U232AM_MIN_DIV) 786 d = FTDI_8U232AM_MIN_DIV; 787 else if (d > FTDI_8U232AM_MAX_DIV) 788 d = FTDI_8U232AM_MAX_DIV; 789 790 /* 791 * Calculate the frequency needed for "d" to exactly divide down to 792 * our target "speed", and check that the actual frequency is within 793 * 3% of this. 794 */ 795 freq = (speed * d); 796 if ((freq < ((FTDI_8U232AM_FREQ * 1600ULL) / 103)) || 797 (freq > ((FTDI_8U232AM_FREQ * 1600ULL) / 97))) 798 return (1); 799 800 /* 801 * Pack the divisor into the resultant value. The lower 14-bits 802 * hold the integral part, while the upper 2 bits encode the 803 * fractional component: either 0, 0.5, 0.25, or 0.125. 804 */ 805 result = (d >> 4); 806 if (d & 8) 807 result |= 0x4000; 808 else if (d & 4) 809 result |= 0x8000; 810 else if (d & 2) 811 result |= 0xc000; 812 813 done: 814 *rate = result; 815 return (0); 816 } 817 818 static void 819 uftdi_poll(struct ucom_softc *ucom) 820 { 821 struct uftdi_softc *sc = ucom->sc_parent; 822 usbd_transfer_poll(sc->sc_xfer, UFTDI_N_TRANSFER); 823 } 824