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.
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.
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.
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
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.
78 * PL-2303HX is probably programmed the same as PL-2303X.
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.
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>
95 #include <sys/module.h>
97 #include <sys/mutex.h>
98 #include <sys/condvar.h>
99 #include <sys/sysctl.h>
101 #include <sys/unistd.h>
102 #include <sys/callout.h>
103 #include <sys/malloc.h>
104 #include <sys/priv.h>
106 #include <dev/usb/usb.h>
107 #include <dev/usb/usbdi.h>
108 #include <dev/usb/usbdi_util.h>
109 #include <dev/usb/usb_cdc.h>
112 #define USB_DEBUG_VAR uplcom_debug
113 #include <dev/usb/usb_debug.h>
114 #include <dev/usb/usb_process.h>
116 #include <dev/usb/serial/usb_serial.h>
119 static int uplcom_debug = 0;
121 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
122 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW,
123 &uplcom_debug, 0, "Debug level");
126 #define UPLCOM_MODVER 1 /* module version */
128 #define UPLCOM_CONFIG_INDEX 0
129 #define UPLCOM_IFACE_INDEX 0
130 #define UPLCOM_SECOND_IFACE_INDEX 1
132 #ifndef UPLCOM_INTR_INTERVAL
133 #define UPLCOM_INTR_INTERVAL 0 /* default */
136 #define UPLCOM_BULK_BUF_SIZE 1024 /* bytes */
138 #define UPLCOM_SET_REQUEST 0x01
139 #define UPLCOM_SET_CRTSCTS 0x41
140 #define UPLCOM_SET_CRTSCTS_PL2303X 0x61
141 #define RSAQ_STATUS_CTS 0x80
142 #define RSAQ_STATUS_DSR 0x02
143 #define RSAQ_STATUS_DCD 0x01
145 #define TYPE_PL2303 0
146 #define TYPE_PL2303HX 1
155 struct uplcom_softc {
156 struct ucom_super_softc sc_super_ucom;
157 struct ucom_softc sc_ucom;
159 struct usb_xfer *sc_xfer[UPLCOM_N_TRANSFER];
160 struct usb_device *sc_udev;
165 uint8_t sc_lsr; /* local status register */
166 uint8_t sc_msr; /* uplcom status register */
167 uint8_t sc_chiptype; /* type of chip */
168 uint8_t sc_ctrl_iface_no;
169 uint8_t sc_data_iface_no;
170 uint8_t sc_iface_index[2];
175 static usb_error_t uplcom_reset(struct uplcom_softc *, struct usb_device *);
176 static usb_error_t uplcom_pl2303_do(struct usb_device *, int8_t, uint8_t,
177 uint16_t, uint16_t, uint16_t);
178 static int uplcom_pl2303_init(struct usb_device *, uint8_t);
179 static void uplcom_free(struct ucom_softc *);
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 *,
191 static void uplcom_poll(struct ucom_softc *ucom);
193 static device_probe_t uplcom_probe;
194 static device_attach_t uplcom_attach;
195 static device_detach_t uplcom_detach;
196 static void uplcom_free_softc(struct uplcom_softc *);
198 static usb_callback_t uplcom_intr_callback;
199 static usb_callback_t uplcom_write_callback;
200 static usb_callback_t uplcom_read_callback;
202 static const struct usb_config uplcom_config_data[UPLCOM_N_TRANSFER] = {
204 [UPLCOM_BULK_DT_WR] = {
206 .endpoint = UE_ADDR_ANY,
207 .direction = UE_DIR_OUT,
208 .bufsize = UPLCOM_BULK_BUF_SIZE,
209 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
210 .callback = &uplcom_write_callback,
214 [UPLCOM_BULK_DT_RD] = {
216 .endpoint = UE_ADDR_ANY,
217 .direction = UE_DIR_IN,
218 .bufsize = UPLCOM_BULK_BUF_SIZE,
219 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
220 .callback = &uplcom_read_callback,
224 [UPLCOM_INTR_DT_RD] = {
225 .type = UE_INTERRUPT,
226 .endpoint = UE_ADDR_ANY,
227 .direction = UE_DIR_IN,
228 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
229 .bufsize = 0, /* use wMaxPacketSize */
230 .callback = &uplcom_intr_callback,
235 static struct ucom_callback uplcom_callback = {
236 .ucom_cfg_get_status = &uplcom_cfg_get_status,
237 .ucom_cfg_set_dtr = &uplcom_cfg_set_dtr,
238 .ucom_cfg_set_rts = &uplcom_cfg_set_rts,
239 .ucom_cfg_set_break = &uplcom_cfg_set_break,
240 .ucom_cfg_param = &uplcom_cfg_param,
241 .ucom_pre_param = &uplcom_pre_param,
242 .ucom_start_read = &uplcom_start_read,
243 .ucom_stop_read = &uplcom_stop_read,
244 .ucom_start_write = &uplcom_start_write,
245 .ucom_stop_write = &uplcom_stop_write,
246 .ucom_poll = &uplcom_poll,
247 .ucom_free = &uplcom_free,
250 #define UPLCOM_DEV(v,p) \
251 { USB_VENDOR(USB_VENDOR_##v), USB_PRODUCT(USB_PRODUCT_##v##_##p) }
253 static const STRUCT_USB_HOST_ID uplcom_devs[] = {
254 UPLCOM_DEV(ACERP, S81), /* BenQ S81 phone */
255 UPLCOM_DEV(ADLINK, ND6530), /* ADLINK ND-6530 USB-Serial */
256 UPLCOM_DEV(ALCATEL, OT535), /* Alcatel One Touch 535/735 */
257 UPLCOM_DEV(ALCOR, AU9720), /* Alcor AU9720 USB 2.0-RS232 */
258 UPLCOM_DEV(ANCHOR, SERIAL), /* Anchor Serial adapter */
259 UPLCOM_DEV(ATEN, UC232A), /* PLANEX USB-RS232 URS-03 */
260 UPLCOM_DEV(BELKIN, F5U257), /* Belkin F5U257 USB to Serial */
261 UPLCOM_DEV(COREGA, CGUSBRS232R), /* Corega CG-USBRS232R */
262 UPLCOM_DEV(EPSON, CRESSI_EDY), /* Cressi Edy diving computer */
263 UPLCOM_DEV(EPSON, N2ITION3), /* Zeagle N2iTion3 diving computer */
264 UPLCOM_DEV(ELECOM, UCSGT), /* ELECOM UC-SGT Serial Adapter */
265 UPLCOM_DEV(ELECOM, UCSGT0), /* ELECOM UC-SGT Serial Adapter */
266 UPLCOM_DEV(HAL, IMR001), /* HAL Corporation Crossam2+USB */
267 UPLCOM_DEV(HP, LD220), /* HP LD220 POS Display */
268 UPLCOM_DEV(IODATA, USBRSAQ), /* I/O DATA USB-RSAQ */
269 UPLCOM_DEV(IODATA, USBRSAQ5), /* I/O DATA USB-RSAQ5 */
270 UPLCOM_DEV(ITEGNO, WM1080A), /* iTegno WM1080A GSM/GFPRS modem */
271 UPLCOM_DEV(ITEGNO, WM2080A), /* iTegno WM2080A CDMA modem */
272 UPLCOM_DEV(LEADTEK, 9531), /* Leadtek 9531 GPS */
273 UPLCOM_DEV(MICROSOFT, 700WX), /* Microsoft Palm 700WX */
274 UPLCOM_DEV(MOBILEACTION, MA620), /* Mobile Action MA-620 Infrared Adapter */
275 UPLCOM_DEV(NETINDEX, WS002IN), /* Willcom W-S002IN */
276 UPLCOM_DEV(NOKIA2, CA42), /* Nokia CA-42 cable */
277 UPLCOM_DEV(OTI, DKU5), /* OTI DKU-5 cable */
278 UPLCOM_DEV(PANASONIC, TYTP50P6S), /* Panasonic TY-TP50P6-S flat screen */
279 UPLCOM_DEV(PLX, CA42), /* PLX CA-42 clone cable */
280 UPLCOM_DEV(PROLIFIC, ALLTRONIX_GPRS), /* Alltronix ACM003U00 modem */
281 UPLCOM_DEV(PROLIFIC, ALDIGA_AL11U), /* AlDiga AL-11U modem */
282 UPLCOM_DEV(PROLIFIC, DCU11), /* DCU-11 Phone Cable */
283 UPLCOM_DEV(PROLIFIC, HCR331), /* HCR331 Card Reader */
284 UPLCOM_DEV(PROLIFIC, MICROMAX_610U), /* Micromax 610U modem */
285 UPLCOM_DEV(PROLIFIC, MOTOROLA), /* Motorola cable */
286 UPLCOM_DEV(PROLIFIC, PHAROS), /* Prolific Pharos */
287 UPLCOM_DEV(PROLIFIC, PL2303), /* Generic adapter */
288 UPLCOM_DEV(PROLIFIC, RSAQ2), /* I/O DATA USB-RSAQ2 */
289 UPLCOM_DEV(PROLIFIC, RSAQ3), /* I/O DATA USB-RSAQ3 */
290 UPLCOM_DEV(PROLIFIC, UIC_MSR206), /* UIC MSR206 Card Reader */
291 UPLCOM_DEV(PROLIFIC2, PL2303), /* Prolific adapter */
292 UPLCOM_DEV(RADIOSHACK, USBCABLE), /* Radio Shack USB Adapter */
293 UPLCOM_DEV(RATOC, REXUSB60), /* RATOC REX-USB60 */
294 UPLCOM_DEV(SAGEM, USBSERIAL), /* Sagem USB-Serial Controller */
295 UPLCOM_DEV(SAMSUNG, I330), /* Samsung I330 phone cradle */
296 UPLCOM_DEV(SANWA, KB_USB2), /* Sanwa KB-USB2 Multimeter cable */
297 UPLCOM_DEV(SIEMENS3, EF81), /* Siemens EF81 */
298 UPLCOM_DEV(SIEMENS3, SX1), /* Siemens SX1 */
299 UPLCOM_DEV(SIEMENS3, X65), /* Siemens X65 */
300 UPLCOM_DEV(SIEMENS3, X75), /* Siemens X75 */
301 UPLCOM_DEV(SITECOM, SERIAL), /* Sitecom USB to Serial */
302 UPLCOM_DEV(SMART, PL2303), /* SMART Technologies USB to Serial */
303 UPLCOM_DEV(SONY, QN3), /* Sony QN3 phone cable */
304 UPLCOM_DEV(SONYERICSSON, DATAPILOT), /* Sony Ericsson Datapilot */
305 UPLCOM_DEV(SONYERICSSON, DCU10), /* Sony Ericsson DCU-10 Cable */
306 UPLCOM_DEV(SOURCENEXT, KEIKAI8), /* SOURCENEXT KeikaiDenwa 8 */
307 UPLCOM_DEV(SOURCENEXT, KEIKAI8_CHG), /* SOURCENEXT KeikaiDenwa 8 with charger */
308 UPLCOM_DEV(SPEEDDRAGON, MS3303H), /* Speed Dragon USB-Serial */
309 UPLCOM_DEV(SYNTECH, CPT8001C), /* Syntech CPT-8001C Barcode scanner */
310 UPLCOM_DEV(TDK, UHA6400), /* TDK USB-PHS Adapter UHA6400 */
311 UPLCOM_DEV(TDK, UPA9664), /* TDK USB-PHS Adapter UPA9664 */
312 UPLCOM_DEV(TRIPPLITE, U209), /* Tripp-Lite U209-000-R USB to Serial */
313 UPLCOM_DEV(YCCABLE, PL2303), /* YC Cable USB-Serial */
317 static device_method_t uplcom_methods[] = {
318 DEVMETHOD(device_probe, uplcom_probe),
319 DEVMETHOD(device_attach, uplcom_attach),
320 DEVMETHOD(device_detach, uplcom_detach),
324 static devclass_t uplcom_devclass;
326 static driver_t uplcom_driver = {
328 .methods = uplcom_methods,
329 .size = sizeof(struct uplcom_softc),
332 DRIVER_MODULE(uplcom, uhub, uplcom_driver, uplcom_devclass, NULL, 0);
333 MODULE_DEPEND(uplcom, ucom, 1, 1, 1);
334 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
335 MODULE_VERSION(uplcom, UPLCOM_MODVER);
338 uplcom_probe(device_t dev)
340 struct usb_attach_arg *uaa = device_get_ivars(dev);
344 if (uaa->usb_mode != USB_MODE_HOST) {
347 if (uaa->info.bConfigIndex != UPLCOM_CONFIG_INDEX) {
350 if (uaa->info.bIfaceIndex != UPLCOM_IFACE_INDEX) {
353 return (usbd_lookup_id_by_uaa(uplcom_devs, sizeof(uplcom_devs), uaa));
357 uplcom_attach(device_t dev)
359 struct usb_attach_arg *uaa = device_get_ivars(dev);
360 struct uplcom_softc *sc = device_get_softc(dev);
361 struct usb_interface *iface;
362 struct usb_interface_descriptor *id;
363 struct usb_device_descriptor *dd;
368 device_set_usb_desc(dev);
369 mtx_init(&sc->sc_mtx, "uplcom", NULL, MTX_DEF);
370 ucom_ref(&sc->sc_super_ucom);
372 DPRINTF("sc = %p\n", sc);
374 sc->sc_udev = uaa->device;
376 /* Determine the chip type. This algorithm is taken from Linux. */
377 dd = usbd_get_device_descriptor(sc->sc_udev);
378 if (dd->bDeviceClass == 0x02)
379 sc->sc_chiptype = TYPE_PL2303;
380 else if (dd->bMaxPacketSize == 0x40)
381 sc->sc_chiptype = TYPE_PL2303HX;
383 sc->sc_chiptype = TYPE_PL2303;
385 DPRINTF("chiptype: %s\n",
386 (sc->sc_chiptype == TYPE_PL2303HX) ?
390 * USB-RSAQ1 has two interface
392 * USB-RSAQ1 | USB-RSAQ2
393 * -----------------+-----------------
394 * Interface 0 |Interface 0
395 * Interrupt(0x81) | Interrupt(0x81)
396 * -----------------+ BulkIN(0x02)
397 * Interface 1 | BulkOUT(0x83)
402 sc->sc_ctrl_iface_no = uaa->info.bIfaceNum;
403 sc->sc_iface_index[1] = UPLCOM_IFACE_INDEX;
405 iface = usbd_get_iface(uaa->device, UPLCOM_SECOND_IFACE_INDEX);
407 id = usbd_get_interface_descriptor(iface);
409 device_printf(dev, "no interface descriptor (2)\n");
412 sc->sc_data_iface_no = id->bInterfaceNumber;
413 sc->sc_iface_index[0] = UPLCOM_SECOND_IFACE_INDEX;
414 usbd_set_parent_iface(uaa->device,
415 UPLCOM_SECOND_IFACE_INDEX, uaa->info.bIfaceIndex);
417 sc->sc_data_iface_no = sc->sc_ctrl_iface_no;
418 sc->sc_iface_index[0] = UPLCOM_IFACE_INDEX;
421 error = usbd_transfer_setup(uaa->device,
422 sc->sc_iface_index, sc->sc_xfer, uplcom_config_data,
423 UPLCOM_N_TRANSFER, sc, &sc->sc_mtx);
425 DPRINTF("one or more missing USB endpoints, "
426 "error=%s\n", usbd_errstr(error));
429 error = uplcom_reset(sc, uaa->device);
431 device_printf(dev, "reset failed, error=%s\n",
436 if (sc->sc_chiptype != TYPE_PL2303HX) {
437 /* HX variants seem to lock up after a clear stall request. */
438 mtx_lock(&sc->sc_mtx);
439 usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
440 usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
441 mtx_unlock(&sc->sc_mtx);
443 if (uplcom_pl2303_do(sc->sc_udev, UT_WRITE_VENDOR_DEVICE,
444 UPLCOM_SET_REQUEST, 8, 0, 0) ||
445 uplcom_pl2303_do(sc->sc_udev, UT_WRITE_VENDOR_DEVICE,
446 UPLCOM_SET_REQUEST, 9, 0, 0)) {
451 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
452 &uplcom_callback, &sc->sc_mtx);
457 * do the initialization during attach so that the system does not
460 if (uplcom_pl2303_init(uaa->device, sc->sc_chiptype)) {
461 device_printf(dev, "init failed\n");
464 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
474 uplcom_detach(device_t dev)
476 struct uplcom_softc *sc = device_get_softc(dev);
478 DPRINTF("sc=%p\n", sc);
480 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
481 usbd_transfer_unsetup(sc->sc_xfer, UPLCOM_N_TRANSFER);
483 device_claim_softc(dev);
485 uplcom_free_softc(sc);
490 UCOM_UNLOAD_DRAIN(uplcom);
493 uplcom_free_softc(struct uplcom_softc *sc)
495 if (ucom_unref(&sc->sc_super_ucom)) {
496 mtx_destroy(&sc->sc_mtx);
497 device_free_softc(sc);
502 uplcom_free(struct ucom_softc *ucom)
504 uplcom_free_softc(ucom->sc_parent);
508 uplcom_reset(struct uplcom_softc *sc, struct usb_device *udev)
510 struct usb_device_request req;
512 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
513 req.bRequest = UPLCOM_SET_REQUEST;
514 USETW(req.wValue, 0);
515 req.wIndex[0] = sc->sc_data_iface_no;
517 USETW(req.wLength, 0);
519 return (usbd_do_request(udev, NULL, &req, NULL));
523 uplcom_pl2303_do(struct usb_device *udev, int8_t req_type, uint8_t request,
524 uint16_t value, uint16_t index, uint16_t length)
526 struct usb_device_request req;
530 req.bmRequestType = req_type;
531 req.bRequest = request;
532 USETW(req.wValue, value);
533 USETW(req.wIndex, index);
534 USETW(req.wLength, length);
536 err = usbd_do_request(udev, NULL, &req, buf);
538 DPRINTF("error=%s\n", usbd_errstr(err));
545 uplcom_pl2303_init(struct usb_device *udev, uint8_t chiptype)
549 if (uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
550 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 0, 0)
551 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
552 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
553 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
554 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0)
555 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
556 || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
557 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0)
558 || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0))
561 if (chiptype == TYPE_PL2303HX)
562 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0);
564 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x24, 0);
572 uplcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
574 struct uplcom_softc *sc = ucom->sc_parent;
575 struct usb_device_request req;
577 DPRINTF("onoff = %d\n", onoff);
580 sc->sc_line |= UCDC_LINE_DTR;
582 sc->sc_line &= ~UCDC_LINE_DTR;
584 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
585 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
586 USETW(req.wValue, sc->sc_line);
587 req.wIndex[0] = sc->sc_data_iface_no;
589 USETW(req.wLength, 0);
591 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
592 &req, NULL, 0, 1000);
596 uplcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
598 struct uplcom_softc *sc = ucom->sc_parent;
599 struct usb_device_request req;
601 DPRINTF("onoff = %d\n", onoff);
604 sc->sc_line |= UCDC_LINE_RTS;
606 sc->sc_line &= ~UCDC_LINE_RTS;
608 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
609 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
610 USETW(req.wValue, sc->sc_line);
611 req.wIndex[0] = sc->sc_data_iface_no;
613 USETW(req.wLength, 0);
615 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
616 &req, NULL, 0, 1000);
620 uplcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
622 struct uplcom_softc *sc = ucom->sc_parent;
623 struct usb_device_request req;
626 DPRINTF("onoff = %d\n", onoff);
628 temp = (onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
630 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
631 req.bRequest = UCDC_SEND_BREAK;
632 USETW(req.wValue, temp);
633 req.wIndex[0] = sc->sc_data_iface_no;
635 USETW(req.wLength, 0);
637 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
638 &req, NULL, 0, 1000);
641 static const uint32_t uplcom_rates[] = {
642 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
643 19200, 28800, 38400, 57600, 115200,
645 * Higher speeds are probably possible. PL2303X supports up to
646 * 6Mb and can set any rate
648 230400, 460800, 614400, 921600, 1228800
651 #define N_UPLCOM_RATES (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
654 uplcom_pre_param(struct ucom_softc *ucom, struct termios *t)
656 struct uplcom_softc *sc = ucom->sc_parent;
662 * Check requested baud rate.
664 * The PL2303 can only set specific baud rates, up to 1228800 baud.
665 * The PL2303X can set any baud rate up to 6Mb.
666 * The PL2303HX rev. D can set any baud rate up to 12Mb.
668 * XXX: We currently cannot identify the PL2303HX rev. D, so treat
669 * it the same as the PL2303X.
671 if (sc->sc_chiptype != TYPE_PL2303HX) {
672 for (i = 0; i < N_UPLCOM_RATES; i++) {
673 if (uplcom_rates[i] == t->c_ospeed)
677 if (t->c_ospeed <= 6000000)
681 DPRINTF("uplcom_param: bad baud rate (%d)\n", t->c_ospeed);
686 uplcom_cfg_param(struct ucom_softc *ucom, struct termios *t)
688 struct uplcom_softc *sc = ucom->sc_parent;
689 struct usb_cdc_line_state ls;
690 struct usb_device_request req;
692 DPRINTF("sc = %p\n", sc);
694 memset(&ls, 0, sizeof(ls));
696 USETDW(ls.dwDTERate, t->c_ospeed);
698 if (t->c_cflag & CSTOPB) {
699 ls.bCharFormat = UCDC_STOP_BIT_2;
701 ls.bCharFormat = UCDC_STOP_BIT_1;
704 if (t->c_cflag & PARENB) {
705 if (t->c_cflag & PARODD) {
706 ls.bParityType = UCDC_PARITY_ODD;
708 ls.bParityType = UCDC_PARITY_EVEN;
711 ls.bParityType = UCDC_PARITY_NONE;
714 switch (t->c_cflag & CSIZE) {
729 DPRINTF("rate=%d fmt=%d parity=%d bits=%d\n",
730 UGETDW(ls.dwDTERate), ls.bCharFormat,
731 ls.bParityType, ls.bDataBits);
733 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
734 req.bRequest = UCDC_SET_LINE_CODING;
735 USETW(req.wValue, 0);
736 req.wIndex[0] = sc->sc_data_iface_no;
738 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
740 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
743 if (t->c_cflag & CRTSCTS) {
745 DPRINTF("crtscts = on\n");
747 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
748 req.bRequest = UPLCOM_SET_REQUEST;
749 USETW(req.wValue, 0);
750 if (sc->sc_chiptype == TYPE_PL2303HX)
751 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
753 USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
754 USETW(req.wLength, 0);
756 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
757 &req, NULL, 0, 1000);
759 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
760 req.bRequest = UPLCOM_SET_REQUEST;
761 USETW(req.wValue, 0);
762 USETW(req.wIndex, 0);
763 USETW(req.wLength, 0);
764 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
765 &req, NULL, 0, 1000);
770 uplcom_start_read(struct ucom_softc *ucom)
772 struct uplcom_softc *sc = ucom->sc_parent;
774 /* start interrupt endpoint */
775 usbd_transfer_start(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
777 /* start read endpoint */
778 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
782 uplcom_stop_read(struct ucom_softc *ucom)
784 struct uplcom_softc *sc = ucom->sc_parent;
786 /* stop interrupt endpoint */
787 usbd_transfer_stop(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
789 /* stop read endpoint */
790 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
794 uplcom_start_write(struct ucom_softc *ucom)
796 struct uplcom_softc *sc = ucom->sc_parent;
798 usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
802 uplcom_stop_write(struct ucom_softc *ucom)
804 struct uplcom_softc *sc = ucom->sc_parent;
806 usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
810 uplcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
812 struct uplcom_softc *sc = ucom->sc_parent;
821 uplcom_intr_callback(struct usb_xfer *xfer, usb_error_t error)
823 struct uplcom_softc *sc = usbd_xfer_softc(xfer);
824 struct usb_page_cache *pc;
828 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
830 switch (USB_GET_STATE(xfer)) {
831 case USB_ST_TRANSFERRED:
833 DPRINTF("actlen = %u\n", actlen);
837 pc = usbd_xfer_get_frame(xfer, 0);
838 usbd_copy_out(pc, 0, buf, sizeof(buf));
840 DPRINTF("status = 0x%02x\n", buf[8]);
845 if (buf[8] & RSAQ_STATUS_CTS) {
846 sc->sc_msr |= SER_CTS;
848 if (buf[8] & RSAQ_STATUS_DSR) {
849 sc->sc_msr |= SER_DSR;
851 if (buf[8] & RSAQ_STATUS_DCD) {
852 sc->sc_msr |= SER_DCD;
854 ucom_status_change(&sc->sc_ucom);
858 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
859 usbd_transfer_submit(xfer);
863 if (error != USB_ERR_CANCELLED) {
864 /* try to clear stall first */
865 usbd_xfer_set_stall(xfer);
873 uplcom_write_callback(struct usb_xfer *xfer, usb_error_t error)
875 struct uplcom_softc *sc = usbd_xfer_softc(xfer);
876 struct usb_page_cache *pc;
879 switch (USB_GET_STATE(xfer)) {
881 case USB_ST_TRANSFERRED:
883 pc = usbd_xfer_get_frame(xfer, 0);
884 if (ucom_get_data(&sc->sc_ucom, pc, 0,
885 UPLCOM_BULK_BUF_SIZE, &actlen)) {
887 DPRINTF("actlen = %d\n", actlen);
889 usbd_xfer_set_frame_len(xfer, 0, actlen);
890 usbd_transfer_submit(xfer);
895 if (error != USB_ERR_CANCELLED) {
896 /* try to clear stall first */
897 usbd_xfer_set_stall(xfer);
905 uplcom_read_callback(struct usb_xfer *xfer, usb_error_t error)
907 struct uplcom_softc *sc = usbd_xfer_softc(xfer);
908 struct usb_page_cache *pc;
911 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
913 switch (USB_GET_STATE(xfer)) {
914 case USB_ST_TRANSFERRED:
915 pc = usbd_xfer_get_frame(xfer, 0);
916 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
920 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
921 usbd_transfer_submit(xfer);
925 if (error != USB_ERR_CANCELLED) {
926 /* try to clear stall first */
927 usbd_xfer_set_stall(xfer);
935 uplcom_poll(struct ucom_softc *ucom)
937 struct uplcom_softc *sc = ucom->sc_parent;
938 usbd_transfer_poll(sc->sc_xfer, UPLCOM_N_TRANSFER);