2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2009 The FreeBSD Foundation
6 * This software was developed by Ed Schouten under sponsorship from the
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 #include <sys/param.h>
34 #include <sys/consio.h>
35 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/mutex.h>
39 #include <sys/systm.h>
40 #include <sys/terminal.h>
43 #include <machine/stdarg.h>
45 static MALLOC_DEFINE(M_TERMINAL, "terminal", "terminal device");
50 * Normally we don't need to lock down the terminal emulator, because
51 * the TTY lock is already held when calling teken_input().
52 * Unfortunately this is not the case when the terminal acts as a
53 * console device, because cnputc() can be called at the same time.
54 * This means terminals may need to be locked down using a spin lock.
56 #define TERMINAL_LOCK(tm) do { \
57 if ((tm)->tm_flags & TF_CONS) \
58 mtx_lock_spin(&(tm)->tm_mtx); \
59 else if ((tm)->tm_tty != NULL) \
60 tty_lock((tm)->tm_tty); \
62 #define TERMINAL_UNLOCK(tm) do { \
63 if ((tm)->tm_flags & TF_CONS) \
64 mtx_unlock_spin(&(tm)->tm_mtx); \
65 else if ((tm)->tm_tty != NULL) \
66 tty_unlock((tm)->tm_tty); \
68 #define TERMINAL_LOCK_TTY(tm) do { \
69 if ((tm)->tm_flags & TF_CONS) \
70 mtx_lock_spin(&(tm)->tm_mtx); \
72 #define TERMINAL_UNLOCK_TTY(tm) do { \
73 if ((tm)->tm_flags & TF_CONS) \
74 mtx_unlock_spin(&(tm)->tm_mtx); \
76 #define TERMINAL_LOCK_CONS(tm) mtx_lock_spin(&(tm)->tm_mtx)
77 #define TERMINAL_UNLOCK_CONS(tm) mtx_unlock_spin(&(tm)->tm_mtx)
83 static tsw_open_t termtty_open;
84 static tsw_close_t termtty_close;
85 static tsw_outwakeup_t termtty_outwakeup;
86 static tsw_ioctl_t termtty_ioctl;
87 static tsw_mmap_t termtty_mmap;
89 static struct ttydevsw terminal_tty_class = {
90 .tsw_open = termtty_open,
91 .tsw_close = termtty_close,
92 .tsw_outwakeup = termtty_outwakeup,
93 .tsw_ioctl = termtty_ioctl,
94 .tsw_mmap = termtty_mmap,
98 * Terminal emulator routines.
101 static tf_bell_t termteken_bell;
102 static tf_cursor_t termteken_cursor;
103 static tf_putchar_t termteken_putchar;
104 static tf_fill_t termteken_fill;
105 static tf_copy_t termteken_copy;
106 static tf_pre_input_t termteken_pre_input;
107 static tf_post_input_t termteken_post_input;
108 static tf_param_t termteken_param;
109 static tf_respond_t termteken_respond;
111 static teken_funcs_t terminal_drawmethods = {
112 .tf_bell = termteken_bell,
113 .tf_cursor = termteken_cursor,
114 .tf_putchar = termteken_putchar,
115 .tf_fill = termteken_fill,
116 .tf_copy = termteken_copy,
117 .tf_pre_input = termteken_pre_input,
118 .tf_post_input = termteken_post_input,
119 .tf_param = termteken_param,
120 .tf_respond = termteken_respond,
123 /* Kernel message formatting. */
124 static teken_attr_t kernel_message = {
125 .ta_fgcolor = TCHAR_FGCOLOR(TERMINAL_KERN_ATTR),
126 .ta_bgcolor = TCHAR_BGCOLOR(TERMINAL_KERN_ATTR),
127 .ta_format = TCHAR_FORMAT(TERMINAL_KERN_ATTR)
130 static teken_attr_t default_message = {
131 .ta_fgcolor = TCHAR_FGCOLOR(TERMINAL_NORM_ATTR),
132 .ta_bgcolor = TCHAR_BGCOLOR(TERMINAL_NORM_ATTR),
133 .ta_format = TCHAR_FORMAT(TERMINAL_NORM_ATTR)
136 /* Fudge fg brightness as TF_BOLD (shifted). */
137 #define TCOLOR_FG_FUDGED(color) __extension__ ({ \
141 TCOLOR_FG(_c & 7) | ((_c & 8) << 18); \
144 /* Fudge bg brightness as TF_BLINK (shifted). */
145 #define TCOLOR_BG_FUDGED(color) __extension__ ({ \
149 TCOLOR_BG(_c & 7) | ((_c & 8) << 20); \
152 #define TCOLOR_256TO16(color) __extension__ ({ \
157 _c = teken_256to16(_c); \
161 #define TCHAR_CREATE(c, a) ((c) | TFORMAT((a)->ta_format) | \
162 TCOLOR_FG_FUDGED(TCOLOR_256TO16((a)->ta_fgcolor)) | \
163 TCOLOR_BG_FUDGED(TCOLOR_256TO16((a)->ta_bgcolor)))
166 terminal_init(struct terminal *tm)
170 if (tm->tm_flags & TF_CONS)
171 mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
173 teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
176 TUNABLE_INT_FETCH("teken.fg_color", &fg);
177 TUNABLE_INT_FETCH("teken.bg_color", &bg);
180 default_message.ta_fgcolor = fg;
181 kernel_message.ta_fgcolor = fg;
184 default_message.ta_bgcolor = bg;
185 kernel_message.ta_bgcolor = bg;
188 if (default_message.ta_bgcolor == TC_WHITE) {
189 default_message.ta_bgcolor |= TC_LIGHT;
190 kernel_message.ta_bgcolor |= TC_LIGHT;
193 if (default_message.ta_bgcolor == TC_BLACK &&
194 default_message.ta_fgcolor < TC_NCOLORS)
195 kernel_message.ta_fgcolor |= TC_LIGHT;
196 teken_set_defattr(&tm->tm_emulator, &default_message);
200 terminal_alloc(const struct terminal_class *tc, void *softc)
204 tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
208 tm->tm_softc = softc;
214 terminal_sync_ttysize(struct terminal *tm)
223 tty_set_winsize(tp, &tm->tm_winsize);
228 terminal_maketty(struct terminal *tm, const char *fmt, ...)
235 vsnrprintf(name, sizeof name, 32, fmt, ap);
238 tp = tty_alloc(&terminal_tty_class, tm);
239 tty_makedev(tp, NULL, "%s", name);
241 terminal_sync_ttysize(tm);
245 terminal_set_cursor(struct terminal *tm, const term_pos_t *pos)
248 teken_set_cursor(&tm->tm_emulator, pos);
252 terminal_set_winsize_blank(struct terminal *tm, const struct winsize *size,
253 int blank, const term_attr_t *attr)
257 tm->tm_winsize = *size;
259 r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
260 r.tr_end.tp_row = size->ws_row;
261 r.tr_end.tp_col = size->ws_col;
265 teken_set_winsize_noreset(&tm->tm_emulator, &r.tr_end);
267 teken_set_winsize(&tm->tm_emulator, &r.tr_end);
270 if ((blank != 0) && !(tm->tm_flags & TF_MUTE))
271 tm->tm_class->tc_fill(tm, &r,
272 TCHAR_CREATE((teken_char_t)' ', attr));
274 terminal_sync_ttysize(tm);
278 terminal_set_winsize(struct terminal *tm, const struct winsize *size)
281 terminal_set_winsize_blank(tm, size, 1,
282 (const term_attr_t *)&default_message);
286 * XXX: This function is a kludge. Drivers like vt(4) need to
287 * temporarily stop input when resizing, etc. This should ideally be
288 * handled within the driver.
292 terminal_mute(struct terminal *tm, int yes)
297 tm->tm_flags |= TF_MUTE;
299 tm->tm_flags &= ~TF_MUTE;
304 terminal_input_char(struct terminal *tm, term_char_t c)
313 * Strip off any attributes. Also ignore input of second part of
314 * CJK fullwidth characters, as we don't want to return these
317 if (TCHAR_FORMAT(c) & TF_CJK_RIGHT)
319 c = TCHAR_CHARACTER(c);
323 * Conversion to UTF-8.
326 ttydisc_rint(tp, c, 0);
327 } else if (c < 0x800) {
333 ttydisc_rint_simple(tp, str, sizeof str);
334 } else if (c < 0x10000) {
337 0x80 | ((c >> 6) & 0x3f),
341 ttydisc_rint_simple(tp, str, sizeof str);
345 0x80 | ((c >> 12) & 0x3f),
346 0x80 | ((c >> 6) & 0x3f),
350 ttydisc_rint_simple(tp, str, sizeof str);
352 ttydisc_rint_done(tp);
357 terminal_input_raw(struct terminal *tm, char c)
366 ttydisc_rint(tp, c, 0);
367 ttydisc_rint_done(tp);
372 terminal_input_special(struct terminal *tm, unsigned int k)
381 str = teken_get_sequence(&tm->tm_emulator, k);
386 ttydisc_rint_simple(tp, str, strlen(str));
387 ttydisc_rint_done(tp);
392 * Binding with the TTY layer.
396 termtty_open(struct tty *tp)
398 struct terminal *tm = tty_softc(tp);
400 tm->tm_class->tc_opened(tm, 1);
405 termtty_close(struct tty *tp)
407 struct terminal *tm = tty_softc(tp);
409 tm->tm_class->tc_opened(tm, 0);
413 termtty_outwakeup(struct tty *tp)
415 struct terminal *tm = tty_softc(tp);
418 unsigned int flags = 0;
420 while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
421 TERMINAL_LOCK_TTY(tm);
422 if (!(tm->tm_flags & TF_MUTE)) {
423 tm->tm_flags &= ~TF_BELL;
424 teken_input(&tm->tm_emulator, obuf, olen);
425 flags |= tm->tm_flags;
427 TERMINAL_UNLOCK_TTY(tm);
430 TERMINAL_LOCK_TTY(tm);
431 if (!(tm->tm_flags & TF_MUTE))
432 tm->tm_class->tc_done(tm);
433 TERMINAL_UNLOCK_TTY(tm);
435 tm->tm_class->tc_bell(tm);
439 termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
441 struct terminal *tm = tty_softc(tp);
446 vid_info_t *vi = (vid_info_t *)data;
447 const teken_pos_t *p;
450 if (vi->size != sizeof(vid_info_t))
453 /* Already help the console driver by filling in some data. */
454 p = teken_get_cursor(&tm->tm_emulator);
455 vi->mv_row = p->tp_row;
456 vi->mv_col = p->tp_col;
458 p = teken_get_winsize(&tm->tm_emulator);
459 vi->mv_rsz = p->tp_row;
460 vi->mv_csz = p->tp_col;
462 teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
463 vi->mv_norm.fore = fg;
464 vi->mv_norm.back = bg;
465 /* XXX: keep vidcontrol happy; bold backgrounds. */
466 vi->mv_rev.fore = bg;
467 vi->mv_rev.back = fg & 0x7;
473 * Unlike various other drivers, this driver will never
474 * deallocate TTYs. This means it's safe to temporarily unlock
475 * the TTY when handling ioctls.
478 error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
480 if ((error == 0) && (cmd == CONS_CLRHIST)) {
482 * Scrollback history has been successfully cleared,
483 * so reset the cursor position to the top left of the screen.
488 teken_set_cursor(&tm->tm_emulator, &p);
494 termtty_mmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t * paddr,
495 int nprot, vm_memattr_t *memattr)
497 struct terminal *tm = tty_softc(tp);
499 return (tm->tm_class->tc_mmap(tm, offset, paddr, nprot, memattr));
503 * Binding with the kernel and debug console.
506 static cn_probe_t termcn_cnprobe;
507 static cn_init_t termcn_cninit;
508 static cn_term_t termcn_cnterm;
509 static cn_getc_t termcn_cngetc;
510 static cn_putc_t termcn_cnputc;
511 static cn_grab_t termcn_cngrab;
512 static cn_ungrab_t termcn_cnungrab;
514 const struct consdev_ops termcn_cnops = {
515 .cn_probe = termcn_cnprobe,
516 .cn_init = termcn_cninit,
517 .cn_term = termcn_cnterm,
518 .cn_getc = termcn_cngetc,
519 .cn_putc = termcn_cnputc,
520 .cn_grab = termcn_cngrab,
521 .cn_ungrab = termcn_cnungrab,
525 termcn_cnregister(struct terminal *tm)
531 cp = malloc(sizeof(struct consdev), M_TERMINAL,
533 cp->cn_ops = &termcn_cnops;
535 cp->cn_pri = CN_INTERNAL;
536 sprintf(cp->cn_name, "ttyv0");
538 tm->tm_flags = TF_CONS;
544 /* Attach terminal as console. */
549 termcn_cngrab(struct consdev *cp)
551 struct terminal *tm = cp->cn_arg;
553 tm->tm_class->tc_cngrab(tm);
557 termcn_cnungrab(struct consdev *cp)
559 struct terminal *tm = cp->cn_arg;
561 tm->tm_class->tc_cnungrab(tm);
565 termcn_cnprobe(struct consdev *cp)
567 struct terminal *tm = cp->cn_arg;
570 cp->cn_pri = CN_DEAD;
577 tm->tm_class->tc_cnprobe(tm, cp);
581 termcn_cninit(struct consdev *cp)
587 termcn_cnterm(struct consdev *cp)
593 termcn_cngetc(struct consdev *cp)
595 struct terminal *tm = cp->cn_arg;
597 return (tm->tm_class->tc_cngetc(tm));
601 termcn_cnputc(struct consdev *cp, int c)
603 struct terminal *tm = cp->cn_arg;
607 TERMINAL_LOCK_CONS(tm);
608 if (!(tm->tm_flags & TF_MUTE)) {
609 backup = *teken_get_curattr(&tm->tm_emulator);
610 teken_set_curattr(&tm->tm_emulator, &kernel_message);
611 teken_input(&tm->tm_emulator, &cv, 1);
612 teken_set_curattr(&tm->tm_emulator, &backup);
613 tm->tm_class->tc_done(tm);
615 TERMINAL_UNLOCK_CONS(tm);
619 * Binding with the terminal emulator.
623 termteken_bell(void *softc)
625 struct terminal *tm = softc;
627 tm->tm_flags |= TF_BELL;
631 termteken_cursor(void *softc, const teken_pos_t *p)
633 struct terminal *tm = softc;
635 tm->tm_class->tc_cursor(tm, p);
639 termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
640 const teken_attr_t *a)
642 struct terminal *tm = softc;
644 tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
648 termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
649 const teken_attr_t *a)
651 struct terminal *tm = softc;
653 tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
657 termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
659 struct terminal *tm = softc;
661 tm->tm_class->tc_copy(tm, r, p);
665 termteken_pre_input(void *softc)
667 struct terminal *tm = softc;
669 tm->tm_class->tc_pre_input(tm);
673 termteken_post_input(void *softc)
675 struct terminal *tm = softc;
677 tm->tm_class->tc_post_input(tm);
681 termteken_param(void *softc, int cmd, unsigned int arg)
683 struct terminal *tm = softc;
685 tm->tm_class->tc_param(tm, cmd, arg);
689 termteken_respond(void *softc, const void *buf, size_t len)
692 struct terminal *tm = softc;
696 * Only inject a response into the TTY if the data actually
697 * originated from the TTY.
699 * XXX: This cannot be done right now. The TTY could pick up
700 * other locks. It could also in theory cause loops, when the
701 * TTY performs echoing of a command that generates even more
708 ttydisc_rint_simple(tp, buf, len);
709 ttydisc_rint_done(tp);