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.
45 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
46 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
47 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
48 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
49 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
50 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
53 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
55 * POSSIBILITY OF SUCH DAMAGE.
58 #include <sys/stdint.h>
59 #include <sys/stddef.h>
60 #include <sys/param.h>
61 #include <sys/queue.h>
62 #include <sys/types.h>
63 #include <sys/systm.h>
64 #include <sys/kernel.h>
66 #include <sys/module.h>
68 #include <sys/mutex.h>
69 #include <sys/condvar.h>
70 #include <sys/sysctl.h>
72 #include <sys/unistd.h>
73 #include <sys/callout.h>
74 #include <sys/malloc.h>
77 #include <dev/usb/usb.h>
78 #include <dev/usb/usbdi.h>
79 #include <dev/usb/usbdi_util.h>
82 #define USB_DEBUG_VAR ubsa_debug
83 #include <dev/usb/usb_debug.h>
84 #include <dev/usb/usb_process.h>
86 #include <dev/usb/serial/usb_serial.h>
89 static int ubsa_debug = 0;
91 static SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
92 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
93 &ubsa_debug, 0, "ubsa debug level");
96 #define UBSA_BSIZE 1024 /* bytes */
98 #define UBSA_CONFIG_INDEX 0
99 #define UBSA_IFACE_INDEX 0
101 #define UBSA_REG_BAUDRATE 0x00
102 #define UBSA_REG_STOP_BITS 0x01
103 #define UBSA_REG_DATA_BITS 0x02
104 #define UBSA_REG_PARITY 0x03
105 #define UBSA_REG_DTR 0x0A
106 #define UBSA_REG_RTS 0x0B
107 #define UBSA_REG_BREAK 0x0C
108 #define UBSA_REG_FLOW_CTRL 0x10
110 #define UBSA_PARITY_NONE 0x00
111 #define UBSA_PARITY_EVEN 0x01
112 #define UBSA_PARITY_ODD 0x02
113 #define UBSA_PARITY_MARK 0x03
114 #define UBSA_PARITY_SPACE 0x04
116 #define UBSA_FLOW_NONE 0x0000
117 #define UBSA_FLOW_OCTS 0x0001
118 #define UBSA_FLOW_ODSR 0x0002
119 #define UBSA_FLOW_IDSR 0x0004
120 #define UBSA_FLOW_IDTR 0x0008
121 #define UBSA_FLOW_IRTS 0x0010
122 #define UBSA_FLOW_ORTS 0x0020
123 #define UBSA_FLOW_UNKNOWN 0x0040
124 #define UBSA_FLOW_OXON 0x0080
125 #define UBSA_FLOW_IXON 0x0100
127 /* line status register */
128 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
129 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
130 #define UBSA_LSR_BI 0x10 /* Break detected */
131 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
132 #define UBSA_LSR_PE 0x04 /* Parity error */
133 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
134 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
135 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
137 /* modem status register */
138 /* All deltas are from the last read of the MSR. */
139 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
140 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
141 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
142 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
143 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
144 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
145 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
146 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
156 struct ucom_super_softc sc_super_ucom;
157 struct ucom_softc sc_ucom;
159 struct usb_xfer *sc_xfer[UBSA_N_TRANSFER];
160 struct usb_device *sc_udev;
163 uint8_t sc_iface_no; /* interface number */
164 uint8_t sc_iface_index; /* interface index */
165 uint8_t sc_lsr; /* local status register */
166 uint8_t sc_msr; /* UBSA status register */
169 static device_probe_t ubsa_probe;
170 static device_attach_t ubsa_attach;
171 static device_detach_t ubsa_detach;
172 static void ubsa_free_softc(struct ubsa_softc *);
174 static usb_callback_t ubsa_write_callback;
175 static usb_callback_t ubsa_read_callback;
176 static usb_callback_t ubsa_intr_callback;
178 static void ubsa_cfg_request(struct ubsa_softc *, uint8_t, uint16_t);
179 static void ubsa_free(struct ucom_softc *);
180 static void ubsa_cfg_set_dtr(struct ucom_softc *, uint8_t);
181 static void ubsa_cfg_set_rts(struct ucom_softc *, uint8_t);
182 static void ubsa_cfg_set_break(struct ucom_softc *, uint8_t);
183 static int ubsa_pre_param(struct ucom_softc *, struct termios *);
184 static void ubsa_cfg_param(struct ucom_softc *, struct termios *);
185 static void ubsa_start_read(struct ucom_softc *);
186 static void ubsa_stop_read(struct ucom_softc *);
187 static void ubsa_start_write(struct ucom_softc *);
188 static void ubsa_stop_write(struct ucom_softc *);
189 static void ubsa_cfg_get_status(struct ucom_softc *, uint8_t *,
191 static void ubsa_poll(struct ucom_softc *ucom);
193 static const struct usb_config ubsa_config[UBSA_N_TRANSFER] = {
195 [UBSA_BULK_DT_WR] = {
197 .endpoint = UE_ADDR_ANY,
198 .direction = UE_DIR_OUT,
199 .bufsize = UBSA_BSIZE, /* bytes */
200 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
201 .callback = &ubsa_write_callback,
204 [UBSA_BULK_DT_RD] = {
206 .endpoint = UE_ADDR_ANY,
207 .direction = UE_DIR_IN,
208 .bufsize = UBSA_BSIZE, /* bytes */
209 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
210 .callback = &ubsa_read_callback,
213 [UBSA_INTR_DT_RD] = {
214 .type = UE_INTERRUPT,
215 .endpoint = UE_ADDR_ANY,
216 .direction = UE_DIR_IN,
217 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
218 .bufsize = 0, /* use wMaxPacketSize */
219 .callback = &ubsa_intr_callback,
223 static const struct ucom_callback ubsa_callback = {
224 .ucom_cfg_get_status = &ubsa_cfg_get_status,
225 .ucom_cfg_set_dtr = &ubsa_cfg_set_dtr,
226 .ucom_cfg_set_rts = &ubsa_cfg_set_rts,
227 .ucom_cfg_set_break = &ubsa_cfg_set_break,
228 .ucom_cfg_param = &ubsa_cfg_param,
229 .ucom_pre_param = &ubsa_pre_param,
230 .ucom_start_read = &ubsa_start_read,
231 .ucom_stop_read = &ubsa_stop_read,
232 .ucom_start_write = &ubsa_start_write,
233 .ucom_stop_write = &ubsa_stop_write,
234 .ucom_poll = &ubsa_poll,
235 .ucom_free = &ubsa_free,
238 static const STRUCT_USB_HOST_ID ubsa_devs[] = {
239 /* AnyData ADU-500A */
240 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A, 0)},
241 /* AnyData ADU-E100A/H */
242 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_E100X, 0)},
243 /* Axesstel MV100H */
244 {USB_VPI(USB_VENDOR_AXESSTEL, USB_PRODUCT_AXESSTEL_DATAMODEM, 0)},
246 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103, 0)},
248 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120, 0)},
249 /* GoHubs GO-COM232 */
250 {USB_VPI(USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM, 0)},
251 /* GoHubs GO-COM232 */
252 {USB_VPI(USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232, 0)},
254 {USB_VPI(USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1, 0)},
257 static device_method_t ubsa_methods[] = {
258 DEVMETHOD(device_probe, ubsa_probe),
259 DEVMETHOD(device_attach, ubsa_attach),
260 DEVMETHOD(device_detach, ubsa_detach),
264 static devclass_t ubsa_devclass;
266 static driver_t ubsa_driver = {
268 .methods = ubsa_methods,
269 .size = sizeof(struct ubsa_softc),
272 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ubsa_devclass, NULL, 0);
273 MODULE_DEPEND(ubsa, ucom, 1, 1, 1);
274 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
275 MODULE_VERSION(ubsa, 1);
278 ubsa_probe(device_t dev)
280 struct usb_attach_arg *uaa = device_get_ivars(dev);
282 if (uaa->usb_mode != USB_MODE_HOST) {
285 if (uaa->info.bConfigIndex != UBSA_CONFIG_INDEX) {
288 if (uaa->info.bIfaceIndex != UBSA_IFACE_INDEX) {
291 return (usbd_lookup_id_by_uaa(ubsa_devs, sizeof(ubsa_devs), uaa));
295 ubsa_attach(device_t dev)
297 struct usb_attach_arg *uaa = device_get_ivars(dev);
298 struct ubsa_softc *sc = device_get_softc(dev);
301 DPRINTF("sc=%p\n", sc);
303 device_set_usb_desc(dev);
304 mtx_init(&sc->sc_mtx, "ubsa", NULL, MTX_DEF);
305 ucom_ref(&sc->sc_super_ucom);
307 sc->sc_udev = uaa->device;
308 sc->sc_iface_no = uaa->info.bIfaceNum;
309 sc->sc_iface_index = UBSA_IFACE_INDEX;
311 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
312 sc->sc_xfer, ubsa_config, UBSA_N_TRANSFER, sc, &sc->sc_mtx);
315 DPRINTF("could not allocate all pipes\n");
318 /* clear stall at first run */
319 mtx_lock(&sc->sc_mtx);
320 usbd_xfer_set_stall(sc->sc_xfer[UBSA_BULK_DT_WR]);
321 usbd_xfer_set_stall(sc->sc_xfer[UBSA_BULK_DT_RD]);
322 mtx_unlock(&sc->sc_mtx);
324 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
325 &ubsa_callback, &sc->sc_mtx);
327 DPRINTF("ucom_attach failed\n");
330 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
340 ubsa_detach(device_t dev)
342 struct ubsa_softc *sc = device_get_softc(dev);
344 DPRINTF("sc=%p\n", sc);
346 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
347 usbd_transfer_unsetup(sc->sc_xfer, UBSA_N_TRANSFER);
349 device_claim_softc(dev);
356 UCOM_UNLOAD_DRAIN(ubsa);
359 ubsa_free_softc(struct ubsa_softc *sc)
361 if (ucom_unref(&sc->sc_super_ucom)) {
362 mtx_destroy(&sc->sc_mtx);
363 device_free_softc(sc);
368 ubsa_free(struct ucom_softc *ucom)
370 ubsa_free_softc(ucom->sc_parent);
374 ubsa_cfg_request(struct ubsa_softc *sc, uint8_t index, uint16_t value)
376 struct usb_device_request req;
379 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
380 req.bRequest = index;
381 USETW(req.wValue, value);
382 req.wIndex[0] = sc->sc_iface_no;
384 USETW(req.wLength, 0);
386 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
387 &req, NULL, 0, 1000);
389 DPRINTFN(0, "device request failed, err=%s "
390 "(ignored)\n", usbd_errstr(err));
395 ubsa_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
397 struct ubsa_softc *sc = ucom->sc_parent;
399 DPRINTF("onoff = %d\n", onoff);
401 ubsa_cfg_request(sc, UBSA_REG_DTR, onoff ? 1 : 0);
405 ubsa_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
407 struct ubsa_softc *sc = ucom->sc_parent;
409 DPRINTF("onoff = %d\n", onoff);
411 ubsa_cfg_request(sc, UBSA_REG_RTS, onoff ? 1 : 0);
415 ubsa_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
417 struct ubsa_softc *sc = ucom->sc_parent;
419 DPRINTF("onoff = %d\n", onoff);
421 ubsa_cfg_request(sc, UBSA_REG_BREAK, onoff ? 1 : 0);
425 ubsa_pre_param(struct ucom_softc *ucom, struct termios *t)
428 DPRINTF("sc = %p\n", ucom->sc_parent);
430 switch (t->c_ospeed) {
451 ubsa_cfg_param(struct ucom_softc *ucom, struct termios *t)
453 struct ubsa_softc *sc = ucom->sc_parent;
456 DPRINTF("sc = %p\n", sc);
458 switch (t->c_ospeed) {
460 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, 0);
461 ubsa_cfg_set_dtr(&sc->sc_ucom, 0);
462 ubsa_cfg_set_rts(&sc->sc_ucom, 0);
475 value = B230400 / t->c_ospeed;
476 ubsa_cfg_request(sc, UBSA_REG_BAUDRATE, value);
482 if (t->c_cflag & PARENB)
483 value = (t->c_cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
485 value = UBSA_PARITY_NONE;
487 ubsa_cfg_request(sc, UBSA_REG_PARITY, value);
489 switch (t->c_cflag & CSIZE) {
505 ubsa_cfg_request(sc, UBSA_REG_DATA_BITS, value);
507 value = (t->c_cflag & CSTOPB) ? 1 : 0;
509 ubsa_cfg_request(sc, UBSA_REG_STOP_BITS, value);
512 if (t->c_cflag & CRTSCTS)
513 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
515 if (t->c_iflag & (IXON | IXOFF))
516 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
518 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, value);
522 ubsa_start_read(struct ucom_softc *ucom)
524 struct ubsa_softc *sc = ucom->sc_parent;
526 /* start interrupt endpoint */
527 usbd_transfer_start(sc->sc_xfer[UBSA_INTR_DT_RD]);
529 /* start read endpoint */
530 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_RD]);
534 ubsa_stop_read(struct ucom_softc *ucom)
536 struct ubsa_softc *sc = ucom->sc_parent;
538 /* stop interrupt endpoint */
539 usbd_transfer_stop(sc->sc_xfer[UBSA_INTR_DT_RD]);
541 /* stop read endpoint */
542 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_RD]);
546 ubsa_start_write(struct ucom_softc *ucom)
548 struct ubsa_softc *sc = ucom->sc_parent;
550 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_WR]);
554 ubsa_stop_write(struct ucom_softc *ucom)
556 struct ubsa_softc *sc = ucom->sc_parent;
558 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_WR]);
562 ubsa_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
564 struct ubsa_softc *sc = ucom->sc_parent;
573 ubsa_write_callback(struct usb_xfer *xfer, usb_error_t error)
575 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
576 struct usb_page_cache *pc;
579 switch (USB_GET_STATE(xfer)) {
581 case USB_ST_TRANSFERRED:
583 pc = usbd_xfer_get_frame(xfer, 0);
584 if (ucom_get_data(&sc->sc_ucom, pc, 0,
585 UBSA_BSIZE, &actlen)) {
587 usbd_xfer_set_frame_len(xfer, 0, actlen);
588 usbd_transfer_submit(xfer);
593 if (error != USB_ERR_CANCELLED) {
594 /* try to clear stall first */
595 usbd_xfer_set_stall(xfer);
604 ubsa_read_callback(struct usb_xfer *xfer, usb_error_t error)
606 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
607 struct usb_page_cache *pc;
610 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
612 switch (USB_GET_STATE(xfer)) {
613 case USB_ST_TRANSFERRED:
614 pc = usbd_xfer_get_frame(xfer, 0);
615 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
619 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
620 usbd_transfer_submit(xfer);
624 if (error != USB_ERR_CANCELLED) {
625 /* try to clear stall first */
626 usbd_xfer_set_stall(xfer);
635 ubsa_intr_callback(struct usb_xfer *xfer, usb_error_t error)
637 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
638 struct usb_page_cache *pc;
642 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
644 switch (USB_GET_STATE(xfer)) {
645 case USB_ST_TRANSFERRED:
647 if (actlen >= (int)sizeof(buf)) {
648 pc = usbd_xfer_get_frame(xfer, 0);
649 usbd_copy_out(pc, 0, buf, sizeof(buf));
652 * incidentally, Belkin adapter status bits match
658 DPRINTF("lsr = 0x%02x, msr = 0x%02x\n",
659 sc->sc_lsr, sc->sc_msr);
661 ucom_status_change(&sc->sc_ucom);
663 DPRINTF("ignoring short packet, %d bytes\n", actlen);
668 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
669 usbd_transfer_submit(xfer);
673 if (error != USB_ERR_CANCELLED) {
674 /* try to clear stall first */
675 usbd_xfer_set_stall(xfer);
684 ubsa_poll(struct ucom_softc *ucom)
686 struct ubsa_softc *sc = ucom->sc_parent;
687 usbd_transfer_poll(sc->sc_xfer, UBSA_N_TRANSFER);