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>
76 * Check for 'options EARLY_PRINTF' that may have been used in old kernel
77 * config files. If you are hitting this error you should update your
78 * config to use 'options EARLY_PRINTF=<device name>', e.g. with the
81 * options EARLY_PRINTF=pl011
83 #if CHECK_EARLY_PRINTF(1)
84 #error Update your config to use 'options EARLY_PRINTF=<device name>'
87 static MALLOC_DEFINE(M_TTYCONS, "tty console", "tty console handling");
90 STAILQ_ENTRY(cn_device) cnd_next;
91 struct consdev *cnd_cn;
94 #define CNDEVPATHMAX 32
95 #define CNDEVTAB_SIZE 4
96 static struct cn_device cn_devtab[CNDEVTAB_SIZE];
97 static STAILQ_HEAD(, cn_device) cn_devlist =
98 STAILQ_HEAD_INITIALIZER(cn_devlist);
100 int cons_avail_mask = 0; /* Bit mask. Each registered low level console
101 * which is currently unavailable for inpit
102 * (i.e., if it is in graphics mode) will have
107 SYSCTL_INT(_kern, OID_AUTO, consmute, CTLFLAG_RW, &cn_mute, 0,
108 "State of the console muting");
110 static char *consbuf; /* buffer used by `consmsgbuf' */
111 static struct callout conscallout; /* callout for outputting to constty */
112 struct msgbuf consmsgbuf; /* message buffer for console tty */
113 static bool console_pausing; /* pause after each line during probe */
114 static const char console_pausestr[] =
115 "<pause; press any key to proceed to next line or '.' to end pause mode>";
116 struct tty *constty; /* pointer to console "window" tty */
117 static struct mtx constty_mtx; /* Mutex for constty assignment. */
118 MTX_SYSINIT(constty_mtx, &constty_mtx, "constty_mtx", MTX_DEF);
119 static struct mtx cnputs_mtx; /* Mutex for cnputs(). */
120 MTX_SYSINIT(cnputs_mtx, &cnputs_mtx, "cnputs_mtx", MTX_SPIN | MTX_NOWITNESS);
122 static void constty_timeout(void *arg);
124 static struct consdev cons_consdev;
125 DATA_SET(cons_set, cons_consdev);
126 SET_DECLARE(cons_set, struct consdev);
129 * Stub for configurations that don't actually have a keyboard driver. Inclusion
130 * of kbd.c is contingent on any number of keyboard/console drivers being
131 * present in the kernel; rather than trying to catch them all, we'll just
132 * maintain this weak kbdinit that will be overridden by the strong version in
133 * kbd.c if it's present.
144 struct consdev *best_cn, *cn, **list;
148 * Check if we should mute the console (for security reasons perhaps)
149 * It can be changes dynamically using sysctl kern.consmute
150 * once we are up and going.
153 cn_mute = ((boothowto & (RB_MUTE
156 |RB_ASKNAME)) == RB_MUTE);
159 * Bring up the kbd layer just in time for cnprobe. Console drivers
160 * have a dependency on kbd being ready, so this fits nicely between the
161 * machdep callers of cninit() and MI probing/initialization of consoles
167 * Find the first console with the highest priority.
170 SET_FOREACH(list, cons_set) {
173 /* Skip cons_consdev. */
174 if (cn->cn_ops == NULL)
176 cn->cn_ops->cn_probe(cn);
177 if (cn->cn_pri == CN_DEAD)
179 if (best_cn == NULL || cn->cn_pri > best_cn->cn_pri)
181 if (boothowto & RB_MULTIPLE) {
183 * Initialize console, and attach to it.
185 cn->cn_ops->cn_init(cn);
191 if ((boothowto & RB_MULTIPLE) == 0) {
192 best_cn->cn_ops->cn_init(best_cn);
195 if (boothowto & RB_PAUSE)
196 console_pausing = true;
198 * Make the best console the preferred console.
204 * Release early console.
214 console_pausing = false;
217 /* add a new physical console to back the virtual console */
219 cnadd(struct consdev *cn)
221 struct cn_device *cnd;
224 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
225 if (cnd->cnd_cn == cn)
227 for (i = 0; i < CNDEVTAB_SIZE; i++) {
229 if (cnd->cnd_cn == NULL)
232 if (cnd->cnd_cn != NULL)
235 if (cn->cn_name[0] == '\0') {
236 /* XXX: it is unclear if/where this print might output */
237 printf("WARNING: console at %p has no name\n", cn);
239 STAILQ_INSERT_TAIL(&cn_devlist, cnd, cnd_next);
240 if (STAILQ_FIRST(&cn_devlist) == cnd)
241 ttyconsdev_select(cnd->cnd_cn->cn_name);
243 /* Add device to the active mask. */
244 cnavailable(cn, (cn->cn_flags & CN_FLAG_NOAVAIL) == 0);
250 cnremove(struct consdev *cn)
252 struct cn_device *cnd;
255 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
256 if (cnd->cnd_cn != cn)
258 if (STAILQ_FIRST(&cn_devlist) == cnd)
259 ttyconsdev_select(NULL);
260 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
263 /* Remove this device from available mask. */
264 for (i = 0; i < CNDEVTAB_SIZE; i++)
265 if (cnd == &cn_devtab[i]) {
266 cons_avail_mask &= ~(1 << i);
272 * syscons gets really confused if console resources are
273 * freed after the system has initialized.
275 if (cn->cn_term != NULL)
276 cn->cn_ops->cn_term(cn);
283 cnselect(struct consdev *cn)
285 struct cn_device *cnd;
287 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
288 if (cnd->cnd_cn != cn)
290 if (cnd == STAILQ_FIRST(&cn_devlist))
292 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
293 STAILQ_INSERT_HEAD(&cn_devlist, cnd, cnd_next);
294 ttyconsdev_select(cnd->cnd_cn->cn_name);
300 cnavailable(struct consdev *cn, int available)
304 for (i = 0; i < CNDEVTAB_SIZE; i++) {
305 if (cn_devtab[i].cnd_cn == cn)
309 if (i < CNDEVTAB_SIZE)
310 cons_avail_mask |= (1 << i);
311 cn->cn_flags &= ~CN_FLAG_NOAVAIL;
313 if (i < CNDEVTAB_SIZE)
314 cons_avail_mask &= ~(1 << i);
315 cn->cn_flags |= CN_FLAG_NOAVAIL;
323 return (cons_avail_mask == 0);
327 * sysctl_kern_console() provides output parseable in conscontrol(1).
330 sysctl_kern_console(SYSCTL_HANDLER_ARGS)
332 struct cn_device *cnd;
333 struct consdev *cp, **list;
339 sb = sbuf_new(NULL, NULL, CNDEVPATHMAX * 2, SBUF_AUTOEXTEND |
344 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
345 sbuf_printf(sb, "%s,", cnd->cnd_cn->cn_name);
347 SET_FOREACH(list, cons_set) {
349 if (cp->cn_name[0] != '\0')
350 sbuf_printf(sb, "%s,", cp->cn_name);
353 error = sysctl_handle_string(oidp, sbuf_data(sb), sbuf_len(sb), req);
354 if (error == 0 && req->newptr != NULL) {
362 SET_FOREACH(list, cons_set) {
364 if (strcmp(p, cp->cn_name) != 0)
381 SYSCTL_PROC(_kern, OID_AUTO, console,
382 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT, 0, 0,
383 sysctl_kern_console, "A",
384 "Console device control");
389 struct cn_device *cnd;
392 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
394 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
395 cn->cn_ops->cn_grab(cn);
402 struct cn_device *cnd;
405 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
407 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
408 cn->cn_ops->cn_ungrab(cn);
415 struct cn_device *cnd;
418 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
420 if (cn->cn_ops->cn_resume != NULL)
421 cn->cn_ops->cn_resume(cn);
426 * Low level console routines.
435 while ((c = cncheckc()) == -1)
438 c = '\n'; /* console input is always ICRNL */
445 struct cn_device *cnd;
451 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
453 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
454 c = cn->cn_ops->cn_getc(cn);
463 cngets(char *cp, size_t size, int visible)
512 struct cn_device *cnd;
517 if (early_putc != NULL) {
525 if (cn_mute || c == '\0')
527 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
529 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
531 cn->cn_ops->cn_putc(cn, '\r');
532 cn->cn_ops->cn_putc(cn, c);
535 if (console_pausing && c == '\n' && !kdb_active) {
536 for (cp = console_pausestr; *cp != '\0'; cp++)
540 console_pausing = false;
543 for (cp = console_pausestr; *cp != '\0'; cp++)
550 cnputsn(const char *p, size_t n)
553 bool unlock_reqd = false;
555 if (mtx_initialized(&cnputs_mtx)) {
557 * NOTE: Debug prints and/or witness printouts in
558 * console driver clients can cause the "cnputs_mtx"
559 * mutex to recurse. Simply return if that happens.
561 if (mtx_owned(&cnputs_mtx))
563 mtx_lock_spin(&cnputs_mtx);
567 for (i = 0; i < n; i++)
571 mtx_unlock_spin(&cnputs_mtx);
575 cnputs(const char *p)
577 cnputsn(p, strlen(p));
580 static unsigned int consmsgbuf_size = 65536;
581 SYSCTL_UINT(_kern, OID_AUTO, consmsgbuf_size, CTLFLAG_RWTUN, &consmsgbuf_size,
582 0, "Console tty buffer size");
585 * Redirect console output to a tty.
588 constty_set(struct tty *tp)
590 int size = consmsgbuf_size;
593 tty_assert_locked(tp);
599 if (consbuf == NULL) {
601 buf = malloc(size, M_TTYCONS, M_WAITOK);
604 mtx_lock(&constty_mtx);
605 if (constty != NULL) {
606 mtx_unlock(&constty_mtx);
607 free(buf, M_TTYCONS);
610 if (consbuf == NULL) {
612 msgbuf_init(&consmsgbuf, buf, size);
614 free(buf, M_TTYCONS);
616 mtx_unlock(&constty_mtx);
618 callout_init_mtx(&conscallout, tty_getlock(tp), 0);
624 * Disable console redirection to a tty.
627 constty_clear(struct tty *tp)
631 tty_assert_locked(tp);
634 callout_stop(&conscallout);
635 mtx_lock(&constty_mtx);
637 mtx_unlock(&constty_mtx);
638 while ((c = msgbuf_getchar(&consmsgbuf)) != -1)
640 /* We never free consbuf because it can still be in use. */
644 /* Times per second to check for pending console tty messages. */
645 static int constty_wakeups_per_second = 15;
646 SYSCTL_INT(_kern, OID_AUTO, constty_wakeups_per_second, CTLFLAG_RW,
647 &constty_wakeups_per_second, 0,
648 "Times per second to check for pending console tty messages");
651 constty_timeout(void *arg)
653 struct tty *tp = arg;
656 tty_assert_locked(tp);
657 while ((c = msgbuf_getchar(&consmsgbuf)) != -1) {
658 if (tty_putchar(tp, c) < 0) {
663 callout_reset_sbt(&conscallout, SBT_1S / constty_wakeups_per_second,
664 0, constty_timeout, tp, C_PREL(1));
668 * Sysbeep(), if we have hardware for it
671 #ifdef HAS_TIMER_SPKR
674 static struct callout beeping_timer;
677 sysbeepstop(void *chan)
680 timer_spkr_release();
685 sysbeep(int pitch, sbintime_t duration)
688 if (timer_spkr_acquire()) {
690 /* Something else owns it. */
694 timer_spkr_setfreq(pitch);
697 callout_reset_sbt(&beeping_timer, duration, 0, sysbeepstop,
704 sysbeep_init(void *unused)
707 callout_init(&beeping_timer, 1);
709 SYSINIT(sysbeep, SI_SUB_SOFTINTR, SI_ORDER_ANY, sysbeep_init, NULL);
713 * No hardware, no sound
717 sysbeep(int pitch __unused, sbintime_t duration __unused)
726 * Temporary support for sc(4) to vt(4) transition.
728 static unsigned vty_prefer;
729 static char vty_name[16];
730 SYSCTL_STRING(_kern, OID_AUTO, vty, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, vty_name,
731 0, "Console vty driver");
734 vty_enabled(unsigned vty)
736 static unsigned vty_selected = 0;
738 if (vty_selected == 0) {
739 TUNABLE_STR_FETCH("kern.vty", vty_name, sizeof(vty_name));
742 if (strcmp(vty_name, "sc") == 0) {
743 vty_selected = VTY_SC;
748 if (strcmp(vty_name, "vt") == 0) {
749 vty_selected = VTY_VT;
753 if (vty_prefer != 0) {
754 vty_selected = vty_prefer;
758 vty_selected = VTY_VT;
759 #elif defined(DEV_SC)
760 vty_selected = VTY_SC;
764 if (vty_selected == VTY_VT)
765 strcpy(vty_name, "vt");
766 else if (vty_selected == VTY_SC)
767 strcpy(vty_name, "sc");
769 return ((vty_selected & vty) != 0);
773 vty_set_preferred(unsigned vty)
778 vty_prefer &= ~VTY_SC;
781 vty_prefer &= ~VTY_VT;