sys/dev/usb/serial/uplcom.c

   1 /*      $NetBSD: uplcom.c,v 1.21 2001/11/13 06:24:56 lukem Exp $        */
   2
   3 #include <sys/cdefs.h>
   4 __FBSDID("$FreeBSD$");
   5
   6 /*-
   7  * Copyright (c) 2001-2003, 2005 Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 /*-
  33  * Copyright (c) 2001 The NetBSD Foundation, Inc.
  34  * All rights reserved.
  35  *
  36  * This code is derived from software contributed to The NetBSD Foundation
  37  * by Ichiro FUKUHARA (ichiro@ichiro.org).
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 3. All advertising materials mentioning features or use of this software
  48  *    must display the following acknowledgement:
  49  *        This product includes software developed by the NetBSD
  50  *        Foundation, Inc. and its contributors.
  51  * 4. Neither the name of The NetBSD Foundation nor the names of its
  52  *    contributors may be used to endorse or promote products derived
  53  *    from this software without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  56  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  57  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  58  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  59  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  60  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  61  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  62  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  63  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  64  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  65  * POSSIBILITY OF SUCH DAMAGE.
  66  */
  67
  68 /*
  69  * This driver supports several USB-to-RS232 serial adapters driven by
  70  * Prolific PL-2303, PL-2303X and probably PL-2303HX USB-to-RS232
  71  * bridge chip.  The adapters are sold under many different brand
  72  * names.
  73  *
  74  * Datasheets are available at Prolific www site at
  75  * http://www.prolific.com.tw.  The datasheets don't contain full
  76  * programming information for the chip.
  77  *
  78  * PL-2303HX is probably programmed the same as PL-2303X.
  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/stdint.h>
  88 #include <sys/stddef.h>
  89 #include <sys/param.h>
  90 #include <sys/queue.h>
  91 #include <sys/types.h>
  92 #include <sys/systm.h>
  93 #include <sys/kernel.h>
  94 #include <sys/bus.h>
  95 #include <sys/module.h>
  96 #include <sys/lock.h>
  97 #include <sys/mutex.h>
  98 #include <sys/condvar.h>
  99 #include <sys/sysctl.h>
 100 #include <sys/sx.h>
 101 #include <sys/unistd.h>
 102 #include <sys/callout.h>
 103 #include <sys/malloc.h>
 104 #include <sys/priv.h>
 105
 106 #include <dev/usb/usb.h>
 107 #include <dev/usb/usbdi.h>
 108 #include <dev/usb/usbdi_util.h>
 109 #include <dev/usb/usb_cdc.h>
 110 #include "usbdevs.h"
 111
 112 #define USB_DEBUG_VAR uplcom_debug
 113 #include <dev/usb/usb_debug.h>
 114 #include <dev/usb/usb_process.h>
 115
 116 #include <dev/usb/serial/usb_serial.h>
 117
 118 #ifdef USB_DEBUG
 119 static int uplcom_debug = 0;
 120
 121 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
 122 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW,
 123     &uplcom_debug, 0, "Debug level");
 124 #endif
 125
 126 #define UPLCOM_MODVER                   1       /* module version */
 127
 128 #define UPLCOM_CONFIG_INDEX             0
 129 #define UPLCOM_IFACE_INDEX              0
 130 #define UPLCOM_SECOND_IFACE_INDEX       1
 131
 132 #ifndef UPLCOM_INTR_INTERVAL
 133 #define UPLCOM_INTR_INTERVAL            0       /* default */
 134 #endif
 135
 136 #define UPLCOM_BULK_BUF_SIZE 1024       /* bytes */
 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_PL2303HX                   1
 147
 148 enum {
 149         UPLCOM_BULK_DT_WR,
 150         UPLCOM_BULK_DT_RD,
 151         UPLCOM_INTR_DT_RD,
 152         UPLCOM_N_TRANSFER,
 153 };
 154
 155 struct uplcom_softc {
 156         struct ucom_super_softc sc_super_ucom;
 157         struct ucom_softc sc_ucom;
 158
 159         struct usb_xfer *sc_xfer[UPLCOM_N_TRANSFER];
 160         struct usb_device *sc_udev;
 161         struct mtx sc_mtx;
 162
 163         uint16_t sc_line;
 164
 165         uint8_t sc_lsr;                 /* local status register */
 166         uint8_t sc_msr;                 /* uplcom status register */
 167         uint8_t sc_chiptype;            /* type of chip */
 168         uint8_t sc_ctrl_iface_no;
 169         uint8_t sc_data_iface_no;
 170         uint8_t sc_iface_index[2];
 171 };
 172
 173 /* prototypes */
 174
 175 static usb_error_t uplcom_reset(struct uplcom_softc *, struct usb_device *);
 176 static usb_error_t uplcom_pl2303_do(struct usb_device *, int8_t, uint8_t,
 177                         uint16_t, uint16_t, uint16_t);
 178 static int      uplcom_pl2303_init(struct usb_device *, uint8_t);
 179 static void     uplcom_cfg_set_dtr(struct ucom_softc *, uint8_t);
 180 static void     uplcom_cfg_set_rts(struct ucom_softc *, uint8_t);
 181 static void     uplcom_cfg_set_break(struct ucom_softc *, uint8_t);
 182 static int      uplcom_pre_param(struct ucom_softc *, struct termios *);
 183 static void     uplcom_cfg_param(struct ucom_softc *, struct termios *);
 184 static void     uplcom_start_read(struct ucom_softc *);
 185 static void     uplcom_stop_read(struct ucom_softc *);
 186 static void     uplcom_start_write(struct ucom_softc *);
 187 static void     uplcom_stop_write(struct ucom_softc *);
 188 static void     uplcom_cfg_get_status(struct ucom_softc *, uint8_t *,
 189                     uint8_t *);
 190 static void     uplcom_poll(struct ucom_softc *ucom);
 191
 192 static device_probe_t uplcom_probe;
 193 static device_attach_t uplcom_attach;
 194 static device_detach_t uplcom_detach;
 195
 196 static usb_callback_t uplcom_intr_callback;
 197 static usb_callback_t uplcom_write_callback;
 198 static usb_callback_t uplcom_read_callback;
 199
 200 static const struct usb_config uplcom_config_data[UPLCOM_N_TRANSFER] = {
 201
 202         [UPLCOM_BULK_DT_WR] = {
 203                 .type = UE_BULK,
 204                 .endpoint = UE_ADDR_ANY,
 205                 .direction = UE_DIR_OUT,
 206                 .bufsize = UPLCOM_BULK_BUF_SIZE,
 207                 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
 208                 .callback = &uplcom_write_callback,
 209                 .if_index = 0,
 210         },
 211
 212         [UPLCOM_BULK_DT_RD] = {
 213                 .type = UE_BULK,
 214                 .endpoint = UE_ADDR_ANY,
 215                 .direction = UE_DIR_IN,
 216                 .bufsize = UPLCOM_BULK_BUF_SIZE,
 217                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 218                 .callback = &uplcom_read_callback,
 219                 .if_index = 0,
 220         },
 221
 222         [UPLCOM_INTR_DT_RD] = {
 223                 .type = UE_INTERRUPT,
 224                 .endpoint = UE_ADDR_ANY,
 225                 .direction = UE_DIR_IN,
 226                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 227                 .bufsize = 0,   /* use wMaxPacketSize */
 228                 .callback = &uplcom_intr_callback,
 229                 .if_index = 1,
 230         },
 231 };
 232
 233 static struct ucom_callback uplcom_callback = {
 234         .ucom_cfg_get_status = &uplcom_cfg_get_status,
 235         .ucom_cfg_set_dtr = &uplcom_cfg_set_dtr,
 236         .ucom_cfg_set_rts = &uplcom_cfg_set_rts,
 237         .ucom_cfg_set_break = &uplcom_cfg_set_break,
 238         .ucom_cfg_param = &uplcom_cfg_param,
 239         .ucom_pre_param = &uplcom_pre_param,
 240         .ucom_start_read = &uplcom_start_read,
 241         .ucom_stop_read = &uplcom_stop_read,
 242         .ucom_start_write = &uplcom_start_write,
 243         .ucom_stop_write = &uplcom_stop_write,
 244         .ucom_poll = &uplcom_poll,
 245 };
 246
 247 #define UPLCOM_DEV(v,p)                         \
 248   { USB_VENDOR(USB_VENDOR_##v), USB_PRODUCT(USB_PRODUCT_##v##_##p) }
 249
 250 static const STRUCT_USB_HOST_ID uplcom_devs[] = {
 251         UPLCOM_DEV(ACERP, S81),                 /* BenQ S81 phone */
 252         UPLCOM_DEV(ADLINK, ND6530),             /* ADLINK ND-6530 USB-Serial */
 253         UPLCOM_DEV(ALCATEL, OT535),             /* Alcatel One Touch 535/735 */
 254         UPLCOM_DEV(ALCOR, AU9720),              /* Alcor AU9720 USB 2.0-RS232 */
 255         UPLCOM_DEV(ANCHOR, SERIAL),             /* Anchor Serial adapter */
 256         UPLCOM_DEV(ATEN, UC232A),               /* PLANEX USB-RS232 URS-03 */
 257         UPLCOM_DEV(BELKIN, F5U257),             /* Belkin F5U257 USB to Serial */
 258         UPLCOM_DEV(COREGA, CGUSBRS232R),        /* Corega CG-USBRS232R */
 259         UPLCOM_DEV(EPSON, CRESSI_EDY),          /* Cressi Edy diving computer */
 260         UPLCOM_DEV(EPSON, N2ITION3),            /* Zeagle N2iTion3 diving computer */
 261         UPLCOM_DEV(ELECOM, UCSGT),              /* ELECOM UC-SGT Serial Adapter */
 262         UPLCOM_DEV(ELECOM, UCSGT0),             /* ELECOM UC-SGT Serial Adapter */
 263         UPLCOM_DEV(HAL, IMR001),                /* HAL Corporation Crossam2+USB */
 264         UPLCOM_DEV(HP, LD220),                  /* HP LD220 POS Display */
 265         UPLCOM_DEV(IODATA, USBRSAQ),            /* I/O DATA USB-RSAQ */
 266         UPLCOM_DEV(IODATA, USBRSAQ5),           /* I/O DATA USB-RSAQ5 */
 267         UPLCOM_DEV(ITEGNO, WM1080A),            /* iTegno WM1080A GSM/GFPRS modem */
 268         UPLCOM_DEV(ITEGNO, WM2080A),            /* iTegno WM2080A CDMA modem */
 269         UPLCOM_DEV(LEADTEK, 9531),              /* Leadtek 9531 GPS */
 270         UPLCOM_DEV(MICROSOFT, 700WX),           /* Microsoft Palm 700WX */
 271         UPLCOM_DEV(MOBILEACTION, MA620),        /* Mobile Action MA-620 Infrared Adapter */
 272         UPLCOM_DEV(NETINDEX, WS002IN),          /* Willcom W-S002IN */
 273         UPLCOM_DEV(NOKIA2, CA42),               /* Nokia CA-42 cable */
 274         UPLCOM_DEV(OTI, DKU5),                  /* OTI DKU-5 cable */
 275         UPLCOM_DEV(PANASONIC, TYTP50P6S),       /* Panasonic TY-TP50P6-S flat screen */
 276         UPLCOM_DEV(PLX, CA42),                  /* PLX CA-42 clone cable */
 277         UPLCOM_DEV(PROLIFIC, ALLTRONIX_GPRS),   /* Alltronix ACM003U00 modem */
 278         UPLCOM_DEV(PROLIFIC, ALDIGA_AL11U),     /* AlDiga AL-11U modem */
 279         UPLCOM_DEV(PROLIFIC, DCU11),            /* DCU-11 Phone Cable */
 280         UPLCOM_DEV(PROLIFIC, HCR331),           /* HCR331 Card Reader */
 281         UPLCOM_DEV(PROLIFIC, MICROMAX_610U),    /* Micromax 610U modem */
 282         UPLCOM_DEV(PROLIFIC, PHAROS),           /* Prolific Pharos */
 283         UPLCOM_DEV(PROLIFIC, PL2303),           /* Generic adapter */
 284         UPLCOM_DEV(PROLIFIC, RSAQ2),            /* I/O DATA USB-RSAQ2 */
 285         UPLCOM_DEV(PROLIFIC, RSAQ3),            /* I/O DATA USB-RSAQ3 */
 286         UPLCOM_DEV(PROLIFIC, UIC_MSR206),       /* UIC MSR206 Card Reader */
 287         UPLCOM_DEV(PROLIFIC2, PL2303),          /* Prolific adapter */
 288         UPLCOM_DEV(RADIOSHACK, USBCABLE),       /* Radio Shack USB Adapter */
 289         UPLCOM_DEV(RATOC, REXUSB60),            /* RATOC REX-USB60 */
 290         UPLCOM_DEV(SAGEM, USBSERIAL),           /* Sagem USB-Serial Controller */
 291         UPLCOM_DEV(SAMSUNG, I330),              /* Samsung I330 phone cradle */
 292         UPLCOM_DEV(SANWA, KB_USB2),             /* Sanwa KB-USB2 Multimeter cable */
 293         UPLCOM_DEV(SIEMENS3, EF81),             /* Siemens EF81 */
 294         UPLCOM_DEV(SIEMENS3, SX1),              /* Siemens SX1 */
 295         UPLCOM_DEV(SIEMENS3, X65),              /* Siemens X65 */
 296         UPLCOM_DEV(SIEMENS3, X75),              /* Siemens X75 */
 297         UPLCOM_DEV(SITECOM, SERIAL),            /* Sitecom USB to Serial */
 298         UPLCOM_DEV(SMART, PL2303),              /* SMART Technologies USB to Serial */
 299         UPLCOM_DEV(SONY, QN3),                  /* Sony QN3 phone cable */
 300         UPLCOM_DEV(SONYERICSSON, DATAPILOT),    /* Sony Ericsson Datapilot */
 301         UPLCOM_DEV(SONYERICSSON, DCU10),        /* Sony Ericsson DCU-10 Cable */
 302         UPLCOM_DEV(SOURCENEXT, KEIKAI8),        /* SOURCENEXT KeikaiDenwa 8 */
 303         UPLCOM_DEV(SOURCENEXT, KEIKAI8_CHG),    /* SOURCENEXT KeikaiDenwa 8 with charger */
 304         UPLCOM_DEV(SPEEDDRAGON, MS3303H),       /* Speed Dragon USB-Serial */
 305         UPLCOM_DEV(SYNTECH, CPT8001C),          /* Syntech CPT-8001C Barcode scanner */
 306         UPLCOM_DEV(TDK, UHA6400),               /* TDK USB-PHS Adapter UHA6400 */
 307         UPLCOM_DEV(TDK, UPA9664),               /* TDK USB-PHS Adapter UPA9664 */
 308         UPLCOM_DEV(TRIPPLITE, U209),            /* Tripp-Lite U209-000-R USB to Serial */
 309         UPLCOM_DEV(YCCABLE, PL2303),            /* YC Cable USB-Serial */
 310 };
 311 #undef UPLCOM_DEV
 312
 313 static device_method_t uplcom_methods[] = {
 314         DEVMETHOD(device_probe, uplcom_probe),
 315         DEVMETHOD(device_attach, uplcom_attach),
 316         DEVMETHOD(device_detach, uplcom_detach),
 317         {0, 0}
 318 };
 319
 320 static devclass_t uplcom_devclass;
 321
 322 static driver_t uplcom_driver = {
 323         .name = "uplcom",
 324         .methods = uplcom_methods,
 325         .size = sizeof(struct uplcom_softc),
 326 };
 327
 328 DRIVER_MODULE(uplcom, uhub, uplcom_driver, uplcom_devclass, NULL, 0);
 329 MODULE_DEPEND(uplcom, ucom, 1, 1, 1);
 330 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
 331 MODULE_VERSION(uplcom, UPLCOM_MODVER);
 332
 333 static int
 334 uplcom_probe(device_t dev)
 335 {
 336         struct usb_attach_arg *uaa = device_get_ivars(dev);
 337
 338         DPRINTFN(11, "\n");
 339
 340         if (uaa->usb_mode != USB_MODE_HOST) {
 341                 return (ENXIO);
 342         }
 343         if (uaa->info.bConfigIndex != UPLCOM_CONFIG_INDEX) {
 344                 return (ENXIO);
 345         }
 346         if (uaa->info.bIfaceIndex != UPLCOM_IFACE_INDEX) {
 347                 return (ENXIO);
 348         }
 349         return (usbd_lookup_id_by_uaa(uplcom_devs, sizeof(uplcom_devs), uaa));
 350 }
 351
 352 static int
 353 uplcom_attach(device_t dev)
 354 {
 355         struct usb_attach_arg *uaa = device_get_ivars(dev);
 356         struct uplcom_softc *sc = device_get_softc(dev);
 357         struct usb_interface *iface;
 358         struct usb_interface_descriptor *id;
 359         struct usb_device_descriptor *dd;
 360         int error;
 361
 362         DPRINTFN(11, "\n");
 363
 364         device_set_usb_desc(dev);
 365         mtx_init(&sc->sc_mtx, "uplcom", NULL, MTX_DEF);
 366
 367         DPRINTF("sc = %p\n", sc);
 368
 369         sc->sc_udev = uaa->device;
 370
 371         /* Determine the chip type.  This algorithm is taken from Linux. */
 372         dd = usbd_get_device_descriptor(sc->sc_udev);
 373         if (dd->bDeviceClass == 0x02)
 374                 sc->sc_chiptype = TYPE_PL2303;
 375         else if (dd->bMaxPacketSize == 0x40)
 376                 sc->sc_chiptype = TYPE_PL2303HX;
 377         else
 378                 sc->sc_chiptype = TYPE_PL2303;
 379
 380         DPRINTF("chiptype: %s\n",
 381             (sc->sc_chiptype == TYPE_PL2303HX) ?
 382             "2303X" : "2303");
 383
 384         /*
 385          * USB-RSAQ1 has two interface
 386          *
 387          *  USB-RSAQ1       | USB-RSAQ2
 388          * -----------------+-----------------
 389          * Interface 0      |Interface 0
 390          *  Interrupt(0x81) | Interrupt(0x81)
 391          * -----------------+ BulkIN(0x02)
 392          * Interface 1      | BulkOUT(0x83)
 393          *   BulkIN(0x02)   |
 394          *   BulkOUT(0x83)  |
 395          */
 396
 397         sc->sc_ctrl_iface_no = uaa->info.bIfaceNum;
 398         sc->sc_iface_index[1] = UPLCOM_IFACE_INDEX;
 399
 400         iface = usbd_get_iface(uaa->device, UPLCOM_SECOND_IFACE_INDEX);
 401         if (iface) {
 402                 id = usbd_get_interface_descriptor(iface);
 403                 if (id == NULL) {
 404                         device_printf(dev, "no interface descriptor (2)\n");
 405                         goto detach;
 406                 }
 407                 sc->sc_data_iface_no = id->bInterfaceNumber;
 408                 sc->sc_iface_index[0] = UPLCOM_SECOND_IFACE_INDEX;
 409                 usbd_set_parent_iface(uaa->device,
 410                     UPLCOM_SECOND_IFACE_INDEX, uaa->info.bIfaceIndex);
 411         } else {
 412                 sc->sc_data_iface_no = sc->sc_ctrl_iface_no;
 413                 sc->sc_iface_index[0] = UPLCOM_IFACE_INDEX;
 414         }
 415
 416         error = usbd_transfer_setup(uaa->device,
 417             sc->sc_iface_index, sc->sc_xfer, uplcom_config_data,
 418             UPLCOM_N_TRANSFER, sc, &sc->sc_mtx);
 419         if (error) {
 420                 DPRINTF("one or more missing USB endpoints, "
 421                     "error=%s\n", usbd_errstr(error));
 422                 goto detach;
 423         }
 424         error = uplcom_reset(sc, uaa->device);
 425         if (error) {
 426                 device_printf(dev, "reset failed, error=%s\n",
 427                     usbd_errstr(error));
 428                 goto detach;
 429         }
 430         /* clear stall at first run */
 431         mtx_lock(&sc->sc_mtx);
 432         usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
 433         usbd_xfer_set_stall(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
 434         mtx_unlock(&sc->sc_mtx);
 435
 436         error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
 437             &uplcom_callback, &sc->sc_mtx);
 438         if (error) {
 439                 goto detach;
 440         }
 441         /*
 442          * do the initialization during attach so that the system does not
 443          * sleep during open:
 444          */
 445         if (uplcom_pl2303_init(uaa->device, sc->sc_chiptype)) {
 446                 device_printf(dev, "init failed\n");
 447                 goto detach;
 448         }
 449         ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
 450
 451         return (0);
 452
 453 detach:
 454         uplcom_detach(dev);
 455         return (ENXIO);
 456 }
 457
 458 static int
 459 uplcom_detach(device_t dev)
 460 {
 461         struct uplcom_softc *sc = device_get_softc(dev);
 462
 463         DPRINTF("sc=%p\n", sc);
 464
 465         ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
 466         usbd_transfer_unsetup(sc->sc_xfer, UPLCOM_N_TRANSFER);
 467         mtx_destroy(&sc->sc_mtx);
 468
 469         return (0);
 470 }
 471
 472 static usb_error_t
 473 uplcom_reset(struct uplcom_softc *sc, struct usb_device *udev)
 474 {
 475         struct usb_device_request req;
 476
 477         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 478         req.bRequest = UPLCOM_SET_REQUEST;
 479         USETW(req.wValue, 0);
 480         req.wIndex[0] = sc->sc_data_iface_no;
 481         req.wIndex[1] = 0;
 482         USETW(req.wLength, 0);
 483
 484         return (usbd_do_request(udev, NULL, &req, NULL));
 485 }
 486
 487 static usb_error_t
 488 uplcom_pl2303_do(struct usb_device *udev, int8_t req_type, uint8_t request,
 489     uint16_t value, uint16_t index, uint16_t length)
 490 {
 491         struct usb_device_request req;
 492         usb_error_t err;
 493         uint8_t buf[4];
 494
 495         req.bmRequestType = req_type;
 496         req.bRequest = request;
 497         USETW(req.wValue, value);
 498         USETW(req.wIndex, index);
 499         USETW(req.wLength, length);
 500
 501         err = usbd_do_request(udev, NULL, &req, buf);
 502         if (err) {
 503                 DPRINTF("error=%s\n", usbd_errstr(err));
 504                 return (1);
 505         }
 506         return (0);
 507 }
 508
 509 static int
 510 uplcom_pl2303_init(struct usb_device *udev, uint8_t chiptype)
 511 {
 512         int err;
 513
 514         if (uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 515             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 0, 0)
 516             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 517             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
 518             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 519             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0)
 520             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 521             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
 522             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0)
 523             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0))
 524                 return (EIO);
 525
 526         if (chiptype == TYPE_PL2303HX)
 527                 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0);
 528         else
 529                 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x24, 0);
 530         if (err)
 531                 return (EIO);
 532
 533         if (uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 8, 0, 0)
 534             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 9, 0, 0))
 535                 return (EIO);
 536         return (0);
 537 }
 538
 539 static void
 540 uplcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
 541 {
 542         struct uplcom_softc *sc = ucom->sc_parent;
 543         struct usb_device_request req;
 544
 545         DPRINTF("onoff = %d\n", onoff);
 546
 547         if (onoff)
 548                 sc->sc_line |= UCDC_LINE_DTR;
 549         else
 550                 sc->sc_line &= ~UCDC_LINE_DTR;
 551
 552         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 553         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 554         USETW(req.wValue, sc->sc_line);
 555         req.wIndex[0] = sc->sc_data_iface_no;
 556         req.wIndex[1] = 0;
 557         USETW(req.wLength, 0);
 558
 559         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 560             &req, NULL, 0, 1000);
 561 }
 562
 563 static void
 564 uplcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
 565 {
 566         struct uplcom_softc *sc = ucom->sc_parent;
 567         struct usb_device_request req;
 568
 569         DPRINTF("onoff = %d\n", onoff);
 570
 571         if (onoff)
 572                 sc->sc_line |= UCDC_LINE_RTS;
 573         else
 574                 sc->sc_line &= ~UCDC_LINE_RTS;
 575
 576         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 577         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 578         USETW(req.wValue, sc->sc_line);
 579         req.wIndex[0] = sc->sc_data_iface_no;
 580         req.wIndex[1] = 0;
 581         USETW(req.wLength, 0);
 582
 583         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 584             &req, NULL, 0, 1000);
 585 }
 586
 587 static void
 588 uplcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
 589 {
 590         struct uplcom_softc *sc = ucom->sc_parent;
 591         struct usb_device_request req;
 592         uint16_t temp;
 593
 594         DPRINTF("onoff = %d\n", onoff);
 595
 596         temp = (onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
 597
 598         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 599         req.bRequest = UCDC_SEND_BREAK;
 600         USETW(req.wValue, temp);
 601         req.wIndex[0] = sc->sc_data_iface_no;
 602         req.wIndex[1] = 0;
 603         USETW(req.wLength, 0);
 604
 605         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 606             &req, NULL, 0, 1000);
 607 }
 608
 609 static const int32_t uplcom_rates[] = {
 610         75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
 611         19200, 28800, 38400, 57600, 115200,
 612         /*
 613          * Higher speeds are probably possible. PL2303X supports up to
 614          * 6Mb and can set any rate
 615          */
 616         230400, 460800, 614400, 921600, 1228800
 617 };
 618
 619 #define N_UPLCOM_RATES  (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
 620
 621 static int
 622 uplcom_pre_param(struct ucom_softc *ucom, struct termios *t)
 623 {
 624         struct uplcom_softc *sc = ucom->sc_parent;
 625         uint8_t i;
 626
 627         DPRINTF("\n");
 628
 629         /**
 630          * Check requested baud rate.
 631          *
 632          * The PL2303 can only set specific baud rates, up to 1228800 baud.
 633          * The PL2303X can set any baud rate up to 6Mb.
 634          * The PL2303HX rev. D can set any baud rate up to 12Mb.
 635          *
 636          * XXX: We currently cannot identify the PL2303HX rev. D, so treat
 637          *      it the same as the PL2303X.
 638          */
 639         if (sc->sc_chiptype != TYPE_PL2303HX) {
 640                 for (i = 0; i < N_UPLCOM_RATES; i++) {
 641                         if (uplcom_rates[i] == t->c_ospeed)
 642                                 return (0);
 643                 }
 644         } else {
 645                 if (t->c_ospeed <= 6000000)
 646                         return (0);
 647         }
 648
 649         DPRINTF("uplcom_param: bad baud rate (%d)\n", t->c_ospeed);
 650         return (EIO);
 651 }
 652
 653 static void
 654 uplcom_cfg_param(struct ucom_softc *ucom, struct termios *t)
 655 {
 656         struct uplcom_softc *sc = ucom->sc_parent;
 657         struct usb_cdc_line_state ls;
 658         struct usb_device_request req;
 659
 660         DPRINTF("sc = %p\n", sc);
 661
 662         bzero(&ls, sizeof(ls));
 663
 664         USETDW(ls.dwDTERate, t->c_ospeed);
 665
 666         if (t->c_cflag & CSTOPB) {
 667                 ls.bCharFormat = UCDC_STOP_BIT_2;
 668         } else {
 669                 ls.bCharFormat = UCDC_STOP_BIT_1;
 670         }
 671
 672         if (t->c_cflag & PARENB) {
 673                 if (t->c_cflag & PARODD) {
 674                         ls.bParityType = UCDC_PARITY_ODD;
 675                 } else {
 676                         ls.bParityType = UCDC_PARITY_EVEN;
 677                 }
 678         } else {
 679                 ls.bParityType = UCDC_PARITY_NONE;
 680         }
 681
 682         switch (t->c_cflag & CSIZE) {
 683         case CS5:
 684                 ls.bDataBits = 5;
 685                 break;
 686         case CS6:
 687                 ls.bDataBits = 6;
 688                 break;
 689         case CS7:
 690                 ls.bDataBits = 7;
 691                 break;
 692         case CS8:
 693                 ls.bDataBits = 8;
 694                 break;
 695         }
 696
 697         DPRINTF("rate=%d fmt=%d parity=%d bits=%d\n",
 698             UGETDW(ls.dwDTERate), ls.bCharFormat,
 699             ls.bParityType, ls.bDataBits);
 700
 701         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 702         req.bRequest = UCDC_SET_LINE_CODING;
 703         USETW(req.wValue, 0);
 704         req.wIndex[0] = sc->sc_data_iface_no;
 705         req.wIndex[1] = 0;
 706         USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
 707
 708         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 709             &req, &ls, 0, 1000);
 710
 711         if (t->c_cflag & CRTSCTS) {
 712
 713                 DPRINTF("crtscts = on\n");
 714
 715                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 716                 req.bRequest = UPLCOM_SET_REQUEST;
 717                 USETW(req.wValue, 0);
 718                 if (sc->sc_chiptype == TYPE_PL2303HX)
 719                         USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
 720                 else
 721                         USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
 722                 USETW(req.wLength, 0);
 723
 724                 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 725                     &req, NULL, 0, 1000);
 726         } else {
 727                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 728                 req.bRequest = UPLCOM_SET_REQUEST;
 729                 USETW(req.wValue, 0);
 730                 USETW(req.wIndex, 0);
 731                 USETW(req.wLength, 0);
 732                 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 733                     &req, NULL, 0, 1000);
 734         }
 735 }
 736
 737 static void
 738 uplcom_start_read(struct ucom_softc *ucom)
 739 {
 740         struct uplcom_softc *sc = ucom->sc_parent;
 741
 742         /* start interrupt endpoint */
 743         usbd_transfer_start(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
 744
 745         /* start read endpoint */
 746         usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
 747 }
 748
 749 static void
 750 uplcom_stop_read(struct ucom_softc *ucom)
 751 {
 752         struct uplcom_softc *sc = ucom->sc_parent;
 753
 754         /* stop interrupt endpoint */
 755         usbd_transfer_stop(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
 756
 757         /* stop read endpoint */
 758         usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
 759 }
 760
 761 static void
 762 uplcom_start_write(struct ucom_softc *ucom)
 763 {
 764         struct uplcom_softc *sc = ucom->sc_parent;
 765
 766         usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
 767 }
 768
 769 static void
 770 uplcom_stop_write(struct ucom_softc *ucom)
 771 {
 772         struct uplcom_softc *sc = ucom->sc_parent;
 773
 774         usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
 775 }
 776
 777 static void
 778 uplcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
 779 {
 780         struct uplcom_softc *sc = ucom->sc_parent;
 781
 782         DPRINTF("\n");
 783
 784         *lsr = sc->sc_lsr;
 785         *msr = sc->sc_msr;
 786 }
 787
 788 static void
 789 uplcom_intr_callback(struct usb_xfer *xfer, usb_error_t error)
 790 {
 791         struct uplcom_softc *sc = usbd_xfer_softc(xfer);
 792         struct usb_page_cache *pc;
 793         uint8_t buf[9];
 794         int actlen;
 795
 796         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 797
 798         switch (USB_GET_STATE(xfer)) {
 799         case USB_ST_TRANSFERRED:
 800
 801                 DPRINTF("actlen = %u\n", actlen);
 802
 803                 if (actlen >= 9) {
 804
 805                         pc = usbd_xfer_get_frame(xfer, 0);
 806                         usbd_copy_out(pc, 0, buf, sizeof(buf));
 807
 808                         DPRINTF("status = 0x%02x\n", buf[8]);
 809
 810                         sc->sc_lsr = 0;
 811                         sc->sc_msr = 0;
 812
 813                         if (buf[8] & RSAQ_STATUS_CTS) {
 814                                 sc->sc_msr |= SER_CTS;
 815                         }
 816                         if (buf[8] & RSAQ_STATUS_DSR) {
 817                                 sc->sc_msr |= SER_DSR;
 818                         }
 819                         if (buf[8] & RSAQ_STATUS_DCD) {
 820                                 sc->sc_msr |= SER_DCD;
 821                         }
 822                         ucom_status_change(&sc->sc_ucom);
 823                 }
 824         case USB_ST_SETUP:
 825 tr_setup:
 826                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 827                 usbd_transfer_submit(xfer);
 828                 return;
 829
 830         default:                        /* Error */
 831                 if (error != USB_ERR_CANCELLED) {
 832                         /* try to clear stall first */
 833                         usbd_xfer_set_stall(xfer);
 834                         goto tr_setup;
 835                 }
 836                 return;
 837         }
 838 }
 839
 840 static void
 841 uplcom_write_callback(struct usb_xfer *xfer, usb_error_t error)
 842 {
 843         struct uplcom_softc *sc = usbd_xfer_softc(xfer);
 844         struct usb_page_cache *pc;
 845         uint32_t actlen;
 846
 847         switch (USB_GET_STATE(xfer)) {
 848         case USB_ST_SETUP:
 849         case USB_ST_TRANSFERRED:
 850 tr_setup:
 851                 pc = usbd_xfer_get_frame(xfer, 0);
 852                 if (ucom_get_data(&sc->sc_ucom, pc, 0,
 853                     UPLCOM_BULK_BUF_SIZE, &actlen)) {
 854
 855                         DPRINTF("actlen = %d\n", actlen);
 856
 857                         usbd_xfer_set_frame_len(xfer, 0, actlen);
 858                         usbd_transfer_submit(xfer);
 859                 }
 860                 return;
 861
 862         default:                        /* Error */
 863                 if (error != USB_ERR_CANCELLED) {
 864                         /* try to clear stall first */
 865                         usbd_xfer_set_stall(xfer);
 866                         goto tr_setup;
 867                 }
 868                 return;
 869         }
 870 }
 871
 872 static void
 873 uplcom_read_callback(struct usb_xfer *xfer, usb_error_t error)
 874 {
 875         struct uplcom_softc *sc = usbd_xfer_softc(xfer);
 876         struct usb_page_cache *pc;
 877         int actlen;
 878
 879         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 880
 881         switch (USB_GET_STATE(xfer)) {
 882         case USB_ST_TRANSFERRED:
 883                 pc = usbd_xfer_get_frame(xfer, 0);
 884                 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
 885
 886         case USB_ST_SETUP:
 887 tr_setup:
 888                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 889                 usbd_transfer_submit(xfer);
 890                 return;
 891
 892         default:                        /* Error */
 893                 if (error != USB_ERR_CANCELLED) {
 894                         /* try to clear stall first */
 895                         usbd_xfer_set_stall(xfer);
 896                         goto tr_setup;
 897                 }
 898                 return;
 899         }
 900 }
 901
 902 static void
 903 uplcom_poll(struct ucom_softc *ucom)
 904 {
 905         struct uplcom_softc *sc = ucom->sc_parent;
 906         usbd_transfer_poll(sc->sc_xfer, UPLCOM_N_TRANSFER);
 907 }