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