1 /* $NetBSD: uplcom.c,v 1.21 2001/11/13 06:24:56 lukem Exp $ */
7 * Copyright (c) 2001-2003, 2005 Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
33 * Copyright (c) 2001 The NetBSD Foundation, Inc.
34 * All rights reserved.
36 * This code is derived from software contributed to The NetBSD Foundation
37 * by Ichiro FUKUHARA (ichiro@ichiro.org).
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
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.
48 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
49 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
50 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
51 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
52 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
53 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
54 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
55 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
56 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
57 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
58 * POSSIBILITY OF SUCH DAMAGE.
62 * This driver supports several USB-to-RS232 serial adapters driven by
63 * Prolific PL-2303, PL-2303X and probably PL-2303HX USB-to-RS232
64 * bridge chip. The adapters are sold under many different brand
67 * Datasheets are available at Prolific www site at
68 * http://www.prolific.com.tw. The datasheets don't contain full
69 * programming information for the chip.
71 * PL-2303HX is probably programmed the same as PL-2303X.
73 * There are several differences between PL-2303 and PL-2303(H)X.
74 * PL-2303(H)X can do higher bitrate in bulk mode, has _probably_
75 * different command for controlling CRTSCTS and needs special
76 * sequence of commands for initialization which aren't also
77 * documented in the datasheet.
80 #include <sys/stdint.h>
81 #include <sys/stddef.h>
82 #include <sys/param.h>
83 #include <sys/queue.h>
84 #include <sys/types.h>
85 #include <sys/systm.h>
86 #include <sys/kernel.h>
88 #include <sys/module.h>
90 #include <sys/mutex.h>
91 #include <sys/condvar.h>
92 #include <sys/sysctl.h>
94 #include <sys/unistd.h>
95 #include <sys/callout.h>
96 #include <sys/malloc.h>
99 #include <dev/usb/usb.h>
100 #include <dev/usb/usbdi.h>
101 #include <dev/usb/usbdi_util.h>
102 #include <dev/usb/usb_cdc.h>
105 #define USB_DEBUG_VAR uplcom_debug
106 #include <dev/usb/usb_debug.h>
107 #include <dev/usb/usb_process.h>
109 #include <dev/usb/serial/usb_serial.h>
112 static int uplcom_debug = 0;
114 static SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
115 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RWTUN,
116 &uplcom_debug, 0, "Debug level");
119 #define UPLCOM_MODVER 1 /* module version */
121 #define UPLCOM_CONFIG_INDEX 0
122 #define UPLCOM_IFACE_INDEX 0
123 #define UPLCOM_SECOND_IFACE_INDEX 1
125 #ifndef UPLCOM_INTR_INTERVAL
126 #define UPLCOM_INTR_INTERVAL 0 /* default */
129 #define UPLCOM_BULK_BUF_SIZE 1024 /* bytes */
131 #define UPLCOM_SET_REQUEST 0x01
132 #define UPLCOM_SET_CRTSCTS 0x41
133 #define UPLCOM_SET_CRTSCTS_PL2303X 0x61
134 #define RSAQ_STATUS_CTS 0x80
135 #define RSAQ_STATUS_DSR 0x02
136 #define RSAQ_STATUS_DCD 0x01
138 #define TYPE_PL2303 0
139 #define TYPE_PL2303HX 1
148 struct uplcom_softc {
149 struct ucom_super_softc sc_super_ucom;
150 struct ucom_softc sc_ucom;
152 struct usb_xfer *sc_xfer[UPLCOM_N_TRANSFER];
153 struct usb_device *sc_udev;
158 uint8_t sc_lsr; /* local status register */
159 uint8_t sc_msr; /* uplcom status register */
160 uint8_t sc_chiptype; /* type of chip */
161 uint8_t sc_ctrl_iface_no;
162 uint8_t sc_data_iface_no;
163 uint8_t sc_iface_index[2];
168 static usb_error_t uplcom_reset(struct uplcom_softc *, struct usb_device *);
169 static usb_error_t uplcom_pl2303_do(struct usb_device *, uint8_t, uint8_t,
170 uint16_t, uint16_t, uint16_t);
171 static int uplcom_pl2303_init(struct usb_device *, uint8_t);
172 static void uplcom_free(struct ucom_softc *);
173 static void uplcom_cfg_set_dtr(struct ucom_softc *, uint8_t);
174 static void uplcom_cfg_set_rts(struct ucom_softc *, uint8_t);
175 static void uplcom_cfg_set_break(struct ucom_softc *, uint8_t);
176 static int uplcom_pre_param(struct ucom_softc *, struct termios *);
177 static void uplcom_cfg_param(struct ucom_softc *, struct termios *);
178 static void uplcom_start_read(struct ucom_softc *);
179 static void uplcom_stop_read(struct ucom_softc *);
180 static void uplcom_start_write(struct ucom_softc *);
181 static void uplcom_stop_write(struct ucom_softc *);
182 static void uplcom_cfg_get_status(struct ucom_softc *, uint8_t *,
184 static void uplcom_poll(struct ucom_softc *ucom);
186 static device_probe_t uplcom_probe;
187 static device_attach_t uplcom_attach;
188 static device_detach_t uplcom_detach;
189 static void uplcom_free_softc(struct uplcom_softc *);
191 static usb_callback_t uplcom_intr_callback;
192 static usb_callback_t uplcom_write_callback;
193 static usb_callback_t uplcom_read_callback;
195 static const struct usb_config uplcom_config_data[UPLCOM_N_TRANSFER] = {
197 [UPLCOM_BULK_DT_WR] = {
199 .endpoint = UE_ADDR_ANY,
200 .direction = UE_DIR_OUT,
201 .bufsize = UPLCOM_BULK_BUF_SIZE,
202 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
203 .callback = &uplcom_write_callback,
207 [UPLCOM_BULK_DT_RD] = {
209 .endpoint = UE_ADDR_ANY,
210 .direction = UE_DIR_IN,
211 .bufsize = UPLCOM_BULK_BUF_SIZE,
212 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
213 .callback = &uplcom_read_callback,
217 [UPLCOM_INTR_DT_RD] = {
218 .type = UE_INTERRUPT,
219 .endpoint = UE_ADDR_ANY,
220 .direction = UE_DIR_IN,
221 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
222 .bufsize = 0, /* use wMaxPacketSize */
223 .callback = &uplcom_intr_callback,
228 static struct ucom_callback uplcom_callback = {
229 .ucom_cfg_get_status = &uplcom_cfg_get_status,
230 .ucom_cfg_set_dtr = &uplcom_cfg_set_dtr,
231 .ucom_cfg_set_rts = &uplcom_cfg_set_rts,
232 .ucom_cfg_set_break = &uplcom_cfg_set_break,
233 .ucom_cfg_param = &uplcom_cfg_param,
234 .ucom_pre_param = &uplcom_pre_param,
235 .ucom_start_read = &uplcom_start_read,
236 .ucom_stop_read = &uplcom_stop_read,
237 .ucom_start_write = &uplcom_start_write,
238 .ucom_stop_write = &uplcom_stop_write,
239 .ucom_poll = &uplcom_poll,
240 .ucom_free = &uplcom_free,
243 #define UPLCOM_DEV(v,p) \
244 { USB_VENDOR(USB_VENDOR_##v), USB_PRODUCT(USB_PRODUCT_##v##_##p) }
246 static const STRUCT_USB_HOST_ID uplcom_devs[] = {
247 UPLCOM_DEV(ACERP, S81), /* BenQ S81 phone */
248 UPLCOM_DEV(ADLINK, ND6530), /* ADLINK ND-6530 USB-Serial */
249 UPLCOM_DEV(ALCATEL, OT535), /* Alcatel One Touch 535/735 */
250 UPLCOM_DEV(ALCOR, AU9720), /* Alcor AU9720 USB 2.0-RS232 */
251 UPLCOM_DEV(ANCHOR, SERIAL), /* Anchor Serial adapter */
252 UPLCOM_DEV(ATEN, UC232A), /* PLANEX USB-RS232 URS-03 */
253 UPLCOM_DEV(BELKIN, F5U257), /* Belkin F5U257 USB to Serial */
254 UPLCOM_DEV(COREGA, CGUSBRS232R), /* Corega CG-USBRS232R */
255 UPLCOM_DEV(EPSON, CRESSI_EDY), /* Cressi Edy diving computer */
256 UPLCOM_DEV(EPSON, N2ITION3), /* Zeagle N2iTion3 diving computer */
257 UPLCOM_DEV(ELECOM, UCSGT), /* ELECOM UC-SGT Serial Adapter */
258 UPLCOM_DEV(ELECOM, UCSGT0), /* ELECOM UC-SGT Serial Adapter */
259 UPLCOM_DEV(HAL, IMR001), /* HAL Corporation Crossam2+USB */
260 UPLCOM_DEV(HP, LD220), /* HP LD220 POS Display */
261 UPLCOM_DEV(IODATA, USBRSAQ), /* I/O DATA USB-RSAQ */
262 UPLCOM_DEV(IODATA, USBRSAQ5), /* I/O DATA USB-RSAQ5 */
263 UPLCOM_DEV(ITEGNO, WM1080A), /* iTegno WM1080A GSM/GFPRS modem */
264 UPLCOM_DEV(ITEGNO, WM2080A), /* iTegno WM2080A CDMA modem */
265 UPLCOM_DEV(LEADTEK, 9531), /* Leadtek 9531 GPS */
266 UPLCOM_DEV(MICROSOFT, 700WX), /* Microsoft Palm 700WX */
267 UPLCOM_DEV(MOBILEACTION, MA620), /* Mobile Action MA-620 Infrared Adapter */
268 UPLCOM_DEV(NETINDEX, WS002IN), /* Willcom W-S002IN */
269 UPLCOM_DEV(NOKIA2, CA42), /* Nokia CA-42 cable */
270 UPLCOM_DEV(OTI, DKU5), /* OTI DKU-5 cable */
271 UPLCOM_DEV(PANASONIC, TYTP50P6S), /* Panasonic TY-TP50P6-S flat screen */
272 UPLCOM_DEV(PLX, CA42), /* PLX CA-42 clone cable */
273 UPLCOM_DEV(PROLIFIC, ALLTRONIX_GPRS), /* Alltronix ACM003U00 modem */
274 UPLCOM_DEV(PROLIFIC, ALDIGA_AL11U), /* AlDiga AL-11U modem */
275 UPLCOM_DEV(PROLIFIC, DCU11), /* DCU-11 Phone Cable */
276 UPLCOM_DEV(PROLIFIC, HCR331), /* HCR331 Card Reader */
277 UPLCOM_DEV(PROLIFIC, MICROMAX_610U), /* Micromax 610U modem */
278 UPLCOM_DEV(PROLIFIC, MOTOROLA), /* Motorola cable */
279 UPLCOM_DEV(PROLIFIC, PHAROS), /* Prolific Pharos */
280 UPLCOM_DEV(PROLIFIC, PL2303), /* Generic adapter */
281 UPLCOM_DEV(PROLIFIC, RSAQ2), /* I/O DATA USB-RSAQ2 */
282 UPLCOM_DEV(PROLIFIC, RSAQ3), /* I/O DATA USB-RSAQ3 */
283 UPLCOM_DEV(PROLIFIC, UIC_MSR206), /* UIC MSR206 Card Reader */
284 UPLCOM_DEV(PROLIFIC2, PL2303), /* Prolific adapter */
285 UPLCOM_DEV(RADIOSHACK, USBCABLE), /* Radio Shack USB Adapter */
286 UPLCOM_DEV(RATOC, REXUSB60), /* RATOC REX-USB60 */
287 UPLCOM_DEV(SAGEM, USBSERIAL), /* Sagem USB-Serial Controller */
288 UPLCOM_DEV(SAMSUNG, I330), /* Samsung I330 phone cradle */
289 UPLCOM_DEV(SANWA, KB_USB2), /* Sanwa KB-USB2 Multimeter cable */
290 UPLCOM_DEV(SIEMENS3, EF81), /* Siemens EF81 */
291 UPLCOM_DEV(SIEMENS3, SX1), /* Siemens SX1 */
292 UPLCOM_DEV(SIEMENS3, X65), /* Siemens X65 */
293 UPLCOM_DEV(SIEMENS3, X75), /* Siemens X75 */
294 UPLCOM_DEV(SITECOM, SERIAL), /* Sitecom USB to Serial */
295 UPLCOM_DEV(SMART, PL2303), /* SMART Technologies USB to Serial */
296 UPLCOM_DEV(SONY, QN3), /* Sony QN3 phone cable */
297 UPLCOM_DEV(SONYERICSSON, DATAPILOT), /* Sony Ericsson Datapilot */
298 UPLCOM_DEV(SONYERICSSON, DCU10), /* Sony Ericsson DCU-10 Cable */
299 UPLCOM_DEV(SOURCENEXT, KEIKAI8), /* SOURCENEXT KeikaiDenwa 8 */
300 UPLCOM_DEV(SOURCENEXT, KEIKAI8_CHG), /* SOURCENEXT KeikaiDenwa 8 with charger */
301 UPLCOM_DEV(SPEEDDRAGON, MS3303H), /* Speed Dragon USB-Serial */
302 UPLCOM_DEV(SYNTECH, CPT8001C), /* Syntech CPT-8001C Barcode scanner */
303 UPLCOM_DEV(TDK, UHA6400), /* TDK USB-PHS Adapter UHA6400 */
304 UPLCOM_DEV(TDK, UPA9664), /* TDK USB-PHS Adapter UPA9664 */
305 UPLCOM_DEV(TRIPPLITE, U209), /* Tripp-Lite U209-000-R USB to Serial */
306 UPLCOM_DEV(YCCABLE, PL2303), /* YC Cable USB-Serial */
310 static device_method_t uplcom_methods[] = {
311 DEVMETHOD(device_probe, uplcom_probe),
312 DEVMETHOD(device_attach, uplcom_attach),
313 DEVMETHOD(device_detach, uplcom_detach),
317 static devclass_t uplcom_devclass;
319 static driver_t uplcom_driver = {
321 .methods = uplcom_methods,
322 .size = sizeof(struct uplcom_softc),
325 DRIVER_MODULE(uplcom, uhub, uplcom_driver, uplcom_devclass, NULL, 0);
326 MODULE_DEPEND(uplcom, ucom, 1, 1, 1);
327 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
328 MODULE_VERSION(uplcom, UPLCOM_MODVER);
329 USB_PNP_HOST_INFO(uplcom_devs);
332 uplcom_probe(device_t dev)
334 struct usb_attach_arg *uaa = device_get_ivars(dev);
338 if (uaa->usb_mode != USB_MODE_HOST) {
341 if (uaa->info.bConfigIndex != UPLCOM_CONFIG_INDEX) {
344 if (uaa->info.bIfaceIndex != UPLCOM_IFACE_INDEX) {
347 return (usbd_lookup_id_by_uaa(uplcom_devs, sizeof(uplcom_devs), uaa));
351 uplcom_attach(device_t dev)
353 struct usb_attach_arg *uaa = device_get_ivars(dev);
354 struct uplcom_softc *sc = device_get_softc(dev);
355 struct usb_interface *iface;
356 struct usb_interface_descriptor *id;
357 struct usb_device_descriptor *dd;
362 device_set_usb_desc(dev);
363 mtx_init(&sc->sc_mtx, "uplcom", NULL, MTX_DEF);
364 ucom_ref(&sc->sc_super_ucom);
366 DPRINTF("sc = %p\n", sc);
368 sc->sc_udev = uaa->device;
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;
377 sc->sc_chiptype = TYPE_PL2303;
379 DPRINTF("chiptype: %s\n",
380 (sc->sc_chiptype == TYPE_PL2303HX) ?
384 * USB-RSAQ1 has two interface
386 * USB-RSAQ1 | USB-RSAQ2
387 * -----------------+-----------------
388 * Interface 0 |Interface 0
389 * Interrupt(0x81) | Interrupt(0x81)
390 * -----------------+ BulkIN(0x02)
391 * Interface 1 | BulkOUT(0x83)
396 sc->sc_ctrl_iface_no = uaa->info.bIfaceNum;
397 sc->sc_iface_index[1] = UPLCOM_IFACE_INDEX;
399 iface = usbd_get_iface(uaa->device, UPLCOM_SECOND_IFACE_INDEX);
401 id = usbd_get_interface_descriptor(iface);
403 device_printf(dev, "no interface descriptor (2)\n");
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);
411 sc->sc_data_iface_no = sc->sc_ctrl_iface_no;
412 sc->sc_iface_index[0] = UPLCOM_IFACE_INDEX;
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);
419 DPRINTF("one or more missing USB endpoints, "
420 "error=%s\n", usbd_errstr(error));
423 error = uplcom_reset(sc, uaa->device);
425 device_printf(dev, "reset failed, error=%s\n",
430 if (sc->sc_chiptype != TYPE_PL2303HX) {
431 /* HX variants seem to lock up after a clear stall request. */
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);
437 if (uplcom_pl2303_do(sc->sc_udev, UT_WRITE_VENDOR_DEVICE,
438 UPLCOM_SET_REQUEST, 8, 0, 0) ||
439 uplcom_pl2303_do(sc->sc_udev, UT_WRITE_VENDOR_DEVICE,
440 UPLCOM_SET_REQUEST, 9, 0, 0)) {
445 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
446 &uplcom_callback, &sc->sc_mtx);
451 * do the initialization during attach so that the system does not
454 if (uplcom_pl2303_init(uaa->device, sc->sc_chiptype)) {
455 device_printf(dev, "init failed\n");
458 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
468 uplcom_detach(device_t dev)
470 struct uplcom_softc *sc = device_get_softc(dev);
472 DPRINTF("sc=%p\n", sc);
474 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
475 usbd_transfer_unsetup(sc->sc_xfer, UPLCOM_N_TRANSFER);
477 device_claim_softc(dev);
479 uplcom_free_softc(sc);
484 UCOM_UNLOAD_DRAIN(uplcom);
487 uplcom_free_softc(struct uplcom_softc *sc)
489 if (ucom_unref(&sc->sc_super_ucom)) {
490 mtx_destroy(&sc->sc_mtx);
491 device_free_softc(sc);
496 uplcom_free(struct ucom_softc *ucom)
498 uplcom_free_softc(ucom->sc_parent);
502 uplcom_reset(struct uplcom_softc *sc, struct usb_device *udev)
504 struct usb_device_request req;
506 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
507 req.bRequest = UPLCOM_SET_REQUEST;
508 USETW(req.wValue, 0);
509 req.wIndex[0] = sc->sc_data_iface_no;
511 USETW(req.wLength, 0);
513 return (usbd_do_request(udev, NULL, &req, NULL));
517 uplcom_pl2303_do(struct usb_device *udev, uint8_t req_type, uint8_t request,
518 uint16_t value, uint16_t index, uint16_t length)
520 struct usb_device_request req;
524 req.bmRequestType = req_type;
525 req.bRequest = request;
526 USETW(req.wValue, value);
527 USETW(req.wIndex, index);
528 USETW(req.wLength, length);
530 err = usbd_do_request(udev, NULL, &req, buf);
532 DPRINTF("error=%s\n", usbd_errstr(err));
539 uplcom_pl2303_init(struct usb_device *udev, uint8_t chiptype)
543 if (uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
544 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 0, 0)
545 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
546 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
547 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
548 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0)
549 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
550 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
551 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0)
552 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0))
555 if (chiptype == TYPE_PL2303HX)
556 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0);
558 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x24, 0);
566 uplcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
568 struct uplcom_softc *sc = ucom->sc_parent;
569 struct usb_device_request req;
571 DPRINTF("onoff = %d\n", onoff);
574 sc->sc_line |= UCDC_LINE_DTR;
576 sc->sc_line &= ~UCDC_LINE_DTR;
578 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
579 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
580 USETW(req.wValue, sc->sc_line);
581 req.wIndex[0] = sc->sc_data_iface_no;
583 USETW(req.wLength, 0);
585 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
586 &req, NULL, 0, 1000);
590 uplcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
592 struct uplcom_softc *sc = ucom->sc_parent;
593 struct usb_device_request req;
595 DPRINTF("onoff = %d\n", onoff);
598 sc->sc_line |= UCDC_LINE_RTS;
600 sc->sc_line &= ~UCDC_LINE_RTS;
602 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
603 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
604 USETW(req.wValue, sc->sc_line);
605 req.wIndex[0] = sc->sc_data_iface_no;
607 USETW(req.wLength, 0);
609 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
610 &req, NULL, 0, 1000);
614 uplcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
616 struct uplcom_softc *sc = ucom->sc_parent;
617 struct usb_device_request req;
620 DPRINTF("onoff = %d\n", onoff);
622 temp = (onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
624 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
625 req.bRequest = UCDC_SEND_BREAK;
626 USETW(req.wValue, temp);
627 req.wIndex[0] = sc->sc_data_iface_no;
629 USETW(req.wLength, 0);
631 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
632 &req, NULL, 0, 1000);
635 static const uint32_t uplcom_rates[] = {
636 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
637 19200, 28800, 38400, 57600, 115200,
639 * Higher speeds are probably possible. PL2303X supports up to
640 * 6Mb and can set any rate
642 230400, 460800, 614400, 921600, 1228800
645 #define N_UPLCOM_RATES nitems(uplcom_rates)
648 uplcom_pre_param(struct ucom_softc *ucom, struct termios *t)
650 struct uplcom_softc *sc = ucom->sc_parent;
656 * Check requested baud rate.
658 * The PL2303 can only set specific baud rates, up to 1228800 baud.
659 * The PL2303X can set any baud rate up to 6Mb.
660 * The PL2303HX rev. D can set any baud rate up to 12Mb.
662 * XXX: We currently cannot identify the PL2303HX rev. D, so treat
663 * it the same as the PL2303X.
665 if (sc->sc_chiptype != TYPE_PL2303HX) {
666 for (i = 0; i < N_UPLCOM_RATES; i++) {
667 if (uplcom_rates[i] == t->c_ospeed)
671 if (t->c_ospeed <= 6000000)
675 DPRINTF("uplcom_param: bad baud rate (%d)\n", t->c_ospeed);
680 uplcom_cfg_param(struct ucom_softc *ucom, struct termios *t)
682 struct uplcom_softc *sc = ucom->sc_parent;
683 struct usb_cdc_line_state ls;
684 struct usb_device_request req;
686 DPRINTF("sc = %p\n", sc);
688 memset(&ls, 0, sizeof(ls));
690 USETDW(ls.dwDTERate, t->c_ospeed);
692 if (t->c_cflag & CSTOPB) {
693 ls.bCharFormat = UCDC_STOP_BIT_2;
695 ls.bCharFormat = UCDC_STOP_BIT_1;
698 if (t->c_cflag & PARENB) {
699 if (t->c_cflag & PARODD) {
700 ls.bParityType = UCDC_PARITY_ODD;
702 ls.bParityType = UCDC_PARITY_EVEN;
705 ls.bParityType = UCDC_PARITY_NONE;
708 switch (t->c_cflag & CSIZE) {
723 DPRINTF("rate=%d fmt=%d parity=%d bits=%d\n",
724 UGETDW(ls.dwDTERate), ls.bCharFormat,
725 ls.bParityType, ls.bDataBits);
727 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
728 req.bRequest = UCDC_SET_LINE_CODING;
729 USETW(req.wValue, 0);
730 req.wIndex[0] = sc->sc_data_iface_no;
732 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
734 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
737 if (t->c_cflag & CRTSCTS) {
739 DPRINTF("crtscts = on\n");
741 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
742 req.bRequest = UPLCOM_SET_REQUEST;
743 USETW(req.wValue, 0);
744 if (sc->sc_chiptype == TYPE_PL2303HX)
745 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
747 USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
748 USETW(req.wLength, 0);
750 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
751 &req, NULL, 0, 1000);
753 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
754 req.bRequest = UPLCOM_SET_REQUEST;
755 USETW(req.wValue, 0);
756 USETW(req.wIndex, 0);
757 USETW(req.wLength, 0);
758 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
759 &req, NULL, 0, 1000);
764 uplcom_start_read(struct ucom_softc *ucom)
766 struct uplcom_softc *sc = ucom->sc_parent;
768 /* start interrupt endpoint */
769 usbd_transfer_start(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
771 /* start read endpoint */
772 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
776 uplcom_stop_read(struct ucom_softc *ucom)
778 struct uplcom_softc *sc = ucom->sc_parent;
780 /* stop interrupt endpoint */
781 usbd_transfer_stop(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
783 /* stop read endpoint */
784 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
788 uplcom_start_write(struct ucom_softc *ucom)
790 struct uplcom_softc *sc = ucom->sc_parent;
792 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
796 uplcom_stop_write(struct ucom_softc *ucom)
798 struct uplcom_softc *sc = ucom->sc_parent;
800 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
804 uplcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
806 struct uplcom_softc *sc = ucom->sc_parent;
810 /* XXX Note: sc_lsr is always zero */
816 uplcom_intr_callback(struct usb_xfer *xfer, usb_error_t error)
818 struct uplcom_softc *sc = usbd_xfer_softc(xfer);
819 struct usb_page_cache *pc;
823 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
825 switch (USB_GET_STATE(xfer)) {
826 case USB_ST_TRANSFERRED:
828 DPRINTF("actlen = %u\n", actlen);
832 pc = usbd_xfer_get_frame(xfer, 0);
833 usbd_copy_out(pc, 0, buf, sizeof(buf));
835 DPRINTF("status = 0x%02x\n", buf[8]);
840 if (buf[8] & RSAQ_STATUS_CTS) {
841 sc->sc_msr |= SER_CTS;
843 if (buf[8] & RSAQ_STATUS_DSR) {
844 sc->sc_msr |= SER_DSR;
846 if (buf[8] & RSAQ_STATUS_DCD) {
847 sc->sc_msr |= SER_DCD;
849 ucom_status_change(&sc->sc_ucom);
853 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
854 usbd_transfer_submit(xfer);
858 if (error != USB_ERR_CANCELLED) {
859 /* try to clear stall first */
860 usbd_xfer_set_stall(xfer);
868 uplcom_write_callback(struct usb_xfer *xfer, usb_error_t error)
870 struct uplcom_softc *sc = usbd_xfer_softc(xfer);
871 struct usb_page_cache *pc;
874 switch (USB_GET_STATE(xfer)) {
876 case USB_ST_TRANSFERRED:
878 pc = usbd_xfer_get_frame(xfer, 0);
879 if (ucom_get_data(&sc->sc_ucom, pc, 0,
880 UPLCOM_BULK_BUF_SIZE, &actlen)) {
882 DPRINTF("actlen = %d\n", actlen);
884 usbd_xfer_set_frame_len(xfer, 0, actlen);
885 usbd_transfer_submit(xfer);
890 if (error != USB_ERR_CANCELLED) {
891 /* try to clear stall first */
892 usbd_xfer_set_stall(xfer);
900 uplcom_read_callback(struct usb_xfer *xfer, usb_error_t error)
902 struct uplcom_softc *sc = usbd_xfer_softc(xfer);
903 struct usb_page_cache *pc;
906 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
908 switch (USB_GET_STATE(xfer)) {
909 case USB_ST_TRANSFERRED:
910 pc = usbd_xfer_get_frame(xfer, 0);
911 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
915 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
916 usbd_transfer_submit(xfer);
920 if (error != USB_ERR_CANCELLED) {
921 /* try to clear stall first */
922 usbd_xfer_set_stall(xfer);
930 uplcom_poll(struct ucom_softc *ucom)
932 struct uplcom_softc *sc = ucom->sc_parent;
933 usbd_transfer_poll(sc->sc_xfer, UPLCOM_N_TRANSFER);