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.20 2007/08/13 12:26:51 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         /* Sony-Ericsson DCU-10 and DCU-11 USB data cables */
 275         { USB_VENDOR_SUSTEEN, USB_PRODUCT_SUSTEEN_DCU10 },
 276         /* Susteen Datapilot Universal-2 Phone Cable */
 277         { USB_VENDOR_SUSTEEN, USB_PRODUCT_SUSTEEN_U2 },
 278         /* SOURCENEXT KeikaiDenwa 8 */
 279         { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8 },
 280         /* SOURCENEXT KeikaiDenwa 8 with charger */
 281         { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8_CHG },
 282         /* Speed Dragon Multimedia MS3303H USB to serial controller */
 283         { USB_VENDOR_SPEEDDRAGON, USB_PRODUCT_SPEEDDRAGON_MS3303H },
 284         /* Syntech CPT-8001C barcode scanner USB IR cradle */
 285         { USB_VENDOR_SYNTECH, USB_PRODUCT_SYNTECH_SERIAL },
 286         /* TDK USB-PHS adapter UHA6400 */
 287         { USB_VENDOR_TDK, USB_PRODUCT_TDK_UHA6400 },
 288         /* TDK USB-PDC adapter UPA9664 */
 289         { USB_VENDOR_TDK, USB_PRODUCT_TDK_UPA9664 },
 290         /* Tripp-Lite U209-000-R USB to serial cable */
 291         { USB_VENDOR_TRIPPLITE, USB_PRODUCT_TRIPPLITE_U209 },
 292         { 0, 0 }
 293 };
 294
 295 static device_probe_t uplcom_match;
 296 static device_attach_t uplcom_attach;
 297 static device_detach_t uplcom_detach;
 298
 299 static device_method_t uplcom_methods[] = {
 300         /* Device interface */
 301         DEVMETHOD(device_probe, uplcom_match),
 302         DEVMETHOD(device_attach, uplcom_attach),
 303         DEVMETHOD(device_detach, uplcom_detach),
 304         { 0, 0 }
 305 };
 306
 307 static driver_t uplcom_driver = {
 308         "ucom",
 309         uplcom_methods,
 310         sizeof (struct uplcom_softc)
 311 };
 312
 313 DRIVER_MODULE(uplcom, uhub, uplcom_driver, ucom_devclass, usbd_driver_load, 0);
 314 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
 315 MODULE_DEPEND(uplcom, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
 316 MODULE_VERSION(uplcom, UPLCOM_MODVER);
 317
 318 static int      uplcominterval = UPLCOM_INTR_INTERVAL;
 319
 320 static int
 321 sysctl_hw_usb_uplcom_interval(SYSCTL_HANDLER_ARGS)
 322 {
 323         int err, val;
 324
 325         val = uplcominterval;
 326         err = sysctl_handle_int(oidp, &val, sizeof(val), req);
 327         if (err != 0 || req->newptr == NULL)
 328                 return (err);
 329         if (0 < val && val <= 1000)
 330                 uplcominterval = val;
 331         else
 332                 err = EINVAL;
 333
 334         return (err);
 335 }
 336
 337 SYSCTL_PROC(_hw_usb_uplcom, OID_AUTO, interval, CTLTYPE_INT | CTLFLAG_RW,
 338             0, sizeof(int), sysctl_hw_usb_uplcom_interval,
 339             "I", "uplcom interrupt pipe interval");
 340
 341 static int
 342 uplcom_match(device_t self)
 343 {
 344         struct usb_attach_arg *uaa = device_get_ivars(self);
 345
 346         if (uaa->iface != NULL)
 347                 return (UMATCH_NONE);
 348
 349         return (usb_lookup(uplcom_devs, uaa->vendor, uaa->product) != NULL ?
 350                 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
 351 }
 352
 353 static int
 354 uplcom_attach(device_t self)
 355 {
 356         struct uplcom_softc *sc = device_get_softc(self);
 357         struct usb_attach_arg *uaa = device_get_ivars(self);
 358         usbd_device_handle dev = uaa->device;
 359         usb_device_descriptor_t *dd;
 360         struct ucom_softc *ucom;
 361         usb_config_descriptor_t *cdesc;
 362         usb_interface_descriptor_t *id;
 363         usb_endpoint_descriptor_t *ed;
 364         char *devinfo;
 365         const char *devname;
 366         usbd_status err;
 367         int i;
 368
 369         devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT);
 370         ucom = &sc->sc_ucom;
 371
 372         bzero(sc, sizeof (struct uplcom_softc));
 373
 374         usbd_devinfo(dev, 0, devinfo);
 375         ucom->sc_dev = self;
 376         device_set_desc_copy(self, devinfo);
 377
 378         ucom->sc_udev = dev;
 379         ucom->sc_iface = uaa->iface;
 380
 381         devname = device_get_nameunit(ucom->sc_dev);
 382         kprintf("%s: %s\n", devname, 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                 kprintf("%s: failed to set configuration: %s\n",
 422                         devname, 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                 kprintf("%s: failed to get configuration descriptor\n",
 432                         device_get_nameunit(ucom->sc_dev));
 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                 kprintf("%s: failed to get interface: %s\n",
 442                         devname, 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                         kprintf("%s: no endpoint descriptor for %d\n",
 456                                 device_get_nameunit(ucom->sc_dev), 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                 kprintf("%s: Could not find interrupt in\n",
 470                         device_get_nameunit(ucom->sc_dev));
 471                 ucom->sc_dying = 1;
 472                 goto error;
 473         }
 474
 475         /* keep interface for interrupt */
 476         sc->sc_intr_iface = ucom->sc_iface;
 477
 478         /*
 479          * USB-RSAQ1 has two interface
 480          *
 481          *  USB-RSAQ1       | USB-RSAQ2
 482          * -----------------+-----------------
 483          * Interface 0      |Interface 0
 484          *  Interrupt(0x81) | Interrupt(0x81)
 485          * -----------------+ BulkIN(0x02)
 486          * Interface 1      | BulkOUT(0x83)
 487          *   BulkIN(0x02)   |
 488          *   BulkOUT(0x83)  |
 489          */
 490         if (cdesc->bNumInterface == 2) {
 491                 err = usbd_device2interface_handle(dev,
 492                                                    UPLCOM_SECOND_IFACE_INDEX,
 493                                                    &ucom->sc_iface);
 494                 if (err) {
 495                         kprintf("%s: failed to get second interface: %s\n",
 496                                 devname, usbd_errstr(err));
 497                         ucom->sc_dying = 1;
 498                         goto error;
 499                 }
 500         }
 501
 502         /* Find the bulk{in,out} endpoints */
 503
 504         id = usbd_get_interface_descriptor(ucom->sc_iface);
 505         sc->sc_iface_number = id->bInterfaceNumber;
 506
 507         for (i = 0; i < id->bNumEndpoints; i++) {
 508                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 509                 if (ed == NULL) {
 510                         kprintf("%s: no endpoint descriptor for %d\n",
 511                                 device_get_nameunit(ucom->sc_dev), i);
 512                         ucom->sc_dying = 1;
 513                         goto error;
 514                 }
 515
 516                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 517                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 518                         ucom->sc_bulkin_no = ed->bEndpointAddress;
 519                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
 520                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 521                         ucom->sc_bulkout_no = ed->bEndpointAddress;
 522                 }
 523         }
 524
 525         if (ucom->sc_bulkin_no == -1) {
 526                 kprintf("%s: Could not find data bulk in\n",
 527                         device_get_nameunit(ucom->sc_dev));
 528                 ucom->sc_dying = 1;
 529                 goto error;
 530         }
 531
 532         if (ucom->sc_bulkout_no == -1) {
 533                 kprintf("%s: Could not find data bulk out\n",
 534                         device_get_nameunit(ucom->sc_dev));
 535                 ucom->sc_dying = 1;
 536                 goto error;
 537         }
 538
 539         sc->sc_dtr = sc->sc_rts = -1;
 540         ucom->sc_parent = sc;
 541         ucom->sc_portno = UCOM_UNK_PORTNO;
 542         /* bulkin, bulkout set above */
 543         ucom->sc_ibufsize = UPLCOMIBUFSIZE;
 544         ucom->sc_obufsize = UPLCOMOBUFSIZE;
 545         ucom->sc_ibufsizepad = UPLCOMIBUFSIZE;
 546         ucom->sc_opkthdrlen = 0;
 547         ucom->sc_callback = &uplcom_callback;
 548
 549         err = uplcom_reset(sc);
 550
 551         if (err) {
 552                 kprintf("%s: reset failed: %s\n",
 553                        device_get_nameunit(ucom->sc_dev), usbd_errstr(err));
 554                 ucom->sc_dying = 1;
 555                 goto error;
 556         }
 557
 558         DPRINTF(("uplcom: in = 0x%x, out = 0x%x, intr = 0x%x\n",
 559                  ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
 560
 561         TASK_INIT(&sc->sc_task, 0, uplcom_notify, sc);
 562         ucom_attach(&sc->sc_ucom);
 563
 564         kfree(devinfo, M_USBDEV);
 565         return 0;
 566
 567 error:
 568         kfree(devinfo, M_USBDEV);
 569         return ENXIO;
 570 }
 571
 572 static int
 573 uplcom_detach(device_t self)
 574 {
 575         struct uplcom_softc *sc = device_get_softc(self);
 576         int rv = 0;
 577
 578         DPRINTF(("uplcom_detach: sc = %p\n", sc));
 579
 580         if (sc->sc_intr_pipe != NULL) {
 581                 usbd_abort_pipe(sc->sc_intr_pipe);
 582                 usbd_close_pipe(sc->sc_intr_pipe);
 583                 kfree(sc->sc_intr_buf, M_USBDEV);
 584                 sc->sc_intr_pipe = NULL;
 585         }
 586
 587         sc->sc_ucom.sc_dying = 1;
 588
 589         rv = ucom_detach(&sc->sc_ucom);
 590
 591         return (rv);
 592 }
 593
 594 static usbd_status
 595 uplcom_reset(struct uplcom_softc *sc)
 596 {
 597         usb_device_request_t req;
 598         usbd_status err;
 599
 600         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 601         req.bRequest = UPLCOM_SET_REQUEST;
 602         USETW(req.wValue, 0);
 603         USETW(req.wIndex, sc->sc_iface_number);
 604         USETW(req.wLength, 0);
 605
 606         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 607         if (err) {
 608                 kprintf("%s: uplcom_reset: %s\n",
 609                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 610                 return (EIO);
 611         }
 612
 613         return (0);
 614 }
 615
 616 struct pl2303x_init {
 617         uint8_t         req_type;
 618         uint8_t         request;
 619         uint16_t        value;
 620         uint16_t        index;
 621         uint16_t        length;
 622 };
 623
 624 static const struct pl2303x_init pl2303x[] = {
 625         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 626         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404,    0, 0 },
 627         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 628         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8383,    0, 0 },
 629         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 630         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404,    1, 0 },
 631         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 632         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8383,    0, 0 },
 633         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      0,    1, 0 },
 634         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      1,    0, 0 },
 635         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      2, 0x44, 0 }
 636 };
 637 #define N_PL2302X_INIT  (sizeof(pl2303x)/sizeof(pl2303x[0]))
 638
 639 static usbd_status
 640 uplcom_pl2303x_init(struct uplcom_softc *sc)
 641 {
 642         usb_device_request_t req;
 643         usbd_status err;
 644         int i;
 645
 646         for (i = 0; i < N_PL2302X_INIT; i++) {
 647                 req.bmRequestType = pl2303x[i].req_type;
 648                 req.bRequest = pl2303x[i].request;
 649                 USETW(req.wValue, pl2303x[i].value);
 650                 USETW(req.wIndex, pl2303x[i].index);
 651                 USETW(req.wLength, pl2303x[i].length);
 652
 653                 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 654                 if (err) {
 655                         kprintf("%s: uplcom_pl2303x_init: %d: %s\n",
 656                                 device_get_nameunit(sc->sc_ucom.sc_dev), i,
 657                                 usbd_errstr(err));
 658                         return (EIO);
 659                 }
 660         }
 661
 662         return (0);
 663 }
 664
 665 static void
 666 uplcom_set_line_state(struct uplcom_softc *sc)
 667 {
 668         usb_device_request_t req;
 669         int ls;
 670         usbd_status err;
 671
 672         ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
 673                 (sc->sc_rts ? UCDC_LINE_RTS : 0);
 674         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 675         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 676         USETW(req.wValue, ls);
 677         USETW(req.wIndex, sc->sc_iface_number);
 678         USETW(req.wLength, 0);
 679
 680         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 681         if (err)
 682                 kprintf("%s: uplcom_set_line_status: %s\n",
 683                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 684 }
 685
 686 static void
 687 uplcom_set(void *addr, int portno, int reg, int onoff)
 688 {
 689         struct uplcom_softc *sc = addr;
 690
 691         switch (reg) {
 692         case UCOM_SET_DTR:
 693                 uplcom_dtr(sc, onoff);
 694                 break;
 695         case UCOM_SET_RTS:
 696                 uplcom_rts(sc, onoff);
 697                 break;
 698         case UCOM_SET_BREAK:
 699                 uplcom_break(sc, onoff);
 700                 break;
 701         default:
 702                 break;
 703         }
 704 }
 705
 706 static void
 707 uplcom_dtr(struct uplcom_softc *sc, int onoff)
 708 {
 709         DPRINTF(("uplcom_dtr: onoff = %d\n", onoff));
 710
 711         if (sc->sc_dtr == onoff)
 712                 return;
 713         sc->sc_dtr = onoff;
 714
 715         uplcom_set_line_state(sc);
 716 }
 717
 718 static void
 719 uplcom_rts(struct uplcom_softc *sc, int onoff)
 720 {
 721         DPRINTF(("uplcom_rts: onoff = %d\n", onoff));
 722
 723         if (sc->sc_rts == onoff)
 724                 return;
 725         sc->sc_rts = onoff;
 726
 727         uplcom_set_line_state(sc);
 728 }
 729
 730 static void
 731 uplcom_break(struct uplcom_softc *sc, int onoff)
 732 {
 733         usb_device_request_t req;
 734         usbd_status err;
 735
 736         DPRINTF(("uplcom_break: onoff = %d\n", onoff));
 737
 738         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 739         req.bRequest = UCDC_SEND_BREAK;
 740         USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
 741         USETW(req.wIndex, sc->sc_iface_number);
 742         USETW(req.wLength, 0);
 743
 744         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 745         if (err)
 746                 kprintf("%s: uplcom_break: %s\n",
 747                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 748 }
 749
 750 static usbd_status
 751 uplcom_set_crtscts(struct uplcom_softc *sc)
 752 {
 753         usb_device_request_t req;
 754         usbd_status err;
 755
 756         DPRINTF(("uplcom_set_crtscts: on\n"));
 757
 758         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 759         req.bRequest = UPLCOM_SET_REQUEST;
 760         USETW(req.wValue, 0);
 761         if (sc->sc_chiptype == TYPE_PL2303X)
 762                 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
 763         else
 764                 USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
 765         USETW(req.wLength, 0);
 766
 767         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 768         if (err) {
 769                 kprintf("%s: uplcom_set_crtscts: %s\n",
 770                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 771                 return (err);
 772         }
 773
 774         return (USBD_NORMAL_COMPLETION);
 775 }
 776
 777 static usbd_status
 778 uplcom_set_line_coding(struct uplcom_softc *sc, usb_cdc_line_state_t *state)
 779 {
 780         usb_device_request_t req;
 781         usbd_status err;
 782
 783         DPRINTF((
 784 "uplcom_set_line_coding: rate = %d, fmt = %d, parity = %d bits = %d\n",
 785                  UGETDW(state->dwDTERate), state->bCharFormat,
 786                  state->bParityType, state->bDataBits));
 787
 788         if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
 789                 DPRINTF(("uplcom_set_line_coding: already set\n"));
 790                 return (USBD_NORMAL_COMPLETION);
 791         }
 792
 793         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 794         req.bRequest = UCDC_SET_LINE_CODING;
 795         USETW(req.wValue, 0);
 796         USETW(req.wIndex, sc->sc_iface_number);
 797         USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
 798
 799         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, state);
 800         if (err) {
 801                 kprintf("%s: uplcom_set_line_coding: %s\n",
 802                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 803                 return (err);
 804         }
 805
 806         sc->sc_line_state = *state;
 807
 808         return (USBD_NORMAL_COMPLETION);
 809 }
 810
 811 static const int uplcom_rates[] = {
 812         75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
 813         19200, 28800, 38400, 57600, 115200,
 814         /*
 815          * Higher speeds are probably possible. PL2303X supports up to
 816          * 6Mb and can set any rate
 817          */
 818         230400, 460800, 614400, 921600, 1228800
 819 };
 820 #define N_UPLCOM_RATES  (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
 821
 822 static int
 823 uplcom_param(void *addr, int portno, struct termios *t)
 824 {
 825         struct uplcom_softc *sc = addr;
 826         usbd_status err;
 827         usb_cdc_line_state_t ls;
 828         int i;
 829
 830         DPRINTF(("uplcom_param: sc = %p\n", sc));
 831
 832         /* Check requested baud rate */
 833         for (i = 0; i < N_UPLCOM_RATES; i++)
 834                 if (uplcom_rates[i] == t->c_ospeed)
 835                         break;
 836         if (i == N_UPLCOM_RATES) {
 837                 DPRINTF(("uplcom_param: bad baud rate (%d)\n", t->c_ospeed));
 838                 return (EIO);
 839         }
 840
 841         USETDW(ls.dwDTERate, t->c_ospeed);
 842         if (ISSET(t->c_cflag, CSTOPB))
 843                 ls.bCharFormat = UCDC_STOP_BIT_2;
 844         else
 845                 ls.bCharFormat = UCDC_STOP_BIT_1;
 846         if (ISSET(t->c_cflag, PARENB)) {
 847                 if (ISSET(t->c_cflag, PARODD))
 848                         ls.bParityType = UCDC_PARITY_ODD;
 849                 else
 850                         ls.bParityType = UCDC_PARITY_EVEN;
 851         } else
 852                 ls.bParityType = UCDC_PARITY_NONE;
 853         switch (ISSET(t->c_cflag, CSIZE)) {
 854         case CS5:
 855                 ls.bDataBits = 5;
 856                 break;
 857         case CS6:
 858                 ls.bDataBits = 6;
 859                 break;
 860         case CS7:
 861                 ls.bDataBits = 7;
 862                 break;
 863         case CS8:
 864                 ls.bDataBits = 8;
 865                 break;
 866         }
 867
 868         err = uplcom_set_line_coding(sc, &ls);
 869         if (err)
 870                 return (EIO);
 871
 872         if (ISSET(t->c_cflag, CRTSCTS)) {
 873                 err = uplcom_set_crtscts(sc);
 874                 if (err)
 875                         return (EIO);
 876         }
 877
 878         return (0);
 879 }
 880
 881 static int
 882 uplcom_open(void *addr, int portno)
 883 {
 884         struct uplcom_softc *sc = addr;
 885         int err;
 886
 887         if (sc->sc_ucom.sc_dying)
 888                 return (ENXIO);
 889
 890         DPRINTF(("uplcom_open: sc = %p\n", sc));
 891
 892         if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
 893                 sc->sc_status = 0; /* clear status bit */
 894                 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
 895                 err = usbd_open_pipe_intr(sc->sc_intr_iface,
 896                                           sc->sc_intr_number,
 897                                           USBD_SHORT_XFER_OK,
 898                                           &sc->sc_intr_pipe,
 899                                           sc,
 900                                           sc->sc_intr_buf,
 901                                           sc->sc_isize,
 902                                           uplcom_intr,
 903                                           uplcominterval);
 904                 if (err) {
 905                         kprintf("%s: cannot open interrupt pipe (addr %d)\n",
 906                                device_get_nameunit(sc->sc_ucom.sc_dev),
 907                                sc->sc_intr_number);
 908                         return (EIO);
 909                 }
 910         }
 911
 912         if (sc->sc_chiptype == TYPE_PL2303X)
 913                 return (uplcom_pl2303x_init(sc));
 914
 915         return (0);
 916 }
 917
 918 static void
 919 uplcom_close(void *addr, int portno)
 920 {
 921         struct uplcom_softc *sc = addr;
 922         int err;
 923
 924         if (sc->sc_ucom.sc_dying)
 925                 return;
 926
 927         DPRINTF(("uplcom_close: close\n"));
 928
 929         if (sc->sc_intr_pipe != NULL) {
 930                 err = usbd_abort_pipe(sc->sc_intr_pipe);
 931                 if (err)
 932                         kprintf("%s: abort interrupt pipe failed: %s\n",
 933                                device_get_nameunit(sc->sc_ucom.sc_dev),
 934                                usbd_errstr(err));
 935                 err = usbd_close_pipe(sc->sc_intr_pipe);
 936                 if (err)
 937                         kprintf("%s: close interrupt pipe failed: %s\n",
 938                                device_get_nameunit(sc->sc_ucom.sc_dev),
 939                                usbd_errstr(err));
 940                 kfree(sc->sc_intr_buf, M_USBDEV);
 941                 sc->sc_intr_pipe = NULL;
 942         }
 943 }
 944
 945 static void
 946 uplcom_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 947 {
 948         struct uplcom_softc *sc = priv;
 949         u_char *buf = sc->sc_intr_buf;
 950         u_char pstatus;
 951
 952         if (sc->sc_ucom.sc_dying)
 953                 return;
 954
 955         if (status != USBD_NORMAL_COMPLETION) {
 956                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
 957                         return;
 958
 959                 DPRINTF(("%s: uplcom_intr: abnormal status: %s\n",
 960                         device_get_nameunit(sc->sc_ucom.sc_dev),
 961                         usbd_errstr(status)));
 962                 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
 963                 return;
 964         }
 965
 966         DPRINTF(("%s: uplcom status = %02x\n",
 967                  device_get_nameunit(sc->sc_ucom.sc_dev), buf[8]));
 968
 969         sc->sc_lsr = sc->sc_msr = 0;
 970         pstatus = buf[8];
 971         if (ISSET(pstatus, RSAQ_STATUS_CTS))
 972                 sc->sc_msr |= UMSR_CTS;
 973         else
 974                 sc->sc_msr &= ~UMSR_CTS;
 975         if (ISSET(pstatus, RSAQ_STATUS_DSR))
 976                 sc->sc_msr |= UMSR_DSR;
 977         else
 978                 sc->sc_msr &= ~UMSR_DSR;
 979         if (ISSET(pstatus, RSAQ_STATUS_DCD))
 980                 sc->sc_msr |= UMSR_DCD;
 981         else
 982                 sc->sc_msr &= ~UMSR_DCD;
 983
 984         /* Deferred notifying to the ucom layer */
 985         taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
 986 }
 987
 988 static void
 989 uplcom_notify(void *arg, int count)
 990 {
 991         struct uplcom_softc *sc;
 992
 993         sc = (struct uplcom_softc *)arg;
 994         if (sc->sc_ucom.sc_dying)
 995                 return;
 996         ucom_status_change(&sc->sc_ucom);
 997 }
 998
 999 static void
1000 uplcom_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
1001 {
1002         struct uplcom_softc *sc = addr;
1003
1004         DPRINTF(("uplcom_get_status:\n"));
1005
1006         if (lsr != NULL)
1007                 *lsr = sc->sc_lsr;
1008         if (msr != NULL)
1009                 *msr = sc->sc_msr;
1010 }
1011
1012 #if 0 /* TODO */
1013 static int
1014 uplcom_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag,
1015              struct thread *p)
1016 {
1017         struct uplcom_softc *sc = addr;
1018         int error = 0;
1019
1020         if (sc->sc_ucom.sc_dying)
1021                 return (EIO);
1022
1023         DPRINTF(("uplcom_ioctl: cmd = 0x%08lx\n", cmd));
1024
1025         switch (cmd) {
1026         case TIOCNOTTY:
1027         case TIOCMGET:
1028         case TIOCMSET:
1029         case USB_GET_CM_OVER_DATA:
1030         case USB_SET_CM_OVER_DATA:
1031                 break;
1032
1033         default:
1034                 DPRINTF(("uplcom_ioctl: unknown\n"));
1035                 error = ENOTTY;
1036                 break;
1037         }
1038
1039         return (error);
1040 }
1041 #endif