1 /* $NetBSD: ucom.c,v 1.40 2001/11/13 06:24:54 lukem Exp $ */
4 * Copyright (c) 2001-2003, 2005, 2008
5 * Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
31 * Copyright (c) 1998, 2000 The NetBSD Foundation, Inc.
32 * All rights reserved.
34 * This code is derived from software contributed to The NetBSD Foundation
35 * by Lennart Augustsson (lennart@augustsson.net) at
36 * Carlstedt Research & Technology.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the NetBSD
49 * Foundation, Inc. and its contributors.
50 * 4. Neither the name of The NetBSD Foundation nor the names of its
51 * contributors may be used to endorse or promote products derived
52 * from this software without specific prior written permission.
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.
69 * This is a Frankenstein of FreeBSD's usb4bsd ucom and Dragonfly's old ucom
70 * module. There might be bugs lurking everywhere still
72 * In particular serial console on ucom is completely untested and likely broken
73 * as well as anyting that requires the modem control lines.
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>
83 #include <sys/module.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>
92 #include <sys/serial.h>
93 #include <sys/thread2.h>
95 #include <sys/clist.h>
97 #include <bus/u4b/usb.h>
98 #include <bus/u4b/usbdi.h>
99 #include <bus/u4b/usbdi_util.h>
101 #define USB_DEBUG_VAR ucom_debug
102 #include <bus/u4b/usb_debug.h>
103 #include <bus/u4b/usb_busdma.h>
104 #include <bus/u4b/usb_process.h>
106 #include <bus/u4b/serial/usb_serial.h>
108 //#include "opt_gdb.h"
110 static SYSCTL_NODE(_hw_usb, OID_AUTO, ucom, CTLFLAG_RW, 0, "USB ucom");
113 static int ucom_debug = 0;
115 SYSCTL_INT(_hw_usb_ucom, OID_AUTO, debug, CTLFLAG_RW,
116 &ucom_debug, 0, "ucom debug level");
119 #define UCOM_CONS_BUFSIZE 1024
121 static uint8_t ucom_cons_rx_buf[UCOM_CONS_BUFSIZE];
122 static uint8_t ucom_cons_tx_buf[UCOM_CONS_BUFSIZE];
124 static unsigned int ucom_cons_rx_low = 0;
125 static unsigned int ucom_cons_rx_high = 0;
127 static unsigned int ucom_cons_tx_low = 0;
128 static unsigned int ucom_cons_tx_high = 0;
130 static int ucom_cons_unit = -1;
131 static int ucom_cons_subunit = 0;
132 static int ucom_cons_baud = 9600;
133 static struct ucom_softc *ucom_cons_softc = NULL;
135 TUNABLE_INT("hw.usb.ucom.cons_unit", &ucom_cons_unit);
136 SYSCTL_INT(_hw_usb_ucom, OID_AUTO, cons_unit, CTLFLAG_RW,
137 &ucom_cons_unit, 0, "console unit number");
138 TUNABLE_INT("hw.usb.ucom.cons_subunit", &ucom_cons_subunit);
139 SYSCTL_INT(_hw_usb_ucom, OID_AUTO, cons_subunit, CTLFLAG_RW,
140 &ucom_cons_subunit, 0, "console subunit number");
141 TUNABLE_INT("hw.usb.ucom.cons_baud", &ucom_cons_baud);
142 SYSCTL_INT(_hw_usb_ucom, OID_AUTO, cons_baud, CTLFLAG_RW,
143 &ucom_cons_baud, 0, "console baud rate");
145 static usb_proc_callback_t ucom_cfg_start_transfers;
146 static usb_proc_callback_t ucom_cfg_open;
147 static usb_proc_callback_t ucom_cfg_close;
148 static usb_proc_callback_t ucom_cfg_line_state;
149 static usb_proc_callback_t ucom_cfg_status_change;
150 static usb_proc_callback_t ucom_cfg_param;
152 static int ucom_unit_alloc(void);
153 static void ucom_unit_free(int);
154 static int ucom_attach_tty(struct ucom_super_softc *, struct ucom_softc *);
155 static void ucom_detach_tty(struct ucom_super_softc *, struct ucom_softc *);
156 static void ucom_queue_command(struct ucom_softc *,
157 usb_proc_callback_t *, struct termios *pt,
158 struct usb_proc_msg *t0, struct usb_proc_msg *t1);
159 static void ucom_shutdown(struct ucom_softc *);
160 static void ucom_ring(struct ucom_softc *, uint8_t);
161 static void ucom_break(struct ucom_softc *, uint8_t);
162 static void ucom_dtr(struct ucom_softc *, uint8_t);
163 static void ucom_rts(struct ucom_softc *, uint8_t);
165 static int ucom_open(struct ucom_softc *sc);
166 static int ucom_close(struct ucom_softc *sc);
167 static void ucom_start(struct tty *tp);
168 static void ucom_stop(struct tty *tp, int);
169 static int ucom_param(struct tty *tp, struct termios *t);
170 static int ucom_modem(struct tty *tp, int sigon, int sigoff);
172 static int ucom_fromtio(int);
173 static int ucom_totio(int);
175 static void disc_optim(struct tty *, struct termios *, struct ucom_softc *);
177 static d_open_t ucom_dev_open;
178 static d_close_t ucom_dev_close;
179 static d_read_t ucom_dev_read;
180 static d_write_t ucom_dev_write;
181 static d_ioctl_t ucom_dev_ioctl;
183 static struct dev_ops ucom_ops = {
184 { "ucom", 0, D_MPSAFE | D_TTY },
185 .d_open = ucom_dev_open,
186 .d_close = ucom_dev_close,
187 .d_read = ucom_dev_read,
188 .d_write = ucom_dev_write,
189 .d_ioctl = ucom_dev_ioctl,
190 .d_kqfilter = ttykqfilter,
191 .d_revoke = ttyrevoke
194 static moduledata_t ucom_mod = {
200 DECLARE_MODULE(ucom, ucom_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
201 MODULE_DEPEND(ucom, usb, 1, 1, 1);
202 MODULE_VERSION(ucom, UCOM_MODVER);
205 #define tty_gone(tp) ((tp->t_state) & (TS_ZOMBIE))
207 #define UCOM_UNIT_MAX 128 /* maximum number of units */
208 #define UCOM_TTY_PREFIX "ucom"
210 static struct unrhdr *ucom_unrhdr;
211 static struct lock ucom_lock;
212 static int ucom_close_refs;
218 ucom_unrhdr = new_unrhdr(0, UCOM_UNIT_MAX - 1, NULL);
219 lockinit(&ucom_lock, "UCOM LOCK", 0, 0);
221 SYSINIT(ucom_init, SI_BOOT2_KLD - 1, SI_ORDER_ANY, ucom_init, NULL);
224 ucom_uninit(void *arg)
235 lockuninit(&ucom_lock);
237 SYSUNINIT(ucom_uninit, SI_BOOT2_KLD - 2, SI_ORDER_ANY, ucom_uninit, NULL);
240 * Mark a unit number (the X in cuaUX) as in use.
242 * Note that devices using a different naming scheme (see ucom_tty_name()
243 * callback) still use this unit allocation.
246 ucom_unit_alloc(void)
251 if (ucom_unrhdr == NULL) {
252 DPRINTF("ucom_unrhdr is NULL\n");
255 unit = alloc_unr(ucom_unrhdr);
256 DPRINTF("unit %d is allocated\n", unit);
261 * Mark the unit number as not in use.
264 ucom_unit_free(int unit)
267 if (unit < 0 || unit >= UCOM_UNIT_MAX || ucom_unrhdr == NULL) {
268 DPRINTF("cannot free unit number\n");
271 DPRINTF("unit %d is freed\n", unit);
272 free_unr(ucom_unrhdr, unit);
276 * Setup a group of one or more serial ports.
278 * The lock pointed to by "lock" is applied before all
279 * callbacks are called back. Also "lock" must be applied
280 * before calling into the ucom-layer!
283 ucom_attach(struct ucom_super_softc *ssc, struct ucom_softc *sc,
284 int subunits, void *parent,
285 const struct ucom_callback *callback, struct lock *lock)
292 (callback == NULL) ||
297 /* XXX Do we want our own lock here maybe */
300 /* allocate a uniq unit number */
301 ssc->sc_unit = ucom_unit_alloc();
302 if (ssc->sc_unit == -1)
305 /* generate TTY name string */
306 ksnprintf(ssc->sc_ttyname, sizeof(ssc->sc_ttyname),
307 UCOM_TTY_PREFIX "%d", ssc->sc_unit);
309 /* create USB request handling process */
310 error = usb_proc_create(&ssc->sc_tq, lock, "ucom", USB_PRI_MED);
312 ucom_unit_free(ssc->sc_unit);
315 ssc->sc_subunits = subunits;
316 ssc->sc_flag = UCOM_FLAG_ATTACHED |
319 if (callback->ucom_free == NULL)
320 ssc->sc_flag |= UCOM_FLAG_WAIT_REFS;
322 /* increment reference count */
325 for (subunit = 0; subunit < ssc->sc_subunits; subunit++) {
326 sc[subunit].sc_subunit = subunit;
327 sc[subunit].sc_super = ssc;
328 sc[subunit].sc_lock = lock;
329 sc[subunit].sc_parent = parent;
330 sc[subunit].sc_callback = callback;
332 error = ucom_attach_tty(ssc, &sc[subunit]);
334 ucom_detach(ssc, &sc[0]);
337 /* increment reference count */
340 /* set subunit attached */
341 sc[subunit].sc_flag |= UCOM_FLAG_ATTACHED;
344 DPRINTF("tp = %p, unit = %d, subunits = %d\n",
345 sc->sc_tty, ssc->sc_unit, ssc->sc_subunits);
351 * The following function will do nothing if the structure pointed to
352 * by "ssc" and "sc" is zero or has already been detached.
355 ucom_detach(struct ucom_super_softc *ssc, struct ucom_softc *sc)
359 if (!(ssc->sc_flag & UCOM_FLAG_ATTACHED))
360 return; /* not initialized */
362 destroy_dev(sc->sc_cdev);
364 lwkt_gettoken(&tty_token);
366 if (ssc->sc_sysctl_ttyname != NULL) {
367 sysctl_remove_oid(ssc->sc_sysctl_ttyname, 1, 0);
368 ssc->sc_sysctl_ttyname = NULL;
371 if (ssc->sc_sysctl_ttyports != NULL) {
372 sysctl_remove_oid(ssc->sc_sysctl_ttyports, 1, 0);
373 ssc->sc_sysctl_ttyports = NULL;
376 usb_proc_drain(&ssc->sc_tq);
378 for (subunit = 0; subunit < ssc->sc_subunits; subunit++) {
379 if (sc[subunit].sc_flag & UCOM_FLAG_ATTACHED) {
380 ucom_detach_tty(ssc, &sc[subunit]);
382 /* avoid duplicate detach */
383 sc[subunit].sc_flag &= ~UCOM_FLAG_ATTACHED;
386 usb_proc_free(&ssc->sc_tq);
390 if (ssc->sc_flag & UCOM_FLAG_WAIT_REFS)
393 /* make sure we don't detach twice */
394 ssc->sc_flag &= ~UCOM_FLAG_ATTACHED;
396 lwkt_reltoken(&tty_token);
400 ucom_drain(struct ucom_super_softc *ssc)
402 lockmgr(&ucom_lock, LK_EXCLUSIVE);
403 while (ssc->sc_refs > 0) {
404 kprintf("ucom: Waiting for a TTY device to close.\n");
405 usb_pause_mtx(&ucom_lock, hz);
407 lockmgr(&ucom_lock, LK_RELEASE);
411 ucom_drain_all(void *arg)
413 lockmgr(&ucom_lock, LK_EXCLUSIVE);
414 while (ucom_close_refs > 0) {
415 kprintf("ucom: Waiting for all detached TTY "
416 "devices to have open fds closed.\n");
417 usb_pause_mtx(&ucom_lock, hz);
419 lockmgr(&ucom_lock, LK_RELEASE);
423 ucom_attach_tty(struct ucom_super_softc *ssc, struct ucom_softc *sc)
426 char buf[32]; /* temporary TTY device name buffer */
429 lwkt_gettoken(&tty_token);
431 sc->sc_tty = tp = ttymalloc(sc->sc_tty);
434 lwkt_reltoken(&tty_token);
438 tp->t_sc = (void *)sc;
440 tp->t_oproc = ucom_start;
441 tp->t_param = ucom_param;
442 tp->t_stop = ucom_stop;
444 /* Check if the client has a custom TTY name */
446 if (sc->sc_callback->ucom_tty_name) {
447 sc->sc_callback->ucom_tty_name(sc, buf,
448 sizeof(buf), ssc->sc_unit, sc->sc_subunit);
451 /* Use default TTY name */
452 if (ssc->sc_subunits > 1) {
453 /* multiple modems in one */
454 ksnprintf(buf, sizeof(buf), UCOM_TTY_PREFIX "%u.%u",
455 ssc->sc_unit, sc->sc_subunit);
458 ksnprintf(buf, sizeof(buf), UCOM_TTY_PREFIX "%u",
463 dev = make_dev(&ucom_ops, ssc->sc_unit | 0x80, // XXX UCOM_CALLOUT_MASK,
464 UID_UUCP, GID_DIALER, 0660,
471 DPRINTF("ttycreate: %s\n", buf);
473 /* Check if this device should be a console */
474 if ((ucom_cons_softc == NULL) &&
475 (ssc->sc_unit == ucom_cons_unit) &&
476 (sc->sc_subunit == ucom_cons_subunit)) {
478 DPRINTF("unit %d subunit %d is console",
479 ssc->sc_unit, sc->sc_subunit);
481 ucom_cons_softc = sc;
484 tty_init_console(tp, ucom_cons_baud);
486 tp->t_termios.c_ispeed = ucom_cons_baud;
487 tp->t_termios.c_ospeed = ucom_cons_baud;
489 UCOM_MTX_LOCK(ucom_cons_softc);
490 ucom_cons_rx_low = 0;
491 ucom_cons_rx_high = 0;
492 ucom_cons_tx_low = 0;
493 ucom_cons_tx_high = 0;
494 sc->sc_flag |= UCOM_FLAG_CONSOLE;
496 ucom_open(ucom_cons_softc);
497 ucom_param(tp, &tp->t_termios);
498 UCOM_MTX_UNLOCK(ucom_cons_softc);
501 lwkt_reltoken(&tty_token);
506 ucom_detach_tty(struct ucom_super_softc *ssc, struct ucom_softc *sc)
508 struct tty *tp = sc->sc_tty;
510 DPRINTF("sc = %p, tp = %p\n", sc, sc->sc_tty);
512 if (sc->sc_flag & UCOM_FLAG_CONSOLE) {
513 UCOM_MTX_LOCK(ucom_cons_softc);
514 ucom_close(ucom_cons_softc);
515 sc->sc_flag &= ~UCOM_FLAG_CONSOLE;
516 UCOM_MTX_UNLOCK(ucom_cons_softc);
517 ucom_cons_softc = NULL;
520 /* the config thread has been stopped when we get here */
523 sc->sc_flag |= UCOM_FLAG_GONE;
524 sc->sc_flag &= ~(UCOM_FLAG_HL_READY | UCOM_FLAG_LL_READY);
527 lwkt_gettoken(&tty_token);
532 if (tp->t_state & TS_ISOPEN) {
533 kprintf("device still open, forcing close\n");
534 (*linesw[tp->t_line].l_close)(tp, 0);
537 ucom_close(sc); /* close, if any */
540 * make sure that read and write transfers are stopped
542 if (sc->sc_callback->ucom_stop_read) {
543 (sc->sc_callback->ucom_stop_read) (sc);
545 if (sc->sc_callback->ucom_stop_write) {
546 (sc->sc_callback->ucom_stop_write) (sc);
553 dev_ops_remove_minor(&ucom_ops,ssc->sc_unit);
555 lwkt_reltoken(&tty_token);
560 ucom_set_pnpinfo_usb(struct ucom_super_softc *ssc, device_t dev)
564 struct usb_attach_arg *uaa;
566 ksnprintf(buf, sizeof(buf), "ttyname=" UCOM_TTY_PREFIX
567 "%d ttyports=%d", ssc->sc_unit, ssc->sc_subunits);
569 /* Store the PNP info in the first interface for the device */
570 uaa = device_get_ivars(dev);
571 iface_index = uaa->info.bIfaceIndex;
573 if (usbd_set_pnpinfo(uaa->device, iface_index, buf) != 0)
574 device_printf(dev, "Could not set PNP info\n");
577 * The following information is also replicated in the PNP-info
578 * string which is registered above:
580 if (ssc->sc_sysctl_ttyname == NULL) {
582 ssc->sc_sysctl_ttyname = SYSCTL_ADD_STRING(NULL,
583 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
584 OID_AUTO, "ttyname", CTLFLAG_RD, ssc->sc_ttyname, 0,
585 "TTY device basename");
588 if (ssc->sc_sysctl_ttyports == NULL) {
590 ssc->sc_sysctl_ttyports = SYSCTL_ADD_INT(NULL,
591 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
592 OID_AUTO, "ttyports", CTLFLAG_RD,
593 NULL, ssc->sc_subunits, "Number of ports");
599 ucom_queue_command(struct ucom_softc *sc,
600 usb_proc_callback_t *fn, struct termios *pt,
601 struct usb_proc_msg *t0, struct usb_proc_msg *t1)
603 struct ucom_super_softc *ssc = sc->sc_super;
604 struct ucom_param_task *task;
606 UCOM_MTX_ASSERT(sc, MA_OWNED);
608 if (usb_proc_is_gone(&ssc->sc_tq)) {
609 DPRINTF("proc is gone\n");
610 return; /* nothing to do */
613 * NOTE: The task cannot get executed before we drop the
614 * "sc_lock" lock. It is safe to update fields in the message
615 * structure after that the message got queued.
617 task = (struct ucom_param_task *)
618 usb_proc_msignal(&ssc->sc_tq, t0, t1);
620 /* Setup callback and softc pointers */
621 task->hdr.pm_callback = fn;
625 * Make a copy of the termios. This field is only present if
626 * the "pt" field is not NULL.
629 task->termios_copy = *pt;
632 * Closing the device should be synchronous.
634 if (fn == ucom_cfg_close)
635 usb_proc_mwait(&ssc->sc_tq, t0, t1);
638 * In case of multiple configure requests,
639 * keep track of the last one!
641 if (fn == ucom_cfg_start_transfers)
642 sc->sc_last_start_xfer = &task->hdr;
646 ucom_shutdown(struct ucom_softc *sc)
648 struct tty *tp = sc->sc_tty;
650 UCOM_MTX_ASSERT(sc, MA_OWNED);
655 * Hang up if necessary:
657 if (tp->t_termios.c_cflag & HUPCL) {
658 ucom_modem(tp, 0, SER_DTR);
665 * else: taskqueue is draining or gone
668 ucom_cfg_is_gone(struct ucom_softc *sc)
670 struct ucom_super_softc *ssc = sc->sc_super;
672 return (usb_proc_is_gone(&ssc->sc_tq));
676 ucom_cfg_start_transfers(struct usb_proc_msg *_task)
678 struct ucom_cfg_task *task =
679 (struct ucom_cfg_task *)_task;
680 struct ucom_softc *sc = task->sc;
682 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) {
685 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
686 /* TTY device closed */
690 if (_task == sc->sc_last_start_xfer)
691 sc->sc_flag |= UCOM_FLAG_GP_DATA;
693 if (sc->sc_callback->ucom_start_read) {
694 (sc->sc_callback->ucom_start_read) (sc);
696 if (sc->sc_callback->ucom_start_write) {
697 (sc->sc_callback->ucom_start_write) (sc);
702 ucom_start_transfers(struct ucom_softc *sc)
704 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
708 * Make sure that data transfers are started in both
711 if (sc->sc_callback->ucom_start_read) {
712 (sc->sc_callback->ucom_start_read) (sc);
714 if (sc->sc_callback->ucom_start_write) {
715 (sc->sc_callback->ucom_start_write) (sc);
720 ucom_cfg_open(struct usb_proc_msg *_task)
722 struct ucom_cfg_task *task =
723 (struct ucom_cfg_task *)_task;
724 struct ucom_softc *sc = task->sc;
728 if (sc->sc_flag & UCOM_FLAG_LL_READY) {
734 sc->sc_flag |= UCOM_FLAG_LL_READY;
736 if (sc->sc_callback->ucom_cfg_open) {
737 (sc->sc_callback->ucom_cfg_open) (sc);
740 usb_pause_mtx(sc->sc_lock, hz / 10);
746 ucom_dev_open(struct dev_open_args *ap)
748 cdev_t dev = ap->a_head.a_dev;
749 struct ucom_softc *sc = (struct ucom_softc *)dev->si_drv1;
753 error = ucom_open(sc);
760 ucom_open(struct ucom_softc *sc)
765 if (sc->sc_flag & UCOM_FLAG_GONE) {
768 if (sc->sc_flag & UCOM_FLAG_HL_READY) {
772 DPRINTF("tp = %p\n", sc->sc_tty);
774 if (sc->sc_callback->ucom_pre_open) {
776 * give the lower layer a chance to disallow TTY open, for
777 * example if the device is not present:
779 error = (sc->sc_callback->ucom_pre_open) (sc);
784 sc->sc_flag |= UCOM_FLAG_HL_READY;
786 lwkt_gettoken(&tty_token);
791 if (!ISSET(tp->t_state, TS_ISOPEN)) {
794 tp->t_dev = reference_dev(sc->sc_cdev);
797 t.c_ospeed = TTYDEF_SPEED;
798 t.c_cflag = TTYDEF_CFLAG;
801 tp->t_iflag = TTYDEF_IFLAG;
802 tp->t_oflag = TTYDEF_OFLAG;
803 tp->t_lflag = TTYDEF_LFLAG;
807 /* Disable transfers */
808 sc->sc_flag &= ~UCOM_FLAG_GP_DATA;
814 /* reset programmed line state */
819 /* reset jitter buffer */
820 sc->sc_jitterbuf_in = 0;
821 sc->sc_jitterbuf_out = 0;
823 ucom_queue_command(sc, ucom_cfg_open, NULL,
824 &sc->sc_open_task[0].hdr,
825 &sc->sc_open_task[1].hdr);
827 /* Queue transfer enable command last */
828 ucom_queue_command(sc, ucom_cfg_start_transfers, NULL,
829 &sc->sc_start_task[0].hdr,
830 &sc->sc_start_task[1].hdr);
832 ucom_modem(sc->sc_tty, SER_DTR | SER_RTS, 0);
838 ucom_status_change(sc);
840 if (ISSET(sc->sc_msr, SER_DCD)) {
841 (*linesw[tp->t_line].l_modem)(tp, 1);
846 error = ttyopen(sc->sc_cdev, tp);
848 lwkt_reltoken(&tty_token);
852 error = (*linesw[tp->t_line].l_open)(sc->sc_cdev, tp);
854 lwkt_reltoken(&tty_token);
858 disc_optim(tp, &tp->t_termios, sc);
860 lwkt_reltoken(&tty_token);
866 ucom_cfg_close(struct usb_proc_msg *_task)
868 struct ucom_cfg_task *task =
869 (struct ucom_cfg_task *)_task;
870 struct ucom_softc *sc = task->sc;
874 if (sc->sc_flag & UCOM_FLAG_LL_READY) {
875 sc->sc_flag &= ~UCOM_FLAG_LL_READY;
876 if (sc->sc_callback->ucom_cfg_close)
877 (sc->sc_callback->ucom_cfg_close) (sc);
884 ucom_dev_close(struct dev_close_args *ap)
886 cdev_t dev = ap->a_head.a_dev;
887 struct ucom_softc *sc = (struct ucom_softc *)dev->si_drv1;
891 error = ucom_close(sc);
898 ucom_close(struct ucom_softc *sc)
900 struct tty *tp = sc->sc_tty;
903 DPRINTF("tp=%p\n", tp);
905 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
906 DPRINTF("tp=%p already closed\n", tp);
909 if (!ISSET(tp->t_state, TS_ISOPEN)) {
914 ucom_queue_command(sc, ucom_cfg_close, NULL,
915 &sc->sc_close_task[0].hdr,
916 &sc->sc_close_task[1].hdr);
918 sc->sc_flag &= ~(UCOM_FLAG_HL_READY | UCOM_FLAG_RTS_IFLOW);
920 if (sc->sc_callback->ucom_stop_read) {
921 (sc->sc_callback->ucom_stop_read) (sc);
924 lwkt_gettoken(&tty_token);
926 (*linesw[tp->t_line].l_close)(tp, 0); /* XXX: flags */
927 disc_optim(tp, &tp->t_termios, sc);
932 release_dev(tp->t_dev);
935 /* XXX: Detach wakeup */
936 lwkt_reltoken(&tty_token);
943 ucom_inwakeup(struct tty *tp)
945 struct ucom_softc *sc = tty_softc(tp);
951 UCOM_MTX_ASSERT(sc, MA_OWNED);
953 DPRINTF("tp=%p\n", tp);
955 if (ttydisc_can_bypass(tp) != 0 ||
956 (sc->sc_flag & UCOM_FLAG_HL_READY) == 0 ||
957 (sc->sc_flag & UCOM_FLAG_INWAKEUP) != 0) {
961 /* prevent recursion */
962 sc->sc_flag |= UCOM_FLAG_INWAKEUP;
964 pos = sc->sc_jitterbuf_out;
966 while (sc->sc_jitterbuf_in != pos) {
969 c = (char)sc->sc_jitterbuf[pos];
971 if (ttydisc_rint(tp, c, 0) == -1)
974 if (pos >= UCOM_JITTERBUF_SIZE)
975 pos -= UCOM_JITTERBUF_SIZE;
978 sc->sc_jitterbuf_out = pos;
980 /* clear RTS in async fashion */
981 if ((sc->sc_jitterbuf_in == pos) &&
982 (sc->sc_flag & UCOM_FLAG_RTS_IFLOW))
985 sc->sc_flag &= ~UCOM_FLAG_INWAKEUP;
990 ucom_dev_read(struct dev_read_args *ap)
992 cdev_t dev = ap->a_head.a_dev;
993 struct ucom_softc *sc;
999 lwkt_gettoken(&tty_token);
1006 DPRINTF("tp = %p, flag = 0x%x\n", tp, ap->a_ioflag);
1009 error = (*linesw[tp->t_line].l_read)(tp, ap->a_uio, ap->a_ioflag);
1010 UCOM_MTX_UNLOCK(sc);
1012 DPRINTF("error = %d\n", error);
1014 lwkt_reltoken(&tty_token);
1019 ucom_dev_write(struct dev_write_args *ap)
1021 cdev_t dev = ap->a_head.a_dev;
1022 struct ucom_softc *sc;
1026 lwkt_gettoken(&tty_token);
1032 DPRINTF("tp = %p, flag = 0x%x\n", tp, ap->a_ioflag);
1035 error = (*linesw[tp->t_line].l_write)(tp, ap->a_uio, ap->a_ioflag);
1036 UCOM_MTX_UNLOCK(sc);
1038 DPRINTF("ucomwrite: error = %d\n", error);
1040 lwkt_reltoken(&tty_token);
1045 ucom_dev_ioctl(struct dev_ioctl_args *ap)
1047 cdev_t dev = ap->a_head.a_dev;
1048 struct ucom_softc *sc = (struct ucom_softc *)dev->si_drv1;
1049 u_long cmd = ap->a_cmd;
1050 caddr_t data = ap->a_data;
1051 struct tty *tp = sc->sc_tty;
1056 lwkt_gettoken(&tty_token);
1058 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1059 lwkt_reltoken(&tty_token);
1062 DPRINTF("cmd = 0x%08lx\n", cmd);
1064 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data,
1065 ap->a_fflag, ap->a_cred);
1067 if (error != ENOIOCTL) {
1068 DPRINTF("ucomioctl: l_ioctl: error = %d\n", error);
1069 lwkt_reltoken(&tty_token);
1070 UCOM_MTX_UNLOCK(sc);
1076 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
1077 disc_optim(tp, &tp->t_termios, sc);
1078 if (error != ENOIOCTL) {
1080 DPRINTF("ucomioctl: ttioctl: error = %d\n", error);
1081 lwkt_reltoken(&tty_token);
1082 UCOM_MTX_UNLOCK(sc);
1115 d = *(int *)ap->a_data;
1116 DPRINTF("ucomioctl: TIOCMSET, 0x%x\n", d);
1117 ucom_modem(tp, ucom_fromtio(d), 0);
1120 d = ucom_modem(tp, 0, 0);
1121 DPRINTF("ucomioctl: TIOCMGET, 0x%x\n", d);
1122 *(int *)ap->a_data = ucom_totio(d);
1125 d = *(int *)ap->a_data;
1126 ucom_modem(tp, ucom_fromtio(d), 0);
1129 d = *(int *)ap->a_data;
1130 ucom_modem(tp, 0, ucom_fromtio(d));
1133 if (sc->sc_callback->ucom_ioctl) {
1134 error = (sc->sc_callback->ucom_ioctl)
1135 (sc, cmd, data, 0, curthread);
1139 lwkt_reltoken(&tty_token);
1140 UCOM_MTX_UNLOCK(sc);
1151 lwkt_reltoken(&tty_token);
1152 UCOM_MTX_UNLOCK(sc);
1158 ucom_totio(int bits)
1162 SET(bits, TIOCM_LE);
1164 if (ISSET(bits, SER_DTR)) {
1165 SET(rbits, TIOCM_DTR);
1167 if (ISSET(bits, SER_RTS)) {
1168 SET(rbits, TIOCM_RTS);
1170 if (ISSET(bits, SER_CTS)) {
1171 SET(rbits, TIOCM_CTS);
1173 if (ISSET(bits, SER_DCD)) {
1174 SET(rbits, TIOCM_CD);
1176 if (ISSET(bits, SER_DSR)) {
1177 SET(rbits, TIOCM_DSR);
1179 if (ISSET(bits, SER_RI)) {
1180 SET(rbits, TIOCM_RI);
1187 ucom_fromtio(int bits)
1191 if (ISSET(bits, TIOCM_DTR)) {
1192 SET(rbits, SER_DTR);
1194 if (ISSET(bits, TIOCM_RTS)) {
1195 SET(rbits, SER_RTS);
1197 if (ISSET(bits, TIOCM_CTS)) {
1198 SET(rbits, SER_CTS);
1200 if (ISSET(bits, TIOCM_CD)) {
1201 SET(rbits, SER_DCD);
1203 if (ISSET(bits, TIOCM_DSR)) {
1204 SET(rbits, SER_DSR);
1206 if (ISSET(bits, TIOCM_RI)) {
1214 ucom_modem(struct tty *tp, int sigon, int sigoff)
1216 struct ucom_softc *sc = (struct ucom_softc *)tp->t_sc;
1219 UCOM_MTX_ASSERT(sc, MA_OWNED);
1221 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1224 if ((sigon == 0) && (sigoff == 0)) {
1226 if (sc->sc_mcr & SER_DTR) {
1229 if (sc->sc_mcr & SER_RTS) {
1232 if (sc->sc_msr & SER_CTS) {
1235 if (sc->sc_msr & SER_DCD) {
1238 if (sc->sc_msr & SER_DSR) {
1241 if (sc->sc_msr & SER_RI) {
1246 if (sigon & SER_DTR) {
1247 sc->sc_mcr |= SER_DTR;
1249 if (sigoff & SER_DTR) {
1250 sc->sc_mcr &= ~SER_DTR;
1252 if (sigon & SER_RTS) {
1253 sc->sc_mcr |= SER_RTS;
1255 if (sigoff & SER_RTS) {
1256 sc->sc_mcr &= ~SER_RTS;
1258 onoff = (sc->sc_mcr & SER_DTR) ? 1 : 0;
1259 ucom_dtr(sc, onoff);
1261 onoff = (sc->sc_mcr & SER_RTS) ? 1 : 0;
1262 ucom_rts(sc, onoff);
1268 ucom_cfg_line_state(struct usb_proc_msg *_task)
1270 struct ucom_cfg_task *task =
1271 (struct ucom_cfg_task *)_task;
1272 struct ucom_softc *sc = task->sc;
1279 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) {
1284 /* compute callback mask */
1285 if (sc->sc_callback->ucom_cfg_set_dtr)
1286 mask |= UCOM_LS_DTR;
1287 if (sc->sc_callback->ucom_cfg_set_rts)
1288 mask |= UCOM_LS_RTS;
1289 if (sc->sc_callback->ucom_cfg_set_break)
1290 mask |= UCOM_LS_BREAK;
1291 if (sc->sc_callback->ucom_cfg_set_ring)
1292 mask |= UCOM_LS_RING;
1294 /* compute the bits we are to program */
1295 notch_bits = (sc->sc_pls_set & sc->sc_pls_clr) & mask;
1296 any_bits = (sc->sc_pls_set | sc->sc_pls_clr) & mask;
1297 prev_value = sc->sc_pls_curr ^ notch_bits;
1298 last_value = sc->sc_pls_curr;
1300 /* reset programmed line state */
1301 sc->sc_pls_curr = 0;
1305 /* ensure that we don't lose any levels */
1306 if (notch_bits & UCOM_LS_DTR)
1307 sc->sc_callback->ucom_cfg_set_dtr(sc,
1308 (prev_value & UCOM_LS_DTR) ? 1 : 0);
1309 if (notch_bits & UCOM_LS_RTS)
1310 sc->sc_callback->ucom_cfg_set_rts(sc,
1311 (prev_value & UCOM_LS_RTS) ? 1 : 0);
1312 if (notch_bits & UCOM_LS_BREAK)
1313 sc->sc_callback->ucom_cfg_set_break(sc,
1314 (prev_value & UCOM_LS_BREAK) ? 1 : 0);
1315 if (notch_bits & UCOM_LS_RING)
1316 sc->sc_callback->ucom_cfg_set_ring(sc,
1317 (prev_value & UCOM_LS_RING) ? 1 : 0);
1319 /* set last value */
1320 if (any_bits & UCOM_LS_DTR)
1321 sc->sc_callback->ucom_cfg_set_dtr(sc,
1322 (last_value & UCOM_LS_DTR) ? 1 : 0);
1323 if (any_bits & UCOM_LS_RTS)
1324 sc->sc_callback->ucom_cfg_set_rts(sc,
1325 (last_value & UCOM_LS_RTS) ? 1 : 0);
1326 if (any_bits & UCOM_LS_BREAK)
1327 sc->sc_callback->ucom_cfg_set_break(sc,
1328 (last_value & UCOM_LS_BREAK) ? 1 : 0);
1329 if (any_bits & UCOM_LS_RING)
1330 sc->sc_callback->ucom_cfg_set_ring(sc,
1331 (last_value & UCOM_LS_RING) ? 1 : 0);
1335 ucom_line_state(struct ucom_softc *sc,
1336 uint8_t set_bits, uint8_t clear_bits)
1338 UCOM_MTX_ASSERT(sc, MA_OWNED);
1340 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1344 DPRINTF("on=0x%02x, off=0x%02x\n", set_bits, clear_bits);
1346 /* update current programmed line state */
1347 sc->sc_pls_curr |= set_bits;
1348 sc->sc_pls_curr &= ~clear_bits;
1349 sc->sc_pls_set |= set_bits;
1350 sc->sc_pls_clr |= clear_bits;
1352 /* defer driver programming */
1353 ucom_queue_command(sc, ucom_cfg_line_state, NULL,
1354 &sc->sc_line_state_task[0].hdr,
1355 &sc->sc_line_state_task[1].hdr);
1359 ucom_ring(struct ucom_softc *sc, uint8_t onoff)
1361 DPRINTF("onoff = %d\n", onoff);
1364 ucom_line_state(sc, UCOM_LS_RING, 0);
1366 ucom_line_state(sc, 0, UCOM_LS_RING);
1370 ucom_break(struct ucom_softc *sc, uint8_t onoff)
1372 DPRINTF("onoff = %d\n", onoff);
1375 ucom_line_state(sc, UCOM_LS_BREAK, 0);
1377 ucom_line_state(sc, 0, UCOM_LS_BREAK);
1381 ucom_dtr(struct ucom_softc *sc, uint8_t onoff)
1383 DPRINTF("onoff = %d\n", onoff);
1386 ucom_line_state(sc, UCOM_LS_DTR, 0);
1388 ucom_line_state(sc, 0, UCOM_LS_DTR);
1392 ucom_rts(struct ucom_softc *sc, uint8_t onoff)
1394 DPRINTF("onoff = %d\n", onoff);
1397 ucom_line_state(sc, UCOM_LS_RTS, 0);
1399 ucom_line_state(sc, 0, UCOM_LS_RTS);
1403 ucom_cfg_status_change(struct usb_proc_msg *_task)
1405 struct ucom_cfg_task *task =
1406 (struct ucom_cfg_task *)_task;
1407 struct ucom_softc *sc = task->sc;
1416 UCOM_MTX_ASSERT(sc, MA_OWNED);
1418 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) {
1421 if (sc->sc_callback->ucom_cfg_get_status == NULL) {
1429 (sc->sc_callback->ucom_cfg_get_status) (sc, &new_lsr, &new_msr);
1431 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1432 /* TTY device closed */
1435 onoff = ((sc->sc_msr ^ new_msr) & SER_DCD);
1436 lsr_delta = (sc->sc_lsr ^ new_lsr);
1438 sc->sc_msr = new_msr;
1439 sc->sc_lsr = new_lsr;
1443 onoff = (sc->sc_msr & SER_DCD) ? 1 : 0;
1444 DPRINTF("DCD changed to %d\n", onoff);
1445 (*linesw[tp->t_line].l_modem)(tp, onoff);
1448 if ((lsr_delta & ULSR_BI) && (sc->sc_lsr & ULSR_BI)) {
1450 DPRINTF("BREAK detected\n");
1451 (*linesw[tp->t_line].l_rint)(0, tp);
1454 ttydisc_rint(tp, 0, TRE_BREAK);
1455 ttydisc_rint_done(tp);
1459 if ((lsr_delta & ULSR_FE) && (sc->sc_lsr & ULSR_FE)) {
1461 DPRINTF("Frame error detected\n");
1462 (*linesw[tp->t_line].l_rint)(0, tp);
1465 ttydisc_rint(tp, 0, TRE_FRAMING);
1466 ttydisc_rint_done(tp);
1470 if ((lsr_delta & ULSR_PE) && (sc->sc_lsr & ULSR_PE)) {
1472 DPRINTF("Parity error detected\n");
1473 (*linesw[tp->t_line].l_rint)(0, tp);
1475 ttydisc_rint(tp, 0, TRE_PARITY);
1476 ttydisc_rint_done(tp);
1482 ucom_status_change(struct ucom_softc *sc)
1484 UCOM_MTX_ASSERT(sc, MA_OWNED);
1486 if (sc->sc_flag & UCOM_FLAG_CONSOLE)
1487 return; /* not supported */
1489 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1494 ucom_queue_command(sc, ucom_cfg_status_change, NULL,
1495 &sc->sc_status_task[0].hdr,
1496 &sc->sc_status_task[1].hdr);
1500 ucom_cfg_param(struct usb_proc_msg *_task)
1502 struct ucom_param_task *task =
1503 (struct ucom_param_task *)_task;
1504 struct ucom_softc *sc = task->sc;
1506 if (!(sc->sc_flag & UCOM_FLAG_LL_READY)) {
1509 if (sc->sc_callback->ucom_cfg_param == NULL) {
1513 (sc->sc_callback->ucom_cfg_param) (sc, &task->termios_copy);
1516 usb_pause_mtx(sc->sc_lock, hz / 10);
1520 ucom_param(struct tty *tp, struct termios *t)
1522 struct ucom_softc *sc = (struct ucom_softc *)tp->t_sc;
1526 lwkt_gettoken(&tty_token);
1527 UCOM_MTX_ASSERT(sc, MA_OWNED);
1532 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1534 /* XXX the TTY layer should call "open()" first! */
1536 * Not quite: Its ordering is partly backwards, but
1537 * some parameters must be set early in ttydev_open(),
1538 * possibly before calling ttydevsw_open().
1540 error = ucom_open(sc);
1547 DPRINTF("sc = %p\n", sc);
1549 /* Check requested parameters. */
1550 if (t->c_ispeed && (t->c_ispeed != t->c_ospeed)) {
1551 /* XXX c_ospeed == 0 is perfectly valid. */
1552 DPRINTF("mismatch ispeed and ospeed\n");
1556 t->c_ispeed = t->c_ospeed;
1558 if (sc->sc_callback->ucom_pre_param) {
1559 /* Let the lower layer verify the parameters */
1560 error = (sc->sc_callback->ucom_pre_param) (sc, t);
1562 DPRINTF("callback error = %d\n", error);
1567 /* Disable transfers */
1568 sc->sc_flag &= ~UCOM_FLAG_GP_DATA;
1570 /* Queue baud rate programming command first */
1571 ucom_queue_command(sc, ucom_cfg_param, t,
1572 &sc->sc_param_task[0].hdr,
1573 &sc->sc_param_task[1].hdr);
1575 /* Queue transfer enable command last */
1576 ucom_queue_command(sc, ucom_cfg_start_transfers, NULL,
1577 &sc->sc_start_task[0].hdr,
1578 &sc->sc_start_task[1].hdr);
1580 if (t->c_cflag & CRTS_IFLOW) {
1581 sc->sc_flag |= UCOM_FLAG_RTS_IFLOW;
1582 } else if (sc->sc_flag & UCOM_FLAG_RTS_IFLOW) {
1583 sc->sc_flag &= ~UCOM_FLAG_RTS_IFLOW;
1584 ucom_modem(tp, SER_RTS, 0);
1593 lwkt_reltoken(&tty_token);
1598 ucom_start(struct tty *tp)
1600 struct ucom_softc *sc = (struct ucom_softc *)tp->t_sc;
1602 UCOM_MTX_ASSERT(sc, MA_OWNED);
1604 DPRINTF("sc = %p\n", sc);
1606 if (!(sc->sc_flag & UCOM_FLAG_HL_READY)) {
1607 /* The higher layer is not ready */
1611 lwkt_gettoken(&tty_token);
1614 if (tp->t_state & TS_TBLOCK) {
1615 if (ISSET(sc->sc_mcr, SER_RTS) &&
1616 ISSET(sc->sc_flag, UCOM_FLAG_RTS_IFLOW)) {
1617 DPRINTF("ucom_start: clear RTS\n");
1618 (void)ucom_modem(tp, 0, SER_RTS);
1621 if (!ISSET(sc->sc_mcr, SER_RTS) &&
1622 tp->t_rawq.c_cc <= tp->t_ilowat &&
1623 ISSET(sc->sc_flag, UCOM_FLAG_RTS_IFLOW)) {
1624 DPRINTF("ucom_start: set RTS\n");
1625 (void)ucom_modem(tp, SER_RTS, 0);
1629 if (ISSET(tp->t_state, TS_BUSY | TS_TIMEOUT | TS_TTSTOP)) {
1631 DPRINTF("ucom_start: stopped\n");
1635 if (tp->t_outq.c_cc <= tp->t_olowat) {
1636 if (ISSET(tp->t_state, TS_SO_OLOWAT)) {
1637 CLR(tp->t_state, TS_SO_OLOWAT);
1638 wakeup(TSA_OLOWAT(tp));
1640 KNOTE(&tp->t_wkq.ki_note, 0);
1641 if (tp->t_outq.c_cc == 0) {
1642 if (ISSET(tp->t_state, TS_BUSY | TS_SO_OCOMPLETE) ==
1643 TS_SO_OCOMPLETE && tp->t_outq.c_cc == 0) {
1644 CLR(tp->t_state, TS_SO_OCOMPLETE);
1645 wakeup(TSA_OCOMPLETE(tp));
1651 DPRINTF("about to start write?\n");
1652 ucom_start_transfers(sc);
1658 lwkt_reltoken(&tty_token);
1662 ucom_stop(struct tty *tp, int flag)
1664 struct ucom_softc *sc = (struct ucom_softc *)tp->t_sc;
1666 DPRINTF("sc = %p, x = 0x%x\n", sc, flag);
1668 lwkt_gettoken(&tty_token);
1671 * This is just supposed to flush pending receive data,
1672 * not stop the reception of data entirely!
1675 if (sc->sc_callback->ucom_stop_read) {
1676 (sc->sc_callback->ucom_stop_read) (sc);
1678 if (sc->sc_callback->ucom_start_read) {
1679 (sc->sc_callback->ucom_start_read) (sc);
1681 /* ucomstopread(sc);
1685 if (flag & FWRITE) {
1688 if (ISSET(tp->t_state, TS_BUSY)) {
1690 if (!ISSET(tp->t_state, TS_TTSTOP))
1691 SET(tp->t_state, TS_FLUSH);
1697 lwkt_reltoken(&tty_token);
1700 /*------------------------------------------------------------------------*
1703 * len: maximum length of data to get
1705 * Get data from the TTY layer
1708 * 0: No data is available.
1709 * Else: Data is available.
1710 *------------------------------------------------------------------------*/
1712 /* Copy data from the tty layer to usb */
1714 ucom_get_data(struct ucom_softc *sc, struct usb_page_cache *pc,
1715 uint32_t offset, uint32_t len, uint32_t *actlen)
1717 struct usb_page_search res;
1718 struct tty *tp = sc->sc_tty;
1720 uint32_t offset_orig;
1724 UCOM_MTX_ASSERT(sc, MA_OWNED);
1725 if (sc->sc_flag & UCOM_FLAG_CONSOLE) {
1728 /* get total TX length */
1730 temp = ucom_cons_tx_high - ucom_cons_tx_low;
1731 temp %= UCOM_CONS_BUFSIZE;
1733 /* limit TX length */
1735 if (temp > (UCOM_CONS_BUFSIZE - ucom_cons_tx_low))
1736 temp = (UCOM_CONS_BUFSIZE - ucom_cons_tx_low);
1743 usbd_copy_in(pc, offset, ucom_cons_tx_buf + ucom_cons_tx_low, temp);
1745 /* update counters */
1747 ucom_cons_tx_low += temp;
1748 ucom_cons_tx_low %= UCOM_CONS_BUFSIZE;
1750 /* store actual length */
1754 return (temp ? 1 : 0);
1758 !(sc->sc_flag & UCOM_FLAG_GP_DATA)) {
1760 return (0); /* multiport device polling */
1763 offset_orig = offset;
1765 lwkt_gettoken(&tty_token);
1768 usbd_get_page(pc, offset, &res);
1770 /* Buffer bigger than max requested data */
1771 if (res.length > len) {
1774 /* copy data directly into USB buffer */
1775 SET(tp->t_state, TS_BUSY);
1776 cnt = q_to_b(&tp->t_outq, res.buffer, len);
1778 DPRINTF("ucom_get_data: cnt == 0\n");
1779 CLR(tp->t_state, TS_BUSY);
1783 CLR(tp->t_state, TS_BUSY);
1785 /* XXX mp: This breaks avrdude,
1786 does the flush need to happen
1788 if (ISSET(tp->t_state, TS_FLUSH))
1789 CLR(tp->t_state, TS_FLUSH);
1791 ndflush(&tp->t_outq,cnt);
1797 if (cnt < res.length) {
1803 lwkt_reltoken(&tty_token);
1805 actlen[0] = offset - offset_orig;
1807 DPRINTF("cnt=%d\n", actlen[0]);
1809 if (actlen[0] == 0) {
1816 * Write data to the tty layer
1820 ucom_put_data(struct ucom_softc *sc, struct usb_page_cache *pc,
1821 uint32_t offset, uint32_t len)
1823 struct usb_page_search res;
1824 struct tty *tp = sc->sc_tty;
1831 UCOM_MTX_ASSERT(sc, MA_OWNED);
1832 lwkt_gettoken(&tty_token);
1834 if (sc->sc_flag & UCOM_FLAG_CONSOLE) {
1837 /* get maximum RX length */
1839 temp = (UCOM_CONS_BUFSIZE - 1) - ucom_cons_rx_high + ucom_cons_rx_low;
1840 temp %= UCOM_CONS_BUFSIZE;
1842 /* limit RX length */
1844 if (temp > (UCOM_CONS_BUFSIZE - ucom_cons_rx_high))
1845 temp = (UCOM_CONS_BUFSIZE - ucom_cons_rx_high);
1852 usbd_copy_out(pc, offset, ucom_cons_rx_buf + ucom_cons_rx_high, temp);
1854 /* update counters */
1856 ucom_cons_rx_high += temp;
1857 ucom_cons_rx_high %= UCOM_CONS_BUFSIZE;
1859 lwkt_reltoken(&tty_token);
1864 lwkt_reltoken(&tty_token);
1865 return; /* multiport device polling */
1868 lwkt_reltoken(&tty_token);
1869 return; /* no data */
1872 /* set a flag to prevent recursation ? */
1876 usbd_get_page(pc, offset, &res);
1878 if (res.length > len) {
1882 offset += res.length;
1884 /* pass characters to tty layer */
1889 /* first check if we can pass the buffer directly */
1891 if (tp->t_state & TS_CAN_BYPASS_L_RINT) {
1892 /* clear any jitter buffer */
1893 sc->sc_jitterbuf_in = 0;
1894 sc->sc_jitterbuf_out = 0;
1896 if (tp->t_rawq.c_cc + cnt > tp->t_ihiwat
1897 && (sc->sc_flag & UCOM_FLAG_RTS_IFLOW
1898 || tp->t_iflag & IXOFF)
1899 && !(tp->t_state & TS_TBLOCK))
1901 lostcc = b_to_q((char *)buf, cnt, &tp->t_rawq);
1905 if (*buf == sc->hotchar)
1914 if (tp->t_state & TS_TTSTOP
1915 && (tp->t_iflag & IXANY
1916 || tp->t_cc[VSTART] == tp->t_cc[VSTOP])) {
1917 tp->t_state &= ~TS_TTSTOP;
1918 tp->t_lflag &= ~FLUSHO;
1922 kprintf("lost %d chars\n", lostcc);
1925 if (ttydisc_rint_bypass(tp, buf, cnt) != cnt) {
1926 DPRINTF("tp=%p, data lost\n", tp);
1932 for (cnt = 0; cnt != res.length; cnt++) {
1933 if (sc->sc_jitterbuf_in != sc->sc_jitterbuf_out ||
1934 (*linesw[tp->t_line].l_rint)(buf[cnt], tp) == -1) {
1938 pos = sc->sc_jitterbuf_in;
1939 end = sc->sc_jitterbuf_out +
1940 UCOM_JITTERBUF_SIZE - 1;
1942 if (end >= UCOM_JITTERBUF_SIZE)
1943 end -= UCOM_JITTERBUF_SIZE;
1945 for (; cnt != res.length; cnt++) {
1948 sc->sc_jitterbuf[pos] = buf[cnt];
1950 if (pos >= UCOM_JITTERBUF_SIZE)
1951 pos -= UCOM_JITTERBUF_SIZE;
1954 sc->sc_jitterbuf_in = pos;
1956 /* set RTS in async fashion */
1957 if (sc->sc_flag & UCOM_FLAG_RTS_IFLOW)
1960 DPRINTF("tp=%p, lost %d "
1961 "chars\n", tp, res.length - cnt);
1968 lwkt_reltoken(&tty_token);
1970 ttydisc_rint_done(tp);
1976 ucom_free(void *xsc)
1978 struct ucom_softc *sc = xsc;
1980 if (sc->sc_callback->ucom_free != NULL)
1981 sc->sc_callback->ucom_free(sc);
1983 /*ucom_unref(sc->sc_super) XXX hack, see end of ucom_detach_tty() */;
1985 lockmgr(&ucom_lock, LK_EXCLUSIVE);
1987 lockmgr(&ucom_lock, LK_RELEASE);
1990 static cn_probe_t ucom_cnprobe;
1991 static cn_init_t ucom_cninit;
1992 static cn_term_t ucom_cnterm;
1993 static cn_getc_t ucom_cngetc;
1994 static cn_putc_t ucom_cnputc;
1997 static cn_grab_t ucom_cngrab;
1998 static cn_ungrab_t ucom_cnungrab;
1999 CONSOLE_DRIVER(ucom);
2003 ucom_cnprobe(struct consdev *cp)
2005 if (ucom_cons_unit != -1)
2006 cp->cn_pri = CN_NORMAL;
2008 cp->cn_pri = CN_DEAD;
2011 strlcpy(cp->cn_name, "ucom", sizeof(cp->cn_name));
2016 ucom_cninit(struct consdev *cp)
2021 ucom_cnterm(struct consdev *cp)
2026 ucom_cngrab(struct consdev *cp)
2031 ucom_cnungrab(struct consdev *cp)
2036 ucom_cngetc(struct consdev *cd)
2038 struct ucom_softc *sc = ucom_cons_softc;
2046 if (ucom_cons_rx_low != ucom_cons_rx_high) {
2047 c = ucom_cons_rx_buf[ucom_cons_rx_low];
2048 ucom_cons_rx_low ++;
2049 ucom_cons_rx_low %= UCOM_CONS_BUFSIZE;
2054 /* start USB transfers */
2055 ucom_outwakeup(sc->sc_tty);
2057 UCOM_MTX_UNLOCK(sc);
2059 /* poll if necessary */
2061 if (kdb_active && sc->sc_callback->ucom_poll)
2062 (sc->sc_callback->ucom_poll) (sc);
2068 ucom_cnputc(void *cd, int c)
2070 ucom_cnputc(struct consdev *cd, int c)
2074 struct ucom_softc *sc = ucom_cons_softc;
2084 /* compute maximum TX length */
2086 temp = (UCOM_CONS_BUFSIZE - 1) - ucom_cons_tx_high + ucom_cons_tx_low;
2087 temp %= UCOM_CONS_BUFSIZE;
2090 ucom_cons_tx_buf[ucom_cons_tx_high] = c;
2091 ucom_cons_tx_high ++;
2092 ucom_cons_tx_high %= UCOM_CONS_BUFSIZE;
2095 /* start USB transfers */
2096 ucom_outwakeup(sc->sc_tty);
2098 UCOM_MTX_UNLOCK(sc);
2100 /* poll if necessary */
2102 if (kdb_active && sc->sc_callback->ucom_poll) {
2103 (sc->sc_callback->ucom_poll) (sc);
2104 /* simple flow control */
2111 /*------------------------------------------------------------------------*
2114 * This function will increment the super UCOM reference count.
2115 *------------------------------------------------------------------------*/
2117 ucom_ref(struct ucom_super_softc *ssc)
2119 lockmgr(&ucom_lock, LK_EXCLUSIVE);
2121 lockmgr(&ucom_lock, LK_RELEASE);
2124 /*------------------------------------------------------------------------*
2127 * This function will free the super UCOM's allocated unit
2128 * number. This function can be called on a zero-initialized
2129 * structure. This function can be called multiple times.
2130 *------------------------------------------------------------------------*/
2132 ucom_free_unit(struct ucom_super_softc *ssc)
2134 if (!(ssc->sc_flag & UCOM_FLAG_FREE_UNIT))
2137 ucom_unit_free(ssc->sc_unit);
2139 ssc->sc_flag &= ~UCOM_FLAG_FREE_UNIT;
2142 /*------------------------------------------------------------------------*
2145 * This function will decrement the super UCOM reference count.
2148 * 0: UCOM structures are still referenced.
2149 * Else: UCOM structures are no longer referenced.
2150 *------------------------------------------------------------------------*/
2152 ucom_unref(struct ucom_super_softc *ssc)
2156 lockmgr(&ucom_lock, LK_EXCLUSIVE);
2157 retval = (ssc->sc_refs < 2);
2159 lockmgr(&ucom_lock, LK_RELEASE);
2162 ucom_free_unit(ssc);
2168 * NOTE: Must be called with tty_token held.
2171 disc_optim(struct tty *tp, struct termios *t, struct ucom_softc *sc)
2173 ASSERT_LWKT_TOKEN_HELD(&tty_token);
2174 if (!(t->c_iflag & (ICRNL | IGNCR | IMAXBEL | INLCR | ISTRIP | IXON))
2175 && (!(t->c_iflag & BRKINT) || (t->c_iflag & IGNBRK))
2176 && (!(t->c_iflag & PARMRK)
2177 || (t->c_iflag & (IGNPAR | IGNBRK)) == (IGNPAR | IGNBRK))
2178 && !(t->c_lflag & (ECHO | ICANON | IEXTEN | ISIG | PENDIN))
2179 && linesw[tp->t_line].l_rint == ttyinput) {
2180 DPRINTF("disc_optim: bypass l_rint\n");
2181 tp->t_state |= TS_CAN_BYPASS_L_RINT;
2183 DPRINTF("disc_optim: can't bypass l_rint\n");
2184 tp->t_state &= ~TS_CAN_BYPASS_L_RINT;
2186 sc->hotchar = linesw[tp->t_line].l_hotchar;
2191 #include <gdb/gdb.h>
2193 static gdb_probe_f ucom_gdbprobe;
2194 static gdb_init_f ucom_gdbinit;
2195 static gdb_term_f ucom_gdbterm;
2196 static gdb_getc_f ucom_gdbgetc;
2197 static gdb_putc_f ucom_gdbputc;
2199 GDB_DBGPORT(sio, ucom_gdbprobe, ucom_gdbinit, ucom_gdbterm, ucom_gdbgetc, ucom_gdbputc);
2204 return ((ucom_cons_softc != NULL) ? 0 : -1);
2220 ucom_cnputc(NULL, c);
2226 return (ucom_cngetc(NULL));