2 * Copyright (c) 2002, Alexander Kabaev <kan.FreeBSD.org>.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 * Copyright (c) 2001 The NetBSD Foundation, Inc.
31 * All rights reserved.
33 * This code is derived from software contributed to The NetBSD Foundation
34 * by Ichiro FUKUHARA (ichiro@ichiro.org).
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. All advertising materials mentioning features or use of this software
45 * must display the following acknowledgement:
46 * This product includes software developed by the NetBSD
47 * Foundation, Inc. and its contributors.
48 * 4. Neither the name of The NetBSD Foundation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
53 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
54 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
55 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
56 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
57 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
58 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
59 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
60 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
61 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
62 * POSSIBILITY OF SUCH DAMAGE.
65 #include <sys/stdint.h>
66 #include <sys/stddef.h>
67 #include <sys/param.h>
68 #include <sys/queue.h>
69 #include <sys/types.h>
70 #include <sys/systm.h>
71 #include <sys/kernel.h>
73 #include <sys/module.h>
75 #include <sys/mutex.h>
76 #include <sys/condvar.h>
77 #include <sys/sysctl.h>
79 #include <sys/unistd.h>
80 #include <sys/callout.h>
81 #include <sys/malloc.h>
84 #include <dev/usb/usb.h>
85 #include <dev/usb/usbdi.h>
86 #include <dev/usb/usbdi_util.h>
89 #define USB_DEBUG_VAR ubsa_debug
90 #include <dev/usb/usb_debug.h>
91 #include <dev/usb/usb_process.h>
93 #include <dev/usb/serial/usb_serial.h>
96 static int ubsa_debug = 0;
98 static SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
99 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
100 &ubsa_debug, 0, "ubsa debug level");
103 #define UBSA_BSIZE 1024 /* bytes */
105 #define UBSA_CONFIG_INDEX 0
106 #define UBSA_IFACE_INDEX 0
108 #define UBSA_REG_BAUDRATE 0x00
109 #define UBSA_REG_STOP_BITS 0x01
110 #define UBSA_REG_DATA_BITS 0x02
111 #define UBSA_REG_PARITY 0x03
112 #define UBSA_REG_DTR 0x0A
113 #define UBSA_REG_RTS 0x0B
114 #define UBSA_REG_BREAK 0x0C
115 #define UBSA_REG_FLOW_CTRL 0x10
117 #define UBSA_PARITY_NONE 0x00
118 #define UBSA_PARITY_EVEN 0x01
119 #define UBSA_PARITY_ODD 0x02
120 #define UBSA_PARITY_MARK 0x03
121 #define UBSA_PARITY_SPACE 0x04
123 #define UBSA_FLOW_NONE 0x0000
124 #define UBSA_FLOW_OCTS 0x0001
125 #define UBSA_FLOW_ODSR 0x0002
126 #define UBSA_FLOW_IDSR 0x0004
127 #define UBSA_FLOW_IDTR 0x0008
128 #define UBSA_FLOW_IRTS 0x0010
129 #define UBSA_FLOW_ORTS 0x0020
130 #define UBSA_FLOW_UNKNOWN 0x0040
131 #define UBSA_FLOW_OXON 0x0080
132 #define UBSA_FLOW_IXON 0x0100
134 /* line status register */
135 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
136 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
137 #define UBSA_LSR_BI 0x10 /* Break detected */
138 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
139 #define UBSA_LSR_PE 0x04 /* Parity error */
140 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
141 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
142 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
144 /* modem status register */
145 /* All deltas are from the last read of the MSR. */
146 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
147 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
148 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
149 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
150 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
151 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
152 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
153 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
163 struct ucom_super_softc sc_super_ucom;
164 struct ucom_softc sc_ucom;
166 struct usb_xfer *sc_xfer[UBSA_N_TRANSFER];
167 struct usb_device *sc_udev;
170 uint8_t sc_iface_no; /* interface number */
171 uint8_t sc_iface_index; /* interface index */
172 uint8_t sc_lsr; /* local status register */
173 uint8_t sc_msr; /* UBSA status register */
176 static device_probe_t ubsa_probe;
177 static device_attach_t ubsa_attach;
178 static device_detach_t ubsa_detach;
179 static void ubsa_free_softc(struct ubsa_softc *);
181 static usb_callback_t ubsa_write_callback;
182 static usb_callback_t ubsa_read_callback;
183 static usb_callback_t ubsa_intr_callback;
185 static void ubsa_cfg_request(struct ubsa_softc *, uint8_t, uint16_t);
186 static void ubsa_free(struct ucom_softc *);
187 static void ubsa_cfg_set_dtr(struct ucom_softc *, uint8_t);
188 static void ubsa_cfg_set_rts(struct ucom_softc *, uint8_t);
189 static void ubsa_cfg_set_break(struct ucom_softc *, uint8_t);
190 static int ubsa_pre_param(struct ucom_softc *, struct termios *);
191 static void ubsa_cfg_param(struct ucom_softc *, struct termios *);
192 static void ubsa_start_read(struct ucom_softc *);
193 static void ubsa_stop_read(struct ucom_softc *);
194 static void ubsa_start_write(struct ucom_softc *);
195 static void ubsa_stop_write(struct ucom_softc *);
196 static void ubsa_cfg_get_status(struct ucom_softc *, uint8_t *,
198 static void ubsa_poll(struct ucom_softc *ucom);
200 static const struct usb_config ubsa_config[UBSA_N_TRANSFER] = {
202 [UBSA_BULK_DT_WR] = {
204 .endpoint = UE_ADDR_ANY,
205 .direction = UE_DIR_OUT,
206 .bufsize = UBSA_BSIZE, /* bytes */
207 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
208 .callback = &ubsa_write_callback,
211 [UBSA_BULK_DT_RD] = {
213 .endpoint = UE_ADDR_ANY,
214 .direction = UE_DIR_IN,
215 .bufsize = UBSA_BSIZE, /* bytes */
216 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
217 .callback = &ubsa_read_callback,
220 [UBSA_INTR_DT_RD] = {
221 .type = UE_INTERRUPT,
222 .endpoint = UE_ADDR_ANY,
223 .direction = UE_DIR_IN,
224 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
225 .bufsize = 0, /* use wMaxPacketSize */
226 .callback = &ubsa_intr_callback,
230 static const struct ucom_callback ubsa_callback = {
231 .ucom_cfg_get_status = &ubsa_cfg_get_status,
232 .ucom_cfg_set_dtr = &ubsa_cfg_set_dtr,
233 .ucom_cfg_set_rts = &ubsa_cfg_set_rts,
234 .ucom_cfg_set_break = &ubsa_cfg_set_break,
235 .ucom_cfg_param = &ubsa_cfg_param,
236 .ucom_pre_param = &ubsa_pre_param,
237 .ucom_start_read = &ubsa_start_read,
238 .ucom_stop_read = &ubsa_stop_read,
239 .ucom_start_write = &ubsa_start_write,
240 .ucom_stop_write = &ubsa_stop_write,
241 .ucom_poll = &ubsa_poll,
242 .ucom_free = &ubsa_free,
245 static const STRUCT_USB_HOST_ID ubsa_devs[] = {
246 /* AnyData ADU-500A */
247 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A, 0)},
248 /* AnyData ADU-E100A/H */
249 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_E100X, 0)},
250 /* Axesstel MV100H */
251 {USB_VPI(USB_VENDOR_AXESSTEL, USB_PRODUCT_AXESSTEL_DATAMODEM, 0)},
253 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103, 0)},
255 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120, 0)},
256 /* GoHubs GO-COM232 */
257 {USB_VPI(USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM, 0)},
258 /* GoHubs GO-COM232 */
259 {USB_VPI(USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232, 0)},
261 {USB_VPI(USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1, 0)},
264 static device_method_t ubsa_methods[] = {
265 DEVMETHOD(device_probe, ubsa_probe),
266 DEVMETHOD(device_attach, ubsa_attach),
267 DEVMETHOD(device_detach, ubsa_detach),
271 static devclass_t ubsa_devclass;
273 static driver_t ubsa_driver = {
275 .methods = ubsa_methods,
276 .size = sizeof(struct ubsa_softc),
279 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ubsa_devclass, NULL, 0);
280 MODULE_DEPEND(ubsa, ucom, 1, 1, 1);
281 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
282 MODULE_VERSION(ubsa, 1);
285 ubsa_probe(device_t dev)
287 struct usb_attach_arg *uaa = device_get_ivars(dev);
289 if (uaa->usb_mode != USB_MODE_HOST) {
292 if (uaa->info.bConfigIndex != UBSA_CONFIG_INDEX) {
295 if (uaa->info.bIfaceIndex != UBSA_IFACE_INDEX) {
298 return (usbd_lookup_id_by_uaa(ubsa_devs, sizeof(ubsa_devs), uaa));
302 ubsa_attach(device_t dev)
304 struct usb_attach_arg *uaa = device_get_ivars(dev);
305 struct ubsa_softc *sc = device_get_softc(dev);
308 DPRINTF("sc=%p\n", sc);
310 device_set_usb_desc(dev);
311 mtx_init(&sc->sc_mtx, "ubsa", NULL, MTX_DEF);
312 ucom_ref(&sc->sc_super_ucom);
314 sc->sc_udev = uaa->device;
315 sc->sc_iface_no = uaa->info.bIfaceNum;
316 sc->sc_iface_index = UBSA_IFACE_INDEX;
318 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
319 sc->sc_xfer, ubsa_config, UBSA_N_TRANSFER, sc, &sc->sc_mtx);
322 DPRINTF("could not allocate all pipes\n");
325 /* clear stall at first run */
326 mtx_lock(&sc->sc_mtx);
327 usbd_xfer_set_stall(sc->sc_xfer[UBSA_BULK_DT_WR]);
328 usbd_xfer_set_stall(sc->sc_xfer[UBSA_BULK_DT_RD]);
329 mtx_unlock(&sc->sc_mtx);
331 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
332 &ubsa_callback, &sc->sc_mtx);
334 DPRINTF("ucom_attach failed\n");
337 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
347 ubsa_detach(device_t dev)
349 struct ubsa_softc *sc = device_get_softc(dev);
351 DPRINTF("sc=%p\n", sc);
353 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
354 usbd_transfer_unsetup(sc->sc_xfer, UBSA_N_TRANSFER);
356 device_claim_softc(dev);
363 UCOM_UNLOAD_DRAIN(ubsa);
366 ubsa_free_softc(struct ubsa_softc *sc)
368 if (ucom_unref(&sc->sc_super_ucom)) {
369 mtx_destroy(&sc->sc_mtx);
370 device_free_softc(sc);
375 ubsa_free(struct ucom_softc *ucom)
377 ubsa_free_softc(ucom->sc_parent);
381 ubsa_cfg_request(struct ubsa_softc *sc, uint8_t index, uint16_t value)
383 struct usb_device_request req;
386 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
387 req.bRequest = index;
388 USETW(req.wValue, value);
389 req.wIndex[0] = sc->sc_iface_no;
391 USETW(req.wLength, 0);
393 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
394 &req, NULL, 0, 1000);
396 DPRINTFN(0, "device request failed, err=%s "
397 "(ignored)\n", usbd_errstr(err));
402 ubsa_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
404 struct ubsa_softc *sc = ucom->sc_parent;
406 DPRINTF("onoff = %d\n", onoff);
408 ubsa_cfg_request(sc, UBSA_REG_DTR, onoff ? 1 : 0);
412 ubsa_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
414 struct ubsa_softc *sc = ucom->sc_parent;
416 DPRINTF("onoff = %d\n", onoff);
418 ubsa_cfg_request(sc, UBSA_REG_RTS, onoff ? 1 : 0);
422 ubsa_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
424 struct ubsa_softc *sc = ucom->sc_parent;
426 DPRINTF("onoff = %d\n", onoff);
428 ubsa_cfg_request(sc, UBSA_REG_BREAK, onoff ? 1 : 0);
432 ubsa_pre_param(struct ucom_softc *ucom, struct termios *t)
435 DPRINTF("sc = %p\n", ucom->sc_parent);
437 switch (t->c_ospeed) {
458 ubsa_cfg_param(struct ucom_softc *ucom, struct termios *t)
460 struct ubsa_softc *sc = ucom->sc_parent;
463 DPRINTF("sc = %p\n", sc);
465 switch (t->c_ospeed) {
467 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, 0);
468 ubsa_cfg_set_dtr(&sc->sc_ucom, 0);
469 ubsa_cfg_set_rts(&sc->sc_ucom, 0);
482 value = B230400 / t->c_ospeed;
483 ubsa_cfg_request(sc, UBSA_REG_BAUDRATE, value);
489 if (t->c_cflag & PARENB)
490 value = (t->c_cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
492 value = UBSA_PARITY_NONE;
494 ubsa_cfg_request(sc, UBSA_REG_PARITY, value);
496 switch (t->c_cflag & CSIZE) {
512 ubsa_cfg_request(sc, UBSA_REG_DATA_BITS, value);
514 value = (t->c_cflag & CSTOPB) ? 1 : 0;
516 ubsa_cfg_request(sc, UBSA_REG_STOP_BITS, value);
519 if (t->c_cflag & CRTSCTS)
520 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
522 if (t->c_iflag & (IXON | IXOFF))
523 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
525 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, value);
529 ubsa_start_read(struct ucom_softc *ucom)
531 struct ubsa_softc *sc = ucom->sc_parent;
533 /* start interrupt endpoint */
534 usbd_transfer_start(sc->sc_xfer[UBSA_INTR_DT_RD]);
536 /* start read endpoint */
537 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_RD]);
541 ubsa_stop_read(struct ucom_softc *ucom)
543 struct ubsa_softc *sc = ucom->sc_parent;
545 /* stop interrupt endpoint */
546 usbd_transfer_stop(sc->sc_xfer[UBSA_INTR_DT_RD]);
548 /* stop read endpoint */
549 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_RD]);
553 ubsa_start_write(struct ucom_softc *ucom)
555 struct ubsa_softc *sc = ucom->sc_parent;
557 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_WR]);
561 ubsa_stop_write(struct ucom_softc *ucom)
563 struct ubsa_softc *sc = ucom->sc_parent;
565 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_WR]);
569 ubsa_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
571 struct ubsa_softc *sc = ucom->sc_parent;
580 ubsa_write_callback(struct usb_xfer *xfer, usb_error_t error)
582 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
583 struct usb_page_cache *pc;
586 switch (USB_GET_STATE(xfer)) {
588 case USB_ST_TRANSFERRED:
590 pc = usbd_xfer_get_frame(xfer, 0);
591 if (ucom_get_data(&sc->sc_ucom, pc, 0,
592 UBSA_BSIZE, &actlen)) {
594 usbd_xfer_set_frame_len(xfer, 0, actlen);
595 usbd_transfer_submit(xfer);
600 if (error != USB_ERR_CANCELLED) {
601 /* try to clear stall first */
602 usbd_xfer_set_stall(xfer);
611 ubsa_read_callback(struct usb_xfer *xfer, usb_error_t error)
613 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
614 struct usb_page_cache *pc;
617 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
619 switch (USB_GET_STATE(xfer)) {
620 case USB_ST_TRANSFERRED:
621 pc = usbd_xfer_get_frame(xfer, 0);
622 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
626 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
627 usbd_transfer_submit(xfer);
631 if (error != USB_ERR_CANCELLED) {
632 /* try to clear stall first */
633 usbd_xfer_set_stall(xfer);
642 ubsa_intr_callback(struct usb_xfer *xfer, usb_error_t error)
644 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
645 struct usb_page_cache *pc;
649 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
651 switch (USB_GET_STATE(xfer)) {
652 case USB_ST_TRANSFERRED:
654 if (actlen >= (int)sizeof(buf)) {
655 pc = usbd_xfer_get_frame(xfer, 0);
656 usbd_copy_out(pc, 0, buf, sizeof(buf));
659 * incidentally, Belkin adapter status bits match
665 DPRINTF("lsr = 0x%02x, msr = 0x%02x\n",
666 sc->sc_lsr, sc->sc_msr);
668 ucom_status_change(&sc->sc_ucom);
670 DPRINTF("ignoring short packet, %d bytes\n", actlen);
675 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
676 usbd_transfer_submit(xfer);
680 if (error != USB_ERR_CANCELLED) {
681 /* try to clear stall first */
682 usbd_xfer_set_stall(xfer);
691 ubsa_poll(struct ucom_softc *ucom)
693 struct ubsa_softc *sc = ucom->sc_parent;
694 usbd_transfer_poll(sc->sc_xfer, UBSA_N_TRANSFER);