sys/dev/usb/serial/ubser.c

   1 /*-
   2  * Copyright (c) 2004 Bernd Walter <ticso@FreeBSD.org>
   3  *
   4  * $URL: https://devel.bwct.de/svn/projects/ubser/ubser.c $
   5  * $Date: 2004-02-29 01:53:10 +0100 (Sun, 29 Feb 2004) $
   6  * $Author: ticso $
   7  * $Rev: 1127 $
   8  */
   9
  10 /*-
  11  * Copyright (c) 2001-2002, Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 /*-
  37  * Copyright (c) 2000 The NetBSD Foundation, Inc.
  38  * All rights reserved.
  39  *
  40  * This code is derived from software contributed to The NetBSD Foundation
  41  * by Lennart Augustsson (lennart@augustsson.net).
  42  *
  43  * Redistribution and use in source and binary forms, with or without
  44  * modification, are permitted provided that the following conditions
  45  * are met:
  46  * 1. Redistributions of source code must retain the above copyright
  47  *    notice, this list of conditions and the following disclaimer.
  48  * 2. Redistributions in binary form must reproduce the above copyright
  49  *    notice, this list of conditions and the following disclaimer in the
  50  *    documentation and/or other materials provided with the distribution.
  51  * 3. All advertising materials mentioning features or use of this software
  52  *    must display the following acknowledgement:
  53  *        This product includes software developed by the NetBSD
  54  *        Foundation, Inc. and its contributors.
  55  * 4. Neither the name of The NetBSD Foundation nor the names of its
  56  *    contributors may be used to endorse or promote products derived
  57  *    from this software without specific prior written permission.
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  60  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  61  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  62  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  63  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  64  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  65  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  66  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  67  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  68  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  69  * POSSIBILITY OF SUCH DAMAGE.
  70  */
  71
  72 #include <sys/cdefs.h>
  73 __FBSDID("$FreeBSD$");
  74
  75 /*
  76  * BWCT serial adapter driver
  77  */
  78
  79 #include <sys/stdint.h>
  80 #include <sys/stddef.h>
  81 #include <sys/param.h>
  82 #include <sys/queue.h>
  83 #include <sys/types.h>
  84 #include <sys/systm.h>
  85 #include <sys/kernel.h>
  86 #include <sys/bus.h>
  87 #include <sys/module.h>
  88 #include <sys/lock.h>
  89 #include <sys/mutex.h>
  90 #include <sys/condvar.h>
  91 #include <sys/sysctl.h>
  92 #include <sys/sx.h>
  93 #include <sys/unistd.h>
  94 #include <sys/callout.h>
  95 #include <sys/malloc.h>
  96 #include <sys/priv.h>
  97
  98 #include <dev/usb/usb.h>
  99 #include <dev/usb/usbdi.h>
 100 #include <dev/usb/usbdi_util.h>
 101 #include "usbdevs.h"
 102
 103 #define USB_DEBUG_VAR ubser_debug
 104 #include <dev/usb/usb_debug.h>
 105 #include <dev/usb/usb_process.h>
 106
 107 #include <dev/usb/serial/usb_serial.h>
 108
 109 #define UBSER_UNIT_MAX  32
 110
 111 /* Vendor Interface Requests */
 112 #define VENDOR_GET_NUMSER               0x01
 113 #define VENDOR_SET_BREAK                0x02
 114 #define VENDOR_CLEAR_BREAK              0x03
 115
 116 #ifdef USB_DEBUG
 117 static int ubser_debug = 0;
 118
 119 static SYSCTL_NODE(_hw_usb, OID_AUTO, ubser, CTLFLAG_RW, 0, "USB ubser");
 120 SYSCTL_INT(_hw_usb_ubser, OID_AUTO, debug, CTLFLAG_RW,
 121     &ubser_debug, 0, "ubser debug level");
 122 #endif
 123
 124 enum {
 125         UBSER_BULK_DT_WR,
 126         UBSER_BULK_DT_RD,
 127         UBSER_N_TRANSFER,
 128 };
 129
 130 struct ubser_softc {
 131         struct ucom_super_softc sc_super_ucom;
 132         struct ucom_softc sc_ucom[UBSER_UNIT_MAX];
 133
 134         struct usb_xfer *sc_xfer[UBSER_N_TRANSFER];
 135         struct usb_device *sc_udev;
 136         struct mtx sc_mtx;
 137
 138         uint16_t sc_tx_size;
 139
 140         uint8_t sc_numser;
 141         uint8_t sc_iface_no;
 142         uint8_t sc_iface_index;
 143         uint8_t sc_curr_tx_unit;
 144 };
 145
 146 /* prototypes */
 147
 148 static device_probe_t ubser_probe;
 149 static device_attach_t ubser_attach;
 150 static device_detach_t ubser_detach;
 151 static void ubser_free_softc(struct ubser_softc *);
 152
 153 static usb_callback_t ubser_write_callback;
 154 static usb_callback_t ubser_read_callback;
 155
 156 static void     ubser_free(struct ucom_softc *);
 157 static int      ubser_pre_param(struct ucom_softc *, struct termios *);
 158 static void     ubser_cfg_set_break(struct ucom_softc *, uint8_t);
 159 static void     ubser_cfg_get_status(struct ucom_softc *, uint8_t *,
 160                     uint8_t *);
 161 static void     ubser_start_read(struct ucom_softc *);
 162 static void     ubser_stop_read(struct ucom_softc *);
 163 static void     ubser_start_write(struct ucom_softc *);
 164 static void     ubser_stop_write(struct ucom_softc *);
 165 static void     ubser_poll(struct ucom_softc *ucom);
 166
 167 static const struct usb_config ubser_config[UBSER_N_TRANSFER] = {
 168
 169         [UBSER_BULK_DT_WR] = {
 170                 .type = UE_BULK,
 171                 .endpoint = UE_ADDR_ANY,
 172                 .direction = UE_DIR_OUT,
 173                 .bufsize = 0,   /* use wMaxPacketSize */
 174                 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
 175                 .callback = &ubser_write_callback,
 176         },
 177
 178         [UBSER_BULK_DT_RD] = {
 179                 .type = UE_BULK,
 180                 .endpoint = UE_ADDR_ANY,
 181                 .direction = UE_DIR_IN,
 182                 .bufsize = 0,   /* use wMaxPacketSize */
 183                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 184                 .callback = &ubser_read_callback,
 185         },
 186 };
 187
 188 static const struct ucom_callback ubser_callback = {
 189         .ucom_cfg_set_break = &ubser_cfg_set_break,
 190         .ucom_cfg_get_status = &ubser_cfg_get_status,
 191         .ucom_pre_param = &ubser_pre_param,
 192         .ucom_start_read = &ubser_start_read,
 193         .ucom_stop_read = &ubser_stop_read,
 194         .ucom_start_write = &ubser_start_write,
 195         .ucom_stop_write = &ubser_stop_write,
 196         .ucom_poll = &ubser_poll,
 197         .ucom_free = &ubser_free,
 198 };
 199
 200 static device_method_t ubser_methods[] = {
 201         DEVMETHOD(device_probe, ubser_probe),
 202         DEVMETHOD(device_attach, ubser_attach),
 203         DEVMETHOD(device_detach, ubser_detach),
 204         DEVMETHOD_END
 205 };
 206
 207 static devclass_t ubser_devclass;
 208
 209 static driver_t ubser_driver = {
 210         .name = "ubser",
 211         .methods = ubser_methods,
 212         .size = sizeof(struct ubser_softc),
 213 };
 214
 215 DRIVER_MODULE(ubser, uhub, ubser_driver, ubser_devclass, NULL, 0);
 216 MODULE_DEPEND(ubser, ucom, 1, 1, 1);
 217 MODULE_DEPEND(ubser, usb, 1, 1, 1);
 218 MODULE_VERSION(ubser, 1);
 219
 220 static int
 221 ubser_probe(device_t dev)
 222 {
 223         struct usb_attach_arg *uaa = device_get_ivars(dev);
 224
 225         if (uaa->usb_mode != USB_MODE_HOST) {
 226                 return (ENXIO);
 227         }
 228         /* check if this is a BWCT vendor specific ubser interface */
 229         if ((strcmp(usb_get_manufacturer(uaa->device), "BWCT") == 0) &&
 230             (uaa->info.bInterfaceClass == 0xff) &&
 231             (uaa->info.bInterfaceSubClass == 0x00))
 232                 return (0);
 233
 234         return (ENXIO);
 235 }
 236
 237 static int
 238 ubser_attach(device_t dev)
 239 {
 240         struct usb_attach_arg *uaa = device_get_ivars(dev);
 241         struct ubser_softc *sc = device_get_softc(dev);
 242         struct usb_device_request req;
 243         uint8_t n;
 244         int error;
 245
 246         device_set_usb_desc(dev);
 247         mtx_init(&sc->sc_mtx, "ubser", NULL, MTX_DEF);
 248         ucom_ref(&sc->sc_super_ucom);
 249
 250         sc->sc_iface_no = uaa->info.bIfaceNum;
 251         sc->sc_iface_index = uaa->info.bIfaceIndex;
 252         sc->sc_udev = uaa->device;
 253
 254         /* get number of serials */
 255         req.bmRequestType = UT_READ_VENDOR_INTERFACE;
 256         req.bRequest = VENDOR_GET_NUMSER;
 257         USETW(req.wValue, 0);
 258         req.wIndex[0] = sc->sc_iface_no;
 259         req.wIndex[1] = 0;
 260         USETW(req.wLength, 1);
 261         error = usbd_do_request_flags(uaa->device, NULL,
 262             &req, &sc->sc_numser,
 263             0, NULL, USB_DEFAULT_TIMEOUT);
 264
 265         if (error || (sc->sc_numser == 0)) {
 266                 device_printf(dev, "failed to get number "
 267                     "of serial ports: %s\n",
 268                     usbd_errstr(error));
 269                 goto detach;
 270         }
 271         if (sc->sc_numser > UBSER_UNIT_MAX)
 272                 sc->sc_numser = UBSER_UNIT_MAX;
 273
 274         device_printf(dev, "found %i serials\n", sc->sc_numser);
 275
 276         error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
 277             sc->sc_xfer, ubser_config, UBSER_N_TRANSFER, sc, &sc->sc_mtx);
 278         if (error) {
 279                 goto detach;
 280         }
 281         sc->sc_tx_size = usbd_xfer_max_len(sc->sc_xfer[UBSER_BULK_DT_WR]);
 282
 283         if (sc->sc_tx_size == 0) {
 284                 DPRINTFN(0, "invalid tx_size\n");
 285                 goto detach;
 286         }
 287         /* initialize port numbers */
 288
 289         for (n = 0; n < sc->sc_numser; n++) {
 290                 sc->sc_ucom[n].sc_portno = n;
 291         }
 292
 293         error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
 294             sc->sc_numser, sc, &ubser_callback, &sc->sc_mtx);
 295         if (error) {
 296                 goto detach;
 297         }
 298         ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
 299
 300         mtx_lock(&sc->sc_mtx);
 301         usbd_xfer_set_stall(sc->sc_xfer[UBSER_BULK_DT_WR]);
 302         usbd_xfer_set_stall(sc->sc_xfer[UBSER_BULK_DT_RD]);
 303         usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_RD]);
 304         mtx_unlock(&sc->sc_mtx);
 305
 306         return (0);                     /* success */
 307
 308 detach:
 309         ubser_detach(dev);
 310         return (ENXIO);                 /* failure */
 311 }
 312
 313 static int
 314 ubser_detach(device_t dev)
 315 {
 316         struct ubser_softc *sc = device_get_softc(dev);
 317
 318         DPRINTF("\n");
 319
 320         ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
 321         usbd_transfer_unsetup(sc->sc_xfer, UBSER_N_TRANSFER);
 322
 323         device_claim_softc(dev);
 324
 325         ubser_free_softc(sc);
 326
 327         return (0);
 328 }
 329
 330 UCOM_UNLOAD_DRAIN(ubser);
 331
 332 static void
 333 ubser_free_softc(struct ubser_softc *sc)
 334 {
 335         if (ucom_unref(&sc->sc_super_ucom)) {
 336                 mtx_destroy(&sc->sc_mtx);
 337                 device_free_softc(sc);
 338         }
 339 }
 340
 341 static void
 342 ubser_free(struct ucom_softc *ucom)
 343 {
 344         ubser_free_softc(ucom->sc_parent);
 345 }
 346
 347 static int
 348 ubser_pre_param(struct ucom_softc *ucom, struct termios *t)
 349 {
 350         DPRINTF("\n");
 351
 352         /*
 353          * The firmware on our devices can only do 8n1@9600bps
 354          * without handshake.
 355          * We refuse to accept other configurations.
 356          */
 357
 358         /* ensure 9600bps */
 359         switch (t->c_ospeed) {
 360         case 9600:
 361                 break;
 362         default:
 363                 return (EINVAL);
 364         }
 365
 366         /* 2 stop bits not possible */
 367         if (t->c_cflag & CSTOPB)
 368                 return (EINVAL);
 369
 370         /* XXX parity handling not possible with current firmware */
 371         if (t->c_cflag & PARENB)
 372                 return (EINVAL);
 373
 374         /* we can only do 8 data bits */
 375         switch (t->c_cflag & CSIZE) {
 376         case CS8:
 377                 break;
 378         default:
 379                 return (EINVAL);
 380         }
 381
 382         /* we can't do any kind of hardware handshaking */
 383         if ((t->c_cflag &
 384             (CRTS_IFLOW | CDTR_IFLOW | CDSR_OFLOW | CCAR_OFLOW)) != 0)
 385                 return (EINVAL);
 386
 387         /*
 388          * XXX xon/xoff not supported by the firmware!
 389          * This is handled within FreeBSD only and may overflow buffers
 390          * because of delayed reaction due to device buffering.
 391          */
 392
 393         return (0);
 394 }
 395
 396 static __inline void
 397 ubser_inc_tx_unit(struct ubser_softc *sc)
 398 {
 399         sc->sc_curr_tx_unit++;
 400         if (sc->sc_curr_tx_unit >= sc->sc_numser) {
 401                 sc->sc_curr_tx_unit = 0;
 402         }
 403 }
 404
 405 static void
 406 ubser_write_callback(struct usb_xfer *xfer, usb_error_t error)
 407 {
 408         struct ubser_softc *sc = usbd_xfer_softc(xfer);
 409         struct usb_page_cache *pc;
 410         uint8_t buf[1];
 411         uint8_t first_unit = sc->sc_curr_tx_unit;
 412         uint32_t actlen;
 413
 414         switch (USB_GET_STATE(xfer)) {
 415         case USB_ST_SETUP:
 416         case USB_ST_TRANSFERRED:
 417 tr_setup:
 418                 pc = usbd_xfer_get_frame(xfer, 0);
 419                 do {
 420                         if (ucom_get_data(sc->sc_ucom + sc->sc_curr_tx_unit,
 421                             pc, 1, sc->sc_tx_size - 1,
 422                             &actlen)) {
 423
 424                                 buf[0] = sc->sc_curr_tx_unit;
 425
 426                                 usbd_copy_in(pc, 0, buf, 1);
 427
 428                                 usbd_xfer_set_frame_len(xfer, 0, actlen + 1);
 429                                 usbd_transfer_submit(xfer);
 430
 431                                 ubser_inc_tx_unit(sc);  /* round robin */
 432
 433                                 break;
 434                         }
 435                         ubser_inc_tx_unit(sc);
 436
 437                 } while (sc->sc_curr_tx_unit != first_unit);
 438
 439                 return;
 440
 441         default:                        /* Error */
 442                 if (error != USB_ERR_CANCELLED) {
 443                         /* try to clear stall first */
 444                         usbd_xfer_set_stall(xfer);
 445                         goto tr_setup;
 446                 }
 447                 return;
 448
 449         }
 450 }
 451
 452 static void
 453 ubser_read_callback(struct usb_xfer *xfer, usb_error_t error)
 454 {
 455         struct ubser_softc *sc = usbd_xfer_softc(xfer);
 456         struct usb_page_cache *pc;
 457         uint8_t buf[1];
 458         int actlen;
 459
 460         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 461
 462         switch (USB_GET_STATE(xfer)) {
 463         case USB_ST_TRANSFERRED:
 464                 if (actlen < 1) {
 465                         DPRINTF("invalid actlen=0!\n");
 466                         goto tr_setup;
 467                 }
 468                 pc = usbd_xfer_get_frame(xfer, 0);
 469                 usbd_copy_out(pc, 0, buf, 1);
 470
 471                 if (buf[0] >= sc->sc_numser) {
 472                         DPRINTF("invalid serial number!\n");
 473                         goto tr_setup;
 474                 }
 475                 ucom_put_data(sc->sc_ucom + buf[0], pc, 1, actlen - 1);
 476
 477         case USB_ST_SETUP:
 478 tr_setup:
 479                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 480                 usbd_transfer_submit(xfer);
 481                 return;
 482
 483         default:                        /* Error */
 484                 if (error != USB_ERR_CANCELLED) {
 485                         /* try to clear stall first */
 486                         usbd_xfer_set_stall(xfer);
 487                         goto tr_setup;
 488                 }
 489                 return;
 490
 491         }
 492 }
 493
 494 static void
 495 ubser_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
 496 {
 497         struct ubser_softc *sc = ucom->sc_parent;
 498         uint8_t x = ucom->sc_portno;
 499         struct usb_device_request req;
 500         usb_error_t err;
 501
 502         if (onoff) {
 503
 504                 req.bmRequestType = UT_READ_VENDOR_INTERFACE;
 505                 req.bRequest = VENDOR_SET_BREAK;
 506                 req.wValue[0] = x;
 507                 req.wValue[1] = 0;
 508                 req.wIndex[0] = sc->sc_iface_no;
 509                 req.wIndex[1] = 0;
 510                 USETW(req.wLength, 0);
 511
 512                 err = ucom_cfg_do_request(sc->sc_udev, ucom,
 513                     &req, NULL, 0, 1000);
 514                 if (err) {
 515                         DPRINTFN(0, "send break failed, error=%s\n",
 516                             usbd_errstr(err));
 517                 }
 518         }
 519 }
 520
 521 static void
 522 ubser_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
 523 {
 524         /* fake status bits */
 525         *lsr = 0;
 526         *msr = SER_DCD;
 527 }
 528
 529 static void
 530 ubser_start_read(struct ucom_softc *ucom)
 531 {
 532         struct ubser_softc *sc = ucom->sc_parent;
 533
 534         usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_RD]);
 535 }
 536
 537 static void
 538 ubser_stop_read(struct ucom_softc *ucom)
 539 {
 540         struct ubser_softc *sc = ucom->sc_parent;
 541
 542         usbd_transfer_stop(sc->sc_xfer[UBSER_BULK_DT_RD]);
 543 }
 544
 545 static void
 546 ubser_start_write(struct ucom_softc *ucom)
 547 {
 548         struct ubser_softc *sc = ucom->sc_parent;
 549
 550         usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_WR]);
 551 }
 552
 553 static void
 554 ubser_stop_write(struct ucom_softc *ucom)
 555 {
 556         struct ubser_softc *sc = ucom->sc_parent;
 557
 558         usbd_transfer_stop(sc->sc_xfer[UBSER_BULK_DT_WR]);
 559 }
 560
 561 static void
 562 ubser_poll(struct ucom_softc *ucom)
 563 {
 564         struct ubser_softc *sc = ucom->sc_parent;
 565         usbd_transfer_poll(sc->sc_xfer, UBSER_N_TRANSFER);
 566 }