2 * Copyright (c) 2003 Scott Long
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
26 * $FreeBSD: src/sys/dev/usb/umct.c,v 1.12 2006/09/07 00:06:42 imp Exp $
27 * $DragonFly: src/sys/dev/usbmisc/umct/umct.c,v 1.7 2006/12/22 23:26:26 swildner Exp $
31 * Driver for the MCT (Magic Control Technology) USB-RS232 Converter.
32 * Based on the superb documentation from the linux mct_u232 driver by
33 * Wolfgang Grandeggar <wolfgang@cec.ch>.
34 * This device smells a lot like the Belkin F5U103, except that it has
35 * suffered some mild brain-damage. This driver is based off of the ubsa.c
36 * driver from Alexander Kabaev <kan@freebsd.org>. Merging the two together
37 * might be useful, though the subtle differences might lead to lots of
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/malloc.h>
47 #include <sys/taskqueue.h>
49 #include <bus/usb/usb.h>
50 #include <bus/usb/usbdi.h>
51 #include <bus/usb/usbdi_util.h>
52 #include <bus/usb/usbdevs.h>
53 #include "../ucom/ucomvar.h"
55 /* The UMCT advertises the standard 8250 UART registers */
56 #define UMCT_GET_MSR 2 /* Get Modem Status Register */
57 #define UMCT_GET_MSR_SIZE 1
58 #define UMCT_GET_LCR 6 /* Get Line Control Register */
59 #define UMCT_GET_LCR_SIZE 1
60 #define UMCT_SET_BAUD 5 /* Set the Baud Rate Divisor */
61 #define UMCT_SET_BAUD_SIZE 4
62 #define UMCT_SET_LCR 7 /* Set Line Control Register */
63 #define UMCT_SET_LCR_SIZE 1
64 #define UMCT_SET_MCR 10 /* Set Modem Control Register */
65 #define UMCT_SET_MCR_SIZE 1
67 #define UMCT_INTR_INTERVAL 100
68 #define UMCT_IFACE_INDEX 0
69 #define UMCT_CONFIG_INDEX 1
72 struct ucom_softc sc_ucom;
74 usbd_interface_handle sc_intr_iface;
76 usbd_pipe_handle sc_intr_pipe;
86 Static void umct_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
87 Static void umct_get_status(void *, int, u_char *, u_char *);
88 Static void umct_set(void *, int, int, int);
89 Static int umct_param(void *, int, struct termios *);
90 Static int umct_open(void *, int);
91 Static void umct_close(void *, int);
92 Static void umct_notify(void *, int);
94 Static struct ucom_callback umct_callback = {
95 umct_get_status, /* ucom_get_status */
96 umct_set, /* ucom_set */
97 umct_param, /* ucom_param */
98 NULL, /* ucom_ioctl */
99 umct_open, /* ucom_open */
100 umct_close, /* ucom_close */
101 NULL, /* ucom_read */
102 NULL /* ucom_write */
105 Static const struct umct_product {
108 } umct_products[] = {
109 { USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232 },
110 { USB_VENDOR_MCT, USB_PRODUCT_MCT_SITECOM_USB232 },
111 { USB_VENDOR_MCT, USB_PRODUCT_MCT_DU_H3SP_USB232 },
112 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U109 },
113 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U409 },
117 Static device_probe_t umct_match;
118 Static device_attach_t umct_attach;
119 Static device_detach_t umct_detach;
121 Static device_method_t umct_methods[] = {
122 DEVMETHOD(device_probe, umct_match),
123 DEVMETHOD(device_attach, umct_attach),
124 DEVMETHOD(device_detach, umct_detach),
128 Static driver_t umct_driver = {
131 sizeof(struct umct_softc)
134 DRIVER_MODULE(umct, uhub, umct_driver, ucom_devclass, usbd_driver_load, 0);
135 MODULE_DEPEND(umct, usb, 1, 1, 1);
136 MODULE_DEPEND(umct, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
137 MODULE_VERSION(umct, 1);
141 USB_MATCH_START(umct, uaa);
144 if (uaa->iface != NULL)
145 return (UMATCH_NONE);
147 for (i = 0; umct_products[i].vendor != 0; i++) {
148 if (umct_products[i].vendor == uaa->vendor &&
149 umct_products[i].product == uaa->product) {
150 return (UMATCH_VENDOR_PRODUCT);
154 return (UMATCH_NONE);
159 USB_ATTACH_START(umct, sc, uaa);
160 usbd_device_handle dev;
161 struct ucom_softc *ucom;
162 usb_config_descriptor_t *cdesc;
163 usb_interface_descriptor_t *id;
164 usb_endpoint_descriptor_t *ed;
171 devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT | M_ZERO);
172 bzero(sc, sizeof(struct umct_softc));
176 ucom->sc_iface = uaa->iface;
178 usbd_devinfo(dev, 0, devinfo);
179 device_set_desc_copy(self, devinfo);
180 devname = USBDEVNAME(ucom->sc_dev);
181 kprintf("%s: %s\n", devname, devinfo);
183 ucom->sc_bulkout_no = -1;
184 ucom->sc_bulkin_no = -1;
185 sc->sc_intr_number = -1;
186 sc->sc_intr_pipe = NULL;
188 err = usbd_set_config_index(dev, UMCT_CONFIG_INDEX, 1);
190 kprintf("%s: failed to set configuration: %s\n",
191 devname, usbd_errstr(err));
196 cdesc = usbd_get_config_descriptor(ucom->sc_udev);
198 kprintf("%s: failed to get configuration descriptor\n", devname);
203 err = usbd_device2interface_handle(dev, UMCT_IFACE_INDEX,
206 kprintf("%s: failed to get interface: %s\n", devname,
212 id = usbd_get_interface_descriptor(ucom->sc_iface);
213 sc->sc_iface_number = id->bInterfaceNumber;
215 for (i = 0; i < id->bNumEndpoints; i++) {
216 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
218 kprintf("%s: no endpoint descriptor for %d\n",
225 * The real bulk-in endpoint is also marked as an interrupt.
226 * The only way to differentiate it from the real interrupt
227 * endpoint is to look at the wMaxPacketSize field.
229 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN) {
230 if (UGETW(ed->wMaxPacketSize) == 0x2) {
231 sc->sc_intr_number = ed->bEndpointAddress;
232 sc->sc_isize = UGETW(ed->wMaxPacketSize);
234 ucom->sc_bulkin_no = ed->bEndpointAddress;
235 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
240 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT) {
241 ucom->sc_bulkout_no = ed->bEndpointAddress;
242 if (uaa->product == USB_PRODUCT_MCT_SITECOM_USB232)
243 ucom->sc_obufsize = 16; /* device is broken */
245 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
249 kprintf("%s: warning - unsupported endpoint 0x%x\n", devname,
250 ed->bEndpointAddress);
253 if (sc->sc_intr_number == -1) {
254 kprintf("%s: Could not find interrupt in\n", devname);
259 sc->sc_intr_iface = ucom->sc_iface;
261 if (ucom->sc_bulkout_no == -1) {
262 kprintf("%s: Could not find data bulk out\n", devname);
267 ucom->sc_parent = sc;
268 ucom->sc_portno = UCOM_UNK_PORTNO;
269 ucom->sc_opkthdrlen = 0;
270 ucom->sc_callback = &umct_callback;
271 TASK_INIT(&sc->sc_task, 0, umct_notify, sc);
274 kfree(devinfo, M_USBDEV);
275 USB_ATTACH_SUCCESS_RETURN;
278 kfree(devinfo, M_USBDEV);
279 USB_ATTACH_ERROR_RETURN;
284 USB_DETACH_START(umct, sc);
287 if (sc->sc_intr_pipe != NULL) {
288 usbd_abort_pipe(sc->sc_intr_pipe);
289 usbd_close_pipe(sc->sc_intr_pipe);
290 kfree(sc->sc_intr_buf, M_USBDEV);
291 sc->sc_intr_pipe = NULL;
294 sc->sc_ucom.sc_dying = 1;
295 rv = ucom_detach(&sc->sc_ucom);
300 umct_request(struct umct_softc *sc, uint8_t request, int len, uint32_t value)
302 usb_device_request_t req;
306 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
307 req.bRequest = request;
308 USETW(req.wValue, 0);
309 USETW(req.wIndex, sc->sc_iface_number);
310 USETW(req.wLength, len);
313 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, oval);
315 kprintf("%s: ubsa_request: %s\n",
316 USBDEVNAME(sc->sc_ucom.sc_dev), usbd_errstr(err));
321 umct_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
323 struct umct_softc *sc;
326 sc = (struct umct_softc *)priv;
327 buf = sc->sc_intr_buf;
328 if (sc->sc_ucom.sc_dying)
331 if (status != USBD_NORMAL_COMPLETION) {
332 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
335 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
343 * Defer notifying the ucom layer as it doesn't like to be bothered
344 * from an interrupt context.
346 taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
350 umct_notify(void *arg, int count)
352 struct umct_softc *sc;
354 sc = (struct umct_softc *)arg;
355 if (sc->sc_ucom.sc_dying == 0)
356 ucom_status_change(&sc->sc_ucom);
360 umct_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
362 struct umct_softc *sc;
374 umct_set(void *addr, int portno, int reg, int onoff)
376 struct umct_softc *sc;
382 sc->sc_lcr |= (onoff) ? 0x40 : 0;
383 umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, sc->sc_lcr);
387 sc->sc_mcr |= (onoff) ? 0x01 : 0;
388 umct_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
392 sc->sc_mcr |= (onoff) ? 0x02 : 0;
393 umct_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
401 umct_calc_baud(u_int baud)
404 case B300: return (0x1);
405 case B600: return (0x2);
406 case B1200: return (0x3);
407 case B2400: return (0x4);
408 case B4800: return (0x6);
409 case B9600: return (0x8);
410 case B19200: return (0x9);
411 case B38400: return (0xa);
412 case B57600: return (0xb);
413 case 115200: return (0xc);
423 umct_param(void *addr, int portno, struct termios *ti)
425 struct umct_softc *sc;
429 value = umct_calc_baud(ti->c_ospeed);
430 umct_request(sc, UMCT_SET_BAUD, UMCT_SET_BAUD_SIZE, value);
432 value = sc->sc_lcr & 0x40;
434 switch (ti->c_cflag & CSIZE) {
435 case CS5: value |= 0x0; break;
436 case CS6: value |= 0x1; break;
437 case CS7: value |= 0x2; break;
438 case CS8: value |= 0x3; break;
439 default: value |= 0x0; break;
442 value |= (ti->c_cflag & CSTOPB) ? 0x4 : 0;
443 if (ti->c_cflag & PARENB) {
445 value |= (ti->c_cflag & PARODD) ? 0x0 : 0x10;
449 * XXX There doesn't seem to be a way to tell the device to use flow
454 umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, value);
460 umct_open(void *addr, int portno)
462 struct umct_softc *sc;
466 if (sc->sc_ucom.sc_dying) {
470 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
471 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
472 err = usbd_open_pipe_intr(sc->sc_intr_iface, sc->sc_intr_number,
473 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buf,
474 sc->sc_isize, umct_intr, UMCT_INTR_INTERVAL);
476 kprintf("%s: cannot open interrupt pipe (addr %d)\n",
477 USBDEVNAME(sc->sc_ucom.sc_dev),
479 kfree(sc->sc_intr_buf, M_USBDEV);
488 umct_close(void *addr, int portno)
490 struct umct_softc *sc;
494 if (sc->sc_ucom.sc_dying)
497 if (sc->sc_intr_pipe != NULL) {
498 err = usbd_abort_pipe(sc->sc_intr_pipe);
500 kprintf("%s: abort interrupt pipe failed: %s\n",
501 USBDEVNAME(sc->sc_ucom.sc_dev), usbd_errstr(err));
502 err = usbd_close_pipe(sc->sc_intr_pipe);
504 kprintf("%s: close interrupt pipe failed: %s\n",
505 USBDEVNAME(sc->sc_ucom.sc_dev), usbd_errstr(err));
506 kfree(sc->sc_intr_buf, M_USBDEV);
507 sc->sc_intr_pipe = NULL;