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.5 2003/11/16 12:13:39 akiyama Exp $
  27  * $DragonFly: src/sys/dev/usbmisc/umct/umct.c,v 1.1 2003/12/30 01:01:47 dillon 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/interrupt.h>
  48
  49 #include <dev/usb/usb.h>
  50 #include <dev/usb/usbdi.h>
  51 #include <dev/usb/usbdi_util.h>
  52 #include <dev/usb/usbdevs.h>
  53 #include <dev/usb/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
  67 #define UMCT_INTR_INTERVAL      100
  68 #define UMCT_IFACE_INDEX        0
  69 #define UMCT_CONFIG_INDEX       1
  70
  71 struct umct_softc {
  72         struct ucom_softc       sc_ucom;
  73         int                     sc_iface_number;
  74         usbd_interface_handle   sc_intr_iface;
  75         int                     sc_intr_number;
  76         usbd_pipe_handle        sc_intr_pipe;
  77         u_char                  *sc_intr_buf;
  78         int                     sc_isize;
  79         uint8_t                 sc_lsr;
  80         uint8_t                 sc_msr;
  81         uint8_t                 sc_lcr;
  82         uint8_t                 sc_mcr;
  83         void                    *sc_swicookie;
  84 };
  85
  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 *);
  93
  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 */
 103 };
 104
 105 Static const struct umct_product {
 106         uint16_t        vendor;
 107         uint16_t        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         { 0, 0 }
 114 };
 115
 116 Static device_probe_t   umct_match;
 117 Static device_attach_t  umct_attach;
 118 Static device_detach_t  umct_detach;
 119
 120 Static device_method_t umct_methods[] = {
 121         DEVMETHOD(device_probe, umct_match),
 122         DEVMETHOD(device_attach, umct_attach),
 123         DEVMETHOD(device_detach, umct_detach),
 124         { 0, 0 }
 125 };
 126
 127 Static driver_t umct_driver = {
 128         "ucom",
 129         umct_methods,
 130         sizeof(struct umct_softc)
 131 };
 132
 133 DRIVER_MODULE(umct, uhub, umct_driver, ucom_devclass, usbd_driver_load, 0);
 134 MODULE_DEPEND(umct, usb, 1, 1, 1);
 135 MODULE_DEPEND(umct, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
 136 MODULE_VERSION(umct, 1);
 137
 138 Static struct ithd *umct_ithd;
 139
 140 USB_MATCH(umct)
 141 {
 142         USB_MATCH_START(umct, uaa);
 143         int i;
 144
 145         if (uaa->iface != NULL)
 146                 return (UMATCH_NONE);
 147
 148         for (i = 0; umct_products[i].vendor != 0; i++) {
 149                 if (umct_products[i].vendor == uaa->vendor &&
 150                     umct_products[i].product == uaa->product) {
 151                         return (UMATCH_VENDOR_PRODUCT);
 152                 }
 153         }
 154
 155         return (UMATCH_NONE);
 156 }
 157
 158 USB_ATTACH(umct)
 159 {
 160         USB_ATTACH_START(umct, sc, uaa);
 161         usbd_device_handle dev;
 162         struct ucom_softc *ucom;
 163         usb_config_descriptor_t *cdesc;
 164         usb_interface_descriptor_t *id;
 165         usb_endpoint_descriptor_t *ed;
 166         char *devinfo;
 167         const char *devname;
 168         usbd_status err;
 169         int i;
 170
 171         dev = uaa->device;
 172         devinfo = malloc(1024, M_USBDEV, M_NOWAIT | M_ZERO);
 173         if (devinfo == NULL)
 174                 return (ENOMEM);
 175         bzero(sc, sizeof(struct umct_softc));
 176         ucom = &sc->sc_ucom;
 177         ucom->sc_dev = self;
 178         ucom->sc_udev = dev;
 179         ucom->sc_iface = uaa->iface;
 180
 181         usbd_devinfo(dev, 0, devinfo);
 182         device_set_desc_copy(self, devinfo);
 183         devname = USBDEVNAME(ucom->sc_dev);
 184         printf("%s: %s\n", devname, devinfo);
 185
 186         ucom->sc_bulkout_no = -1;
 187         ucom->sc_bulkin_no = -1;
 188         sc->sc_intr_number = -1;
 189         sc->sc_intr_pipe = NULL;
 190
 191         err = usbd_set_config_index(dev, UMCT_CONFIG_INDEX, 1);
 192         if (err) {
 193                 printf("%s: failed to set configuration: %s\n",
 194                     devname, usbd_errstr(err));
 195                 ucom->sc_dying = 1;
 196                 goto error;
 197         }
 198
 199         cdesc = usbd_get_config_descriptor(ucom->sc_udev);
 200         if (cdesc == NULL) {
 201                 printf("%s: failed to get configuration descriptor\n", devname);
 202                 ucom->sc_dying = 1;
 203                 goto error;
 204         }
 205
 206         err = usbd_device2interface_handle(dev, UMCT_IFACE_INDEX,
 207             &ucom->sc_iface);
 208         if (err) {
 209                 printf("%s: failed to get interface: %s\n", devname,
 210                     usbd_errstr(err));
 211                 ucom->sc_dying = 1;
 212                 goto error;
 213         }
 214
 215         id = usbd_get_interface_descriptor(ucom->sc_iface);
 216         sc->sc_iface_number = id->bInterfaceNumber;
 217
 218         for (i = 0; i < id->bNumEndpoints; i++) {
 219                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 220                 if (ed == NULL) {
 221                         printf("%s: no endpoint descriptor for %d\n",
 222                             devname, i);
 223                         ucom->sc_dying = 1;
 224                         goto error;
 225                 }
 226
 227                 /*
 228                  * The real bulk-in endpoint is also marked as an interrupt.
 229                  * The only way to differentiate it from the real interrupt
 230                  * endpoint is to look at the wMaxPacketSize field.
 231                  */
 232                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN) {
 233                         if (UGETW(ed->wMaxPacketSize) == 0x2) {
 234                                 sc->sc_intr_number = ed->bEndpointAddress;
 235                                 sc->sc_isize = UGETW(ed->wMaxPacketSize);
 236                         } else {
 237                                 ucom->sc_bulkin_no = ed->bEndpointAddress;
 238                                 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
 239                         }
 240                         continue;
 241                 }
 242
 243                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT) {
 244                         ucom->sc_bulkout_no = ed->bEndpointAddress;
 245                         if (uaa->product == USB_PRODUCT_MCT_SITECOM_USB232)
 246                                 ucom->sc_obufsize = 16; /* device is broken */
 247                         else
 248                                 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
 249                         continue;
 250                 }
 251
 252                 printf("%s: warning - unsupported endpoint 0x%x\n", devname,
 253                     ed->bEndpointAddress);
 254         }
 255
 256         if (sc->sc_intr_number == -1) {
 257                 printf("%s: Could not fint interrupt in\n", devname);
 258                 ucom->sc_dying = 1;
 259                 goto error;
 260         }
 261
 262         sc->sc_intr_iface = ucom->sc_iface;
 263
 264         if (ucom->sc_bulkout_no == -1) {
 265                 printf("%s: Could not find data bulk out\n", devname);
 266                 ucom->sc_dying = 1;
 267                 goto error;
 268         }
 269
 270         ucom->sc_parent = sc;
 271         ucom->sc_portno = UCOM_UNK_PORTNO;
 272         ucom->sc_opkthdrlen = 0;
 273         ucom->sc_callback = &umct_callback;
 274         ucom_attach(ucom);
 275         swi_add(&umct_ithd, "ucom", umct_notify, sc, SWI_TTY, 0,
 276             &sc->sc_swicookie);
 277
 278         free(devinfo, M_USBDEV);
 279         USB_ATTACH_SUCCESS_RETURN;
 280
 281 error:
 282         free(devinfo, M_USBDEV);
 283         USB_ATTACH_ERROR_RETURN;
 284 }
 285
 286 USB_DETACH(umct)
 287 {
 288         USB_DETACH_START(umct, sc);
 289         int rv;
 290
 291         if (sc->sc_intr_pipe != NULL) {
 292                 usbd_abort_pipe(sc->sc_intr_pipe);
 293                 usbd_close_pipe(sc->sc_intr_pipe);
 294                 free(sc->sc_intr_buf, M_USBDEV);
 295                 sc->sc_intr_pipe = NULL;
 296         }
 297
 298         sc->sc_ucom.sc_dying = 1;
 299         ithread_remove_handler(sc->sc_swicookie);
 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                 printf("%s: ubsa_request: %s\n",
 321                     USBDEVNAME(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         swi_sched(sc->sc_swicookie, 0);
 352 }
 353
 354 Static void
 355 umct_notify(void *arg)
 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
 437         value = sc->sc_lcr & 0x40;
 438
 439         switch (ti->c_cflag & CSIZE) {
 440         case CS5: value |= 0x0; break;
 441         case CS6: value |= 0x1; break;
 442         case CS7: value |= 0x2; break;
 443         case CS8: value |= 0x3; break;
 444         default: value |= 0x0; break;
 445         }
 446
 447         value |= (ti->c_cflag & CSTOPB) ? 0x4 : 0;
 448         if (ti->c_cflag & PARENB) {
 449                 value |= 0x8;
 450                 value |= (ti->c_cflag & PARODD) ? 0x0 : 0x10;
 451         }
 452
 453         /*
 454          * XXX There doesn't seem to be a way to tell the device to use flow
 455          * control.
 456          */
 457
 458         sc->sc_lcr = value;
 459         umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, value);
 460
 461         return (0);
 462 }
 463
 464 Static int
 465 umct_open(void *addr, int portno)
 466 {
 467         struct umct_softc *sc;
 468         int err;
 469
 470         sc = addr;
 471         if (sc->sc_ucom.sc_dying) {
 472                 return (ENXIO);
 473         }
 474
 475         if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
 476                 sc->sc_intr_buf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
 477                 err = usbd_open_pipe_intr(sc->sc_intr_iface, sc->sc_intr_number,
 478                     USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buf,
 479                     sc->sc_isize, umct_intr, UMCT_INTR_INTERVAL);
 480                 if (err) {
 481                         printf("%s: cannot open interrupt pipe (addr %d)\n",
 482                             USBDEVNAME(sc->sc_ucom.sc_dev),
 483                             sc->sc_intr_number);
 484                         free(sc->sc_intr_buf, M_USBDEV);
 485                         return (EIO);
 486                 }
 487         }
 488
 489         return (0);
 490 }
 491
 492 Static void
 493 umct_close(void *addr, int portno)
 494 {
 495         struct umct_softc *sc;
 496         int err;
 497
 498         sc = addr;
 499         if (sc->sc_ucom.sc_dying)
 500                 return;
 501
 502         if (sc->sc_intr_pipe != NULL) {
 503                 err = usbd_abort_pipe(sc->sc_intr_pipe);
 504                 if (err)
 505                         printf("%s: abort interrupt pipe failed: %s\n",
 506                             USBDEVNAME(sc->sc_ucom.sc_dev), usbd_errstr(err));
 507                 err = usbd_close_pipe(sc->sc_intr_pipe);
 508                 if (err)
 509                         printf("%s: close interrupt pipe failed: %s\n",
 510                             USBDEVNAME(sc->sc_ucom.sc_dev), usbd_errstr(err));
 511                 free(sc->sc_intr_buf, M_USBDEV);
 512                 sc->sc_intr_pipe = NULL;
 513         }
 514 }