2 * Copyright (c) 2004 Bernd Walter <ticso@FreeBSD.org>
4 * $URL: https://devel.bwct.de/svn/projects/ubser/ubser.c $
5 * $Date: 2004-02-29 01:53:10 +0100 (Sun, 29 Feb 2004) $
11 * Copyright (c) 2001-2002, Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Copyright (c) 2000 The NetBSD Foundation, Inc.
38 * All rights reserved.
40 * This code is derived from software contributed to The NetBSD Foundation
41 * by Lennart Augustsson (lennart@augustsson.net).
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the NetBSD
54 * Foundation, Inc. and its contributors.
55 * 4. Neither the name of The NetBSD Foundation nor the names of its
56 * contributors may be used to endorse or promote products derived
57 * from this software without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
60 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
61 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
62 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
63 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
64 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
65 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
66 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
67 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
68 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
69 * POSSIBILITY OF SUCH DAMAGE.
72 #include <sys/cdefs.h>
73 __FBSDID("$FreeBSD$");
76 * BWCT serial adapter driver
79 #include <sys/stdint.h>
80 #include <sys/stddef.h>
81 #include <sys/param.h>
82 #include <sys/queue.h>
83 #include <sys/types.h>
84 #include <sys/systm.h>
85 #include <sys/kernel.h>
87 #include <sys/linker_set.h>
88 #include <sys/module.h>
90 #include <sys/mutex.h>
91 #include <sys/condvar.h>
92 #include <sys/sysctl.h>
94 #include <sys/unistd.h>
95 #include <sys/callout.h>
96 #include <sys/malloc.h>
99 #include <dev/usb/usb.h>
100 #include <dev/usb/usbdi.h>
101 #include <dev/usb/usbdi_util.h>
104 #define USB_DEBUG_VAR ubser_debug
105 #include <dev/usb/usb_debug.h>
106 #include <dev/usb/usb_process.h>
108 #include <dev/usb/serial/usb_serial.h>
110 #define UBSER_UNIT_MAX 32
112 /* Vendor Interface Requests */
113 #define VENDOR_GET_NUMSER 0x01
114 #define VENDOR_SET_BREAK 0x02
115 #define VENDOR_CLEAR_BREAK 0x03
118 static int ubser_debug = 0;
120 SYSCTL_NODE(_hw_usb, OID_AUTO, ubser, CTLFLAG_RW, 0, "USB ubser");
121 SYSCTL_INT(_hw_usb_ubser, OID_AUTO, debug, CTLFLAG_RW,
122 &ubser_debug, 0, "ubser debug level");
132 struct ucom_super_softc sc_super_ucom;
133 struct ucom_softc sc_ucom[UBSER_UNIT_MAX];
135 struct usb_xfer *sc_xfer[UBSER_N_TRANSFER];
136 struct usb_device *sc_udev;
143 uint8_t sc_iface_index;
144 uint8_t sc_curr_tx_unit;
150 static device_probe_t ubser_probe;
151 static device_attach_t ubser_attach;
152 static device_detach_t ubser_detach;
154 static usb_callback_t ubser_write_callback;
155 static usb_callback_t ubser_read_callback;
157 static int ubser_pre_param(struct ucom_softc *, struct termios *);
158 static void ubser_cfg_set_break(struct ucom_softc *, uint8_t);
159 static void ubser_cfg_get_status(struct ucom_softc *, uint8_t *,
161 static void ubser_start_read(struct ucom_softc *);
162 static void ubser_stop_read(struct ucom_softc *);
163 static void ubser_start_write(struct ucom_softc *);
164 static void ubser_stop_write(struct ucom_softc *);
165 static void ubser_poll(struct ucom_softc *ucom);
167 static const struct usb_config ubser_config[UBSER_N_TRANSFER] = {
169 [UBSER_BULK_DT_WR] = {
171 .endpoint = UE_ADDR_ANY,
172 .direction = UE_DIR_OUT,
173 .bufsize = 0, /* use wMaxPacketSize */
174 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
175 .callback = &ubser_write_callback,
178 [UBSER_BULK_DT_RD] = {
180 .endpoint = UE_ADDR_ANY,
181 .direction = UE_DIR_IN,
182 .bufsize = 0, /* use wMaxPacketSize */
183 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
184 .callback = &ubser_read_callback,
188 static const struct ucom_callback ubser_callback = {
189 .ucom_cfg_set_break = &ubser_cfg_set_break,
190 .ucom_cfg_get_status = &ubser_cfg_get_status,
191 .ucom_pre_param = &ubser_pre_param,
192 .ucom_start_read = &ubser_start_read,
193 .ucom_stop_read = &ubser_stop_read,
194 .ucom_start_write = &ubser_start_write,
195 .ucom_stop_write = &ubser_stop_write,
196 .ucom_poll = &ubser_poll,
199 static device_method_t ubser_methods[] = {
200 DEVMETHOD(device_probe, ubser_probe),
201 DEVMETHOD(device_attach, ubser_attach),
202 DEVMETHOD(device_detach, ubser_detach),
206 static devclass_t ubser_devclass;
208 static driver_t ubser_driver = {
210 .methods = ubser_methods,
211 .size = sizeof(struct ubser_softc),
214 DRIVER_MODULE(ubser, uhub, ubser_driver, ubser_devclass, NULL, 0);
215 MODULE_DEPEND(ubser, ucom, 1, 1, 1);
216 MODULE_DEPEND(ubser, usb, 1, 1, 1);
217 MODULE_VERSION(ubser, 1);
220 ubser_probe(device_t dev)
222 struct usb_attach_arg *uaa = device_get_ivars(dev);
224 if (uaa->usb_mode != USB_MODE_HOST) {
227 /* check if this is a BWCT vendor specific ubser interface */
228 if ((strcmp(usb_get_manufacturer(uaa->device), "BWCT") == 0) &&
229 (uaa->info.bInterfaceClass == 0xff) &&
230 (uaa->info.bInterfaceSubClass == 0x00))
237 ubser_attach(device_t dev)
239 struct usb_attach_arg *uaa = device_get_ivars(dev);
240 struct ubser_softc *sc = device_get_softc(dev);
241 struct usb_device_request req;
245 device_set_usb_desc(dev);
246 mtx_init(&sc->sc_mtx, "ubser", NULL, MTX_DEF);
248 snprintf(sc->sc_name, sizeof(sc->sc_name), "%s",
249 device_get_nameunit(dev));
251 sc->sc_iface_no = uaa->info.bIfaceNum;
252 sc->sc_iface_index = uaa->info.bIfaceIndex;
253 sc->sc_udev = uaa->device;
255 /* get number of serials */
256 req.bmRequestType = UT_READ_VENDOR_INTERFACE;
257 req.bRequest = VENDOR_GET_NUMSER;
258 USETW(req.wValue, 0);
259 req.wIndex[0] = sc->sc_iface_no;
261 USETW(req.wLength, 1);
262 error = usbd_do_request_flags(uaa->device, NULL,
263 &req, &sc->sc_numser,
264 0, NULL, USB_DEFAULT_TIMEOUT);
266 if (error || (sc->sc_numser == 0)) {
267 device_printf(dev, "failed to get number "
268 "of serial ports: %s\n",
272 if (sc->sc_numser > UBSER_UNIT_MAX)
273 sc->sc_numser = UBSER_UNIT_MAX;
275 device_printf(dev, "found %i serials\n", sc->sc_numser);
277 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
278 sc->sc_xfer, ubser_config, UBSER_N_TRANSFER, sc, &sc->sc_mtx);
282 sc->sc_tx_size = usbd_xfer_max_len(sc->sc_xfer[UBSER_BULK_DT_WR]);
284 if (sc->sc_tx_size == 0) {
285 DPRINTFN(0, "invalid tx_size\n");
288 /* initialize port numbers */
290 for (n = 0; n < sc->sc_numser; n++) {
291 sc->sc_ucom[n].sc_portno = n;
294 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
295 sc->sc_numser, sc, &ubser_callback, &sc->sc_mtx);
300 mtx_lock(&sc->sc_mtx);
301 usbd_xfer_set_stall(sc->sc_xfer[UBSER_BULK_DT_WR]);
302 usbd_xfer_set_stall(sc->sc_xfer[UBSER_BULK_DT_RD]);
303 usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_RD]);
304 mtx_unlock(&sc->sc_mtx);
306 return (0); /* success */
310 return (ENXIO); /* failure */
314 ubser_detach(device_t dev)
316 struct ubser_softc *sc = device_get_softc(dev);
320 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_numser);
321 usbd_transfer_unsetup(sc->sc_xfer, UBSER_N_TRANSFER);
322 mtx_destroy(&sc->sc_mtx);
328 ubser_pre_param(struct ucom_softc *ucom, struct termios *t)
333 * The firmware on our devices can only do 8n1@9600bps
335 * We refuse to accept other configurations.
339 switch (t->c_ospeed) {
346 /* 2 stop bits not possible */
347 if (t->c_cflag & CSTOPB)
350 /* XXX parity handling not possible with current firmware */
351 if (t->c_cflag & PARENB)
354 /* we can only do 8 data bits */
355 switch (t->c_cflag & CSIZE) {
362 /* we can't do any kind of hardware handshaking */
364 (CRTS_IFLOW | CDTR_IFLOW | CDSR_OFLOW | CCAR_OFLOW)) != 0)
368 * XXX xon/xoff not supported by the firmware!
369 * This is handled within FreeBSD only and may overflow buffers
370 * because of delayed reaction due to device buffering.
377 ubser_inc_tx_unit(struct ubser_softc *sc)
379 sc->sc_curr_tx_unit++;
380 if (sc->sc_curr_tx_unit >= sc->sc_numser) {
381 sc->sc_curr_tx_unit = 0;
386 ubser_write_callback(struct usb_xfer *xfer, usb_error_t error)
388 struct ubser_softc *sc = usbd_xfer_softc(xfer);
389 struct usb_page_cache *pc;
391 uint8_t first_unit = sc->sc_curr_tx_unit;
394 switch (USB_GET_STATE(xfer)) {
396 case USB_ST_TRANSFERRED:
398 pc = usbd_xfer_get_frame(xfer, 0);
400 if (ucom_get_data(sc->sc_ucom + sc->sc_curr_tx_unit,
401 pc, 1, sc->sc_tx_size - 1,
404 buf[0] = sc->sc_curr_tx_unit;
406 usbd_copy_in(pc, 0, buf, 1);
408 usbd_xfer_set_frame_len(xfer, 0, actlen + 1);
409 usbd_transfer_submit(xfer);
411 ubser_inc_tx_unit(sc); /* round robin */
415 ubser_inc_tx_unit(sc);
417 } while (sc->sc_curr_tx_unit != first_unit);
422 if (error != USB_ERR_CANCELLED) {
423 /* try to clear stall first */
424 usbd_xfer_set_stall(xfer);
433 ubser_read_callback(struct usb_xfer *xfer, usb_error_t error)
435 struct ubser_softc *sc = usbd_xfer_softc(xfer);
436 struct usb_page_cache *pc;
440 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
442 switch (USB_GET_STATE(xfer)) {
443 case USB_ST_TRANSFERRED:
445 DPRINTF("invalid actlen=0!\n");
448 pc = usbd_xfer_get_frame(xfer, 0);
449 usbd_copy_out(pc, 0, buf, 1);
451 if (buf[0] >= sc->sc_numser) {
452 DPRINTF("invalid serial number!\n");
455 ucom_put_data(sc->sc_ucom + buf[0], pc, 1, actlen - 1);
459 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
460 usbd_transfer_submit(xfer);
464 if (error != USB_ERR_CANCELLED) {
465 /* try to clear stall first */
466 usbd_xfer_set_stall(xfer);
475 ubser_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
477 struct ubser_softc *sc = ucom->sc_parent;
478 uint8_t x = ucom->sc_portno;
479 struct usb_device_request req;
484 req.bmRequestType = UT_READ_VENDOR_INTERFACE;
485 req.bRequest = VENDOR_SET_BREAK;
488 req.wIndex[0] = sc->sc_iface_no;
490 USETW(req.wLength, 0);
492 err = ucom_cfg_do_request(sc->sc_udev, ucom,
493 &req, NULL, 0, 1000);
495 DPRINTFN(0, "send break failed, error=%s\n",
502 ubser_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
504 /* fake status bits */
510 ubser_start_read(struct ucom_softc *ucom)
512 struct ubser_softc *sc = ucom->sc_parent;
514 usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_RD]);
518 ubser_stop_read(struct ucom_softc *ucom)
520 struct ubser_softc *sc = ucom->sc_parent;
522 usbd_transfer_stop(sc->sc_xfer[UBSER_BULK_DT_RD]);
526 ubser_start_write(struct ucom_softc *ucom)
528 struct ubser_softc *sc = ucom->sc_parent;
530 usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_WR]);
534 ubser_stop_write(struct ucom_softc *ucom)
536 struct ubser_softc *sc = ucom->sc_parent;
538 usbd_transfer_stop(sc->sc_xfer[UBSER_BULK_DT_WR]);
542 ubser_poll(struct ucom_softc *ucom)
544 struct ubser_softc *sc = ucom->sc_parent;
545 usbd_transfer_poll(sc->sc_xfer, UBSER_N_TRANSFER);