sys/bus/u4b/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 /*
  73  * BWCT serial adapter driver
  74  */
  75
  76 #include <sys/stdint.h>
  77 #include <sys/param.h>
  78 #include <sys/queue.h>
  79 #include <sys/types.h>
  80 #include <sys/systm.h>
  81 #include <sys/kernel.h>
  82 #include <sys/bus.h>
  83 #include <sys/module.h>
  84 #include <sys/lock.h>
  85 #include <sys/condvar.h>
  86 #include <sys/sysctl.h>
  87 #include <sys/unistd.h>
  88 #include <sys/callout.h>
  89 #include <sys/malloc.h>
  90 #include <sys/priv.h>
  91 #include <sys/serial.h>
  92
  93 #include <bus/u4b/usb.h>
  94 #include <bus/u4b/usbdi.h>
  95 #include <bus/u4b/usbdi_util.h>
  96 #include "usbdevs.h"
  97
  98 #define USB_DEBUG_VAR ubser_debug
  99 #include <bus/u4b/usb_debug.h>
 100 #include <bus/u4b/usb_process.h>
 101
 102 #include <bus/u4b/serial/usb_serial.h>
 103
 104 #define UBSER_UNIT_MAX  32
 105
 106 /* Vendor Interface Requests */
 107 #define VENDOR_GET_NUMSER               0x01
 108 #define VENDOR_SET_BREAK                0x02
 109 #define VENDOR_CLEAR_BREAK              0x03
 110
 111 #ifdef USB_DEBUG
 112 static int ubser_debug = 0;
 113
 114 static SYSCTL_NODE(_hw_usb, OID_AUTO, ubser, CTLFLAG_RW, 0, "USB ubser");
 115 SYSCTL_INT(_hw_usb_ubser, OID_AUTO, debug, CTLFLAG_RWTUN,
 116     &ubser_debug, 0, "ubser debug level");
 117 #endif
 118
 119 enum {
 120         UBSER_BULK_DT_WR,
 121         UBSER_BULK_DT_RD,
 122         UBSER_N_TRANSFER,
 123 };
 124
 125 struct ubser_softc {
 126         struct ucom_super_softc sc_super_ucom;
 127         struct ucom_softc sc_ucom[UBSER_UNIT_MAX];
 128
 129         struct usb_xfer *sc_xfer[UBSER_N_TRANSFER];
 130         struct usb_device *sc_udev;
 131         struct lock sc_lock;
 132
 133         uint16_t sc_tx_size;
 134
 135         uint8_t sc_numser;
 136         uint8_t sc_iface_no;
 137         uint8_t sc_iface_index;
 138         uint8_t sc_curr_tx_unit;
 139         uint8_t sc_name[16];
 140 };
 141
 142 /* prototypes */
 143
 144 static device_probe_t ubser_probe;
 145 static device_attach_t ubser_attach;
 146 static device_detach_t ubser_detach;
 147
 148 static usb_callback_t ubser_write_callback;
 149 static usb_callback_t ubser_read_callback;
 150
 151 static int      ubser_pre_param(struct ucom_softc *, struct termios *);
 152 static void     ubser_cfg_set_break(struct ucom_softc *, uint8_t);
 153 static void     ubser_cfg_get_status(struct ucom_softc *, uint8_t *,
 154                     uint8_t *);
 155 static void     ubser_start_read(struct ucom_softc *);
 156 static void     ubser_stop_read(struct ucom_softc *);
 157 static void     ubser_start_write(struct ucom_softc *);
 158 static void     ubser_stop_write(struct ucom_softc *);
 159 static void     ubser_poll(struct ucom_softc *ucom);
 160
 161 static const struct usb_config ubser_config[UBSER_N_TRANSFER] = {
 162
 163         [UBSER_BULK_DT_WR] = {
 164                 .type = UE_BULK,
 165                 .endpoint = UE_ADDR_ANY,
 166                 .direction = UE_DIR_OUT,
 167                 .bufsize = 0,   /* use wMaxPacketSize */
 168                 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
 169                 .callback = &ubser_write_callback,
 170         },
 171
 172         [UBSER_BULK_DT_RD] = {
 173                 .type = UE_BULK,
 174                 .endpoint = UE_ADDR_ANY,
 175                 .direction = UE_DIR_IN,
 176                 .bufsize = 0,   /* use wMaxPacketSize */
 177                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 178                 .callback = &ubser_read_callback,
 179         },
 180 };
 181
 182 static const struct ucom_callback ubser_callback = {
 183         .ucom_cfg_set_break = &ubser_cfg_set_break,
 184         .ucom_cfg_get_status = &ubser_cfg_get_status,
 185         .ucom_pre_param = &ubser_pre_param,
 186         .ucom_start_read = &ubser_start_read,
 187         .ucom_stop_read = &ubser_stop_read,
 188         .ucom_start_write = &ubser_start_write,
 189         .ucom_stop_write = &ubser_stop_write,
 190         .ucom_poll = &ubser_poll,
 191 };
 192
 193 static device_method_t ubser_methods[] = {
 194         DEVMETHOD(device_probe, ubser_probe),
 195         DEVMETHOD(device_attach, ubser_attach),
 196         DEVMETHOD(device_detach, ubser_detach),
 197         DEVMETHOD_END
 198 };
 199
 200 static devclass_t ubser_devclass;
 201
 202 static driver_t ubser_driver = {
 203         .name = "ubser",
 204         .methods = ubser_methods,
 205         .size = sizeof(struct ubser_softc),
 206 };
 207
 208 DRIVER_MODULE(ubser, uhub, ubser_driver, ubser_devclass, NULL, NULL);
 209 MODULE_DEPEND(ubser, ucom, 1, 1, 1);
 210 MODULE_DEPEND(ubser, usb, 1, 1, 1);
 211 MODULE_VERSION(ubser, 1);
 212
 213 static int
 214 ubser_probe(device_t dev)
 215 {
 216         struct usb_attach_arg *uaa = device_get_ivars(dev);
 217
 218         if (uaa->usb_mode != USB_MODE_HOST) {
 219                 return (ENXIO);
 220         }
 221         /* check if this is a BWCT vendor specific ubser interface */
 222         if ((strcmp(usb_get_manufacturer(uaa->device), "BWCT") == 0) &&
 223             (uaa->info.bInterfaceClass == 0xff) &&
 224             (uaa->info.bInterfaceSubClass == 0x00))
 225                 return (0);
 226
 227         return (ENXIO);
 228 }
 229
 230 static int
 231 ubser_attach(device_t dev)
 232 {
 233         struct usb_attach_arg *uaa = device_get_ivars(dev);
 234         struct ubser_softc *sc = device_get_softc(dev);
 235         struct usb_device_request req;
 236         uint8_t n;
 237         int error;
 238
 239         device_set_usb_desc(dev);
 240         lockinit(&sc->sc_lock, "ubser", 0, LK_CANRECURSE);
 241
 242         ksnprintf(sc->sc_name, sizeof(sc->sc_name), "%s",
 243             device_get_nameunit(dev));
 244
 245         sc->sc_iface_no = uaa->info.bIfaceNum;
 246         sc->sc_iface_index = uaa->info.bIfaceIndex;
 247         sc->sc_udev = uaa->device;
 248
 249         /* get number of serials */
 250         req.bmRequestType = UT_READ_VENDOR_INTERFACE;
 251         req.bRequest = VENDOR_GET_NUMSER;
 252         USETW(req.wValue, 0);
 253         req.wIndex[0] = sc->sc_iface_no;
 254         req.wIndex[1] = 0;
 255         USETW(req.wLength, 1);
 256         error = usbd_do_request_flags(uaa->device, NULL,
 257             &req, &sc->sc_numser,
 258             0, NULL, USB_DEFAULT_TIMEOUT);
 259
 260         if (error || (sc->sc_numser == 0)) {
 261                 device_printf(dev, "failed to get number "
 262                     "of serial ports: %s\n",
 263                     usbd_errstr(error));
 264                 goto detach;
 265         }
 266         if (sc->sc_numser > UBSER_UNIT_MAX)
 267                 sc->sc_numser = UBSER_UNIT_MAX;
 268
 269         device_printf(dev, "found %i serials\n", sc->sc_numser);
 270
 271         error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
 272             sc->sc_xfer, ubser_config, UBSER_N_TRANSFER, sc, &sc->sc_lock);
 273         if (error) {
 274                 goto detach;
 275         }
 276         sc->sc_tx_size = usbd_xfer_max_len(sc->sc_xfer[UBSER_BULK_DT_WR]);
 277
 278         if (sc->sc_tx_size == 0) {
 279                 DPRINTFN(0, "invalid tx_size\n");
 280                 goto detach;
 281         }
 282         /* initialize port numbers */
 283
 284         for (n = 0; n < sc->sc_numser; n++) {
 285                 sc->sc_ucom[n].sc_portno = n;
 286         }
 287
 288         error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
 289             sc->sc_numser, sc, &ubser_callback, &sc->sc_lock);
 290         if (error) {
 291                 goto detach;
 292         }
 293         ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
 294
 295         lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
 296         usbd_xfer_set_stall(sc->sc_xfer[UBSER_BULK_DT_WR]);
 297         usbd_xfer_set_stall(sc->sc_xfer[UBSER_BULK_DT_RD]);
 298         usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_RD]);
 299         lockmgr(&sc->sc_lock, LK_RELEASE);
 300
 301         return (0);                     /* success */
 302
 303 detach:
 304         ubser_detach(dev);
 305         return (ENXIO);                 /* failure */
 306 }
 307
 308 static int
 309 ubser_detach(device_t dev)
 310 {
 311         struct ubser_softc *sc = device_get_softc(dev);
 312
 313         DPRINTF("\n");
 314
 315         ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
 316         usbd_transfer_unsetup(sc->sc_xfer, UBSER_N_TRANSFER);
 317         lockuninit(&sc->sc_lock);
 318
 319         return (0);
 320 }
 321
 322 static int
 323 ubser_pre_param(struct ucom_softc *ucom, struct termios *t)
 324 {
 325         DPRINTF("\n");
 326
 327         /*
 328          * The firmware on our devices can only do 8n1@9600bps
 329          * without handshake.
 330          * We refuse to accept other configurations.
 331          */
 332
 333         /* ensure 9600bps */
 334         switch (t->c_ospeed) {
 335         case 9600:
 336                 break;
 337         default:
 338                 return (EINVAL);
 339         }
 340
 341         /* 2 stop bits not possible */
 342         if (t->c_cflag & CSTOPB)
 343                 return (EINVAL);
 344
 345         /* XXX parity handling not possible with current firmware */
 346         if (t->c_cflag & PARENB)
 347                 return (EINVAL);
 348
 349         /* we can only do 8 data bits */
 350         switch (t->c_cflag & CSIZE) {
 351         case CS8:
 352                 break;
 353         default:
 354                 return (EINVAL);
 355         }
 356
 357         /* we can't do any kind of hardware handshaking */
 358         if ((t->c_cflag &
 359             (CRTS_IFLOW | CDTR_IFLOW | CDSR_OFLOW | CCAR_OFLOW)) != 0)
 360                 return (EINVAL);
 361
 362         /*
 363          * XXX xon/xoff not supported by the firmware!
 364          * This is handled within FreeBSD only and may overflow buffers
 365          * because of delayed reaction due to device buffering.
 366          */
 367
 368         return (0);
 369 }
 370
 371 static __inline void
 372 ubser_inc_tx_unit(struct ubser_softc *sc)
 373 {
 374         sc->sc_curr_tx_unit++;
 375         if (sc->sc_curr_tx_unit >= sc->sc_numser) {
 376                 sc->sc_curr_tx_unit = 0;
 377         }
 378 }
 379
 380 static void
 381 ubser_write_callback(struct usb_xfer *xfer, usb_error_t error)
 382 {
 383         struct ubser_softc *sc = usbd_xfer_softc(xfer);
 384         struct usb_page_cache *pc;
 385         uint8_t buf[1];
 386         uint8_t first_unit = sc->sc_curr_tx_unit;
 387         uint32_t actlen;
 388
 389         switch (USB_GET_STATE(xfer)) {
 390         case USB_ST_SETUP:
 391         case USB_ST_TRANSFERRED:
 392 tr_setup:
 393                 pc = usbd_xfer_get_frame(xfer, 0);
 394                 do {
 395                         if (ucom_get_data(sc->sc_ucom + sc->sc_curr_tx_unit,
 396                             pc, 1, sc->sc_tx_size - 1,
 397                             &actlen)) {
 398
 399                                 buf[0] = sc->sc_curr_tx_unit;
 400
 401                                 usbd_copy_in(pc, 0, buf, 1);
 402
 403                                 usbd_xfer_set_frame_len(xfer, 0, actlen + 1);
 404                                 usbd_transfer_submit(xfer);
 405
 406                                 ubser_inc_tx_unit(sc);  /* round robin */
 407
 408                                 break;
 409                         }
 410                         ubser_inc_tx_unit(sc);
 411
 412                 } while (sc->sc_curr_tx_unit != first_unit);
 413
 414                 return;
 415
 416         default:                        /* Error */
 417                 if (error != USB_ERR_CANCELLED) {
 418                         /* try to clear stall first */
 419                         usbd_xfer_set_stall(xfer);
 420                         goto tr_setup;
 421                 }
 422                 return;
 423
 424         }
 425 }
 426
 427 static void
 428 ubser_read_callback(struct usb_xfer *xfer, usb_error_t error)
 429 {
 430         struct ubser_softc *sc = usbd_xfer_softc(xfer);
 431         struct usb_page_cache *pc;
 432         uint8_t buf[1];
 433         int actlen;
 434
 435         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 436
 437         switch (USB_GET_STATE(xfer)) {
 438         case USB_ST_TRANSFERRED:
 439                 if (actlen < 1) {
 440                         DPRINTF("invalid actlen=0!\n");
 441                         goto tr_setup;
 442                 }
 443                 pc = usbd_xfer_get_frame(xfer, 0);
 444                 usbd_copy_out(pc, 0, buf, 1);
 445
 446                 if (buf[0] >= sc->sc_numser) {
 447                         DPRINTF("invalid serial number!\n");
 448                         goto tr_setup;
 449                 }
 450                 ucom_put_data(sc->sc_ucom + buf[0], pc, 1, actlen - 1);
 451
 452         case USB_ST_SETUP:
 453 tr_setup:
 454                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 455                 usbd_transfer_submit(xfer);
 456                 return;
 457
 458         default:                        /* Error */
 459                 if (error != USB_ERR_CANCELLED) {
 460                         /* try to clear stall first */
 461                         usbd_xfer_set_stall(xfer);
 462                         goto tr_setup;
 463                 }
 464                 return;
 465
 466         }
 467 }
 468
 469 static void
 470 ubser_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
 471 {
 472         struct ubser_softc *sc = ucom->sc_parent;
 473         uint8_t x = ucom->sc_portno;
 474         struct usb_device_request req;
 475         usb_error_t err;
 476
 477         if (onoff) {
 478
 479                 req.bmRequestType = UT_READ_VENDOR_INTERFACE;
 480                 req.bRequest = VENDOR_SET_BREAK;
 481                 req.wValue[0] = x;
 482                 req.wValue[1] = 0;
 483                 req.wIndex[0] = sc->sc_iface_no;
 484                 req.wIndex[1] = 0;
 485                 USETW(req.wLength, 0);
 486
 487                 err = ucom_cfg_do_request(sc->sc_udev, ucom,
 488                     &req, NULL, 0, 1000);
 489                 if (err) {
 490                         DPRINTFN(0, "send break failed, error=%s\n",
 491                             usbd_errstr(err));
 492                 }
 493         }
 494 }
 495
 496 static void
 497 ubser_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
 498 {
 499         /* fake status bits */
 500         *lsr = 0;
 501         *msr = SER_DCD;
 502 }
 503
 504 static void
 505 ubser_start_read(struct ucom_softc *ucom)
 506 {
 507         struct ubser_softc *sc = ucom->sc_parent;
 508
 509         usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_RD]);
 510 }
 511
 512 static void
 513 ubser_stop_read(struct ucom_softc *ucom)
 514 {
 515         struct ubser_softc *sc = ucom->sc_parent;
 516
 517         usbd_transfer_stop(sc->sc_xfer[UBSER_BULK_DT_RD]);
 518 }
 519
 520 static void
 521 ubser_start_write(struct ucom_softc *ucom)
 522 {
 523         struct ubser_softc *sc = ucom->sc_parent;
 524
 525         usbd_transfer_start(sc->sc_xfer[UBSER_BULK_DT_WR]);
 526 }
 527
 528 static void
 529 ubser_stop_write(struct ucom_softc *ucom)
 530 {
 531         struct ubser_softc *sc = ucom->sc_parent;
 532
 533         usbd_transfer_stop(sc->sc_xfer[UBSER_BULK_DT_WR]);
 534 }
 535
 536 static void
 537 ubser_poll(struct ucom_softc *ucom)
 538 {
 539         struct ubser_softc *sc = ucom->sc_parent;
 540         usbd_transfer_poll(sc->sc_xfer, UBSER_N_TRANSFER);
 541 }