2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1988 University of Utah.
5 * Copyright (c) 1991 The Regents of the University of California.
6 * Copyright (c) 1999 Michael Smith
7 * Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
11 * This code is derived from software contributed to Berkeley by
12 * the Systems Programming Group of the University of Utah Computer
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 #include <sys/cdefs.h>
42 #include "opt_syscons.h"
44 #include <sys/param.h>
45 #include <sys/systm.h>
47 #include <sys/mutex.h>
50 #include <sys/fcntl.h>
53 #include <sys/kernel.h>
54 #include <sys/malloc.h>
55 #include <sys/msgbuf.h>
56 #include <sys/namei.h>
59 #include <sys/queue.h>
60 #include <sys/reboot.h>
61 #include <sys/sysctl.h>
63 #include <sys/tslog.h>
66 #include <sys/vnode.h>
70 #include <dev/kbd/kbdreg.h>
72 #include <machine/cpu.h>
73 #include <machine/clock.h>
75 static MALLOC_DEFINE(M_TTYCONS, "tty console", "tty console handling");
78 STAILQ_ENTRY(cn_device) cnd_next;
79 struct consdev *cnd_cn;
82 #define CNDEVPATHMAX 32
83 #define CNDEVTAB_SIZE 4
84 static struct cn_device cn_devtab[CNDEVTAB_SIZE];
85 static STAILQ_HEAD(, cn_device) cn_devlist =
86 STAILQ_HEAD_INITIALIZER(cn_devlist);
88 int cons_avail_mask = 0; /* Bit mask. Each registered low level console
89 * which is currently unavailable for inpit
90 * (i.e., if it is in graphics mode) will have
95 SYSCTL_INT(_kern, OID_AUTO, consmute, CTLFLAG_RW, &cn_mute, 0,
96 "State of the console muting");
98 static char *consbuf; /* buffer used by `consmsgbuf' */
99 static struct callout conscallout; /* callout for outputting to constty */
100 struct msgbuf consmsgbuf; /* message buffer for console tty */
101 static bool console_pausing; /* pause after each line during probe */
102 static const char console_pausestr[] =
103 "<pause; press any key to proceed to next line or '.' to end pause mode>";
104 struct tty *constty; /* pointer to console "window" tty */
105 static struct mtx constty_mtx; /* Mutex for constty assignment. */
106 MTX_SYSINIT(constty_mtx, &constty_mtx, "constty_mtx", MTX_DEF);
107 static struct mtx cnputs_mtx; /* Mutex for cnputs(). */
108 MTX_SYSINIT(cnputs_mtx, &cnputs_mtx, "cnputs_mtx", MTX_SPIN | MTX_NOWITNESS);
110 static void constty_timeout(void *arg);
112 static struct consdev cons_consdev;
113 DATA_SET(cons_set, cons_consdev);
114 SET_DECLARE(cons_set, struct consdev);
117 * Stub for configurations that don't actually have a keyboard driver. Inclusion
118 * of kbd.c is contingent on any number of keyboard/console drivers being
119 * present in the kernel; rather than trying to catch them all, we'll just
120 * maintain this weak kbdinit that will be overridden by the strong version in
121 * kbd.c if it's present.
132 struct consdev *best_cn, *cn, **list;
136 * Check if we should mute the console (for security reasons perhaps)
137 * It can be changes dynamically using sysctl kern.consmute
138 * once we are up and going.
141 cn_mute = ((boothowto & (RB_MUTE
144 |RB_ASKNAME)) == RB_MUTE);
147 * Bring up the kbd layer just in time for cnprobe. Console drivers
148 * have a dependency on kbd being ready, so this fits nicely between the
149 * machdep callers of cninit() and MI probing/initialization of consoles
155 * Find the first console with the highest priority.
158 SET_FOREACH(list, cons_set) {
161 /* Skip cons_consdev. */
162 if (cn->cn_ops == NULL)
164 cn->cn_ops->cn_probe(cn);
165 if (cn->cn_pri == CN_DEAD)
167 if (best_cn == NULL || cn->cn_pri > best_cn->cn_pri)
169 if (boothowto & RB_MULTIPLE) {
171 * Initialize console, and attach to it.
173 cn->cn_ops->cn_init(cn);
179 if ((boothowto & RB_MULTIPLE) == 0) {
180 best_cn->cn_ops->cn_init(best_cn);
183 if (boothowto & RB_PAUSE)
184 console_pausing = true;
186 * Make the best console the preferred console.
192 * Release early console.
202 console_pausing = false;
205 /* add a new physical console to back the virtual console */
207 cnadd(struct consdev *cn)
209 struct cn_device *cnd;
212 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
213 if (cnd->cnd_cn == cn)
215 for (i = 0; i < CNDEVTAB_SIZE; i++) {
217 if (cnd->cnd_cn == NULL)
220 if (cnd->cnd_cn != NULL)
223 if (cn->cn_name[0] == '\0') {
224 /* XXX: it is unclear if/where this print might output */
225 printf("WARNING: console at %p has no name\n", cn);
227 STAILQ_INSERT_TAIL(&cn_devlist, cnd, cnd_next);
228 if (STAILQ_FIRST(&cn_devlist) == cnd)
229 ttyconsdev_select(cnd->cnd_cn->cn_name);
231 /* Add device to the active mask. */
232 cnavailable(cn, (cn->cn_flags & CN_FLAG_NOAVAIL) == 0);
238 cnremove(struct consdev *cn)
240 struct cn_device *cnd;
243 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
244 if (cnd->cnd_cn != cn)
246 if (STAILQ_FIRST(&cn_devlist) == cnd)
247 ttyconsdev_select(NULL);
248 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
251 /* Remove this device from available mask. */
252 for (i = 0; i < CNDEVTAB_SIZE; i++)
253 if (cnd == &cn_devtab[i]) {
254 cons_avail_mask &= ~(1 << i);
260 * syscons gets really confused if console resources are
261 * freed after the system has initialized.
263 if (cn->cn_term != NULL)
264 cn->cn_ops->cn_term(cn);
271 cnselect(struct consdev *cn)
273 struct cn_device *cnd;
275 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
276 if (cnd->cnd_cn != cn)
278 if (cnd == STAILQ_FIRST(&cn_devlist))
280 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
281 STAILQ_INSERT_HEAD(&cn_devlist, cnd, cnd_next);
282 ttyconsdev_select(cnd->cnd_cn->cn_name);
288 cnavailable(struct consdev *cn, int available)
292 for (i = 0; i < CNDEVTAB_SIZE; i++) {
293 if (cn_devtab[i].cnd_cn == cn)
297 if (i < CNDEVTAB_SIZE)
298 cons_avail_mask |= (1 << i);
299 cn->cn_flags &= ~CN_FLAG_NOAVAIL;
301 if (i < CNDEVTAB_SIZE)
302 cons_avail_mask &= ~(1 << i);
303 cn->cn_flags |= CN_FLAG_NOAVAIL;
311 return (cons_avail_mask == 0);
315 * sysctl_kern_console() provides output parseable in conscontrol(1).
318 sysctl_kern_console(SYSCTL_HANDLER_ARGS)
320 struct cn_device *cnd;
321 struct consdev *cp, **list;
327 sb = sbuf_new(NULL, NULL, CNDEVPATHMAX * 2, SBUF_AUTOEXTEND |
332 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
333 sbuf_printf(sb, "%s,", cnd->cnd_cn->cn_name);
335 SET_FOREACH(list, cons_set) {
337 if (cp->cn_name[0] != '\0')
338 sbuf_printf(sb, "%s,", cp->cn_name);
341 error = sysctl_handle_string(oidp, sbuf_data(sb), sbuf_len(sb), req);
342 if (error == 0 && req->newptr != NULL) {
350 SET_FOREACH(list, cons_set) {
352 if (strcmp(p, cp->cn_name) != 0)
369 SYSCTL_PROC(_kern, OID_AUTO, console,
370 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT, 0, 0,
371 sysctl_kern_console, "A",
372 "Console device control");
377 struct cn_device *cnd;
380 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
382 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
383 cn->cn_ops->cn_grab(cn);
390 struct cn_device *cnd;
393 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
395 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
396 cn->cn_ops->cn_ungrab(cn);
403 struct cn_device *cnd;
406 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
408 if (cn->cn_ops->cn_resume != NULL)
409 cn->cn_ops->cn_resume(cn);
414 * Low level console routines.
423 while ((c = cncheckc()) == -1)
426 c = '\n'; /* console input is always ICRNL */
433 struct cn_device *cnd;
439 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
441 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
442 c = cn->cn_ops->cn_getc(cn);
451 cngets(char *cp, size_t size, int visible)
500 struct cn_device *cnd;
505 if (early_putc != NULL) {
513 if (cn_mute || c == '\0')
515 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
517 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
519 cn->cn_ops->cn_putc(cn, '\r');
520 cn->cn_ops->cn_putc(cn, c);
523 if (console_pausing && c == '\n' && !kdb_active) {
524 for (cp = console_pausestr; *cp != '\0'; cp++)
528 console_pausing = false;
531 for (cp = console_pausestr; *cp != '\0'; cp++)
538 cnputsn(const char *p, size_t n)
541 bool unlock_reqd = false;
543 if (mtx_initialized(&cnputs_mtx)) {
545 * NOTE: Debug prints and/or witness printouts in
546 * console driver clients can cause the "cnputs_mtx"
547 * mutex to recurse. Simply return if that happens.
549 if (mtx_owned(&cnputs_mtx))
551 mtx_lock_spin(&cnputs_mtx);
555 for (i = 0; i < n; i++)
559 mtx_unlock_spin(&cnputs_mtx);
563 cnputs(const char *p)
565 cnputsn(p, strlen(p));
568 static unsigned int consmsgbuf_size = 65536;
569 SYSCTL_UINT(_kern, OID_AUTO, consmsgbuf_size, CTLFLAG_RWTUN, &consmsgbuf_size,
570 0, "Console tty buffer size");
573 * Redirect console output to a tty.
576 constty_set(struct tty *tp)
578 int size = consmsgbuf_size;
581 tty_assert_locked(tp);
587 if (consbuf == NULL) {
589 buf = malloc(size, M_TTYCONS, M_WAITOK);
592 mtx_lock(&constty_mtx);
593 if (constty != NULL) {
594 mtx_unlock(&constty_mtx);
595 free(buf, M_TTYCONS);
598 if (consbuf == NULL) {
600 msgbuf_init(&consmsgbuf, buf, size);
602 free(buf, M_TTYCONS);
604 mtx_unlock(&constty_mtx);
606 callout_init_mtx(&conscallout, tty_getlock(tp), 0);
612 * Disable console redirection to a tty.
615 constty_clear(struct tty *tp)
619 tty_assert_locked(tp);
622 callout_stop(&conscallout);
623 mtx_lock(&constty_mtx);
625 mtx_unlock(&constty_mtx);
626 while ((c = msgbuf_getchar(&consmsgbuf)) != -1)
628 /* We never free consbuf because it can still be in use. */
632 /* Times per second to check for pending console tty messages. */
633 static int constty_wakeups_per_second = 15;
634 SYSCTL_INT(_kern, OID_AUTO, constty_wakeups_per_second, CTLFLAG_RW,
635 &constty_wakeups_per_second, 0,
636 "Times per second to check for pending console tty messages");
639 constty_timeout(void *arg)
641 struct tty *tp = arg;
644 tty_assert_locked(tp);
645 while ((c = msgbuf_getchar(&consmsgbuf)) != -1) {
646 if (tty_putchar(tp, c) < 0) {
651 callout_reset_sbt(&conscallout, SBT_1S / constty_wakeups_per_second,
652 0, constty_timeout, tp, C_PREL(1));
656 * Sysbeep(), if we have hardware for it
659 #ifdef HAS_TIMER_SPKR
662 static struct callout beeping_timer;
665 sysbeepstop(void *chan)
668 timer_spkr_release();
673 sysbeep(int pitch, sbintime_t duration)
676 if (timer_spkr_acquire()) {
678 /* Something else owns it. */
682 timer_spkr_setfreq(pitch);
685 callout_reset_sbt(&beeping_timer, duration, 0, sysbeepstop,
692 sysbeep_init(void *unused)
695 callout_init(&beeping_timer, 1);
697 SYSINIT(sysbeep, SI_SUB_SOFTINTR, SI_ORDER_ANY, sysbeep_init, NULL);
701 * No hardware, no sound
705 sysbeep(int pitch __unused, sbintime_t duration __unused)
714 * Temporary support for sc(4) to vt(4) transition.
716 static unsigned vty_prefer;
717 static char vty_name[16];
718 SYSCTL_STRING(_kern, OID_AUTO, vty, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, vty_name,
719 0, "Console vty driver");
722 vty_enabled(unsigned vty)
724 static unsigned vty_selected = 0;
726 if (vty_selected == 0) {
727 TUNABLE_STR_FETCH("kern.vty", vty_name, sizeof(vty_name));
730 if (strcmp(vty_name, "sc") == 0) {
731 vty_selected = VTY_SC;
736 if (strcmp(vty_name, "vt") == 0) {
737 vty_selected = VTY_VT;
741 if (vty_prefer != 0) {
742 vty_selected = vty_prefer;
746 vty_selected = VTY_VT;
747 #elif defined(DEV_SC)
748 vty_selected = VTY_SC;
752 if (vty_selected == VTY_VT)
753 strcpy(vty_name, "vt");
754 else if (vty_selected == VTY_SC)
755 strcpy(vty_name, "sc");
757 return ((vty_selected & vty) != 0);
761 vty_set_preferred(unsigned vty)
766 vty_prefer &= ~VTY_SC;
769 vty_prefer &= ~VTY_VT;