dbab5e28b5cfd62de31ac1a8f0d611d5ac6c0660
[dragonfly.git] / sys / dev / usbmisc / umct / umct.c
1 /*-
2  * Copyright (c) 2003 Scott Long
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  *
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.9 2007/06/28 06:32:33 hasso Exp $
28  */
29
30 /*
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
38  * #ifdef's.
39  */
40
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/malloc.h>
45 #include <sys/bus.h>
46 #include <sys/tty.h>
47 #include <sys/taskqueue.h>
48
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"
54
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
66 #define UMCT_SET_UNKNOWN1       11
67 #define UMCT_SET_UNKNOWN1_SIZE  1
68 #define UMCT_SET_UNKNOWN2       12
69 #define UMCT_SET_UNKNOWN2_SIZE  1
70
71
72 #define UMCT_INTR_INTERVAL      100
73 #define UMCT_IFACE_INDEX        0
74 #define UMCT_CONFIG_INDEX       1
75
76 struct umct_softc {
77         struct ucom_softc       sc_ucom;
78         int                     sc_iface_number;
79         usbd_interface_handle   sc_intr_iface;
80         int                     sc_intr_number;
81         usbd_pipe_handle        sc_intr_pipe;
82         u_char                  *sc_intr_buf;
83         int                     sc_isize;
84         uint8_t                 sc_lsr;
85         uint8_t                 sc_msr;
86         uint8_t                 sc_lcr;
87         uint8_t                 sc_mcr;
88         struct task             sc_task;
89 };
90
91 static void umct_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
92 static void umct_get_status(void *, int, u_char *, u_char *);
93 static void umct_set(void *, int, int, int);
94 static int  umct_param(void *, int, struct termios *);
95 static int  umct_open(void *, int);
96 static void umct_close(void *, int);
97 static void umct_notify(void *, int);
98
99 static struct ucom_callback umct_callback = {
100         umct_get_status,        /* ucom_get_status */
101         umct_set,               /* ucom_set */
102         umct_param,             /* ucom_param */
103         NULL,                   /* ucom_ioctl */
104         umct_open,              /* ucom_open */
105         umct_close,             /* ucom_close */
106         NULL,                   /* ucom_read */
107         NULL                    /* ucom_write */
108 };
109
110 static const struct umct_product {
111         uint16_t        vendor;
112         uint16_t        product;
113 } umct_products[] = {
114         { USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232 },
115         { USB_VENDOR_MCT, USB_PRODUCT_MCT_SITECOM_USB232 },
116         { USB_VENDOR_MCT, USB_PRODUCT_MCT_DU_H3SP_USB232 },
117         { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U109 },
118         { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U409 },
119         { 0, 0 }
120 };
121
122 static device_probe_t   umct_match;
123 static device_attach_t  umct_attach;
124 static device_detach_t  umct_detach;
125
126 static device_method_t umct_methods[] = {
127         DEVMETHOD(device_probe, umct_match),
128         DEVMETHOD(device_attach, umct_attach),
129         DEVMETHOD(device_detach, umct_detach),
130         { 0, 0 }
131 };
132
133 static driver_t umct_driver = {
134         "ucom",
135         umct_methods,
136         sizeof(struct umct_softc)
137 };
138
139 DRIVER_MODULE(umct, uhub, umct_driver, ucom_devclass, usbd_driver_load, 0);
140 MODULE_DEPEND(umct, usb, 1, 1, 1);
141 MODULE_DEPEND(umct, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
142 MODULE_VERSION(umct, 1);
143
144 USB_MATCH(umct)
145 {
146         USB_MATCH_START(umct, uaa);
147         int i;
148
149         if (uaa->iface != NULL)
150                 return (UMATCH_NONE);
151
152         for (i = 0; umct_products[i].vendor != 0; i++) {
153                 if (umct_products[i].vendor == uaa->vendor &&
154                     umct_products[i].product == uaa->product) {
155                         return (UMATCH_VENDOR_PRODUCT);
156                 }
157         }
158
159         return (UMATCH_NONE);
160 }
161
162 USB_ATTACH(umct)
163 {
164         USB_ATTACH_START(umct, sc, uaa);
165         usbd_device_handle dev;
166         struct ucom_softc *ucom;
167         usb_config_descriptor_t *cdesc;
168         usb_interface_descriptor_t *id;
169         usb_endpoint_descriptor_t *ed;
170         char *devinfo;
171         const char *devname;
172         usbd_status err;
173         int i;
174
175         dev = uaa->device;
176         devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT | M_ZERO);
177         bzero(sc, sizeof(struct umct_softc));
178         ucom = &sc->sc_ucom;
179         ucom->sc_dev = self;
180         ucom->sc_udev = dev;
181         ucom->sc_iface = uaa->iface;
182
183         usbd_devinfo(dev, 0, devinfo);
184         device_set_desc_copy(self, devinfo);
185         devname = device_get_nameunit(ucom->sc_dev);
186         kprintf("%s: %s\n", devname, devinfo);
187
188         ucom->sc_bulkout_no = -1;
189         ucom->sc_bulkin_no = -1;
190         sc->sc_intr_number = -1;
191         sc->sc_intr_pipe = NULL;
192
193         err = usbd_set_config_index(dev, UMCT_CONFIG_INDEX, 1);
194         if (err) {
195                 kprintf("%s: failed to set configuration: %s\n",
196                     devname, usbd_errstr(err));
197                 ucom->sc_dying = 1;
198                 goto error;
199         }
200
201         cdesc = usbd_get_config_descriptor(ucom->sc_udev);
202         if (cdesc == NULL) {
203                 kprintf("%s: failed to get configuration descriptor\n", devname);
204                 ucom->sc_dying = 1;
205                 goto error;
206         }
207
208         err = usbd_device2interface_handle(dev, UMCT_IFACE_INDEX,
209             &ucom->sc_iface);
210         if (err) {
211                 kprintf("%s: failed to get interface: %s\n", devname,
212                     usbd_errstr(err));
213                 ucom->sc_dying = 1;
214                 goto error;
215         }
216
217         id = usbd_get_interface_descriptor(ucom->sc_iface);
218         sc->sc_iface_number = id->bInterfaceNumber;
219
220         for (i = 0; i < id->bNumEndpoints; i++) {
221                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
222                 if (ed == NULL) {
223                         kprintf("%s: no endpoint descriptor for %d\n",
224                             devname, i);
225                         ucom->sc_dying = 1;
226                         goto error;
227                 }
228
229                 /*
230                  * The real bulk-in endpoint is also marked as an interrupt.
231                  * The only way to differentiate it from the real interrupt
232                  * endpoint is to look at the wMaxPacketSize field.
233                  */
234                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN) {
235                         if (UGETW(ed->wMaxPacketSize) == 0x2) {
236                                 sc->sc_intr_number = ed->bEndpointAddress;
237                                 sc->sc_isize = UGETW(ed->wMaxPacketSize);
238                         } else {
239                                 ucom->sc_bulkin_no = ed->bEndpointAddress;
240                                 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
241                         }
242                         continue;
243                 }
244
245                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT) {
246                         ucom->sc_bulkout_no = ed->bEndpointAddress;
247                         if (uaa->product == USB_PRODUCT_MCT_SITECOM_USB232)
248                                 ucom->sc_obufsize = 16; /* device is broken */
249                         else
250                                 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
251                         continue;
252                 }
253
254                 kprintf("%s: warning - unsupported endpoint 0x%x\n", devname,
255                     ed->bEndpointAddress);
256         }
257
258         if (sc->sc_intr_number == -1) {
259                 kprintf("%s: Could not find interrupt in\n", devname);
260                 ucom->sc_dying = 1;
261                 goto error;
262         }
263
264         sc->sc_intr_iface = ucom->sc_iface;
265
266         if (ucom->sc_bulkout_no == -1) {
267                 kprintf("%s: Could not find data bulk out\n", devname);
268                 ucom->sc_dying = 1;
269                 goto error;
270         }
271
272         ucom->sc_parent = sc;
273         ucom->sc_portno = UCOM_UNK_PORTNO;
274         ucom->sc_opkthdrlen = 0;
275         ucom->sc_callback = &umct_callback;
276         TASK_INIT(&sc->sc_task, 0, umct_notify, sc);
277         ucom_attach(ucom);
278
279         kfree(devinfo, M_USBDEV);
280         USB_ATTACH_SUCCESS_RETURN;
281
282 error:
283         kfree(devinfo, M_USBDEV);
284         USB_ATTACH_ERROR_RETURN;
285 }
286
287 USB_DETACH(umct)
288 {
289         USB_DETACH_START(umct, sc);
290         int rv;
291
292         if (sc->sc_intr_pipe != NULL) {
293                 usbd_abort_pipe(sc->sc_intr_pipe);
294                 usbd_close_pipe(sc->sc_intr_pipe);
295                 kfree(sc->sc_intr_buf, M_USBDEV);
296                 sc->sc_intr_pipe = NULL;
297         }
298
299         sc->sc_ucom.sc_dying = 1;
300         rv = ucom_detach(&sc->sc_ucom);
301         return (rv);
302 }
303
304 static int
305 umct_request(struct umct_softc *sc, uint8_t request, int len, uint32_t value)
306 {
307         usb_device_request_t req;
308         usbd_status err;
309         uint8_t oval[4];
310
311         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
312         req.bRequest = request;
313         USETW(req.wValue, 0);
314         USETW(req.wIndex, sc->sc_iface_number);
315         USETW(req.wLength, len);
316         USETDW(oval, value);
317
318         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, oval);
319         if (err)
320                 kprintf("%s: ubsa_request: %s\n",
321                     device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
322         return (err);
323 }
324
325 static void
326 umct_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
327 {
328         struct umct_softc *sc;
329         u_char *buf;
330
331         sc = (struct umct_softc *)priv;
332         buf = sc->sc_intr_buf;
333         if (sc->sc_ucom.sc_dying)
334                 return;
335
336         if (status != USBD_NORMAL_COMPLETION) {
337                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
338                         return;
339
340                 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
341                 return;
342         }
343
344         sc->sc_msr = buf[0];
345         sc->sc_lsr = buf[1];
346
347         /*
348          * Defer notifying the ucom layer as it doesn't like to be bothered
349          * from an interrupt context.
350          */
351         taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
352 }
353
354 static void
355 umct_notify(void *arg, int count)
356 {
357         struct umct_softc *sc;
358
359         sc = (struct umct_softc *)arg;
360         if (sc->sc_ucom.sc_dying == 0)
361                 ucom_status_change(&sc->sc_ucom);
362 }
363
364 static void
365 umct_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
366 {
367         struct umct_softc *sc;
368
369         sc = addr;
370         if (lsr != NULL)
371                 *lsr = sc->sc_lsr;
372         if (msr != NULL)
373                 *msr = sc->sc_msr;
374
375         return;
376 }
377
378 static void
379 umct_set(void *addr, int portno, int reg, int onoff)
380 {
381         struct umct_softc *sc;
382
383         sc = addr;
384         switch (reg) {
385         case UCOM_SET_BREAK:
386                 sc->sc_lcr &= ~0x40;
387                 sc->sc_lcr |= (onoff) ? 0x40 : 0;
388                 umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, sc->sc_lcr);
389                 break;
390         case UCOM_SET_DTR:
391                 sc->sc_mcr &= ~0x01;
392                 sc->sc_mcr |= (onoff) ? 0x01 : 0;
393                 umct_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
394                 break;
395         case UCOM_SET_RTS:
396                 sc->sc_mcr &= ~0x2;
397                 sc->sc_mcr |= (onoff) ? 0x02 : 0;
398                 umct_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
399                 break;
400         default:
401                 break;
402         }
403 }
404
405 static int
406 umct_calc_baud(u_int baud)
407 {
408         switch(baud) {
409         case B300: return (0x1);
410         case B600: return (0x2);
411         case B1200: return (0x3);
412         case B2400: return (0x4);
413         case B4800: return (0x6);
414         case B9600: return (0x8);
415         case B19200: return (0x9);
416         case B38400: return (0xa);
417         case B57600: return (0xb);
418         case 115200: return (0xc);
419         case B0:
420         default:
421                 break;
422         }
423
424         return (0x0);
425 }
426
427 static int
428 umct_param(void *addr, int portno, struct termios *ti)
429 {
430         struct umct_softc *sc;
431         uint32_t value;
432
433         sc = addr;
434         value = umct_calc_baud(ti->c_ospeed);
435         umct_request(sc, UMCT_SET_BAUD, UMCT_SET_BAUD_SIZE, value);
436         umct_request(sc, UMCT_SET_UNKNOWN1, UMCT_SET_UNKNOWN1_SIZE, 0);
437         umct_request(sc, UMCT_SET_UNKNOWN2, UMCT_SET_UNKNOWN2_SIZE, 0);
438
439         value = sc->sc_lcr & 0x40;
440
441         switch (ti->c_cflag & CSIZE) {
442         case CS5: value |= 0x0; break;
443         case CS6: value |= 0x1; break;
444         case CS7: value |= 0x2; break;
445         case CS8: value |= 0x3; break;
446         default: value |= 0x0; break;
447         }
448
449         value |= (ti->c_cflag & CSTOPB) ? 0x4 : 0;
450         if (ti->c_cflag & PARENB) {
451                 value |= 0x8;
452                 value |= (ti->c_cflag & PARODD) ? 0x0 : 0x10;
453         }
454
455         /*
456          * XXX There doesn't seem to be a way to tell the device to use flow
457          * control.
458          */
459
460         sc->sc_lcr = value;
461         umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, value);
462
463         return (0);
464 }
465
466 static int
467 umct_open(void *addr, int portno)
468 {
469         struct umct_softc *sc;
470         int err;
471
472         sc = addr;
473         if (sc->sc_ucom.sc_dying) {
474                 return (ENXIO);
475         }
476
477         if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
478                 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
479                 err = usbd_open_pipe_intr(sc->sc_intr_iface, sc->sc_intr_number,
480                     USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buf,
481                     sc->sc_isize, umct_intr, UMCT_INTR_INTERVAL);
482                 if (err) {
483                         kprintf("%s: cannot open interrupt pipe (addr %d)\n",
484                             device_get_nameunit(sc->sc_ucom.sc_dev),
485                             sc->sc_intr_number);
486                         kfree(sc->sc_intr_buf, M_USBDEV);
487                         return (EIO);
488                 }
489         }
490
491         return (0);
492 }
493
494 static void
495 umct_close(void *addr, int portno)
496 {
497         struct umct_softc *sc;
498         int err;
499
500         sc = addr;
501         if (sc->sc_ucom.sc_dying)
502                 return;
503
504         if (sc->sc_intr_pipe != NULL) {
505                 err = usbd_abort_pipe(sc->sc_intr_pipe);
506                 if (err)
507                         kprintf("%s: abort interrupt pipe failed: %s\n",
508                             device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
509                 err = usbd_close_pipe(sc->sc_intr_pipe);
510                 if (err)
511                         kprintf("%s: close interrupt pipe failed: %s\n",
512                             device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
513                 kfree(sc->sc_intr_buf, M_USBDEV);
514                 sc->sc_intr_pipe = NULL;
515         }
516 }