5 * Copyright (c) 2003 Scott Long
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * Driver for the MCT (Magic Control Technology) USB-RS232 Converter.
33 * Based on the superb documentation from the linux mct_u232 driver by
34 * Wolfgang Grandeggar <wolfgang@cec.ch>.
35 * This device smells a lot like the Belkin F5U103, except that it has
36 * suffered some mild brain-damage. This driver is based off of the ubsa.c
37 * driver from Alexander Kabaev <kan@FreeBSD.org>. Merging the two together
38 * might be useful, though the subtle differences might lead to lots of
43 * NOTE: all function names beginning like "umct_cfg_" can only
44 * be called from within the config thread function !
47 #include <sys/stdint.h>
48 #include <sys/stddef.h>
49 #include <sys/param.h>
50 #include <sys/queue.h>
51 #include <sys/types.h>
52 #include <sys/systm.h>
53 #include <sys/kernel.h>
55 #include <sys/module.h>
57 #include <sys/mutex.h>
58 #include <sys/condvar.h>
59 #include <sys/sysctl.h>
61 #include <sys/unistd.h>
62 #include <sys/callout.h>
63 #include <sys/malloc.h>
66 #include <dev/usb/usb.h>
67 #include <dev/usb/usbdi.h>
68 #include <dev/usb/usbdi_util.h>
71 #define USB_DEBUG_VAR usb_debug
72 #include <dev/usb/usb_debug.h>
73 #include <dev/usb/usb_process.h>
75 #include <dev/usb/serial/usb_serial.h>
77 /* The UMCT advertises the standard 8250 UART registers */
78 #define UMCT_GET_MSR 2 /* Get Modem Status Register */
79 #define UMCT_GET_MSR_SIZE 1
80 #define UMCT_GET_LCR 6 /* Get Line Control Register */
81 #define UMCT_GET_LCR_SIZE 1
82 #define UMCT_SET_BAUD 5 /* Set the Baud Rate Divisor */
83 #define UMCT_SET_BAUD_SIZE 4
84 #define UMCT_SET_LCR 7 /* Set Line Control Register */
85 #define UMCT_SET_LCR_SIZE 1
86 #define UMCT_SET_MCR 10 /* Set Modem Control Register */
87 #define UMCT_SET_MCR_SIZE 1
89 #define UMCT_INTR_INTERVAL 100
90 #define UMCT_IFACE_INDEX 0
91 #define UMCT_CONFIG_INDEX 0
101 struct ucom_super_softc sc_super_ucom;
102 struct ucom_softc sc_ucom;
104 struct usb_device *sc_udev;
105 struct usb_xfer *sc_xfer[UMCT_N_TRANSFER];
110 uint16_t sc_obufsize;
122 static device_probe_t umct_probe;
123 static device_attach_t umct_attach;
124 static device_detach_t umct_detach;
125 static void umct_free_softc(struct umct_softc *);
127 static usb_callback_t umct_intr_callback;
128 static usb_callback_t umct_intr_callback_sub;
129 static usb_callback_t umct_read_callback;
130 static usb_callback_t umct_read_callback_sub;
131 static usb_callback_t umct_write_callback;
133 static void umct_cfg_do_request(struct umct_softc *sc, uint8_t request,
134 uint16_t len, uint32_t value);
135 static void umct_free(struct ucom_softc *);
136 static void umct_cfg_get_status(struct ucom_softc *, uint8_t *,
138 static void umct_cfg_set_break(struct ucom_softc *, uint8_t);
139 static void umct_cfg_set_dtr(struct ucom_softc *, uint8_t);
140 static void umct_cfg_set_rts(struct ucom_softc *, uint8_t);
141 static uint8_t umct_calc_baud(uint32_t);
142 static int umct_pre_param(struct ucom_softc *, struct termios *);
143 static void umct_cfg_param(struct ucom_softc *, struct termios *);
144 static void umct_start_read(struct ucom_softc *);
145 static void umct_stop_read(struct ucom_softc *);
146 static void umct_start_write(struct ucom_softc *);
147 static void umct_stop_write(struct ucom_softc *);
148 static void umct_poll(struct ucom_softc *ucom);
150 static const struct usb_config umct_config[UMCT_N_TRANSFER] = {
152 [UMCT_BULK_DT_WR] = {
154 .endpoint = UE_ADDR_ANY,
155 .direction = UE_DIR_OUT,
156 .bufsize = 0, /* use wMaxPacketSize */
157 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
158 .callback = &umct_write_callback,
161 [UMCT_BULK_DT_RD] = {
162 .type = UE_INTERRUPT,
163 .endpoint = UE_ADDR_ANY,
164 .direction = UE_DIR_IN,
165 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
166 .bufsize = 0, /* use wMaxPacketSize */
167 .callback = &umct_read_callback,
168 .ep_index = 0, /* first interrupt endpoint */
171 [UMCT_INTR_DT_RD] = {
172 .type = UE_INTERRUPT,
173 .endpoint = UE_ADDR_ANY,
174 .direction = UE_DIR_IN,
175 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
176 .bufsize = 0, /* use wMaxPacketSize */
177 .callback = &umct_intr_callback,
178 .ep_index = 1, /* second interrupt endpoint */
182 static const struct ucom_callback umct_callback = {
183 .ucom_cfg_get_status = &umct_cfg_get_status,
184 .ucom_cfg_set_dtr = &umct_cfg_set_dtr,
185 .ucom_cfg_set_rts = &umct_cfg_set_rts,
186 .ucom_cfg_set_break = &umct_cfg_set_break,
187 .ucom_cfg_param = &umct_cfg_param,
188 .ucom_pre_param = &umct_pre_param,
189 .ucom_start_read = &umct_start_read,
190 .ucom_stop_read = &umct_stop_read,
191 .ucom_start_write = &umct_start_write,
192 .ucom_stop_write = &umct_stop_write,
193 .ucom_poll = &umct_poll,
194 .ucom_free = &umct_free,
197 static const STRUCT_USB_HOST_ID umct_devs[] = {
198 {USB_VPI(USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232, 0)},
199 {USB_VPI(USB_VENDOR_MCT, USB_PRODUCT_MCT_SITECOM_USB232, 0)},
200 {USB_VPI(USB_VENDOR_MCT, USB_PRODUCT_MCT_DU_H3SP_USB232, 0)},
201 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U109, 0)},
202 {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U409, 0)},
205 static device_method_t umct_methods[] = {
206 DEVMETHOD(device_probe, umct_probe),
207 DEVMETHOD(device_attach, umct_attach),
208 DEVMETHOD(device_detach, umct_detach),
212 static devclass_t umct_devclass;
214 static driver_t umct_driver = {
216 .methods = umct_methods,
217 .size = sizeof(struct umct_softc),
220 DRIVER_MODULE(umct, uhub, umct_driver, umct_devclass, NULL, 0);
221 MODULE_DEPEND(umct, ucom, 1, 1, 1);
222 MODULE_DEPEND(umct, usb, 1, 1, 1);
223 MODULE_VERSION(umct, 1);
226 umct_probe(device_t dev)
228 struct usb_attach_arg *uaa = device_get_ivars(dev);
230 if (uaa->usb_mode != USB_MODE_HOST) {
233 if (uaa->info.bConfigIndex != UMCT_CONFIG_INDEX) {
236 if (uaa->info.bIfaceIndex != UMCT_IFACE_INDEX) {
239 return (usbd_lookup_id_by_uaa(umct_devs, sizeof(umct_devs), uaa));
243 umct_attach(device_t dev)
245 struct usb_attach_arg *uaa = device_get_ivars(dev);
246 struct umct_softc *sc = device_get_softc(dev);
251 sc->sc_udev = uaa->device;
252 sc->sc_unit = device_get_unit(dev);
254 device_set_usb_desc(dev);
255 mtx_init(&sc->sc_mtx, "umct", NULL, MTX_DEF);
256 ucom_ref(&sc->sc_super_ucom);
258 sc->sc_iface_no = uaa->info.bIfaceNum;
260 iface_index = UMCT_IFACE_INDEX;
261 error = usbd_transfer_setup(uaa->device, &iface_index,
262 sc->sc_xfer, umct_config, UMCT_N_TRANSFER, sc, &sc->sc_mtx);
265 device_printf(dev, "allocating USB "
266 "transfers failed\n");
271 * The real bulk-in endpoint is also marked as an interrupt.
272 * The only way to differentiate it from the real interrupt
273 * endpoint is to look at the wMaxPacketSize field.
275 maxp = usbd_xfer_max_framelen(sc->sc_xfer[UMCT_BULK_DT_RD]);
278 /* guessed wrong - switch around endpoints */
280 struct usb_xfer *temp = sc->sc_xfer[UMCT_INTR_DT_RD];
282 sc->sc_xfer[UMCT_INTR_DT_RD] = sc->sc_xfer[UMCT_BULK_DT_RD];
283 sc->sc_xfer[UMCT_BULK_DT_RD] = temp;
287 sc->sc_obufsize = usbd_xfer_max_len(sc->sc_xfer[UMCT_BULK_DT_WR]);
289 if (uaa->info.idProduct == USB_PRODUCT_MCT_SITECOM_USB232) {
290 if (sc->sc_obufsize > 16) {
291 sc->sc_obufsize = 16;
294 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
295 &umct_callback, &sc->sc_mtx);
299 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
301 return (0); /* success */
305 return (ENXIO); /* failure */
309 umct_detach(device_t dev)
311 struct umct_softc *sc = device_get_softc(dev);
313 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
314 usbd_transfer_unsetup(sc->sc_xfer, UMCT_N_TRANSFER);
316 device_claim_softc(dev);
323 UCOM_UNLOAD_DRAIN(umct);
326 umct_free_softc(struct umct_softc *sc)
328 if (ucom_unref(&sc->sc_super_ucom)) {
329 mtx_destroy(&sc->sc_mtx);
330 device_free_softc(sc);
335 umct_free(struct ucom_softc *ucom)
337 umct_free_softc(ucom->sc_parent);
341 umct_cfg_do_request(struct umct_softc *sc, uint8_t request,
342 uint16_t len, uint32_t value)
344 struct usb_device_request req;
350 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
351 req.bRequest = request;
352 USETW(req.wValue, 0);
353 req.wIndex[0] = sc->sc_iface_no;
355 USETW(req.wLength, len);
358 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
359 &req, temp, 0, 1000);
361 DPRINTFN(0, "device request failed, err=%s "
362 "(ignored)\n", usbd_errstr(err));
368 umct_intr_callback_sub(struct usb_xfer *xfer, usb_error_t error)
370 struct umct_softc *sc = usbd_xfer_softc(xfer);
371 struct usb_page_cache *pc;
375 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
377 switch (USB_GET_STATE(xfer)) {
378 case USB_ST_TRANSFERRED:
380 DPRINTF("too short message\n");
383 pc = usbd_xfer_get_frame(xfer, 0);
384 usbd_copy_out(pc, 0, buf, sizeof(buf));
389 ucom_status_change(&sc->sc_ucom);
393 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
394 usbd_transfer_submit(xfer);
398 if (error != USB_ERR_CANCELLED) {
399 /* try to clear stall first */
400 usbd_xfer_set_stall(xfer);
408 umct_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
410 struct umct_softc *sc = ucom->sc_parent;
417 umct_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
419 struct umct_softc *sc = ucom->sc_parent;
426 umct_cfg_do_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, sc->sc_lcr);
430 umct_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
432 struct umct_softc *sc = ucom->sc_parent;
439 umct_cfg_do_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
443 umct_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
445 struct umct_softc *sc = ucom->sc_parent;
452 umct_cfg_do_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
456 umct_calc_baud(uint32_t baud)
459 case B300:return (0x1);
486 umct_pre_param(struct ucom_softc *ucom, struct termios *t)
488 return (0); /* we accept anything */
492 umct_cfg_param(struct ucom_softc *ucom, struct termios *t)
494 struct umct_softc *sc = ucom->sc_parent;
497 value = umct_calc_baud(t->c_ospeed);
498 umct_cfg_do_request(sc, UMCT_SET_BAUD, UMCT_SET_BAUD_SIZE, value);
500 value = (sc->sc_lcr & 0x40);
502 switch (t->c_cflag & CSIZE) {
518 value |= (t->c_cflag & CSTOPB) ? 0x4 : 0;
519 if (t->c_cflag & PARENB) {
521 value |= (t->c_cflag & PARODD) ? 0x0 : 0x10;
524 * XXX There doesn't seem to be a way to tell the device
525 * to use flow control.
529 umct_cfg_do_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, value);
533 umct_start_read(struct ucom_softc *ucom)
535 struct umct_softc *sc = ucom->sc_parent;
537 /* start interrupt endpoint */
538 usbd_transfer_start(sc->sc_xfer[UMCT_INTR_DT_RD]);
540 /* start read endpoint */
541 usbd_transfer_start(sc->sc_xfer[UMCT_BULK_DT_RD]);
545 umct_stop_read(struct ucom_softc *ucom)
547 struct umct_softc *sc = ucom->sc_parent;
549 /* stop interrupt endpoint */
550 usbd_transfer_stop(sc->sc_xfer[UMCT_INTR_DT_RD]);
552 /* stop read endpoint */
553 usbd_transfer_stop(sc->sc_xfer[UMCT_BULK_DT_RD]);
557 umct_start_write(struct ucom_softc *ucom)
559 struct umct_softc *sc = ucom->sc_parent;
561 usbd_transfer_start(sc->sc_xfer[UMCT_BULK_DT_WR]);
565 umct_stop_write(struct ucom_softc *ucom)
567 struct umct_softc *sc = ucom->sc_parent;
569 usbd_transfer_stop(sc->sc_xfer[UMCT_BULK_DT_WR]);
573 umct_read_callback(struct usb_xfer *xfer, usb_error_t error)
575 struct umct_softc *sc = usbd_xfer_softc(xfer);
578 umct_intr_callback_sub(xfer, error);
580 umct_read_callback_sub(xfer, error);
584 umct_intr_callback(struct usb_xfer *xfer, usb_error_t error)
586 struct umct_softc *sc = usbd_xfer_softc(xfer);
589 umct_read_callback_sub(xfer, error);
591 umct_intr_callback_sub(xfer, error);
595 umct_write_callback(struct usb_xfer *xfer, usb_error_t error)
597 struct umct_softc *sc = usbd_xfer_softc(xfer);
598 struct usb_page_cache *pc;
601 switch (USB_GET_STATE(xfer)) {
603 case USB_ST_TRANSFERRED:
605 pc = usbd_xfer_get_frame(xfer, 0);
606 if (ucom_get_data(&sc->sc_ucom, pc, 0,
607 sc->sc_obufsize, &actlen)) {
609 usbd_xfer_set_frame_len(xfer, 0, actlen);
610 usbd_transfer_submit(xfer);
615 if (error != USB_ERR_CANCELLED) {
616 /* try to clear stall first */
617 usbd_xfer_set_stall(xfer);
625 umct_read_callback_sub(struct usb_xfer *xfer, usb_error_t error)
627 struct umct_softc *sc = usbd_xfer_softc(xfer);
628 struct usb_page_cache *pc;
631 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
633 switch (USB_GET_STATE(xfer)) {
634 case USB_ST_TRANSFERRED:
635 pc = usbd_xfer_get_frame(xfer, 0);
636 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
640 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
641 usbd_transfer_submit(xfer);
645 if (error != USB_ERR_CANCELLED) {
646 /* try to clear stall first */
647 usbd_xfer_set_stall(xfer);
655 umct_poll(struct ucom_softc *ucom)
657 struct umct_softc *sc = ucom->sc_parent;
658 usbd_transfer_poll(sc->sc_xfer, UMCT_N_TRANSFER);