1 /* $NetBSD: uplcom.c,v 1.21 2001/11/13 06:24:56 lukem Exp $ */ 2 3 #include <sys/cdefs.h> 4 __FBSDID("$FreeBSD$"); 5 6 /*- 7 * Copyright (c) 2001-2003, 2005 Shunsuke Akiyama <akiyama@jp.FreeBSD.org>. 8 * All rights reserved. 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 /*- 33 * Copyright (c) 2001 The NetBSD Foundation, Inc. 34 * All rights reserved. 35 * 36 * This code is derived from software contributed to The NetBSD Foundation 37 * by Ichiro FUKUHARA (ichiro@ichiro.org). 38 * 39 * Redistribution and use in source and binary forms, with or without 40 * modification, are permitted provided that the following conditions 41 * are met: 42 * 1. Redistributions of source code must retain the above copyright 43 * notice, this list of conditions and the following disclaimer. 44 * 2. Redistributions in binary form must reproduce the above copyright 45 * notice, this list of conditions and the following disclaimer in the 46 * documentation and/or other materials provided with the distribution. 47 * 3. All advertising materials mentioning features or use of this software 48 * must display the following acknowledgement: 49 * This product includes software developed by the NetBSD 50 * Foundation, Inc. and its contributors. 51 * 4. Neither the name of The NetBSD Foundation nor the names of its 52 * contributors may be used to endorse or promote products derived 53 * from this software without specific prior written permission. 54 * 55 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 56 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 57 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 58 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 59 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 60 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 61 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 62 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 63 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 64 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 65 * POSSIBILITY OF SUCH DAMAGE. 66 */ 67 68 /* 69 * This driver supports several USB-to-RS232 serial adapters driven by 70 * Prolific PL-2303, PL-2303X and probably PL-2303HX USB-to-RS232 71 * bridge chip. The adapters are sold under many different brand 72 * names. 73 * 74 * Datasheets are available at Prolific www site at 75 * http://www.prolific.com.tw. The datasheets don't contain full 76 * programming information for the chip. 77 * 78 * PL-2303HX is probably programmed the same as PL-2303X. 79 * 80 * There are several differences between PL-2303 and PL-2303(H)X. 81 * PL-2303(H)X can do higher bitrate in bulk mode, has _probably_ 82 * different command for controlling CRTSCTS and needs special 83 * sequence of commands for initialization which aren't also 84 * documented in the datasheet. 85 */ 86 87 #include <sys/stdint.h> 88 #include <sys/stddef.h> 89 #include <sys/param.h> 90 #include <sys/queue.h> 91 #include <sys/types.h> 92 #include <sys/systm.h> 93 #include <sys/kernel.h> 94 #include <sys/bus.h> 95 #include <sys/linker_set.h> 96 #include <sys/module.h> 97 #include <sys/lock.h> 98 #include <sys/mutex.h> 99 #include <sys/condvar.h> 100 #include <sys/sysctl.h> 101 #include <sys/sx.h> 102 #include <sys/unistd.h> 103 #include <sys/callout.h> 104 #include <sys/malloc.h> 105 #include <sys/priv.h> 106 107 #include <dev/usb/usb.h> 108 #include <dev/usb/usbdi.h> 109 #include <dev/usb/usbdi_util.h> 110 #include <dev/usb/usb_cdc.h> 111 #include "usbdevs.h" 112 113 #define USB_DEBUG_VAR uplcom_debug 114 #include <dev/usb/usb_debug.h> 115 #include <dev/usb/usb_process.h> 116 117 #include <dev/usb/serial/usb_serial.h> 118 119 #ifdef USB_DEBUG 120 static int uplcom_debug = 0; 121 122 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom"); 123 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW, 124 &uplcom_debug, 0, "Debug level"); 125 #endif 126 127 #define UPLCOM_MODVER 1 /* module version */ 128 129 #define UPLCOM_CONFIG_INDEX 0 130 #define UPLCOM_IFACE_INDEX 0 131 #define UPLCOM_SECOND_IFACE_INDEX 1 132 133 #ifndef UPLCOM_INTR_INTERVAL 134 #define UPLCOM_INTR_INTERVAL 0 /* default */ 135 #endif 136 137 #define UPLCOM_BULK_BUF_SIZE 1024 /* bytes */ 138 139 #define UPLCOM_SET_REQUEST 0x01 140 #define UPLCOM_SET_CRTSCTS 0x41 141 #define UPLCOM_SET_CRTSCTS_PL2303X 0x61 142 #define RSAQ_STATUS_CTS 0x80 143 #define RSAQ_STATUS_DSR 0x02 144 #define RSAQ_STATUS_DCD 0x01 145 146 #define TYPE_PL2303 0 147 #define TYPE_PL2303HX 1 148 149 enum { 150 UPLCOM_BULK_DT_WR, 151 UPLCOM_BULK_DT_RD, 152 UPLCOM_INTR_DT_RD, 153 UPLCOM_N_TRANSFER, 154 }; 155 156 struct uplcom_softc { 157 struct ucom_super_softc sc_super_ucom; 158 struct ucom_softc sc_ucom; 159 160 struct usb_xfer *sc_xfer[UPLCOM_N_TRANSFER]; 161 struct usb_device *sc_udev; 162 struct mtx sc_mtx; 163 164 uint16_t sc_line; 165 166 uint8_t sc_lsr; /* local status register */ 167 uint8_t sc_msr; /* uplcom status register */ 168 uint8_t sc_chiptype; /* type of chip */ 169 uint8_t sc_ctrl_iface_no; 170 uint8_t sc_data_iface_no; 171 uint8_t sc_iface_index[2]; 172 }; 173 174 /* prototypes */ 175 176 static usb_error_t uplcom_reset(struct uplcom_softc *, struct usb_device *); 177 static usb_error_t uplcom_pl2303_do(struct usb_device *, int8_t, uint8_t, 178 uint16_t, uint16_t, uint16_t); 179 static int uplcom_pl2303_init(struct usb_device *, uint8_t); 180 static void uplcom_cfg_set_dtr(struct ucom_softc *, uint8_t); 181 static void uplcom_cfg_set_rts(struct ucom_softc *, uint8_t); 182 static void uplcom_cfg_set_break(struct ucom_softc *, uint8_t); 183 static int uplcom_pre_param(struct ucom_softc *, struct termios *); 184 static void uplcom_cfg_param(struct ucom_softc *, struct termios *); 185 static void uplcom_start_read(struct ucom_softc *); 186 static void uplcom_stop_read(struct ucom_softc *); 187 static void uplcom_start_write(struct ucom_softc *); 188 static void uplcom_stop_write(struct ucom_softc *); 189 static void uplcom_cfg_get_status(struct ucom_softc *, uint8_t *, 190 uint8_t *); 191 static void uplcom_poll(struct ucom_softc *ucom); 192 193 static device_probe_t uplcom_probe; 194 static device_attach_t uplcom_attach; 195 static device_detach_t uplcom_detach; 196 197 static usb_callback_t uplcom_intr_callback; 198 static usb_callback_t uplcom_write_callback; 199 static usb_callback_t uplcom_read_callback; 200 201 static const struct usb_config uplcom_config_data[UPLCOM_N_TRANSFER] = { 202 203 [UPLCOM_BULK_DT_WR] = { 204 .type = UE_BULK, 205 .endpoint = UE_ADDR_ANY, 206 .direction = UE_DIR_OUT, 207 .bufsize = UPLCOM_BULK_BUF_SIZE, 208 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 209 .callback = &uplcom_write_callback, 210 .if_index = 0, 211 }, 212 213 [UPLCOM_BULK_DT_RD] = { 214 .type = UE_BULK, 215 .endpoint = UE_ADDR_ANY, 216 .direction = UE_DIR_IN, 217 .bufsize = UPLCOM_BULK_BUF_SIZE, 218 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 219 .callback = &uplcom_read_callback, 220 .if_index = 0, 221 }, 222 223 [UPLCOM_INTR_DT_RD] = { 224 .type = UE_INTERRUPT, 225 .endpoint = UE_ADDR_ANY, 226 .direction = UE_DIR_IN, 227 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 228 .bufsize = 0, /* use wMaxPacketSize */ 229 .callback = &uplcom_intr_callback, 230 .if_index = 1, 231 }, 232 }; 233 234 static struct ucom_callback uplcom_callback = { 235 .ucom_cfg_get_status = &uplcom_cfg_get_status, 236 .ucom_cfg_set_dtr = &uplcom_cfg_set_dtr, 237 .ucom_cfg_set_rts = &uplcom_cfg_set_rts, 238 .ucom_cfg_set_break = &uplcom_cfg_set_break, 239 .ucom_cfg_param = &uplcom_cfg_param, 240 .ucom_pre_param = &uplcom_pre_param, 241 .ucom_start_read = &uplcom_start_read, 242 .ucom_stop_read = &uplcom_stop_read, 243 .ucom_start_write = &uplcom_start_write, 244 .ucom_stop_write = &uplcom_stop_write, 245 .ucom_poll = &uplcom_poll, 246 }; 247 248 #define UPLCOM_DEV(v,p) \ 249 { USB_VENDOR(USB_VENDOR_##v), USB_PRODUCT(USB_PRODUCT_##v##_##p) } 250 251 static const struct usb_device_id uplcom_devs[] = { 252 UPLCOM_DEV(ACERP, S81), /* BenQ S81 phone */ 253 UPLCOM_DEV(ADLINK, ND6530), /* ADLINK ND-6530 USB-Serial */ 254 UPLCOM_DEV(ALCATEL, OT535), /* Alcatel One Touch 535/735 */ 255 UPLCOM_DEV(ALCOR, AU9720), /* Alcor AU9720 USB 2.0-RS232 */ 256 UPLCOM_DEV(ANCHOR, SERIAL), /* Anchor Serial adapter */ 257 UPLCOM_DEV(ATEN, UC232A), /* PLANEX USB-RS232 URS-03 */ 258 UPLCOM_DEV(BELKIN, F5U257), /* Belkin F5U257 */ 259 UPLCOM_DEV(COREGA, CGUSBRS232R), /* Corega CG-USBRS232R */ 260 UPLCOM_DEV(EPSON, CRESSI_EDY), /* Cressi Edy diving computer */ 261 UPLCOM_DEV(ELECOM, UCSGT), /* ELECOM UC-SGT */ 262 UPLCOM_DEV(ELECOM, UCSGT0), /* ELECOM UC-SGT */ 263 UPLCOM_DEV(HAL, IMR001), /* HAL Corporation Crossam2+USB */ 264 UPLCOM_DEV(HP, LD220), /* HP LD220 POS Display */ 265 UPLCOM_DEV(IODATA, USBRSAQ), /* I/O DATA USB-RSAQ */ 266 UPLCOM_DEV(IODATA, USBRSAQ5), /* I/O DATA USB-RSAQ5 */ 267 UPLCOM_DEV(ITEGNO, WM1080A), /* iTegno WM1080A GSM/GFPRS modem */ 268 UPLCOM_DEV(ITEGNO, WM2080A), /* iTegno WM2080A CDMA modem */ 269 UPLCOM_DEV(LEADTEK, 9531), /* Leadtek 9531 GPS */ 270 UPLCOM_DEV(MICROSOFT, 700WX), /* Microsoft Palm 700WX */ 271 UPLCOM_DEV(MOBILEACTION, MA620), /* Mobile Action MA-620 Infrared Adapter */ 272 UPLCOM_DEV(NETINDEX, WS002IN), /* Willcom W-S002IN */ 273 UPLCOM_DEV(NOKIA2, CA42), /* Nokia CA-42 cable */ 274 UPLCOM_DEV(OTI, DKU5), /* OTI DKU-5 cable */ 275 UPLCOM_DEV(PANASONIC, TYTP50P6S), /* Panasonic TY-TP50P6-S flat screen */ 276 UPLCOM_DEV(PLX, CA42), /* PLX CA-42 clone cable */ 277 UPLCOM_DEV(PROLIFIC, ALLTRONIX_GPRS), /* Alltronix ACM003U00 modem */ 278 UPLCOM_DEV(PROLIFIC, ALDIGA_AL11U), /* AlDiga AL-11U modem */ 279 UPLCOM_DEV(PROLIFIC, DCU11), /* DCU-11 Phone Cable */ 280 UPLCOM_DEV(PROLIFIC, HCR331), /* HCR331 Card Reader */ 281 UPLCOM_DEV(PROLIFIC, MICROMAX_610U), /* Micromax 610U modem */ 282 UPLCOM_DEV(PROLIFIC, PHAROS), /* Prolific Pharos */ 283 UPLCOM_DEV(PROLIFIC, PL2303), /* Generic adapter */ 284 UPLCOM_DEV(PROLIFIC, RSAQ2), /* I/O DATA USB-RSAQ2 */ 285 UPLCOM_DEV(PROLIFIC, RSAQ3), /* I/O DATA USB-RSAQ3 */ 286 UPLCOM_DEV(PROLIFIC2, PL2303), /* Prolific adapter */ 287 UPLCOM_DEV(RADIOSHACK, USBCABLE), 288 UPLCOM_DEV(RATOC, REXUSB60), /* RATOC REX-USB60 */ 289 UPLCOM_DEV(SAGEM, USBSERIAL), /* Sagem USB-Serial Controller */ 290 UPLCOM_DEV(SAMSUNG, I330), /* Samsung I330 phone cradle */ 291 UPLCOM_DEV(SANWA, KB_USB2), /* Sanwa KB-USB2 Multimeter cable */ 292 UPLCOM_DEV(SIEMENS3, EF81), /* Seimens EF81 */ 293 UPLCOM_DEV(SIEMENS3, SX1), /* Seimens SX1 */ 294 UPLCOM_DEV(SIEMENS3, X65), /* Seimens X65 */ 295 UPLCOM_DEV(SIEMENS3, X75), /* Seimens X75 */ 296 UPLCOM_DEV(SITECOM, SERIAL), /* Sitecom USB to Serial */ 297 UPLCOM_DEV(SMART, PL2303), /* SMART Technologies */ 298 UPLCOM_DEV(SONY, QN3), /* Sony QN3 phone cable */ 299 UPLCOM_DEV(SONYERICSSON, DATAPILOT), /* Sony Ericsson Datapilot */ 300 UPLCOM_DEV(SONYERICSSON, DCU10), /* Sony Ericsson DCU-10 Cable */ 301 UPLCOM_DEV(SOURCENEXT, KEIKAI8), /* SOURCENEXT KeikaiDenwa 8 */ 302 UPLCOM_DEV(SOURCENEXT, KEIKAI8_CHG), /* SOURCENEXT KeikaiDenwa 8 with charger */ 303 UPLCOM_DEV(SPEEDDRAGON, MS3303H), /* Speed Dragon USB-Serial */ 304 UPLCOM_DEV(SYNTECH, CPT8001C), /* Syntech CPT-8001C Barcode scanner */ 305 UPLCOM_DEV(TDK, UHA6400), /* TDK USB-PHS Adapter UHA6400 */ 306 UPLCOM_DEV(TDK, UPA9664), /* TDK USB-PHS Adapter UPA9664 */ 307 UPLCOM_DEV(TRIPPLITE, U209), /* Tripp-Lite U209-000-R */ 308 UPLCOM_DEV(YCCABLE, PL2303), /* YC Cable USB-Serial */ 309 }; 310 #undef UPLCOM_DEV 311 312 static device_method_t uplcom_methods[] = { 313 DEVMETHOD(device_probe, uplcom_probe), 314 DEVMETHOD(device_attach, uplcom_attach), 315 DEVMETHOD(device_detach, uplcom_detach), 316 {0, 0} 317 }; 318 319 static devclass_t uplcom_devclass; 320 321 static driver_t uplcom_driver = { 322 .name = "uplcom", 323 .methods = uplcom_methods, 324 .size = sizeof(struct uplcom_softc), 325 }; 326 327 DRIVER_MODULE(uplcom, uhub, uplcom_driver, uplcom_devclass, NULL, 0); 328 MODULE_DEPEND(uplcom, ucom, 1, 1, 1); 329 MODULE_DEPEND(uplcom, usb, 1, 1, 1); 330 MODULE_VERSION(uplcom, UPLCOM_MODVER); 331 332 static int 333 uplcom_probe(device_t dev) 334 { 335 struct usb_attach_arg *uaa = device_get_ivars(dev); 336 337 DPRINTFN(11, "\n"); 338 339 if (uaa->usb_mode != USB_MODE_HOST) { 340 return (ENXIO); 341 } 342 if (uaa->info.bConfigIndex != UPLCOM_CONFIG_INDEX) { 343 return (ENXIO); 344 } 345 if (uaa->info.bIfaceIndex != UPLCOM_IFACE_INDEX) { 346 return (ENXIO); 347 } 348 return (usbd_lookup_id_by_uaa(uplcom_devs, sizeof(uplcom_devs), uaa)); 349 } 350 351 static int 352 uplcom_attach(device_t dev) 353 { 354 struct usb_attach_arg *uaa = device_get_ivars(dev); 355 struct uplcom_softc *sc = device_get_softc(dev); 356 struct usb_interface *iface; 357 struct usb_interface_descriptor *id; 358 struct usb_device_descriptor *dd; 359 int error; 360 361 DPRINTFN(11, "\n"); 362 363 device_set_usb_desc(dev); 364 mtx_init(&sc->sc_mtx, "uplcom", NULL, MTX_DEF); 365 366 DPRINTF("sc = %p\n", sc); 367 368 sc->sc_udev = uaa->device; 369 370 /* Determine the chip type. This algorithm is taken from Linux. */ 371 dd = usbd_get_device_descriptor(sc->sc_udev); 372 if (dd->bDeviceClass == 0x02) 373 sc->sc_chiptype = TYPE_PL2303; 374 else if (dd->bMaxPacketSize == 0x40) 375 sc->sc_chiptype = TYPE_PL2303HX; 376 else 377 sc->sc_chiptype = TYPE_PL2303; 378 379 DPRINTF("chiptype: %s\n", 380 (sc->sc_chiptype == TYPE_PL2303HX) ? 381 "2303X" : "2303"); 382 383 /* 384 * USB-RSAQ1 has two interface 385 * 386 * USB-RSAQ1 | USB-RSAQ2 387 * -----------------+----------------- 388 * Interface 0 |Interface 0 389 * Interrupt(0x81) | Interrupt(0x81) 390 * -----------------+ BulkIN(0x02) 391 * Interface 1 | BulkOUT(0x83) 392 * BulkIN(0x02) | 393 * BulkOUT(0x83) | 394 */ 395 396 sc->sc_ctrl_iface_no = uaa->info.bIfaceNum; 397 sc->sc_iface_index[1] = UPLCOM_IFACE_INDEX; 398 399 iface = usbd_get_iface(uaa->device, UPLCOM_SECOND_IFACE_INDEX); 400 if (iface) { 401 id = usbd_get_interface_descriptor(iface); 402 if (id == NULL) { 403 device_printf(dev, "no interface descriptor (2)\n"); 404 goto detach; 405 } 406 sc->sc_data_iface_no = id->bInterfaceNumber; 407 sc->sc_iface_index[0] = UPLCOM_SECOND_IFACE_INDEX; 408 usbd_set_parent_iface(uaa->device, 409 UPLCOM_SECOND_IFACE_INDEX, uaa->info.bIfaceIndex); 410 } else { 411 sc->sc_data_iface_no = sc->sc_ctrl_iface_no; 412 sc->sc_iface_index[0] = UPLCOM_IFACE_INDEX; 413 } 414 415 error = usbd_transfer_setup(uaa->device, 416 sc->sc_iface_index, sc->sc_xfer, uplcom_config_data, 417 UPLCOM_N_TRANSFER, sc, &sc->sc_mtx); 418 if (error) { 419 DPRINTF("one or more missing USB endpoints, " 420 "error=%s\n", usbd_errstr(error)); 421 goto detach; 422 } 423 error = uplcom_reset(sc, uaa->device); 424 if (error) { 425 device_printf(dev, "reset failed, error=%s\n", 426 usbd_errstr(error)); 427 goto detach; 428 } 429 /* clear stall at first run */ 430 mtx_lock(&sc->sc_mtx); 431 usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_WR]); 432 usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_RD]); 433 mtx_unlock(&sc->sc_mtx); 434 435 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 436 &uplcom_callback, &sc->sc_mtx); 437 if (error) { 438 goto detach; 439 } 440 /* 441 * do the initialization during attach so that the system does not 442 * sleep during open: 443 */ 444 if (uplcom_pl2303_init(uaa->device, sc->sc_chiptype)) { 445 device_printf(dev, "init failed\n"); 446 goto detach; 447 } 448 return (0); 449 450 detach: 451 uplcom_detach(dev); 452 return (ENXIO); 453 } 454 455 static int 456 uplcom_detach(device_t dev) 457 { 458 struct uplcom_softc *sc = device_get_softc(dev); 459 460 DPRINTF("sc=%p\n", sc); 461 462 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1); 463 usbd_transfer_unsetup(sc->sc_xfer, UPLCOM_N_TRANSFER); 464 mtx_destroy(&sc->sc_mtx); 465 466 return (0); 467 } 468 469 static usb_error_t 470 uplcom_reset(struct uplcom_softc *sc, struct usb_device *udev) 471 { 472 struct usb_device_request req; 473 474 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 475 req.bRequest = UPLCOM_SET_REQUEST; 476 USETW(req.wValue, 0); 477 req.wIndex[0] = sc->sc_data_iface_no; 478 req.wIndex[1] = 0; 479 USETW(req.wLength, 0); 480 481 return (usbd_do_request(udev, NULL, &req, NULL)); 482 } 483 484 static usb_error_t 485 uplcom_pl2303_do(struct usb_device *udev, int8_t req_type, uint8_t request, 486 uint16_t value, uint16_t index, uint16_t length) 487 { 488 struct usb_device_request req; 489 usb_error_t err; 490 uint8_t buf[4]; 491 492 req.bmRequestType = req_type; 493 req.bRequest = request; 494 USETW(req.wValue, value); 495 USETW(req.wIndex, index); 496 USETW(req.wLength, length); 497 498 err = usbd_do_request(udev, NULL, &req, buf); 499 if (err) { 500 DPRINTF("error=%s\n", usbd_errstr(err)); 501 return (1); 502 } 503 return (0); 504 } 505 506 static int 507 uplcom_pl2303_init(struct usb_device *udev, uint8_t chiptype) 508 { 509 int err; 510 511 if (uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1) 512 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 0, 0) 513 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1) 514 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1) 515 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1) 516 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0) 517 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1) 518 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1) 519 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0) 520 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0)) 521 return (EIO); 522 523 if (chiptype == TYPE_PL2303HX) 524 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0); 525 else 526 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x24, 0); 527 if (err) 528 return (EIO); 529 530 if (uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 8, 0, 0) 531 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 9, 0, 0)) 532 return (EIO); 533 return (0); 534 } 535 536 static void 537 uplcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 538 { 539 struct uplcom_softc *sc = ucom->sc_parent; 540 struct usb_device_request req; 541 542 DPRINTF("onoff = %d\n", onoff); 543 544 if (onoff) 545 sc->sc_line |= UCDC_LINE_DTR; 546 else 547 sc->sc_line &= ~UCDC_LINE_DTR; 548 549 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 550 req.bRequest = UCDC_SET_CONTROL_LINE_STATE; 551 USETW(req.wValue, sc->sc_line); 552 req.wIndex[0] = sc->sc_data_iface_no; 553 req.wIndex[1] = 0; 554 USETW(req.wLength, 0); 555 556 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 557 &req, NULL, 0, 1000); 558 } 559 560 static void 561 uplcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff) 562 { 563 struct uplcom_softc *sc = ucom->sc_parent; 564 struct usb_device_request req; 565 566 DPRINTF("onoff = %d\n", onoff); 567 568 if (onoff) 569 sc->sc_line |= UCDC_LINE_RTS; 570 else 571 sc->sc_line &= ~UCDC_LINE_RTS; 572 573 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 574 req.bRequest = UCDC_SET_CONTROL_LINE_STATE; 575 USETW(req.wValue, sc->sc_line); 576 req.wIndex[0] = sc->sc_data_iface_no; 577 req.wIndex[1] = 0; 578 USETW(req.wLength, 0); 579 580 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 581 &req, NULL, 0, 1000); 582 } 583 584 static void 585 uplcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff) 586 { 587 struct uplcom_softc *sc = ucom->sc_parent; 588 struct usb_device_request req; 589 uint16_t temp; 590 591 DPRINTF("onoff = %d\n", onoff); 592 593 temp = (onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF); 594 595 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 596 req.bRequest = UCDC_SEND_BREAK; 597 USETW(req.wValue, temp); 598 req.wIndex[0] = sc->sc_data_iface_no; 599 req.wIndex[1] = 0; 600 USETW(req.wLength, 0); 601 602 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 603 &req, NULL, 0, 1000); 604 } 605 606 static const int32_t uplcom_rates[] = { 607 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400, 608 19200, 28800, 38400, 57600, 115200, 609 /* 610 * Higher speeds are probably possible. PL2303X supports up to 611 * 6Mb and can set any rate 612 */ 613 230400, 460800, 614400, 921600, 1228800 614 }; 615 616 #define N_UPLCOM_RATES (sizeof(uplcom_rates)/sizeof(uplcom_rates[0])) 617 618 static int 619 uplcom_pre_param(struct ucom_softc *ucom, struct termios *t) 620 { 621 struct uplcom_softc *sc = ucom->sc_parent; 622 uint8_t i; 623 624 DPRINTF("\n"); 625 626 /** 627 * Check requested baud rate. 628 * 629 * The PL2303 can only set specific baud rates, up to 1228800 baud. 630 * The PL2303X can set any baud rate up to 6Mb. 631 * The PL2303HX rev. D can set any baud rate up to 12Mb. 632 * 633 * XXX: We currently cannot identify the PL2303HX rev. D, so treat 634 * it the same as the PL2303X. 635 */ 636 if (sc->sc_chiptype != TYPE_PL2303HX) { 637 for (i = 0; i < N_UPLCOM_RATES; i++) { 638 if (uplcom_rates[i] == t->c_ospeed) 639 return (0); 640 } 641 } else { 642 if (t->c_ospeed <= 6000000) 643 return (0); 644 } 645 646 DPRINTF("uplcom_param: bad baud rate (%d)\n", t->c_ospeed); 647 return (EIO); 648 } 649 650 static void 651 uplcom_cfg_param(struct ucom_softc *ucom, struct termios *t) 652 { 653 struct uplcom_softc *sc = ucom->sc_parent; 654 struct usb_cdc_line_state ls; 655 struct usb_device_request req; 656 657 DPRINTF("sc = %p\n", sc); 658 659 bzero(&ls, sizeof(ls)); 660 661 USETDW(ls.dwDTERate, t->c_ospeed); 662 663 if (t->c_cflag & CSTOPB) { 664 ls.bCharFormat = UCDC_STOP_BIT_2; 665 } else { 666 ls.bCharFormat = UCDC_STOP_BIT_1; 667 } 668 669 if (t->c_cflag & PARENB) { 670 if (t->c_cflag & PARODD) { 671 ls.bParityType = UCDC_PARITY_ODD; 672 } else { 673 ls.bParityType = UCDC_PARITY_EVEN; 674 } 675 } else { 676 ls.bParityType = UCDC_PARITY_NONE; 677 } 678 679 switch (t->c_cflag & CSIZE) { 680 case CS5: 681 ls.bDataBits = 5; 682 break; 683 case CS6: 684 ls.bDataBits = 6; 685 break; 686 case CS7: 687 ls.bDataBits = 7; 688 break; 689 case CS8: 690 ls.bDataBits = 8; 691 break; 692 } 693 694 DPRINTF("rate=%d fmt=%d parity=%d bits=%d\n", 695 UGETDW(ls.dwDTERate), ls.bCharFormat, 696 ls.bParityType, ls.bDataBits); 697 698 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 699 req.bRequest = UCDC_SET_LINE_CODING; 700 USETW(req.wValue, 0); 701 req.wIndex[0] = sc->sc_data_iface_no; 702 req.wIndex[1] = 0; 703 USETW(req.wLength, UCDC_LINE_STATE_LENGTH); 704 705 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 706 &req, &ls, 0, 1000); 707 708 if (t->c_cflag & CRTSCTS) { 709 710 DPRINTF("crtscts = on\n"); 711 712 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 713 req.bRequest = UPLCOM_SET_REQUEST; 714 USETW(req.wValue, 0); 715 if (sc->sc_chiptype == TYPE_PL2303HX) 716 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X); 717 else 718 USETW(req.wIndex, UPLCOM_SET_CRTSCTS); 719 USETW(req.wLength, 0); 720 721 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 722 &req, NULL, 0, 1000); 723 } else { 724 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 725 req.bRequest = UPLCOM_SET_REQUEST; 726 USETW(req.wValue, 0); 727 USETW(req.wIndex, 0); 728 USETW(req.wLength, 0); 729 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 730 &req, NULL, 0, 1000); 731 } 732 } 733 734 static void 735 uplcom_start_read(struct ucom_softc *ucom) 736 { 737 struct uplcom_softc *sc = ucom->sc_parent; 738 739 /* start interrupt endpoint */ 740 usbd_transfer_start(sc->sc_xfer[UPLCOM_INTR_DT_RD]); 741 742 /* start read endpoint */ 743 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_RD]); 744 } 745 746 static void 747 uplcom_stop_read(struct ucom_softc *ucom) 748 { 749 struct uplcom_softc *sc = ucom->sc_parent; 750 751 /* stop interrupt endpoint */ 752 usbd_transfer_stop(sc->sc_xfer[UPLCOM_INTR_DT_RD]); 753 754 /* stop read endpoint */ 755 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_RD]); 756 } 757 758 static void 759 uplcom_start_write(struct ucom_softc *ucom) 760 { 761 struct uplcom_softc *sc = ucom->sc_parent; 762 763 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_WR]); 764 } 765 766 static void 767 uplcom_stop_write(struct ucom_softc *ucom) 768 { 769 struct uplcom_softc *sc = ucom->sc_parent; 770 771 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_WR]); 772 } 773 774 static void 775 uplcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 776 { 777 struct uplcom_softc *sc = ucom->sc_parent; 778 779 DPRINTF("\n"); 780 781 *lsr = sc->sc_lsr; 782 *msr = sc->sc_msr; 783 } 784 785 static void 786 uplcom_intr_callback(struct usb_xfer *xfer, usb_error_t error) 787 { 788 struct uplcom_softc *sc = usbd_xfer_softc(xfer); 789 struct usb_page_cache *pc; 790 uint8_t buf[9]; 791 int actlen; 792 793 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 794 795 switch (USB_GET_STATE(xfer)) { 796 case USB_ST_TRANSFERRED: 797 798 DPRINTF("actlen = %u\n", actlen); 799 800 if (actlen >= 9) { 801 802 pc = usbd_xfer_get_frame(xfer, 0); 803 usbd_copy_out(pc, 0, buf, sizeof(buf)); 804 805 DPRINTF("status = 0x%02x\n", buf[8]); 806 807 sc->sc_lsr = 0; 808 sc->sc_msr = 0; 809 810 if (buf[8] & RSAQ_STATUS_CTS) { 811 sc->sc_msr |= SER_CTS; 812 } 813 if (buf[8] & RSAQ_STATUS_DSR) { 814 sc->sc_msr |= SER_DSR; 815 } 816 if (buf[8] & RSAQ_STATUS_DCD) { 817 sc->sc_msr |= SER_DCD; 818 } 819 ucom_status_change(&sc->sc_ucom); 820 } 821 case USB_ST_SETUP: 822 tr_setup: 823 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 824 usbd_transfer_submit(xfer); 825 return; 826 827 default: /* Error */ 828 if (error != USB_ERR_CANCELLED) { 829 /* try to clear stall first */ 830 usbd_xfer_set_stall(xfer); 831 goto tr_setup; 832 } 833 return; 834 } 835 } 836 837 static void 838 uplcom_write_callback(struct usb_xfer *xfer, usb_error_t error) 839 { 840 struct uplcom_softc *sc = usbd_xfer_softc(xfer); 841 struct usb_page_cache *pc; 842 uint32_t actlen; 843 844 switch (USB_GET_STATE(xfer)) { 845 case USB_ST_SETUP: 846 case USB_ST_TRANSFERRED: 847 tr_setup: 848 pc = usbd_xfer_get_frame(xfer, 0); 849 if (ucom_get_data(&sc->sc_ucom, pc, 0, 850 UPLCOM_BULK_BUF_SIZE, &actlen)) { 851 852 DPRINTF("actlen = %d\n", actlen); 853 854 usbd_xfer_set_frame_len(xfer, 0, actlen); 855 usbd_transfer_submit(xfer); 856 } 857 return; 858 859 default: /* Error */ 860 if (error != USB_ERR_CANCELLED) { 861 /* try to clear stall first */ 862 usbd_xfer_set_stall(xfer); 863 goto tr_setup; 864 } 865 return; 866 } 867 } 868 869 static void 870 uplcom_read_callback(struct usb_xfer *xfer, usb_error_t error) 871 { 872 struct uplcom_softc *sc = usbd_xfer_softc(xfer); 873 struct usb_page_cache *pc; 874 int actlen; 875 876 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 877 878 switch (USB_GET_STATE(xfer)) { 879 case USB_ST_TRANSFERRED: 880 pc = usbd_xfer_get_frame(xfer, 0); 881 ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 882 883 case USB_ST_SETUP: 884 tr_setup: 885 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 886 usbd_transfer_submit(xfer); 887 return; 888 889 default: /* Error */ 890 if (error != USB_ERR_CANCELLED) { 891 /* try to clear stall first */ 892 usbd_xfer_set_stall(xfer); 893 goto tr_setup; 894 } 895 return; 896 } 897 } 898 899 static void 900 uplcom_poll(struct ucom_softc *ucom) 901 { 902 struct uplcom_softc *sc = ucom->sc_parent; 903 usbd_transfer_poll(sc->sc_xfer, UPLCOM_N_TRANSFER); 904 } 905