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/linker_set.h>
  96 #include <sys/module.h>
  97 #include <sys/lock.h>
  98 #include <sys/mutex.h>
  99 #include <sys/condvar.h>
 100 #include <sys/sysctl.h>
 101 #include <sys/sx.h>
 102 #include <sys/unistd.h>
 103 #include <sys/callout.h>
 104 #include <sys/malloc.h>
 105 #include <sys/priv.h>
 106
 107 #include <dev/usb/usb.h>
 108 #include <dev/usb/usbdi.h>
 109 #include <dev/usb/usbdi_util.h>
 110 #include <dev/usb/usb_cdc.h>
 111 #include "usbdevs.h"
 112
 113 #define USB_DEBUG_VAR uplcom_debug
 114 #include <dev/usb/usb_debug.h>
 115 #include <dev/usb/usb_process.h>
 116
 117 #include <dev/usb/serial/usb_serial.h>
 118
 119 #ifdef USB_DEBUG
 120 static int uplcom_debug = 0;
 121
 122 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
 123 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW,
 124     &uplcom_debug, 0, "Debug level");
 125 #endif
 126
 127 #define UPLCOM_MODVER                   1       /* module version */
 128
 129 #define UPLCOM_CONFIG_INDEX             0
 130 #define UPLCOM_IFACE_INDEX              0
 131 #define UPLCOM_SECOND_IFACE_INDEX       1
 132
 133 #ifndef UPLCOM_INTR_INTERVAL
 134 #define UPLCOM_INTR_INTERVAL            0       /* default */
 135 #endif
 136
 137 #define UPLCOM_BULK_BUF_SIZE 1024       /* bytes */
 138
 139 #define UPLCOM_SET_REQUEST              0x01
 140 #define UPLCOM_SET_CRTSCTS              0x41
 141 #define UPLCOM_SET_CRTSCTS_PL2303X      0x61
 142 #define RSAQ_STATUS_CTS                 0x80
 143 #define RSAQ_STATUS_DSR                 0x02
 144 #define RSAQ_STATUS_DCD                 0x01
 145
 146 #define TYPE_PL2303                     0
 147 #define TYPE_PL2303HX                   1
 148
 149 enum {
 150         UPLCOM_BULK_DT_WR,
 151         UPLCOM_BULK_DT_RD,
 152         UPLCOM_INTR_DT_RD,
 153         UPLCOM_N_TRANSFER,
 154 };
 155
 156 struct uplcom_softc {
 157         struct ucom_super_softc sc_super_ucom;
 158         struct ucom_softc sc_ucom;
 159
 160         struct usb_xfer *sc_xfer[UPLCOM_N_TRANSFER];
 161         struct usb_device *sc_udev;
 162         struct mtx sc_mtx;
 163
 164         uint16_t sc_line;
 165
 166         uint8_t sc_lsr;                 /* local status register */
 167         uint8_t sc_msr;                 /* uplcom status register */
 168         uint8_t sc_chiptype;            /* type of chip */
 169         uint8_t sc_ctrl_iface_no;
 170         uint8_t sc_data_iface_no;
 171         uint8_t sc_iface_index[2];
 172 };
 173
 174 /* prototypes */
 175
 176 static usb_error_t uplcom_reset(struct uplcom_softc *, struct usb_device *);
 177 static usb_error_t uplcom_pl2303_do(struct usb_device *, int8_t, uint8_t,
 178                         uint16_t, uint16_t, uint16_t);
 179 static int      uplcom_pl2303_init(struct usb_device *, uint8_t);
 180 static void     uplcom_cfg_set_dtr(struct ucom_softc *, uint8_t);
 181 static void     uplcom_cfg_set_rts(struct ucom_softc *, uint8_t);
 182 static void     uplcom_cfg_set_break(struct ucom_softc *, uint8_t);
 183 static int      uplcom_pre_param(struct ucom_softc *, struct termios *);
 184 static void     uplcom_cfg_param(struct ucom_softc *, struct termios *);
 185 static void     uplcom_start_read(struct ucom_softc *);
 186 static void     uplcom_stop_read(struct ucom_softc *);
 187 static void     uplcom_start_write(struct ucom_softc *);
 188 static void     uplcom_stop_write(struct ucom_softc *);
 189 static void     uplcom_cfg_get_status(struct ucom_softc *, uint8_t *,
 190                     uint8_t *);
 191 static void     uplcom_poll(struct ucom_softc *ucom);
 192
 193 static device_probe_t uplcom_probe;
 194 static device_attach_t uplcom_attach;
 195 static device_detach_t uplcom_detach;
 196
 197 static usb_callback_t uplcom_intr_callback;
 198 static usb_callback_t uplcom_write_callback;
 199 static usb_callback_t uplcom_read_callback;
 200
 201 static const struct usb_config uplcom_config_data[UPLCOM_N_TRANSFER] = {
 202
 203         [UPLCOM_BULK_DT_WR] = {
 204                 .type = UE_BULK,
 205                 .endpoint = UE_ADDR_ANY,
 206                 .direction = UE_DIR_OUT,
 207                 .bufsize = UPLCOM_BULK_BUF_SIZE,
 208                 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
 209                 .callback = &uplcom_write_callback,
 210                 .if_index = 0,
 211         },
 212
 213         [UPLCOM_BULK_DT_RD] = {
 214                 .type = UE_BULK,
 215                 .endpoint = UE_ADDR_ANY,
 216                 .direction = UE_DIR_IN,
 217                 .bufsize = UPLCOM_BULK_BUF_SIZE,
 218                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 219                 .callback = &uplcom_read_callback,
 220                 .if_index = 0,
 221         },
 222
 223         [UPLCOM_INTR_DT_RD] = {
 224                 .type = UE_INTERRUPT,
 225                 .endpoint = UE_ADDR_ANY,
 226                 .direction = UE_DIR_IN,
 227                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 228                 .bufsize = 0,   /* use wMaxPacketSize */
 229                 .callback = &uplcom_intr_callback,
 230                 .if_index = 1,
 231         },
 232 };
 233
 234 static struct ucom_callback uplcom_callback = {
 235         .ucom_cfg_get_status = &uplcom_cfg_get_status,
 236         .ucom_cfg_set_dtr = &uplcom_cfg_set_dtr,
 237         .ucom_cfg_set_rts = &uplcom_cfg_set_rts,
 238         .ucom_cfg_set_break = &uplcom_cfg_set_break,
 239         .ucom_cfg_param = &uplcom_cfg_param,
 240         .ucom_pre_param = &uplcom_pre_param,
 241         .ucom_start_read = &uplcom_start_read,
 242         .ucom_stop_read = &uplcom_stop_read,
 243         .ucom_start_write = &uplcom_start_write,
 244         .ucom_stop_write = &uplcom_stop_write,
 245         .ucom_poll = &uplcom_poll,
 246 };
 247
 248 #define UPLCOM_DEV(v,p)                         \
 249   { USB_VENDOR(USB_VENDOR_##v), USB_PRODUCT(USB_PRODUCT_##v##_##p) }
 250
 251 static const struct usb_device_id uplcom_devs[] = {
 252         UPLCOM_DEV(ACERP, S81),                 /* BenQ S81 phone */
 253         UPLCOM_DEV(ADLINK, ND6530),             /* ADLINK ND-6530 USB-Serial */
 254         UPLCOM_DEV(ALCATEL, OT535),             /* Alcatel One Touch 535/735 */
 255         UPLCOM_DEV(ALCOR, AU9720),              /* Alcor AU9720 USB 2.0-RS232 */
 256         UPLCOM_DEV(ANCHOR, SERIAL),             /* Anchor Serial adapter */
 257         UPLCOM_DEV(ATEN, UC232A),               /* PLANEX USB-RS232 URS-03 */
 258         UPLCOM_DEV(BELKIN, F5U257),             /* Belkin F5U257 USB to Serial */
 259         UPLCOM_DEV(COREGA, CGUSBRS232R),        /* Corega CG-USBRS232R */
 260         UPLCOM_DEV(EPSON, CRESSI_EDY),          /* Cressi Edy 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         return (0);
 450
 451 detach:
 452         uplcom_detach(dev);
 453         return (ENXIO);
 454 }
 455
 456 static int
 457 uplcom_detach(device_t dev)
 458 {
 459         struct uplcom_softc *sc = device_get_softc(dev);
 460
 461         DPRINTF("sc=%p\n", sc);
 462
 463         ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1);
 464         usbd_transfer_unsetup(sc->sc_xfer, UPLCOM_N_TRANSFER);
 465         mtx_destroy(&sc->sc_mtx);
 466
 467         return (0);
 468 }
 469
 470 static usb_error_t
 471 uplcom_reset(struct uplcom_softc *sc, struct usb_device *udev)
 472 {
 473         struct usb_device_request req;
 474
 475         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 476         req.bRequest = UPLCOM_SET_REQUEST;
 477         USETW(req.wValue, 0);
 478         req.wIndex[0] = sc->sc_data_iface_no;
 479         req.wIndex[1] = 0;
 480         USETW(req.wLength, 0);
 481
 482         return (usbd_do_request(udev, NULL, &req, NULL));
 483 }
 484
 485 static usb_error_t
 486 uplcom_pl2303_do(struct usb_device *udev, int8_t req_type, uint8_t request,
 487     uint16_t value, uint16_t index, uint16_t length)
 488 {
 489         struct usb_device_request req;
 490         usb_error_t err;
 491         uint8_t buf[4];
 492
 493         req.bmRequestType = req_type;
 494         req.bRequest = request;
 495         USETW(req.wValue, value);
 496         USETW(req.wIndex, index);
 497         USETW(req.wLength, length);
 498
 499         err = usbd_do_request(udev, NULL, &req, buf);
 500         if (err) {
 501                 DPRINTF("error=%s\n", usbd_errstr(err));
 502                 return (1);
 503         }
 504         return (0);
 505 }
 506
 507 static int
 508 uplcom_pl2303_init(struct usb_device *udev, uint8_t chiptype)
 509 {
 510         int err;
 511
 512         if (uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 513             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 0, 0)
 514             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 515             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
 516             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 517             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0)
 518             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 1)
 519             || uplcom_pl2303_do(udev, UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 1)
 520             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0)
 521             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0))
 522                 return (EIO);
 523
 524         if (chiptype == TYPE_PL2303HX)
 525                 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0);
 526         else
 527                 err = uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x24, 0);
 528         if (err)
 529                 return (EIO);
 530
 531         if (uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 8, 0, 0)
 532             || uplcom_pl2303_do(udev, UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 9, 0, 0))
 533                 return (EIO);
 534         return (0);
 535 }
 536
 537 static void
 538 uplcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
 539 {
 540         struct uplcom_softc *sc = ucom->sc_parent;
 541         struct usb_device_request req;
 542
 543         DPRINTF("onoff = %d\n", onoff);
 544
 545         if (onoff)
 546                 sc->sc_line |= UCDC_LINE_DTR;
 547         else
 548                 sc->sc_line &= ~UCDC_LINE_DTR;
 549
 550         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 551         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 552         USETW(req.wValue, sc->sc_line);
 553         req.wIndex[0] = sc->sc_data_iface_no;
 554         req.wIndex[1] = 0;
 555         USETW(req.wLength, 0);
 556
 557         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 558             &req, NULL, 0, 1000);
 559 }
 560
 561 static void
 562 uplcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
 563 {
 564         struct uplcom_softc *sc = ucom->sc_parent;
 565         struct usb_device_request req;
 566
 567         DPRINTF("onoff = %d\n", onoff);
 568
 569         if (onoff)
 570                 sc->sc_line |= UCDC_LINE_RTS;
 571         else
 572                 sc->sc_line &= ~UCDC_LINE_RTS;
 573
 574         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 575         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 576         USETW(req.wValue, sc->sc_line);
 577         req.wIndex[0] = sc->sc_data_iface_no;
 578         req.wIndex[1] = 0;
 579         USETW(req.wLength, 0);
 580
 581         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 582             &req, NULL, 0, 1000);
 583 }
 584
 585 static void
 586 uplcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
 587 {
 588         struct uplcom_softc *sc = ucom->sc_parent;
 589         struct usb_device_request req;
 590         uint16_t temp;
 591
 592         DPRINTF("onoff = %d\n", onoff);
 593
 594         temp = (onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
 595
 596         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 597         req.bRequest = UCDC_SEND_BREAK;
 598         USETW(req.wValue, temp);
 599         req.wIndex[0] = sc->sc_data_iface_no;
 600         req.wIndex[1] = 0;
 601         USETW(req.wLength, 0);
 602
 603         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 604             &req, NULL, 0, 1000);
 605 }
 606
 607 static const int32_t uplcom_rates[] = {
 608         75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
 609         19200, 28800, 38400, 57600, 115200,
 610         /*
 611          * Higher speeds are probably possible. PL2303X supports up to
 612          * 6Mb and can set any rate
 613          */
 614         230400, 460800, 614400, 921600, 1228800
 615 };
 616
 617 #define N_UPLCOM_RATES  (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
 618
 619 static int
 620 uplcom_pre_param(struct ucom_softc *ucom, struct termios *t)
 621 {
 622         struct uplcom_softc *sc = ucom->sc_parent;
 623         uint8_t i;
 624
 625         DPRINTF("\n");
 626
 627         /**
 628          * Check requested baud rate.
 629          *
 630          * The PL2303 can only set specific baud rates, up to 1228800 baud.
 631          * The PL2303X can set any baud rate up to 6Mb.
 632          * The PL2303HX rev. D can set any baud rate up to 12Mb.
 633          *
 634          * XXX: We currently cannot identify the PL2303HX rev. D, so treat
 635          *      it the same as the PL2303X.
 636          */
 637         if (sc->sc_chiptype != TYPE_PL2303HX) {
 638                 for (i = 0; i < N_UPLCOM_RATES; i++) {
 639                         if (uplcom_rates[i] == t->c_ospeed)
 640                                 return (0);
 641                 }
 642         } else {
 643                 if (t->c_ospeed <= 6000000)
 644                         return (0);
 645         }
 646
 647         DPRINTF("uplcom_param: bad baud rate (%d)\n", t->c_ospeed);
 648         return (EIO);
 649 }
 650
 651 static void
 652 uplcom_cfg_param(struct ucom_softc *ucom, struct termios *t)
 653 {
 654         struct uplcom_softc *sc = ucom->sc_parent;
 655         struct usb_cdc_line_state ls;
 656         struct usb_device_request req;
 657
 658         DPRINTF("sc = %p\n", sc);
 659
 660         bzero(&ls, sizeof(ls));
 661
 662         USETDW(ls.dwDTERate, t->c_ospeed);
 663
 664         if (t->c_cflag & CSTOPB) {
 665                 ls.bCharFormat = UCDC_STOP_BIT_2;
 666         } else {
 667                 ls.bCharFormat = UCDC_STOP_BIT_1;
 668         }
 669
 670         if (t->c_cflag & PARENB) {
 671                 if (t->c_cflag & PARODD) {
 672                         ls.bParityType = UCDC_PARITY_ODD;
 673                 } else {
 674                         ls.bParityType = UCDC_PARITY_EVEN;
 675                 }
 676         } else {
 677                 ls.bParityType = UCDC_PARITY_NONE;
 678         }
 679
 680         switch (t->c_cflag & CSIZE) {
 681         case CS5:
 682                 ls.bDataBits = 5;
 683                 break;
 684         case CS6:
 685                 ls.bDataBits = 6;
 686                 break;
 687         case CS7:
 688                 ls.bDataBits = 7;
 689                 break;
 690         case CS8:
 691                 ls.bDataBits = 8;
 692                 break;
 693         }
 694
 695         DPRINTF("rate=%d fmt=%d parity=%d bits=%d\n",
 696             UGETDW(ls.dwDTERate), ls.bCharFormat,
 697             ls.bParityType, ls.bDataBits);
 698
 699         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 700         req.bRequest = UCDC_SET_LINE_CODING;
 701         USETW(req.wValue, 0);
 702         req.wIndex[0] = sc->sc_data_iface_no;
 703         req.wIndex[1] = 0;
 704         USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
 705
 706         ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 707             &req, &ls, 0, 1000);
 708
 709         if (t->c_cflag & CRTSCTS) {
 710
 711                 DPRINTF("crtscts = on\n");
 712
 713                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 714                 req.bRequest = UPLCOM_SET_REQUEST;
 715                 USETW(req.wValue, 0);
 716                 if (sc->sc_chiptype == TYPE_PL2303HX)
 717                         USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
 718                 else
 719                         USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
 720                 USETW(req.wLength, 0);
 721
 722                 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 723                     &req, NULL, 0, 1000);
 724         } else {
 725                 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 726                 req.bRequest = UPLCOM_SET_REQUEST;
 727                 USETW(req.wValue, 0);
 728                 USETW(req.wIndex, 0);
 729                 USETW(req.wLength, 0);
 730                 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 731                     &req, NULL, 0, 1000);
 732         }
 733 }
 734
 735 static void
 736 uplcom_start_read(struct ucom_softc *ucom)
 737 {
 738         struct uplcom_softc *sc = ucom->sc_parent;
 739
 740         /* start interrupt endpoint */
 741         usbd_transfer_start(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
 742
 743         /* start read endpoint */
 744         usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
 745 }
 746
 747 static void
 748 uplcom_stop_read(struct ucom_softc *ucom)
 749 {
 750         struct uplcom_softc *sc = ucom->sc_parent;
 751
 752         /* stop interrupt endpoint */
 753         usbd_transfer_stop(sc->sc_xfer[UPLCOM_INTR_DT_RD]);
 754
 755         /* stop read endpoint */
 756         usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_RD]);
 757 }
 758
 759 static void
 760 uplcom_start_write(struct ucom_softc *ucom)
 761 {
 762         struct uplcom_softc *sc = ucom->sc_parent;
 763
 764         usbd_transfer_start(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
 765 }
 766
 767 static void
 768 uplcom_stop_write(struct ucom_softc *ucom)
 769 {
 770         struct uplcom_softc *sc = ucom->sc_parent;
 771
 772         usbd_transfer_stop(sc->sc_xfer[UPLCOM_BULK_DT_WR]);
 773 }
 774
 775 static void
 776 uplcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
 777 {
 778         struct uplcom_softc *sc = ucom->sc_parent;
 779
 780         DPRINTF("\n");
 781
 782         *lsr = sc->sc_lsr;
 783         *msr = sc->sc_msr;
 784 }
 785
 786 static void
 787 uplcom_intr_callback(struct usb_xfer *xfer, usb_error_t error)
 788 {
 789         struct uplcom_softc *sc = usbd_xfer_softc(xfer);
 790         struct usb_page_cache *pc;
 791         uint8_t buf[9];
 792         int actlen;
 793
 794         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 795
 796         switch (USB_GET_STATE(xfer)) {
 797         case USB_ST_TRANSFERRED:
 798
 799                 DPRINTF("actlen = %u\n", actlen);
 800
 801                 if (actlen >= 9) {
 802
 803                         pc = usbd_xfer_get_frame(xfer, 0);
 804                         usbd_copy_out(pc, 0, buf, sizeof(buf));
 805
 806                         DPRINTF("status = 0x%02x\n", buf[8]);
 807
 808                         sc->sc_lsr = 0;
 809                         sc->sc_msr = 0;
 810
 811                         if (buf[8] & RSAQ_STATUS_CTS) {
 812                                 sc->sc_msr |= SER_CTS;
 813                         }
 814                         if (buf[8] & RSAQ_STATUS_DSR) {
 815                                 sc->sc_msr |= SER_DSR;
 816                         }
 817                         if (buf[8] & RSAQ_STATUS_DCD) {
 818                                 sc->sc_msr |= SER_DCD;
 819                         }
 820                         ucom_status_change(&sc->sc_ucom);
 821                 }
 822         case USB_ST_SETUP:
 823 tr_setup:
 824                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 825                 usbd_transfer_submit(xfer);
 826                 return;
 827
 828         default:                        /* Error */
 829                 if (error != USB_ERR_CANCELLED) {
 830                         /* try to clear stall first */
 831                         usbd_xfer_set_stall(xfer);
 832                         goto tr_setup;
 833                 }
 834                 return;
 835         }
 836 }
 837
 838 static void
 839 uplcom_write_callback(struct usb_xfer *xfer, usb_error_t error)
 840 {
 841         struct uplcom_softc *sc = usbd_xfer_softc(xfer);
 842         struct usb_page_cache *pc;
 843         uint32_t actlen;
 844
 845         switch (USB_GET_STATE(xfer)) {
 846         case USB_ST_SETUP:
 847         case USB_ST_TRANSFERRED:
 848 tr_setup:
 849                 pc = usbd_xfer_get_frame(xfer, 0);
 850                 if (ucom_get_data(&sc->sc_ucom, pc, 0,
 851                     UPLCOM_BULK_BUF_SIZE, &actlen)) {
 852
 853                         DPRINTF("actlen = %d\n", actlen);
 854
 855                         usbd_xfer_set_frame_len(xfer, 0, actlen);
 856                         usbd_transfer_submit(xfer);
 857                 }
 858                 return;
 859
 860         default:                        /* Error */
 861                 if (error != USB_ERR_CANCELLED) {
 862                         /* try to clear stall first */
 863                         usbd_xfer_set_stall(xfer);
 864                         goto tr_setup;
 865                 }
 866                 return;
 867         }
 868 }
 869
 870 static void
 871 uplcom_read_callback(struct usb_xfer *xfer, usb_error_t error)
 872 {
 873         struct uplcom_softc *sc = usbd_xfer_softc(xfer);
 874         struct usb_page_cache *pc;
 875         int actlen;
 876
 877         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 878
 879         switch (USB_GET_STATE(xfer)) {
 880         case USB_ST_TRANSFERRED:
 881                 pc = usbd_xfer_get_frame(xfer, 0);
 882                 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
 883
 884         case USB_ST_SETUP:
 885 tr_setup:
 886                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 887                 usbd_transfer_submit(xfer);
 888                 return;
 889
 890         default:                        /* Error */
 891                 if (error != USB_ERR_CANCELLED) {
 892                         /* try to clear stall first */
 893                         usbd_xfer_set_stall(xfer);
 894                         goto tr_setup;
 895                 }
 896                 return;
 897         }
 898 }
 899
 900 static void
 901 uplcom_poll(struct ucom_softc *ucom)
 902 {
 903         struct uplcom_softc *sc = ucom->sc_parent;
 904         usbd_transfer_poll(sc->sc_xfer, UPLCOM_N_TRANSFER);
 905 }