1 /* $OpenBSD: uslcom.c,v 1.17 2007/11/24 10:52:12 jsg Exp $ */ 2 3 #include <sys/cdefs.h> 4 __FBSDID("$FreeBSD$"); 5 6 /* 7 * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org> 8 * 9 * Permission to use, copy, modify, and distribute this software for any 10 * purpose with or without fee is hereby granted, provided that the above 11 * copyright notice and this permission notice appear in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 14 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 15 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 16 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 17 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 18 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 19 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 20 */ 21 22 /* 23 * Driver for Silicon Laboratories CP2101/CP2102/CP2103/CP2104/CP2105 24 * USB-Serial adapters. Based on datasheet AN571, publicly available from 25 * http://www.silabs.com/Support%20Documents/TechnicalDocs/AN571.pdf 26 */ 27 28 #include <sys/stdint.h> 29 #include <sys/stddef.h> 30 #include <sys/param.h> 31 #include <sys/queue.h> 32 #include <sys/types.h> 33 #include <sys/systm.h> 34 #include <sys/kernel.h> 35 #include <sys/bus.h> 36 #include <sys/module.h> 37 #include <sys/lock.h> 38 #include <sys/mutex.h> 39 #include <sys/condvar.h> 40 #include <sys/sysctl.h> 41 #include <sys/sx.h> 42 #include <sys/unistd.h> 43 #include <sys/callout.h> 44 #include <sys/malloc.h> 45 #include <sys/priv.h> 46 47 #include <dev/usb/usb.h> 48 #include <dev/usb/usbdi.h> 49 #include <dev/usb/usbdi_util.h> 50 #include <dev/usb/usb_ioctl.h> 51 #include "usbdevs.h" 52 53 #define USB_DEBUG_VAR uslcom_debug 54 #include <dev/usb/usb_debug.h> 55 #include <dev/usb/usb_process.h> 56 57 #include <dev/usb/serial/usb_serial.h> 58 59 #ifdef USB_DEBUG 60 static int uslcom_debug = 0; 61 62 static SYSCTL_NODE(_hw_usb, OID_AUTO, uslcom, CTLFLAG_RW, 0, "USB uslcom"); 63 SYSCTL_INT(_hw_usb_uslcom, OID_AUTO, debug, CTLFLAG_RWTUN, 64 &uslcom_debug, 0, "Debug level"); 65 #endif 66 67 #define USLCOM_BULK_BUF_SIZE 1024 68 #define USLCOM_CONFIG_INDEX 0 69 70 /* Request types */ 71 #define USLCOM_WRITE 0x41 72 #define USLCOM_READ 0xc1 73 74 /* Request codes */ 75 #define USLCOM_IFC_ENABLE 0x00 76 #define USLCOM_SET_BAUDDIV 0x01 77 #define USLCOM_SET_LINE_CTL 0x03 78 #define USLCOM_SET_BREAK 0x05 79 #define USLCOM_SET_MHS 0x07 80 #define USLCOM_GET_MDMSTS 0x08 81 #define USLCOM_SET_FLOW 0x13 82 #define USLCOM_SET_BAUDRATE 0x1e 83 #define USLCOM_VENDOR_SPECIFIC 0xff 84 85 /* USLCOM_IFC_ENABLE values */ 86 #define USLCOM_IFC_ENABLE_DIS 0x00 87 #define USLCOM_IFC_ENABLE_EN 0x01 88 89 /* USLCOM_SET_MHS/USLCOM_GET_MDMSTS values */ 90 #define USLCOM_MHS_DTR_ON 0x0001 91 #define USLCOM_MHS_DTR_SET 0x0100 92 #define USLCOM_MHS_RTS_ON 0x0002 93 #define USLCOM_MHS_RTS_SET 0x0200 94 #define USLCOM_MHS_CTS 0x0010 95 #define USLCOM_MHS_DSR 0x0020 96 #define USLCOM_MHS_RI 0x0040 97 #define USLCOM_MHS_DCD 0x0080 98 99 /* USLCOM_SET_BAUDDIV values */ 100 #define USLCOM_BAUDDIV_REF 3686400 /* 3.6864 MHz */ 101 102 /* USLCOM_SET_LINE_CTL values */ 103 #define USLCOM_STOP_BITS_1 0x00 104 #define USLCOM_STOP_BITS_2 0x02 105 #define USLCOM_PARITY_NONE 0x00 106 #define USLCOM_PARITY_ODD 0x10 107 #define USLCOM_PARITY_EVEN 0x20 108 #define USLCOM_SET_DATA_BITS(x) ((x) << 8) 109 110 /* USLCOM_SET_BREAK values */ 111 #define USLCOM_SET_BREAK_OFF 0x00 112 #define USLCOM_SET_BREAK_ON 0x01 113 114 /* USLCOM_SET_FLOW values - 1st word */ 115 #define USLCOM_FLOW_DTR_ON 0x00000001 /* DTR static active */ 116 #define USLCOM_FLOW_CTS_HS 0x00000008 /* CTS handshake */ 117 /* USLCOM_SET_FLOW values - 2nd word */ 118 #define USLCOM_FLOW_RTS_ON 0x00000040 /* RTS static active */ 119 #define USLCOM_FLOW_RTS_HS 0x00000080 /* RTS handshake */ 120 121 /* USLCOM_VENDOR_SPECIFIC values */ 122 #define USLCOM_GET_PARTNUM 0x370B 123 #define USLCOM_WRITE_LATCH 0x37E1 124 #define USLCOM_READ_LATCH 0x00C2 125 126 /* USLCOM_GET_PARTNUM values from hardware */ 127 #define USLCOM_PARTNUM_CP2101 1 128 #define USLCOM_PARTNUM_CP2102 2 129 #define USLCOM_PARTNUM_CP2103 3 130 #define USLCOM_PARTNUM_CP2104 4 131 #define USLCOM_PARTNUM_CP2105 5 132 133 enum { 134 USLCOM_BULK_DT_WR, 135 USLCOM_BULK_DT_RD, 136 USLCOM_CTRL_DT_RD, 137 USLCOM_N_TRANSFER, 138 }; 139 140 struct uslcom_softc { 141 struct ucom_super_softc sc_super_ucom; 142 struct ucom_softc sc_ucom; 143 struct usb_callout sc_watchdog; 144 145 struct usb_xfer *sc_xfer[USLCOM_N_TRANSFER]; 146 struct usb_device *sc_udev; 147 struct mtx sc_mtx; 148 149 uint8_t sc_msr; 150 uint8_t sc_lsr; 151 uint8_t sc_iface_no; 152 uint8_t sc_partnum; 153 }; 154 155 static device_probe_t uslcom_probe; 156 static device_attach_t uslcom_attach; 157 static device_detach_t uslcom_detach; 158 static void uslcom_free_softc(struct uslcom_softc *); 159 160 static usb_callback_t uslcom_write_callback; 161 static usb_callback_t uslcom_read_callback; 162 static usb_callback_t uslcom_control_callback; 163 164 static void uslcom_free(struct ucom_softc *); 165 static void uslcom_open(struct ucom_softc *); 166 static void uslcom_close(struct ucom_softc *); 167 static uint8_t uslcom_get_partnum(struct uslcom_softc *); 168 static void uslcom_set_dtr(struct ucom_softc *, uint8_t); 169 static void uslcom_set_rts(struct ucom_softc *, uint8_t); 170 static void uslcom_set_break(struct ucom_softc *, uint8_t); 171 static int uslcom_ioctl(struct ucom_softc *, uint32_t, caddr_t, int, 172 struct thread *); 173 static int uslcom_pre_param(struct ucom_softc *, struct termios *); 174 static void uslcom_param(struct ucom_softc *, struct termios *); 175 static void uslcom_get_status(struct ucom_softc *, uint8_t *, uint8_t *); 176 static void uslcom_start_read(struct ucom_softc *); 177 static void uslcom_stop_read(struct ucom_softc *); 178 static void uslcom_start_write(struct ucom_softc *); 179 static void uslcom_stop_write(struct ucom_softc *); 180 static void uslcom_poll(struct ucom_softc *ucom); 181 182 static const struct usb_config uslcom_config[USLCOM_N_TRANSFER] = { 183 184 [USLCOM_BULK_DT_WR] = { 185 .type = UE_BULK, 186 .endpoint = UE_ADDR_ANY, 187 .direction = UE_DIR_OUT, 188 .bufsize = USLCOM_BULK_BUF_SIZE, 189 .flags = {.pipe_bof = 1,}, 190 .callback = &uslcom_write_callback, 191 }, 192 193 [USLCOM_BULK_DT_RD] = { 194 .type = UE_BULK, 195 .endpoint = UE_ADDR_ANY, 196 .direction = UE_DIR_IN, 197 .bufsize = USLCOM_BULK_BUF_SIZE, 198 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 199 .callback = &uslcom_read_callback, 200 }, 201 [USLCOM_CTRL_DT_RD] = { 202 .type = UE_CONTROL, 203 .endpoint = 0x00, 204 .direction = UE_DIR_ANY, 205 .bufsize = sizeof(struct usb_device_request) + 8, 206 .flags = {.pipe_bof = 1,}, 207 .callback = &uslcom_control_callback, 208 .timeout = 1000, /* 1 second timeout */ 209 }, 210 }; 211 212 static struct ucom_callback uslcom_callback = { 213 .ucom_cfg_open = &uslcom_open, 214 .ucom_cfg_close = &uslcom_close, 215 .ucom_cfg_get_status = &uslcom_get_status, 216 .ucom_cfg_set_dtr = &uslcom_set_dtr, 217 .ucom_cfg_set_rts = &uslcom_set_rts, 218 .ucom_cfg_set_break = &uslcom_set_break, 219 .ucom_ioctl = &uslcom_ioctl, 220 .ucom_cfg_param = &uslcom_param, 221 .ucom_pre_param = &uslcom_pre_param, 222 .ucom_start_read = &uslcom_start_read, 223 .ucom_stop_read = &uslcom_stop_read, 224 .ucom_start_write = &uslcom_start_write, 225 .ucom_stop_write = &uslcom_stop_write, 226 .ucom_poll = &uslcom_poll, 227 .ucom_free = &uslcom_free, 228 }; 229 230 static const STRUCT_USB_HOST_ID uslcom_devs[] = { 231 #define USLCOM_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) } 232 USLCOM_DEV(BALTECH, CARDREADER), 233 USLCOM_DEV(CLIPSAL, 5000CT2), 234 USLCOM_DEV(CLIPSAL, 5500PACA), 235 USLCOM_DEV(CLIPSAL, 5500PCU), 236 USLCOM_DEV(CLIPSAL, 560884), 237 USLCOM_DEV(CLIPSAL, 5800PC), 238 USLCOM_DEV(CLIPSAL, C5000CT2), 239 USLCOM_DEV(CLIPSAL, L51xx), 240 USLCOM_DEV(DATAAPEX, MULTICOM), 241 USLCOM_DEV(DELL, DW700), 242 USLCOM_DEV(DIGIANSWER, ZIGBEE802154), 243 USLCOM_DEV(DYNASTREAM, ANTDEVBOARD), 244 USLCOM_DEV(DYNASTREAM, ANTDEVBOARD2), 245 USLCOM_DEV(DYNASTREAM, ANT2USB), 246 USLCOM_DEV(ELV, USBI2C), 247 USLCOM_DEV(FESTO, CMSP), 248 USLCOM_DEV(FESTO, CPX_USB), 249 USLCOM_DEV(FOXCONN, PIRELLI_DP_L10), 250 USLCOM_DEV(FOXCONN, TCOM_TC_300), 251 USLCOM_DEV(GEMALTO, PROXPU), 252 USLCOM_DEV(JABLOTRON, PC60B), 253 USLCOM_DEV(KAMSTRUP, OPTICALEYE), 254 USLCOM_DEV(KAMSTRUP, MBUS_250D), 255 USLCOM_DEV(LAKESHORE, 121), 256 USLCOM_DEV(LAKESHORE, 218A), 257 USLCOM_DEV(LAKESHORE, 219), 258 USLCOM_DEV(LAKESHORE, 233), 259 USLCOM_DEV(LAKESHORE, 235), 260 USLCOM_DEV(LAKESHORE, 335), 261 USLCOM_DEV(LAKESHORE, 336), 262 USLCOM_DEV(LAKESHORE, 350), 263 USLCOM_DEV(LAKESHORE, 371), 264 USLCOM_DEV(LAKESHORE, 411), 265 USLCOM_DEV(LAKESHORE, 425), 266 USLCOM_DEV(LAKESHORE, 455A), 267 USLCOM_DEV(LAKESHORE, 465), 268 USLCOM_DEV(LAKESHORE, 475A), 269 USLCOM_DEV(LAKESHORE, 625A), 270 USLCOM_DEV(LAKESHORE, 642A), 271 USLCOM_DEV(LAKESHORE, 648), 272 USLCOM_DEV(LAKESHORE, 737), 273 USLCOM_DEV(LAKESHORE, 776), 274 USLCOM_DEV(LINKINSTRUMENTS, MSO19), 275 USLCOM_DEV(LINKINSTRUMENTS, MSO28), 276 USLCOM_DEV(LINKINSTRUMENTS, MSO28_2), 277 USLCOM_DEV(MEI, CASHFLOW_SC), 278 USLCOM_DEV(MEI, S2000), 279 USLCOM_DEV(NETGEAR, M4100), 280 USLCOM_DEV(OWEN, AC4), 281 USLCOM_DEV(OWL, CM_160), 282 USLCOM_DEV(PHILIPS, ACE1001), 283 USLCOM_DEV(PLX, CA42), 284 USLCOM_DEV(RENESAS, RX610), 285 USLCOM_DEV(SEL, C662), 286 USLCOM_DEV(SILABS, AC_SERV_CAN), 287 USLCOM_DEV(SILABS, AC_SERV_CIS), 288 USLCOM_DEV(SILABS, AC_SERV_IBUS), 289 USLCOM_DEV(SILABS, AC_SERV_OBD), 290 USLCOM_DEV(SILABS, AEROCOMM), 291 USLCOM_DEV(SILABS, AMBER_AMB2560), 292 USLCOM_DEV(SILABS, ARGUSISP), 293 USLCOM_DEV(SILABS, ARKHAM_DS101_A), 294 USLCOM_DEV(SILABS, ARKHAM_DS101_M), 295 USLCOM_DEV(SILABS, ARYGON_MIFARE), 296 USLCOM_DEV(SILABS, AVIT_USB_TTL), 297 USLCOM_DEV(SILABS, B_G_H3000), 298 USLCOM_DEV(SILABS, BALLUFF_RFID), 299 USLCOM_DEV(SILABS, BEI_VCP), 300 USLCOM_DEV(SILABS, BSM7DUSB), 301 USLCOM_DEV(SILABS, BURNSIDE), 302 USLCOM_DEV(SILABS, C2_EDGE_MODEM), 303 USLCOM_DEV(SILABS, CP2102), 304 USLCOM_DEV(SILABS, CP210X_2), 305 USLCOM_DEV(SILABS, CP210X_3), 306 USLCOM_DEV(SILABS, CP210X_4), 307 USLCOM_DEV(SILABS, CRUMB128), 308 USLCOM_DEV(SILABS, CYGNAL), 309 USLCOM_DEV(SILABS, CYGNAL_DEBUG), 310 USLCOM_DEV(SILABS, CYGNAL_GPS), 311 USLCOM_DEV(SILABS, DEGREE), 312 USLCOM_DEV(SILABS, DEKTEK_DTAPLUS), 313 USLCOM_DEV(SILABS, EMS_C1007), 314 USLCOM_DEV(SILABS, HAMLINKUSB), 315 USLCOM_DEV(SILABS, HELICOM), 316 USLCOM_DEV(SILABS, IMS_USB_RS422), 317 USLCOM_DEV(SILABS, INFINITY_MIC), 318 USLCOM_DEV(SILABS, INGENI_ZIGBEE), 319 USLCOM_DEV(SILABS, INSYS_MODEM), 320 USLCOM_DEV(SILABS, IRZ_SG10), 321 USLCOM_DEV(SILABS, KYOCERA_GPS), 322 USLCOM_DEV(SILABS, LIPOWSKY_HARP), 323 USLCOM_DEV(SILABS, LIPOWSKY_JTAG), 324 USLCOM_DEV(SILABS, LIPOWSKY_LIN), 325 USLCOM_DEV(SILABS, MC35PU), 326 USLCOM_DEV(SILABS, MMB_ZIGBEE), 327 USLCOM_DEV(SILABS, MJS_TOSLINK), 328 USLCOM_DEV(SILABS, MSD_DASHHAWK), 329 USLCOM_DEV(SILABS, MULTIPLEX_RC), 330 USLCOM_DEV(SILABS, OPTRIS_MSPRO), 331 USLCOM_DEV(SILABS, POLOLU), 332 USLCOM_DEV(SILABS, PROCYON_AVS), 333 USLCOM_DEV(SILABS, SB_PARAMOUNT_ME), 334 USLCOM_DEV(SILABS, SUUNTO), 335 USLCOM_DEV(SILABS, TAMSMASTER), 336 USLCOM_DEV(SILABS, TELEGESIS_ETRX2), 337 USLCOM_DEV(SILABS, TRACIENT), 338 USLCOM_DEV(SILABS, TRAQMATE), 339 USLCOM_DEV(SILABS, USBCOUNT50), 340 USLCOM_DEV(SILABS, USBPULSE100), 341 USLCOM_DEV(SILABS, USBSCOPE50), 342 USLCOM_DEV(SILABS, USBWAVE12), 343 USLCOM_DEV(SILABS, V_PREON32), 344 USLCOM_DEV(SILABS, VSTABI), 345 USLCOM_DEV(SILABS, WAVIT), 346 USLCOM_DEV(SILABS, WMRBATT), 347 USLCOM_DEV(SILABS, WMRRIGBLASTER), 348 USLCOM_DEV(SILABS, WMRRIGTALK), 349 USLCOM_DEV(SILABS, ZEPHYR_BIO), 350 USLCOM_DEV(SILABS2, DCU11CLONE), 351 USLCOM_DEV(SILABS3, GPRS_MODEM), 352 USLCOM_DEV(SILABS4, 100EU_MODEM), 353 USLCOM_DEV(SYNTECH, CYPHERLAB100), 354 USLCOM_DEV(USI, MC60), 355 USLCOM_DEV(VAISALA, CABLE), 356 USLCOM_DEV(WAGO, SERVICECABLE), 357 USLCOM_DEV(WAVESENSE, JAZZ), 358 USLCOM_DEV(WESTMOUNTAIN, RIGBLASTER_ADVANTAGE), 359 USLCOM_DEV(WIENERPLEINBAUS, PL512), 360 USLCOM_DEV(WIENERPLEINBAUS, RCM), 361 USLCOM_DEV(WIENERPLEINBAUS, MPOD), 362 USLCOM_DEV(WIENERPLEINBAUS, CML), 363 #undef USLCOM_DEV 364 }; 365 366 static device_method_t uslcom_methods[] = { 367 DEVMETHOD(device_probe, uslcom_probe), 368 DEVMETHOD(device_attach, uslcom_attach), 369 DEVMETHOD(device_detach, uslcom_detach), 370 DEVMETHOD_END 371 }; 372 373 static devclass_t uslcom_devclass; 374 375 static driver_t uslcom_driver = { 376 .name = "uslcom", 377 .methods = uslcom_methods, 378 .size = sizeof(struct uslcom_softc), 379 }; 380 381 DRIVER_MODULE(uslcom, uhub, uslcom_driver, uslcom_devclass, NULL, 0); 382 MODULE_DEPEND(uslcom, ucom, 1, 1, 1); 383 MODULE_DEPEND(uslcom, usb, 1, 1, 1); 384 MODULE_VERSION(uslcom, 1); 385 USB_PNP_HOST_INFO(uslcom_devs); 386 387 static void 388 uslcom_watchdog(void *arg) 389 { 390 struct uslcom_softc *sc = arg; 391 392 mtx_assert(&sc->sc_mtx, MA_OWNED); 393 394 usbd_transfer_start(sc->sc_xfer[USLCOM_CTRL_DT_RD]); 395 396 usb_callout_reset(&sc->sc_watchdog, 397 hz / 4, &uslcom_watchdog, sc); 398 } 399 400 static int 401 uslcom_probe(device_t dev) 402 { 403 struct usb_attach_arg *uaa = device_get_ivars(dev); 404 405 DPRINTFN(11, "\n"); 406 407 if (uaa->usb_mode != USB_MODE_HOST) { 408 return (ENXIO); 409 } 410 if (uaa->info.bConfigIndex != USLCOM_CONFIG_INDEX) { 411 return (ENXIO); 412 } 413 return (usbd_lookup_id_by_uaa(uslcom_devs, sizeof(uslcom_devs), uaa)); 414 } 415 416 static int 417 uslcom_attach(device_t dev) 418 { 419 struct usb_attach_arg *uaa = device_get_ivars(dev); 420 struct uslcom_softc *sc = device_get_softc(dev); 421 int error; 422 423 DPRINTFN(11, "\n"); 424 425 device_set_usb_desc(dev); 426 mtx_init(&sc->sc_mtx, "uslcom", NULL, MTX_DEF); 427 ucom_ref(&sc->sc_super_ucom); 428 usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_mtx, 0); 429 430 sc->sc_udev = uaa->device; 431 /* use the interface number from the USB interface descriptor */ 432 sc->sc_iface_no = uaa->info.bIfaceNum; 433 434 error = usbd_transfer_setup(uaa->device, 435 &uaa->info.bIfaceIndex, sc->sc_xfer, uslcom_config, 436 USLCOM_N_TRANSFER, sc, &sc->sc_mtx); 437 if (error) { 438 DPRINTF("one or more missing USB endpoints, " 439 "error=%s\n", usbd_errstr(error)); 440 goto detach; 441 } 442 /* clear stall at first run */ 443 mtx_lock(&sc->sc_mtx); 444 usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_WR]); 445 usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_RD]); 446 mtx_unlock(&sc->sc_mtx); 447 448 sc->sc_partnum = uslcom_get_partnum(sc); 449 450 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 451 &uslcom_callback, &sc->sc_mtx); 452 if (error) { 453 goto detach; 454 } 455 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 456 457 return (0); 458 459 detach: 460 uslcom_detach(dev); 461 return (ENXIO); 462 } 463 464 static int 465 uslcom_detach(device_t dev) 466 { 467 struct uslcom_softc *sc = device_get_softc(dev); 468 469 DPRINTF("sc=%p\n", sc); 470 471 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom); 472 usbd_transfer_unsetup(sc->sc_xfer, USLCOM_N_TRANSFER); 473 474 usb_callout_drain(&sc->sc_watchdog); 475 476 device_claim_softc(dev); 477 478 uslcom_free_softc(sc); 479 480 return (0); 481 } 482 483 UCOM_UNLOAD_DRAIN(uslcom); 484 485 static void 486 uslcom_free_softc(struct uslcom_softc *sc) 487 { 488 if (ucom_unref(&sc->sc_super_ucom)) { 489 mtx_destroy(&sc->sc_mtx); 490 device_free_softc(sc); 491 } 492 } 493 494 static void 495 uslcom_free(struct ucom_softc *ucom) 496 { 497 uslcom_free_softc(ucom->sc_parent); 498 } 499 500 static void 501 uslcom_open(struct ucom_softc *ucom) 502 { 503 struct uslcom_softc *sc = ucom->sc_parent; 504 struct usb_device_request req; 505 506 req.bmRequestType = USLCOM_WRITE; 507 req.bRequest = USLCOM_IFC_ENABLE; 508 USETW(req.wValue, USLCOM_IFC_ENABLE_EN); 509 USETW(req.wIndex, sc->sc_iface_no); 510 USETW(req.wLength, 0); 511 512 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 513 &req, NULL, 0, 1000)) { 514 DPRINTF("UART enable failed (ignored)\n"); 515 } 516 517 /* start polling status */ 518 uslcom_watchdog(sc); 519 } 520 521 static void 522 uslcom_close(struct ucom_softc *ucom) 523 { 524 struct uslcom_softc *sc = ucom->sc_parent; 525 struct usb_device_request req; 526 527 /* stop polling status */ 528 usb_callout_stop(&sc->sc_watchdog); 529 530 req.bmRequestType = USLCOM_WRITE; 531 req.bRequest = USLCOM_IFC_ENABLE; 532 USETW(req.wValue, USLCOM_IFC_ENABLE_DIS); 533 USETW(req.wIndex, sc->sc_iface_no); 534 USETW(req.wLength, 0); 535 536 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 537 &req, NULL, 0, 1000)) { 538 DPRINTF("UART disable failed (ignored)\n"); 539 } 540 } 541 542 static uint8_t 543 uslcom_get_partnum(struct uslcom_softc *sc) 544 { 545 struct usb_device_request req; 546 uint8_t partnum; 547 548 /* Find specific chip type */ 549 partnum = 0; 550 req.bmRequestType = USLCOM_READ; 551 req.bRequest = USLCOM_VENDOR_SPECIFIC; 552 USETW(req.wValue, USLCOM_GET_PARTNUM); 553 USETW(req.wIndex, sc->sc_iface_no); 554 USETW(req.wLength, sizeof(partnum)); 555 556 if (usbd_do_request_flags(sc->sc_udev, NULL, 557 &req, &partnum, 0, NULL, 1000)) { 558 DPRINTF("GET_PARTNUM failed\n"); 559 } 560 561 return(partnum); 562 } 563 564 static void 565 uslcom_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 566 { 567 struct uslcom_softc *sc = ucom->sc_parent; 568 struct usb_device_request req; 569 uint16_t ctl; 570 571 DPRINTF("onoff = %d\n", onoff); 572 573 ctl = onoff ? USLCOM_MHS_DTR_ON : 0; 574 ctl |= USLCOM_MHS_DTR_SET; 575 576 req.bmRequestType = USLCOM_WRITE; 577 req.bRequest = USLCOM_SET_MHS; 578 USETW(req.wValue, ctl); 579 USETW(req.wIndex, sc->sc_iface_no); 580 USETW(req.wLength, 0); 581 582 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 583 &req, NULL, 0, 1000)) { 584 DPRINTF("Setting DTR failed (ignored)\n"); 585 } 586 } 587 588 static void 589 uslcom_set_rts(struct ucom_softc *ucom, uint8_t onoff) 590 { 591 struct uslcom_softc *sc = ucom->sc_parent; 592 struct usb_device_request req; 593 uint16_t ctl; 594 595 DPRINTF("onoff = %d\n", onoff); 596 597 ctl = onoff ? USLCOM_MHS_RTS_ON : 0; 598 ctl |= USLCOM_MHS_RTS_SET; 599 600 req.bmRequestType = USLCOM_WRITE; 601 req.bRequest = USLCOM_SET_MHS; 602 USETW(req.wValue, ctl); 603 USETW(req.wIndex, sc->sc_iface_no); 604 USETW(req.wLength, 0); 605 606 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 607 &req, NULL, 0, 1000)) { 608 DPRINTF("Setting DTR failed (ignored)\n"); 609 } 610 } 611 612 static int 613 uslcom_pre_param(struct ucom_softc *ucom, struct termios *t) 614 { 615 if (t->c_ospeed <= 0 || t->c_ospeed > 921600) 616 return (EINVAL); 617 return (0); 618 } 619 620 static void 621 uslcom_param(struct ucom_softc *ucom, struct termios *t) 622 { 623 struct uslcom_softc *sc = ucom->sc_parent; 624 struct usb_device_request req; 625 uint32_t baudrate, flowctrl[4]; 626 uint16_t data; 627 628 DPRINTF("\n"); 629 630 baudrate = t->c_ospeed; 631 req.bmRequestType = USLCOM_WRITE; 632 req.bRequest = USLCOM_SET_BAUDRATE; 633 USETW(req.wValue, 0); 634 USETW(req.wIndex, sc->sc_iface_no); 635 USETW(req.wLength, sizeof(baudrate)); 636 637 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 638 &req, &baudrate, 0, 1000)) { 639 DPRINTF("Set baudrate failed (ignored)\n"); 640 } 641 642 if (t->c_cflag & CSTOPB) 643 data = USLCOM_STOP_BITS_2; 644 else 645 data = USLCOM_STOP_BITS_1; 646 if (t->c_cflag & PARENB) { 647 if (t->c_cflag & PARODD) 648 data |= USLCOM_PARITY_ODD; 649 else 650 data |= USLCOM_PARITY_EVEN; 651 } else 652 data |= USLCOM_PARITY_NONE; 653 switch (t->c_cflag & CSIZE) { 654 case CS5: 655 data |= USLCOM_SET_DATA_BITS(5); 656 break; 657 case CS6: 658 data |= USLCOM_SET_DATA_BITS(6); 659 break; 660 case CS7: 661 data |= USLCOM_SET_DATA_BITS(7); 662 break; 663 case CS8: 664 data |= USLCOM_SET_DATA_BITS(8); 665 break; 666 } 667 668 req.bmRequestType = USLCOM_WRITE; 669 req.bRequest = USLCOM_SET_LINE_CTL; 670 USETW(req.wValue, data); 671 USETW(req.wIndex, sc->sc_iface_no); 672 USETW(req.wLength, 0); 673 674 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 675 &req, NULL, 0, 1000)) { 676 DPRINTF("Set format failed (ignored)\n"); 677 } 678 679 if (t->c_cflag & CRTSCTS) { 680 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON | USLCOM_FLOW_CTS_HS); 681 flowctrl[1] = htole32(USLCOM_FLOW_RTS_HS); 682 } else { 683 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON); 684 flowctrl[1] = htole32(USLCOM_FLOW_RTS_ON); 685 } 686 flowctrl[2] = 0; 687 flowctrl[3] = 0; 688 req.bmRequestType = USLCOM_WRITE; 689 req.bRequest = USLCOM_SET_FLOW; 690 USETW(req.wValue, 0); 691 USETW(req.wIndex, sc->sc_iface_no); 692 USETW(req.wLength, sizeof(flowctrl)); 693 694 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 695 &req, flowctrl, 0, 1000)) { 696 DPRINTF("Set flowcontrol failed (ignored)\n"); 697 } 698 } 699 700 static void 701 uslcom_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 702 { 703 struct uslcom_softc *sc = ucom->sc_parent; 704 705 DPRINTF("\n"); 706 707 /* XXX Note: sc_lsr is always zero */ 708 *lsr = sc->sc_lsr; 709 *msr = sc->sc_msr; 710 } 711 712 static void 713 uslcom_set_break(struct ucom_softc *ucom, uint8_t onoff) 714 { 715 struct uslcom_softc *sc = ucom->sc_parent; 716 struct usb_device_request req; 717 uint16_t brk = onoff ? USLCOM_SET_BREAK_ON : USLCOM_SET_BREAK_OFF; 718 719 req.bmRequestType = USLCOM_WRITE; 720 req.bRequest = USLCOM_SET_BREAK; 721 USETW(req.wValue, brk); 722 USETW(req.wIndex, sc->sc_iface_no); 723 USETW(req.wLength, 0); 724 725 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 726 &req, NULL, 0, 1000)) { 727 DPRINTF("Set BREAK failed (ignored)\n"); 728 } 729 } 730 731 static int 732 uslcom_ioctl(struct ucom_softc *ucom, uint32_t cmd, caddr_t data, 733 int flag, struct thread *td) 734 { 735 struct uslcom_softc *sc = ucom->sc_parent; 736 struct usb_device_request req; 737 int error = 0; 738 uint8_t latch; 739 740 DPRINTF("cmd=0x%08x\n", cmd); 741 742 switch (cmd) { 743 case USB_GET_GPIO: 744 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) { 745 error = ENODEV; 746 break; 747 } 748 req.bmRequestType = USLCOM_READ; 749 req.bRequest = USLCOM_VENDOR_SPECIFIC; 750 USETW(req.wValue, USLCOM_READ_LATCH); 751 USETW(req.wIndex, sc->sc_iface_no); 752 USETW(req.wLength, sizeof(latch)); 753 754 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 755 &req, &latch, 0, 1000)) { 756 DPRINTF("Get LATCH failed\n"); 757 error = EIO; 758 } 759 *(int *)data = latch; 760 break; 761 762 case USB_SET_GPIO: 763 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) 764 error = ENODEV; 765 else if ((sc->sc_partnum == USLCOM_PARTNUM_CP2103) || 766 (sc->sc_partnum == USLCOM_PARTNUM_CP2104)) { 767 req.bmRequestType = USLCOM_WRITE; 768 req.bRequest = USLCOM_VENDOR_SPECIFIC; 769 USETW(req.wValue, USLCOM_WRITE_LATCH); 770 USETW(req.wIndex, (*(int *)data)); 771 USETW(req.wLength, 0); 772 773 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 774 &req, NULL, 0, 1000)) { 775 DPRINTF("Set LATCH failed\n"); 776 error = EIO; 777 } 778 } else 779 error = ENODEV; /* Not yet */ 780 break; 781 782 default: 783 DPRINTF("Unknown IOCTL\n"); 784 error = ENOIOCTL; 785 break; 786 } 787 return (error); 788 } 789 790 static void 791 uslcom_write_callback(struct usb_xfer *xfer, usb_error_t error) 792 { 793 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 794 struct usb_page_cache *pc; 795 uint32_t actlen; 796 797 switch (USB_GET_STATE(xfer)) { 798 case USB_ST_SETUP: 799 case USB_ST_TRANSFERRED: 800 tr_setup: 801 pc = usbd_xfer_get_frame(xfer, 0); 802 if (ucom_get_data(&sc->sc_ucom, pc, 0, 803 USLCOM_BULK_BUF_SIZE, &actlen)) { 804 805 DPRINTF("actlen = %d\n", actlen); 806 807 usbd_xfer_set_frame_len(xfer, 0, actlen); 808 usbd_transfer_submit(xfer); 809 } 810 return; 811 812 default: /* Error */ 813 if (error != USB_ERR_CANCELLED) { 814 /* try to clear stall first */ 815 usbd_xfer_set_stall(xfer); 816 goto tr_setup; 817 } 818 return; 819 } 820 } 821 822 static void 823 uslcom_read_callback(struct usb_xfer *xfer, usb_error_t error) 824 { 825 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 826 struct usb_page_cache *pc; 827 int actlen; 828 829 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 830 831 switch (USB_GET_STATE(xfer)) { 832 case USB_ST_TRANSFERRED: 833 pc = usbd_xfer_get_frame(xfer, 0); 834 ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 835 836 case USB_ST_SETUP: 837 tr_setup: 838 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 839 usbd_transfer_submit(xfer); 840 return; 841 842 default: /* Error */ 843 if (error != USB_ERR_CANCELLED) { 844 /* try to clear stall first */ 845 usbd_xfer_set_stall(xfer); 846 goto tr_setup; 847 } 848 return; 849 } 850 } 851 852 static void 853 uslcom_control_callback(struct usb_xfer *xfer, usb_error_t error) 854 { 855 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 856 struct usb_page_cache *pc; 857 struct usb_device_request req; 858 uint8_t msr = 0; 859 uint8_t buf; 860 861 switch (USB_GET_STATE(xfer)) { 862 case USB_ST_TRANSFERRED: 863 pc = usbd_xfer_get_frame(xfer, 1); 864 usbd_copy_out(pc, 0, &buf, sizeof(buf)); 865 if (buf & USLCOM_MHS_CTS) 866 msr |= SER_CTS; 867 if (buf & USLCOM_MHS_DSR) 868 msr |= SER_DSR; 869 if (buf & USLCOM_MHS_RI) 870 msr |= SER_RI; 871 if (buf & USLCOM_MHS_DCD) 872 msr |= SER_DCD; 873 874 if (msr != sc->sc_msr) { 875 DPRINTF("status change msr=0x%02x " 876 "(was 0x%02x)\n", msr, sc->sc_msr); 877 sc->sc_msr = msr; 878 ucom_status_change(&sc->sc_ucom); 879 } 880 break; 881 882 case USB_ST_SETUP: 883 req.bmRequestType = USLCOM_READ; 884 req.bRequest = USLCOM_GET_MDMSTS; 885 USETW(req.wValue, 0); 886 USETW(req.wIndex, sc->sc_iface_no); 887 USETW(req.wLength, sizeof(buf)); 888 889 usbd_xfer_set_frames(xfer, 2); 890 usbd_xfer_set_frame_len(xfer, 0, sizeof(req)); 891 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf)); 892 893 pc = usbd_xfer_get_frame(xfer, 0); 894 usbd_copy_in(pc, 0, &req, sizeof(req)); 895 usbd_transfer_submit(xfer); 896 break; 897 898 default: /* error */ 899 if (error != USB_ERR_CANCELLED) 900 DPRINTF("error=%s\n", usbd_errstr(error)); 901 break; 902 } 903 } 904 905 static void 906 uslcom_start_read(struct ucom_softc *ucom) 907 { 908 struct uslcom_softc *sc = ucom->sc_parent; 909 910 /* start read endpoint */ 911 usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_RD]); 912 } 913 914 static void 915 uslcom_stop_read(struct ucom_softc *ucom) 916 { 917 struct uslcom_softc *sc = ucom->sc_parent; 918 919 /* stop read endpoint */ 920 usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_RD]); 921 } 922 923 static void 924 uslcom_start_write(struct ucom_softc *ucom) 925 { 926 struct uslcom_softc *sc = ucom->sc_parent; 927 928 usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_WR]); 929 } 930 931 static void 932 uslcom_stop_write(struct ucom_softc *ucom) 933 { 934 struct uslcom_softc *sc = ucom->sc_parent; 935 936 usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_WR]); 937 } 938 939 static void 940 uslcom_poll(struct ucom_softc *ucom) 941 { 942 struct uslcom_softc *sc = ucom->sc_parent; 943 usbd_transfer_poll(sc->sc_xfer, USLCOM_N_TRANSFER); 944 } 945