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/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/malloc.h>
69 #include <sys/module.h>
71 #include <sys/ioccom.h>
72 #include <sys/fcntl.h>
73 #include <sys/taskqueue.h>
77 #if __FreeBSD_version >= 500014
78 #include <sys/selinfo.h>
80 #include <sys/select.h>
84 #include <sys/sysctl.h>
86 #include <dev/usb/usb.h>
87 #include <dev/usb/usbcdc.h>
89 #include <dev/usb/usbdi.h>
90 #include <dev/usb/usbdi_util.h>
92 #include <dev/usb/usb_quirks.h>
94 #include <dev/usb/ucomvar.h>
97 Static int ubsadebug = 0;
98 SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
99 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
100 &ubsadebug, 0, "ubsa debug level");
102 #define DPRINTFN(n, x) do { \
103 if (ubsadebug > (n)) \
107 #define DPRINTFN(n, x)
109 #define DPRINTF(x) DPRINTFN(0, x)
111 #define UBSA_MODVER 1 /* module version */
113 #define UBSA_CONFIG_INDEX 1
114 #define UBSA_IFACE_INDEX 0
116 #define UBSA_INTR_INTERVAL 100 /* ms */
118 #define UBSA_SET_BAUDRATE 0x00
119 #define UBSA_SET_STOP_BITS 0x01
120 #define UBSA_SET_DATA_BITS 0x02
121 #define UBSA_SET_PARITY 0x03
122 #define UBSA_SET_DTR 0x0A
123 #define UBSA_SET_RTS 0x0B
124 #define UBSA_SET_BREAK 0x0C
125 #define UBSA_SET_FLOW_CTRL 0x10
127 #define UBSA_PARITY_NONE 0x00
128 #define UBSA_PARITY_EVEN 0x01
129 #define UBSA_PARITY_ODD 0x02
130 #define UBSA_PARITY_MARK 0x03
131 #define UBSA_PARITY_SPACE 0x04
133 #define UBSA_FLOW_NONE 0x0000
134 #define UBSA_FLOW_OCTS 0x0001
135 #define UBSA_FLOW_ODSR 0x0002
136 #define UBSA_FLOW_IDSR 0x0004
137 #define UBSA_FLOW_IDTR 0x0008
138 #define UBSA_FLOW_IRTS 0x0010
139 #define UBSA_FLOW_ORTS 0x0020
140 #define UBSA_FLOW_UNKNOWN 0x0040
141 #define UBSA_FLOW_OXON 0x0080
142 #define UBSA_FLOW_IXON 0x0100
144 /* line status register */
145 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
146 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
147 #define UBSA_LSR_BI 0x10 /* Break detected */
148 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
149 #define UBSA_LSR_PE 0x04 /* Parity error */
150 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
151 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
152 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
154 /* modem status register */
155 /* All deltas are from the last read of the MSR. */
156 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
157 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
158 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
159 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
160 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
161 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
162 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
163 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
166 struct ucom_softc sc_ucom;
168 int sc_iface_number; /* interface number */
170 usbd_interface_handle sc_intr_iface; /* interrupt interface */
171 int sc_intr_number; /* interrupt number */
172 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */
173 u_char *sc_intr_buf; /* interrupt buffer */
176 u_char sc_dtr; /* current DTR state */
177 u_char sc_rts; /* current RTS state */
179 u_char sc_lsr; /* Local status register */
180 u_char sc_msr; /* ubsa status register */
184 Static void ubsa_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
185 Static void ubsa_notify(void *, int count);
187 Static void ubsa_get_status(void *, int, u_char *, u_char *);
188 Static void ubsa_set(void *, int, int, int);
189 Static int ubsa_param(void *, int, struct termios *);
190 Static int ubsa_open(void *, int);
191 Static void ubsa_close(void *, int);
193 Static int ubsa_request(struct ubsa_softc *, u_int8_t, u_int16_t);
194 Static void ubsa_dtr(struct ubsa_softc *, int);
195 Static void ubsa_rts(struct ubsa_softc *, int);
196 Static void ubsa_baudrate(struct ubsa_softc *, speed_t);
197 Static void ubsa_parity(struct ubsa_softc *, tcflag_t);
198 Static void ubsa_databits(struct ubsa_softc *, tcflag_t);
199 Static void ubsa_stopbits(struct ubsa_softc *, tcflag_t);
200 Static void ubsa_flow(struct ubsa_softc *, tcflag_t, tcflag_t);
202 struct ucom_callback ubsa_callback = {
213 Static const struct ubsa_product {
216 } ubsa_products [] = {
218 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103 },
220 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120 },
221 /* GoHubs GO-COM232 */
222 { USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM },
223 /* GoHubs GO-COM232 */
224 { USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232 },
226 { USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1 },
228 { USB_VENDOR_VODAFONE, USB_PRODUCT_VODAFONE_MC3G },
232 Static device_probe_t ubsa_match;
233 Static device_attach_t ubsa_attach;
234 Static device_detach_t ubsa_detach;
236 Static device_method_t ubsa_methods[] = {
237 /* Device interface */
238 DEVMETHOD(device_probe, ubsa_match),
239 DEVMETHOD(device_attach, ubsa_attach),
240 DEVMETHOD(device_detach, ubsa_detach),
244 Static driver_t ubsa_driver = {
247 sizeof (struct ubsa_softc)
250 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ucom_devclass, usbd_driver_load, 0);
251 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
252 MODULE_DEPEND(ubsa, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
253 MODULE_VERSION(ubsa, UBSA_MODVER);
257 USB_MATCH_START(ubsa, uaa);
260 if (uaa->iface != NULL)
261 return (UMATCH_NONE);
263 for (i = 0; ubsa_products[i].vendor != 0; i++) {
264 if (ubsa_products[i].vendor == uaa->vendor &&
265 ubsa_products[i].product == uaa->product) {
266 return (UMATCH_VENDOR_PRODUCT);
269 return (UMATCH_NONE);
274 USB_ATTACH_START(ubsa, sc, uaa);
275 usbd_device_handle dev;
276 struct ucom_softc *ucom;
277 usb_config_descriptor_t *cdesc;
278 usb_interface_descriptor_t *id;
279 usb_endpoint_descriptor_t *ed;
286 devinfo = malloc(1024, M_USBDEV, M_WAITOK);
289 bzero(sc, sizeof (struct ubsa_softc));
292 * initialize rts, dtr variables to something
293 * different from boolean 0, 1
298 usbd_devinfo(dev, 0, devinfo);
299 /* USB_ATTACH_SETUP; */
301 device_set_desc_copy(self, devinfo);
302 /* USB_ATTACH_SETUP; */
305 ucom->sc_iface = uaa->iface;
307 devname = USBDEVNAME(ucom->sc_dev);
308 printf("%s: %s\n", devname, devinfo);
310 DPRINTF(("ubsa attach: sc = %p\n", sc));
312 /* initialize endpoints */
313 ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
314 sc->sc_intr_number = -1;
315 sc->sc_intr_pipe = NULL;
317 /* Move the device into the configured state. */
318 err = usbd_set_config_index(dev, UBSA_CONFIG_INDEX, 1);
320 printf("%s: failed to set configuration: %s\n",
321 devname, usbd_errstr(err));
326 /* get the config descriptor */
327 cdesc = usbd_get_config_descriptor(ucom->sc_udev);
330 printf("%s: failed to get configuration descriptor\n",
331 USBDEVNAME(ucom->sc_dev));
336 /* get the first interface */
337 err = usbd_device2interface_handle(dev, UBSA_IFACE_INDEX,
340 printf("%s: failed to get interface: %s\n",
341 devname, usbd_errstr(err));
346 /* Find the endpoints */
348 id = usbd_get_interface_descriptor(ucom->sc_iface);
349 sc->sc_iface_number = id->bInterfaceNumber;
351 for (i = 0; i < id->bNumEndpoints; i++) {
352 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
354 printf("%s: no endpoint descriptor for %d\n",
355 USBDEVNAME(ucom->sc_dev), i);
360 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
361 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
362 sc->sc_intr_number = ed->bEndpointAddress;
363 sc->sc_isize = UGETW(ed->wMaxPacketSize);
364 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
365 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
366 ucom->sc_bulkin_no = ed->bEndpointAddress;
367 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
368 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
369 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
370 ucom->sc_bulkout_no = ed->bEndpointAddress;
371 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
375 if (sc->sc_intr_number == -1) {
376 printf("%s: Could not find interrupt in\n",
377 USBDEVNAME(ucom->sc_dev));
382 /* keep interface for interrupt */
383 sc->sc_intr_iface = ucom->sc_iface;
385 if (ucom->sc_bulkin_no == -1) {
386 printf("%s: Could not find data bulk in\n",
387 USBDEVNAME(ucom->sc_dev));
392 if (ucom->sc_bulkout_no == -1) {
393 printf("%s: Could not find data bulk out\n",
394 USBDEVNAME(ucom->sc_dev));
399 ucom->sc_parent = sc;
400 ucom->sc_portno = UCOM_UNK_PORTNO;
401 /* bulkin, bulkout set above */
402 ucom->sc_ibufsizepad = ucom->sc_ibufsize;
403 ucom->sc_opkthdrlen = 0;
404 ucom->sc_callback = &ubsa_callback;
406 DPRINTF(("ubsa: in = 0x%x, out = 0x%x, intr = 0x%x\n",
407 ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
409 TASK_INIT(&sc->sc_task, 0, ubsa_notify, sc);
412 free(devinfo, M_USBDEV);
413 USB_ATTACH_SUCCESS_RETURN;
416 free(devinfo, M_USBDEV);
417 USB_ATTACH_ERROR_RETURN;
422 USB_DETACH_START(ubsa, sc);
426 DPRINTF(("ubsa_detach: sc = %p\n", sc));
428 if (sc->sc_intr_pipe != NULL) {
429 usbd_abort_pipe(sc->sc_intr_pipe);
430 usbd_close_pipe(sc->sc_intr_pipe);
431 free(sc->sc_intr_buf, M_USBDEV);
432 sc->sc_intr_pipe = NULL;
435 sc->sc_ucom.sc_dying = 1;
437 taskqueue_drain(taskqueue_swi_giant);
439 rv = ucom_detach(&sc->sc_ucom);
445 ubsa_request(struct ubsa_softc *sc, u_int8_t request, u_int16_t value)
447 usb_device_request_t req;
450 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
451 req.bRequest = request;
452 USETW(req.wValue, value);
453 USETW(req.wIndex, sc->sc_iface_number);
454 USETW(req.wLength, 0);
456 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
458 printf("%s: ubsa_request: %s\n",
459 USBDEVNAME(sc->sc_ucom.sc_dev), usbd_errstr(err));
464 ubsa_dtr(struct ubsa_softc *sc, int onoff)
467 DPRINTF(("ubsa_dtr: onoff = %d\n", onoff));
469 if (sc->sc_dtr == onoff)
473 ubsa_request(sc, UBSA_SET_DTR, onoff ? 1 : 0);
477 ubsa_rts(struct ubsa_softc *sc, int onoff)
480 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
482 if (sc->sc_rts == onoff)
486 ubsa_request(sc, UBSA_SET_RTS, onoff ? 1 : 0);
490 ubsa_break(struct ubsa_softc *sc, int onoff)
493 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
495 ubsa_request(sc, UBSA_SET_BREAK, onoff ? 1 : 0);
499 ubsa_set(void *addr, int portno, int reg, int onoff)
501 struct ubsa_softc *sc;
512 ubsa_break(sc, onoff);
520 ubsa_baudrate(struct ubsa_softc *sc, speed_t speed)
524 DPRINTF(("ubsa_baudrate: speed = %d\n", speed));
540 value = B230400 / speed;
543 printf("%s: ubsa_param: unsupported baudrate, "
544 "forcing default of 9600\n",
545 USBDEVNAME(sc->sc_ucom.sc_dev));
546 value = B230400 / B9600;
555 ubsa_request(sc, UBSA_SET_BAUDRATE, value);
559 ubsa_parity(struct ubsa_softc *sc, tcflag_t cflag)
563 DPRINTF(("ubsa_parity: cflag = 0x%x\n", cflag));
566 value = (cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
568 value = UBSA_PARITY_NONE;
570 ubsa_request(sc, UBSA_SET_PARITY, value);
574 ubsa_databits(struct ubsa_softc *sc, tcflag_t cflag)
578 DPRINTF(("ubsa_databits: cflag = 0x%x\n", cflag));
580 switch (cflag & CSIZE) {
581 case CS5: value = 0; break;
582 case CS6: value = 1; break;
583 case CS7: value = 2; break;
584 case CS8: value = 3; break;
586 printf("%s: ubsa_param: unsupported databits requested, "
587 "forcing default of 8\n",
588 USBDEVNAME(sc->sc_ucom.sc_dev));
592 ubsa_request(sc, UBSA_SET_DATA_BITS, value);
596 ubsa_stopbits(struct ubsa_softc *sc, tcflag_t cflag)
600 DPRINTF(("ubsa_stopbits: cflag = 0x%x\n", cflag));
602 value = (cflag & CSTOPB) ? 1 : 0;
604 ubsa_request(sc, UBSA_SET_STOP_BITS, value);
608 ubsa_flow(struct ubsa_softc *sc, tcflag_t cflag, tcflag_t iflag)
612 DPRINTF(("ubsa_flow: cflag = 0x%x, iflag = 0x%x\n", cflag, iflag));
616 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
617 if (iflag & (IXON|IXOFF))
618 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
620 ubsa_request(sc, UBSA_SET_FLOW_CTRL, value);
624 ubsa_param(void *addr, int portno, struct termios *ti)
626 struct ubsa_softc *sc;
630 DPRINTF(("ubsa_param: sc = %p\n", sc));
632 ubsa_baudrate(sc, ti->c_ospeed);
633 ubsa_parity(sc, ti->c_cflag);
634 ubsa_databits(sc, ti->c_cflag);
635 ubsa_stopbits(sc, ti->c_cflag);
636 ubsa_flow(sc, ti->c_cflag, ti->c_iflag);
642 ubsa_open(void *addr, int portno)
644 struct ubsa_softc *sc;
648 if (sc->sc_ucom.sc_dying)
651 DPRINTF(("ubsa_open: sc = %p\n", sc));
653 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
654 sc->sc_intr_buf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
655 err = usbd_open_pipe_intr(sc->sc_intr_iface,
665 printf("%s: cannot open interrupt pipe (addr %d)\n",
666 USBDEVNAME(sc->sc_ucom.sc_dev),
676 ubsa_close(void *addr, int portno)
678 struct ubsa_softc *sc;
682 if (sc->sc_ucom.sc_dying)
685 DPRINTF(("ubsa_close: close\n"));
687 if (sc->sc_intr_pipe != NULL) {
688 err = usbd_abort_pipe(sc->sc_intr_pipe);
690 printf("%s: abort interrupt pipe failed: %s\n",
691 USBDEVNAME(sc->sc_ucom.sc_dev),
693 err = usbd_close_pipe(sc->sc_intr_pipe);
695 printf("%s: close interrupt pipe failed: %s\n",
696 USBDEVNAME(sc->sc_ucom.sc_dev),
698 free(sc->sc_intr_buf, M_USBDEV);
699 sc->sc_intr_pipe = NULL;
704 ubsa_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
706 struct ubsa_softc *sc;
710 buf = sc->sc_intr_buf;
711 if (sc->sc_ucom.sc_dying)
714 if (status != USBD_NORMAL_COMPLETION) {
715 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
718 DPRINTF(("%s: ubsa_intr: abnormal status: %s\n",
719 USBDEVNAME(sc->sc_ucom.sc_dev),
720 usbd_errstr(status)));
721 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
725 /* incidentally, Belkin adapter status bits match UART 16550 bits */
729 DPRINTF(("%s: ubsa lsr = 0x%02x, msr = 0x%02x\n",
730 USBDEVNAME(sc->sc_ucom.sc_dev), sc->sc_lsr, sc->sc_msr));
732 taskqueue_enqueue(taskqueue_swi_giant, &sc->sc_task);
735 /* Handle delayed events. */
737 ubsa_notify(void *arg, int count)
739 struct ubsa_softc *sc;
742 ucom_status_change(&sc->sc_ucom);
746 ubsa_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
748 struct ubsa_softc *sc;
750 DPRINTF(("ubsa_get_status\n"));