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.13 2007/07/01 21:24:03 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>
79 #include <sys/vnode.h>
81 #include <sys/sysctl.h>
83 #include <bus/usb/usb.h>
84 #include <bus/usb/usbcdc.h>
86 #include <bus/usb/usbdi.h>
87 #include <bus/usb/usbdi_util.h>
88 #include <bus/usb/usbdevs.h>
89 #include <bus/usb/usb_quirks.h>
91 #include "../ucom/ucomvar.h"
94 static int ubsadebug = 0;
95 SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
96 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
97 &ubsadebug, 0, "ubsa debug level");
99 #define DPRINTFN(n, x) do { \
100 if (ubsadebug > (n)) \
104 #define DPRINTFN(n, x)
106 #define DPRINTF(x) DPRINTFN(0, x)
108 #define UBSA_MODVER 1 /* module version */
110 #define UBSA_CONFIG_INDEX 1
111 #define UBSA_IFACE_INDEX 0
113 #define UBSA_INTR_INTERVAL 100 /* ms */
115 #define UBSA_SET_BAUDRATE 0x00
116 #define UBSA_SET_STOP_BITS 0x01
117 #define UBSA_SET_DATA_BITS 0x02
118 #define UBSA_SET_PARITY 0x03
119 #define UBSA_SET_DTR 0x0A
120 #define UBSA_SET_RTS 0x0B
121 #define UBSA_SET_BREAK 0x0C
122 #define UBSA_SET_FLOW_CTRL 0x10
124 #define UBSA_PARITY_NONE 0x00
125 #define UBSA_PARITY_EVEN 0x01
126 #define UBSA_PARITY_ODD 0x02
127 #define UBSA_PARITY_MARK 0x03
128 #define UBSA_PARITY_SPACE 0x04
130 #define UBSA_FLOW_NONE 0x0000
131 #define UBSA_FLOW_OCTS 0x0001
132 #define UBSA_FLOW_ODSR 0x0002
133 #define UBSA_FLOW_IDSR 0x0004
134 #define UBSA_FLOW_IDTR 0x0008
135 #define UBSA_FLOW_IRTS 0x0010
136 #define UBSA_FLOW_ORTS 0x0020
137 #define UBSA_FLOW_UNKNOWN 0x0040
138 #define UBSA_FLOW_OXON 0x0080
139 #define UBSA_FLOW_IXON 0x0100
141 /* line status register */
142 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
143 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
144 #define UBSA_LSR_BI 0x10 /* Break detected */
145 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
146 #define UBSA_LSR_PE 0x04 /* Parity error */
147 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
148 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
149 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
151 /* modem status register */
152 /* All deltas are from the last read of the MSR. */
153 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
154 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
155 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
156 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
157 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
158 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
159 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
160 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
163 struct ucom_softc sc_ucom;
165 int sc_iface_number; /* interface number */
167 usbd_interface_handle sc_intr_iface; /* interrupt interface */
168 int sc_intr_number; /* interrupt number */
169 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */
170 u_char *sc_intr_buf; /* interrupt buffer */
173 u_char sc_dtr; /* current DTR state */
174 u_char sc_rts; /* current RTS state */
176 u_char sc_lsr; /* Local status register */
177 u_char sc_msr; /* ubsa status register */
180 static void ubsa_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
181 static void ubsa_notify(void *);
183 static void ubsa_get_status(void *, int, u_char *, u_char *);
184 static void ubsa_set(void *, int, int, int);
185 static int ubsa_param(void *, int, struct termios *);
186 static int ubsa_open(void *, int);
187 static void ubsa_close(void *, int);
189 static int ubsa_request(struct ubsa_softc *, u_int8_t, u_int16_t);
190 static void ubsa_dtr(struct ubsa_softc *, int);
191 static void ubsa_rts(struct ubsa_softc *, int);
192 static void ubsa_baudrate(struct ubsa_softc *, speed_t);
193 static void ubsa_parity(struct ubsa_softc *, tcflag_t);
194 static void ubsa_databits(struct ubsa_softc *, tcflag_t);
195 static void ubsa_stopbits(struct ubsa_softc *, tcflag_t);
196 static void ubsa_flow(struct ubsa_softc *, tcflag_t, tcflag_t);
198 struct ucom_callback ubsa_callback = {
209 static const struct ubsa_product {
212 } ubsa_products [] = {
214 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U103 },
216 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U120 },
217 /* GoHubs GO-COM232 */
218 { USB_VENDOR_ETEK, USB_PRODUCT_ETEK_1COM },
219 /* GoHubs GO-COM232 */
220 { USB_VENDOR_GOHUBS, USB_PRODUCT_GOHUBS_GOCOM232 },
222 { USB_VENDOR_PERACOM, USB_PRODUCT_PERACOM_SERIAL1 },
226 static device_probe_t ubsa_match;
227 static device_attach_t ubsa_attach;
228 static device_detach_t ubsa_detach;
230 static device_method_t ubsa_methods[] = {
231 /* Device interface */
232 DEVMETHOD(device_probe, ubsa_match),
233 DEVMETHOD(device_attach, ubsa_attach),
234 DEVMETHOD(device_detach, ubsa_detach),
238 static driver_t ubsa_driver = {
241 sizeof (struct ubsa_softc)
244 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ucom_devclass, usbd_driver_load, 0);
245 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
246 MODULE_DEPEND(ubsa, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
247 MODULE_VERSION(ubsa, UBSA_MODVER);
250 ubsa_match(device_t self)
252 struct usb_attach_arg *uaa = device_get_ivars(self);
255 if (uaa->iface != NULL)
256 return (UMATCH_NONE);
258 for (i = 0; ubsa_products[i].vendor != 0; i++) {
259 if (ubsa_products[i].vendor == uaa->vendor &&
260 ubsa_products[i].product == uaa->product) {
261 return (UMATCH_VENDOR_PRODUCT);
264 return (UMATCH_NONE);
268 ubsa_attach(device_t self)
270 struct ubsa_softc *sc = device_get_softc(self);
271 struct usb_attach_arg *uaa = device_get_ivars(self);
272 usbd_device_handle dev;
273 struct ucom_softc *ucom;
274 usb_config_descriptor_t *cdesc;
275 usb_interface_descriptor_t *id;
276 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 devname = device_get_nameunit(ucom->sc_dev);
303 kprintf("%s: %s\n", devname, devinfo);
305 DPRINTF(("ubsa attach: sc = %p\n", sc));
307 /* initialize endpoints */
308 ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
309 sc->sc_intr_number = -1;
310 sc->sc_intr_pipe = NULL;
312 /* Move the device into the configured state. */
313 err = usbd_set_config_index(dev, UBSA_CONFIG_INDEX, 1);
315 kprintf("%s: failed to set configuration: %s\n",
316 devname, usbd_errstr(err));
321 /* get the config descriptor */
322 cdesc = usbd_get_config_descriptor(ucom->sc_udev);
325 kprintf("%s: failed to get configuration descriptor\n",
326 device_get_nameunit(ucom->sc_dev));
331 /* get the first interface */
332 err = usbd_device2interface_handle(dev, UBSA_IFACE_INDEX,
335 kprintf("%s: failed to get interface: %s\n",
336 devname, usbd_errstr(err));
341 /* Find the endpoints */
343 id = usbd_get_interface_descriptor(ucom->sc_iface);
344 sc->sc_iface_number = id->bInterfaceNumber;
346 for (i = 0; i < id->bNumEndpoints; i++) {
347 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
349 kprintf("%s: no endpoint descriptor for %d\n",
350 device_get_nameunit(ucom->sc_dev), i);
355 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
356 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
357 sc->sc_intr_number = ed->bEndpointAddress;
358 sc->sc_isize = UGETW(ed->wMaxPacketSize);
359 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
360 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
361 ucom->sc_bulkin_no = ed->bEndpointAddress;
362 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
363 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
364 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
365 ucom->sc_bulkout_no = ed->bEndpointAddress;
366 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
370 if (sc->sc_intr_number == -1) {
371 kprintf("%s: Could not find interrupt in\n",
372 device_get_nameunit(ucom->sc_dev));
377 /* keep interface for interrupt */
378 sc->sc_intr_iface = ucom->sc_iface;
380 if (ucom->sc_bulkin_no == -1) {
381 kprintf("%s: Could not find data bulk in\n",
382 device_get_nameunit(ucom->sc_dev));
387 if (ucom->sc_bulkout_no == -1) {
388 kprintf("%s: Could not find data bulk out\n",
389 device_get_nameunit(ucom->sc_dev));
394 ucom->sc_parent = sc;
395 ucom->sc_portno = UCOM_UNK_PORTNO;
396 /* bulkin, bulkout set above */
397 ucom->sc_ibufsizepad = ucom->sc_ibufsize;
398 ucom->sc_opkthdrlen = 0;
399 ucom->sc_callback = &ubsa_callback;
401 DPRINTF(("ubsa: in = 0x%x, out = 0x%x, intr = 0x%x\n",
402 ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
406 kfree(devinfo, M_USBDEV);
410 kfree(devinfo, M_USBDEV);
415 ubsa_detach(device_t self)
417 struct ubsa_softc *sc = device_get_softc(self);
421 DPRINTF(("ubsa_detach: sc = %p\n", sc));
423 if (sc->sc_intr_pipe != NULL) {
424 usbd_abort_pipe(sc->sc_intr_pipe);
425 usbd_close_pipe(sc->sc_intr_pipe);
426 kfree(sc->sc_intr_buf, M_USBDEV);
427 sc->sc_intr_pipe = NULL;
430 sc->sc_ucom.sc_dying = 1;
432 rv = ucom_detach(&sc->sc_ucom);
438 ubsa_request(struct ubsa_softc *sc, u_int8_t request, u_int16_t value)
440 usb_device_request_t req;
443 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
444 req.bRequest = request;
445 USETW(req.wValue, value);
446 USETW(req.wIndex, sc->sc_iface_number);
447 USETW(req.wLength, 0);
449 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
451 kprintf("%s: ubsa_request: %s\n",
452 device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
457 ubsa_dtr(struct ubsa_softc *sc, int onoff)
460 DPRINTF(("ubsa_dtr: onoff = %d\n", onoff));
462 if (sc->sc_dtr == onoff)
466 ubsa_request(sc, UBSA_SET_DTR, onoff ? 1 : 0);
470 ubsa_rts(struct ubsa_softc *sc, int onoff)
473 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
475 if (sc->sc_rts == onoff)
479 ubsa_request(sc, UBSA_SET_RTS, onoff ? 1 : 0);
483 ubsa_break(struct ubsa_softc *sc, int onoff)
486 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
488 ubsa_request(sc, UBSA_SET_BREAK, onoff ? 1 : 0);
492 ubsa_set(void *addr, int portno, int reg, int onoff)
494 struct ubsa_softc *sc;
505 ubsa_break(sc, onoff);
513 ubsa_baudrate(struct ubsa_softc *sc, speed_t speed)
517 DPRINTF(("ubsa_baudrate: speed = %d\n", speed));
533 value = B230400 / speed;
536 kprintf("%s: ubsa_param: unsupported baudrate, "
537 "forcing default of 9600\n",
538 device_get_nameunit(sc->sc_ucom.sc_dev));
539 value = B230400 / B9600;
548 ubsa_request(sc, UBSA_SET_BAUDRATE, value);
552 ubsa_parity(struct ubsa_softc *sc, tcflag_t cflag)
556 DPRINTF(("ubsa_parity: cflag = 0x%x\n", cflag));
559 value = (cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
561 value = UBSA_PARITY_NONE;
563 ubsa_request(sc, UBSA_SET_PARITY, value);
567 ubsa_databits(struct ubsa_softc *sc, tcflag_t cflag)
571 DPRINTF(("ubsa_databits: cflag = 0x%x\n", cflag));
573 switch (cflag & CSIZE) {
574 case CS5: value = 0; break;
575 case CS6: value = 1; break;
576 case CS7: value = 2; break;
577 case CS8: value = 3; break;
579 kprintf("%s: ubsa_param: unsupported databits requested, "
580 "forcing default of 8\n",
581 device_get_nameunit(sc->sc_ucom.sc_dev));
585 ubsa_request(sc, UBSA_SET_DATA_BITS, value);
589 ubsa_stopbits(struct ubsa_softc *sc, tcflag_t cflag)
593 DPRINTF(("ubsa_stopbits: cflag = 0x%x\n", cflag));
595 value = (cflag & CSTOPB) ? 1 : 0;
597 ubsa_request(sc, UBSA_SET_STOP_BITS, value);
601 ubsa_flow(struct ubsa_softc *sc, tcflag_t cflag, tcflag_t iflag)
605 DPRINTF(("ubsa_flow: cflag = 0x%x, iflag = 0x%x\n", cflag, iflag));
609 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
610 if (iflag & (IXON|IXOFF))
611 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
613 ubsa_request(sc, UBSA_SET_FLOW_CTRL, value);
617 ubsa_param(void *addr, int portno, struct termios *ti)
619 struct ubsa_softc *sc;
623 DPRINTF(("ubsa_param: sc = %p\n", sc));
625 ubsa_baudrate(sc, ti->c_ospeed);
626 ubsa_parity(sc, ti->c_cflag);
627 ubsa_databits(sc, ti->c_cflag);
628 ubsa_stopbits(sc, ti->c_cflag);
629 ubsa_flow(sc, ti->c_cflag, ti->c_iflag);
635 ubsa_open(void *addr, int portno)
637 struct ubsa_softc *sc;
641 if (sc->sc_ucom.sc_dying)
644 DPRINTF(("ubsa_open: sc = %p\n", sc));
646 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
647 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
648 err = usbd_open_pipe_intr(sc->sc_intr_iface,
658 kprintf("%s: cannot open interrupt pipe (addr %d)\n",
659 device_get_nameunit(sc->sc_ucom.sc_dev),
669 ubsa_close(void *addr, int portno)
671 struct ubsa_softc *sc;
675 if (sc->sc_ucom.sc_dying)
678 DPRINTF(("ubsa_close: close\n"));
680 if (sc->sc_intr_pipe != NULL) {
681 err = usbd_abort_pipe(sc->sc_intr_pipe);
683 kprintf("%s: abort interrupt pipe failed: %s\n",
684 device_get_nameunit(sc->sc_ucom.sc_dev),
686 err = usbd_close_pipe(sc->sc_intr_pipe);
688 kprintf("%s: close interrupt pipe failed: %s\n",
689 device_get_nameunit(sc->sc_ucom.sc_dev),
691 kfree(sc->sc_intr_buf, M_USBDEV);
692 sc->sc_intr_pipe = NULL;
697 ubsa_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
699 struct ubsa_softc *sc;
703 buf = sc->sc_intr_buf;
704 if (sc->sc_ucom.sc_dying)
707 if (status != USBD_NORMAL_COMPLETION) {
708 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
711 DPRINTF(("%s: ubsa_intr: abnormal status: %s\n",
712 device_get_nameunit(sc->sc_ucom.sc_dev),
713 usbd_errstr(status)));
714 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
718 /* incidentally, Belkin adapter status bits match UART 16550 bits */
722 DPRINTF(("%s: ubsa lsr = 0x%02x, msr = 0x%02x\n",
723 device_get_nameunit(sc->sc_ucom.sc_dev), sc->sc_lsr, sc->sc_msr));
728 /* Handle delayed events. */
730 ubsa_notify(void *arg)
732 struct ubsa_softc *sc;
735 ucom_status_change(&sc->sc_ucom);
739 ubsa_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
741 struct ubsa_softc *sc;
743 DPRINTF(("ubsa_get_status\n"));