uplcom.c revision 217202
1/* $NetBSD: uplcom.c,v 1.21 2001/11/13 06:24:56 lukem Exp $ */ 2 3#include <sys/cdefs.h> 4__FBSDID("$FreeBSD: head/sys/dev/usb/serial/uplcom.c 217202 2011-01-09 17:40:04Z gavin $"); 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 120static int uplcom_debug = 0; 121 122SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom"); 123SYSCTL_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 149enum { 150 UPLCOM_BULK_DT_WR, 151 UPLCOM_BULK_DT_RD, 152 UPLCOM_INTR_DT_RD, 153 UPLCOM_N_TRANSFER, 154}; 155 156struct 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 176static usb_error_t uplcom_reset(struct uplcom_softc *, struct usb_device *); 177static usb_error_t uplcom_pl2303_do(struct usb_device *, int8_t, uint8_t, 178 uint16_t, uint16_t, uint16_t); 179static int uplcom_pl2303_init(struct usb_device *, uint8_t); 180static void uplcom_cfg_set_dtr(struct ucom_softc *, uint8_t); 181static void uplcom_cfg_set_rts(struct ucom_softc *, uint8_t); 182static void uplcom_cfg_set_break(struct ucom_softc *, uint8_t); 183static int uplcom_pre_param(struct ucom_softc *, struct termios *); 184static void uplcom_cfg_param(struct ucom_softc *, struct termios *); 185static void uplcom_start_read(struct ucom_softc *); 186static void uplcom_stop_read(struct ucom_softc *); 187static void uplcom_start_write(struct ucom_softc *); 188static void uplcom_stop_write(struct ucom_softc *); 189static void uplcom_cfg_get_status(struct ucom_softc *, uint8_t *, 190 uint8_t *); 191static void uplcom_poll(struct ucom_softc *ucom); 192 193static device_probe_t uplcom_probe; 194static device_attach_t uplcom_attach; 195static device_detach_t uplcom_detach; 196 197static usb_callback_t uplcom_intr_callback; 198static usb_callback_t uplcom_write_callback; 199static usb_callback_t uplcom_read_callback; 200 201static 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 234static 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 251static 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(EPSON, N2ITION3), /* Zeagle N2iTion3 diving computer */ 262 UPLCOM_DEV(ELECOM, UCSGT), /* ELECOM UC-SGT */ 263 UPLCOM_DEV(ELECOM, UCSGT0), /* ELECOM UC-SGT */ 264 UPLCOM_DEV(HAL, IMR001), /* HAL Corporation Crossam2+USB */ 265 UPLCOM_DEV(HP, LD220), /* HP LD220 POS Display */ 266 UPLCOM_DEV(IODATA, USBRSAQ), /* I/O DATA USB-RSAQ */ 267 UPLCOM_DEV(IODATA, USBRSAQ5), /* I/O DATA USB-RSAQ5 */ 268 UPLCOM_DEV(ITEGNO, WM1080A), /* iTegno WM1080A GSM/GFPRS modem */ 269 UPLCOM_DEV(ITEGNO, WM2080A), /* iTegno WM2080A CDMA modem */ 270 UPLCOM_DEV(LEADTEK, 9531), /* Leadtek 9531 GPS */ 271 UPLCOM_DEV(MICROSOFT, 700WX), /* Microsoft Palm 700WX */ 272 UPLCOM_DEV(MOBILEACTION, MA620), /* Mobile Action MA-620 Infrared Adapter */ 273 UPLCOM_DEV(NETINDEX, WS002IN), /* Willcom W-S002IN */ 274 UPLCOM_DEV(NOKIA2, CA42), /* Nokia CA-42 cable */ 275 UPLCOM_DEV(OTI, DKU5), /* OTI DKU-5 cable */ 276 UPLCOM_DEV(PANASONIC, TYTP50P6S), /* Panasonic TY-TP50P6-S flat screen */ 277 UPLCOM_DEV(PLX, CA42), /* PLX CA-42 clone cable */ 278 UPLCOM_DEV(PROLIFIC, ALLTRONIX_GPRS), /* Alltronix ACM003U00 modem */ 279 UPLCOM_DEV(PROLIFIC, ALDIGA_AL11U), /* AlDiga AL-11U modem */ 280 UPLCOM_DEV(PROLIFIC, DCU11), /* DCU-11 Phone Cable */ 281 UPLCOM_DEV(PROLIFIC, HCR331), /* HCR331 Card Reader */ 282 UPLCOM_DEV(PROLIFIC, MICROMAX_610U), /* Micromax 610U modem */ 283 UPLCOM_DEV(PROLIFIC, PHAROS), /* Prolific Pharos */ 284 UPLCOM_DEV(PROLIFIC, PL2303), /* Generic adapter */ 285 UPLCOM_DEV(PROLIFIC, RSAQ2), /* I/O DATA USB-RSAQ2 */ 286 UPLCOM_DEV(PROLIFIC, RSAQ3), /* I/O DATA USB-RSAQ3 */ 287 UPLCOM_DEV(PROLIFIC, UIC_MSR206), /* UIC MSR206 Card Reader */ 288 UPLCOM_DEV(PROLIFIC2, PL2303), /* Prolific adapter */ 289 UPLCOM_DEV(RADIOSHACK, USBCABLE), 290 UPLCOM_DEV(RATOC, REXUSB60), /* RATOC REX-USB60 */ 291 UPLCOM_DEV(SAGEM, USBSERIAL), /* Sagem USB-Serial Controller */ 292 UPLCOM_DEV(SAMSUNG, I330), /* Samsung I330 phone cradle */ 293 UPLCOM_DEV(SANWA, KB_USB2), /* Sanwa KB-USB2 Multimeter cable */ 294 UPLCOM_DEV(SIEMENS3, EF81), /* Seimens EF81 */ 295 UPLCOM_DEV(SIEMENS3, SX1), /* Seimens SX1 */ 296 UPLCOM_DEV(SIEMENS3, X65), /* Seimens X65 */ 297 UPLCOM_DEV(SIEMENS3, X75), /* Seimens X75 */ 298 UPLCOM_DEV(SITECOM, SERIAL), /* Sitecom USB to Serial */ 299 UPLCOM_DEV(SMART, PL2303), /* SMART Technologies */ 300 UPLCOM_DEV(SONY, QN3), /* Sony QN3 phone cable */ 301 UPLCOM_DEV(SONYERICSSON, DATAPILOT), /* Sony Ericsson Datapilot */ 302 UPLCOM_DEV(SONYERICSSON, DCU10), /* Sony Ericsson DCU-10 Cable */ 303 UPLCOM_DEV(SOURCENEXT, KEIKAI8), /* SOURCENEXT KeikaiDenwa 8 */ 304 UPLCOM_DEV(SOURCENEXT, KEIKAI8_CHG), /* SOURCENEXT KeikaiDenwa 8 with charger */ 305 UPLCOM_DEV(SPEEDDRAGON, MS3303H), /* Speed Dragon USB-Serial */ 306 UPLCOM_DEV(SYNTECH, CPT8001C), /* Syntech CPT-8001C Barcode scanner */ 307 UPLCOM_DEV(TDK, UHA6400), /* TDK USB-PHS Adapter UHA6400 */ 308 UPLCOM_DEV(TDK, UPA9664), /* TDK USB-PHS Adapter UPA9664 */ 309 UPLCOM_DEV(TRIPPLITE, U209), /* Tripp-Lite U209-000-R */ 310 UPLCOM_DEV(YCCABLE, PL2303), /* YC Cable USB-Serial */ 311}; 312#undef UPLCOM_DEV 313 314static device_method_t uplcom_methods[] = { 315 DEVMETHOD(device_probe, uplcom_probe), 316 DEVMETHOD(device_attach, uplcom_attach), 317 DEVMETHOD(device_detach, uplcom_detach), 318 {0, 0} 319}; 320 321static devclass_t uplcom_devclass; 322 323static driver_t uplcom_driver = { 324 .name = "uplcom", 325 .methods = uplcom_methods, 326 .size = sizeof(struct uplcom_softc), 327}; 328 329DRIVER_MODULE(uplcom, uhub, uplcom_driver, uplcom_devclass, NULL, 0); 330MODULE_DEPEND(uplcom, ucom, 1, 1, 1); 331MODULE_DEPEND(uplcom, usb, 1, 1, 1); 332MODULE_VERSION(uplcom, UPLCOM_MODVER); 333 334static int 335uplcom_probe(device_t dev) 336{ 337 struct usb_attach_arg *uaa = device_get_ivars(dev); 338 339 DPRINTFN(11, "\n"); 340 341 if (uaa->usb_mode != USB_MODE_HOST) { 342 return (ENXIO); 343 } 344 if (uaa->info.bConfigIndex != UPLCOM_CONFIG_INDEX) { 345 return (ENXIO); 346 } 347 if (uaa->info.bIfaceIndex != UPLCOM_IFACE_INDEX) { 348 return (ENXIO); 349 } 350 return (usbd_lookup_id_by_uaa(uplcom_devs, sizeof(uplcom_devs), uaa)); 351} 352 353static int 354uplcom_attach(device_t dev) 355{ 356 struct usb_attach_arg *uaa = device_get_ivars(dev); 357 struct uplcom_softc *sc = device_get_softc(dev); 358 struct usb_interface *iface; 359 struct usb_interface_descriptor *id; 360 struct usb_device_descriptor *dd; 361 int error; 362 363 DPRINTFN(11, "\n"); 364 365 device_set_usb_desc(dev); 366 mtx_init(&sc->sc_mtx, "uplcom", NULL, MTX_DEF); 367 368 DPRINTF("sc = %p\n", sc); 369 370 sc->sc_udev = uaa->device; 371 372 /* Determine the chip type. This algorithm is taken from Linux. */ 373 dd = usbd_get_device_descriptor(sc->sc_udev); 374 if (dd->bDeviceClass == 0x02) 375 sc->sc_chiptype = TYPE_PL2303; 376 else if (dd->bMaxPacketSize == 0x40) 377 sc->sc_chiptype = TYPE_PL2303HX; 378 else 379 sc->sc_chiptype = TYPE_PL2303; 380 381 DPRINTF("chiptype: %s\n", 382 (sc->sc_chiptype == TYPE_PL2303HX) ? 383 "2303X" : "2303"); 384 385 /* 386 * USB-RSAQ1 has two interface 387 * 388 * USB-RSAQ1 | USB-RSAQ2 389 * -----------------+----------------- 390 * Interface 0 |Interface 0 391 * Interrupt(0x81) | Interrupt(0x81) 392 * -----------------+ BulkIN(0x02) 393 * Interface 1 | BulkOUT(0x83) 394 * BulkIN(0x02) | 395 * BulkOUT(0x83) | 396 */ 397 398 sc->sc_ctrl_iface_no = uaa->info.bIfaceNum; 399 sc->sc_iface_index[1] = UPLCOM_IFACE_INDEX; 400 401 iface = usbd_get_iface(uaa->device, UPLCOM_SECOND_IFACE_INDEX); 402 if (iface) { 403 id = usbd_get_interface_descriptor(iface); 404 if (id == NULL) { 405 device_printf(dev, "no interface descriptor (2)\n"); 406 goto detach; 407 } 408 sc->sc_data_iface_no = id->bInterfaceNumber; 409 sc->sc_iface_index[0] = UPLCOM_SECOND_IFACE_INDEX; 410 usbd_set_parent_iface(uaa->device, 411 UPLCOM_SECOND_IFACE_INDEX, uaa->info.bIfaceIndex); 412 } else { 413 sc->sc_data_iface_no = sc->sc_ctrl_iface_no; 414 sc->sc_iface_index[0] = UPLCOM_IFACE_INDEX; 415 } 416 417 error = usbd_transfer_setup(uaa->device, 418 sc->sc_iface_index, sc->sc_xfer, uplcom_config_data, 419 UPLCOM_N_TRANSFER, sc, &sc->sc_mtx); 420 if (error) { 421 DPRINTF("one or more missing USB endpoints, " 422 "error=%s\n", usbd_errstr(error)); 423 goto detach; 424 } 425 error = uplcom_reset(sc, uaa->device); 426 if (error) { 427 device_printf(dev, "reset failed, error=%s\n", 428 usbd_errstr(error)); 429 goto detach; 430 } 431 /* clear stall at first run */ 432 mtx_lock(&sc->sc_mtx); 433 usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_WR]); 434 usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_RD]); 435 mtx_unlock(&sc->sc_mtx); 436 437 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 438 &uplcom_callback, &sc->sc_mtx); 439 if (error) { 440 goto detach; 441 } 442 /* 443 * do the initialization during attach so that the system does not 444 * sleep during open: 445 */ 446 if (uplcom_pl2303_init(uaa->device, sc->sc_chiptype)) { 447 device_printf(dev, "init failed\n"); 448 goto detach; 449 } 450 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 451 452 return (0); 453 454detach: 455 uplcom_detach(dev); 456 return (ENXIO); 457} 458 459static int 460uplcom_detach(device_t dev) 461{ 462 struct uplcom_softc *sc = device_get_softc(dev); 463 464 DPRINTF("sc=%p\n", sc); 465 466 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom); 467 usbd_transfer_unsetup(sc->sc_xfer, UPLCOM_N_TRANSFER); 468 mtx_destroy(&sc->sc_mtx); 469 470 return (0); 471} 472 473static usb_error_t 474uplcom_reset(struct uplcom_softc *sc, struct usb_device *udev) 475{ 476 struct usb_device_request req; 477 478 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 479 req.bRequest = UPLCOM_SET_REQUEST; 480 USETW(req.wValue, 0); 481 req.wIndex[0] = sc->sc_data_iface_no; 482 req.wIndex[1] = 0; 483 USETW(req.wLength, 0); 484 485 return (usbd_do_request(udev, NULL, &req, NULL)); 486} 487 488static usb_error_t 489uplcom_pl2303_do(struct usb_device *udev, int8_t req_type, uint8_t request, 490 uint16_t value, uint16_t index, uint16_t length) 491{ 492 struct usb_device_request req; 493 usb_error_t err; 494 uint8_t buf[4]; 495 496 req.bmRequestType = req_type; 497 req.bRequest = request; 498 USETW(req.wValue, value); 499 USETW(req.wIndex, index); 500 USETW(req.wLength, length); 501 502 err = usbd_do_request(udev, NULL, &req, buf); 503 if (err) { 504 DPRINTF("error=%s\n", usbd_errstr(err)); 505 return (1); 506 } 507 return (0); 508} 509 510static int 511uplcom_pl2303_init(struct usb_device *udev, uint8_t chiptype) 512{ 513 int err; 514 515 if (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, 0, 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_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1) 520 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0) 521 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1) 522 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1) 523 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0) 524 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0)) 525 return (EIO); 526 527 if (chiptype == TYPE_PL2303HX) 528 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0); 529 else 530 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x24, 0); 531 if (err) 532 return (EIO); 533 534 if (uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 8, 0, 0) 535 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 9, 0, 0)) 536 return (EIO); 537 return (0); 538} 539 540static void 541uplcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 542{ 543 struct uplcom_softc *sc = ucom->sc_parent; 544 struct usb_device_request req; 545 546 DPRINTF("onoff = %d\n", onoff); 547 548 if (onoff) 549 sc->sc_line |= UCDC_LINE_DTR; 550 else 551 sc->sc_line &= ~UCDC_LINE_DTR; 552 553 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 554 req.bRequest = UCDC_SET_CONTROL_LINE_STATE; 555 USETW(req.wValue, sc->sc_line); 556 req.wIndex[0] = sc->sc_data_iface_no; 557 req.wIndex[1] = 0; 558 USETW(req.wLength, 0); 559 560 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 561 &req, NULL, 0, 1000); 562} 563 564static void 565uplcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff) 566{ 567 struct uplcom_softc *sc = ucom->sc_parent; 568 struct usb_device_request req; 569 570 DPRINTF("onoff = %d\n", onoff); 571 572 if (onoff) 573 sc->sc_line |= UCDC_LINE_RTS; 574 else 575 sc->sc_line &= ~UCDC_LINE_RTS; 576 577 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 578 req.bRequest = UCDC_SET_CONTROL_LINE_STATE; 579 USETW(req.wValue, sc->sc_line); 580 req.wIndex[0] = sc->sc_data_iface_no; 581 req.wIndex[1] = 0; 582 USETW(req.wLength, 0); 583 584 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 585 &req, NULL, 0, 1000); 586} 587 588static void 589uplcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff) 590{ 591 struct uplcom_softc *sc = ucom->sc_parent; 592 struct usb_device_request req; 593 uint16_t temp; 594 595 DPRINTF("onoff = %d\n", onoff); 596 597 temp = (onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF); 598 599 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 600 req.bRequest = UCDC_SEND_BREAK; 601 USETW(req.wValue, temp); 602 req.wIndex[0] = sc->sc_data_iface_no; 603 req.wIndex[1] = 0; 604 USETW(req.wLength, 0); 605 606 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 607 &req, NULL, 0, 1000); 608} 609 610static const int32_t uplcom_rates[] = { 611 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400, 612 19200, 28800, 38400, 57600, 115200, 613 /* 614 * Higher speeds are probably possible. PL2303X supports up to 615 * 6Mb and can set any rate 616 */ 617 230400, 460800, 614400, 921600, 1228800 618}; 619 620#define N_UPLCOM_RATES (sizeof(uplcom_rates)/sizeof(uplcom_rates[0])) 621 622static int 623uplcom_pre_param(struct ucom_softc *ucom, struct termios *t) 624{ 625 struct uplcom_softc *sc = ucom->sc_parent; 626 uint8_t i; 627 628 DPRINTF("\n"); 629 630 /** 631 * Check requested baud rate. 632 * 633 * The PL2303 can only set specific baud rates, up to 1228800 baud. 634 * The PL2303X can set any baud rate up to 6Mb. 635 * The PL2303HX rev. D can set any baud rate up to 12Mb. 636 * 637 * XXX: We currently cannot identify the PL2303HX rev. D, so treat 638 * it the same as the PL2303X. 639 */ 640 if (sc->sc_chiptype != TYPE_PL2303HX) { 641 for (i = 0; i < N_UPLCOM_RATES; i++) { 642 if (uplcom_rates[i] == t->c_ospeed) 643 return (0); 644 } 645 } else { 646 if (t->c_ospeed <= 6000000) 647 return (0); 648 } 649 650 DPRINTF("uplcom_param: bad baud rate (%d)\n", t->c_ospeed); 651 return (EIO); 652} 653 654static void 655uplcom_cfg_param(struct ucom_softc *ucom, struct termios *t) 656{ 657 struct uplcom_softc *sc = ucom->sc_parent; 658 struct usb_cdc_line_state ls; 659 struct usb_device_request req; 660 661 DPRINTF("sc = %p\n", sc); 662 663 bzero(&ls, sizeof(ls)); 664 665 USETDW(ls.dwDTERate, t->c_ospeed); 666 667 if (t->c_cflag & CSTOPB) { 668 ls.bCharFormat = UCDC_STOP_BIT_2; 669 } else { 670 ls.bCharFormat = UCDC_STOP_BIT_1; 671 } 672 673 if (t->c_cflag & PARENB) { 674 if (t->c_cflag & PARODD) { 675 ls.bParityType = UCDC_PARITY_ODD; 676 } else { 677 ls.bParityType = UCDC_PARITY_EVEN; 678 } 679 } else { 680 ls.bParityType = UCDC_PARITY_NONE; 681 } 682 683 switch (t->c_cflag & CSIZE) { 684 case CS5: 685 ls.bDataBits = 5; 686 break; 687 case CS6: 688 ls.bDataBits = 6; 689 break; 690 case CS7: 691 ls.bDataBits = 7; 692 break; 693 case CS8: 694 ls.bDataBits = 8; 695 break; 696 } 697 698 DPRINTF("rate=%d fmt=%d parity=%d bits=%d\n", 699 UGETDW(ls.dwDTERate), ls.bCharFormat, 700 ls.bParityType, ls.bDataBits); 701 702 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 703 req.bRequest = UCDC_SET_LINE_CODING; 704 USETW(req.wValue, 0); 705 req.wIndex[0] = sc->sc_data_iface_no; 706 req.wIndex[1] = 0; 707 USETW(req.wLength, UCDC_LINE_STATE_LENGTH); 708 709 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 710 &req, &ls, 0, 1000); 711 712 if (t->c_cflag & CRTSCTS) { 713 714 DPRINTF("crtscts = on\n"); 715 716 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 717 req.bRequest = UPLCOM_SET_REQUEST; 718 USETW(req.wValue, 0); 719 if (sc->sc_chiptype == TYPE_PL2303HX) 720 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X); 721 else 722 USETW(req.wIndex, UPLCOM_SET_CRTSCTS); 723 USETW(req.wLength, 0); 724 725 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 726 &req, NULL, 0, 1000); 727 } else { 728 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 729 req.bRequest = UPLCOM_SET_REQUEST; 730 USETW(req.wValue, 0); 731 USETW(req.wIndex, 0); 732 USETW(req.wLength, 0); 733 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 734 &req, NULL, 0, 1000); 735 } 736} 737 738static void 739uplcom_start_read(struct ucom_softc *ucom) 740{ 741 struct uplcom_softc *sc = ucom->sc_parent; 742 743 /* start interrupt endpoint */ 744 usbd_transfer_start(sc->sc_xfer[UPLCOM_INTR_DT_RD]); 745 746 /* start read endpoint */ 747 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_RD]); 748} 749 750static void 751uplcom_stop_read(struct ucom_softc *ucom) 752{ 753 struct uplcom_softc *sc = ucom->sc_parent; 754 755 /* stop interrupt endpoint */ 756 usbd_transfer_stop(sc->sc_xfer[UPLCOM_INTR_DT_RD]); 757 758 /* stop read endpoint */ 759 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_RD]); 760} 761 762static void 763uplcom_start_write(struct ucom_softc *ucom) 764{ 765 struct uplcom_softc *sc = ucom->sc_parent; 766 767 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_WR]); 768} 769 770static void 771uplcom_stop_write(struct ucom_softc *ucom) 772{ 773 struct uplcom_softc *sc = ucom->sc_parent; 774 775 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_WR]); 776} 777 778static void 779uplcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 780{ 781 struct uplcom_softc *sc = ucom->sc_parent; 782 783 DPRINTF("\n"); 784 785 *lsr = sc->sc_lsr; 786 *msr = sc->sc_msr; 787} 788 789static void 790uplcom_intr_callback(struct usb_xfer *xfer, usb_error_t error) 791{ 792 struct uplcom_softc *sc = usbd_xfer_softc(xfer); 793 struct usb_page_cache *pc; 794 uint8_t buf[9]; 795 int actlen; 796 797 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 798 799 switch (USB_GET_STATE(xfer)) { 800 case USB_ST_TRANSFERRED: 801 802 DPRINTF("actlen = %u\n", actlen); 803 804 if (actlen >= 9) { 805 806 pc = usbd_xfer_get_frame(xfer, 0); 807 usbd_copy_out(pc, 0, buf, sizeof(buf)); 808 809 DPRINTF("status = 0x%02x\n", buf[8]); 810 811 sc->sc_lsr = 0; 812 sc->sc_msr = 0; 813 814 if (buf[8] & RSAQ_STATUS_CTS) { 815 sc->sc_msr |= SER_CTS; 816 } 817 if (buf[8] & RSAQ_STATUS_DSR) { 818 sc->sc_msr |= SER_DSR; 819 } 820 if (buf[8] & RSAQ_STATUS_DCD) { 821 sc->sc_msr |= SER_DCD; 822 } 823 ucom_status_change(&sc->sc_ucom); 824 } 825 case USB_ST_SETUP: 826tr_setup: 827 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 828 usbd_transfer_submit(xfer); 829 return; 830 831 default: /* Error */ 832 if (error != USB_ERR_CANCELLED) { 833 /* try to clear stall first */ 834 usbd_xfer_set_stall(xfer); 835 goto tr_setup; 836 } 837 return; 838 } 839} 840 841static void 842uplcom_write_callback(struct usb_xfer *xfer, usb_error_t error) 843{ 844 struct uplcom_softc *sc = usbd_xfer_softc(xfer); 845 struct usb_page_cache *pc; 846 uint32_t actlen; 847 848 switch (USB_GET_STATE(xfer)) { 849 case USB_ST_SETUP: 850 case USB_ST_TRANSFERRED: 851tr_setup: 852 pc = usbd_xfer_get_frame(xfer, 0); 853 if (ucom_get_data(&sc->sc_ucom, pc, 0, 854 UPLCOM_BULK_BUF_SIZE, &actlen)) { 855 856 DPRINTF("actlen = %d\n", actlen); 857 858 usbd_xfer_set_frame_len(xfer, 0, actlen); 859 usbd_transfer_submit(xfer); 860 } 861 return; 862 863 default: /* Error */ 864 if (error != USB_ERR_CANCELLED) { 865 /* try to clear stall first */ 866 usbd_xfer_set_stall(xfer); 867 goto tr_setup; 868 } 869 return; 870 } 871} 872 873static void 874uplcom_read_callback(struct usb_xfer *xfer, usb_error_t error) 875{ 876 struct uplcom_softc *sc = usbd_xfer_softc(xfer); 877 struct usb_page_cache *pc; 878 int actlen; 879 880 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 881 882 switch (USB_GET_STATE(xfer)) { 883 case USB_ST_TRANSFERRED: 884 pc = usbd_xfer_get_frame(xfer, 0); 885 ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 886 887 case USB_ST_SETUP: 888tr_setup: 889 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 890 usbd_transfer_submit(xfer); 891 return; 892 893 default: /* Error */ 894 if (error != USB_ERR_CANCELLED) { 895 /* try to clear stall first */ 896 usbd_xfer_set_stall(xfer); 897 goto tr_setup; 898 } 899 return; 900 } 901} 902 903static void 904uplcom_poll(struct ucom_softc *ucom) 905{ 906 struct uplcom_softc *sc = ucom->sc_parent; 907 usbd_transfer_poll(sc->sc_xfer, UPLCOM_N_TRANSFER); 908} 909