sys/dev/usbmisc/uplcom/uplcom.c

   1 /*
   2  * $NetBSD: uplcom.c,v 1.21 2001/11/13 06:24:56 lukem Exp $
   3  * $FreeBSD: src/sys/dev/usb/uplcom.c,v 1.39 2006/09/07 00:06:42 imp Exp $
   4  * $DragonFly: src/sys/dev/usbmisc/uplcom/uplcom.c,v 1.22 2007/08/19 17:16:43 hasso Exp $
   5  */
   6
   7 /*-
   8  * Copyright (c) 2001-2003, 2005 Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * Copyright (c) 2001 The NetBSD Foundation, Inc.
  35  * All rights reserved.
  36  *
  37  * This code is derived from software contributed to The NetBSD Foundation
  38  * by Ichiro FUKUHARA (ichiro@ichiro.org).
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice, this list of conditions and the following disclaimer.
  45  * 2. Redistributions in binary form must reproduce the above copyright
  46  *    notice, this list of conditions and the following disclaimer in the
  47  *    documentation and/or other materials provided with the distribution.
  48  * 3. All advertising materials mentioning features or use of this software
  49  *    must display the following acknowledgement:
  50  *        This product includes software developed by the NetBSD
  51  *        Foundation, Inc. and its contributors.
  52  * 4. Neither the name of The NetBSD Foundation nor the names of its
  53  *    contributors may be used to endorse or promote products derived
  54  *    from this software without specific prior written permission.
  55  *
  56  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  57  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  58  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  59  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  60  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  61  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  62  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  63  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  64  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  65  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  66  * POSSIBILITY OF SUCH DAMAGE.
  67  */
  68
  69 /*
  70  * This driver supports several devices devices driven by Prolific PL-2303
  71  * (known also as PL-2303H), PL-2303X and PL-2303HX USB-to-RS232 bridge chip.
  72  * The devices are sold under many different brand names.
  73  *
  74  * Datasheets are available at Prolific www site at http://www.prolific.com.tw
  75  * The datasheets don't contain full programming information for the chip.
  76  *
  77  * PL-2303HX has the same features as PL-2303X (at least from the point of
  78  * view of device driver) but is pin-to-pin compatible with PL-2303.
  79  *
  80  * There are several differences between PL-2303 and PL-2303(H)X.
  81  * PL-2303(H)X can do higher bitrate in bulk mode, has _probably_
  82  * different command for controlling CRTSCTS and needs special
  83  * sequence of commands for initialization which aren't also
  84  * documented in the datasheet.
  85  */
  86
  87 #include <sys/param.h>
  88 #include <sys/systm.h>
  89 #include <sys/kernel.h>
  90 #include <sys/malloc.h>
  91 #include <sys/bus.h>
  92 #include <sys/ioccom.h>
  93 #include <sys/fcntl.h>
  94 #include <sys/conf.h>
  95 #include <sys/tty.h>
  96 #include <sys/file.h>
  97 #include <sys/select.h>
  98 #include <sys/proc.h>
  99 #include <sys/poll.h>
 100 #include <sys/sysctl.h>
 101 #include <sys/taskqueue.h>
 102
 103 #include <bus/usb/usb.h>
 104 #include <bus/usb/usbcdc.h>
 105
 106 #include <bus/usb/usbdi.h>
 107 #include <bus/usb/usbdi_util.h>
 108 #include <bus/usb/usbdevs.h>
 109 #include <bus/usb/usb_quirks.h>
 110
 111 #include "../ucom/ucomvar.h"
 112
 113 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
 114 #ifdef USB_DEBUG
 115 static int      uplcomdebug = 0;
 116 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW,
 117            &uplcomdebug, 0, "uplcom debug level");
 118
 119 #define DPRINTFN(n, x)  do { \
 120                                 if (uplcomdebug > (n)) \
 121                                         kprintf x; \
 122                         } while (0)
 123 #else
 124 #define DPRINTFN(n, x)
 125 #endif
 126 #define DPRINTF(x) DPRINTFN(0, x)
 127
 128 #define UPLCOM_MODVER                   1       /* module version */
 129
 130 #define UPLCOM_CONFIG_INDEX             0
 131 #define UPLCOM_IFACE_INDEX              0
 132 #define UPLCOM_SECOND_IFACE_INDEX       1
 133
 134 #ifndef UPLCOM_INTR_INTERVAL
 135 #define UPLCOM_INTR_INTERVAL            100     /* ms */
 136 #endif
 137
 138 #define UPLCOM_SET_REQUEST              0x01
 139 #define UPLCOM_SET_CRTSCTS              0x41
 140 #define UPLCOM_SET_CRTSCTS_PL2303X      0x61
 141 #define RSAQ_STATUS_CTS                 0x80
 142 #define RSAQ_STATUS_DSR                 0x02
 143 #define RSAQ_STATUS_DCD                 0x01
 144
 145 #define TYPE_PL2303                     0
 146 #define TYPE_PL2303X                    1
 147
 148 struct  uplcom_softc {
 149         struct ucom_softc       sc_ucom;
 150
 151         int                     sc_iface_number;        /* interface number */
 152
 153         usbd_interface_handle   sc_intr_iface;  /* interrupt interface */
 154         int                     sc_intr_number; /* interrupt number */
 155         usbd_pipe_handle        sc_intr_pipe;   /* interrupt pipe */
 156         u_char                  *sc_intr_buf;   /* interrupt buffer */
 157         int                     sc_isize;
 158
 159         usb_cdc_line_state_t    sc_line_state;  /* current line state */
 160         u_char                  sc_dtr;         /* current DTR state */
 161         u_char                  sc_rts;         /* current RTS state */
 162         u_char                  sc_status;
 163
 164         u_char                  sc_lsr;         /* Local status register */
 165         u_char                  sc_msr;         /* uplcom status register */
 166
 167         int                     sc_chiptype;    /* Type of chip */
 168
 169         struct task             sc_task;
 170 };
 171
 172 /*
 173  * These are the maximum number of bytes transferred per frame.
 174  * The output buffer size cannot be increased due to the size encoding.
 175  */
 176 #define UPLCOMIBUFSIZE 256
 177 #define UPLCOMOBUFSIZE 256
 178
 179 static  usbd_status uplcom_reset(struct uplcom_softc *);
 180 static  usbd_status uplcom_set_line_coding(struct uplcom_softc *,
 181                                            usb_cdc_line_state_t *);
 182 static  usbd_status uplcom_set_crtscts(struct uplcom_softc *);
 183 static  void uplcom_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
 184
 185 static  void uplcom_set(void *, int, int, int);
 186 static  void uplcom_dtr(struct uplcom_softc *, int);
 187 static  void uplcom_rts(struct uplcom_softc *, int);
 188 static  void uplcom_break(struct uplcom_softc *, int);
 189 static  void uplcom_set_line_state(struct uplcom_softc *);
 190 static  void uplcom_get_status(void *, int, u_char *, u_char *);
 191 #if 0 /* TODO */
 192 static  int  uplcom_ioctl(void *, int, u_long, caddr_t, int, struct thread *);
 193 #endif
 194 static  int  uplcom_param(void *, int, struct termios *);
 195 static  int  uplcom_open(void *, int);
 196 static  void uplcom_close(void *, int);
 197 static  void uplcom_notify(void *, int);
 198
 199 struct ucom_callback uplcom_callback = {
 200         uplcom_get_status,
 201         uplcom_set,
 202         uplcom_param,
 203         NULL, /* uplcom_ioctl, TODO */
 204         uplcom_open,
 205         uplcom_close,
 206         NULL,
 207         NULL
 208 };
 209
 210 static const struct usb_devno uplcom_devs[] = {
 211         /* Alcatel One Touch 535/735 phones */
 212         { USB_VENDOR_ALCATEL, USB_PRODUCT_ALCATEL_OT535 },
 213         /* Alcor AU9720 USB to serial controller */
 214         { USB_VENDOR_ALCOR, USB_PRODUCT_ALCOR_AU9720 },
 215         /* Anchor serial */
 216         { USB_VENDOR_ANCHOR, USB_PRODUCT_ANCHOR_SERIAL },
 217         /* Aten UC232A USB to serial adapter */
 218         { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC232A },
 219         /* Belkin F5U257 USB to serial adapter */
 220         { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U257 },
 221         /* ELECOM UC-SGT USB to serial adapters */
 222         { USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_UCSGT },
 223         { USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_UCSGT0 },
 224         /* HAL Corporation Crossam2+USB */
 225         { USB_VENDOR_HAL, USB_PRODUCT_HAL_IMR001 },
 226         /* Huawei UMTS/HSDPA adapters */
 227         { USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_MOBILE },
 228         /* I/O DATA USB-RSAQ USB to serial cable */
 229         { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBRSAQ },
 230         /* I/O DATA USB-RSAQ5 USB to serial cable */
 231         { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBRSAQ5 },
 232         /* Itegno GSM/GPRS modem */
 233         { USB_VENDOR_ITEGNO, USB_PRODUCT_ITEGNO_GSM },
 234         /* Itegno CDMA 1x card */
 235         { USB_VENDOR_ITEGNO, USB_PRODUCT_ITEGNO_CDMA },
 236         /* Leadtek 9531 GPS */
 237         { USB_VENDOR_LEADTEK, USB_PRODUCT_LEADTEK_9531 },
 238         /* Mobile Action MA-620 IrDA */
 239         { USB_VENDOR_MOBILEACTION, USB_PRODUCT_MOBILEACTION_MA620 },
 240         /* Willcom W-SIM */
 241         { USB_VENDOR_NETINDEX, USB_PRODUCT_NETINDEX_WSIM },
 242         /* Nokia CA-42 USB data cable clones*/
 243         { USB_VENDOR_NOKIA, USB_PRODUCT_NOKIA_CA42 },
 244         /* Panasonic 50" touch panel */
 245         { USB_VENDOR_PANASONIC, USB_PRODUCT_PANASONIC_TYTP50P6S },
 246         /* PLX CA-42 USB data cable clone */
 247         { USB_VENDOR_PLX, USB_PRODUCT_PLX_CA42 },
 248         /* Unbranded DCU-11 clone */
 249         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_DCU11 },
 250         /* IOGEAR/ATEN UC-232A, ST Lab USB-SERIAL-X etc */
 251         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303 },
 252         /* Microsoft OEM Pharos 360 GPS */
 253         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303X },
 254         /* I/O DATA USB-RSAQ2 USB to serial cable */
 255         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_RSAQ2 },
 256         /* I/O DATA USB-RSAQ3 USB to serial cable */
 257         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_RSAQ3 },
 258         /* RADIOSHACK USB cable */
 259         { USB_VENDOR_RADIOSHACK, USB_PRODUCT_RADIOSHACK_USBCABLE },
 260         /* RATOC REX-USB60 USB to serial cable */
 261         { USB_VENDOR_RATOC, USB_PRODUCT_RATOC_REXUSB60 },
 262         /* Sagem USB data cables */
 263         { USB_VENDOR_SAGEM, USB_PRODUCT_SAGEM_USBSERIAL },
 264         /* Samsung I330 smartphone cradle */
 265         { USB_VENDOR_SAMSUNG, USB_PRODUCT_SAMSUNG_I330 },
 266         /* Siemens SX1 cellphone */
 267         { USB_VENDOR_SIEMENS3, USB_PRODUCT_SIEMENS3_SX1 },
 268         /* Siemens x65 series cellphones */
 269         { USB_VENDOR_SIEMENS3, USB_PRODUCT_SIEMENS3_X65 },
 270         /* Siemens x75 series cellphones */
 271         { USB_VENDOR_SIEMENS3, USB_PRODUCT_SIEMENS3_X75 },
 272         /* Sitecom USB to serial cable */
 273         { USB_VENDOR_SITECOM, USB_PRODUCT_SITECOM_CN104 },
 274         /* Smart Technologies USB to serial adapter */
 275         { USB_VENDOR_SMART, USB_PRODUCT_SMART_PL2303 },
 276         /* Sony-Ericsson DCU-10 and DCU-11 USB data cables */
 277         { USB_VENDOR_SUSTEEN, USB_PRODUCT_SUSTEEN_DCU10 },
 278         /* Susteen Datapilot Universal-2 Phone Cable */
 279         { USB_VENDOR_SUSTEEN, USB_PRODUCT_SUSTEEN_U2 },
 280         /* SOURCENEXT KeikaiDenwa 8 */
 281         { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8 },
 282         /* SOURCENEXT KeikaiDenwa 8 with charger */
 283         { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8_CHG },
 284         /* Speed Dragon Multimedia MS3303H USB to serial controller */
 285         { USB_VENDOR_SPEEDDRAGON, USB_PRODUCT_SPEEDDRAGON_MS3303H },
 286         /* Syntech CPT-8001C barcode scanner USB IR cradle */
 287         { USB_VENDOR_SYNTECH, USB_PRODUCT_SYNTECH_SERIAL },
 288         /* TDK USB-PHS adapter UHA6400 */
 289         { USB_VENDOR_TDK, USB_PRODUCT_TDK_UHA6400 },
 290         /* TDK USB-PDC adapter UPA9664 */
 291         { USB_VENDOR_TDK, USB_PRODUCT_TDK_UPA9664 },
 292         /* Tripp-Lite U209-000-R USB to serial cable */
 293         { USB_VENDOR_TRIPPLITE, USB_PRODUCT_TRIPPLITE_U209 },
 294         { 0, 0 }
 295 };
 296
 297 static device_probe_t uplcom_match;
 298 static device_attach_t uplcom_attach;
 299 static device_detach_t uplcom_detach;
 300
 301 static device_method_t uplcom_methods[] = {
 302         /* Device interface */
 303         DEVMETHOD(device_probe, uplcom_match),
 304         DEVMETHOD(device_attach, uplcom_attach),
 305         DEVMETHOD(device_detach, uplcom_detach),
 306         { 0, 0 }
 307 };
 308
 309 static driver_t uplcom_driver = {
 310         "ucom",
 311         uplcom_methods,
 312         sizeof (struct uplcom_softc)
 313 };
 314
 315 DRIVER_MODULE(uplcom, uhub, uplcom_driver, ucom_devclass, usbd_driver_load, 0);
 316 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
 317 MODULE_DEPEND(uplcom, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
 318 MODULE_VERSION(uplcom, UPLCOM_MODVER);
 319
 320 static int      uplcominterval = UPLCOM_INTR_INTERVAL;
 321
 322 static int
 323 sysctl_hw_usb_uplcom_interval(SYSCTL_HANDLER_ARGS)
 324 {
 325         int err, val;
 326
 327         val = uplcominterval;
 328         err = sysctl_handle_int(oidp, &val, sizeof(val), req);
 329         if (err != 0 || req->newptr == NULL)
 330                 return (err);
 331         if (0 < val && val <= 1000)
 332                 uplcominterval = val;
 333         else
 334                 err = EINVAL;
 335
 336         return (err);
 337 }
 338
 339 SYSCTL_PROC(_hw_usb_uplcom, OID_AUTO, interval, CTLTYPE_INT | CTLFLAG_RW,
 340             0, sizeof(int), sysctl_hw_usb_uplcom_interval,
 341             "I", "uplcom interrupt pipe interval");
 342
 343 static int
 344 uplcom_match(device_t self)
 345 {
 346         struct usb_attach_arg *uaa = device_get_ivars(self);
 347
 348         if (uaa->iface != NULL)
 349                 return (UMATCH_NONE);
 350
 351         return (usb_lookup(uplcom_devs, uaa->vendor, uaa->product) != NULL ?
 352                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
 353 }
 354
 355 static int
 356 uplcom_attach(device_t self)
 357 {
 358         struct uplcom_softc *sc = device_get_softc(self);
 359         struct usb_attach_arg *uaa = device_get_ivars(self);
 360         usbd_device_handle dev = uaa->device;
 361         usb_device_descriptor_t *dd;
 362         struct ucom_softc *ucom;
 363         usb_config_descriptor_t *cdesc;
 364         usb_interface_descriptor_t *id;
 365         usb_endpoint_descriptor_t *ed;
 366         char *devinfo;
 367         usbd_status err;
 368         int i;
 369
 370         devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT);
 371         ucom = &sc->sc_ucom;
 372
 373         bzero(sc, sizeof (struct uplcom_softc));
 374
 375         usbd_devinfo(dev, 0, devinfo);
 376         ucom->sc_dev = self;
 377         device_set_desc_copy(self, devinfo);
 378
 379         ucom->sc_udev = dev;
 380         ucom->sc_iface = uaa->iface;
 381
 382         device_printf(ucom->sc_dev, "%s\n", devinfo);
 383
 384         DPRINTF(("uplcom attach: sc = %p\n", sc));
 385
 386         dd = usbd_get_device_descriptor(uaa->device);
 387
 388         if (!dd)
 389                 goto error;
 390
 391         /*
 392          * Determine chip type with algorithm sequence taken from the
 393          * Linux driver as I'm not aware of any better method. Device
 394          * release number in chip could be (and in fact is in many cases)
 395          * replaced by the contents of external EEPROM etc.
 396          */
 397         else if (dd->bDeviceClass == 0x02)
 398                 sc->sc_chiptype = TYPE_PL2303;
 399         else if (dd->bMaxPacketSize == 0x40)
 400                 sc->sc_chiptype = TYPE_PL2303X;
 401         else
 402                 sc->sc_chiptype = TYPE_PL2303;
 403
 404 #ifdef USB_DEBUG
 405         /* print the chip type */
 406         if (sc->sc_chiptype == TYPE_PL2303X) {
 407                 DPRINTF(("uplcom_attach: chiptype 2303X\n"));
 408         } else {
 409                 DPRINTF(("uplcom_attach: chiptype 2303\n"));
 410         }
 411 #endif
 412
 413         /* initialize endpoints */
 414         ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
 415         sc->sc_intr_number = -1;
 416         sc->sc_intr_pipe = NULL;
 417
 418         /* Move the device into the configured state. */
 419         err = usbd_set_config_index(dev, UPLCOM_CONFIG_INDEX, 1);
 420         if (err) {
 421                 device_printf(ucom->sc_dev, "failed to set configuration: %s\n",
 422                               usbd_errstr(err));
 423                 ucom->sc_dying = 1;
 424                 goto error;
 425         }
 426
 427         /* get the config descriptor */
 428         cdesc = usbd_get_config_descriptor(ucom->sc_udev);
 429
 430         if (cdesc == NULL) {
 431                 device_printf(ucom->sc_dev, "failed to get configuration "
 432                               "descriptor\n");
 433                 ucom->sc_dying = 1;
 434                 goto error;
 435         }
 436
 437         /* get the (first/common) interface */
 438         err = usbd_device2interface_handle(dev, UPLCOM_IFACE_INDEX,
 439                                            &ucom->sc_iface);
 440         if (err) {
 441                 device_printf(ucom->sc_dev, "failed to get interface: %s\n",
 442                               usbd_errstr(err));
 443                 ucom->sc_dying = 1;
 444                 goto error;
 445         }
 446
 447         /* Find the interrupt endpoints */
 448
 449         id = usbd_get_interface_descriptor(ucom->sc_iface);
 450         sc->sc_iface_number = id->bInterfaceNumber;
 451
 452         for (i = 0; i < id->bNumEndpoints; i++) {
 453                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 454                 if (ed == NULL) {
 455                         device_printf(ucom->sc_dev, "no endpoint descriptor "
 456                                       "for %d\n", i);
 457                         ucom->sc_dying = 1;
 458                         goto error;
 459                 }
 460
 461                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 462                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
 463                         sc->sc_intr_number = ed->bEndpointAddress;
 464                         sc->sc_isize = UGETW(ed->wMaxPacketSize);
 465                 }
 466         }
 467
 468         if (sc->sc_intr_number == -1) {
 469                 device_printf(ucom->sc_dev, "could not find interrupt in\n");
 470                 ucom->sc_dying = 1;
 471                 goto error;
 472         }
 473
 474         /* keep interface for interrupt */
 475         sc->sc_intr_iface = ucom->sc_iface;
 476
 477         /*
 478          * USB-RSAQ1 has two interface
 479          *
 480          *  USB-RSAQ1       | USB-RSAQ2
 481          * -----------------+-----------------
 482          * Interface 0      |Interface 0
 483          *  Interrupt(0x81) | Interrupt(0x81)
 484          * -----------------+ BulkIN(0x02)
 485          * Interface 1      | BulkOUT(0x83)
 486          *   BulkIN(0x02)   |
 487          *   BulkOUT(0x83)  |
 488          */
 489         if (cdesc->bNumInterface == 2) {
 490                 err = usbd_device2interface_handle(dev,
 491                                                    UPLCOM_SECOND_IFACE_INDEX,
 492                                                    &ucom->sc_iface);
 493                 if (err) {
 494                         device_printf(ucom->sc_dev, "failed to get second "
 495                                       "interface: %s\n", usbd_errstr(err));
 496                         ucom->sc_dying = 1;
 497                         goto error;
 498                 }
 499         }
 500
 501         /* Find the bulk{in,out} endpoints */
 502
 503         id = usbd_get_interface_descriptor(ucom->sc_iface);
 504         sc->sc_iface_number = id->bInterfaceNumber;
 505
 506         for (i = 0; i < id->bNumEndpoints; i++) {
 507                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 508                 if (ed == NULL) {
 509                         device_printf(ucom->sc_dev, "no endpoint descriptor "
 510                                       "for %d\n", i);
 511                         ucom->sc_dying = 1;
 512                         goto error;
 513                 }
 514
 515                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 516                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 517                         ucom->sc_bulkin_no = ed->bEndpointAddress;
 518                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
 519                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 520                         ucom->sc_bulkout_no = ed->bEndpointAddress;
 521                 }
 522         }
 523
 524         if (ucom->sc_bulkin_no == -1) {
 525                 device_printf(ucom->sc_dev, "could not find data bulk in\n");
 526                 ucom->sc_dying = 1;
 527                 goto error;
 528         }
 529
 530         if (ucom->sc_bulkout_no == -1) {
 531                 device_printf(ucom->sc_dev, "could not find data bulk out\n");
 532                 ucom->sc_dying = 1;
 533                 goto error;
 534         }
 535
 536         sc->sc_dtr = sc->sc_rts = -1;
 537         ucom->sc_parent = sc;
 538         ucom->sc_portno = UCOM_UNK_PORTNO;
 539         /* bulkin, bulkout set above */
 540         ucom->sc_ibufsize = UPLCOMIBUFSIZE;
 541         ucom->sc_obufsize = UPLCOMOBUFSIZE;
 542         ucom->sc_ibufsizepad = UPLCOMIBUFSIZE;
 543         ucom->sc_opkthdrlen = 0;
 544         ucom->sc_callback = &uplcom_callback;
 545
 546         err = uplcom_reset(sc);
 547
 548         if (err) {
 549                 device_printf(ucom->sc_dev, "reset failed: %s\n",
 550                               usbd_errstr(err));
 551                 ucom->sc_dying = 1;
 552                 goto error;
 553         }
 554
 555         DPRINTF(("uplcom: in = 0x%x, out = 0x%x, intr = 0x%x\n",
 556                  ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
 557
 558         TASK_INIT(&sc->sc_task, 0, uplcom_notify, sc);
 559         ucom_attach(&sc->sc_ucom);
 560
 561         kfree(devinfo, M_USBDEV);
 562         return 0;
 563
 564 error:
 565         kfree(devinfo, M_USBDEV);
 566         return ENXIO;
 567 }
 568
 569 static int
 570 uplcom_detach(device_t self)
 571 {
 572         struct uplcom_softc *sc = device_get_softc(self);
 573         int rv = 0;
 574
 575         DPRINTF(("uplcom_detach: sc = %p\n", sc));
 576
 577         if (sc->sc_intr_pipe != NULL) {
 578                 usbd_abort_pipe(sc->sc_intr_pipe);
 579                 usbd_close_pipe(sc->sc_intr_pipe);
 580                 kfree(sc->sc_intr_buf, M_USBDEV);
 581                 sc->sc_intr_pipe = NULL;
 582         }
 583
 584         sc->sc_ucom.sc_dying = 1;
 585
 586         rv = ucom_detach(&sc->sc_ucom);
 587
 588         return (rv);
 589 }
 590
 591 static usbd_status
 592 uplcom_reset(struct uplcom_softc *sc)
 593 {
 594         usb_device_request_t req;
 595         usbd_status err;
 596
 597         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 598         req.bRequest = UPLCOM_SET_REQUEST;
 599         USETW(req.wValue, 0);
 600         USETW(req.wIndex, sc->sc_iface_number);
 601         USETW(req.wLength, 0);
 602
 603         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 604         if (err) {
 605                 device_printf(sc->sc_ucom.sc_dev, "uplcom_reset: %s\n",
 606                               usbd_errstr(err));
 607                 return (EIO);
 608         }
 609
 610         return (0);
 611 }
 612
 613 struct pl2303x_init {
 614         uint8_t         req_type;
 615         uint8_t         request;
 616         uint16_t        value;
 617         uint16_t        index;
 618         uint16_t        length;
 619 };
 620
 621 static const struct pl2303x_init pl2303x[] = {
 622         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 623         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404,    0, 0 },
 624         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 625         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8383,    0, 0 },
 626         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 627         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404,    1, 0 },
 628         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 629         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8383,    0, 0 },
 630         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      0,    1, 0 },
 631         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      1,    0, 0 },
 632         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      2, 0x44, 0 }
 633 };
 634 #define N_PL2302X_INIT  (sizeof(pl2303x)/sizeof(pl2303x[0]))
 635
 636 static usbd_status
 637 uplcom_pl2303x_init(struct uplcom_softc *sc)
 638 {
 639         usb_device_request_t req;
 640         usbd_status err;
 641         int i;
 642
 643         for (i = 0; i < N_PL2302X_INIT; i++) {
 644                 req.bmRequestType = pl2303x[i].req_type;
 645                 req.bRequest = pl2303x[i].request;
 646                 USETW(req.wValue, pl2303x[i].value);
 647                 USETW(req.wIndex, pl2303x[i].index);
 648                 USETW(req.wLength, pl2303x[i].length);
 649
 650                 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 651                 if (err) {
 652                         device_printf(sc->sc_ucom.sc_dev,
 653                                       "uplcom_pl2303x_init: %d: %s\n", i,
 654                                       usbd_errstr(err));
 655                         return (EIO);
 656                 }
 657         }
 658
 659         return (0);
 660 }
 661
 662 static void
 663 uplcom_set_line_state(struct uplcom_softc *sc)
 664 {
 665         usb_device_request_t req;
 666         int ls;
 667         usbd_status err;
 668
 669         ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
 670                 (sc->sc_rts ? UCDC_LINE_RTS : 0);
 671         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 672         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 673         USETW(req.wValue, ls);
 674         USETW(req.wIndex, sc->sc_iface_number);
 675         USETW(req.wLength, 0);
 676
 677         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 678         if (err)
 679                 device_printf(sc->sc_ucom.sc_dev, "uplcom_set_line_status: "
 680                               "%s\n", usbd_errstr(err));
 681 }
 682
 683 static void
 684 uplcom_set(void *addr, int portno, int reg, int onoff)
 685 {
 686         struct uplcom_softc *sc = addr;
 687
 688         switch (reg) {
 689         case UCOM_SET_DTR:
 690                 uplcom_dtr(sc, onoff);
 691                 break;
 692         case UCOM_SET_RTS:
 693                 uplcom_rts(sc, onoff);
 694                 break;
 695         case UCOM_SET_BREAK:
 696                 uplcom_break(sc, onoff);
 697                 break;
 698         default:
 699                 break;
 700         }
 701 }
 702
 703 static void
 704 uplcom_dtr(struct uplcom_softc *sc, int onoff)
 705 {
 706         DPRINTF(("uplcom_dtr: onoff = %d\n", onoff));
 707
 708         if (sc->sc_dtr == onoff)
 709                 return;
 710         sc->sc_dtr = onoff;
 711
 712         uplcom_set_line_state(sc);
 713 }
 714
 715 static void
 716 uplcom_rts(struct uplcom_softc *sc, int onoff)
 717 {
 718         DPRINTF(("uplcom_rts: onoff = %d\n", onoff));
 719
 720         if (sc->sc_rts == onoff)
 721                 return;
 722         sc->sc_rts = onoff;
 723
 724         uplcom_set_line_state(sc);
 725 }
 726
 727 static void
 728 uplcom_break(struct uplcom_softc *sc, int onoff)
 729 {
 730         usb_device_request_t req;
 731         usbd_status err;
 732
 733         DPRINTF(("uplcom_break: onoff = %d\n", onoff));
 734
 735         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 736         req.bRequest = UCDC_SEND_BREAK;
 737         USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
 738         USETW(req.wIndex, sc->sc_iface_number);
 739         USETW(req.wLength, 0);
 740
 741         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 742         if (err)
 743                 device_printf(sc->sc_ucom.sc_dev, "uplcom_break: %s\n",
 744                               usbd_errstr(err));
 745 }
 746
 747 static usbd_status
 748 uplcom_set_crtscts(struct uplcom_softc *sc)
 749 {
 750         usb_device_request_t req;
 751         usbd_status err;
 752
 753         DPRINTF(("uplcom_set_crtscts: on\n"));
 754
 755         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 756         req.bRequest = UPLCOM_SET_REQUEST;
 757         USETW(req.wValue, 0);
 758         if (sc->sc_chiptype == TYPE_PL2303X)
 759                 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
 760         else
 761                 USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
 762         USETW(req.wLength, 0);
 763
 764         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 765         if (err) {
 766                 device_printf(sc->sc_ucom.sc_dev, "uplcom_set_crtscts: %s\n",
 767                               usbd_errstr(err));
 768                 return (err);
 769         }
 770
 771         return (USBD_NORMAL_COMPLETION);
 772 }
 773
 774 static usbd_status
 775 uplcom_set_line_coding(struct uplcom_softc *sc, usb_cdc_line_state_t *state)
 776 {
 777         usb_device_request_t req;
 778         usbd_status err;
 779
 780         DPRINTF((
 781 "uplcom_set_line_coding: rate = %d, fmt = %d, parity = %d bits = %d\n",
 782                  UGETDW(state->dwDTERate), state->bCharFormat,
 783                  state->bParityType, state->bDataBits));
 784
 785         if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
 786                 DPRINTF(("uplcom_set_line_coding: already set\n"));
 787                 return (USBD_NORMAL_COMPLETION);
 788         }
 789
 790         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 791         req.bRequest = UCDC_SET_LINE_CODING;
 792         USETW(req.wValue, 0);
 793         USETW(req.wIndex, sc->sc_iface_number);
 794         USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
 795
 796         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, state);
 797         if (err) {
 798                 device_printf(sc->sc_ucom.sc_dev, "uplcom_set_line_coding: "
 799                               "%s\n", usbd_errstr(err));
 800                 return (err);
 801         }
 802
 803         sc->sc_line_state = *state;
 804
 805         return (USBD_NORMAL_COMPLETION);
 806 }
 807
 808 static const int uplcom_rates[] = {
 809         75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
 810         19200, 28800, 38400, 57600, 115200,
 811         /*
 812          * Higher speeds are probably possible. PL2303X supports up to
 813          * 6Mb and can set any rate
 814          */
 815         230400, 460800, 614400, 921600, 1228800
 816 };
 817 #define N_UPLCOM_RATES  (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
 818
 819 static int
 820 uplcom_param(void *addr, int portno, struct termios *t)
 821 {
 822         struct uplcom_softc *sc = addr;
 823         usbd_status err;
 824         usb_cdc_line_state_t ls;
 825         int i;
 826
 827         DPRINTF(("uplcom_param: sc = %p\n", sc));
 828
 829         /* Check requested baud rate */
 830         for (i = 0; i < N_UPLCOM_RATES; i++)
 831                 if (uplcom_rates[i] == t->c_ospeed)
 832                         break;
 833         if (i == N_UPLCOM_RATES) {
 834                 DPRINTF(("uplcom_param: bad baud rate (%d)\n", t->c_ospeed));
 835                 return (EIO);
 836         }
 837
 838         USETDW(ls.dwDTERate, t->c_ospeed);
 839         if (ISSET(t->c_cflag, CSTOPB))
 840                 ls.bCharFormat = UCDC_STOP_BIT_2;
 841         else
 842                 ls.bCharFormat = UCDC_STOP_BIT_1;
 843         if (ISSET(t->c_cflag, PARENB)) {
 844                 if (ISSET(t->c_cflag, PARODD))
 845                         ls.bParityType = UCDC_PARITY_ODD;
 846                 else
 847                         ls.bParityType = UCDC_PARITY_EVEN;
 848         } else
 849                 ls.bParityType = UCDC_PARITY_NONE;
 850         switch (ISSET(t->c_cflag, CSIZE)) {
 851         case CS5:
 852                 ls.bDataBits = 5;
 853                 break;
 854         case CS6:
 855                 ls.bDataBits = 6;
 856                 break;
 857         case CS7:
 858                 ls.bDataBits = 7;
 859                 break;
 860         case CS8:
 861                 ls.bDataBits = 8;
 862                 break;
 863         }
 864
 865         err = uplcom_set_line_coding(sc, &ls);
 866         if (err)
 867                 return (EIO);
 868
 869         if (ISSET(t->c_cflag, CRTSCTS)) {
 870                 err = uplcom_set_crtscts(sc);
 871                 if (err)
 872                         return (EIO);
 873         }
 874
 875         return (0);
 876 }
 877
 878 static int
 879 uplcom_open(void *addr, int portno)
 880 {
 881         struct uplcom_softc *sc = addr;
 882         int err;
 883
 884         if (sc->sc_ucom.sc_dying)
 885                 return (ENXIO);
 886
 887         DPRINTF(("uplcom_open: sc = %p\n", sc));
 888
 889         if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
 890                 sc->sc_status = 0; /* clear status bit */
 891                 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
 892                 err = usbd_open_pipe_intr(sc->sc_intr_iface,
 893                                           sc->sc_intr_number,
 894                                           USBD_SHORT_XFER_OK,
 895                                           &sc->sc_intr_pipe,
 896                                           sc,
 897                                           sc->sc_intr_buf,
 898                                           sc->sc_isize,
 899                                           uplcom_intr,
 900                                           uplcominterval);
 901                 if (err) {
 902                         device_printf(sc->sc_ucom.sc_dev, "cannot open "
 903                                       "interrupt pipe (addr %d)\n",
 904                                       sc->sc_intr_number);
 905                         return (EIO);
 906                 }
 907         }
 908
 909         if (sc->sc_chiptype == TYPE_PL2303X)
 910                 return (uplcom_pl2303x_init(sc));
 911
 912         return (0);
 913 }
 914
 915 static void
 916 uplcom_close(void *addr, int portno)
 917 {
 918         struct uplcom_softc *sc = addr;
 919         int err;
 920
 921         if (sc->sc_ucom.sc_dying)
 922                 return;
 923
 924         DPRINTF(("uplcom_close: close\n"));
 925
 926         if (sc->sc_intr_pipe != NULL) {
 927                 err = usbd_abort_pipe(sc->sc_intr_pipe);
 928                 if (err)
 929                         device_printf(sc->sc_ucom.sc_dev, "abort interrupt "
 930                                       "pipe failed: %s\n", usbd_errstr(err));
 931                 err = usbd_close_pipe(sc->sc_intr_pipe);
 932                 if (err)
 933                         device_printf(sc->sc_ucom.sc_dev, "close interrupt "
 934                                       "pipe failed: %s\n", usbd_errstr(err));
 935                 kfree(sc->sc_intr_buf, M_USBDEV);
 936                 sc->sc_intr_pipe = NULL;
 937         }
 938 }
 939
 940 static void
 941 uplcom_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 942 {
 943         struct uplcom_softc *sc = priv;
 944         u_char *buf = sc->sc_intr_buf;
 945         u_char pstatus;
 946
 947         if (sc->sc_ucom.sc_dying)
 948                 return;
 949
 950         if (status != USBD_NORMAL_COMPLETION) {
 951                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
 952                         return;
 953
 954                 DPRINTF(("%s: uplcom_intr: abnormal status: %s\n",
 955                         device_get_nameunit(sc->sc_ucom.sc_dev),
 956                         usbd_errstr(status)));
 957                 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
 958                 return;
 959         }
 960
 961         DPRINTF(("%s: uplcom status = %02x\n",
 962                  device_get_nameunit(sc->sc_ucom.sc_dev), buf[8]));
 963
 964         sc->sc_lsr = sc->sc_msr = 0;
 965         pstatus = buf[8];
 966         if (ISSET(pstatus, RSAQ_STATUS_CTS))
 967                 sc->sc_msr |= UMSR_CTS;
 968         else
 969                 sc->sc_msr &= ~UMSR_CTS;
 970         if (ISSET(pstatus, RSAQ_STATUS_DSR))
 971                 sc->sc_msr |= UMSR_DSR;
 972         else
 973                 sc->sc_msr &= ~UMSR_DSR;
 974         if (ISSET(pstatus, RSAQ_STATUS_DCD))
 975                 sc->sc_msr |= UMSR_DCD;
 976         else
 977                 sc->sc_msr &= ~UMSR_DCD;
 978
 979         /* Deferred notifying to the ucom layer */
 980         taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
 981 }
 982
 983 static void
 984 uplcom_notify(void *arg, int count)
 985 {
 986         struct uplcom_softc *sc;
 987
 988         sc = (struct uplcom_softc *)arg;
 989         if (sc->sc_ucom.sc_dying)
 990                 return;
 991         ucom_status_change(&sc->sc_ucom);
 992 }
 993
 994 static void
 995 uplcom_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
 996 {
 997         struct uplcom_softc *sc = addr;
 998
 999         DPRINTF(("uplcom_get_status:\n"));
1000
1001         if (lsr != NULL)
1002                 *lsr = sc->sc_lsr;
1003         if (msr != NULL)
1004                 *msr = sc->sc_msr;
1005 }
1006
1007 #if 0 /* TODO */
1008 static int
1009 uplcom_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag,
1010              struct thread *p)
1011 {
1012         struct uplcom_softc *sc = addr;
1013         int error = 0;
1014
1015         if (sc->sc_ucom.sc_dying)
1016                 return (EIO);
1017
1018         DPRINTF(("uplcom_ioctl: cmd = 0x%08lx\n", cmd));
1019
1020         switch (cmd) {
1021         case TIOCNOTTY:
1022         case TIOCMGET:
1023         case TIOCMSET:
1024         case USB_GET_CM_OVER_DATA:
1025         case USB_SET_CM_OVER_DATA:
1026                 break;
1027
1028         default:
1029                 DPRINTF(("uplcom_ioctl: unknown\n"));
1030                 error = ENOTTY;
1031                 break;
1032         }
1033
1034         return (error);
1035 }
1036 #endif