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 $
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/malloc.h>
70 #include <sys/fcntl.h>
71 #include <sys/interrupt.h>
75 #include <sys/select.h>
78 #include <sys/sysctl.h>
80 #include <bus/usb/usb.h>
81 #include <bus/usb/usbcdc.h>
83 #include <bus/usb/usbdi.h>
84 #include <bus/usb/usbdi_util.h>
85 #include <bus/usb/usb_quirks.h>
87 #include "../ucom/ucomvar.h"
90 static int ubsadebug = 0;
91 SYSCTL_NODE(_hw_usb, OID_AUTO, ubsa, CTLFLAG_RW, 0, "USB ubsa");
92 SYSCTL_INT(_hw_usb_ubsa, OID_AUTO, debug, CTLFLAG_RW,
93 &ubsadebug, 0, "ubsa debug level");
95 #define DPRINTFN(n, x) do { \
96 if (ubsadebug > (n)) \
100 #define DPRINTFN(n, x)
102 #define DPRINTF(x) DPRINTFN(0, x)
104 #define UBSA_MODVER 1 /* module version */
106 #define UBSA_CONFIG_INDEX 1
107 #define UBSA_IFACE_INDEX 0
109 #define UBSA_INTR_INTERVAL 100 /* ms */
111 #define UBSA_SET_BAUDRATE 0x00
112 #define UBSA_SET_STOP_BITS 0x01
113 #define UBSA_SET_DATA_BITS 0x02
114 #define UBSA_SET_PARITY 0x03
115 #define UBSA_SET_DTR 0x0A
116 #define UBSA_SET_RTS 0x0B
117 #define UBSA_SET_BREAK 0x0C
118 #define UBSA_SET_FLOW_CTRL 0x10
120 #define UBSA_PARITY_NONE 0x00
121 #define UBSA_PARITY_EVEN 0x01
122 #define UBSA_PARITY_ODD 0x02
123 #define UBSA_PARITY_MARK 0x03
124 #define UBSA_PARITY_SPACE 0x04
126 #define UBSA_FLOW_NONE 0x0000
127 #define UBSA_FLOW_OCTS 0x0001
128 #define UBSA_FLOW_ODSR 0x0002
129 #define UBSA_FLOW_IDSR 0x0004
130 #define UBSA_FLOW_IDTR 0x0008
131 #define UBSA_FLOW_IRTS 0x0010
132 #define UBSA_FLOW_ORTS 0x0020
133 #define UBSA_FLOW_UNKNOWN 0x0040
134 #define UBSA_FLOW_OXON 0x0080
135 #define UBSA_FLOW_IXON 0x0100
137 /* line status register */
138 #define UBSA_LSR_TSRE 0x40 /* Transmitter empty: byte sent */
139 #define UBSA_LSR_TXRDY 0x20 /* Transmitter buffer empty */
140 #define UBSA_LSR_BI 0x10 /* Break detected */
141 #define UBSA_LSR_FE 0x08 /* Framing error: bad stop bit */
142 #define UBSA_LSR_PE 0x04 /* Parity error */
143 #define UBSA_LSR_OE 0x02 /* Overrun, lost incoming byte */
144 #define UBSA_LSR_RXRDY 0x01 /* Byte ready in Receive Buffer */
145 #define UBSA_LSR_RCV_MASK 0x1f /* Mask for incoming data or error */
147 /* modem status register */
148 /* All deltas are from the last read of the MSR. */
149 #define UBSA_MSR_DCD 0x80 /* Current Data Carrier Detect */
150 #define UBSA_MSR_RI 0x40 /* Current Ring Indicator */
151 #define UBSA_MSR_DSR 0x20 /* Current Data Set Ready */
152 #define UBSA_MSR_CTS 0x10 /* Current Clear to Send */
153 #define UBSA_MSR_DDCD 0x08 /* DCD has changed state */
154 #define UBSA_MSR_TERI 0x04 /* RI has toggled low to high */
155 #define UBSA_MSR_DDSR 0x02 /* DSR has changed state */
156 #define UBSA_MSR_DCTS 0x01 /* CTS has changed state */
159 struct ucom_softc sc_ucom;
161 int sc_iface_number; /* interface number */
163 usbd_interface_handle sc_intr_iface; /* interrupt interface */
164 int sc_intr_number; /* interrupt number */
165 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */
166 u_char *sc_intr_buf; /* interrupt buffer */
169 u_char sc_dtr; /* current DTR state */
170 u_char sc_rts; /* current RTS state */
172 u_char sc_lsr; /* Local status register */
173 u_char sc_msr; /* ubsa status register */
176 static void ubsa_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
177 static void ubsa_notify(void *);
179 static void ubsa_get_status(void *, int, u_char *, u_char *);
180 static void ubsa_set(void *, int, int, int);
181 static int ubsa_param(void *, int, struct termios *);
182 static int ubsa_open(void *, int);
183 static void ubsa_close(void *, int);
185 static int ubsa_request(struct ubsa_softc *, u_int8_t, u_int16_t);
186 static void ubsa_dtr(struct ubsa_softc *, int);
187 static void ubsa_rts(struct ubsa_softc *, int);
188 static void ubsa_baudrate(struct ubsa_softc *, speed_t);
189 static void ubsa_parity(struct ubsa_softc *, tcflag_t);
190 static void ubsa_databits(struct ubsa_softc *, tcflag_t);
191 static void ubsa_stopbits(struct ubsa_softc *, tcflag_t);
192 static void ubsa_flow(struct ubsa_softc *, tcflag_t, tcflag_t);
194 struct ucom_callback ubsa_callback = {
205 static const struct usb_devno ubsa_devs [] = {
206 { USB_DEVICE(0x050d, 0x0103) }, /* Belkin F5U103 serial adapter */
207 { USB_DEVICE(0x050d, 0x1203) }, /* Belkin F5U120-PC hub */
208 { USB_DEVICE(0x0565, 0x0001) }, /* Peracom serial converter */
209 { USB_DEVICE(0x056c, 0x8007) }, /* e-TEK Labs serial port */
210 { USB_DEVICE(0x0921, 0x1001) }, /* GoHubs GoCOM232 serial converter */
211 { USB_DEVICE(0x0921, 0x1200) }, /* HandyTech's Braille displays */
214 static device_probe_t ubsa_match;
215 static device_attach_t ubsa_attach;
216 static device_detach_t ubsa_detach;
218 static device_method_t ubsa_methods[] = {
219 /* Device interface */
220 DEVMETHOD(device_probe, ubsa_match),
221 DEVMETHOD(device_attach, ubsa_attach),
222 DEVMETHOD(device_detach, ubsa_detach),
226 static driver_t ubsa_driver = {
229 sizeof (struct ubsa_softc)
232 DRIVER_MODULE(ubsa, uhub, ubsa_driver, ucom_devclass, usbd_driver_load, NULL);
233 MODULE_DEPEND(ubsa, usb, 1, 1, 1);
234 MODULE_DEPEND(ubsa, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
235 MODULE_VERSION(ubsa, UBSA_MODVER);
238 ubsa_match(device_t self)
240 struct usb_attach_arg *uaa = device_get_ivars(self);
242 if (uaa->iface != NULL)
243 return (UMATCH_NONE);
245 return (usb_lookup(ubsa_devs, uaa->vendor, uaa->product) != NULL ?
246 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
250 ubsa_attach(device_t self)
252 struct ubsa_softc *sc = device_get_softc(self);
253 struct usb_attach_arg *uaa = device_get_ivars(self);
254 usbd_device_handle dev;
255 struct ucom_softc *ucom;
256 usb_config_descriptor_t *cdesc;
257 usb_interface_descriptor_t *id;
258 usb_endpoint_descriptor_t *ed;
264 bzero(sc, sizeof (struct ubsa_softc));
267 * initialize rts, dtr variables to something
268 * different from boolean 0, 1
275 ucom->sc_iface = uaa->iface;
277 DPRINTF(("ubsa attach: sc = %p\n", sc));
279 /* initialize endpoints */
280 ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
281 sc->sc_intr_number = -1;
282 sc->sc_intr_pipe = NULL;
284 /* Move the device into the configured state. */
285 err = usbd_set_config_index(dev, UBSA_CONFIG_INDEX, 1);
287 device_printf(ucom->sc_dev, "failed to set configuration: %s\n",
293 /* get the config descriptor */
294 cdesc = usbd_get_config_descriptor(ucom->sc_udev);
297 device_printf(ucom->sc_dev, "failed to get configuration "
303 /* get the first interface */
304 err = usbd_device2interface_handle(dev, UBSA_IFACE_INDEX,
307 device_printf(ucom->sc_dev, "failed to get interface: %s\n",
313 /* Find the endpoints */
315 id = usbd_get_interface_descriptor(ucom->sc_iface);
316 sc->sc_iface_number = id->bInterfaceNumber;
318 for (i = 0; i < id->bNumEndpoints; i++) {
319 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
321 device_printf(ucom->sc_dev, "no endpoint descriptor "
327 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
328 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
329 sc->sc_intr_number = ed->bEndpointAddress;
330 sc->sc_isize = UGETW(ed->wMaxPacketSize);
331 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
332 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
333 ucom->sc_bulkin_no = ed->bEndpointAddress;
334 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
335 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
336 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
337 ucom->sc_bulkout_no = ed->bEndpointAddress;
338 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
342 if (sc->sc_intr_number == -1) {
343 device_printf(ucom->sc_dev, "could not find interrupt in\n");
348 /* keep interface for interrupt */
349 sc->sc_intr_iface = ucom->sc_iface;
351 if (ucom->sc_bulkin_no == -1) {
352 device_printf(ucom->sc_dev, "could not find data bulk in\n");
357 if (ucom->sc_bulkout_no == -1) {
358 device_printf(ucom->sc_dev, "could not find data bulk out\n");
363 ucom->sc_parent = sc;
364 ucom->sc_portno = UCOM_UNK_PORTNO;
365 /* bulkin, bulkout set above */
366 ucom->sc_ibufsizepad = ucom->sc_ibufsize;
367 ucom->sc_opkthdrlen = 0;
368 ucom->sc_callback = &ubsa_callback;
370 DPRINTF(("ubsa: in = 0x%x, out = 0x%x, intr = 0x%x\n",
371 ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
382 ubsa_detach(device_t self)
384 struct ubsa_softc *sc = device_get_softc(self);
388 DPRINTF(("ubsa_detach: sc = %p\n", sc));
390 if (sc->sc_intr_pipe != NULL) {
391 usbd_abort_pipe(sc->sc_intr_pipe);
392 usbd_close_pipe(sc->sc_intr_pipe);
393 kfree(sc->sc_intr_buf, M_USBDEV);
394 sc->sc_intr_pipe = NULL;
397 sc->sc_ucom.sc_dying = 1;
399 rv = ucom_detach(&sc->sc_ucom);
405 ubsa_request(struct ubsa_softc *sc, u_int8_t request, u_int16_t value)
407 usb_device_request_t req;
410 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
411 req.bRequest = request;
412 USETW(req.wValue, value);
413 USETW(req.wIndex, sc->sc_iface_number);
414 USETW(req.wLength, 0);
416 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
418 device_printf(sc->sc_ucom.sc_dev, "ubsa_request: %s\n",
424 ubsa_dtr(struct ubsa_softc *sc, int onoff)
427 DPRINTF(("ubsa_dtr: onoff = %d\n", onoff));
429 if (sc->sc_dtr == onoff)
433 ubsa_request(sc, UBSA_SET_DTR, onoff ? 1 : 0);
437 ubsa_rts(struct ubsa_softc *sc, int onoff)
440 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
442 if (sc->sc_rts == onoff)
446 ubsa_request(sc, UBSA_SET_RTS, onoff ? 1 : 0);
450 ubsa_break(struct ubsa_softc *sc, int onoff)
453 DPRINTF(("ubsa_rts: onoff = %d\n", onoff));
455 ubsa_request(sc, UBSA_SET_BREAK, onoff ? 1 : 0);
459 ubsa_set(void *addr, int portno, int reg, int onoff)
461 struct ubsa_softc *sc;
472 ubsa_break(sc, onoff);
480 ubsa_baudrate(struct ubsa_softc *sc, speed_t speed)
484 DPRINTF(("ubsa_baudrate: speed = %d\n", speed));
500 value = B230400 / speed;
503 device_printf(sc->sc_ucom.sc_dev, "ubsa_param: unsupported "
504 "baudrate, forcing default of 9600\n");
505 value = B230400 / B9600;
514 ubsa_request(sc, UBSA_SET_BAUDRATE, value);
518 ubsa_parity(struct ubsa_softc *sc, tcflag_t cflag)
522 DPRINTF(("ubsa_parity: cflag = 0x%x\n", cflag));
525 value = (cflag & PARODD) ? UBSA_PARITY_ODD : UBSA_PARITY_EVEN;
527 value = UBSA_PARITY_NONE;
529 ubsa_request(sc, UBSA_SET_PARITY, value);
533 ubsa_databits(struct ubsa_softc *sc, tcflag_t cflag)
537 DPRINTF(("ubsa_databits: cflag = 0x%x\n", cflag));
539 switch (cflag & CSIZE) {
540 case CS5: value = 0; break;
541 case CS6: value = 1; break;
542 case CS7: value = 2; break;
543 case CS8: value = 3; break;
545 device_printf(sc->sc_ucom.sc_dev, "ubsa_param: unsupported "
546 "databits requested, forcing default of 8\n");
550 ubsa_request(sc, UBSA_SET_DATA_BITS, value);
554 ubsa_stopbits(struct ubsa_softc *sc, tcflag_t cflag)
558 DPRINTF(("ubsa_stopbits: cflag = 0x%x\n", cflag));
560 value = (cflag & CSTOPB) ? 1 : 0;
562 ubsa_request(sc, UBSA_SET_STOP_BITS, value);
566 ubsa_flow(struct ubsa_softc *sc, tcflag_t cflag, tcflag_t iflag)
570 DPRINTF(("ubsa_flow: cflag = 0x%x, iflag = 0x%x\n", cflag, iflag));
574 value |= UBSA_FLOW_OCTS | UBSA_FLOW_IRTS;
575 if (iflag & (IXON|IXOFF))
576 value |= UBSA_FLOW_OXON | UBSA_FLOW_IXON;
578 ubsa_request(sc, UBSA_SET_FLOW_CTRL, value);
582 ubsa_param(void *addr, int portno, struct termios *ti)
584 struct ubsa_softc *sc;
588 DPRINTF(("ubsa_param: sc = %p\n", sc));
590 ubsa_baudrate(sc, ti->c_ospeed);
591 ubsa_parity(sc, ti->c_cflag);
592 ubsa_databits(sc, ti->c_cflag);
593 ubsa_stopbits(sc, ti->c_cflag);
594 ubsa_flow(sc, ti->c_cflag, ti->c_iflag);
600 ubsa_open(void *addr, int portno)
602 struct ubsa_softc *sc;
606 if (sc->sc_ucom.sc_dying)
609 DPRINTF(("ubsa_open: sc = %p\n", sc));
611 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
612 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
613 err = usbd_open_pipe_intr(sc->sc_intr_iface,
623 device_printf(sc->sc_ucom.sc_dev, "cannot open "
624 "interrupt pipe (addr %d)\n",
634 ubsa_close(void *addr, int portno)
636 struct ubsa_softc *sc;
640 if (sc->sc_ucom.sc_dying)
643 DPRINTF(("ubsa_close: close\n"));
645 if (sc->sc_intr_pipe != NULL) {
646 err = usbd_abort_pipe(sc->sc_intr_pipe);
648 device_printf(sc->sc_ucom.sc_dev, "abort interrupt "
649 "pipe failed: %s\n", usbd_errstr(err));
650 err = usbd_close_pipe(sc->sc_intr_pipe);
652 device_printf(sc->sc_ucom.sc_dev, "close interrupt "
653 "pipe failed: %s\n", usbd_errstr(err));
654 kfree(sc->sc_intr_buf, M_USBDEV);
655 sc->sc_intr_pipe = NULL;
660 ubsa_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
662 struct ubsa_softc *sc;
666 buf = sc->sc_intr_buf;
667 if (sc->sc_ucom.sc_dying)
670 if (status != USBD_NORMAL_COMPLETION) {
671 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
674 DPRINTF(("%s: ubsa_intr: abnormal status: %s\n",
675 device_get_nameunit(sc->sc_ucom.sc_dev),
676 usbd_errstr(status)));
677 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
681 /* incidentally, Belkin adapter status bits match UART 16550 bits */
685 DPRINTF(("%s: ubsa lsr = 0x%02x, msr = 0x%02x\n",
686 device_get_nameunit(sc->sc_ucom.sc_dev), sc->sc_lsr, sc->sc_msr));
691 /* Handle delayed events. */
693 ubsa_notify(void *arg)
695 struct ubsa_softc *sc;
698 ucom_status_change(&sc->sc_ucom);
702 ubsa_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
704 struct ubsa_softc *sc;
706 DPRINTF(("ubsa_get_status\n"));