usb_serial.c revision 242695
1/* $NetBSD: ucom.c,v 1.40 2001/11/13 06:24:54 lukem Exp $ */ 2 3/*- 4 * Copyright (c) 2001-2003, 2005, 2008 5 * Shunsuke Akiyama <akiyama@jp.FreeBSD.org>. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30#include <sys/cdefs.h> 31__FBSDID("$FreeBSD: head/sys/dev/usb/serial/usb_serial.c 242695 2012-11-07 08:13:56Z hselasky $"); 32 33/*- 34 * Copyright (c) 1998, 2000 The NetBSD Foundation, Inc. 35 * All rights reserved. 36 * 37 * This code is derived from software contributed to The NetBSD Foundation 38 * by Lennart Augustsson (lennart@augustsson.net) at 39 * Carlstedt Research & Technology. 40 * 41 * Redistribution and use in source and binary forms, with or without 42 * modification, are permitted provided that the following conditions 43 * are met: 44 * 1. Redistributions of source code must retain the above copyright 45 * notice, this list of conditions and the following disclaimer. 46 * 2. Redistributions in binary form must reproduce the above copyright 47 * notice, this list of conditions and the following disclaimer in the 48 * documentation and/or other materials provided with the distribution. 49 * 3. All advertising materials mentioning features or use of this software 50 * must display the following acknowledgement: 51 * This product includes software developed by the NetBSD 52 * Foundation, Inc. and its contributors. 53 * 4. Neither the name of The NetBSD Foundation nor the names of its 54 * contributors may be used to endorse or promote products derived 55 * from this software without specific prior written permission. 56 * 57 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 58 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 59 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 60 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 61 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 62 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 63 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 64 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 65 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 66 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 67 * POSSIBILITY OF SUCH DAMAGE. 68 */ 69 70#include <sys/stdint.h> 71#include <sys/stddef.h> 72#include <sys/param.h> 73#include <sys/queue.h> 74#include <sys/types.h> 75#include <sys/systm.h> 76#include <sys/kernel.h> 77#include <sys/bus.h> 78#include <sys/module.h> 79#include <sys/lock.h> 80#include <sys/mutex.h> 81#include <sys/condvar.h> 82#include <sys/sysctl.h> 83#include <sys/sx.h> 84#include <sys/unistd.h> 85#include <sys/callout.h> 86#include <sys/malloc.h> 87#include <sys/priv.h> 88#include <sys/cons.h> 89#include <sys/kdb.h> 90 91#include <dev/usb/usb.h> 92#include <dev/usb/usbdi.h> 93#include <dev/usb/usbdi_util.h> 94 95#define USB_DEBUG_VAR ucom_debug 96#include <dev/usb/usb_debug.h> 97#include <dev/usb/usb_busdma.h> 98#include <dev/usb/usb_process.h> 99 100#include <dev/usb/serial/usb_serial.h> 101 102#include "opt_gdb.h" 103 104static SYSCTL_NODE(_hw_usb, OID_AUTO, ucom, CTLFLAG_RW, 0, "USB ucom"); 105 106#ifdef USB_DEBUG 107static int ucom_debug = 0; 108 109SYSCTL_INT(_hw_usb_ucom, OID_AUTO, debug, CTLFLAG_RW, 110 &ucom_debug, 0, "ucom debug level"); 111#endif 112 113#define UCOM_CONS_BUFSIZE 1024 114 115static uint8_t ucom_cons_rx_buf[UCOM_CONS_BUFSIZE]; 116static uint8_t ucom_cons_tx_buf[UCOM_CONS_BUFSIZE]; 117 118static unsigned int ucom_cons_rx_low = 0; 119static unsigned int ucom_cons_rx_high = 0; 120 121static unsigned int ucom_cons_tx_low = 0; 122static unsigned int ucom_cons_tx_high = 0; 123 124static int ucom_cons_unit = -1; 125static int ucom_cons_subunit = 0; 126static int ucom_cons_baud = 9600; 127static struct ucom_softc *ucom_cons_softc = NULL; 128 129TUNABLE_INT("hw.usb.ucom.cons_unit", &ucom_cons_unit); 130SYSCTL_INT(_hw_usb_ucom, OID_AUTO, cons_unit, CTLFLAG_RW | CTLFLAG_TUN, 131 &ucom_cons_unit, 0, "console unit number"); 132TUNABLE_INT("hw.usb.ucom.cons_subunit", &ucom_cons_subunit); 133SYSCTL_INT(_hw_usb_ucom, OID_AUTO, cons_subunit, CTLFLAG_RW | CTLFLAG_TUN, 134 &ucom_cons_subunit, 0, "console subunit number"); 135TUNABLE_INT("hw.usb.ucom.cons_baud", &ucom_cons_baud); 136SYSCTL_INT(_hw_usb_ucom, OID_AUTO, cons_baud, CTLFLAG_RW | CTLFLAG_TUN, 137 &ucom_cons_baud, 0, "console baud rate"); 138 139static usb_proc_callback_t ucom_cfg_start_transfers; 140static usb_proc_callback_t ucom_cfg_open; 141static usb_proc_callback_t ucom_cfg_close; 142static usb_proc_callback_t ucom_cfg_line_state; 143static usb_proc_callback_t ucom_cfg_status_change; 144static usb_proc_callback_t ucom_cfg_param; 145 146static int ucom_unit_alloc(void); 147static void ucom_unit_free(int); 148static int ucom_attach_tty(struct ucom_super_softc *, struct ucom_softc *); 149static void ucom_detach_tty(struct ucom_super_softc *, struct ucom_softc *); 150static void ucom_queue_command(struct ucom_softc *, 151 usb_proc_callback_t *, struct termios *pt, 152 struct usb_proc_msg *t0, struct usb_proc_msg *t1); 153static void ucom_shutdown(struct ucom_softc *); 154static void ucom_ring(struct ucom_softc *, uint8_t); 155static void ucom_break(struct ucom_softc *, uint8_t); 156static void ucom_dtr(struct ucom_softc *, uint8_t); 157static void ucom_rts(struct ucom_softc *, uint8_t); 158 159static tsw_open_t ucom_open; 160static tsw_close_t ucom_close; 161static tsw_ioctl_t ucom_ioctl; 162static tsw_modem_t ucom_modem; 163static tsw_param_t ucom_param; 164static tsw_outwakeup_t ucom_outwakeup; 165static tsw_inwakeup_t ucom_inwakeup; 166static tsw_free_t ucom_free; 167 168static struct ttydevsw ucom_class = { 169 .tsw_flags = TF_INITLOCK | TF_CALLOUT, 170 .tsw_open = ucom_open, 171 .tsw_close = ucom_close, 172 .tsw_outwakeup = ucom_outwakeup, 173 .tsw_inwakeup = ucom_inwakeup, 174 .tsw_ioctl = ucom_ioctl, 175 .tsw_param = ucom_param, 176 .tsw_modem = ucom_modem, 177 .tsw_free = ucom_free, 178}; 179 180MODULE_DEPEND(ucom, usb, 1, 1, 1); 181MODULE_VERSION(ucom, 1); 182 183#define UCOM_UNIT_MAX 128 /* maximum number of units */ 184#define UCOM_TTY_PREFIX "U" 185 186static struct unrhdr *ucom_unrhdr; 187static struct mtx ucom_mtx; 188static int ucom_close_refs; 189 190static void 191ucom_init(void *arg) 192{ 193 DPRINTF("\n"); 194 ucom_unrhdr = new_unrhdr(0, UCOM_UNIT_MAX - 1, NULL); 195 mtx_init(&ucom_mtx, "UCOM MTX", NULL, MTX_DEF); 196} 197SYSINIT(ucom_init, SI_SUB_KLD - 1, SI_ORDER_ANY, ucom_init, NULL); 198 199static void 200ucom_uninit(void *arg) 201{ 202 struct unrhdr *hdr; 203 hdr = ucom_unrhdr; 204 ucom_unrhdr = NULL; 205 206 DPRINTF("\n"); 207 208 if (hdr != NULL) 209 delete_unrhdr(hdr); 210 211 mtx_destroy(&ucom_mtx); 212} 213SYSUNINIT(ucom_uninit, SI_SUB_KLD - 2, SI_ORDER_ANY, ucom_uninit, NULL); 214 215/* 216 * Mark a unit number (the X in cuaUX) as in use. 217 * 218 * Note that devices using a different naming scheme (see ucom_tty_name() 219 * callback) still use this unit allocation. 220 */ 221static int 222ucom_unit_alloc(void) 223{ 224 int unit; 225 226 /* sanity checks */ 227 if (ucom_unrhdr == NULL) { 228 DPRINTF("ucom_unrhdr is NULL\n"); 229 return (-1); 230 } 231 unit = alloc_unr(ucom_unrhdr); 232 DPRINTF("unit %d is allocated\n", unit); 233 return (unit); 234} 235 236/* 237 * Mark the unit number as not in use. 238 */ 239static void 240ucom_unit_free(int unit) 241{ 242 /* sanity checks */ 243 if (unit < 0 || unit >= UCOM_UNIT_MAX || ucom_unrhdr == NULL) { 244 DPRINTF("cannot free unit number\n"); 245 return; 246 } 247 DPRINTF("unit %d is freed\n", unit); 248 free_unr(ucom_unrhdr, unit); 249} 250 251/* 252 * Setup a group of one or more serial ports. 253 * 254 * The mutex pointed to by "mtx" is applied before all 255 * callbacks are called back. Also "mtx" must be applied 256 * before calling into the ucom-layer! 257 */ 258int 259ucom_attach(struct ucom_super_softc *ssc, struct ucom_softc *sc, 260 int subunits, void *parent, 261 const struct ucom_callback *callback, struct mtx *mtx) 262{ 263 int subunit; 264 int error = 0; 265 266 if ((sc == NULL) || 267 (subunits <= 0) || 268 (callback == NULL) || 269 (mtx == NULL)) { 270 return (EINVAL); 271 } 272 273 /* allocate a uniq unit number */ 274 ssc->sc_unit = ucom_unit_alloc(); 275 if (ssc->sc_unit == -1) 276 return (ENOMEM); 277 278 /* generate TTY name string */ 279 snprintf(ssc->sc_ttyname, sizeof(ssc->sc_ttyname), 280 UCOM_TTY_PREFIX "%d", ssc->sc_unit); 281 282 /* create USB request handling process */ 283 error = usb_proc_create(&ssc->sc_tq, mtx, "ucom", USB_PRI_MED); 284 if (error) { 285 ucom_unit_free(ssc->sc_unit); 286 return (error); 287 } 288 ssc->sc_subunits = subunits; 289 ssc->sc_flag = UCOM_FLAG_ATTACHED | 290 UCOM_FLAG_FREE_UNIT; 291 292 if (callback->ucom_free == NULL) 293 ssc->sc_flag |= UCOM_FLAG_WAIT_REFS; 294 295 /* increment reference count */ 296 ucom_ref(ssc); 297 298 for (subunit = 0; subunit < ssc->sc_subunits; subunit++) { 299 sc[subunit].sc_subunit = subunit; 300 sc[subunit].sc_super = ssc; 301 sc[subunit].sc_mtx = mtx; 302 sc[subunit].sc_parent = parent; 303 sc[subunit].sc_callback = callback; 304 305 error = ucom_attach_tty(ssc, &sc[subunit]); 306 if (error) { 307 ucom_detach(ssc, &sc[0]); 308 return (error); 309 } 310 /* increment reference count */ 311 ucom_ref(ssc); 312 313 /* set subunit attached */ 314 sc[subunit].sc_flag |= UCOM_FLAG_ATTACHED; 315 } 316 317 DPRINTF("tp = %p, unit = %d, subunits = %d\n", 318 sc->sc_tty, ssc->sc_unit, ssc->sc_subunits); 319 320 return (0); 321} 322 323/* 324 * The following function will do nothing if the structure pointed to 325 * by "ssc" and "sc" is zero or has already been detached. 326 */ 327void 328ucom_detach(struct ucom_super_softc *ssc, struct ucom_softc *sc) 329{ 330 int subunit; 331 332 if (!(ssc->sc_flag & UCOM_FLAG_ATTACHED)) 333 return; /* not initialized */ 334 335 if (ssc->sc_sysctl_ttyname != NULL) { 336 sysctl_remove_oid(ssc->sc_sysctl_ttyname, 1, 0); 337 ssc->sc_sysctl_ttyname = NULL; 338 } 339 340 if (ssc->sc_sysctl_ttyports != NULL) { 341 sysctl_remove_oid(ssc->sc_sysctl_ttyports, 1, 0); 342 ssc->sc_sysctl_ttyports = NULL; 343 } 344 345 usb_proc_drain(&ssc->sc_tq); 346 347 for (subunit = 0; subunit < ssc->sc_subunits; subunit++) { 348 if (sc[subunit].sc_flag & UCOM_FLAG_ATTACHED) { 349 350 ucom_detach_tty(ssc, &sc[subunit]); 351 352 /* avoid duplicate detach */ 353 sc[subunit].sc_flag &= ~UCOM_FLAG_ATTACHED; 354 } 355 } 356 usb_proc_free(&ssc->sc_tq); 357 358 ucom_unref(ssc); 359 360 if (ssc->sc_flag & UCOM_FLAG_WAIT_REFS) 361 ucom_drain(ssc); 362 363 /* make sure we don't detach twice */ 364 ssc->sc_flag &= ~UCOM_FLAG_ATTACHED; 365} 366 367void 368ucom_drain(struct ucom_super_softc *ssc) 369{ 370 mtx_lock(&ucom_mtx); 371 while (ssc->sc_refs > 0) { 372 printf("ucom: Waiting for a TTY device to close.\n"); 373 usb_pause_mtx(&ucom_mtx, hz); 374 } 375 mtx_unlock(&ucom_mtx); 376} 377 378void 379ucom_drain_all(void *arg) 380{ 381 mtx_lock(&ucom_mtx); 382 while (ucom_close_refs > 0) { 383 printf("ucom: Waiting for all detached TTY " 384 "devices to have open fds closed.\n"); 385 usb_pause_mtx(&ucom_mtx, hz); 386 } 387 mtx_unlock(&ucom_mtx); 388} 389 390static int 391ucom_attach_tty(struct ucom_super_softc *ssc, struct ucom_softc *sc) 392{ 393 struct tty *tp; 394 char buf[32]; /* temporary TTY device name buffer */ 395 396 tp = tty_alloc_mutex(&ucom_class, sc, sc->sc_mtx); 397 if (tp == NULL) 398 return (ENOMEM); 399 400 /* Check if the client has a custom TTY name */ 401 buf[0] = '\0'; 402 if (sc->sc_callback->ucom_tty_name) { 403 sc->sc_callback->ucom_tty_name(sc, buf, 404 sizeof(buf), ssc->sc_unit, sc->sc_subunit); 405 } 406 if (buf[0] == 0) { 407 /* Use default TTY name */ 408 if (ssc->sc_subunits > 1) { 409 /* multiple modems in one */ 410 snprintf(buf, sizeof(buf), UCOM_TTY_PREFIX "%u.%u", 411 ssc->sc_unit, sc->sc_subunit); 412 } else { 413 /* single modem */ 414 snprintf(buf, sizeof(buf), UCOM_TTY_PREFIX "%u", 415 ssc->sc_unit); 416 } 417 } 418 tty_makedev(tp, NULL, "%s", buf); 419 420 sc->sc_tty = tp; 421 422 DPRINTF("ttycreate: %s\n", buf); 423 424 /* Check if this device should be a console */ 425 if ((ucom_cons_softc == NULL) && 426 (ssc->sc_unit == ucom_cons_unit) && 427 (sc->sc_subunit == ucom_cons_subunit)) { 428 429 DPRINTF("unit %d subunit %d is console", 430 ssc->sc_unit, sc->sc_subunit); 431 432 ucom_cons_softc = sc; 433 434 tty_init_console(tp, ucom_cons_baud); 435 436 UCOM_MTX_LOCK(ucom_cons_softc); 437 ucom_cons_rx_low = 0; 438 ucom_cons_rx_high = 0; 439 ucom_cons_tx_low = 0; 440 ucom_cons_tx_high = 0; 441 sc->sc_flag |= UCOM_FLAG_CONSOLE; 442 ucom_open(ucom_cons_softc->sc_tty); 443 ucom_param(ucom_cons_softc->sc_tty, &tp->t_termios_init_in); 444 UCOM_MTX_UNLOCK(ucom_cons_softc); 445 } 446 447 return (0); 448} 449 450static void 451ucom_detach_tty(struct ucom_super_softc *ssc, struct ucom_softc *sc) 452{ 453 struct tty *tp = sc->sc_tty; 454 455 DPRINTF("sc = %p, tp = %p\n", sc, sc->sc_tty); 456 457 if (sc->sc_flag & UCOM_FLAG_CONSOLE) { 458 UCOM_MTX_LOCK(ucom_cons_softc); 459 ucom_close(ucom_cons_softc->sc_tty); 460 sc->sc_flag &= ~UCOM_FLAG_CONSOLE; 461 UCOM_MTX_UNLOCK(ucom_cons_softc); 462 ucom_cons_softc = NULL; 463 } 464 465 /* the config thread has been stopped when we get here */ 466 467 UCOM_MTX_LOCK(sc); 468 sc->sc_flag |= UCOM_FLAG_GONE; 469 sc->sc_flag &= ~(UCOM_FLAG_HL_READY | UCOM_FLAG_LL_READY); 470 UCOM_MTX_UNLOCK(sc); 471 472 if (tp) { 473 mtx_lock(&ucom_mtx); 474 ucom_close_refs++; 475 mtx_unlock(&ucom_mtx); 476 477 tty_lock(tp); 478 479 ucom_close(tp); /* close, if any */ 480 481 tty_rel_gone(tp); 482 483 UCOM_MTX_LOCK(sc); 484 /* 485 * make sure that read and write transfers are stopped 486 */ 487 if (sc->sc_callback->ucom_stop_read) 488 (sc->sc_callback->ucom_stop_read) (sc); 489 if (sc->sc_callback->ucom_stop_write) 490 (sc->sc_callback->ucom_stop_write) (sc); 491 UCOM_MTX_UNLOCK(sc); 492 } 493} 494 495void 496ucom_set_pnpinfo_usb(struct ucom_super_softc *ssc, device_t dev) 497{ 498 char buf[64]; 499 uint8_t iface_index; 500 struct usb_attach_arg *uaa; 501 502 snprintf(buf, sizeof(buf), "ttyname=" UCOM_TTY_PREFIX 503 "%d ttyports=%d", ssc->sc_unit, ssc->sc_subunits); 504 505 /* Store the PNP info in the first interface for the device */ 506 uaa = device_get_ivars(dev); 507 iface_index = uaa->info.bIfaceIndex; 508 509 if (usbd_set_pnpinfo(uaa->device, iface_index, buf) != 0) 510 device_printf(dev, "Could not set PNP info\n"); 511 512 /* 513 * The following information is also replicated in the PNP-info 514 * string which is registered above: 515 */ 516 if (ssc->sc_sysctl_ttyname == NULL) { 517 ssc->sc_sysctl_ttyname = SYSCTL_ADD_STRING(NULL, 518 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), 519 OID_AUTO, "ttyname", CTLFLAG_RD, ssc->sc_ttyname, 0, 520 "TTY device basename"); 521 } 522 if (ssc->sc_sysctl_ttyports == NULL) { 523 ssc->sc_sysctl_ttyports = SYSCTL_ADD_INT(NULL, 524 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), 525 OID_AUTO, "ttyports", CTLFLAG_RD, 526 NULL, ssc->sc_subunits, "Number of ports"); 527 } 528} 529 530static void 531ucom_queue_command(struct ucom_softc *sc, 532 usb_proc_callback_t *fn, struct termios *pt, 533 struct usb_proc_msg *t0, struct usb_proc_msg *t1) 534{ 535 struct ucom_super_softc *ssc = sc->sc_super; 536 struct ucom_param_task *task; 537 538 UCOM_MTX_ASSERT(sc, MA_OWNED); 539 540 if (usb_proc_is_gone(&ssc->sc_tq)) { 541 DPRINTF("proc is gone\n"); 542 return; /* nothing to do */ 543 } 544 /* 545 * NOTE: The task cannot get executed before we drop the 546 * "sc_mtx" mutex. It is safe to update fields in the message 547 * structure after that the message got queued. 548 */ 549 task = (struct ucom_param_task *) 550 usb_proc_msignal(&ssc->sc_tq, t0, t1); 551 552 /* Setup callback and softc pointers */ 553 task->hdr.pm_callback = fn; 554 task->sc = sc; 555 556 /* 557 * Make a copy of the termios. This field is only present if 558 * the "pt" field is not NULL. 559 */ 560 if (pt != NULL) 561 task->termios_copy = *pt; 562 563 /* 564 * Closing the device should be synchronous. 565 */ 566 if (fn == ucom_cfg_close) 567 usb_proc_mwait(&ssc->sc_tq, t0, t1); 568 569 /* 570 * In case of multiple configure requests, 571 * keep track of the last one! 572 */ 573 if (fn == ucom_cfg_start_transfers) 574 sc->sc_last_start_xfer = &task->hdr; 575} 576 577static void 578ucom_shutdown(struct ucom_softc *sc) 579{ 580 struct tty *tp = sc->sc_tty; 581 582 UCOM_MTX_ASSERT(sc, MA_OWNED); 583 584 DPRINTF("\n"); 585 586 /* 587 * Hang up if necessary: 588 */ 589 if (tp->t_termios.c_cflag & HUPCL) { 590 ucom_modem(tp, 0, SER_DTR); 591 } 592} 593 594/* 595 * Return values: 596 * 0: normal 597 * else: taskqueue is draining or gone 598 */ 599uint8_t 600ucom_cfg_is_gone(struct ucom_softc *sc) 601{ 602 struct ucom_super_softc *ssc = sc->sc_super; 603 604 return (usb_proc_is_gone(&ssc->sc_tq)); 605} 606 607static void 608ucom_cfg_start_transfers(struct usb_proc_msg *_task) 609{ 610 struct ucom_cfg_task *task = 611 (struct ucom_cfg_task *)_task; 612 struct ucom_softc *sc = task->sc; 613 614 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) { 615 return; 616 } 617 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 618 /* TTY device closed */ 619 return; 620 } 621 622 if (_task == sc->sc_last_start_xfer) 623 sc->sc_flag |= UCOM_FLAG_GP_DATA; 624 625 if (sc->sc_callback->ucom_start_read) { 626 (sc->sc_callback->ucom_start_read) (sc); 627 } 628 if (sc->sc_callback->ucom_start_write) { 629 (sc->sc_callback->ucom_start_write) (sc); 630 } 631} 632 633static void 634ucom_start_transfers(struct ucom_softc *sc) 635{ 636 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 637 return; 638 } 639 /* 640 * Make sure that data transfers are started in both 641 * directions: 642 */ 643 if (sc->sc_callback->ucom_start_read) { 644 (sc->sc_callback->ucom_start_read) (sc); 645 } 646 if (sc->sc_callback->ucom_start_write) { 647 (sc->sc_callback->ucom_start_write) (sc); 648 } 649} 650 651static void 652ucom_cfg_open(struct usb_proc_msg *_task) 653{ 654 struct ucom_cfg_task *task = 655 (struct ucom_cfg_task *)_task; 656 struct ucom_softc *sc = task->sc; 657 658 DPRINTF("\n"); 659 660 if (sc->sc_flag & UCOM_FLAG_LL_READY) { 661 662 /* already opened */ 663 664 } else { 665 666 sc->sc_flag |= UCOM_FLAG_LL_READY; 667 668 if (sc->sc_callback->ucom_cfg_open) { 669 (sc->sc_callback->ucom_cfg_open) (sc); 670 671 /* wait a little */ 672 usb_pause_mtx(sc->sc_mtx, hz / 10); 673 } 674 } 675} 676 677static int 678ucom_open(struct tty *tp) 679{ 680 struct ucom_softc *sc = tty_softc(tp); 681 int error; 682 683 UCOM_MTX_ASSERT(sc, MA_OWNED); 684 685 if (sc->sc_flag & UCOM_FLAG_GONE) { 686 return (ENXIO); 687 } 688 if (sc->sc_flag & UCOM_FLAG_HL_READY) { 689 /* already opened */ 690 return (0); 691 } 692 DPRINTF("tp = %p\n", tp); 693 694 if (sc->sc_callback->ucom_pre_open) { 695 /* 696 * give the lower layer a chance to disallow TTY open, for 697 * example if the device is not present: 698 */ 699 error = (sc->sc_callback->ucom_pre_open) (sc); 700 if (error) { 701 return (error); 702 } 703 } 704 sc->sc_flag |= UCOM_FLAG_HL_READY; 705 706 /* Disable transfers */ 707 sc->sc_flag &= ~UCOM_FLAG_GP_DATA; 708 709 sc->sc_lsr = 0; 710 sc->sc_msr = 0; 711 sc->sc_mcr = 0; 712 713 /* reset programmed line state */ 714 sc->sc_pls_curr = 0; 715 sc->sc_pls_set = 0; 716 sc->sc_pls_clr = 0; 717 718 /* reset jitter buffer */ 719 sc->sc_jitterbuf_in = 0; 720 sc->sc_jitterbuf_out = 0; 721 722 ucom_queue_command(sc, ucom_cfg_open, NULL, 723 &sc->sc_open_task[0].hdr, 724 &sc->sc_open_task[1].hdr); 725 726 /* Queue transfer enable command last */ 727 ucom_queue_command(sc, ucom_cfg_start_transfers, NULL, 728 &sc->sc_start_task[0].hdr, 729 &sc->sc_start_task[1].hdr); 730 731 ucom_modem(tp, SER_DTR | SER_RTS, 0); 732 733 ucom_ring(sc, 0); 734 735 ucom_break(sc, 0); 736 737 ucom_status_change(sc); 738 739 return (0); 740} 741 742static void 743ucom_cfg_close(struct usb_proc_msg *_task) 744{ 745 struct ucom_cfg_task *task = 746 (struct ucom_cfg_task *)_task; 747 struct ucom_softc *sc = task->sc; 748 749 DPRINTF("\n"); 750 751 if (sc->sc_flag & UCOM_FLAG_LL_READY) { 752 sc->sc_flag &= ~UCOM_FLAG_LL_READY; 753 if (sc->sc_callback->ucom_cfg_close) 754 (sc->sc_callback->ucom_cfg_close) (sc); 755 } else { 756 /* already closed */ 757 } 758} 759 760static void 761ucom_close(struct tty *tp) 762{ 763 struct ucom_softc *sc = tty_softc(tp); 764 765 UCOM_MTX_ASSERT(sc, MA_OWNED); 766 767 DPRINTF("tp=%p\n", tp); 768 769 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 770 DPRINTF("tp=%p already closed\n", tp); 771 return; 772 } 773 ucom_shutdown(sc); 774 775 ucom_queue_command(sc, ucom_cfg_close, NULL, 776 &sc->sc_close_task[0].hdr, 777 &sc->sc_close_task[1].hdr); 778 779 sc->sc_flag &= ~(UCOM_FLAG_HL_READY | UCOM_FLAG_RTS_IFLOW); 780 781 if (sc->sc_callback->ucom_stop_read) { 782 (sc->sc_callback->ucom_stop_read) (sc); 783 } 784} 785 786static void 787ucom_inwakeup(struct tty *tp) 788{ 789 struct ucom_softc *sc = tty_softc(tp); 790 uint16_t pos; 791 792 if (sc == NULL) 793 return; 794 795 tty_lock(tp); 796 797 if (ttydisc_can_bypass(tp) != 0 || 798 (sc->sc_flag & UCOM_FLAG_HL_READY) == 0) { 799 tty_unlock(tp); 800 return; 801 } 802 803 pos = sc->sc_jitterbuf_out; 804 805 while (sc->sc_jitterbuf_in != pos) { 806 int c; 807 808 c = (char)sc->sc_jitterbuf[pos]; 809 810 if (ttydisc_rint(tp, c, 0) == -1) 811 break; 812 pos++; 813 if (pos >= UCOM_JITTERBUF_SIZE) 814 pos -= UCOM_JITTERBUF_SIZE; 815 } 816 817 sc->sc_jitterbuf_out = pos; 818 819 /* clear RTS in async fashion */ 820 if ((sc->sc_jitterbuf_in == pos) && 821 (sc->sc_flag & UCOM_FLAG_RTS_IFLOW)) 822 ucom_rts(sc, 0); 823 824 tty_unlock(tp); 825} 826 827static int 828ucom_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td) 829{ 830 struct ucom_softc *sc = tty_softc(tp); 831 int error; 832 833 UCOM_MTX_ASSERT(sc, MA_OWNED); 834 835 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 836 return (EIO); 837 } 838 DPRINTF("cmd = 0x%08lx\n", cmd); 839 840 switch (cmd) { 841#if 0 842 case TIOCSRING: 843 ucom_ring(sc, 1); 844 error = 0; 845 break; 846 case TIOCCRING: 847 ucom_ring(sc, 0); 848 error = 0; 849 break; 850#endif 851 case TIOCSBRK: 852 ucom_break(sc, 1); 853 error = 0; 854 break; 855 case TIOCCBRK: 856 ucom_break(sc, 0); 857 error = 0; 858 break; 859 default: 860 if (sc->sc_callback->ucom_ioctl) { 861 error = (sc->sc_callback->ucom_ioctl) 862 (sc, cmd, data, 0, td); 863 } else { 864 error = ENOIOCTL; 865 } 866 break; 867 } 868 return (error); 869} 870 871static int 872ucom_modem(struct tty *tp, int sigon, int sigoff) 873{ 874 struct ucom_softc *sc = tty_softc(tp); 875 uint8_t onoff; 876 877 UCOM_MTX_ASSERT(sc, MA_OWNED); 878 879 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 880 return (0); 881 } 882 if ((sigon == 0) && (sigoff == 0)) { 883 884 if (sc->sc_mcr & SER_DTR) { 885 sigon |= SER_DTR; 886 } 887 if (sc->sc_mcr & SER_RTS) { 888 sigon |= SER_RTS; 889 } 890 if (sc->sc_msr & SER_CTS) { 891 sigon |= SER_CTS; 892 } 893 if (sc->sc_msr & SER_DCD) { 894 sigon |= SER_DCD; 895 } 896 if (sc->sc_msr & SER_DSR) { 897 sigon |= SER_DSR; 898 } 899 if (sc->sc_msr & SER_RI) { 900 sigon |= SER_RI; 901 } 902 return (sigon); 903 } 904 if (sigon & SER_DTR) { 905 sc->sc_mcr |= SER_DTR; 906 } 907 if (sigoff & SER_DTR) { 908 sc->sc_mcr &= ~SER_DTR; 909 } 910 if (sigon & SER_RTS) { 911 sc->sc_mcr |= SER_RTS; 912 } 913 if (sigoff & SER_RTS) { 914 sc->sc_mcr &= ~SER_RTS; 915 } 916 onoff = (sc->sc_mcr & SER_DTR) ? 1 : 0; 917 ucom_dtr(sc, onoff); 918 919 onoff = (sc->sc_mcr & SER_RTS) ? 1 : 0; 920 ucom_rts(sc, onoff); 921 922 return (0); 923} 924 925static void 926ucom_cfg_line_state(struct usb_proc_msg *_task) 927{ 928 struct ucom_cfg_task *task = 929 (struct ucom_cfg_task *)_task; 930 struct ucom_softc *sc = task->sc; 931 uint8_t notch_bits; 932 uint8_t any_bits; 933 uint8_t prev_value; 934 uint8_t last_value; 935 uint8_t mask; 936 937 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) { 938 return; 939 } 940 941 mask = 0; 942 /* compute callback mask */ 943 if (sc->sc_callback->ucom_cfg_set_dtr) 944 mask |= UCOM_LS_DTR; 945 if (sc->sc_callback->ucom_cfg_set_rts) 946 mask |= UCOM_LS_RTS; 947 if (sc->sc_callback->ucom_cfg_set_break) 948 mask |= UCOM_LS_BREAK; 949 if (sc->sc_callback->ucom_cfg_set_ring) 950 mask |= UCOM_LS_RING; 951 952 /* compute the bits we are to program */ 953 notch_bits = (sc->sc_pls_set & sc->sc_pls_clr) & mask; 954 any_bits = (sc->sc_pls_set | sc->sc_pls_clr) & mask; 955 prev_value = sc->sc_pls_curr ^ notch_bits; 956 last_value = sc->sc_pls_curr; 957 958 /* reset programmed line state */ 959 sc->sc_pls_curr = 0; 960 sc->sc_pls_set = 0; 961 sc->sc_pls_clr = 0; 962 963 /* ensure that we don't loose any levels */ 964 if (notch_bits & UCOM_LS_DTR) 965 sc->sc_callback->ucom_cfg_set_dtr(sc, 966 (prev_value & UCOM_LS_DTR) ? 1 : 0); 967 if (notch_bits & UCOM_LS_RTS) 968 sc->sc_callback->ucom_cfg_set_rts(sc, 969 (prev_value & UCOM_LS_RTS) ? 1 : 0); 970 if (notch_bits & UCOM_LS_BREAK) 971 sc->sc_callback->ucom_cfg_set_break(sc, 972 (prev_value & UCOM_LS_BREAK) ? 1 : 0); 973 if (notch_bits & UCOM_LS_RING) 974 sc->sc_callback->ucom_cfg_set_ring(sc, 975 (prev_value & UCOM_LS_RING) ? 1 : 0); 976 977 /* set last value */ 978 if (any_bits & UCOM_LS_DTR) 979 sc->sc_callback->ucom_cfg_set_dtr(sc, 980 (last_value & UCOM_LS_DTR) ? 1 : 0); 981 if (any_bits & UCOM_LS_RTS) 982 sc->sc_callback->ucom_cfg_set_rts(sc, 983 (last_value & UCOM_LS_RTS) ? 1 : 0); 984 if (any_bits & UCOM_LS_BREAK) 985 sc->sc_callback->ucom_cfg_set_break(sc, 986 (last_value & UCOM_LS_BREAK) ? 1 : 0); 987 if (any_bits & UCOM_LS_RING) 988 sc->sc_callback->ucom_cfg_set_ring(sc, 989 (last_value & UCOM_LS_RING) ? 1 : 0); 990} 991 992static void 993ucom_line_state(struct ucom_softc *sc, 994 uint8_t set_bits, uint8_t clear_bits) 995{ 996 UCOM_MTX_ASSERT(sc, MA_OWNED); 997 998 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 999 return; 1000 } 1001 1002 DPRINTF("on=0x%02x, off=0x%02x\n", set_bits, clear_bits); 1003 1004 /* update current programmed line state */ 1005 sc->sc_pls_curr |= set_bits; 1006 sc->sc_pls_curr &= ~clear_bits; 1007 sc->sc_pls_set |= set_bits; 1008 sc->sc_pls_clr |= clear_bits; 1009 1010 /* defer driver programming */ 1011 ucom_queue_command(sc, ucom_cfg_line_state, NULL, 1012 &sc->sc_line_state_task[0].hdr, 1013 &sc->sc_line_state_task[1].hdr); 1014} 1015 1016static void 1017ucom_ring(struct ucom_softc *sc, uint8_t onoff) 1018{ 1019 DPRINTF("onoff = %d\n", onoff); 1020 1021 if (onoff) 1022 ucom_line_state(sc, UCOM_LS_RING, 0); 1023 else 1024 ucom_line_state(sc, 0, UCOM_LS_RING); 1025} 1026 1027static void 1028ucom_break(struct ucom_softc *sc, uint8_t onoff) 1029{ 1030 DPRINTF("onoff = %d\n", onoff); 1031 1032 if (onoff) 1033 ucom_line_state(sc, UCOM_LS_BREAK, 0); 1034 else 1035 ucom_line_state(sc, 0, UCOM_LS_BREAK); 1036} 1037 1038static void 1039ucom_dtr(struct ucom_softc *sc, uint8_t onoff) 1040{ 1041 DPRINTF("onoff = %d\n", onoff); 1042 1043 if (onoff) 1044 ucom_line_state(sc, UCOM_LS_DTR, 0); 1045 else 1046 ucom_line_state(sc, 0, UCOM_LS_DTR); 1047} 1048 1049static void 1050ucom_rts(struct ucom_softc *sc, uint8_t onoff) 1051{ 1052 DPRINTF("onoff = %d\n", onoff); 1053 1054 if (onoff) 1055 ucom_line_state(sc, UCOM_LS_RTS, 0); 1056 else 1057 ucom_line_state(sc, 0, UCOM_LS_RTS); 1058} 1059 1060static void 1061ucom_cfg_status_change(struct usb_proc_msg *_task) 1062{ 1063 struct ucom_cfg_task *task = 1064 (struct ucom_cfg_task *)_task; 1065 struct ucom_softc *sc = task->sc; 1066 struct tty *tp; 1067 uint8_t new_msr; 1068 uint8_t new_lsr; 1069 uint8_t onoff; 1070 uint8_t lsr_delta; 1071 1072 tp = sc->sc_tty; 1073 1074 UCOM_MTX_ASSERT(sc, MA_OWNED); 1075 1076 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) { 1077 return; 1078 } 1079 if (sc->sc_callback->ucom_cfg_get_status == NULL) { 1080 return; 1081 } 1082 /* get status */ 1083 1084 new_msr = 0; 1085 new_lsr = 0; 1086 1087 (sc->sc_callback->ucom_cfg_get_status) (sc, &new_lsr, &new_msr); 1088 1089 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 1090 /* TTY device closed */ 1091 return; 1092 } 1093 onoff = ((sc->sc_msr ^ new_msr) & SER_DCD); 1094 lsr_delta = (sc->sc_lsr ^ new_lsr); 1095 1096 sc->sc_msr = new_msr; 1097 sc->sc_lsr = new_lsr; 1098 1099 if (onoff) { 1100 1101 onoff = (sc->sc_msr & SER_DCD) ? 1 : 0; 1102 1103 DPRINTF("DCD changed to %d\n", onoff); 1104 1105 ttydisc_modem(tp, onoff); 1106 } 1107 1108 if ((lsr_delta & ULSR_BI) && (sc->sc_lsr & ULSR_BI)) { 1109 1110 DPRINTF("BREAK detected\n"); 1111 1112 ttydisc_rint(tp, 0, TRE_BREAK); 1113 ttydisc_rint_done(tp); 1114 } 1115 1116 if ((lsr_delta & ULSR_FE) && (sc->sc_lsr & ULSR_FE)) { 1117 1118 DPRINTF("Frame error detected\n"); 1119 1120 ttydisc_rint(tp, 0, TRE_FRAMING); 1121 ttydisc_rint_done(tp); 1122 } 1123 1124 if ((lsr_delta & ULSR_PE) && (sc->sc_lsr & ULSR_PE)) { 1125 1126 DPRINTF("Parity error detected\n"); 1127 1128 ttydisc_rint(tp, 0, TRE_PARITY); 1129 ttydisc_rint_done(tp); 1130 } 1131} 1132 1133void 1134ucom_status_change(struct ucom_softc *sc) 1135{ 1136 UCOM_MTX_ASSERT(sc, MA_OWNED); 1137 1138 if (sc->sc_flag & UCOM_FLAG_CONSOLE) 1139 return; /* not supported */ 1140 1141 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 1142 return; 1143 } 1144 DPRINTF("\n"); 1145 1146 ucom_queue_command(sc, ucom_cfg_status_change, NULL, 1147 &sc->sc_status_task[0].hdr, 1148 &sc->sc_status_task[1].hdr); 1149} 1150 1151static void 1152ucom_cfg_param(struct usb_proc_msg *_task) 1153{ 1154 struct ucom_param_task *task = 1155 (struct ucom_param_task *)_task; 1156 struct ucom_softc *sc = task->sc; 1157 1158 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) { 1159 return; 1160 } 1161 if (sc->sc_callback->ucom_cfg_param == NULL) { 1162 return; 1163 } 1164 1165 (sc->sc_callback->ucom_cfg_param) (sc, &task->termios_copy); 1166 1167 /* wait a little */ 1168 usb_pause_mtx(sc->sc_mtx, hz / 10); 1169} 1170 1171static int 1172ucom_param(struct tty *tp, struct termios *t) 1173{ 1174 struct ucom_softc *sc = tty_softc(tp); 1175 uint8_t opened; 1176 int error; 1177 1178 UCOM_MTX_ASSERT(sc, MA_OWNED); 1179 1180 opened = 0; 1181 error = 0; 1182 1183 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 1184 1185 /* XXX the TTY layer should call "open()" first! */ 1186 /* 1187 * Not quite: Its ordering is partly backwards, but 1188 * some parameters must be set early in ttydev_open(), 1189 * possibly before calling ttydevsw_open(). 1190 */ 1191 error = ucom_open(tp); 1192 if (error) 1193 goto done; 1194 1195 opened = 1; 1196 } 1197 DPRINTF("sc = %p\n", sc); 1198 1199 /* Check requested parameters. */ 1200 if (t->c_ispeed && (t->c_ispeed != t->c_ospeed)) { 1201 /* XXX c_ospeed == 0 is perfectly valid. */ 1202 DPRINTF("mismatch ispeed and ospeed\n"); 1203 error = EINVAL; 1204 goto done; 1205 } 1206 t->c_ispeed = t->c_ospeed; 1207 1208 if (sc->sc_callback->ucom_pre_param) { 1209 /* Let the lower layer verify the parameters */ 1210 error = (sc->sc_callback->ucom_pre_param) (sc, t); 1211 if (error) { 1212 DPRINTF("callback error = %d\n", error); 1213 goto done; 1214 } 1215 } 1216 1217 /* Disable transfers */ 1218 sc->sc_flag &= ~UCOM_FLAG_GP_DATA; 1219 1220 /* Queue baud rate programming command first */ 1221 ucom_queue_command(sc, ucom_cfg_param, t, 1222 &sc->sc_param_task[0].hdr, 1223 &sc->sc_param_task[1].hdr); 1224 1225 /* Queue transfer enable command last */ 1226 ucom_queue_command(sc, ucom_cfg_start_transfers, NULL, 1227 &sc->sc_start_task[0].hdr, 1228 &sc->sc_start_task[1].hdr); 1229 1230 if (t->c_cflag & CRTS_IFLOW) { 1231 sc->sc_flag |= UCOM_FLAG_RTS_IFLOW; 1232 } else if (sc->sc_flag & UCOM_FLAG_RTS_IFLOW) { 1233 sc->sc_flag &= ~UCOM_FLAG_RTS_IFLOW; 1234 ucom_modem(tp, SER_RTS, 0); 1235 } 1236done: 1237 if (error) { 1238 if (opened) { 1239 ucom_close(tp); 1240 } 1241 } 1242 return (error); 1243} 1244 1245static void 1246ucom_outwakeup(struct tty *tp) 1247{ 1248 struct ucom_softc *sc = tty_softc(tp); 1249 1250 UCOM_MTX_ASSERT(sc, MA_OWNED); 1251 1252 DPRINTF("sc = %p\n", sc); 1253 1254 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) { 1255 /* The higher layer is not ready */ 1256 return; 1257 } 1258 ucom_start_transfers(sc); 1259} 1260 1261/*------------------------------------------------------------------------* 1262 * ucom_get_data 1263 * 1264 * Return values: 1265 * 0: No data is available. 1266 * Else: Data is available. 1267 *------------------------------------------------------------------------*/ 1268uint8_t 1269ucom_get_data(struct ucom_softc *sc, struct usb_page_cache *pc, 1270 uint32_t offset, uint32_t len, uint32_t *actlen) 1271{ 1272 struct usb_page_search res; 1273 struct tty *tp = sc->sc_tty; 1274 uint32_t cnt; 1275 uint32_t offset_orig; 1276 1277 UCOM_MTX_ASSERT(sc, MA_OWNED); 1278 1279 if (sc->sc_flag & UCOM_FLAG_CONSOLE) { 1280 unsigned int temp; 1281 1282 /* get total TX length */ 1283 1284 temp = ucom_cons_tx_high - ucom_cons_tx_low; 1285 temp %= UCOM_CONS_BUFSIZE; 1286 1287 /* limit TX length */ 1288 1289 if (temp > (UCOM_CONS_BUFSIZE - ucom_cons_tx_low)) 1290 temp = (UCOM_CONS_BUFSIZE - ucom_cons_tx_low); 1291 1292 if (temp > len) 1293 temp = len; 1294 1295 /* copy in data */ 1296 1297 usbd_copy_in(pc, offset, ucom_cons_tx_buf + ucom_cons_tx_low, temp); 1298 1299 /* update counters */ 1300 1301 ucom_cons_tx_low += temp; 1302 ucom_cons_tx_low %= UCOM_CONS_BUFSIZE; 1303 1304 /* store actual length */ 1305 1306 *actlen = temp; 1307 1308 return (temp ? 1 : 0); 1309 } 1310 1311 if (tty_gone(tp) || 1312 !(sc->sc_flag & UCOM_FLAG_GP_DATA)) { 1313 actlen[0] = 0; 1314 return (0); /* multiport device polling */ 1315 } 1316 offset_orig = offset; 1317 1318 while (len != 0) { 1319 1320 usbd_get_page(pc, offset, &res); 1321 1322 if (res.length > len) { 1323 res.length = len; 1324 } 1325 /* copy data directly into USB buffer */ 1326 cnt = ttydisc_getc(tp, res.buffer, res.length); 1327 1328 offset += cnt; 1329 len -= cnt; 1330 1331 if (cnt < res.length) { 1332 /* end of buffer */ 1333 break; 1334 } 1335 } 1336 1337 actlen[0] = offset - offset_orig; 1338 1339 DPRINTF("cnt=%d\n", actlen[0]); 1340 1341 if (actlen[0] == 0) { 1342 return (0); 1343 } 1344 return (1); 1345} 1346 1347void 1348ucom_put_data(struct ucom_softc *sc, struct usb_page_cache *pc, 1349 uint32_t offset, uint32_t len) 1350{ 1351 struct usb_page_search res; 1352 struct tty *tp = sc->sc_tty; 1353 char *buf; 1354 uint32_t cnt; 1355 1356 UCOM_MTX_ASSERT(sc, MA_OWNED); 1357 1358 if (sc->sc_flag & UCOM_FLAG_CONSOLE) { 1359 unsigned int temp; 1360 1361 /* get maximum RX length */ 1362 1363 temp = (UCOM_CONS_BUFSIZE - 1) - ucom_cons_rx_high + ucom_cons_rx_low; 1364 temp %= UCOM_CONS_BUFSIZE; 1365 1366 /* limit RX length */ 1367 1368 if (temp > (UCOM_CONS_BUFSIZE - ucom_cons_rx_high)) 1369 temp = (UCOM_CONS_BUFSIZE - ucom_cons_rx_high); 1370 1371 if (temp > len) 1372 temp = len; 1373 1374 /* copy out data */ 1375 1376 usbd_copy_out(pc, offset, ucom_cons_rx_buf + ucom_cons_rx_high, temp); 1377 1378 /* update counters */ 1379 1380 ucom_cons_rx_high += temp; 1381 ucom_cons_rx_high %= UCOM_CONS_BUFSIZE; 1382 1383 return; 1384 } 1385 1386 if (tty_gone(tp)) 1387 return; /* multiport device polling */ 1388 1389 if (len == 0) 1390 return; /* no data */ 1391 1392 /* set a flag to prevent recursation ? */ 1393 1394 while (len > 0) { 1395 1396 usbd_get_page(pc, offset, &res); 1397 1398 if (res.length > len) { 1399 res.length = len; 1400 } 1401 len -= res.length; 1402 offset += res.length; 1403 1404 /* pass characters to tty layer */ 1405 1406 buf = res.buffer; 1407 cnt = res.length; 1408 1409 /* first check if we can pass the buffer directly */ 1410 1411 if (ttydisc_can_bypass(tp)) { 1412 1413 /* clear any jitter buffer */ 1414 sc->sc_jitterbuf_in = 0; 1415 sc->sc_jitterbuf_out = 0; 1416 1417 if (ttydisc_rint_bypass(tp, buf, cnt) != cnt) { 1418 DPRINTF("tp=%p, data lost\n", tp); 1419 } 1420 continue; 1421 } 1422 /* need to loop */ 1423 1424 for (cnt = 0; cnt != res.length; cnt++) { 1425 if (sc->sc_jitterbuf_in != sc->sc_jitterbuf_out || 1426 ttydisc_rint(tp, buf[cnt], 0) == -1) { 1427 uint16_t end; 1428 uint16_t pos; 1429 1430 pos = sc->sc_jitterbuf_in; 1431 end = sc->sc_jitterbuf_out + 1432 UCOM_JITTERBUF_SIZE - 1; 1433 if (end >= UCOM_JITTERBUF_SIZE) 1434 end -= UCOM_JITTERBUF_SIZE; 1435 1436 for (; cnt != res.length; cnt++) { 1437 if (pos == end) 1438 break; 1439 sc->sc_jitterbuf[pos] = buf[cnt]; 1440 pos++; 1441 if (pos >= UCOM_JITTERBUF_SIZE) 1442 pos -= UCOM_JITTERBUF_SIZE; 1443 } 1444 1445 sc->sc_jitterbuf_in = pos; 1446 1447 /* set RTS in async fashion */ 1448 if (sc->sc_flag & UCOM_FLAG_RTS_IFLOW) 1449 ucom_rts(sc, 1); 1450 1451 DPRINTF("tp=%p, lost %d " 1452 "chars\n", tp, res.length - cnt); 1453 break; 1454 } 1455 } 1456 } 1457 ttydisc_rint_done(tp); 1458} 1459 1460static void 1461ucom_free(void *xsc) 1462{ 1463 struct ucom_softc *sc = xsc; 1464 1465 if (sc->sc_callback->ucom_free != NULL) 1466 sc->sc_callback->ucom_free(sc); 1467 else 1468 ucom_unref(sc->sc_super); 1469 1470 mtx_lock(&ucom_mtx); 1471 ucom_close_refs--; 1472 mtx_unlock(&ucom_mtx); 1473} 1474 1475static cn_probe_t ucom_cnprobe; 1476static cn_init_t ucom_cninit; 1477static cn_term_t ucom_cnterm; 1478static cn_getc_t ucom_cngetc; 1479static cn_putc_t ucom_cnputc; 1480static cn_grab_t ucom_cngrab; 1481static cn_ungrab_t ucom_cnungrab; 1482 1483CONSOLE_DRIVER(ucom); 1484 1485static void 1486ucom_cnprobe(struct consdev *cp) 1487{ 1488 if (ucom_cons_unit != -1) 1489 cp->cn_pri = CN_NORMAL; 1490 else 1491 cp->cn_pri = CN_DEAD; 1492 1493 strlcpy(cp->cn_name, "ucom", sizeof(cp->cn_name)); 1494} 1495 1496static void 1497ucom_cninit(struct consdev *cp) 1498{ 1499} 1500 1501static void 1502ucom_cnterm(struct consdev *cp) 1503{ 1504} 1505 1506static void 1507ucom_cngrab(struct consdev *cp) 1508{ 1509} 1510 1511static void 1512ucom_cnungrab(struct consdev *cp) 1513{ 1514} 1515 1516static int 1517ucom_cngetc(struct consdev *cd) 1518{ 1519 struct ucom_softc *sc = ucom_cons_softc; 1520 int c; 1521 1522 if (sc == NULL) 1523 return (-1); 1524 1525 UCOM_MTX_LOCK(sc); 1526 1527 if (ucom_cons_rx_low != ucom_cons_rx_high) { 1528 c = ucom_cons_rx_buf[ucom_cons_rx_low]; 1529 ucom_cons_rx_low ++; 1530 ucom_cons_rx_low %= UCOM_CONS_BUFSIZE; 1531 } else { 1532 c = -1; 1533 } 1534 1535 /* start USB transfers */ 1536 ucom_outwakeup(sc->sc_tty); 1537 1538 UCOM_MTX_UNLOCK(sc); 1539 1540 /* poll if necessary */ 1541 if (kdb_active && sc->sc_callback->ucom_poll) 1542 (sc->sc_callback->ucom_poll) (sc); 1543 1544 return (c); 1545} 1546 1547static void 1548ucom_cnputc(struct consdev *cd, int c) 1549{ 1550 struct ucom_softc *sc = ucom_cons_softc; 1551 unsigned int temp; 1552 1553 if (sc == NULL) 1554 return; 1555 1556 repeat: 1557 1558 UCOM_MTX_LOCK(sc); 1559 1560 /* compute maximum TX length */ 1561 1562 temp = (UCOM_CONS_BUFSIZE - 1) - ucom_cons_tx_high + ucom_cons_tx_low; 1563 temp %= UCOM_CONS_BUFSIZE; 1564 1565 if (temp) { 1566 ucom_cons_tx_buf[ucom_cons_tx_high] = c; 1567 ucom_cons_tx_high ++; 1568 ucom_cons_tx_high %= UCOM_CONS_BUFSIZE; 1569 } 1570 1571 /* start USB transfers */ 1572 ucom_outwakeup(sc->sc_tty); 1573 1574 UCOM_MTX_UNLOCK(sc); 1575 1576 /* poll if necessary */ 1577 if (kdb_active && sc->sc_callback->ucom_poll) { 1578 (sc->sc_callback->ucom_poll) (sc); 1579 /* simple flow control */ 1580 if (temp == 0) 1581 goto repeat; 1582 } 1583} 1584 1585/*------------------------------------------------------------------------* 1586 * ucom_ref 1587 * 1588 * This function will increment the super UCOM reference count. 1589 *------------------------------------------------------------------------*/ 1590void 1591ucom_ref(struct ucom_super_softc *ssc) 1592{ 1593 mtx_lock(&ucom_mtx); 1594 ssc->sc_refs++; 1595 mtx_unlock(&ucom_mtx); 1596} 1597 1598/*------------------------------------------------------------------------* 1599 * ucom_free_unit 1600 * 1601 * This function will free the super UCOM's allocated unit 1602 * number. This function can be called on a zero-initialized 1603 * structure. This function can be called multiple times. 1604 *------------------------------------------------------------------------*/ 1605static void 1606ucom_free_unit(struct ucom_super_softc *ssc) 1607{ 1608 if (!(ssc->sc_flag & UCOM_FLAG_FREE_UNIT)) 1609 return; 1610 1611 ucom_unit_free(ssc->sc_unit); 1612 1613 ssc->sc_flag &= ~UCOM_FLAG_FREE_UNIT; 1614} 1615 1616/*------------------------------------------------------------------------* 1617 * ucom_unref 1618 * 1619 * This function will decrement the super UCOM reference count. 1620 * 1621 * Return values: 1622 * 0: UCOM structures are still referenced. 1623 * Else: UCOM structures are no longer referenced. 1624 *------------------------------------------------------------------------*/ 1625int 1626ucom_unref(struct ucom_super_softc *ssc) 1627{ 1628 int retval; 1629 1630 mtx_lock(&ucom_mtx); 1631 retval = (ssc->sc_refs < 2); 1632 ssc->sc_refs--; 1633 mtx_unlock(&ucom_mtx); 1634 1635 if (retval) 1636 ucom_free_unit(ssc); 1637 1638 return (retval); 1639} 1640 1641#if defined(GDB) 1642 1643#include <gdb/gdb.h> 1644 1645static gdb_probe_f ucom_gdbprobe; 1646static gdb_init_f ucom_gdbinit; 1647static gdb_term_f ucom_gdbterm; 1648static gdb_getc_f ucom_gdbgetc; 1649static gdb_putc_f ucom_gdbputc; 1650 1651GDB_DBGPORT(sio, ucom_gdbprobe, ucom_gdbinit, ucom_gdbterm, ucom_gdbgetc, ucom_gdbputc); 1652 1653static int 1654ucom_gdbprobe(void) 1655{ 1656 return ((ucom_cons_softc != NULL) ? 0 : -1); 1657} 1658 1659static void 1660ucom_gdbinit(void) 1661{ 1662} 1663 1664static void 1665ucom_gdbterm(void) 1666{ 1667} 1668 1669static void 1670ucom_gdbputc(int c) 1671{ 1672 ucom_cnputc(NULL, c); 1673} 1674 1675static int 1676ucom_gdbgetc(void) 1677{ 1678 return (ucom_cngetc(NULL)); 1679} 1680 1681#endif 1682