2 * Copyright (c) 1988 University of Utah.
3 * Copyright (c) 1991 The Regents of the University of California.
4 * Copyright (c) 1999 Michael Smith
5 * Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
9 * This code is derived from software contributed to Berkeley by
10 * the Systems Programming Group of the University of Utah Computer
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 4. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * from: @(#)cons.c 7.2 (Berkeley) 5/9/91
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
44 #include "opt_syscons.h"
46 #include <sys/param.h>
47 #include <sys/systm.h>
49 #include <sys/mutex.h>
52 #include <sys/fcntl.h>
54 #include <sys/kernel.h>
55 #include <sys/malloc.h>
56 #include <sys/msgbuf.h>
57 #include <sys/namei.h>
60 #include <sys/queue.h>
61 #include <sys/reboot.h>
62 #include <sys/sysctl.h>
66 #include <sys/vnode.h>
70 #include <machine/cpu.h>
71 #include <machine/clock.h>
73 static MALLOC_DEFINE(M_TTYCONS, "tty console", "tty console handling");
76 STAILQ_ENTRY(cn_device) cnd_next;
77 struct consdev *cnd_cn;
80 #define CNDEVPATHMAX 32
81 #define CNDEVTAB_SIZE 4
82 static struct cn_device cn_devtab[CNDEVTAB_SIZE];
83 static STAILQ_HEAD(, cn_device) cn_devlist =
84 STAILQ_HEAD_INITIALIZER(cn_devlist);
86 int cons_avail_mask = 0; /* Bit mask. Each registered low level console
87 * which is currently unavailable for inpit
88 * (i.e., if it is in graphics mode) will have
92 static char *consbuf; /* buffer used by `consmsgbuf' */
93 static struct callout conscallout; /* callout for outputting to constty */
94 struct msgbuf consmsgbuf; /* message buffer for console tty */
95 static u_char console_pausing; /* pause after each line during probe */
96 static char *console_pausestr=
97 "<pause; press any key to proceed to next line or '.' to end pause mode>";
98 struct tty *constty; /* pointer to console "window" tty */
99 static struct mtx cnputs_mtx; /* Mutex for cnputs(). */
100 static int use_cnputs_mtx = 0; /* != 0 if cnputs_mtx locking reqd. */
102 static void constty_timeout(void *arg);
104 static struct consdev cons_consdev;
105 DATA_SET(cons_set, cons_consdev);
106 SET_DECLARE(cons_set, struct consdev);
111 struct consdev *best_cn, *cn, **list;
114 * Check if we should mute the console (for security reasons perhaps)
115 * It can be changes dynamically using sysctl kern.consmute
116 * once we are up and going.
119 cn_mute = ((boothowto & (RB_MUTE
122 |RB_ASKNAME)) == RB_MUTE);
125 * Find the first console with the highest priority.
128 SET_FOREACH(list, cons_set) {
131 /* Skip cons_consdev. */
132 if (cn->cn_ops == NULL)
134 cn->cn_ops->cn_probe(cn);
135 if (cn->cn_pri == CN_DEAD)
137 if (best_cn == NULL || cn->cn_pri > best_cn->cn_pri)
139 if (boothowto & RB_MULTIPLE) {
141 * Initialize console, and attach to it.
143 cn->cn_ops->cn_init(cn);
149 if ((boothowto & RB_MULTIPLE) == 0) {
150 best_cn->cn_ops->cn_init(best_cn);
153 if (boothowto & RB_PAUSE)
156 * Make the best console the preferred console.
162 * Release early console.
174 /* add a new physical console to back the virtual console */
176 cnadd(struct consdev *cn)
178 struct cn_device *cnd;
181 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
182 if (cnd->cnd_cn == cn)
184 for (i = 0; i < CNDEVTAB_SIZE; i++) {
186 if (cnd->cnd_cn == NULL)
189 if (cnd->cnd_cn != NULL)
192 if (cn->cn_name[0] == '\0') {
193 /* XXX: it is unclear if/where this print might output */
194 printf("WARNING: console at %p has no name\n", cn);
196 STAILQ_INSERT_TAIL(&cn_devlist, cnd, cnd_next);
197 if (STAILQ_FIRST(&cn_devlist) == cnd)
198 ttyconsdev_select(cnd->cnd_cn->cn_name);
200 /* Add device to the active mask. */
201 cnavailable(cn, (cn->cn_flags & CN_FLAG_NOAVAIL) == 0);
207 cnremove(struct consdev *cn)
209 struct cn_device *cnd;
212 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
213 if (cnd->cnd_cn != cn)
215 if (STAILQ_FIRST(&cn_devlist) == cnd)
216 ttyconsdev_select(NULL);
217 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
220 /* Remove this device from available mask. */
221 for (i = 0; i < CNDEVTAB_SIZE; i++)
222 if (cnd == &cn_devtab[i]) {
223 cons_avail_mask &= ~(1 << i);
229 * syscons gets really confused if console resources are
230 * freed after the system has initialized.
232 if (cn->cn_term != NULL)
233 cn->cn_ops->cn_term(cn);
240 cnselect(struct consdev *cn)
242 struct cn_device *cnd;
244 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
245 if (cnd->cnd_cn != cn)
247 if (cnd == STAILQ_FIRST(&cn_devlist))
249 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
250 STAILQ_INSERT_HEAD(&cn_devlist, cnd, cnd_next);
251 ttyconsdev_select(cnd->cnd_cn->cn_name);
257 cnavailable(struct consdev *cn, int available)
261 for (i = 0; i < CNDEVTAB_SIZE; i++) {
262 if (cn_devtab[i].cnd_cn == cn)
266 if (i < CNDEVTAB_SIZE)
267 cons_avail_mask |= (1 << i);
268 cn->cn_flags &= ~CN_FLAG_NOAVAIL;
270 if (i < CNDEVTAB_SIZE)
271 cons_avail_mask &= ~(1 << i);
272 cn->cn_flags |= CN_FLAG_NOAVAIL;
280 return (cons_avail_mask == 0);
284 * sysctl_kern_console() provides output parseable in conscontrol(1).
287 sysctl_kern_console(SYSCTL_HANDLER_ARGS)
289 struct cn_device *cnd;
290 struct consdev *cp, **list;
295 sb = sbuf_new(NULL, NULL, CNDEVPATHMAX * 2, SBUF_AUTOEXTEND);
299 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
300 sbuf_printf(sb, "%s,", cnd->cnd_cn->cn_name);
301 sbuf_printf(sb, "/");
302 SET_FOREACH(list, cons_set) {
304 if (cp->cn_name[0] != '\0')
305 sbuf_printf(sb, "%s,", cp->cn_name);
308 error = sysctl_handle_string(oidp, sbuf_data(sb), sbuf_len(sb), req);
309 if (error == 0 && req->newptr != NULL) {
317 SET_FOREACH(list, cons_set) {
319 if (strcmp(p, cp->cn_name) != 0)
336 SYSCTL_PROC(_kern, OID_AUTO, console, CTLTYPE_STRING|CTLFLAG_RW,
337 0, 0, sysctl_kern_console, "A", "Console device control");
340 * User has changed the state of the console muting.
341 * This may require us to open or close the device in question.
344 sysctl_kern_consmute(SYSCTL_HANDLER_ARGS)
348 error = sysctl_handle_int(oidp, &cn_mute, 0, req);
349 if (error != 0 || req->newptr == NULL)
354 SYSCTL_PROC(_kern, OID_AUTO, consmute, CTLTYPE_INT|CTLFLAG_RW,
355 0, sizeof(cn_mute), sysctl_kern_consmute, "I",
356 "State of the console muting");
361 struct cn_device *cnd;
364 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
366 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
367 cn->cn_ops->cn_grab(cn);
374 struct cn_device *cnd;
377 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
379 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
380 cn->cn_ops->cn_ungrab(cn);
385 * Low level console routines.
394 while ((c = cncheckc()) == -1)
397 c = '\n'; /* console input is always ICRNL */
404 struct cn_device *cnd;
410 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
412 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
413 c = cn->cn_ops->cn_getc(cn);
422 cngets(char *cp, size_t size, int visible)
471 struct cn_device *cnd;
476 if (early_putc != NULL) {
484 if (cn_mute || c == '\0')
486 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
488 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
490 cn->cn_ops->cn_putc(cn, '\r');
491 cn->cn_ops->cn_putc(cn, c);
494 if (console_pausing && c == '\n' && !kdb_active) {
495 for (cp = console_pausestr; *cp != '\0'; cp++)
502 for (cp = console_pausestr; *cp != '\0'; cp++)
514 if (use_cnputs_mtx) {
516 * NOTE: Debug prints and/or witness printouts in
517 * console driver clients can cause the "cnputs_mtx"
518 * mutex to recurse. Simply return if that happens.
520 if (mtx_owned(&cnputs_mtx))
522 mtx_lock_spin(&cnputs_mtx);
526 while ((c = *p++) != '\0')
530 mtx_unlock_spin(&cnputs_mtx);
533 static int consmsgbuf_size = 8192;
534 SYSCTL_INT(_kern, OID_AUTO, consmsgbuf_size, CTLFLAG_RW, &consmsgbuf_size, 0,
535 "Console tty buffer size");
538 * Redirect console output to a tty.
541 constty_set(struct tty *tp)
545 KASSERT(tp != NULL, ("constty_set: NULL tp"));
546 if (consbuf == NULL) {
547 size = consmsgbuf_size;
548 consbuf = malloc(size, M_TTYCONS, M_WAITOK);
549 msgbuf_init(&consmsgbuf, consbuf, size);
550 callout_init(&conscallout, 0);
553 constty_timeout(NULL);
557 * Disable console redirection to a tty.
567 callout_stop(&conscallout);
568 while ((c = msgbuf_getchar(&consmsgbuf)) != -1)
570 free(consbuf, M_TTYCONS);
574 /* Times per second to check for pending console tty messages. */
575 static int constty_wakeups_per_second = 5;
576 SYSCTL_INT(_kern, OID_AUTO, constty_wakeups_per_second, CTLFLAG_RW,
577 &constty_wakeups_per_second, 0,
578 "Times per second to check for pending console tty messages");
581 constty_timeout(void *arg)
585 if (constty != NULL) {
587 while ((c = msgbuf_getchar(&consmsgbuf)) != -1) {
588 if (tty_putchar(constty, c) < 0) {
598 if (constty != NULL) {
599 callout_reset(&conscallout, hz / constty_wakeups_per_second,
600 constty_timeout, NULL);
602 /* Deallocate the constty buffer memory. */
608 cn_drvinit(void *unused)
611 mtx_init(&cnputs_mtx, "cnputs_mtx", NULL, MTX_SPIN | MTX_NOWITNESS);
615 SYSINIT(cndev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, cn_drvinit, NULL);
618 * Sysbeep(), if we have hardware for it
621 #ifdef HAS_TIMER_SPKR
626 sysbeepstop(void *chan)
629 timer_spkr_release();
634 sysbeep(int pitch, int period)
637 if (timer_spkr_acquire()) {
639 /* Something else owns it. */
643 timer_spkr_setfreq(pitch);
646 timeout(sysbeepstop, (void *)NULL, period);
654 * No hardware, no sound
658 sysbeep(int pitch __unused, int period __unused)
667 * Temporary support for sc(4) to vt(4) transition.
669 static unsigned vty_prefer;
670 static char vty_name[16];
671 SYSCTL_STRING(_kern, OID_AUTO, vty, CTLFLAG_RDTUN, vty_name, 0,
672 "Console vty driver");
675 vty_enabled(unsigned vty)
677 static unsigned vty_selected = 0;
679 if (vty_selected == 0) {
680 TUNABLE_STR_FETCH("kern.vty", vty_name, sizeof(vty_name));
683 if (strcmp(vty_name, "sc") == 0) {
684 vty_selected = VTY_SC;
689 if (strcmp(vty_name, "vt") == 0) {
690 vty_selected = VTY_VT;
694 if (vty_prefer != 0) {
695 vty_selected = vty_prefer;
699 vty_selected = VTY_SC;
700 #elif defined(DEV_VT)
701 vty_selected = VTY_VT;
705 if (vty_selected == VTY_VT)
706 strcpy(vty_name, "vt");
707 else if (vty_selected == VTY_SC)
708 strcpy(vty_name, "sc");
710 return ((vty_selected & vty) != 0);
714 vty_set_preferred(unsigned vty)
719 vty_prefer &= ~VTY_SC;
722 vty_prefer &= ~VTY_VT;