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.12 2007/08/19 17:16:43 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 static int
 145 umct_match(device_t self)
 146 {
 147         struct usb_attach_arg *uaa = device_get_ivars(self);
 148         int i;
 149
 150         if (uaa->iface != NULL)
 151                 return (UMATCH_NONE);
 152
 153         for (i = 0; umct_products[i].vendor != 0; i++) {
 154                 if (umct_products[i].vendor == uaa->vendor &&
 155                     umct_products[i].product == uaa->product) {
 156                         return (UMATCH_VENDOR_PRODUCT);
 157                 }
 158         }
 159
 160         return (UMATCH_NONE);
 161 }
 162
 163 static int
 164 umct_attach(device_t self)
 165 {
 166         struct umct_softc *sc = device_get_softc(self);
 167         struct usb_attach_arg *uaa = device_get_ivars(self);
 168         usbd_device_handle dev;
 169         struct ucom_softc *ucom;
 170         usb_config_descriptor_t *cdesc;
 171         usb_interface_descriptor_t *id;
 172         usb_endpoint_descriptor_t *ed;
 173         char *devinfo;
 174         usbd_status err;
 175         int i;
 176
 177         dev = uaa->device;
 178         devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT | M_ZERO);
 179         bzero(sc, sizeof(struct umct_softc));
 180         ucom = &sc->sc_ucom;
 181         ucom->sc_dev = self;
 182         ucom->sc_udev = dev;
 183         ucom->sc_iface = uaa->iface;
 184
 185         usbd_devinfo(dev, 0, devinfo);
 186         device_set_desc_copy(self, devinfo);
 187         device_printf(ucom->sc_dev, "%s\n", devinfo);
 188
 189         ucom->sc_bulkout_no = -1;
 190         ucom->sc_bulkin_no = -1;
 191         sc->sc_intr_number = -1;
 192         sc->sc_intr_pipe = NULL;
 193
 194         err = usbd_set_config_index(dev, UMCT_CONFIG_INDEX, 1);
 195         if (err) {
 196                 device_printf(ucom->sc_dev, "failed to set configuration: %s\n",
 197                               usbd_errstr(err));
 198                 ucom->sc_dying = 1;
 199                 goto error;
 200         }
 201
 202         cdesc = usbd_get_config_descriptor(ucom->sc_udev);
 203         if (cdesc == NULL) {
 204                 device_printf(ucom->sc_dev, "failed to get configuration "
 205                               "descriptor\n");
 206                 ucom->sc_dying = 1;
 207                 goto error;
 208         }
 209
 210         err = usbd_device2interface_handle(dev, UMCT_IFACE_INDEX,
 211             &ucom->sc_iface);
 212         if (err) {
 213                 device_printf(ucom->sc_dev, "failed to get interface: %s\n",
 214                               usbd_errstr(err));
 215                 ucom->sc_dying = 1;
 216                 goto error;
 217         }
 218
 219         id = usbd_get_interface_descriptor(ucom->sc_iface);
 220         sc->sc_iface_number = id->bInterfaceNumber;
 221
 222         for (i = 0; i < id->bNumEndpoints; i++) {
 223                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 224                 if (ed == NULL) {
 225                         device_printf(ucom->sc_dev, "no endpoint descriptor "
 226                                       "for %d\n", i);
 227                         ucom->sc_dying = 1;
 228                         goto error;
 229                 }
 230
 231                 /*
 232                  * The real bulk-in endpoint is also marked as an interrupt.
 233                  * The only way to differentiate it from the real interrupt
 234                  * endpoint is to look at the wMaxPacketSize field.
 235                  */
 236                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN) {
 237                         if (UGETW(ed->wMaxPacketSize) == 0x2) {
 238                                 sc->sc_intr_number = ed->bEndpointAddress;
 239                                 sc->sc_isize = UGETW(ed->wMaxPacketSize);
 240                         } else {
 241                                 ucom->sc_bulkin_no = ed->bEndpointAddress;
 242                                 ucom->sc_ibufsize = UGETW(ed->wMaxPacketSize);
 243                         }
 244                         continue;
 245                 }
 246
 247                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT) {
 248                         ucom->sc_bulkout_no = ed->bEndpointAddress;
 249                         if (uaa->product == USB_PRODUCT_MCT_SITECOM_USB232)
 250                                 ucom->sc_obufsize = 16; /* device is broken */
 251                         else
 252                                 ucom->sc_obufsize = UGETW(ed->wMaxPacketSize);
 253                         continue;
 254                 }
 255
 256                 device_printf(ucom->sc_dev, "warning - unsupported endpoint "
 257                               "0x%x\n", ed->bEndpointAddress);
 258         }
 259
 260         if (sc->sc_intr_number == -1) {
 261                 device_printf(ucom->sc_dev, "could not find interrupt in\n");
 262                 ucom->sc_dying = 1;
 263                 goto error;
 264         }
 265
 266         sc->sc_intr_iface = ucom->sc_iface;
 267
 268         if (ucom->sc_bulkout_no == -1) {
 269                 device_printf(ucom->sc_dev, "rould not find data bulk out\n");
 270                 ucom->sc_dying = 1;
 271                 goto error;
 272         }
 273
 274         ucom->sc_parent = sc;
 275         ucom->sc_portno = UCOM_UNK_PORTNO;
 276         ucom->sc_opkthdrlen = 0;
 277         ucom->sc_callback = &umct_callback;
 278         TASK_INIT(&sc->sc_task, 0, umct_notify, sc);
 279         ucom_attach(ucom);
 280
 281         kfree(devinfo, M_USBDEV);
 282         return 0;
 283
 284 error:
 285         kfree(devinfo, M_USBDEV);
 286         return ENXIO;
 287 }
 288
 289 static int
 290 umct_detach(device_t self)
 291 {
 292         struct umct_softc *sc = device_get_softc(self);
 293         int rv;
 294
 295         if (sc->sc_intr_pipe != NULL) {
 296                 usbd_abort_pipe(sc->sc_intr_pipe);
 297                 usbd_close_pipe(sc->sc_intr_pipe);
 298                 kfree(sc->sc_intr_buf, M_USBDEV);
 299                 sc->sc_intr_pipe = NULL;
 300         }
 301
 302         sc->sc_ucom.sc_dying = 1;
 303         rv = ucom_detach(&sc->sc_ucom);
 304         return (rv);
 305 }
 306
 307 static int
 308 umct_request(struct umct_softc *sc, uint8_t request, int len, uint32_t value)
 309 {
 310         usb_device_request_t req;
 311         usbd_status err;
 312         uint8_t oval[4];
 313
 314         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 315         req.bRequest = request;
 316         USETW(req.wValue, 0);
 317         USETW(req.wIndex, sc->sc_iface_number);
 318         USETW(req.wLength, len);
 319         USETDW(oval, value);
 320
 321         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, oval);
 322         if (err)
 323                 device_printf(sc->sc_ucom.sc_dev, "ubsa_request: %s\n",
 324                               usbd_errstr(err));
 325         return (err);
 326 }
 327
 328 static void
 329 umct_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 330 {
 331         struct umct_softc *sc;
 332         u_char *buf;
 333
 334         sc = (struct umct_softc *)priv;
 335         buf = sc->sc_intr_buf;
 336         if (sc->sc_ucom.sc_dying)
 337                 return;
 338
 339         if (status != USBD_NORMAL_COMPLETION) {
 340                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
 341                         return;
 342
 343                 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
 344                 return;
 345         }
 346
 347         sc->sc_msr = buf[0];
 348         sc->sc_lsr = buf[1];
 349
 350         /*
 351          * Defer notifying the ucom layer as it doesn't like to be bothered
 352          * from an interrupt context.
 353          */
 354         taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
 355 }
 356
 357 static void
 358 umct_notify(void *arg, int count)
 359 {
 360         struct umct_softc *sc;
 361
 362         sc = (struct umct_softc *)arg;
 363         if (sc->sc_ucom.sc_dying == 0)
 364                 ucom_status_change(&sc->sc_ucom);
 365 }
 366
 367 static void
 368 umct_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
 369 {
 370         struct umct_softc *sc;
 371
 372         sc = addr;
 373         if (lsr != NULL)
 374                 *lsr = sc->sc_lsr;
 375         if (msr != NULL)
 376                 *msr = sc->sc_msr;
 377
 378         return;
 379 }
 380
 381 static void
 382 umct_set(void *addr, int portno, int reg, int onoff)
 383 {
 384         struct umct_softc *sc;
 385
 386         sc = addr;
 387         switch (reg) {
 388         case UCOM_SET_BREAK:
 389                 sc->sc_lcr &= ~0x40;
 390                 sc->sc_lcr |= (onoff) ? 0x40 : 0;
 391                 umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, sc->sc_lcr);
 392                 break;
 393         case UCOM_SET_DTR:
 394                 sc->sc_mcr &= ~0x01;
 395                 sc->sc_mcr |= (onoff) ? 0x01 : 0;
 396                 umct_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
 397                 break;
 398         case UCOM_SET_RTS:
 399                 sc->sc_mcr &= ~0x2;
 400                 sc->sc_mcr |= (onoff) ? 0x02 : 0;
 401                 umct_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr);
 402                 break;
 403         default:
 404                 break;
 405         }
 406 }
 407
 408 static int
 409 umct_calc_baud(u_int baud)
 410 {
 411         switch(baud) {
 412         case B300: return (0x1);
 413         case B600: return (0x2);
 414         case B1200: return (0x3);
 415         case B2400: return (0x4);
 416         case B4800: return (0x6);
 417         case B9600: return (0x8);
 418         case B19200: return (0x9);
 419         case B38400: return (0xa);
 420         case B57600: return (0xb);
 421         case B115200: return (0xc);
 422         case B0:
 423         default:
 424                 break;
 425         }
 426
 427         return (0x0);
 428 }
 429
 430 static int
 431 umct_param(void *addr, int portno, struct termios *ti)
 432 {
 433         struct umct_softc *sc;
 434         uint32_t value;
 435
 436         sc = addr;
 437         value = umct_calc_baud(ti->c_ospeed);
 438         umct_request(sc, UMCT_SET_BAUD, UMCT_SET_BAUD_SIZE, value);
 439         umct_request(sc, UMCT_SET_UNKNOWN1, UMCT_SET_UNKNOWN1_SIZE, 0);
 440         umct_request(sc, UMCT_SET_UNKNOWN2, UMCT_SET_UNKNOWN2_SIZE, 0);
 441
 442         value = sc->sc_lcr & 0x40;
 443
 444         switch (ti->c_cflag & CSIZE) {
 445         case CS5: value |= 0x0; break;
 446         case CS6: value |= 0x1; break;
 447         case CS7: value |= 0x2; break;
 448         case CS8: value |= 0x3; break;
 449         default: value |= 0x0; break;
 450         }
 451
 452         value |= (ti->c_cflag & CSTOPB) ? 0x4 : 0;
 453         if (ti->c_cflag & PARENB) {
 454                 value |= 0x8;
 455                 value |= (ti->c_cflag & PARODD) ? 0x0 : 0x10;
 456         }
 457
 458         /*
 459          * XXX There doesn't seem to be a way to tell the device to use flow
 460          * control.
 461          */
 462
 463         sc->sc_lcr = value;
 464         umct_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, value);
 465
 466         return (0);
 467 }
 468
 469 static int
 470 umct_open(void *addr, int portno)
 471 {
 472         struct umct_softc *sc;
 473         int err;
 474
 475         sc = addr;
 476         if (sc->sc_ucom.sc_dying) {
 477                 return (ENXIO);
 478         }
 479
 480         if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
 481                 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
 482                 err = usbd_open_pipe_intr(sc->sc_intr_iface, sc->sc_intr_number,
 483                     USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buf,
 484                     sc->sc_isize, umct_intr, UMCT_INTR_INTERVAL);
 485                 if (err) {
 486                         device_printf(sc->sc_ucom.sc_dev, "cannot open "
 487                                       "interrupt pipe (addr %d)\n",
 488                                       sc->sc_intr_number);
 489                         kfree(sc->sc_intr_buf, M_USBDEV);
 490                         return (EIO);
 491                 }
 492         }
 493
 494         return (0);
 495 }
 496
 497 static void
 498 umct_close(void *addr, int portno)
 499 {
 500         struct umct_softc *sc;
 501         int err;
 502
 503         sc = addr;
 504         if (sc->sc_ucom.sc_dying)
 505                 return;
 506
 507         if (sc->sc_intr_pipe != NULL) {
 508                 err = usbd_abort_pipe(sc->sc_intr_pipe);
 509                 if (err)
 510                         device_printf(sc->sc_ucom.sc_dev, "abort interrupt "
 511                                       "pipe failed: %s\n", usbd_errstr(err));
 512                 err = usbd_close_pipe(sc->sc_intr_pipe);
 513                 if (err)
 514                         device_printf(sc->sc_ucom.sc_dev, "close interrupt "
 515                                       "pipe failed: %s\n", usbd_errstr(err));
 516                 kfree(sc->sc_intr_buf, M_USBDEV);
 517                 sc->sc_intr_pipe = NULL;
 518         }
 519 }