sys/dev/usb/serial/uslcom.c

   1 /*      $OpenBSD: uslcom.c,v 1.17 2007/11/24 10:52:12 jsg Exp $ */
   2
   3 #include <sys/cdefs.h>
   4 __FBSDID("$FreeBSD$");
   5
   6 /*
   7  * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
   8  *
   9  * Permission to use, copy, modify, and distribute this software for any
  10  * purpose with or without fee is hereby granted, provided that the above
  11  * copyright notice and this permission notice appear in all copies.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  14  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  15  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  16  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  17  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  18  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  19  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  20  */
  21
  22 /*
  23  * Driver for Silicon Laboratories CP2101/CP2102/CP2103/CP2104/CP2105
  24  * USB-Serial adapters.  Based on datasheet AN571, publicly available from
  25  * http://www.silabs.com/Support%20Documents/TechnicalDocs/AN571.pdf
  26  */
  27
  28 #include <sys/stdint.h>
  29 #include <sys/stddef.h>
  30 #include <sys/param.h>
  31 #include <sys/queue.h>
  32 #include <sys/types.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/bus.h>
  36 #include <sys/module.h>
  37 #include <sys/lock.h>
  38 #include <sys/mutex.h>
  39 #include <sys/condvar.h>
  40 #include <sys/sysctl.h>
  41 #include <sys/sx.h>
  42 #include <sys/unistd.h>
  43 #include <sys/callout.h>
  44 #include <sys/malloc.h>
  45 #include <sys/priv.h>
  46
  47 #include <dev/usb/usb.h>
  48 #include <dev/usb/usbdi.h>
  49 #include <dev/usb/usbdi_util.h>
  50 #include <dev/usb/usb_ioctl.h>
  51 #include "usbdevs.h"
  52
  53 #define USB_DEBUG_VAR uslcom_debug
  54 #include <dev/usb/usb_debug.h>
  55 #include <dev/usb/usb_process.h>
  56
  57 #include <dev/usb/serial/usb_serial.h>
  58
  59 #ifdef USB_DEBUG
  60 static int uslcom_debug = 0;
  61
  62 static SYSCTL_NODE(_hw_usb, OID_AUTO, uslcom, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
  63     "USB uslcom");
  64 SYSCTL_INT(_hw_usb_uslcom, OID_AUTO, debug, CTLFLAG_RWTUN,
  65     &uslcom_debug, 0, "Debug level");
  66 #endif
  67
  68 #define USLCOM_BULK_BUF_SIZE    1024
  69 #define USLCOM_CONFIG_INDEX     0
  70
  71 /* Request types */
  72 #define USLCOM_WRITE            0x41
  73 #define USLCOM_READ             0xc1
  74
  75 /* Request codes */
  76 #define USLCOM_IFC_ENABLE       0x00
  77 #define USLCOM_SET_BAUDDIV      0x01
  78 #define USLCOM_SET_LINE_CTL     0x03
  79 #define USLCOM_SET_BREAK        0x05
  80 #define USLCOM_SET_MHS          0x07
  81 #define USLCOM_GET_MDMSTS       0x08
  82 #define USLCOM_SET_FLOW         0x13
  83 #define USLCOM_SET_BAUDRATE     0x1e
  84 #define USLCOM_VENDOR_SPECIFIC  0xff
  85
  86 /* USLCOM_IFC_ENABLE values */
  87 #define USLCOM_IFC_ENABLE_DIS   0x00
  88 #define USLCOM_IFC_ENABLE_EN    0x01
  89
  90 /* USLCOM_SET_MHS/USLCOM_GET_MDMSTS values */
  91 #define USLCOM_MHS_DTR_ON       0x0001
  92 #define USLCOM_MHS_DTR_SET      0x0100
  93 #define USLCOM_MHS_RTS_ON       0x0002
  94 #define USLCOM_MHS_RTS_SET      0x0200
  95 #define USLCOM_MHS_CTS          0x0010
  96 #define USLCOM_MHS_DSR          0x0020
  97 #define USLCOM_MHS_RI           0x0040
  98 #define USLCOM_MHS_DCD          0x0080
  99
 100 /* USLCOM_SET_BAUDDIV values */
 101 #define USLCOM_BAUDDIV_REF      3686400 /* 3.6864 MHz */
 102
 103 /* USLCOM_SET_LINE_CTL values */
 104 #define USLCOM_STOP_BITS_1      0x00
 105 #define USLCOM_STOP_BITS_2      0x02
 106 #define USLCOM_PARITY_NONE      0x00
 107 #define USLCOM_PARITY_ODD       0x10
 108 #define USLCOM_PARITY_EVEN      0x20
 109 #define USLCOM_SET_DATA_BITS(x) ((x) << 8)
 110
 111 /* USLCOM_SET_BREAK values */
 112 #define USLCOM_SET_BREAK_OFF    0x00
 113 #define USLCOM_SET_BREAK_ON     0x01
 114
 115 /* USLCOM_SET_FLOW values - 1st word */
 116 #define USLCOM_FLOW_DTR_ON      0x00000001 /* DTR static active */
 117 #define USLCOM_FLOW_CTS_HS      0x00000008 /* CTS handshake */
 118 /* USLCOM_SET_FLOW values - 2nd word */
 119 #define USLCOM_FLOW_RTS_ON      0x00000040 /* RTS static active */
 120 #define USLCOM_FLOW_RTS_HS      0x00000080 /* RTS handshake */
 121
 122 /* USLCOM_VENDOR_SPECIFIC values */
 123 #define USLCOM_GET_PARTNUM      0x370B
 124 #define USLCOM_WRITE_LATCH      0x37E1
 125 #define USLCOM_READ_LATCH       0x00C2
 126
 127 /* USLCOM_GET_PARTNUM values from hardware */
 128 #define USLCOM_PARTNUM_CP2101   1
 129 #define USLCOM_PARTNUM_CP2102   2
 130 #define USLCOM_PARTNUM_CP2103   3
 131 #define USLCOM_PARTNUM_CP2104   4
 132 #define USLCOM_PARTNUM_CP2105   5
 133
 134 enum {
 135         USLCOM_BULK_DT_WR,
 136         USLCOM_BULK_DT_RD,
 137         USLCOM_CTRL_DT_RD,
 138         USLCOM_N_TRANSFER,
 139 };
 140
 141 struct uslcom_softc {
 142         struct ucom_super_softc sc_super_ucom;
 143         struct ucom_softc sc_ucom;
 144         struct usb_callout sc_watchdog;
 145
 146         struct usb_xfer *sc_xfer[USLCOM_N_TRANSFER];
 147         struct usb_device *sc_udev;
 148         struct mtx sc_mtx;
 149
 150         uint8_t sc_msr;
 151         uint8_t sc_lsr;
 152         uint8_t sc_iface_no;
 153         uint8_t sc_partnum;
 154 };
 155
 156 static device_probe_t uslcom_probe;
 157 static device_attach_t uslcom_attach;
 158 static device_detach_t uslcom_detach;
 159 static void uslcom_free_softc(struct uslcom_softc *);
 160
 161 static usb_callback_t uslcom_write_callback;
 162 static usb_callback_t uslcom_read_callback;
 163 static usb_callback_t uslcom_control_callback;
 164
 165 static void uslcom_free(struct ucom_softc *);
 166 static uint8_t uslcom_get_partnum(struct uslcom_softc *);
 167 static void uslcom_cfg_open(struct ucom_softc *);
 168 static void uslcom_cfg_close(struct ucom_softc *);
 169 static void uslcom_cfg_set_dtr(struct ucom_softc *, uint8_t);
 170 static void uslcom_cfg_set_rts(struct ucom_softc *, uint8_t);
 171 static void uslcom_cfg_set_break(struct ucom_softc *, uint8_t);
 172 static void uslcom_cfg_param(struct ucom_softc *, struct termios *);
 173 static void uslcom_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
 174 static int uslcom_ioctl(struct ucom_softc *, uint32_t, caddr_t, int,
 175     struct thread *);
 176 static int uslcom_pre_param(struct ucom_softc *, struct termios *);
 177 static void uslcom_start_read(struct ucom_softc *);
 178 static void uslcom_stop_read(struct ucom_softc *);
 179 static void uslcom_start_write(struct ucom_softc *);
 180 static void uslcom_stop_write(struct ucom_softc *);
 181 static void uslcom_poll(struct ucom_softc *ucom);
 182
 183 static const struct usb_config uslcom_config[USLCOM_N_TRANSFER] = {
 184         [USLCOM_BULK_DT_WR] = {
 185                 .type = UE_BULK,
 186                 .endpoint = UE_ADDR_ANY,
 187                 .direction = UE_DIR_OUT,
 188                 .bufsize = USLCOM_BULK_BUF_SIZE,
 189                .flags = {.pipe_bof = 1,},
 190                 .callback = &uslcom_write_callback,
 191         },
 192
 193         [USLCOM_BULK_DT_RD] = {
 194                 .type = UE_BULK,
 195                 .endpoint = UE_ADDR_ANY,
 196                 .direction = UE_DIR_IN,
 197                 .bufsize = USLCOM_BULK_BUF_SIZE,
 198                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 199                 .callback = &uslcom_read_callback,
 200         },
 201         [USLCOM_CTRL_DT_RD] = {
 202                 .type = UE_CONTROL,
 203                 .endpoint = 0x00,
 204                 .direction = UE_DIR_ANY,
 205                 .bufsize = sizeof(struct usb_device_request) + 8,
 206                 .flags = {.pipe_bof = 1,},
 207                 .callback = &uslcom_control_callback,
 208                 .timeout = 1000,        /* 1 second timeout */
 209         },
 210 };
 211
 212 static struct ucom_callback uslcom_callback = {
 213         .ucom_cfg_get_status = &uslcom_cfg_get_status,
 214         .ucom_cfg_set_dtr = &uslcom_cfg_set_dtr,
 215         .ucom_cfg_set_rts = &uslcom_cfg_set_rts,
 216         .ucom_cfg_set_break = &uslcom_cfg_set_break,
 217         .ucom_cfg_open = &uslcom_cfg_open,
 218         .ucom_cfg_close = &uslcom_cfg_close,
 219         .ucom_cfg_param = &uslcom_cfg_param,
 220         .ucom_pre_param = &uslcom_pre_param,
 221         .ucom_ioctl = &uslcom_ioctl,
 222         .ucom_start_read = &uslcom_start_read,
 223         .ucom_stop_read = &uslcom_stop_read,
 224         .ucom_start_write = &uslcom_start_write,
 225         .ucom_stop_write = &uslcom_stop_write,
 226         .ucom_poll = &uslcom_poll,
 227         .ucom_free = &uslcom_free,
 228 };
 229
 230 static const STRUCT_USB_HOST_ID uslcom_devs[] = {
 231 #define USLCOM_DEV(v,p)  { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
 232     USLCOM_DEV(BALTECH, CARDREADER),
 233     USLCOM_DEV(CLIPSAL, 5000CT2),
 234     USLCOM_DEV(CLIPSAL, 5500PACA),
 235     USLCOM_DEV(CLIPSAL, 5500PCU),
 236     USLCOM_DEV(CLIPSAL, 560884),
 237     USLCOM_DEV(CLIPSAL, 5800PC),
 238     USLCOM_DEV(CLIPSAL, C5000CT2),
 239     USLCOM_DEV(CLIPSAL, L51xx),
 240     USLCOM_DEV(DATAAPEX, MULTICOM),
 241     USLCOM_DEV(DELL, DW700),
 242     USLCOM_DEV(DIGIANSWER, ZIGBEE802154),
 243     USLCOM_DEV(DYNASTREAM, ANTDEVBOARD),
 244     USLCOM_DEV(DYNASTREAM, ANTDEVBOARD2),
 245     USLCOM_DEV(DYNASTREAM, ANT2USB),
 246     USLCOM_DEV(ELV, USBI2C),
 247     USLCOM_DEV(FESTO, CMSP),
 248     USLCOM_DEV(FESTO, CPX_USB),
 249     USLCOM_DEV(FOXCONN, PIRELLI_DP_L10),
 250     USLCOM_DEV(FOXCONN, TCOM_TC_300),
 251     USLCOM_DEV(GEMALTO, PROXPU),
 252     USLCOM_DEV(JABLOTRON, PC60B),
 253     USLCOM_DEV(KAMSTRUP, OPTICALEYE),
 254     USLCOM_DEV(KAMSTRUP, MBUS_250D),
 255     USLCOM_DEV(LAKESHORE, 121),
 256     USLCOM_DEV(LAKESHORE, 218A),
 257     USLCOM_DEV(LAKESHORE, 219),
 258     USLCOM_DEV(LAKESHORE, 233),
 259     USLCOM_DEV(LAKESHORE, 235),
 260     USLCOM_DEV(LAKESHORE, 335),
 261     USLCOM_DEV(LAKESHORE, 336),
 262     USLCOM_DEV(LAKESHORE, 350),
 263     USLCOM_DEV(LAKESHORE, 371),
 264     USLCOM_DEV(LAKESHORE, 411),
 265     USLCOM_DEV(LAKESHORE, 425),
 266     USLCOM_DEV(LAKESHORE, 455A),
 267     USLCOM_DEV(LAKESHORE, 465),
 268     USLCOM_DEV(LAKESHORE, 475A),
 269     USLCOM_DEV(LAKESHORE, 625A),
 270     USLCOM_DEV(LAKESHORE, 642A),
 271     USLCOM_DEV(LAKESHORE, 648),
 272     USLCOM_DEV(LAKESHORE, 737),
 273     USLCOM_DEV(LAKESHORE, 776),
 274     USLCOM_DEV(LINKINSTRUMENTS, MSO19),
 275     USLCOM_DEV(LINKINSTRUMENTS, MSO28),
 276     USLCOM_DEV(LINKINSTRUMENTS, MSO28_2),
 277     USLCOM_DEV(MEI, CASHFLOW_SC),
 278     USLCOM_DEV(MEI, S2000),
 279     USLCOM_DEV(NETGEAR, M4100),
 280     USLCOM_DEV(OWEN, AC4),
 281     USLCOM_DEV(OWL, CM_160),
 282     USLCOM_DEV(PHILIPS, ACE1001),
 283     USLCOM_DEV(PLX, CA42),
 284     USLCOM_DEV(RENESAS, RX610),
 285     USLCOM_DEV(SEL, C662),
 286     USLCOM_DEV(SILABS, AC_SERV_CAN),
 287     USLCOM_DEV(SILABS, AC_SERV_CIS),
 288     USLCOM_DEV(SILABS, AC_SERV_IBUS),
 289     USLCOM_DEV(SILABS, AC_SERV_OBD),
 290     USLCOM_DEV(SILABS, AEROCOMM),
 291     USLCOM_DEV(SILABS, AMBER_AMB2560),
 292     USLCOM_DEV(SILABS, ARGUSISP),
 293     USLCOM_DEV(SILABS, ARKHAM_DS101_A),
 294     USLCOM_DEV(SILABS, ARKHAM_DS101_M),
 295     USLCOM_DEV(SILABS, ARYGON_MIFARE),
 296     USLCOM_DEV(SILABS, AVIT_USB_TTL),
 297     USLCOM_DEV(SILABS, B_G_H3000),
 298     USLCOM_DEV(SILABS, BALLUFF_RFID),
 299     USLCOM_DEV(SILABS, BEI_VCP),
 300     USLCOM_DEV(SILABS, BSM7DUSB),
 301     USLCOM_DEV(SILABS, BURNSIDE),
 302     USLCOM_DEV(SILABS, C2_EDGE_MODEM),
 303     USLCOM_DEV(SILABS, CP2102),
 304     USLCOM_DEV(SILABS, CP210X_2),
 305     USLCOM_DEV(SILABS, CP210X_3),
 306     USLCOM_DEV(SILABS, CP210X_4),
 307     USLCOM_DEV(SILABS, CRUMB128),
 308     USLCOM_DEV(SILABS, CYGNAL),
 309     USLCOM_DEV(SILABS, CYGNAL_DEBUG),
 310     USLCOM_DEV(SILABS, CYGNAL_GPS),
 311     USLCOM_DEV(SILABS, DEGREE),
 312     USLCOM_DEV(SILABS, DEKTEK_DTAPLUS),
 313     USLCOM_DEV(SILABS, EMS_C1007),
 314     USLCOM_DEV(SILABS, HAMLINKUSB),
 315     USLCOM_DEV(SILABS, HELICOM),
 316     USLCOM_DEV(SILABS, HUBZ),
 317     USLCOM_DEV(SILABS, BV_AV2010_10),
 318     USLCOM_DEV(SILABS, IMS_USB_RS422),
 319     USLCOM_DEV(SILABS, INFINITY_MIC),
 320     USLCOM_DEV(SILABS, INGENI_ZIGBEE),
 321     USLCOM_DEV(SILABS, INSYS_MODEM),
 322     USLCOM_DEV(SILABS, IRZ_SG10),
 323     USLCOM_DEV(SILABS, KYOCERA_GPS),
 324     USLCOM_DEV(SILABS, LIPOWSKY_HARP),
 325     USLCOM_DEV(SILABS, LIPOWSKY_JTAG),
 326     USLCOM_DEV(SILABS, LIPOWSKY_LIN),
 327     USLCOM_DEV(SILABS, MC35PU),
 328     USLCOM_DEV(SILABS, MMB_ZIGBEE),
 329     USLCOM_DEV(SILABS, MJS_TOSLINK),
 330     USLCOM_DEV(SILABS, MSD_DASHHAWK),
 331     USLCOM_DEV(SILABS, MULTIPLEX_RC),
 332     USLCOM_DEV(SILABS, OPTRIS_MSPRO),
 333     USLCOM_DEV(SILABS, POLOLU),
 334     USLCOM_DEV(SILABS, PROCYON_AVS),
 335     USLCOM_DEV(SILABS, SB_PARAMOUNT_ME),
 336     USLCOM_DEV(SILABS, SUUNTO),
 337     USLCOM_DEV(SILABS, TAMSMASTER),
 338     USLCOM_DEV(SILABS, TELEGESIS_ETRX2),
 339     USLCOM_DEV(SILABS, TRACIENT),
 340     USLCOM_DEV(SILABS, TRAQMATE),
 341     USLCOM_DEV(SILABS, USBCOUNT50),
 342     USLCOM_DEV(SILABS, USBPULSE100),
 343     USLCOM_DEV(SILABS, USBSCOPE50),
 344     USLCOM_DEV(SILABS, USBWAVE12),
 345     USLCOM_DEV(SILABS, V_PREON32),
 346     USLCOM_DEV(SILABS, VSTABI),
 347     USLCOM_DEV(SILABS, WAVIT),
 348     USLCOM_DEV(SILABS, WMRBATT),
 349     USLCOM_DEV(SILABS, WMRRIGBLASTER),
 350     USLCOM_DEV(SILABS, WMRRIGTALK),
 351     USLCOM_DEV(SILABS, ZEPHYR_BIO),
 352     USLCOM_DEV(SILABS2, DCU11CLONE),
 353     USLCOM_DEV(SILABS3, GPRS_MODEM),
 354     USLCOM_DEV(SILABS4, 100EU_MODEM),
 355     USLCOM_DEV(SYNTECH, CYPHERLAB100),
 356     USLCOM_DEV(USI, MC60),
 357     USLCOM_DEV(VAISALA, CABLE),
 358     USLCOM_DEV(WAGO, SERVICECABLE),
 359     USLCOM_DEV(WAVESENSE, JAZZ),
 360     USLCOM_DEV(WESTMOUNTAIN, RIGBLASTER_ADVANTAGE),
 361     USLCOM_DEV(WIENERPLEINBAUS, PL512),
 362     USLCOM_DEV(WIENERPLEINBAUS, RCM),
 363     USLCOM_DEV(WIENERPLEINBAUS, MPOD),
 364     USLCOM_DEV(WIENERPLEINBAUS, CML),
 365 #undef USLCOM_DEV
 366 };
 367
 368 static device_method_t uslcom_methods[] = {
 369         DEVMETHOD(device_probe, uslcom_probe),
 370         DEVMETHOD(device_attach, uslcom_attach),
 371         DEVMETHOD(device_detach, uslcom_detach),
 372         DEVMETHOD_END
 373 };
 374
 375 static devclass_t uslcom_devclass;
 376
 377 static driver_t uslcom_driver = {
 378         .name = "uslcom",
 379         .methods = uslcom_methods,
 380         .size = sizeof(struct uslcom_softc),
 381 };
 382
 383 DRIVER_MODULE(uslcom, uhub, uslcom_driver, uslcom_devclass, NULL, 0);
 384 MODULE_DEPEND(uslcom, ucom, 1, 1, 1);
 385 MODULE_DEPEND(uslcom, usb, 1, 1, 1);
 386 MODULE_VERSION(uslcom, 1);
 387 USB_PNP_HOST_INFO(uslcom_devs);
 388
 389 static void
 390 uslcom_watchdog(void *arg)
 391 {
 392         struct uslcom_softc *sc = arg;
 393
 394         mtx_assert(&sc->sc_mtx, MA_OWNED);
 395
 396         usbd_transfer_start(sc->sc_xfer[USLCOM_CTRL_DT_RD]);
 397
 398         usb_callout_reset(&sc->sc_watchdog,
 399             hz / 4, &uslcom_watchdog, sc);
 400 }
 401
 402 static int
 403 uslcom_probe(device_t dev)
 404 {
 405         struct usb_attach_arg *uaa = device_get_ivars(dev);
 406
 407         DPRINTFN(11, "\n");
 408
 409         if (uaa->usb_mode != USB_MODE_HOST) {
 410                 return (ENXIO);
 411         }
 412         if (uaa->info.bConfigIndex != USLCOM_CONFIG_INDEX) {
 413                 return (ENXIO);
 414         }
 415         return (usbd_lookup_id_by_uaa(uslcom_devs, sizeof(uslcom_devs), uaa));
 416 }
 417
 418 static int
 419 uslcom_attach(device_t dev)
 420 {
 421         struct usb_attach_arg *uaa = device_get_ivars(dev);
 422         struct uslcom_softc *sc = device_get_softc(dev);
 423         int error;
 424
 425         DPRINTFN(11, "\n");
 426
 427         device_set_usb_desc(dev);
 428         mtx_init(&sc->sc_mtx, "uslcom", NULL, MTX_DEF);
 429         ucom_ref(&sc->sc_super_ucom);
 430         usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_mtx, 0);
 431
 432         sc->sc_udev = uaa->device;
 433         /* use the interface number from the USB interface descriptor */
 434         sc->sc_iface_no = uaa->info.bIfaceNum;
 435
 436         error = usbd_transfer_setup(uaa->device,
 437             &uaa->info.bIfaceIndex, sc->sc_xfer, uslcom_config,
 438             USLCOM_N_TRANSFER, sc, &sc->sc_mtx);
 439         if (error) {
 440                 DPRINTF("one or more missing USB endpoints, "
 441                     "error=%s\n", usbd_errstr(error));
 442                 goto detach;
 443         }
 444         /* clear stall at first run */
 445         mtx_lock(&sc->sc_mtx);
 446         usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_WR]);
 447         usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_RD]);
 448         mtx_unlock(&sc->sc_mtx);
 449
 450         sc->sc_partnum = uslcom_get_partnum(sc);
 451
 452         error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
 453             &uslcom_callback, &sc->sc_mtx);
 454         if (error) {
 455                 goto detach;
 456         }
 457         ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
 458
 459         return (0);
 460
 461 detach:
 462         uslcom_detach(dev);
 463         return (ENXIO);
 464 }
 465
 466 static int
 467 uslcom_detach(device_t dev)
 468 {
 469         struct uslcom_softc *sc = device_get_softc(dev);
 470
 471         DPRINTF("sc=%p\n", sc);
 472
 473         ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
 474         usbd_transfer_unsetup(sc->sc_xfer, USLCOM_N_TRANSFER);
 475
 476         usb_callout_drain(&sc->sc_watchdog);
 477
 478         device_claim_softc(dev);
 479
 480         uslcom_free_softc(sc);
 481
 482         return (0);
 483 }
 484
 485 UCOM_UNLOAD_DRAIN(uslcom);
 486
 487 static void
 488 uslcom_free_softc(struct uslcom_softc *sc)
 489 {
 490         if (ucom_unref(&sc->sc_super_ucom)) {
 491                 mtx_destroy(&sc->sc_mtx);
 492                 device_free_softc(sc);
 493         }
 494 }
 495
 496 static void
 497 uslcom_free(struct ucom_softc *ucom)
 498 {
 499         uslcom_free_softc(ucom->sc_parent);
 500 }
 501
 502 static void
 503 uslcom_cfg_open(struct ucom_softc *ucom)
 504 {
 505         struct uslcom_softc *sc = ucom->sc_parent;
 506         struct usb_device_request req;
 507
 508         req.bmRequestType = USLCOM_WRITE;
 509         req.bRequest = USLCOM_IFC_ENABLE;
 510         USETW(req.wValue, USLCOM_IFC_ENABLE_EN);
 511         USETW(req.wIndex, sc->sc_iface_no);
 512         USETW(req.wLength, 0);
 513
 514         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 515             &req, NULL, 0, 1000)) {
 516                 DPRINTF("UART enable failed (ignored)\n");
 517         }
 518
 519         /* start polling status */
 520         uslcom_watchdog(sc);
 521 }
 522
 523 static void
 524 uslcom_cfg_close(struct ucom_softc *ucom)
 525 {
 526         struct uslcom_softc *sc = ucom->sc_parent;
 527         struct usb_device_request req;
 528
 529         /* stop polling status */
 530         usb_callout_stop(&sc->sc_watchdog);
 531
 532         req.bmRequestType = USLCOM_WRITE;
 533         req.bRequest = USLCOM_IFC_ENABLE;
 534         USETW(req.wValue, USLCOM_IFC_ENABLE_DIS);
 535         USETW(req.wIndex, sc->sc_iface_no);
 536         USETW(req.wLength, 0);
 537
 538         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 539             &req, NULL, 0, 1000)) {
 540                 DPRINTF("UART disable failed (ignored)\n");
 541         }
 542 }
 543
 544 static uint8_t
 545 uslcom_get_partnum(struct uslcom_softc *sc)
 546 {
 547         struct usb_device_request req;
 548         uint8_t partnum;
 549
 550         /* Find specific chip type */
 551         partnum = 0;
 552         req.bmRequestType = USLCOM_READ;
 553         req.bRequest = USLCOM_VENDOR_SPECIFIC;
 554         USETW(req.wValue, USLCOM_GET_PARTNUM);
 555         USETW(req.wIndex, sc->sc_iface_no);
 556         USETW(req.wLength, sizeof(partnum));
 557
 558         if (usbd_do_request_flags(sc->sc_udev, NULL,
 559             &req, &partnum, 0, NULL, 1000)) {
 560                 DPRINTF("GET_PARTNUM failed\n");
 561         }
 562
 563         return(partnum);
 564 }
 565
 566 static void
 567 uslcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
 568 {
 569         struct uslcom_softc *sc = ucom->sc_parent;
 570         struct usb_device_request req;
 571         uint16_t ctl;
 572
 573         DPRINTF("onoff = %d\n", onoff);
 574
 575         ctl = onoff ? USLCOM_MHS_DTR_ON : 0;
 576         ctl |= USLCOM_MHS_DTR_SET;
 577
 578         req.bmRequestType = USLCOM_WRITE;
 579         req.bRequest = USLCOM_SET_MHS;
 580         USETW(req.wValue, ctl);
 581         USETW(req.wIndex, sc->sc_iface_no);
 582         USETW(req.wLength, 0);
 583
 584         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 585             &req, NULL, 0, 1000)) {
 586                 DPRINTF("Setting DTR failed (ignored)\n");
 587         }
 588 }
 589
 590 static void
 591 uslcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
 592 {
 593         struct uslcom_softc *sc = ucom->sc_parent;
 594         struct usb_device_request req;
 595         uint16_t ctl;
 596
 597         DPRINTF("onoff = %d\n", onoff);
 598
 599         ctl = onoff ? USLCOM_MHS_RTS_ON : 0;
 600         ctl |= USLCOM_MHS_RTS_SET;
 601
 602         req.bmRequestType = USLCOM_WRITE;
 603         req.bRequest = USLCOM_SET_MHS;
 604         USETW(req.wValue, ctl);
 605         USETW(req.wIndex, sc->sc_iface_no);
 606         USETW(req.wLength, 0);
 607
 608         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 609             &req, NULL, 0, 1000)) {
 610                 DPRINTF("Setting DTR failed (ignored)\n");
 611         }
 612 }
 613
 614 static int
 615 uslcom_pre_param(struct ucom_softc *ucom, struct termios *t)
 616 {
 617         struct uslcom_softc *sc = ucom->sc_parent;
 618         uint32_t maxspeed;
 619
 620         switch (sc->sc_partnum) {
 621         case USLCOM_PARTNUM_CP2104:
 622         case USLCOM_PARTNUM_CP2105:
 623                 maxspeed = 2000000;
 624                 break;
 625         case USLCOM_PARTNUM_CP2101:
 626         case USLCOM_PARTNUM_CP2102:
 627         case USLCOM_PARTNUM_CP2103:
 628         default:
 629                 /*
 630                  * Datasheet for cp2102 says 921600 max.  Testing shows that
 631                  * 1228800 and 1843200 work fine.
 632                  */
 633                 maxspeed = 1843200;
 634                 break;
 635         }
 636         if (t->c_ospeed <= 0 || t->c_ospeed > maxspeed)
 637                 return (EINVAL);
 638         return (0);
 639 }
 640
 641 static void
 642 uslcom_cfg_param(struct ucom_softc *ucom, struct termios *t)
 643 {
 644         struct uslcom_softc *sc = ucom->sc_parent;
 645         struct usb_device_request req;
 646         uint32_t baudrate, flowctrl[4];
 647         uint16_t data;
 648
 649         DPRINTF("\n");
 650
 651         baudrate = t->c_ospeed;
 652         req.bmRequestType = USLCOM_WRITE;
 653         req.bRequest = USLCOM_SET_BAUDRATE;
 654         USETW(req.wValue, 0);
 655         USETW(req.wIndex, sc->sc_iface_no);
 656         USETW(req.wLength, sizeof(baudrate));
 657
 658         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 659             &req, &baudrate, 0, 1000)) {
 660                 printf("Set baudrate failed (ignored)\n");
 661         }
 662
 663         if (t->c_cflag & CSTOPB)
 664                 data = USLCOM_STOP_BITS_2;
 665         else
 666                 data = USLCOM_STOP_BITS_1;
 667         if (t->c_cflag & PARENB) {
 668                 if (t->c_cflag & PARODD)
 669                         data |= USLCOM_PARITY_ODD;
 670                 else
 671                         data |= USLCOM_PARITY_EVEN;
 672         } else
 673                 data |= USLCOM_PARITY_NONE;
 674         switch (t->c_cflag & CSIZE) {
 675         case CS5:
 676                 data |= USLCOM_SET_DATA_BITS(5);
 677                 break;
 678         case CS6:
 679                 data |= USLCOM_SET_DATA_BITS(6);
 680                 break;
 681         case CS7:
 682                 data |= USLCOM_SET_DATA_BITS(7);
 683                 break;
 684         case CS8:
 685                 data |= USLCOM_SET_DATA_BITS(8);
 686                 break;
 687         }
 688
 689         req.bmRequestType = USLCOM_WRITE;
 690         req.bRequest = USLCOM_SET_LINE_CTL;
 691         USETW(req.wValue, data);
 692         USETW(req.wIndex, sc->sc_iface_no);
 693         USETW(req.wLength, 0);
 694
 695         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 696             &req, NULL, 0, 1000)) {
 697                 DPRINTF("Set format failed (ignored)\n");
 698         }
 699
 700         if (t->c_cflag & CRTSCTS) {
 701                 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON | USLCOM_FLOW_CTS_HS);
 702                 flowctrl[1] = htole32(USLCOM_FLOW_RTS_HS);
 703         } else {
 704                 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON);
 705                 flowctrl[1] = htole32(USLCOM_FLOW_RTS_ON);
 706         }
 707         flowctrl[2] = 0;
 708         flowctrl[3] = 0;
 709         req.bmRequestType = USLCOM_WRITE;
 710         req.bRequest = USLCOM_SET_FLOW;
 711         USETW(req.wValue, 0);
 712         USETW(req.wIndex, sc->sc_iface_no);
 713         USETW(req.wLength, sizeof(flowctrl));
 714
 715         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 716             &req, flowctrl, 0, 1000)) {
 717                 DPRINTF("Set flowcontrol failed (ignored)\n");
 718         }
 719 }
 720
 721 static void
 722 uslcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
 723 {
 724         struct uslcom_softc *sc = ucom->sc_parent;
 725
 726         DPRINTF("\n");
 727
 728         /* XXX Note: sc_lsr is always zero */
 729         *lsr = sc->sc_lsr;
 730         *msr = sc->sc_msr;
 731 }
 732
 733 static void
 734 uslcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
 735 {
 736         struct uslcom_softc *sc = ucom->sc_parent;
 737         struct usb_device_request req;
 738         uint16_t brk = onoff ? USLCOM_SET_BREAK_ON : USLCOM_SET_BREAK_OFF;
 739
 740         req.bmRequestType = USLCOM_WRITE;
 741         req.bRequest = USLCOM_SET_BREAK;
 742         USETW(req.wValue, brk);
 743         USETW(req.wIndex, sc->sc_iface_no);
 744         USETW(req.wLength, 0);
 745
 746         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 747             &req, NULL, 0, 1000)) {
 748                 DPRINTF("Set BREAK failed (ignored)\n");
 749         }
 750 }
 751
 752 static int
 753 uslcom_ioctl(struct ucom_softc *ucom, uint32_t cmd, caddr_t data,
 754     int flag, struct thread *td)
 755 {
 756         struct uslcom_softc *sc = ucom->sc_parent;
 757         struct usb_device_request req;
 758         int error = 0;
 759         uint8_t latch;
 760
 761         DPRINTF("cmd=0x%08x\n", cmd);
 762
 763         switch (cmd) {
 764         case USB_GET_GPIO:
 765                 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) {
 766                         error = ENODEV;
 767                         break;
 768                 }
 769                 req.bmRequestType = USLCOM_READ;
 770                 req.bRequest = USLCOM_VENDOR_SPECIFIC;
 771                 USETW(req.wValue, USLCOM_READ_LATCH);
 772                 USETW(req.wIndex, sc->sc_iface_no);
 773                 USETW(req.wLength, sizeof(latch));
 774
 775                 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 776                     &req, &latch, 0, 1000)) {
 777                         DPRINTF("Get LATCH failed\n");
 778                         error = EIO;
 779                 }
 780                 *(int *)data = latch;
 781                 break;
 782
 783         case USB_SET_GPIO:
 784                 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103)
 785                         error = ENODEV;
 786                 else if ((sc->sc_partnum == USLCOM_PARTNUM_CP2103) ||
 787                     (sc->sc_partnum == USLCOM_PARTNUM_CP2104)) {
 788                         req.bmRequestType = USLCOM_WRITE;
 789                         req.bRequest = USLCOM_VENDOR_SPECIFIC;
 790                         USETW(req.wValue, USLCOM_WRITE_LATCH);
 791                         USETW(req.wIndex, (*(int *)data));
 792                         USETW(req.wLength, 0);
 793
 794                         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
 795                             &req, NULL, 0, 1000)) {
 796                                 DPRINTF("Set LATCH failed\n");
 797                                 error = EIO;
 798                         }
 799                 } else
 800                         error = ENODEV; /* Not yet */
 801                 break;
 802
 803         default:
 804                 DPRINTF("Unknown IOCTL\n");
 805                 error = ENOIOCTL;
 806                 break;
 807         }
 808         return (error);
 809 }
 810
 811 static void
 812 uslcom_write_callback(struct usb_xfer *xfer, usb_error_t error)
 813 {
 814         struct uslcom_softc *sc = usbd_xfer_softc(xfer);
 815         struct usb_page_cache *pc;
 816         uint32_t actlen;
 817
 818         switch (USB_GET_STATE(xfer)) {
 819         case USB_ST_SETUP:
 820         case USB_ST_TRANSFERRED:
 821 tr_setup:
 822                 pc = usbd_xfer_get_frame(xfer, 0);
 823                 if (ucom_get_data(&sc->sc_ucom, pc, 0,
 824                     USLCOM_BULK_BUF_SIZE, &actlen)) {
 825
 826                         DPRINTF("actlen = %d\n", actlen);
 827
 828                         usbd_xfer_set_frame_len(xfer, 0, actlen);
 829                         usbd_transfer_submit(xfer);
 830                 }
 831                 return;
 832
 833         default:                        /* Error */
 834                 if (error != USB_ERR_CANCELLED) {
 835                         /* try to clear stall first */
 836                         usbd_xfer_set_stall(xfer);
 837                         goto tr_setup;
 838                 }
 839                 return;
 840         }
 841 }
 842
 843 static void
 844 uslcom_read_callback(struct usb_xfer *xfer, usb_error_t error)
 845 {
 846         struct uslcom_softc *sc = usbd_xfer_softc(xfer);
 847         struct usb_page_cache *pc;
 848         int actlen;
 849
 850         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 851
 852         switch (USB_GET_STATE(xfer)) {
 853         case USB_ST_TRANSFERRED:
 854                 pc = usbd_xfer_get_frame(xfer, 0);
 855                 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
 856
 857         case USB_ST_SETUP:
 858 tr_setup:
 859                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 860                 usbd_transfer_submit(xfer);
 861                 return;
 862
 863         default:                        /* Error */
 864                 if (error != USB_ERR_CANCELLED) {
 865                         /* try to clear stall first */
 866                         usbd_xfer_set_stall(xfer);
 867                         goto tr_setup;
 868                 }
 869                 return;
 870         }
 871 }
 872
 873 static void
 874 uslcom_control_callback(struct usb_xfer *xfer, usb_error_t error)
 875 {
 876         struct uslcom_softc *sc = usbd_xfer_softc(xfer);
 877         struct usb_page_cache *pc;
 878         struct usb_device_request req;
 879         uint8_t msr = 0;
 880         uint8_t buf;
 881
 882         switch (USB_GET_STATE(xfer)) {
 883         case USB_ST_TRANSFERRED:
 884                 pc = usbd_xfer_get_frame(xfer, 1);
 885                 usbd_copy_out(pc, 0, &buf, sizeof(buf));
 886                 if (buf & USLCOM_MHS_CTS)
 887                         msr |= SER_CTS;
 888                 if (buf & USLCOM_MHS_DSR)
 889                         msr |= SER_DSR;
 890                 if (buf & USLCOM_MHS_RI)
 891                         msr |= SER_RI;
 892                 if (buf & USLCOM_MHS_DCD)
 893                         msr |= SER_DCD;
 894
 895                 if (msr != sc->sc_msr) {
 896                         DPRINTF("status change msr=0x%02x "
 897                             "(was 0x%02x)\n", msr, sc->sc_msr);
 898                         sc->sc_msr = msr;
 899                         ucom_status_change(&sc->sc_ucom);
 900                 }
 901                 break;
 902
 903         case USB_ST_SETUP:
 904                 req.bmRequestType = USLCOM_READ;
 905                 req.bRequest = USLCOM_GET_MDMSTS;
 906                 USETW(req.wValue, 0);
 907                 USETW(req.wIndex, sc->sc_iface_no);
 908                 USETW(req.wLength, sizeof(buf));
 909
 910                 usbd_xfer_set_frames(xfer, 2);
 911                 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
 912                 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf));
 913
 914                 pc = usbd_xfer_get_frame(xfer, 0);
 915                 usbd_copy_in(pc, 0, &req, sizeof(req));
 916                 usbd_transfer_submit(xfer);
 917                 break;
 918
 919         default:                /* error */
 920                 if (error != USB_ERR_CANCELLED)
 921                         DPRINTF("error=%s\n", usbd_errstr(error));
 922                 break;
 923         }
 924 }
 925
 926 static void
 927 uslcom_start_read(struct ucom_softc *ucom)
 928 {
 929         struct uslcom_softc *sc = ucom->sc_parent;
 930
 931         /* start read endpoint */
 932         usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_RD]);
 933 }
 934
 935 static void
 936 uslcom_stop_read(struct ucom_softc *ucom)
 937 {
 938         struct uslcom_softc *sc = ucom->sc_parent;
 939
 940         /* stop read endpoint */
 941         usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_RD]);
 942 }
 943
 944 static void
 945 uslcom_start_write(struct ucom_softc *ucom)
 946 {
 947         struct uslcom_softc *sc = ucom->sc_parent;
 948
 949         usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_WR]);
 950 }
 951
 952 static void
 953 uslcom_stop_write(struct ucom_softc *ucom)
 954 {
 955         struct uslcom_softc *sc = ucom->sc_parent;
 956
 957         usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_WR]);
 958 }
 959
 960 static void
 961 uslcom_poll(struct ucom_softc *ucom)
 962 {
 963         struct uslcom_softc *sc = ucom->sc_parent;
 964         usbd_transfer_poll(sc->sc_xfer, USLCOM_N_TRANSFER);
 965 }