1/* $OpenBSD: uslcom.c,v 1.17 2007/11/24 10:52:12 jsg Exp $ */ 2 3#include <sys/cdefs.h> 4__FBSDID("$FreeBSD: releng/10.2/sys/dev/usb/serial/uslcom.c 265610 2014-05-07 20:57:16Z gavin $"); 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 60static int uslcom_debug = 0; 61 62static SYSCTL_NODE(_hw_usb, OID_AUTO, uslcom, CTLFLAG_RW, 0, "USB uslcom"); 63SYSCTL_INT(_hw_usb_uslcom, OID_AUTO, debug, CTLFLAG_RW, 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 133enum { 134 USLCOM_BULK_DT_WR, 135 USLCOM_BULK_DT_RD, 136 USLCOM_CTRL_DT_RD, 137 USLCOM_N_TRANSFER, 138}; 139 140struct 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 155static device_probe_t uslcom_probe; 156static device_attach_t uslcom_attach; 157static device_detach_t uslcom_detach; 158static void uslcom_free_softc(struct uslcom_softc *); 159 160static usb_callback_t uslcom_write_callback; 161static usb_callback_t uslcom_read_callback; 162static usb_callback_t uslcom_control_callback; 163 164static void uslcom_free(struct ucom_softc *); 165static void uslcom_open(struct ucom_softc *); 166static void uslcom_close(struct ucom_softc *); 167static uint8_t uslcom_get_partnum(struct uslcom_softc *); 168static void uslcom_set_dtr(struct ucom_softc *, uint8_t); 169static void uslcom_set_rts(struct ucom_softc *, uint8_t); 170static void uslcom_set_break(struct ucom_softc *, uint8_t); 171static int uslcom_ioctl(struct ucom_softc *, uint32_t, caddr_t, int, 172 struct thread *); 173static int uslcom_pre_param(struct ucom_softc *, struct termios *); 174static void uslcom_param(struct ucom_softc *, struct termios *); 175static void uslcom_get_status(struct ucom_softc *, uint8_t *, uint8_t *); 176static void uslcom_start_read(struct ucom_softc *); 177static void uslcom_stop_read(struct ucom_softc *); 178static void uslcom_start_write(struct ucom_softc *); 179static void uslcom_stop_write(struct ucom_softc *); 180static void uslcom_poll(struct ucom_softc *ucom); 181 182static 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 212static 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 230static 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 366static 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 373static devclass_t uslcom_devclass; 374 375static driver_t uslcom_driver = { 376 .name = "uslcom", 377 .methods = uslcom_methods, 378 .size = sizeof(struct uslcom_softc), 379}; 380 381DRIVER_MODULE(uslcom, uhub, uslcom_driver, uslcom_devclass, NULL, 0); 382MODULE_DEPEND(uslcom, ucom, 1, 1, 1); 383MODULE_DEPEND(uslcom, usb, 1, 1, 1); 384MODULE_VERSION(uslcom, 1); 385 386static void 387uslcom_watchdog(void *arg) 388{ 389 struct uslcom_softc *sc = arg; 390 391 mtx_assert(&sc->sc_mtx, MA_OWNED); 392 393 usbd_transfer_start(sc->sc_xfer[USLCOM_CTRL_DT_RD]); 394 395 usb_callout_reset(&sc->sc_watchdog, 396 hz / 4, &uslcom_watchdog, sc); 397} 398 399static int 400uslcom_probe(device_t dev) 401{ 402 struct usb_attach_arg *uaa = device_get_ivars(dev); 403 404 DPRINTFN(11, "\n"); 405 406 if (uaa->usb_mode != USB_MODE_HOST) { 407 return (ENXIO); 408 } 409 if (uaa->info.bConfigIndex != USLCOM_CONFIG_INDEX) { 410 return (ENXIO); 411 } 412 return (usbd_lookup_id_by_uaa(uslcom_devs, sizeof(uslcom_devs), uaa)); 413} 414 415static int 416uslcom_attach(device_t dev) 417{ 418 struct usb_attach_arg *uaa = device_get_ivars(dev); 419 struct uslcom_softc *sc = device_get_softc(dev); 420 int error; 421 422 DPRINTFN(11, "\n"); 423 424 device_set_usb_desc(dev); 425 mtx_init(&sc->sc_mtx, "uslcom", NULL, MTX_DEF); 426 ucom_ref(&sc->sc_super_ucom); 427 usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_mtx, 0); 428 429 sc->sc_udev = uaa->device; 430 /* use the interface number from the USB interface descriptor */ 431 sc->sc_iface_no = uaa->info.bIfaceNum; 432 433 error = usbd_transfer_setup(uaa->device, 434 &uaa->info.bIfaceIndex, sc->sc_xfer, uslcom_config, 435 USLCOM_N_TRANSFER, sc, &sc->sc_mtx); 436 if (error) { 437 DPRINTF("one or more missing USB endpoints, " 438 "error=%s\n", usbd_errstr(error)); 439 goto detach; 440 } 441 /* clear stall at first run */ 442 mtx_lock(&sc->sc_mtx); 443 usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_WR]); 444 usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_RD]); 445 mtx_unlock(&sc->sc_mtx); 446 447 sc->sc_partnum = uslcom_get_partnum(sc); 448 449 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 450 &uslcom_callback, &sc->sc_mtx); 451 if (error) { 452 goto detach; 453 } 454 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 455 456 return (0); 457 458detach: 459 uslcom_detach(dev); 460 return (ENXIO); 461} 462 463static int 464uslcom_detach(device_t dev) 465{ 466 struct uslcom_softc *sc = device_get_softc(dev); 467 468 DPRINTF("sc=%p\n", sc); 469 470 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom); 471 usbd_transfer_unsetup(sc->sc_xfer, USLCOM_N_TRANSFER); 472 473 usb_callout_drain(&sc->sc_watchdog); 474 475 device_claim_softc(dev); 476 477 uslcom_free_softc(sc); 478 479 return (0); 480} 481 482UCOM_UNLOAD_DRAIN(uslcom); 483 484static void 485uslcom_free_softc(struct uslcom_softc *sc) 486{ 487 if (ucom_unref(&sc->sc_super_ucom)) { 488 mtx_destroy(&sc->sc_mtx); 489 device_free_softc(sc); 490 } 491} 492 493static void 494uslcom_free(struct ucom_softc *ucom) 495{ 496 uslcom_free_softc(ucom->sc_parent); 497} 498 499static void 500uslcom_open(struct ucom_softc *ucom) 501{ 502 struct uslcom_softc *sc = ucom->sc_parent; 503 struct usb_device_request req; 504 505 req.bmRequestType = USLCOM_WRITE; 506 req.bRequest = USLCOM_IFC_ENABLE; 507 USETW(req.wValue, USLCOM_IFC_ENABLE_EN); 508 USETW(req.wIndex, sc->sc_iface_no); 509 USETW(req.wLength, 0); 510 511 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 512 &req, NULL, 0, 1000)) { 513 DPRINTF("UART enable failed (ignored)\n"); 514 } 515 516 /* start polling status */ 517 uslcom_watchdog(sc); 518} 519 520static void 521uslcom_close(struct ucom_softc *ucom) 522{ 523 struct uslcom_softc *sc = ucom->sc_parent; 524 struct usb_device_request req; 525 526 /* stop polling status */ 527 usb_callout_stop(&sc->sc_watchdog); 528 529 req.bmRequestType = USLCOM_WRITE; 530 req.bRequest = USLCOM_IFC_ENABLE; 531 USETW(req.wValue, USLCOM_IFC_ENABLE_DIS); 532 USETW(req.wIndex, sc->sc_iface_no); 533 USETW(req.wLength, 0); 534 535 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 536 &req, NULL, 0, 1000)) { 537 DPRINTF("UART disable failed (ignored)\n"); 538 } 539} 540 541static uint8_t 542uslcom_get_partnum(struct uslcom_softc *sc) 543{ 544 struct usb_device_request req; 545 uint8_t partnum; 546 547 /* Find specific chip type */ 548 partnum = 0; 549 req.bmRequestType = USLCOM_READ; 550 req.bRequest = USLCOM_VENDOR_SPECIFIC; 551 USETW(req.wValue, USLCOM_GET_PARTNUM); 552 USETW(req.wIndex, sc->sc_iface_no); 553 USETW(req.wLength, sizeof(partnum)); 554 555 if (usbd_do_request_flags(sc->sc_udev, NULL, 556 &req, &partnum, 0, NULL, 1000)) { 557 DPRINTF("GET_PARTNUM failed\n"); 558 } 559 560 return(partnum); 561} 562 563static void 564uslcom_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 565{ 566 struct uslcom_softc *sc = ucom->sc_parent; 567 struct usb_device_request req; 568 uint16_t ctl; 569 570 DPRINTF("onoff = %d\n", onoff); 571 572 ctl = onoff ? USLCOM_MHS_DTR_ON : 0; 573 ctl |= USLCOM_MHS_DTR_SET; 574 575 req.bmRequestType = USLCOM_WRITE; 576 req.bRequest = USLCOM_SET_MHS; 577 USETW(req.wValue, ctl); 578 USETW(req.wIndex, sc->sc_iface_no); 579 USETW(req.wLength, 0); 580 581 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 582 &req, NULL, 0, 1000)) { 583 DPRINTF("Setting DTR failed (ignored)\n"); 584 } 585} 586 587static void 588uslcom_set_rts(struct ucom_softc *ucom, uint8_t onoff) 589{ 590 struct uslcom_softc *sc = ucom->sc_parent; 591 struct usb_device_request req; 592 uint16_t ctl; 593 594 DPRINTF("onoff = %d\n", onoff); 595 596 ctl = onoff ? USLCOM_MHS_RTS_ON : 0; 597 ctl |= USLCOM_MHS_RTS_SET; 598 599 req.bmRequestType = USLCOM_WRITE; 600 req.bRequest = USLCOM_SET_MHS; 601 USETW(req.wValue, ctl); 602 USETW(req.wIndex, sc->sc_iface_no); 603 USETW(req.wLength, 0); 604 605 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 606 &req, NULL, 0, 1000)) { 607 DPRINTF("Setting DTR failed (ignored)\n"); 608 } 609} 610 611static int 612uslcom_pre_param(struct ucom_softc *ucom, struct termios *t) 613{ 614 if (t->c_ospeed <= 0 || t->c_ospeed > 921600) 615 return (EINVAL); 616 return (0); 617} 618 619static void 620uslcom_param(struct ucom_softc *ucom, struct termios *t) 621{ 622 struct uslcom_softc *sc = ucom->sc_parent; 623 struct usb_device_request req; 624 uint32_t baudrate, flowctrl[4]; 625 uint16_t data; 626 627 DPRINTF("\n"); 628 629 baudrate = t->c_ospeed; 630 req.bmRequestType = USLCOM_WRITE; 631 req.bRequest = USLCOM_SET_BAUDRATE; 632 USETW(req.wValue, 0); 633 USETW(req.wIndex, sc->sc_iface_no); 634 USETW(req.wLength, sizeof(baudrate)); 635 636 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 637 &req, &baudrate, 0, 1000)) { 638 DPRINTF("Set baudrate failed (ignored)\n"); 639 } 640 641 if (t->c_cflag & CSTOPB) 642 data = USLCOM_STOP_BITS_2; 643 else 644 data = USLCOM_STOP_BITS_1; 645 if (t->c_cflag & PARENB) { 646 if (t->c_cflag & PARODD) 647 data |= USLCOM_PARITY_ODD; 648 else 649 data |= USLCOM_PARITY_EVEN; 650 } else 651 data |= USLCOM_PARITY_NONE; 652 switch (t->c_cflag & CSIZE) { 653 case CS5: 654 data |= USLCOM_SET_DATA_BITS(5); 655 break; 656 case CS6: 657 data |= USLCOM_SET_DATA_BITS(6); 658 break; 659 case CS7: 660 data |= USLCOM_SET_DATA_BITS(7); 661 break; 662 case CS8: 663 data |= USLCOM_SET_DATA_BITS(8); 664 break; 665 } 666 667 req.bmRequestType = USLCOM_WRITE; 668 req.bRequest = USLCOM_SET_LINE_CTL; 669 USETW(req.wValue, data); 670 USETW(req.wIndex, sc->sc_iface_no); 671 USETW(req.wLength, 0); 672 673 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 674 &req, NULL, 0, 1000)) { 675 DPRINTF("Set format failed (ignored)\n"); 676 } 677 678 if (t->c_cflag & CRTSCTS) { 679 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON | USLCOM_FLOW_CTS_HS); 680 flowctrl[1] = htole32(USLCOM_FLOW_RTS_HS); 681 } else { 682 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON); 683 flowctrl[1] = htole32(USLCOM_FLOW_RTS_ON); 684 } 685 flowctrl[2] = 0; 686 flowctrl[3] = 0; 687 req.bmRequestType = USLCOM_WRITE; 688 req.bRequest = USLCOM_SET_FLOW; 689 USETW(req.wValue, 0); 690 USETW(req.wIndex, sc->sc_iface_no); 691 USETW(req.wLength, sizeof(flowctrl)); 692 693 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 694 &req, flowctrl, 0, 1000)) { 695 DPRINTF("Set flowcontrol failed (ignored)\n"); 696 } 697} 698 699static void 700uslcom_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 701{ 702 struct uslcom_softc *sc = ucom->sc_parent; 703 704 DPRINTF("\n"); 705 706 *lsr = sc->sc_lsr; 707 *msr = sc->sc_msr; 708} 709 710static void 711uslcom_set_break(struct ucom_softc *ucom, uint8_t onoff) 712{ 713 struct uslcom_softc *sc = ucom->sc_parent; 714 struct usb_device_request req; 715 uint16_t brk = onoff ? USLCOM_SET_BREAK_ON : USLCOM_SET_BREAK_OFF; 716 717 req.bmRequestType = USLCOM_WRITE; 718 req.bRequest = USLCOM_SET_BREAK; 719 USETW(req.wValue, brk); 720 USETW(req.wIndex, sc->sc_iface_no); 721 USETW(req.wLength, 0); 722 723 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 724 &req, NULL, 0, 1000)) { 725 DPRINTF("Set BREAK failed (ignored)\n"); 726 } 727} 728 729static int 730uslcom_ioctl(struct ucom_softc *ucom, uint32_t cmd, caddr_t data, 731 int flag, struct thread *td) 732{ 733 struct uslcom_softc *sc = ucom->sc_parent; 734 struct usb_device_request req; 735 int error = 0; 736 uint8_t latch; 737 738 DPRINTF("cmd=0x%08x\n", cmd); 739 740 switch (cmd) { 741 case USB_GET_GPIO: 742 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) { 743 error = ENODEV; 744 break; 745 } 746 req.bmRequestType = USLCOM_READ; 747 req.bRequest = USLCOM_VENDOR_SPECIFIC; 748 USETW(req.wValue, USLCOM_READ_LATCH); 749 USETW(req.wIndex, sc->sc_iface_no); 750 USETW(req.wLength, sizeof(latch)); 751 752 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 753 &req, &latch, 0, 1000)) { 754 DPRINTF("Get LATCH failed\n"); 755 error = EIO; 756 } 757 *(int *)data = latch; 758 break; 759 760 case USB_SET_GPIO: 761 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) 762 error = ENODEV; 763 else if ((sc->sc_partnum == USLCOM_PARTNUM_CP2103) || 764 (sc->sc_partnum == USLCOM_PARTNUM_CP2104)) { 765 req.bmRequestType = USLCOM_WRITE; 766 req.bRequest = USLCOM_VENDOR_SPECIFIC; 767 USETW(req.wValue, USLCOM_WRITE_LATCH); 768 USETW(req.wIndex, (*(int *)data)); 769 USETW(req.wLength, 0); 770 771 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 772 &req, NULL, 0, 1000)) { 773 DPRINTF("Set LATCH failed\n"); 774 error = EIO; 775 } 776 } else 777 error = ENODEV; /* Not yet */ 778 break; 779 780 default: 781 DPRINTF("Unknown IOCTL\n"); 782 error = ENOIOCTL; 783 break; 784 } 785 return (error); 786} 787 788static void 789uslcom_write_callback(struct usb_xfer *xfer, usb_error_t error) 790{ 791 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 792 struct usb_page_cache *pc; 793 uint32_t actlen; 794 795 switch (USB_GET_STATE(xfer)) { 796 case USB_ST_SETUP: 797 case USB_ST_TRANSFERRED: 798tr_setup: 799 pc = usbd_xfer_get_frame(xfer, 0); 800 if (ucom_get_data(&sc->sc_ucom, pc, 0, 801 USLCOM_BULK_BUF_SIZE, &actlen)) { 802 803 DPRINTF("actlen = %d\n", actlen); 804 805 usbd_xfer_set_frame_len(xfer, 0, actlen); 806 usbd_transfer_submit(xfer); 807 } 808 return; 809 810 default: /* Error */ 811 if (error != USB_ERR_CANCELLED) { 812 /* try to clear stall first */ 813 usbd_xfer_set_stall(xfer); 814 goto tr_setup; 815 } 816 return; 817 } 818} 819 820static void 821uslcom_read_callback(struct usb_xfer *xfer, usb_error_t error) 822{ 823 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 824 struct usb_page_cache *pc; 825 int actlen; 826 827 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 828 829 switch (USB_GET_STATE(xfer)) { 830 case USB_ST_TRANSFERRED: 831 pc = usbd_xfer_get_frame(xfer, 0); 832 ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 833 834 case USB_ST_SETUP: 835tr_setup: 836 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 837 usbd_transfer_submit(xfer); 838 return; 839 840 default: /* Error */ 841 if (error != USB_ERR_CANCELLED) { 842 /* try to clear stall first */ 843 usbd_xfer_set_stall(xfer); 844 goto tr_setup; 845 } 846 return; 847 } 848} 849 850static void 851uslcom_control_callback(struct usb_xfer *xfer, usb_error_t error) 852{ 853 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 854 struct usb_page_cache *pc; 855 struct usb_device_request req; 856 uint8_t msr = 0; 857 uint8_t buf; 858 859 switch (USB_GET_STATE(xfer)) { 860 case USB_ST_TRANSFERRED: 861 pc = usbd_xfer_get_frame(xfer, 1); 862 usbd_copy_out(pc, 0, &buf, sizeof(buf)); 863 if (buf & USLCOM_MHS_CTS) 864 msr |= SER_CTS; 865 if (buf & USLCOM_MHS_DSR) 866 msr |= SER_DSR; 867 if (buf & USLCOM_MHS_RI) 868 msr |= SER_RI; 869 if (buf & USLCOM_MHS_DCD) 870 msr |= SER_DCD; 871 872 if (msr != sc->sc_msr) { 873 DPRINTF("status change msr=0x%02x " 874 "(was 0x%02x)\n", msr, sc->sc_msr); 875 sc->sc_msr = msr; 876 ucom_status_change(&sc->sc_ucom); 877 } 878 break; 879 880 case USB_ST_SETUP: 881 req.bmRequestType = USLCOM_READ; 882 req.bRequest = USLCOM_GET_MDMSTS; 883 USETW(req.wValue, 0); 884 USETW(req.wIndex, sc->sc_iface_no); 885 USETW(req.wLength, sizeof(buf)); 886 887 usbd_xfer_set_frames(xfer, 2); 888 usbd_xfer_set_frame_len(xfer, 0, sizeof(req)); 889 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf)); 890 891 pc = usbd_xfer_get_frame(xfer, 0); 892 usbd_copy_in(pc, 0, &req, sizeof(req)); 893 usbd_transfer_submit(xfer); 894 break; 895 896 default: /* error */ 897 if (error != USB_ERR_CANCELLED) 898 DPRINTF("error=%s\n", usbd_errstr(error)); 899 break; 900 } 901} 902 903static void 904uslcom_start_read(struct ucom_softc *ucom) 905{ 906 struct uslcom_softc *sc = ucom->sc_parent; 907 908 /* start read endpoint */ 909 usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_RD]); 910} 911 912static void 913uslcom_stop_read(struct ucom_softc *ucom) 914{ 915 struct uslcom_softc *sc = ucom->sc_parent; 916 917 /* stop read endpoint */ 918 usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_RD]); 919} 920 921static void 922uslcom_start_write(struct ucom_softc *ucom) 923{ 924 struct uslcom_softc *sc = ucom->sc_parent; 925 926 usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_WR]); 927} 928 929static void 930uslcom_stop_write(struct ucom_softc *ucom) 931{ 932 struct uslcom_softc *sc = ucom->sc_parent; 933 934 usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_WR]); 935} 936 937static void 938uslcom_poll(struct ucom_softc *ucom) 939{ 940 struct uslcom_softc *sc = ucom->sc_parent; 941 usbd_transfer_poll(sc->sc_xfer, USLCOM_N_TRANSFER); 942} 943