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/linker_set.h>
74 #include <sys/module.h>
76 #include <sys/mutex.h>
77 #include <sys/condvar.h>
78 #include <sys/sysctl.h>
80 #include <sys/unistd.h>
81 #include <sys/callout.h>
82 #include <sys/malloc.h>
85 #include <dev/usb/usb.h>
86 #include <dev/usb/usbdi.h>
87 #include <dev/usb/usbdi_util.h>
90 #define USB_DEBUG_VAR ubsa_debug
91 #include <dev/usb/usb_debug.h>
92 #include <dev/usb/usb_process.h>
94 #include <dev/usb/serial/usb_serial.h>
97 static int ubsa_debug = 0;
99 SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
100 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
101 &ubsa_debug, 0, "ubsa debug level");
104 #define UBSA_BSIZE 1024 /* bytes */
106 #define UBSA_CONFIG_INDEX 0
107 #define UBSA_IFACE_INDEX 0
109 #define UBSA_REG_BAUDRATE 0x00
110 #define UBSA_REG_STOP_BITS 0x01
111 #define UBSA_REG_DATA_BITS 0x02
112 #define UBSA_REG_PARITY 0x03
113 #define UBSA_REG_DTR 0x0A
114 #define UBSA_REG_RTS 0x0B
115 #define UBSA_REG_BREAK 0x0C
116 #define UBSA_REG_FLOW_CTRL 0x10
118 #define UBSA_PARITY_NONE 0x00
119 #define UBSA_PARITY_EVEN 0x01
120 #define UBSA_PARITY_ODD 0x02
121 #define UBSA_PARITY_MARK 0x03
122 #define UBSA_PARITY_SPACE 0x04
124 #define UBSA_FLOW_NONE 0x0000
125 #define UBSA_FLOW_OCTS 0x0001
126 #define UBSA_FLOW_ODSR 0x0002
127 #define UBSA_FLOW_IDSR 0x0004
128 #define UBSA_FLOW_IDTR 0x0008
129 #define UBSA_FLOW_IRTS 0x0010
130 #define UBSA_FLOW_ORTS 0x0020
131 #define UBSA_FLOW_UNKNOWN 0x0040
132 #define UBSA_FLOW_OXON 0x0080
133 #define UBSA_FLOW_IXON 0x0100
135 /* line status register */
136 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
137 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
138 #define UBSA_LSR_BI 0x10 /* Break detected */
139 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
140 #define UBSA_LSR_PE 0x04 /* Parity error */
141 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
142 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
143 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
145 /* modem status register */
146 /* All deltas are from the last read of the MSR. */
147 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
148 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
149 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
150 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
151 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
152 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
153 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
154 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
164 struct ucom_super_softc sc_super_ucom;
165 struct ucom_softc sc_ucom;
167 struct usb_xfer *sc_xfer[UBSA_N_TRANSFER];
168 struct usb_device *sc_udev;
171 uint8_t sc_iface_no; /* interface number */
172 uint8_t sc_iface_index; /* interface index */
173 uint8_t sc_lsr; /* local status register */
174 uint8_t sc_msr; /* UBSA status register */
177 static device_probe_t ubsa_probe;
178 static device_attach_t ubsa_attach;
179 static device_detach_t ubsa_detach;
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_cfg_set_dtr(struct ucom_softc *, uint8_t);
187 static void ubsa_cfg_set_rts(struct ucom_softc *, uint8_t);
188 static void ubsa_cfg_set_break(struct ucom_softc *, uint8_t);
189 static int ubsa_pre_param(struct ucom_softc *, struct termios *);
190 static void ubsa_cfg_param(struct ucom_softc *, struct termios *);
191 static void ubsa_start_read(struct ucom_softc *);
192 static void ubsa_stop_read(struct ucom_softc *);
193 static void ubsa_start_write(struct ucom_softc *);
194 static void ubsa_stop_write(struct ucom_softc *);
195 static void ubsa_cfg_get_status(struct ucom_softc *, uint8_t *,
197 static void ubsa_poll(struct ucom_softc *ucom);
199 static const struct usb_config ubsa_config[UBSA_N_TRANSFER] = {
201 [UBSA_BULK_DT_WR] = {
203 .endpoint = UE_ADDR_ANY,
204 .direction = UE_DIR_OUT,
205 .bufsize = UBSA_BSIZE, /* bytes */
206 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
207 .callback = &ubsa_write_callback,
210 [UBSA_BULK_DT_RD] = {
212 .endpoint = UE_ADDR_ANY,
213 .direction = UE_DIR_IN,
214 .bufsize = UBSA_BSIZE, /* bytes */
215 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
216 .callback = &ubsa_read_callback,
219 [UBSA_INTR_DT_RD] = {
220 .type = UE_INTERRUPT,
221 .endpoint = UE_ADDR_ANY,
222 .direction = UE_DIR_IN,
223 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
224 .bufsize = 0, /* use wMaxPacketSize */
225 .callback = &ubsa_intr_callback,
229 static const struct ucom_callback ubsa_callback = {
230 .ucom_cfg_get_status = &ubsa_cfg_get_status,
231 .ucom_cfg_set_dtr = &ubsa_cfg_set_dtr,
232 .ucom_cfg_set_rts = &ubsa_cfg_set_rts,
233 .ucom_cfg_set_break = &ubsa_cfg_set_break,
234 .ucom_cfg_param = &ubsa_cfg_param,
235 .ucom_pre_param = &ubsa_pre_param,
236 .ucom_start_read = &ubsa_start_read,
237 .ucom_stop_read = &ubsa_stop_read,
238 .ucom_start_write = &ubsa_start_write,
239 .ucom_stop_write = &ubsa_stop_write,
240 .ucom_poll = &ubsa_poll,
243 static const struct usb_device_id ubsa_devs[] = {
244 /* AnyData ADU-500A */
245 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A, 0)},
246 /* AnyData ADU-E100A/H */
247 {USB_VPI(USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_E100X, 0)},
248 /* Axesstel MV100H */
249 {USB_VPI(USB_VENDOR_AXESSTEL, USB_PRODUCT_AXESSTEL_DATAMODEM, 0)},
251 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103, 0)},
253 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120, 0)},
254 /* GoHubs GO-COM232 */
255 {USB_VPI(USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM, 0)},
256 /* GoHubs GO-COM232 */
257 {USB_VPI(USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232, 0)},
259 {USB_VPI(USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1, 0)},
262 static device_method_t ubsa_methods[] = {
263 DEVMETHOD(device_probe, ubsa_probe),
264 DEVMETHOD(device_attach, ubsa_attach),
265 DEVMETHOD(device_detach, ubsa_detach),
269 static devclass_t ubsa_devclass;
271 static driver_t ubsa_driver = {
273 .methods = ubsa_methods,
274 .size = sizeof(struct ubsa_softc),
277 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ubsa_devclass, NULL, 0);
278 MODULE_DEPEND(ubsa, ucom, 1, 1, 1);
279 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
282 ubsa_probe(device_t dev)
284 struct usb_attach_arg *uaa = device_get_ivars(dev);
286 if (uaa->usb_mode != USB_MODE_HOST) {
289 if (uaa->info.bConfigIndex != UBSA_CONFIG_INDEX) {
292 if (uaa->info.bIfaceIndex != UBSA_IFACE_INDEX) {
295 return (usbd_lookup_id_by_uaa(ubsa_devs, sizeof(ubsa_devs), uaa));
299 ubsa_attach(device_t dev)
301 struct usb_attach_arg *uaa = device_get_ivars(dev);
302 struct ubsa_softc *sc = device_get_softc(dev);
305 DPRINTF("sc=%p\n", sc);
307 device_set_usb_desc(dev);
308 mtx_init(&sc->sc_mtx, "ubsa", NULL, MTX_DEF);
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");
341 ubsa_detach(device_t dev)
343 struct ubsa_softc *sc = device_get_softc(dev);
345 DPRINTF("sc=%p\n", sc);
347 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1);
348 usbd_transfer_unsetup(sc->sc_xfer, UBSA_N_TRANSFER);
349 mtx_destroy(&sc->sc_mtx);
355 ubsa_cfg_request(struct ubsa_softc *sc, uint8_t index, uint16_t value)
357 struct usb_device_request req;
360 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
361 req.bRequest = index;
362 USETW(req.wValue, value);
363 req.wIndex[0] = sc->sc_iface_no;
365 USETW(req.wLength, 0);
367 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
368 &req, NULL, 0, 1000);
370 DPRINTFN(0, "device request failed, err=%s "
371 "(ignored)\n", usbd_errstr(err));
376 ubsa_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
378 struct ubsa_softc *sc = ucom->sc_parent;
380 DPRINTF("onoff = %d\n", onoff);
382 ubsa_cfg_request(sc, UBSA_REG_DTR, onoff ? 1 : 0);
386 ubsa_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
388 struct ubsa_softc *sc = ucom->sc_parent;
390 DPRINTF("onoff = %d\n", onoff);
392 ubsa_cfg_request(sc, UBSA_REG_RTS, onoff ? 1 : 0);
396 ubsa_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
398 struct ubsa_softc *sc = ucom->sc_parent;
400 DPRINTF("onoff = %d\n", onoff);
402 ubsa_cfg_request(sc, UBSA_REG_BREAK, onoff ? 1 : 0);
406 ubsa_pre_param(struct ucom_softc *ucom, struct termios *t)
409 DPRINTF("sc = %p\n", ucom->sc_parent);
411 switch (t->c_ospeed) {
432 ubsa_cfg_param(struct ucom_softc *ucom, struct termios *t)
434 struct ubsa_softc *sc = ucom->sc_parent;
437 DPRINTF("sc = %p\n", sc);
439 switch (t->c_ospeed) {
441 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, 0);
442 ubsa_cfg_set_dtr(&sc->sc_ucom, 0);
443 ubsa_cfg_set_rts(&sc->sc_ucom, 0);
456 value = B230400 / t->c_ospeed;
457 ubsa_cfg_request(sc, UBSA_REG_BAUDRATE, value);
463 if (t->c_cflag & PARENB)
464 value = (t->c_cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
466 value = UBSA_PARITY_NONE;
468 ubsa_cfg_request(sc, UBSA_REG_PARITY, value);
470 switch (t->c_cflag & CSIZE) {
486 ubsa_cfg_request(sc, UBSA_REG_DATA_BITS, value);
488 value = (t->c_cflag & CSTOPB) ? 1 : 0;
490 ubsa_cfg_request(sc, UBSA_REG_STOP_BITS, value);
493 if (t->c_cflag & CRTSCTS)
494 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
496 if (t->c_iflag & (IXON | IXOFF))
497 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
499 ubsa_cfg_request(sc, UBSA_REG_FLOW_CTRL, value);
503 ubsa_start_read(struct ucom_softc *ucom)
505 struct ubsa_softc *sc = ucom->sc_parent;
507 /* start interrupt endpoint */
508 usbd_transfer_start(sc->sc_xfer[UBSA_INTR_DT_RD]);
510 /* start read endpoint */
511 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_RD]);
515 ubsa_stop_read(struct ucom_softc *ucom)
517 struct ubsa_softc *sc = ucom->sc_parent;
519 /* stop interrupt endpoint */
520 usbd_transfer_stop(sc->sc_xfer[UBSA_INTR_DT_RD]);
522 /* stop read endpoint */
523 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_RD]);
527 ubsa_start_write(struct ucom_softc *ucom)
529 struct ubsa_softc *sc = ucom->sc_parent;
531 usbd_transfer_start(sc->sc_xfer[UBSA_BULK_DT_WR]);
535 ubsa_stop_write(struct ucom_softc *ucom)
537 struct ubsa_softc *sc = ucom->sc_parent;
539 usbd_transfer_stop(sc->sc_xfer[UBSA_BULK_DT_WR]);
543 ubsa_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
545 struct ubsa_softc *sc = ucom->sc_parent;
554 ubsa_write_callback(struct usb_xfer *xfer, usb_error_t error)
556 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
557 struct usb_page_cache *pc;
560 switch (USB_GET_STATE(xfer)) {
562 case USB_ST_TRANSFERRED:
564 pc = usbd_xfer_get_frame(xfer, 0);
565 if (ucom_get_data(&sc->sc_ucom, pc, 0,
566 UBSA_BSIZE, &actlen)) {
568 usbd_xfer_set_frame_len(xfer, 0, actlen);
569 usbd_transfer_submit(xfer);
574 if (error != USB_ERR_CANCELLED) {
575 /* try to clear stall first */
576 usbd_xfer_set_stall(xfer);
585 ubsa_read_callback(struct usb_xfer *xfer, usb_error_t error)
587 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
588 struct usb_page_cache *pc;
591 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
593 switch (USB_GET_STATE(xfer)) {
594 case USB_ST_TRANSFERRED:
595 pc = usbd_xfer_get_frame(xfer, 0);
596 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
600 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
601 usbd_transfer_submit(xfer);
605 if (error != USB_ERR_CANCELLED) {
606 /* try to clear stall first */
607 usbd_xfer_set_stall(xfer);
616 ubsa_intr_callback(struct usb_xfer *xfer, usb_error_t error)
618 struct ubsa_softc *sc = usbd_xfer_softc(xfer);
619 struct usb_page_cache *pc;
623 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
625 switch (USB_GET_STATE(xfer)) {
626 case USB_ST_TRANSFERRED:
628 if (actlen >= sizeof(buf)) {
629 pc = usbd_xfer_get_frame(xfer, 0);
630 usbd_copy_out(pc, 0, buf, sizeof(buf));
633 * incidentally, Belkin adapter status bits match
639 DPRINTF("lsr = 0x%02x, msr = 0x%02x\n",
640 sc->sc_lsr, sc->sc_msr);
642 ucom_status_change(&sc->sc_ucom);
644 DPRINTF("ignoring short packet, %d bytes\n", actlen);
649 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
650 usbd_transfer_submit(xfer);
654 if (error != USB_ERR_CANCELLED) {
655 /* try to clear stall first */
656 usbd_xfer_set_stall(xfer);
665 ubsa_poll(struct ucom_softc *ucom)
667 struct ubsa_softc *sc = ucom->sc_parent;
668 usbd_transfer_poll(sc->sc_xfer, UBSA_N_TRANSFER);