6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
9 * Subject to the following obligations and disclaimer of warranty, use and
10 * redistribution of this software, in source or object code forms, with or
11 * without modifications are expressly permitted by Whistle Communications;
12 * provided, however, that:
13 * 1. Any and all reproductions of the source or object code must include the
14 * copyright notice above and the following disclaimer of warranties; and
15 * 2. No rights are granted, in any manner or form, to use Whistle
16 * Communications, Inc. trademarks, including the mark "WHISTLE
17 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18 * such appears in the above copyright notice or in the software.
20 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
38 * Author: Archie Cobbs <archie@freebsd.org>
40 * $FreeBSD: src/sys/netgraph/ng_tty.c,v 1.7.2.3 2002/02/13 00:43:12 dillon Exp $
41 * $Whistle: ng_tty.c,v 1.21 1999/11/01 09:24:52 julian Exp $
45 * This file implements a terminal line discipline that is also a
46 * netgraph node. Installing this line discipline on a terminal device
47 * instantiates a new netgraph node of this type, which allows access
48 * to the device via the "hook" hook of the node.
50 * Once the line discipline is installed, you can find out the name
51 * of the corresponding netgraph node via a NGIOCGINFO ioctl().
53 * Incoming characters are delievered to the hook one at a time, each
54 * in its own mbuf. You may optionally define a ``hotchar,'' which causes
55 * incoming characters to be buffered up until either the hotchar is
56 * seen or the mbuf is full (MHLEN bytes). Then all buffered characters
57 * are immediately delivered.
59 * NOTE: This node operates at spltty().
62 #include <sys/param.h>
63 #include <sys/systm.h>
64 #include <sys/kernel.h>
69 #include <sys/malloc.h>
70 #include <sys/fcntl.h>
72 #include <sys/ttycom.h>
73 #include <sys/syslog.h>
74 #include <sys/errno.h>
75 #include <sys/thread2.h>
77 #include <netgraph/ng_message.h>
78 #include <netgraph/netgraph.h>
82 #define MAX_MBUFQ 3 /* Max number of queued mbufs */
83 #define NGT_HIWATER 400 /* High water mark on output */
85 /* Per-node private info */
87 struct tty *tp; /* Terminal device */
88 node_p node; /* Netgraph node */
89 hook_p hook; /* Netgraph hook */
90 struct mbuf *m; /* Incoming data buffer */
91 struct mbuf *qhead, **qtail; /* Queue of outgoing mbuf's */
92 short qlen; /* Length of queue */
93 short hotchar; /* Hotchar, or -1 if none */
94 u_int flags; /* Flags */
95 struct callout ctimeout; /* See man timeout(9) */
97 typedef struct ngt_sc *sc_p;
100 #define FLG_TIMEOUT 0x0001 /* A timeout is pending */
101 #define FLG_DEBUG 0x0002
105 #define QUEUECHECK(sc) \
110 for (k = 0, mp = &sc->qhead; \
111 k <= MAX_MBUFQ && *mp; \
112 k++, mp = &(*mp)->m_nextpkt); \
113 if (k != sc->qlen || k > MAX_MBUFQ || *mp || mp != sc->qtail) \
114 panic("%s: queue", __func__); \
117 #define QUEUECHECK(sc) do {} while (0)
120 /* Line discipline methods */
121 static int ngt_open(cdev_t dev, struct tty *tp);
122 static int ngt_close(struct tty *tp, int flag);
123 static int ngt_read(struct tty *tp, struct uio *uio, int flag);
124 static int ngt_write(struct tty *tp, struct uio *uio, int flag);
125 static int ngt_tioctl(struct tty *tp,
126 u_long cmd, caddr_t data, int flag, struct ucred *cred);
127 static int ngt_input(int c, struct tty *tp);
128 static int ngt_start(struct tty *tp);
130 /* Netgraph methods */
131 static ng_constructor_t ngt_constructor;
132 static ng_rcvmsg_t ngt_rcvmsg;
133 static ng_shutdown_t ngt_shutdown;
134 static ng_newhook_t ngt_newhook;
135 static ng_rcvdata_t ngt_rcvdata;
136 static ng_disconnect_t ngt_disconnect;
137 static int ngt_mod_event(module_t mod, int event, void *data);
140 static void ngt_timeout(void *arg);
142 #define ERROUT(x) do { error = (x); goto done; } while (0)
144 /* Line discipline descriptor */
145 static struct linesw ngt_disc = {
154 NG_TTY_DFL_HOTCHAR /* XXX can't change this in serial driver */
157 /* Netgraph node type descriptor */
158 static struct ng_type typestruct = {
173 NETGRAPH_INIT(tty, &typestruct);
176 static int ngt_nodeop_ok; /* OK to create/remove node */
177 static int ngt_ldisc;
179 /******************************************************************
180 LINE DISCIPLINE METHODS
181 ******************************************************************/
184 * Set our line discipline on the tty.
185 * Called from device open routine or ttioctl() at >= splsofttty()
188 ngt_open(cdev_t dev, struct tty *tp)
190 struct thread *td = curthread; /* XXX */
191 char name[sizeof(NG_TTY_NODE_TYPE) + 8];
195 /* Super-user only */
196 if ((error = priv_check(td, PRIV_ROOT)))
198 lwkt_gettoken(&tp->t_token);
200 /* Already installed? */
201 if (tp->t_line == NETGRAPHDISC) {
202 sc = (sc_p) tp->t_sc;
203 if (sc != NULL && sc->tp == tp)
207 /* Initialize private struct */
208 sc = kmalloc(sizeof(*sc), M_NETGRAPH, M_WAITOK | M_ZERO);
210 sc->hotchar = NG_TTY_DFL_HOTCHAR;
211 sc->qtail = &sc->qhead;
213 callout_init_mp(&sc->ctimeout);
215 /* Setup netgraph node */
217 error = ng_make_node_common(&typestruct, &sc->node);
220 kfree(sc, M_NETGRAPH);
223 ksnprintf(name, sizeof(name), "%s%d", typestruct.name, ngt_unit++);
225 /* Set back pointers */
226 sc->node->private = sc;
227 tp->t_sc = (caddr_t) sc;
229 /* Assign node its name */
230 if ((error = ng_name_node(sc->node, name))) {
231 log(LOG_ERR, "%s: node name exists?\n", name);
239 * Pre-allocate cblocks to the an appropriate amount.
240 * I'm not sure what is appropriate.
242 ttyflush(tp, FREAD | FWRITE);
243 clist_alloc_cblocks(&tp->t_canq, 0);
244 clist_alloc_cblocks(&tp->t_rawq, 0);
245 clist_alloc_cblocks(&tp->t_outq, MLEN + NGT_HIWATER);
249 lwkt_reltoken(&tp->t_token);
254 * Line specific close routine, called from device close routine
255 * and from ttioctl at >= splsofttty(). This causes the node to
256 * be destroyed as well.
259 ngt_close(struct tty *tp, int flag)
261 const sc_p sc = (sc_p) tp->t_sc;
263 lwkt_gettoken(&tp->t_token);
264 ttyflush(tp, FREAD | FWRITE);
265 clist_free_cblocks(&tp->t_outq);
268 if (sc->flags & FLG_TIMEOUT) {
269 callout_stop(&sc->ctimeout);
270 sc->flags &= ~FLG_TIMEOUT;
277 lwkt_reltoken(&tp->t_token);
283 * Once the device has been turned into a node, we don't allow reading.
286 ngt_read(struct tty *tp, struct uio *uio, int flag)
292 * Once the device has been turned into a node, we don't allow writing.
295 ngt_write(struct tty *tp, struct uio *uio, int flag)
301 * We implement the NGIOCGINFO ioctl() defined in ng_message.h.
304 ngt_tioctl(struct tty *tp, u_long cmd, caddr_t data, int flag, struct ucred *cred)
306 const sc_p sc = (sc_p) tp->t_sc;
309 lwkt_gettoken(&tp->t_token);
314 struct nodeinfo *const ni = (struct nodeinfo *) data;
315 const node_p node = sc->node;
317 bzero(ni, sizeof(*ni));
319 strncpy(ni->name, node->name, sizeof(ni->name) - 1);
320 strncpy(ni->type, node->type->name, sizeof(ni->type) - 1);
321 ni->id = (u_int32_t)(uintptr_t)node;
322 ni->hooks = node->numhooks;
329 lwkt_reltoken(&tp->t_token);
335 * Receive data coming from the device. We get one character at
336 * a time, which is kindof silly.
337 * Only guaranteed to be at splsofttty() or spltty().
340 ngt_input(int c, struct tty *tp)
342 const sc_p sc = (sc_p) tp->t_sc;
343 const node_p node = sc ? sc->node : NULL;
347 lwkt_gettoken(&tp->t_token);
348 if (!sc || tp != sc->tp) {
349 lwkt_reltoken(&tp->t_token);
355 /* Check for error conditions */
356 if ((tp->t_state & TS_CONNECTED) == 0) {
357 if (sc->flags & FLG_DEBUG)
358 log(LOG_DEBUG, "%s: no carrier\n", node->name);
361 if (c & TTY_ERRORMASK) {
362 /* framing error or overrun on this char */
363 if (sc->flags & FLG_DEBUG)
364 log(LOG_DEBUG, "%s: line error %x\n",
365 node->name, c & TTY_ERRORMASK);
370 /* Get a new header mbuf if we need one */
372 MGETHDR(m, M_NOWAIT, MT_DATA);
374 if (sc->flags & FLG_DEBUG)
376 "%s: can't get mbuf\n", node->name);
379 m->m_len = m->m_pkthdr.len = 0;
380 m->m_pkthdr.rcvif = NULL;
384 /* Add char to mbuf */
385 *mtod(m, u_char *) = c;
390 /* Ship off mbuf if it's time */
391 if (sc->hotchar == -1 || c == sc->hotchar || m->m_len >= MHLEN) {
392 m->m_data = m->m_pktdat;
393 error = ng_queue_data(sc->hook, m, NULL);
397 lwkt_reltoken(&tp->t_token);
403 * This is called when the device driver is ready for more output.
404 * Called from tty system at splsofttty() or spltty().
405 * Also call from ngt_rcv_data() when a new mbuf is available for output.
408 ngt_start(struct tty *tp)
410 const sc_p sc = (sc_p) tp->t_sc;
412 lwkt_gettoken(&tp->t_token);
413 while (tp->t_outq.c_cc < NGT_HIWATER) { /* XXX 2.2 specific ? */
414 struct mbuf *m = sc->qhead;
416 /* Remove first mbuf from queue */
419 if ((sc->qhead = m->m_nextpkt) == NULL)
420 sc->qtail = &sc->qhead;
424 /* Send as much of it as possible */
428 sent = m->m_len - clist_btoq(mtod(m, u_char *),
429 m->m_len, &tp->t_outq);
433 break; /* device can't take no more */
437 /* Put remainder of mbuf chain (if any) back on queue */
439 m->m_nextpkt = sc->qhead;
441 if (sc->qtail == &sc->qhead)
442 sc->qtail = &m->m_nextpkt;
449 /* Call output process whether or not there is any output. We are
450 * being called in lieu of ttstart and must do what it would. */
451 if (tp->t_oproc != NULL)
454 /* This timeout is needed for operation on a pseudo-tty, because the
455 * pty code doesn't call pppstart after it has drained the t_outq. */
456 if (sc->qhead && (sc->flags & FLG_TIMEOUT) == 0) {
457 callout_reset(&sc->ctimeout, 1, ngt_timeout, sc);
458 sc->flags |= FLG_TIMEOUT;
460 lwkt_reltoken(&tp->t_token);
466 * We still have data to output to the device, so try sending more.
469 ngt_timeout(void *arg)
471 const sc_p sc = (sc_p) arg;
472 struct tty *tp = sc->tp;
474 lwkt_gettoken(&tp->t_token);
475 sc->flags &= ~FLG_TIMEOUT;
477 lwkt_reltoken(&tp->t_token);
480 /******************************************************************
481 NETGRAPH NODE METHODS
482 ******************************************************************/
485 * Initialize a new node of this type.
487 * We only allow nodes to be created as a result of setting
488 * the line discipline on a tty, so always return an error if not.
491 ngt_constructor(node_p *nodep)
495 return (ng_make_node_common(&typestruct, nodep));
499 * Add a new hook. There can only be one.
502 ngt_newhook(node_p node, hook_p hook, const char *name)
504 const sc_p sc = node->private;
505 struct tty *tp = sc->tp;
508 if (strcmp(name, NG_TTY_HOOK))
510 lwkt_gettoken(&tp->t_token);
515 lwkt_reltoken(&tp->t_token);
521 * Disconnect the hook
524 ngt_disconnect(hook_p hook)
526 const sc_p sc = hook->node->private;
527 struct tty *tp = sc->tp;
529 lwkt_gettoken(&tp->t_token);
530 if (hook != sc->hook)
535 lwkt_reltoken(&tp->t_token);
541 * Remove this node. The does the netgraph portion of the shutdown.
542 * This should only be called indirectly from ngt_close().
545 ngt_shutdown(node_p node)
547 const sc_p sc = node->private;
548 struct tty *tp = sc->tp;
552 lwkt_gettoken(&tp->t_token);
555 node->private = NULL;
559 bzero(sc, sizeof(*sc));
560 kfree(sc, M_NETGRAPH);
561 lwkt_reltoken(&tp->t_token);
567 * Receive incoming data from netgraph system. Put it on our
568 * output queue and start output if necessary.
571 ngt_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
573 const sc_p sc = hook->node->private;
574 struct tty *tp = sc->tp;
577 if (hook != sc->hook)
580 lwkt_gettoken(&tp->t_token);
581 if (sc->qlen >= MAX_MBUFQ)
585 sc->qtail = &m->m_nextpkt;
592 lwkt_reltoken(&tp->t_token);
599 * Receive control message
602 ngt_rcvmsg(node_p node, struct ng_mesg *msg, const char *retaddr,
603 struct ng_mesg **rptr)
605 const sc_p sc = (sc_p) node->private;
606 struct tty *tp = sc->tp;
607 struct ng_mesg *resp = NULL;
610 lwkt_gettoken(&tp->t_token);
611 switch (msg->header.typecookie) {
613 switch (msg->header.cmd) {
614 case NGM_TTY_SET_HOTCHAR:
618 if (msg->header.arglen != sizeof(int))
620 hotchar = *((int *) msg->data);
621 if (hotchar != (u_char) hotchar && hotchar != -1)
623 sc->hotchar = hotchar; /* race condition is OK */
626 case NGM_TTY_GET_HOTCHAR:
627 NG_MKRESPONSE(resp, msg, sizeof(int), M_NOWAIT);
630 /* Race condition here is OK */
631 *((int *) resp->data) = sc->hotchar;
643 kfree(resp, M_NETGRAPH);
646 kfree(msg, M_NETGRAPH);
647 lwkt_reltoken(&tp->t_token);
652 /******************************************************************
654 ******************************************************************/
657 * Handle loading and unloading for this node type
660 ngt_mod_event(module_t mod, int event, void *data)
662 /* struct ng_type *const type = data;*/
667 /* Register line discipline */
668 if ((ngt_ldisc = ldisc_register(NETGRAPHDISC, &ngt_disc)) < 0) {
669 log(LOG_ERR, "%s: can't register line discipline",
677 /* Unregister line discipline */
678 ldisc_deregister(ngt_ldisc);