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
28 * Copyright (c) 2001 The NetBSD Foundation, Inc.
29 * All rights reserved.
31 * This code is derived from software contributed to The NetBSD Foundation
32 * by Ichiro FUKUHARA (ichiro@ichiro.org).
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 * This product includes software developed by the NetBSD
45 * Foundation, Inc. and its contributors.
46 * 4. Neither the name of The NetBSD Foundation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
51 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
52 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
54 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
55 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
56 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
57 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
58 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
60 * POSSIBILITY OF SUCH DAMAGE.
62 * $FreeBSD: src/sys/dev/usb/ubsa.c,v 1.11 2003/11/16 12:13:39 akiyama Exp $
63 * $DragonFly: src/sys/dev/usbmisc/ubsa/ubsa.c,v 1.16 2007/08/19 17:16:43 hasso Exp $
66 #include <sys/param.h>
67 #include <sys/systm.h>
68 #include <sys/kernel.h>
69 #include <sys/malloc.h>
71 #include <sys/ioccom.h>
72 #include <sys/fcntl.h>
73 #include <sys/interrupt.h>
77 #include <sys/select.h>
80 #include <sys/sysctl.h>
82 #include <bus/usb/usb.h>
83 #include <bus/usb/usbcdc.h>
85 #include <bus/usb/usbdi.h>
86 #include <bus/usb/usbdi_util.h>
87 #include <bus/usb/usbdevs.h>
88 #include <bus/usb/usb_quirks.h>
90 #include "../ucom/ucomvar.h"
93 static int ubsadebug = 0;
94 SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
95 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
96 &ubsadebug, 0, "ubsa debug level");
98 #define DPRINTFN(n, x) do { \
99 if (ubsadebug > (n)) \
103 #define DPRINTFN(n, x)
105 #define DPRINTF(x) DPRINTFN(0, x)
107 #define UBSA_MODVER 1 /* module version */
109 #define UBSA_CONFIG_INDEX 1
110 #define UBSA_IFACE_INDEX 0
112 #define UBSA_INTR_INTERVAL 100 /* ms */
114 #define UBSA_SET_BAUDRATE 0x00
115 #define UBSA_SET_STOP_BITS 0x01
116 #define UBSA_SET_DATA_BITS 0x02
117 #define UBSA_SET_PARITY 0x03
118 #define UBSA_SET_DTR 0x0A
119 #define UBSA_SET_RTS 0x0B
120 #define UBSA_SET_BREAK 0x0C
121 #define UBSA_SET_FLOW_CTRL 0x10
123 #define UBSA_PARITY_NONE 0x00
124 #define UBSA_PARITY_EVEN 0x01
125 #define UBSA_PARITY_ODD 0x02
126 #define UBSA_PARITY_MARK 0x03
127 #define UBSA_PARITY_SPACE 0x04
129 #define UBSA_FLOW_NONE 0x0000
130 #define UBSA_FLOW_OCTS 0x0001
131 #define UBSA_FLOW_ODSR 0x0002
132 #define UBSA_FLOW_IDSR 0x0004
133 #define UBSA_FLOW_IDTR 0x0008
134 #define UBSA_FLOW_IRTS 0x0010
135 #define UBSA_FLOW_ORTS 0x0020
136 #define UBSA_FLOW_UNKNOWN 0x0040
137 #define UBSA_FLOW_OXON 0x0080
138 #define UBSA_FLOW_IXON 0x0100
140 /* line status register */
141 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
142 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
143 #define UBSA_LSR_BI 0x10 /* Break detected */
144 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
145 #define UBSA_LSR_PE 0x04 /* Parity error */
146 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
147 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
148 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
150 /* modem status register */
151 /* All deltas are from the last read of the MSR. */
152 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
153 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
154 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
155 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
156 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
157 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
158 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
159 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
162 struct ucom_softc sc_ucom;
164 int sc_iface_number; /* interface number */
166 usbd_interface_handle sc_intr_iface; /* interrupt interface */
167 int sc_intr_number; /* interrupt number */
168 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */
169 u_char *sc_intr_buf; /* interrupt buffer */
172 u_char sc_dtr; /* current DTR state */
173 u_char sc_rts; /* current RTS state */
175 u_char sc_lsr; /* Local status register */
176 u_char sc_msr; /* ubsa status register */
179 static void ubsa_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
180 static void ubsa_notify(void *);
182 static void ubsa_get_status(void *, int, u_char *, u_char *);
183 static void ubsa_set(void *, int, int, int);
184 static int ubsa_param(void *, int, struct termios *);
185 static int ubsa_open(void *, int);
186 static void ubsa_close(void *, int);
188 static int ubsa_request(struct ubsa_softc *, u_int8_t, u_int16_t);
189 static void ubsa_dtr(struct ubsa_softc *, int);
190 static void ubsa_rts(struct ubsa_softc *, int);
191 static void ubsa_baudrate(struct ubsa_softc *, speed_t);
192 static void ubsa_parity(struct ubsa_softc *, tcflag_t);
193 static void ubsa_databits(struct ubsa_softc *, tcflag_t);
194 static void ubsa_stopbits(struct ubsa_softc *, tcflag_t);
195 static void ubsa_flow(struct ubsa_softc *, tcflag_t, tcflag_t);
197 struct ucom_callback ubsa_callback = {
208 static const struct ubsa_product {
211 } ubsa_products [] = {
213 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103 },
215 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120 },
216 /* GoHubs GO-COM232 */
217 { USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM },
218 /* GoHubs GO-COM232 */
219 { USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232 },
220 /* HandyTech's Braille displays */
221 { USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_HANDYLINK },
223 { USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1 },
227 static device_probe_t ubsa_match;
228 static device_attach_t ubsa_attach;
229 static device_detach_t ubsa_detach;
231 static device_method_t ubsa_methods[] = {
232 /* Device interface */
233 DEVMETHOD(device_probe, ubsa_match),
234 DEVMETHOD(device_attach, ubsa_attach),
235 DEVMETHOD(device_detach, ubsa_detach),
239 static driver_t ubsa_driver = {
242 sizeof (struct ubsa_softc)
245 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ucom_devclass, usbd_driver_load, 0);
246 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
247 MODULE_DEPEND(ubsa, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
248 MODULE_VERSION(ubsa, UBSA_MODVER);
251 ubsa_match(device_t self)
253 struct usb_attach_arg *uaa = device_get_ivars(self);
256 if (uaa->iface != NULL)
257 return (UMATCH_NONE);
259 for (i = 0; ubsa_products[i].vendor != 0; i++) {
260 if (ubsa_products[i].vendor == uaa->vendor &&
261 ubsa_products[i].product == uaa->product) {
262 return (UMATCH_VENDOR_PRODUCT);
265 return (UMATCH_NONE);
269 ubsa_attach(device_t self)
271 struct ubsa_softc *sc = device_get_softc(self);
272 struct usb_attach_arg *uaa = device_get_ivars(self);
273 usbd_device_handle dev;
274 struct ucom_softc *ucom;
275 usb_config_descriptor_t *cdesc;
276 usb_interface_descriptor_t *id;
277 usb_endpoint_descriptor_t *ed;
283 devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT);
286 bzero(sc, sizeof (struct ubsa_softc));
289 * initialize rts, dtr variables to something
290 * different from boolean 0, 1
295 usbd_devinfo(dev, 0, devinfo);
297 device_set_desc_copy(self, devinfo);
300 ucom->sc_iface = uaa->iface;
302 device_printf(ucom->sc_dev, "%s\n", devinfo);
304 DPRINTF(("ubsa attach: sc = %p\n", sc));
306 /* initialize endpoints */
307 ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
308 sc->sc_intr_number = -1;
309 sc->sc_intr_pipe = NULL;
311 /* Move the device into the configured state. */
312 err = usbd_set_config_index(dev, UBSA_CONFIG_INDEX, 1);
314 device_printf(ucom->sc_dev, "failed to set configuration: %s\n",
320 /* get the config descriptor */
321 cdesc = usbd_get_config_descriptor(ucom->sc_udev);
324 device_printf(ucom->sc_dev, "failed to get configuration "
330 /* get the first interface */
331 err = usbd_device2interface_handle(dev, UBSA_IFACE_INDEX,
334 device_printf(ucom->sc_dev, "failed to get interface: %s\n",
340 /* Find the endpoints */
342 id = usbd_get_interface_descriptor(ucom->sc_iface);
343 sc->sc_iface_number = id->bInterfaceNumber;
345 for (i = 0; i < id->bNumEndpoints; i++) {
346 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
348 device_printf(ucom->sc_dev, "no endpoint descriptor "
354 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
355 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
356 sc->sc_intr_number = ed->bEndpointAddress;
357 sc->sc_isize = UGETW(ed->wMaxPacketSize);
358 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
359 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
360 ucom->sc_bulkin_no = ed->bEndpointAddress;
361 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
362 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
363 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
364 ucom->sc_bulkout_no = ed->bEndpointAddress;
365 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
369 if (sc->sc_intr_number == -1) {
370 device_printf(ucom->sc_dev, "could not find interrupt in\n");
375 /* keep interface for interrupt */
376 sc->sc_intr_iface = ucom->sc_iface;
378 if (ucom->sc_bulkin_no == -1) {
379 device_printf(ucom->sc_dev, "could not find data bulk in\n");
384 if (ucom->sc_bulkout_no == -1) {
385 device_printf(ucom->sc_dev, "could not find data bulk out\n");
390 ucom->sc_parent = sc;
391 ucom->sc_portno = UCOM_UNK_PORTNO;
392 /* bulkin, bulkout set above */
393 ucom->sc_ibufsizepad = ucom->sc_ibufsize;
394 ucom->sc_opkthdrlen = 0;
395 ucom->sc_callback = &ubsa_callback;
397 DPRINTF(("ubsa: in = 0x%x, out = 0x%x, intr = 0x%x\n",
398 ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
402 kfree(devinfo, M_USBDEV);
406 kfree(devinfo, M_USBDEV);
411 ubsa_detach(device_t self)
413 struct ubsa_softc *sc = device_get_softc(self);
417 DPRINTF(("ubsa_detach: sc = %p\n", sc));
419 if (sc->sc_intr_pipe != NULL) {
420 usbd_abort_pipe(sc->sc_intr_pipe);
421 usbd_close_pipe(sc->sc_intr_pipe);
422 kfree(sc->sc_intr_buf, M_USBDEV);
423 sc->sc_intr_pipe = NULL;
426 sc->sc_ucom.sc_dying = 1;
428 rv = ucom_detach(&sc->sc_ucom);
434 ubsa_request(struct ubsa_softc *sc, u_int8_t request, u_int16_t value)
436 usb_device_request_t req;
439 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
440 req.bRequest = request;
441 USETW(req.wValue, value);
442 USETW(req.wIndex, sc->sc_iface_number);
443 USETW(req.wLength, 0);
445 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
447 device_printf(sc->sc_ucom.sc_dev, "ubsa_request: %s\n",
453 ubsa_dtr(struct ubsa_softc *sc, int onoff)
456 DPRINTF(("ubsa_dtr: onoff = %d\n", onoff));
458 if (sc->sc_dtr == onoff)
462 ubsa_request(sc, UBSA_SET_DTR, onoff ? 1 : 0);
466 ubsa_rts(struct ubsa_softc *sc, int onoff)
469 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
471 if (sc->sc_rts == onoff)
475 ubsa_request(sc, UBSA_SET_RTS, onoff ? 1 : 0);
479 ubsa_break(struct ubsa_softc *sc, int onoff)
482 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
484 ubsa_request(sc, UBSA_SET_BREAK, onoff ? 1 : 0);
488 ubsa_set(void *addr, int portno, int reg, int onoff)
490 struct ubsa_softc *sc;
501 ubsa_break(sc, onoff);
509 ubsa_baudrate(struct ubsa_softc *sc, speed_t speed)
513 DPRINTF(("ubsa_baudrate: speed = %d\n", speed));
529 value = B230400 / speed;
532 device_printf(sc->sc_ucom.sc_dev, "ubsa_param: unsupported "
533 "baudrate, forcing default of 9600\n");
534 value = B230400 / B9600;
543 ubsa_request(sc, UBSA_SET_BAUDRATE, value);
547 ubsa_parity(struct ubsa_softc *sc, tcflag_t cflag)
551 DPRINTF(("ubsa_parity: cflag = 0x%x\n", cflag));
554 value = (cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
556 value = UBSA_PARITY_NONE;
558 ubsa_request(sc, UBSA_SET_PARITY, value);
562 ubsa_databits(struct ubsa_softc *sc, tcflag_t cflag)
566 DPRINTF(("ubsa_databits: cflag = 0x%x\n", cflag));
568 switch (cflag & CSIZE) {
569 case CS5: value = 0; break;
570 case CS6: value = 1; break;
571 case CS7: value = 2; break;
572 case CS8: value = 3; break;
574 device_printf(sc->sc_ucom.sc_dev, "ubsa_param: unsupported "
575 "databits requested, forcing default of 8\n");
579 ubsa_request(sc, UBSA_SET_DATA_BITS, value);
583 ubsa_stopbits(struct ubsa_softc *sc, tcflag_t cflag)
587 DPRINTF(("ubsa_stopbits: cflag = 0x%x\n", cflag));
589 value = (cflag & CSTOPB) ? 1 : 0;
591 ubsa_request(sc, UBSA_SET_STOP_BITS, value);
595 ubsa_flow(struct ubsa_softc *sc, tcflag_t cflag, tcflag_t iflag)
599 DPRINTF(("ubsa_flow: cflag = 0x%x, iflag = 0x%x\n", cflag, iflag));
603 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
604 if (iflag & (IXON|IXOFF))
605 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
607 ubsa_request(sc, UBSA_SET_FLOW_CTRL, value);
611 ubsa_param(void *addr, int portno, struct termios *ti)
613 struct ubsa_softc *sc;
617 DPRINTF(("ubsa_param: sc = %p\n", sc));
619 ubsa_baudrate(sc, ti->c_ospeed);
620 ubsa_parity(sc, ti->c_cflag);
621 ubsa_databits(sc, ti->c_cflag);
622 ubsa_stopbits(sc, ti->c_cflag);
623 ubsa_flow(sc, ti->c_cflag, ti->c_iflag);
629 ubsa_open(void *addr, int portno)
631 struct ubsa_softc *sc;
635 if (sc->sc_ucom.sc_dying)
638 DPRINTF(("ubsa_open: sc = %p\n", sc));
640 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
641 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
642 err = usbd_open_pipe_intr(sc->sc_intr_iface,
652 device_printf(sc->sc_ucom.sc_dev, "cannot open "
653 "interrupt pipe (addr %d)\n",
663 ubsa_close(void *addr, int portno)
665 struct ubsa_softc *sc;
669 if (sc->sc_ucom.sc_dying)
672 DPRINTF(("ubsa_close: close\n"));
674 if (sc->sc_intr_pipe != NULL) {
675 err = usbd_abort_pipe(sc->sc_intr_pipe);
677 device_printf(sc->sc_ucom.sc_dev, "abort interrupt "
678 "pipe failed: %s\n", usbd_errstr(err));
679 err = usbd_close_pipe(sc->sc_intr_pipe);
681 device_printf(sc->sc_ucom.sc_dev, "close interrupt "
682 "pipe failed: %s\n", usbd_errstr(err));
683 kfree(sc->sc_intr_buf, M_USBDEV);
684 sc->sc_intr_pipe = NULL;
689 ubsa_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
691 struct ubsa_softc *sc;
695 buf = sc->sc_intr_buf;
696 if (sc->sc_ucom.sc_dying)
699 if (status != USBD_NORMAL_COMPLETION) {
700 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
703 DPRINTF(("%s: ubsa_intr: abnormal status: %s\n",
704 device_get_nameunit(sc->sc_ucom.sc_dev),
705 usbd_errstr(status)));
706 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
710 /* incidentally, Belkin adapter status bits match UART 16550 bits */
714 DPRINTF(("%s: ubsa lsr = 0x%02x, msr = 0x%02x\n",
715 device_get_nameunit(sc->sc_ucom.sc_dev), sc->sc_lsr, sc->sc_msr));
720 /* Handle delayed events. */
722 ubsa_notify(void *arg)
724 struct ubsa_softc *sc;
727 ucom_status_change(&sc->sc_ucom);
731 ubsa_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
733 struct ubsa_softc *sc;
735 DPRINTF(("ubsa_get_status\n"));