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
39 * from: @(#)cons.c 7.2 (Berkeley) 5/9/91
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
46 #include "opt_syscons.h"
48 #include <sys/param.h>
49 #include <sys/systm.h>
51 #include <sys/mutex.h>
54 #include <sys/fcntl.h>
57 #include <sys/kernel.h>
58 #include <sys/malloc.h>
59 #include <sys/msgbuf.h>
60 #include <sys/namei.h>
63 #include <sys/queue.h>
64 #include <sys/reboot.h>
65 #include <sys/sysctl.h>
69 #include <sys/vnode.h>
73 #include <dev/kbd/kbdreg.h>
75 #include <machine/cpu.h>
76 #include <machine/clock.h>
78 static MALLOC_DEFINE(M_TTYCONS, "tty console", "tty console handling");
81 STAILQ_ENTRY(cn_device) cnd_next;
82 struct consdev *cnd_cn;
85 #define CNDEVPATHMAX 32
86 #define CNDEVTAB_SIZE 4
87 static struct cn_device cn_devtab[CNDEVTAB_SIZE];
88 static STAILQ_HEAD(, cn_device) cn_devlist =
89 STAILQ_HEAD_INITIALIZER(cn_devlist);
91 int cons_avail_mask = 0; /* Bit mask. Each registered low level console
92 * which is currently unavailable for inpit
93 * (i.e., if it is in graphics mode) will have
97 static char *consbuf; /* buffer used by `consmsgbuf' */
98 static struct callout conscallout; /* callout for outputting to constty */
99 struct msgbuf consmsgbuf; /* message buffer for console tty */
100 static u_char console_pausing; /* pause after each line during probe */
101 static const char console_pausestr[] =
102 "<pause; press any key to proceed to next line or '.' to end pause mode>";
103 struct tty *constty; /* pointer to console "window" tty */
104 static struct mtx cnputs_mtx; /* Mutex for cnputs(). */
105 static int use_cnputs_mtx = 0; /* != 0 if cnputs_mtx locking reqd. */
107 static void constty_timeout(void *arg);
109 static struct consdev cons_consdev;
110 DATA_SET(cons_set, cons_consdev);
111 SET_DECLARE(cons_set, struct consdev);
114 * Stub for configurations that don't actually have a keyboard driver. Inclusion
115 * of kbd.c is contingent on any number of keyboard/console drivers being
116 * present in the kernel; rather than trying to catch them all, we'll just
117 * maintain this weak kbdinit that will be overridden by the strong version in
118 * kbd.c if it's present.
129 struct consdev *best_cn, *cn, **list;
132 * Check if we should mute the console (for security reasons perhaps)
133 * It can be changes dynamically using sysctl kern.consmute
134 * once we are up and going.
137 cn_mute = ((boothowto & (RB_MUTE
140 |RB_ASKNAME)) == RB_MUTE);
143 * Bring up the kbd layer just in time for cnprobe. Console drivers
144 * have a dependency on kbd being ready, so this fits nicely between the
145 * machdep callers of cninit() and MI probing/initialization of consoles
151 * Find the first console with the highest priority.
154 SET_FOREACH(list, cons_set) {
157 /* Skip cons_consdev. */
158 if (cn->cn_ops == NULL)
160 cn->cn_ops->cn_probe(cn);
161 if (cn->cn_pri == CN_DEAD)
163 if (best_cn == NULL || cn->cn_pri > best_cn->cn_pri)
165 if (boothowto & RB_MULTIPLE) {
167 * Initialize console, and attach to it.
169 cn->cn_ops->cn_init(cn);
175 if ((boothowto & RB_MULTIPLE) == 0) {
176 best_cn->cn_ops->cn_init(best_cn);
179 if (boothowto & RB_PAUSE)
182 * Make the best console the preferred console.
188 * Release early console.
200 /* add a new physical console to back the virtual console */
202 cnadd(struct consdev *cn)
204 struct cn_device *cnd;
207 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
208 if (cnd->cnd_cn == cn)
210 for (i = 0; i < CNDEVTAB_SIZE; i++) {
212 if (cnd->cnd_cn == NULL)
215 if (cnd->cnd_cn != NULL)
218 if (cn->cn_name[0] == '\0') {
219 /* XXX: it is unclear if/where this print might output */
220 printf("WARNING: console at %p has no name\n", cn);
222 STAILQ_INSERT_TAIL(&cn_devlist, cnd, cnd_next);
223 if (STAILQ_FIRST(&cn_devlist) == cnd)
224 ttyconsdev_select(cnd->cnd_cn->cn_name);
226 /* Add device to the active mask. */
227 cnavailable(cn, (cn->cn_flags & CN_FLAG_NOAVAIL) == 0);
233 cnremove(struct consdev *cn)
235 struct cn_device *cnd;
238 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
239 if (cnd->cnd_cn != cn)
241 if (STAILQ_FIRST(&cn_devlist) == cnd)
242 ttyconsdev_select(NULL);
243 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
246 /* Remove this device from available mask. */
247 for (i = 0; i < CNDEVTAB_SIZE; i++)
248 if (cnd == &cn_devtab[i]) {
249 cons_avail_mask &= ~(1 << i);
255 * syscons gets really confused if console resources are
256 * freed after the system has initialized.
258 if (cn->cn_term != NULL)
259 cn->cn_ops->cn_term(cn);
266 cnselect(struct consdev *cn)
268 struct cn_device *cnd;
270 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
271 if (cnd->cnd_cn != cn)
273 if (cnd == STAILQ_FIRST(&cn_devlist))
275 STAILQ_REMOVE(&cn_devlist, cnd, cn_device, cnd_next);
276 STAILQ_INSERT_HEAD(&cn_devlist, cnd, cnd_next);
277 ttyconsdev_select(cnd->cnd_cn->cn_name);
283 cnavailable(struct consdev *cn, int available)
287 for (i = 0; i < CNDEVTAB_SIZE; i++) {
288 if (cn_devtab[i].cnd_cn == cn)
292 if (i < CNDEVTAB_SIZE)
293 cons_avail_mask |= (1 << i);
294 cn->cn_flags &= ~CN_FLAG_NOAVAIL;
296 if (i < CNDEVTAB_SIZE)
297 cons_avail_mask &= ~(1 << i);
298 cn->cn_flags |= CN_FLAG_NOAVAIL;
306 return (cons_avail_mask == 0);
310 * sysctl_kern_console() provides output parseable in conscontrol(1).
313 sysctl_kern_console(SYSCTL_HANDLER_ARGS)
315 struct cn_device *cnd;
316 struct consdev *cp, **list;
321 sb = sbuf_new(NULL, NULL, CNDEVPATHMAX * 2, SBUF_AUTOEXTEND |
326 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next)
327 sbuf_printf(sb, "%s,", cnd->cnd_cn->cn_name);
328 sbuf_printf(sb, "/");
329 SET_FOREACH(list, cons_set) {
331 if (cp->cn_name[0] != '\0')
332 sbuf_printf(sb, "%s,", cp->cn_name);
335 error = sysctl_handle_string(oidp, sbuf_data(sb), sbuf_len(sb), req);
336 if (error == 0 && req->newptr != NULL) {
344 SET_FOREACH(list, cons_set) {
346 if (strcmp(p, cp->cn_name) != 0)
363 SYSCTL_PROC(_kern, OID_AUTO, console,
364 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT, 0, 0,
365 sysctl_kern_console, "A",
366 "Console device control");
369 * User has changed the state of the console muting.
370 * This may require us to open or close the device in question.
373 sysctl_kern_consmute(SYSCTL_HANDLER_ARGS)
377 error = sysctl_handle_int(oidp, &cn_mute, 0, req);
378 if (error != 0 || req->newptr == NULL)
383 SYSCTL_PROC(_kern, OID_AUTO, consmute,
384 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, 0, sizeof(cn_mute),
385 sysctl_kern_consmute, "I",
386 "State of the console muting");
391 struct cn_device *cnd;
394 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
396 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
397 cn->cn_ops->cn_grab(cn);
404 struct cn_device *cnd;
407 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
409 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG))
410 cn->cn_ops->cn_ungrab(cn);
417 struct cn_device *cnd;
420 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
422 if (cn->cn_ops->cn_resume != NULL)
423 cn->cn_ops->cn_resume(cn);
428 * Low level console routines.
437 while ((c = cncheckc()) == -1)
440 c = '\n'; /* console input is always ICRNL */
447 struct cn_device *cnd;
453 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
455 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
456 c = cn->cn_ops->cn_getc(cn);
465 cngets(char *cp, size_t size, int visible)
514 struct cn_device *cnd;
519 if (early_putc != NULL) {
527 if (cn_mute || c == '\0')
529 STAILQ_FOREACH(cnd, &cn_devlist, cnd_next) {
531 if (!kdb_active || !(cn->cn_flags & CN_FLAG_NODEBUG)) {
533 cn->cn_ops->cn_putc(cn, '\r');
534 cn->cn_ops->cn_putc(cn, c);
537 if (console_pausing && c == '\n' && !kdb_active) {
538 for (cp = console_pausestr; *cp != '\0'; cp++)
545 for (cp = console_pausestr; *cp != '\0'; cp++)
552 cnputsn(const char *p, size_t n)
557 if (use_cnputs_mtx) {
559 * NOTE: Debug prints and/or witness printouts in
560 * console driver clients can cause the "cnputs_mtx"
561 * mutex to recurse. Simply return if that happens.
563 if (mtx_owned(&cnputs_mtx))
565 mtx_lock_spin(&cnputs_mtx);
569 for (i = 0; i < n; i++)
573 mtx_unlock_spin(&cnputs_mtx);
577 cnputs(const char *p)
579 cnputsn(p, strlen(p));
582 static int consmsgbuf_size = 8192;
583 SYSCTL_INT(_kern, OID_AUTO, consmsgbuf_size, CTLFLAG_RW, &consmsgbuf_size, 0,
584 "Console tty buffer size");
587 * Redirect console output to a tty.
590 constty_set(struct tty *tp)
594 KASSERT(tp != NULL, ("constty_set: NULL tp"));
595 if (consbuf == NULL) {
596 size = consmsgbuf_size;
597 consbuf = malloc(size, M_TTYCONS, M_WAITOK);
598 msgbuf_init(&consmsgbuf, consbuf, size);
599 callout_init(&conscallout, 0);
602 constty_timeout(NULL);
606 * Disable console redirection to a tty.
616 callout_stop(&conscallout);
617 while ((c = msgbuf_getchar(&consmsgbuf)) != -1)
619 free(consbuf, M_TTYCONS);
623 /* Times per second to check for pending console tty messages. */
624 static int constty_wakeups_per_second = 5;
625 SYSCTL_INT(_kern, OID_AUTO, constty_wakeups_per_second, CTLFLAG_RW,
626 &constty_wakeups_per_second, 0,
627 "Times per second to check for pending console tty messages");
630 constty_timeout(void *arg)
634 if (constty != NULL) {
636 while ((c = msgbuf_getchar(&consmsgbuf)) != -1) {
637 if (tty_putchar(constty, c) < 0) {
647 if (constty != NULL) {
648 callout_reset(&conscallout, hz / constty_wakeups_per_second,
649 constty_timeout, NULL);
651 /* Deallocate the constty buffer memory. */
657 cn_drvinit(void *unused)
660 mtx_init(&cnputs_mtx, "cnputs_mtx", NULL, MTX_SPIN | MTX_NOWITNESS);
664 SYSINIT(cndev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, cn_drvinit, NULL);
667 * Sysbeep(), if we have hardware for it
670 #ifdef HAS_TIMER_SPKR
673 static struct callout beeping_timer;
676 sysbeepstop(void *chan)
679 timer_spkr_release();
684 sysbeep(int pitch, int period)
687 if (timer_spkr_acquire()) {
689 /* Something else owns it. */
693 timer_spkr_setfreq(pitch);
696 callout_reset(&beeping_timer, period, sysbeepstop, NULL);
702 sysbeep_init(void *unused)
705 callout_init(&beeping_timer, 1);
707 SYSINIT(sysbeep, SI_SUB_SOFTINTR, SI_ORDER_ANY, sysbeep_init, NULL);
711 * No hardware, no sound
715 sysbeep(int pitch __unused, int period __unused)
724 * Temporary support for sc(4) to vt(4) transition.
726 static unsigned vty_prefer;
727 static char vty_name[16];
728 SYSCTL_STRING(_kern, OID_AUTO, vty, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, vty_name,
729 0, "Console vty driver");
732 vty_enabled(unsigned vty)
734 static unsigned vty_selected = 0;
736 if (vty_selected == 0) {
737 TUNABLE_STR_FETCH("kern.vty", vty_name, sizeof(vty_name));
740 if (strcmp(vty_name, "sc") == 0) {
741 vty_selected = VTY_SC;
746 if (strcmp(vty_name, "vt") == 0) {
747 vty_selected = VTY_VT;
751 if (vty_prefer != 0) {
752 vty_selected = vty_prefer;
756 vty_selected = VTY_VT;
757 #elif defined(DEV_SC)
758 vty_selected = VTY_SC;
762 if (vty_selected == VTY_VT)
763 strcpy(vty_name, "vt");
764 else if (vty_selected == VTY_SC)
765 strcpy(vty_name, "sc");
767 return ((vty_selected & vty) != 0);
771 vty_set_preferred(unsigned vty)
776 vty_prefer &= ~VTY_SC;
779 vty_prefer &= ~VTY_VT;