2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD AND BSD-2-Clause-NetBSD
4 * Copyright (c) 2002, Alexander Kabaev <kan.FreeBSD.org>.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 * Copyright (c) 2001 The NetBSD Foundation, Inc.
33 * All rights reserved.
35 * This code is derived from software contributed to The NetBSD Foundation
36 * by Ichiro FUKUHARA (ichiro@ichiro.org).
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
47 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
48 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
49 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
50 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
51 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
52 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
53 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
54 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
55 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
56 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
57 * POSSIBILITY OF SUCH DAMAGE.
60 #include <sys/stdint.h>
61 #include <sys/stddef.h>
62 #include <sys/param.h>
63 #include <sys/queue.h>
64 #include <sys/types.h>
65 #include <sys/systm.h>
66 #include <sys/kernel.h>
68 #include <sys/module.h>
70 #include <sys/mutex.h>
71 #include <sys/condvar.h>
72 #include <sys/sysctl.h>
74 #include <sys/unistd.h>
75 #include <sys/callout.h>
76 #include <sys/malloc.h>
79 #include <dev/usb/usb.h>
80 #include <dev/usb/usbdi.h>
81 #include <dev/usb/usbdi_util.h>
84 #define USB_DEBUG_VAR ubsa_debug
85 #include <dev/usb/usb_debug.h>
86 #include <dev/usb/usb_process.h>
88 #include <dev/usb/serial/usb_serial.h>
91 static int ubsa_debug = 0;
93 static SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
94 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RWTUN,
95 &ubsa_debug, 0, "ubsa debug level");
98 #define UBSA_BSIZE 1024 /* bytes */
100 #define UBSA_CONFIG_INDEX 0
101 #define UBSA_IFACE_INDEX 0
103 #define UBSA_REG_BAUDRATE 0x00
104 #define UBSA_REG_STOP_BITS 0x01
105 #define UBSA_REG_DATA_BITS 0x02
106 #define UBSA_REG_PARITY 0x03
107 #define UBSA_REG_DTR 0x0A
108 #define UBSA_REG_RTS 0x0B
109 #define UBSA_REG_BREAK 0x0C
110 #define UBSA_REG_FLOW_CTRL 0x10
112 #define UBSA_PARITY_NONE 0x00
113 #define UBSA_PARITY_EVEN 0x01
114 #define UBSA_PARITY_ODD 0x02
115 #define UBSA_PARITY_MARK 0x03
116 #define UBSA_PARITY_SPACE 0x04
118 #define UBSA_FLOW_NONE 0x0000
119 #define UBSA_FLOW_OCTS 0x0001
120 #define UBSA_FLOW_ODSR 0x0002
121 #define UBSA_FLOW_IDSR 0x0004
122 #define UBSA_FLOW_IDTR 0x0008
123 #define UBSA_FLOW_IRTS 0x0010
124 #define UBSA_FLOW_ORTS 0x0020
125 #define UBSA_FLOW_UNKNOWN 0x0040
126 #define UBSA_FLOW_OXON 0x0080
127 #define UBSA_FLOW_IXON 0x0100
129 /* line status register */
130 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
131 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
132 #define UBSA_LSR_BI 0x10 /* Break detected */
133 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
134 #define UBSA_LSR_PE 0x04 /* Parity error */
135 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
136 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
137 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
139 /* modem status register */
140 /* All deltas are from the last read of the MSR. */
141 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
142 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
143 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
144 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
145 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
146 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
147 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
148 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
158 struct ucom_super_softc sc_super_ucom;
159 struct ucom_softc sc_ucom;
161 struct usb_xfer *sc_xfer[UBSA_N_TRANSFER];
162 struct usb_device *sc_udev;
165 uint8_t sc_iface_no; /* interface number */
166 uint8_t sc_iface_index; /* interface index */
167 uint8_t sc_lsr; /* local status register */
168 uint8_t sc_msr; /* UBSA status register */
171 static device_probe_t ubsa_probe;
172 static device_attach_t ubsa_attach;
173 static device_detach_t ubsa_detach;
174 static void ubsa_free_softc(struct ubsa_softc *);
176 static usb_callback_t ubsa_write_callback;
177 static usb_callback_t ubsa_read_callback;
178 static usb_callback_t ubsa_intr_callback;
180 static void ubsa_cfg_request(struct ubsa_softc *, uint8_t, uint16_t);
181 static void ubsa_free(struct ucom_softc *);
182 static void ubsa_cfg_set_dtr(struct ucom_softc *, uint8_t);
183 static void ubsa_cfg_set_rts(struct ucom_softc *, uint8_t);
184 static void ubsa_cfg_set_break(struct ucom_softc *, uint8_t);
185 static int ubsa_pre_param(struct ucom_softc *, struct termios *);
186 static void ubsa_cfg_param(struct ucom_softc *, struct termios *);
187 static void ubsa_start_read(struct ucom_softc *);
188 static void ubsa_stop_read(struct ucom_softc *);
189 static void ubsa_start_write(struct ucom_softc *);
190 static void ubsa_stop_write(struct ucom_softc *);
191 static void ubsa_cfg_get_status(struct ucom_softc *, uint8_t *,
193 static void ubsa_poll(struct ucom_softc *ucom);
195 static const struct usb_config ubsa_config[UBSA_N_TRANSFER] = {
197 [UBSA_BULK_DT_WR] = {
199 .endpoint = UE_ADDR_ANY,
200 .direction = UE_DIR_OUT,
201 .bufsize = UBSA_BSIZE, /* bytes */
202 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
203 .callback = &ubsa_write_callback,
206 [UBSA_BULK_DT_RD] = {
208 .endpoint = UE_ADDR_ANY,
209 .direction = UE_DIR_IN,
210 .bufsize = UBSA_BSIZE, /* bytes */
211 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
212 .callback = &ubsa_read_callback,
215 [UBSA_INTR_DT_RD] = {
216 .type = UE_INTERRUPT,
217 .endpoint = UE_ADDR_ANY,
218 .direction = UE_DIR_IN,
219 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
220 .bufsize = 0, /* use wMaxPacketSize */
221 .callback = &ubsa_intr_callback,
225 static const struct ucom_callback ubsa_callback = {
226 .ucom_cfg_get_status = &ubsa_cfg_get_status,
227 .ucom_cfg_set_dtr = &ubsa_cfg_set_dtr,
228 .ucom_cfg_set_rts = &ubsa_cfg_set_rts,
229 .ucom_cfg_set_break = &ubsa_cfg_set_break,
230 .ucom_cfg_param = &ubsa_cfg_param,
231 .ucom_pre_param = &ubsa_pre_param,
232 .ucom_start_read = &ubsa_start_read,
233 .ucom_stop_read = &ubsa_stop_read,
234 .ucom_start_write = &ubsa_start_write,
235 .ucom_stop_write = &ubsa_stop_write,
236 .ucom_poll = &ubsa_poll,
237 .ucom_free = &ubsa_free,
240 static const STRUCT_USB_HOST_ID ubsa_devs[] = {
241 /* AnyData ADU-500A */
242 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A, 0)},
243 /* AnyData ADU-E100A/H */
244 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_E100X, 0)},
245 /* Axesstel MV100H */
246 {USB_VPI(USB_VENDOR_AXESSTEL, USB_PRODUCT_AXESSTEL_DATAMODEM, 0)},
248 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103, 0)},
250 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120, 0)},
251 /* GoHubs GO-COM232 */
252 {USB_VPI(USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM, 0)},
253 /* GoHubs GO-COM232 */
254 {USB_VPI(USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232, 0)},
256 {USB_VPI(USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1, 0)},
259 static device_method_t ubsa_methods[] = {
260 DEVMETHOD(device_probe, ubsa_probe),
261 DEVMETHOD(device_attach, ubsa_attach),
262 DEVMETHOD(device_detach, ubsa_detach),
266 static devclass_t ubsa_devclass;
268 static driver_t ubsa_driver = {
270 .methods = ubsa_methods,
271 .size = sizeof(struct ubsa_softc),
274 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ubsa_devclass, NULL, 0);
275 MODULE_DEPEND(ubsa, ucom, 1, 1, 1);
276 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
277 MODULE_VERSION(ubsa, 1);
278 USB_PNP_HOST_INFO(ubsa_devs);
281 ubsa_probe(device_t dev)
283 struct usb_attach_arg *uaa = device_get_ivars(dev);
285 if (uaa->usb_mode != USB_MODE_HOST) {
288 if (uaa->info.bConfigIndex != UBSA_CONFIG_INDEX) {
291 if (uaa->info.bIfaceIndex != UBSA_IFACE_INDEX) {
294 return (usbd_lookup_id_by_uaa(ubsa_devs, sizeof(ubsa_devs), uaa));
298 ubsa_attach(device_t dev)
300 struct usb_attach_arg *uaa = device_get_ivars(dev);
301 struct ubsa_softc *sc = device_get_softc(dev);
304 DPRINTF("sc=%p\n", sc);
306 device_set_usb_desc(dev);
307 mtx_init(&sc->sc_mtx, "ubsa", NULL, MTX_DEF);
308 ucom_ref(&sc->sc_super_ucom);
310 sc->sc_udev = uaa->device;
311 sc->sc_iface_no = uaa->info.bIfaceNum;
312 sc->sc_iface_index = UBSA_IFACE_INDEX;
314 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
315 sc->sc_xfer, ubsa_config, UBSA_N_TRANSFER, sc, &sc->sc_mtx);
318 DPRINTF("could not allocate all pipes\n");
321 /* clear stall at first run */
322 mtx_lock(&sc->sc_mtx);
323 usbd_xfer_set_stall(sc->sc_xfer[UBSA_BULK_DT_WR]);
324 usbd_xfer_set_stall(sc->sc_xfer[UBSA_BULK_DT_RD]);
325 mtx_unlock(&sc->sc_mtx);
327 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
328 &ubsa_callback, &sc->sc_mtx);
330 DPRINTF("ucom_attach failed\n");
333 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
343 ubsa_detach(device_t dev)
345 struct ubsa_softc *sc = device_get_softc(dev);
347 DPRINTF("sc=%p\n", sc);
349 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
350 usbd_transfer_unsetup(sc->sc_xfer, UBSA_N_TRANSFER);
352 device_claim_softc(dev);
359 UCOM_UNLOAD_DRAIN(ubsa);
362 ubsa_free_softc(struct ubsa_softc *sc)
364 if (ucom_unref(&sc->sc_super_ucom)) {
365 mtx_destroy(&sc->sc_mtx);
366 device_free_softc(sc);
371 ubsa_free(struct ucom_softc *ucom)
373 ubsa_free_softc(ucom->sc_parent);
377 ubsa_cfg_request(struct ubsa_softc *sc, uint8_t index, uint16_t value)
379 struct usb_device_request req;
382 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
383 req.bRequest = index;
384 USETW(req.wValue, value);
385 req.wIndex[0] = sc->sc_iface_no;
387 USETW(req.wLength, 0);
389 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
390 &req, NULL, 0, 1000);
392 DPRINTFN(0, "device request failed, err=%s "
393 "(ignored)\n", usbd_errstr(err));
398 ubsa_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
400 struct ubsa_softc *sc = ucom->sc_parent;
402 DPRINTF("onoff = %d\n", onoff);
404 ubsa_cfg_request(sc, UBSA_REG_DTR, onoff ? 1 : 0);
408 ubsa_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
410 struct ubsa_softc *sc = ucom->sc_parent;
412 DPRINTF("onoff = %d\n", onoff);
414 ubsa_cfg_request(sc, UBSA_REG_RTS, onoff ? 1 : 0);
418 ubsa_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
420 struct ubsa_softc *sc = ucom->sc_parent;
422 DPRINTF("onoff = %d\n", onoff);
424 ubsa_cfg_request(sc, UBSA_REG_BREAK, onoff ? 1 : 0);
428 ubsa_pre_param(struct ucom_softc *ucom, struct termios *t)
431 DPRINTF("sc = %p\n", ucom->sc_parent);
433 switch (t->c_ospeed) {
454 ubsa_cfg_param(struct ucom_softc *ucom, struct termios *t)
456 struct ubsa_softc *sc = ucom->sc_parent;
459 DPRINTF("sc = %p\n", sc);
461 switch (t->c_ospeed) {
463 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, 0);
464 ubsa_cfg_set_dtr(&sc->sc_ucom, 0);
465 ubsa_cfg_set_rts(&sc->sc_ucom, 0);
478 value = B230400 / t->c_ospeed;
479 ubsa_cfg_request(sc, UBSA_REG_BAUDRATE, value);
485 if (t->c_cflag & PARENB)
486 value = (t->c_cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
488 value = UBSA_PARITY_NONE;
490 ubsa_cfg_request(sc, UBSA_REG_PARITY, value);
492 switch (t->c_cflag & CSIZE) {
508 ubsa_cfg_request(sc, UBSA_REG_DATA_BITS, value);
510 value = (t->c_cflag & CSTOPB) ? 1 : 0;
512 ubsa_cfg_request(sc, UBSA_REG_STOP_BITS, value);
515 if (t->c_cflag & CRTSCTS)
516 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
518 if (t->c_iflag & (IXON | IXOFF))
519 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
521 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, value);
525 ubsa_start_read(struct ucom_softc *ucom)
527 struct ubsa_softc *sc = ucom->sc_parent;
529 /* start interrupt endpoint */
530 usbd_transfer_start(sc->sc_xfer[UBSA_INTR_DT_RD]);
532 /* start read endpoint */
533 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_RD]);
537 ubsa_stop_read(struct ucom_softc *ucom)
539 struct ubsa_softc *sc = ucom->sc_parent;
541 /* stop interrupt endpoint */
542 usbd_transfer_stop(sc->sc_xfer[UBSA_INTR_DT_RD]);
544 /* stop read endpoint */
545 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_RD]);
549 ubsa_start_write(struct ucom_softc *ucom)
551 struct ubsa_softc *sc = ucom->sc_parent;
553 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_WR]);
557 ubsa_stop_write(struct ucom_softc *ucom)
559 struct ubsa_softc *sc = ucom->sc_parent;
561 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_WR]);
565 ubsa_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
567 struct ubsa_softc *sc = ucom->sc_parent;
576 ubsa_write_callback(struct usb_xfer *xfer, usb_error_t error)
578 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
579 struct usb_page_cache *pc;
582 switch (USB_GET_STATE(xfer)) {
584 case USB_ST_TRANSFERRED:
586 pc = usbd_xfer_get_frame(xfer, 0);
587 if (ucom_get_data(&sc->sc_ucom, pc, 0,
588 UBSA_BSIZE, &actlen)) {
590 usbd_xfer_set_frame_len(xfer, 0, actlen);
591 usbd_transfer_submit(xfer);
596 if (error != USB_ERR_CANCELLED) {
597 /* try to clear stall first */
598 usbd_xfer_set_stall(xfer);
607 ubsa_read_callback(struct usb_xfer *xfer, usb_error_t error)
609 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
610 struct usb_page_cache *pc;
613 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
615 switch (USB_GET_STATE(xfer)) {
616 case USB_ST_TRANSFERRED:
617 pc = usbd_xfer_get_frame(xfer, 0);
618 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
622 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
623 usbd_transfer_submit(xfer);
627 if (error != USB_ERR_CANCELLED) {
628 /* try to clear stall first */
629 usbd_xfer_set_stall(xfer);
638 ubsa_intr_callback(struct usb_xfer *xfer, usb_error_t error)
640 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
641 struct usb_page_cache *pc;
645 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
647 switch (USB_GET_STATE(xfer)) {
648 case USB_ST_TRANSFERRED:
650 if (actlen >= (int)sizeof(buf)) {
651 pc = usbd_xfer_get_frame(xfer, 0);
652 usbd_copy_out(pc, 0, buf, sizeof(buf));
655 * MSR bits need translation from ns16550 to SER_* values.
656 * LSR bits are ns16550 in hardware and ucom.
659 if (buf[3] & UBSA_MSR_CTS)
660 sc->sc_msr |= SER_CTS;
661 if (buf[3] & UBSA_MSR_DCD)
662 sc->sc_msr |= SER_DCD;
663 if (buf[3] & UBSA_MSR_RI)
664 sc->sc_msr |= SER_RI;
665 if (buf[3] & UBSA_MSR_DSR)
666 sc->sc_msr |= SER_DSR;
669 DPRINTF("lsr = 0x%02x, msr = 0x%02x\n",
670 sc->sc_lsr, sc->sc_msr);
672 ucom_status_change(&sc->sc_ucom);
674 DPRINTF("ignoring short packet, %d bytes\n", actlen);
679 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
680 usbd_transfer_submit(xfer);
684 if (error != USB_ERR_CANCELLED) {
685 /* try to clear stall first */
686 usbd_xfer_set_stall(xfer);
695 ubsa_poll(struct ucom_softc *ucom)
697 struct ubsa_softc *sc = ucom->sc_parent;
698 usbd_transfer_poll(sc->sc_xfer, UBSA_N_TRANSFER);