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.15 2007/07/03 19:28:16 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 USB-to-RS232 serial adapters driven by
  71  * Prolific PL-2303, PL-2303X and probably PL-2303HX USB-to-RS232
  72  * bridge chip.  The adapters are sold under many different brand
  73  * names.
  74  *
  75  * Datasheets are available at Prolific www site at
  76  * http://www.prolific.com.tw.  The datasheets don't contain full
  77  * programming information for the chip.
  78  *
  79  * PL-2303HX is probably programmed the same as PL-2303X.
  80  *
  81  * There are several differences between PL-2303 and PL-2303(H)X.
  82  * PL-2303(H)X can do higher bitrate in bulk mode, has _probably_
  83  * different command for controlling CRTSCTS and needs special
  84  * sequence of commands for initialization which aren't also
  85  * documented in the datasheet.
  86  */
  87
  88 #include <sys/param.h>
  89 #include <sys/systm.h>
  90 #include <sys/kernel.h>
  91 #include <sys/malloc.h>
  92 #include <sys/bus.h>
  93 #include <sys/ioccom.h>
  94 #include <sys/fcntl.h>
  95 #include <sys/conf.h>
  96 #include <sys/tty.h>
  97 #include <sys/file.h>
  98 #include <sys/select.h>
  99 #include <sys/proc.h>
 100 #include <sys/vnode.h>
 101 #include <sys/poll.h>
 102 #include <sys/sysctl.h>
 103 #include <sys/taskqueue.h>
 104
 105 #include <bus/usb/usb.h>
 106 #include <bus/usb/usbcdc.h>
 107
 108 #include <bus/usb/usbdi.h>
 109 #include <bus/usb/usbdi_util.h>
 110 #include <bus/usb/usbdevs.h>
 111 #include <bus/usb/usb_quirks.h>
 112
 113 #include "../ucom/ucomvar.h"
 114
 115 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
 116 #ifdef USB_DEBUG
 117 static int      uplcomdebug = 0;
 118 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW,
 119            &uplcomdebug, 0, "uplcom debug level");
 120
 121 #define DPRINTFN(n, x)  do { \
 122                                 if (uplcomdebug > (n)) \
 123                                         kprintf x; \
 124                         } while (0)
 125 #else
 126 #define DPRINTFN(n, x)
 127 #endif
 128 #define DPRINTF(x) DPRINTFN(0, x)
 129
 130 #define UPLCOM_MODVER                   1       /* module version */
 131
 132 #define UPLCOM_CONFIG_INDEX             0
 133 #define UPLCOM_IFACE_INDEX              0
 134 #define UPLCOM_SECOND_IFACE_INDEX       1
 135
 136 #ifndef UPLCOM_INTR_INTERVAL
 137 #define UPLCOM_INTR_INTERVAL            100     /* ms */
 138 #endif
 139
 140 #define UPLCOM_SET_REQUEST              0x01
 141 #define UPLCOM_SET_CRTSCTS              0x41
 142 #define UPLCOM_SET_CRTSCTS_PL2303X      0x61
 143 #define RSAQ_STATUS_CTS                 0x80
 144 #define RSAQ_STATUS_DSR                 0x02
 145 #define RSAQ_STATUS_DCD                 0x01
 146
 147 #define TYPE_PL2303                     0
 148 #define TYPE_PL2303X                    1
 149
 150 struct  uplcom_softc {
 151         struct ucom_softc       sc_ucom;
 152
 153         int                     sc_iface_number;        /* interface number */
 154
 155         usbd_interface_handle   sc_intr_iface;  /* interrupt interface */
 156         int                     sc_intr_number; /* interrupt number */
 157         usbd_pipe_handle        sc_intr_pipe;   /* interrupt pipe */
 158         u_char                  *sc_intr_buf;   /* interrupt buffer */
 159         int                     sc_isize;
 160
 161         usb_cdc_line_state_t    sc_line_state;  /* current line state */
 162         u_char                  sc_dtr;         /* current DTR state */
 163         u_char                  sc_rts;         /* current RTS state */
 164         u_char                  sc_status;
 165
 166         u_char                  sc_lsr;         /* Local status register */
 167         u_char                  sc_msr;         /* uplcom status register */
 168
 169         int                     sc_chiptype;    /* Type of chip */
 170
 171         struct task             sc_task;
 172 };
 173
 174 /*
 175  * These are the maximum number of bytes transferred per frame.
 176  * The output buffer size cannot be increased due to the size encoding.
 177  */
 178 #define UPLCOMIBUFSIZE 256
 179 #define UPLCOMOBUFSIZE 256
 180
 181 static  usbd_status uplcom_reset(struct uplcom_softc *);
 182 static  usbd_status uplcom_set_line_coding(struct uplcom_softc *,
 183                                            usb_cdc_line_state_t *);
 184 static  usbd_status uplcom_set_crtscts(struct uplcom_softc *);
 185 static  void uplcom_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
 186
 187 static  void uplcom_set(void *, int, int, int);
 188 static  void uplcom_dtr(struct uplcom_softc *, int);
 189 static  void uplcom_rts(struct uplcom_softc *, int);
 190 static  void uplcom_break(struct uplcom_softc *, int);
 191 static  void uplcom_set_line_state(struct uplcom_softc *);
 192 static  void uplcom_get_status(void *, int, u_char *, u_char *);
 193 #if 0 /* TODO */
 194 static  int  uplcom_ioctl(void *, int, u_long, caddr_t, int, struct thread *);
 195 #endif
 196 static  int  uplcom_param(void *, int, struct termios *);
 197 static  int  uplcom_open(void *, int);
 198 static  void uplcom_close(void *, int);
 199 static  void uplcom_notify(void *, int);
 200
 201 struct ucom_callback uplcom_callback = {
 202         uplcom_get_status,
 203         uplcom_set,
 204         uplcom_param,
 205         NULL, /* uplcom_ioctl, TODO */
 206         uplcom_open,
 207         uplcom_close,
 208         NULL,
 209         NULL
 210 };
 211
 212 static const struct uplcom_product {
 213         uint16_t        vendor;
 214         uint16_t        product;
 215         int32_t         release;         /* release is a 16bit entity,
 216                                           * if -1 is specified we "don't care"
 217                                           * This is a floor value.  The table
 218                                           * must have newer revs before older
 219                                           * revs (and -1 last).
 220                                           */
 221         char            chiptype;
 222 } uplcom_products [] = {
 223         { USB_VENDOR_RADIOSHACK, USB_PRODUCT_RADIOSHACK_USBCABLE, -1, TYPE_PL2303 },
 224
 225         /* I/O DATA USB-RSAQ */
 226         { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBRSAQ, -1, TYPE_PL2303 },
 227         /* Prolific Pharos */
 228         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303X, -1, TYPE_PL2303 },
 229         /* I/O DATA USB-RSAQ2 */
 230         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_RSAQ2, -1, TYPE_PL2303 },
 231         /* I/O DATA USB-RSAQ3 */
 232         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_RSAQ3, -1, TYPE_PL2303X },
 233         /* Willcom W-SIM */
 234         { USB_VENDOR_PROLIFIC2, USB_PRODUCT_PROLIFIC2_WSIM, -1, TYPE_PL2303X},
 235         /* PLANEX USB-RS232 URS-03 */
 236         { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC232A, -1, TYPE_PL2303 },
 237         /* ST Lab USB-SERIAL-4 */
 238         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303,
 239           0x300, TYPE_PL2303X },
 240         /* IOGEAR/ATEN UC-232A (also ST Lab USB-SERIAL-1) */
 241         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303, -1, TYPE_PL2303 },
 242         /* HAMLET exagerate XURS232 */
 243         { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303, -1, TYPE_PL2303X },
 244         /* TDK USB-PHS Adapter UHA6400 */
 245         { USB_VENDOR_TDK, USB_PRODUCT_TDK_UHA6400, -1, TYPE_PL2303 },
 246         /* RATOC REX-USB60 */
 247         { USB_VENDOR_RATOC, USB_PRODUCT_RATOC_REXUSB60, -1, TYPE_PL2303 },
 248         /* ELECOM UC-SGT */
 249         { USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_UCSGT, -1, TYPE_PL2303 },
 250         { USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_UCSGT0, -1, TYPE_PL2303 },
 251         /* Sony Ericsson USB Cable */
 252         { USB_VENDOR_SUSTEEN, USB_PRODUCT_SUSTEEN_DCU10,
 253           -1,TYPE_PL2303 },
 254         /* SOURCENEXT KeikaiDenwa 8 */
 255         { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8,
 256           -1, TYPE_PL2303 },
 257         /* SOURCENEXT KeikaiDenwa 8 with charger */
 258         { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8_CHG,
 259           -1, TYPE_PL2303 },
 260         /* HAL Corporation Crossam2+USB */
 261         { USB_VENDOR_HAL, USB_PRODUCT_HAL_IMR001, -1, TYPE_PL2303 },
 262         /* Sitecom USB to Serial */
 263         { USB_VENDOR_MCT, USB_PRODUCT_MCT_SITECOM_USB232, -1, TYPE_PL2303 },
 264         /* Tripp-Lite U209-000-R */
 265         { USB_VENDOR_TRIPPLITE, USB_PRODUCT_TRIPPLITE_U209, -1, TYPE_PL2303X },
 266         { 0, 0 }
 267 };
 268
 269 static device_probe_t uplcom_match;
 270 static device_attach_t uplcom_attach;
 271 static device_detach_t uplcom_detach;
 272
 273 static device_method_t uplcom_methods[] = {
 274         /* Device interface */
 275         DEVMETHOD(device_probe, uplcom_match),
 276         DEVMETHOD(device_attach, uplcom_attach),
 277         DEVMETHOD(device_detach, uplcom_detach),
 278         { 0, 0 }
 279 };
 280
 281 static driver_t uplcom_driver = {
 282         "ucom",
 283         uplcom_methods,
 284         sizeof (struct uplcom_softc)
 285 };
 286
 287 DRIVER_MODULE(uplcom, uhub, uplcom_driver, ucom_devclass, usbd_driver_load, 0);
 288 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
 289 MODULE_DEPEND(uplcom, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
 290 MODULE_VERSION(uplcom, UPLCOM_MODVER);
 291
 292 static int      uplcominterval = UPLCOM_INTR_INTERVAL;
 293
 294 static int
 295 sysctl_hw_usb_uplcom_interval(SYSCTL_HANDLER_ARGS)
 296 {
 297         int err, val;
 298
 299         val = uplcominterval;
 300         err = sysctl_handle_int(oidp, &val, sizeof(val), req);
 301         if (err != 0 || req->newptr == NULL)
 302                 return (err);
 303         if (0 < val && val <= 1000)
 304                 uplcominterval = val;
 305         else
 306                 err = EINVAL;
 307
 308         return (err);
 309 }
 310
 311 SYSCTL_PROC(_hw_usb_uplcom, OID_AUTO, interval, CTLTYPE_INT | CTLFLAG_RW,
 312             0, sizeof(int), sysctl_hw_usb_uplcom_interval,
 313             "I", "uplcom interrupt pipe interval");
 314
 315 static int
 316 uplcom_match(device_t self)
 317 {
 318         struct usb_attach_arg *uaa = device_get_ivars(self);
 319         int i;
 320
 321         if (uaa->iface != NULL)
 322                 return (UMATCH_NONE);
 323
 324         for (i = 0; uplcom_products[i].vendor != 0; i++) {
 325                 if (uplcom_products[i].vendor == uaa->vendor &&
 326                     uplcom_products[i].product == uaa->product &&
 327                     (uplcom_products[i].release <= uaa->release ||
 328                      uplcom_products[i].release == -1)) {
 329                         return (UMATCH_VENDOR_PRODUCT);
 330                 }
 331         }
 332         return (UMATCH_NONE);
 333 }
 334
 335 static int
 336 uplcom_attach(device_t self)
 337 {
 338         struct uplcom_softc *sc = device_get_softc(self);
 339         struct usb_attach_arg *uaa = device_get_ivars(self);
 340         usbd_device_handle dev = uaa->device;
 341         struct ucom_softc *ucom;
 342         usb_config_descriptor_t *cdesc;
 343         usb_interface_descriptor_t *id;
 344         usb_endpoint_descriptor_t *ed;
 345         char *devinfo;
 346         const char *devname;
 347         usbd_status err;
 348         int i;
 349
 350         devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT);
 351         ucom = &sc->sc_ucom;
 352
 353         bzero(sc, sizeof (struct uplcom_softc));
 354
 355         usbd_devinfo(dev, 0, devinfo);
 356         ucom->sc_dev = self;
 357         device_set_desc_copy(self, devinfo);
 358
 359         ucom->sc_udev = dev;
 360         ucom->sc_iface = uaa->iface;
 361
 362         devname = device_get_nameunit(ucom->sc_dev);
 363         kprintf("%s: %s\n", devname, devinfo);
 364
 365         DPRINTF(("uplcom attach: sc = %p\n", sc));
 366
 367         /* determine chip type */
 368         for (i = 0; uplcom_products[i].vendor != 0; i++) {
 369                 if (uplcom_products[i].vendor == uaa->vendor &&
 370                     uplcom_products[i].product == uaa->product &&
 371                     (uplcom_products[i].release == uaa->release ||
 372                      uplcom_products[i].release == -1)) {
 373                         sc->sc_chiptype = uplcom_products[i].chiptype;
 374                         break;
 375                 }
 376         }
 377
 378         /*
 379          * check we found the device - attach should have ensured we
 380          * don't get here without matching device
 381          */
 382         if (uplcom_products[i].vendor == 0) {
 383                 kprintf("%s: didn't match\n", devname);
 384                 ucom->sc_dying = 1;
 385                 goto error;
 386         }
 387
 388 #ifdef USB_DEBUG
 389         /* print the chip type */
 390         if (sc->sc_chiptype == TYPE_PL2303X) {
 391                 DPRINTF(("uplcom_attach: chiptype 2303X\n"));
 392         } else {
 393                 DPRINTF(("uplcom_attach: chiptype 2303\n"));
 394         }
 395 #endif
 396
 397         /* initialize endpoints */
 398         ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
 399         sc->sc_intr_number = -1;
 400         sc->sc_intr_pipe = NULL;
 401
 402         /* Move the device into the configured state. */
 403         err = usbd_set_config_index(dev, UPLCOM_CONFIG_INDEX, 1);
 404         if (err) {
 405                 kprintf("%s: failed to set configuration: %s\n",
 406                         devname, usbd_errstr(err));
 407                 ucom->sc_dying = 1;
 408                 goto error;
 409         }
 410
 411         /* get the config descriptor */
 412         cdesc = usbd_get_config_descriptor(ucom->sc_udev);
 413
 414         if (cdesc == NULL) {
 415                 kprintf("%s: failed to get configuration descriptor\n",
 416                         device_get_nameunit(ucom->sc_dev));
 417                 ucom->sc_dying = 1;
 418                 goto error;
 419         }
 420
 421         /* get the (first/common) interface */
 422         err = usbd_device2interface_handle(dev, UPLCOM_IFACE_INDEX,
 423                                            &ucom->sc_iface);
 424         if (err) {
 425                 kprintf("%s: failed to get interface: %s\n",
 426                         devname, usbd_errstr(err));
 427                 ucom->sc_dying = 1;
 428                 goto error;
 429         }
 430
 431         /* Find the interrupt endpoints */
 432
 433         id = usbd_get_interface_descriptor(ucom->sc_iface);
 434         sc->sc_iface_number = id->bInterfaceNumber;
 435
 436         for (i = 0; i < id->bNumEndpoints; i++) {
 437                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 438                 if (ed == NULL) {
 439                         kprintf("%s: no endpoint descriptor for %d\n",
 440                                 device_get_nameunit(ucom->sc_dev), i);
 441                         ucom->sc_dying = 1;
 442                         goto error;
 443                 }
 444
 445                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 446                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
 447                         sc->sc_intr_number = ed->bEndpointAddress;
 448                         sc->sc_isize = UGETW(ed->wMaxPacketSize);
 449                 }
 450         }
 451
 452         if (sc->sc_intr_number == -1) {
 453                 kprintf("%s: Could not find interrupt in\n",
 454                         device_get_nameunit(ucom->sc_dev));
 455                 ucom->sc_dying = 1;
 456                 goto error;
 457         }
 458
 459         /* keep interface for interrupt */
 460         sc->sc_intr_iface = ucom->sc_iface;
 461
 462         /*
 463          * USB-RSAQ1 has two interface
 464          *
 465          *  USB-RSAQ1       | USB-RSAQ2
 466          * -----------------+-----------------
 467          * Interface 0      |Interface 0
 468          *  Interrupt(0x81) | Interrupt(0x81)
 469          * -----------------+ BulkIN(0x02)
 470          * Interface 1      | BulkOUT(0x83)
 471          *   BulkIN(0x02)   |
 472          *   BulkOUT(0x83)  |
 473          */
 474         if (cdesc->bNumInterface == 2) {
 475                 err = usbd_device2interface_handle(dev,
 476                                                    UPLCOM_SECOND_IFACE_INDEX,
 477                                                    &ucom->sc_iface);
 478                 if (err) {
 479                         kprintf("%s: failed to get second interface: %s\n",
 480                                 devname, usbd_errstr(err));
 481                         ucom->sc_dying = 1;
 482                         goto error;
 483                 }
 484         }
 485
 486         /* Find the bulk{in,out} endpoints */
 487
 488         id = usbd_get_interface_descriptor(ucom->sc_iface);
 489         sc->sc_iface_number = id->bInterfaceNumber;
 490
 491         for (i = 0; i < id->bNumEndpoints; i++) {
 492                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 493                 if (ed == NULL) {
 494                         kprintf("%s: no endpoint descriptor for %d\n",
 495                                 device_get_nameunit(ucom->sc_dev), i);
 496                         ucom->sc_dying = 1;
 497                         goto error;
 498                 }
 499
 500                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 501                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 502                         ucom->sc_bulkin_no = ed->bEndpointAddress;
 503                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
 504                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
 505                         ucom->sc_bulkout_no = ed->bEndpointAddress;
 506                 }
 507         }
 508
 509         if (ucom->sc_bulkin_no == -1) {
 510                 kprintf("%s: Could not find data bulk in\n",
 511                         device_get_nameunit(ucom->sc_dev));
 512                 ucom->sc_dying = 1;
 513                 goto error;
 514         }
 515
 516         if (ucom->sc_bulkout_no == -1) {
 517                 kprintf("%s: Could not find data bulk out\n",
 518                         device_get_nameunit(ucom->sc_dev));
 519                 ucom->sc_dying = 1;
 520                 goto error;
 521         }
 522
 523         sc->sc_dtr = sc->sc_rts = -1;
 524         ucom->sc_parent = sc;
 525         ucom->sc_portno = UCOM_UNK_PORTNO;
 526         /* bulkin, bulkout set above */
 527         ucom->sc_ibufsize = UPLCOMIBUFSIZE;
 528         ucom->sc_obufsize = UPLCOMOBUFSIZE;
 529         ucom->sc_ibufsizepad = UPLCOMIBUFSIZE;
 530         ucom->sc_opkthdrlen = 0;
 531         ucom->sc_callback = &uplcom_callback;
 532
 533         err = uplcom_reset(sc);
 534
 535         if (err) {
 536                 kprintf("%s: reset failed: %s\n",
 537                        device_get_nameunit(ucom->sc_dev), usbd_errstr(err));
 538                 ucom->sc_dying = 1;
 539                 goto error;
 540         }
 541
 542         DPRINTF(("uplcom: in = 0x%x, out = 0x%x, intr = 0x%x\n",
 543                  ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
 544
 545         TASK_INIT(&sc->sc_task, 0, uplcom_notify, sc);
 546         ucom_attach(&sc->sc_ucom);
 547
 548         kfree(devinfo, M_USBDEV);
 549         return 0;
 550
 551 error:
 552         kfree(devinfo, M_USBDEV);
 553         return ENXIO;
 554 }
 555
 556 static int
 557 uplcom_detach(device_t self)
 558 {
 559         struct uplcom_softc *sc = device_get_softc(self);
 560         int rv = 0;
 561
 562         DPRINTF(("uplcom_detach: sc = %p\n", sc));
 563
 564         if (sc->sc_intr_pipe != NULL) {
 565                 usbd_abort_pipe(sc->sc_intr_pipe);
 566                 usbd_close_pipe(sc->sc_intr_pipe);
 567                 kfree(sc->sc_intr_buf, M_USBDEV);
 568                 sc->sc_intr_pipe = NULL;
 569         }
 570
 571         sc->sc_ucom.sc_dying = 1;
 572
 573         rv = ucom_detach(&sc->sc_ucom);
 574
 575         return (rv);
 576 }
 577
 578 static usbd_status
 579 uplcom_reset(struct uplcom_softc *sc)
 580 {
 581         usb_device_request_t req;
 582         usbd_status err;
 583
 584         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 585         req.bRequest = UPLCOM_SET_REQUEST;
 586         USETW(req.wValue, 0);
 587         USETW(req.wIndex, sc->sc_iface_number);
 588         USETW(req.wLength, 0);
 589
 590         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 591         if (err) {
 592                 kprintf("%s: uplcom_reset: %s\n",
 593                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 594                 return (EIO);
 595         }
 596
 597         return (0);
 598 }
 599
 600 struct pl2303x_init {
 601         uint8_t         req_type;
 602         uint8_t         request;
 603         uint16_t        value;
 604         uint16_t        index;
 605         uint16_t        length;
 606 };
 607
 608 static const struct pl2303x_init pl2303x[] = {
 609         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 610         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404,    0, 0 },
 611         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 612         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8383,    0, 0 },
 613         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 614         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404,    1, 0 },
 615         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8484,    0, 0 },
 616         { UT_READ_VENDOR_DEVICE,  UPLCOM_SET_REQUEST, 0x8383,    0, 0 },
 617         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      0,    1, 0 },
 618         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      1,    0, 0 },
 619         { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST,      2, 0x44, 0 }
 620 };
 621 #define N_PL2302X_INIT  (sizeof(pl2303x)/sizeof(pl2303x[0]))
 622
 623 static usbd_status
 624 uplcom_pl2303x_init(struct uplcom_softc *sc)
 625 {
 626         usb_device_request_t req;
 627         usbd_status err;
 628         int i;
 629
 630         for (i = 0; i < N_PL2302X_INIT; i++) {
 631                 req.bmRequestType = pl2303x[i].req_type;
 632                 req.bRequest = pl2303x[i].request;
 633                 USETW(req.wValue, pl2303x[i].value);
 634                 USETW(req.wIndex, pl2303x[i].index);
 635                 USETW(req.wLength, pl2303x[i].length);
 636
 637                 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 638                 if (err) {
 639                         kprintf("%s: uplcom_pl2303x_init: %d: %s\n",
 640                                 device_get_nameunit(sc->sc_ucom.sc_dev), i,
 641                                 usbd_errstr(err));
 642                         return (EIO);
 643                 }
 644         }
 645
 646         return (0);
 647 }
 648
 649 static void
 650 uplcom_set_line_state(struct uplcom_softc *sc)
 651 {
 652         usb_device_request_t req;
 653         int ls;
 654         usbd_status err;
 655
 656         ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
 657                 (sc->sc_rts ? UCDC_LINE_RTS : 0);
 658         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 659         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
 660         USETW(req.wValue, ls);
 661         USETW(req.wIndex, sc->sc_iface_number);
 662         USETW(req.wLength, 0);
 663
 664         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 665         if (err)
 666                 kprintf("%s: uplcom_set_line_status: %s\n",
 667                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 668 }
 669
 670 static void
 671 uplcom_set(void *addr, int portno, int reg, int onoff)
 672 {
 673         struct uplcom_softc *sc = addr;
 674
 675         switch (reg) {
 676         case UCOM_SET_DTR:
 677                 uplcom_dtr(sc, onoff);
 678                 break;
 679         case UCOM_SET_RTS:
 680                 uplcom_rts(sc, onoff);
 681                 break;
 682         case UCOM_SET_BREAK:
 683                 uplcom_break(sc, onoff);
 684                 break;
 685         default:
 686                 break;
 687         }
 688 }
 689
 690 static void
 691 uplcom_dtr(struct uplcom_softc *sc, int onoff)
 692 {
 693         DPRINTF(("uplcom_dtr: onoff = %d\n", onoff));
 694
 695         if (sc->sc_dtr == onoff)
 696                 return;
 697         sc->sc_dtr = onoff;
 698
 699         uplcom_set_line_state(sc);
 700 }
 701
 702 static void
 703 uplcom_rts(struct uplcom_softc *sc, int onoff)
 704 {
 705         DPRINTF(("uplcom_rts: onoff = %d\n", onoff));
 706
 707         if (sc->sc_rts == onoff)
 708                 return;
 709         sc->sc_rts = onoff;
 710
 711         uplcom_set_line_state(sc);
 712 }
 713
 714 static void
 715 uplcom_break(struct uplcom_softc *sc, int onoff)
 716 {
 717         usb_device_request_t req;
 718         usbd_status err;
 719
 720         DPRINTF(("uplcom_break: onoff = %d\n", onoff));
 721
 722         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 723         req.bRequest = UCDC_SEND_BREAK;
 724         USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
 725         USETW(req.wIndex, sc->sc_iface_number);
 726         USETW(req.wLength, 0);
 727
 728         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 729         if (err)
 730                 kprintf("%s: uplcom_break: %s\n",
 731                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 732 }
 733
 734 static usbd_status
 735 uplcom_set_crtscts(struct uplcom_softc *sc)
 736 {
 737         usb_device_request_t req;
 738         usbd_status err;
 739
 740         DPRINTF(("uplcom_set_crtscts: on\n"));
 741
 742         req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
 743         req.bRequest = UPLCOM_SET_REQUEST;
 744         USETW(req.wValue, 0);
 745         if (sc->sc_chiptype == TYPE_PL2303X)
 746                 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
 747         else
 748                 USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
 749         USETW(req.wLength, 0);
 750
 751         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
 752         if (err) {
 753                 kprintf("%s: uplcom_set_crtscts: %s\n",
 754                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 755                 return (err);
 756         }
 757
 758         return (USBD_NORMAL_COMPLETION);
 759 }
 760
 761 static usbd_status
 762 uplcom_set_line_coding(struct uplcom_softc *sc, usb_cdc_line_state_t *state)
 763 {
 764         usb_device_request_t req;
 765         usbd_status err;
 766
 767         DPRINTF((
 768 "uplcom_set_line_coding: rate = %d, fmt = %d, parity = %d bits = %d\n",
 769                  UGETDW(state->dwDTERate), state->bCharFormat,
 770                  state->bParityType, state->bDataBits));
 771
 772         if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
 773                 DPRINTF(("uplcom_set_line_coding: already set\n"));
 774                 return (USBD_NORMAL_COMPLETION);
 775         }
 776
 777         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
 778         req.bRequest = UCDC_SET_LINE_CODING;
 779         USETW(req.wValue, 0);
 780         USETW(req.wIndex, sc->sc_iface_number);
 781         USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
 782
 783         err = usbd_do_request(sc->sc_ucom.sc_udev, &req, state);
 784         if (err) {
 785                 kprintf("%s: uplcom_set_line_coding: %s\n",
 786                        device_get_nameunit(sc->sc_ucom.sc_dev), usbd_errstr(err));
 787                 return (err);
 788         }
 789
 790         sc->sc_line_state = *state;
 791
 792         return (USBD_NORMAL_COMPLETION);
 793 }
 794
 795 static const int uplcom_rates[] = {
 796         75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
 797         19200, 28800, 38400, 57600, 115200,
 798         /*
 799          * Higher speeds are probably possible. PL2303X supports up to
 800          * 6Mb and can set any rate
 801          */
 802         230400, 460800, 614400, 921600, 1228800
 803 };
 804 #define N_UPLCOM_RATES  (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
 805
 806 static int
 807 uplcom_param(void *addr, int portno, struct termios *t)
 808 {
 809         struct uplcom_softc *sc = addr;
 810         usbd_status err;
 811         usb_cdc_line_state_t ls;
 812         int i;
 813
 814         DPRINTF(("uplcom_param: sc = %p\n", sc));
 815
 816         /* Check requested baud rate */
 817         for (i = 0; i < N_UPLCOM_RATES; i++)
 818                 if (uplcom_rates[i] == t->c_ospeed)
 819                         break;
 820         if (i == N_UPLCOM_RATES) {
 821                 DPRINTF(("uplcom_param: bad baud rate (%d)\n", t->c_ospeed));
 822                 return (EIO);
 823         }
 824
 825         USETDW(ls.dwDTERate, t->c_ospeed);
 826         if (ISSET(t->c_cflag, CSTOPB))
 827                 ls.bCharFormat = UCDC_STOP_BIT_2;
 828         else
 829                 ls.bCharFormat = UCDC_STOP_BIT_1;
 830         if (ISSET(t->c_cflag, PARENB)) {
 831                 if (ISSET(t->c_cflag, PARODD))
 832                         ls.bParityType = UCDC_PARITY_ODD;
 833                 else
 834                         ls.bParityType = UCDC_PARITY_EVEN;
 835         } else
 836                 ls.bParityType = UCDC_PARITY_NONE;
 837         switch (ISSET(t->c_cflag, CSIZE)) {
 838         case CS5:
 839                 ls.bDataBits = 5;
 840                 break;
 841         case CS6:
 842                 ls.bDataBits = 6;
 843                 break;
 844         case CS7:
 845                 ls.bDataBits = 7;
 846                 break;
 847         case CS8:
 848                 ls.bDataBits = 8;
 849                 break;
 850         }
 851
 852         err = uplcom_set_line_coding(sc, &ls);
 853         if (err)
 854                 return (EIO);
 855
 856         if (ISSET(t->c_cflag, CRTSCTS)) {
 857                 err = uplcom_set_crtscts(sc);
 858                 if (err)
 859                         return (EIO);
 860         }
 861
 862         return (0);
 863 }
 864
 865 static int
 866 uplcom_open(void *addr, int portno)
 867 {
 868         struct uplcom_softc *sc = addr;
 869         int err;
 870
 871         if (sc->sc_ucom.sc_dying)
 872                 return (ENXIO);
 873
 874         DPRINTF(("uplcom_open: sc = %p\n", sc));
 875
 876         if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
 877                 sc->sc_status = 0; /* clear status bit */
 878                 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
 879                 err = usbd_open_pipe_intr(sc->sc_intr_iface,
 880                                           sc->sc_intr_number,
 881                                           USBD_SHORT_XFER_OK,
 882                                           &sc->sc_intr_pipe,
 883                                           sc,
 884                                           sc->sc_intr_buf,
 885                                           sc->sc_isize,
 886                                           uplcom_intr,
 887                                           uplcominterval);
 888                 if (err) {
 889                         kprintf("%s: cannot open interrupt pipe (addr %d)\n",
 890                                device_get_nameunit(sc->sc_ucom.sc_dev),
 891                                sc->sc_intr_number);
 892                         return (EIO);
 893                 }
 894         }
 895
 896         if (sc->sc_chiptype == TYPE_PL2303X)
 897                 return (uplcom_pl2303x_init(sc));
 898
 899         return (0);
 900 }
 901
 902 static void
 903 uplcom_close(void *addr, int portno)
 904 {
 905         struct uplcom_softc *sc = addr;
 906         int err;
 907
 908         if (sc->sc_ucom.sc_dying)
 909                 return;
 910
 911         DPRINTF(("uplcom_close: close\n"));
 912
 913         if (sc->sc_intr_pipe != NULL) {
 914                 err = usbd_abort_pipe(sc->sc_intr_pipe);
 915                 if (err)
 916                         kprintf("%s: abort interrupt pipe failed: %s\n",
 917                                device_get_nameunit(sc->sc_ucom.sc_dev),
 918                                usbd_errstr(err));
 919                 err = usbd_close_pipe(sc->sc_intr_pipe);
 920                 if (err)
 921                         kprintf("%s: close interrupt pipe failed: %s\n",
 922                                device_get_nameunit(sc->sc_ucom.sc_dev),
 923                                usbd_errstr(err));
 924                 kfree(sc->sc_intr_buf, M_USBDEV);
 925                 sc->sc_intr_pipe = NULL;
 926         }
 927 }
 928
 929 static void
 930 uplcom_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
 931 {
 932         struct uplcom_softc *sc = priv;
 933         u_char *buf = sc->sc_intr_buf;
 934         u_char pstatus;
 935
 936         if (sc->sc_ucom.sc_dying)
 937                 return;
 938
 939         if (status != USBD_NORMAL_COMPLETION) {
 940                 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
 941                         return;
 942
 943                 DPRINTF(("%s: uplcom_intr: abnormal status: %s\n",
 944                         device_get_nameunit(sc->sc_ucom.sc_dev),
 945                         usbd_errstr(status)));
 946                 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
 947                 return;
 948         }
 949
 950         DPRINTF(("%s: uplcom status = %02x\n",
 951                  device_get_nameunit(sc->sc_ucom.sc_dev), buf[8]));
 952
 953         sc->sc_lsr = sc->sc_msr = 0;
 954         pstatus = buf[8];
 955         if (ISSET(pstatus, RSAQ_STATUS_CTS))
 956                 sc->sc_msr |= UMSR_CTS;
 957         else
 958                 sc->sc_msr &= ~UMSR_CTS;
 959         if (ISSET(pstatus, RSAQ_STATUS_DSR))
 960                 sc->sc_msr |= UMSR_DSR;
 961         else
 962                 sc->sc_msr &= ~UMSR_DSR;
 963         if (ISSET(pstatus, RSAQ_STATUS_DCD))
 964                 sc->sc_msr |= UMSR_DCD;
 965         else
 966                 sc->sc_msr &= ~UMSR_DCD;
 967
 968         /* Deferred notifying to the ucom layer */
 969         taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
 970 }
 971
 972 static void
 973 uplcom_notify(void *arg, int count)
 974 {
 975         struct uplcom_softc *sc;
 976
 977         sc = (struct uplcom_softc *)arg;
 978         if (sc->sc_ucom.sc_dying)
 979                 return;
 980         ucom_status_change(&sc->sc_ucom);
 981 }
 982
 983 static void
 984 uplcom_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
 985 {
 986         struct uplcom_softc *sc = addr;
 987
 988         DPRINTF(("uplcom_get_status:\n"));
 989
 990         if (lsr != NULL)
 991                 *lsr = sc->sc_lsr;
 992         if (msr != NULL)
 993                 *msr = sc->sc_msr;
 994 }
 995
 996 #if 0 /* TODO */
 997 static int
 998 uplcom_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag,
 999              struct thread *p)
1000 {
1001         struct uplcom_softc *sc = addr;
1002         int error = 0;
1003
1004         if (sc->sc_ucom.sc_dying)
1005                 return (EIO);
1006
1007         DPRINTF(("uplcom_ioctl: cmd = 0x%08lx\n", cmd));
1008
1009         switch (cmd) {
1010         case TIOCNOTTY:
1011         case TIOCMGET:
1012         case TIOCMSET:
1013         case USB_GET_CM_OVER_DATA:
1014         case USB_SET_CM_OVER_DATA:
1015                 break;
1016
1017         default:
1018                 DPRINTF(("uplcom_ioctl: unknown\n"));
1019                 error = ENOTTY;
1020                 break;
1021         }
1022
1023         return (error);
1024 }
1025 #endif