2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
36 #include <sys/consio.h>
37 #include <sys/kernel.h>
39 #include <sys/malloc.h>
40 #include <sys/mutex.h>
41 #include <sys/systm.h>
42 #include <sys/terminal.h>
45 #include <machine/stdarg.h>
47 static MALLOC_DEFINE(M_TERMINAL, "terminal", "terminal device");
52 * Normally we don't need to lock down the terminal emulator, because
53 * the TTY lock is already held when calling teken_input().
54 * Unfortunately this is not the case when the terminal acts as a
55 * console device, because cnputc() can be called at the same time.
56 * This means terminals may need to be locked down using a spin lock.
58 #define TERMINAL_LOCK(tm) do { \
59 if ((tm)->tm_flags & TF_CONS) \
60 mtx_lock_spin(&(tm)->tm_mtx); \
61 else if ((tm)->tm_tty != NULL) \
62 tty_lock((tm)->tm_tty); \
64 #define TERMINAL_UNLOCK(tm) do { \
65 if ((tm)->tm_flags & TF_CONS) \
66 mtx_unlock_spin(&(tm)->tm_mtx); \
67 else if ((tm)->tm_tty != NULL) \
68 tty_unlock((tm)->tm_tty); \
70 #define TERMINAL_LOCK_TTY(tm) do { \
71 if ((tm)->tm_flags & TF_CONS) \
72 mtx_lock_spin(&(tm)->tm_mtx); \
74 #define TERMINAL_UNLOCK_TTY(tm) do { \
75 if ((tm)->tm_flags & TF_CONS) \
76 mtx_unlock_spin(&(tm)->tm_mtx); \
78 #define TERMINAL_LOCK_CONS(tm) mtx_lock_spin(&(tm)->tm_mtx)
79 #define TERMINAL_UNLOCK_CONS(tm) mtx_unlock_spin(&(tm)->tm_mtx)
85 static tsw_open_t termtty_open;
86 static tsw_close_t termtty_close;
87 static tsw_outwakeup_t termtty_outwakeup;
88 static tsw_ioctl_t termtty_ioctl;
89 static tsw_mmap_t termtty_mmap;
91 static struct ttydevsw terminal_tty_class = {
92 .tsw_open = termtty_open,
93 .tsw_close = termtty_close,
94 .tsw_outwakeup = termtty_outwakeup,
95 .tsw_ioctl = termtty_ioctl,
96 .tsw_mmap = termtty_mmap,
100 * Terminal emulator routines.
103 static tf_bell_t termteken_bell;
104 static tf_cursor_t termteken_cursor;
105 static tf_putchar_t termteken_putchar;
106 static tf_fill_t termteken_fill;
107 static tf_copy_t termteken_copy;
108 static tf_pre_input_t termteken_pre_input;
109 static tf_post_input_t termteken_post_input;
110 static tf_param_t termteken_param;
111 static tf_respond_t termteken_respond;
113 static teken_funcs_t terminal_drawmethods = {
114 .tf_bell = termteken_bell,
115 .tf_cursor = termteken_cursor,
116 .tf_putchar = termteken_putchar,
117 .tf_fill = termteken_fill,
118 .tf_copy = termteken_copy,
119 .tf_pre_input = termteken_pre_input,
120 .tf_post_input = termteken_post_input,
121 .tf_param = termteken_param,
122 .tf_respond = termteken_respond,
125 /* Kernel message formatting. */
126 static teken_attr_t kernel_message = {
127 .ta_fgcolor = TCHAR_FGCOLOR(TERMINAL_KERN_ATTR),
128 .ta_bgcolor = TCHAR_BGCOLOR(TERMINAL_KERN_ATTR),
129 .ta_format = TCHAR_FORMAT(TERMINAL_KERN_ATTR)
132 static teken_attr_t default_message = {
133 .ta_fgcolor = TCHAR_FGCOLOR(TERMINAL_NORM_ATTR),
134 .ta_bgcolor = TCHAR_BGCOLOR(TERMINAL_NORM_ATTR),
135 .ta_format = TCHAR_FORMAT(TERMINAL_NORM_ATTR)
138 /* Fudge fg brightness as TF_BOLD (shifted). */
139 #define TCOLOR_FG_FUDGED(color) __extension__ ({ \
143 TCOLOR_FG(_c & 7) | ((_c & 8) << 18); \
146 /* Fudge bg brightness as TF_BLINK (shifted). */
147 #define TCOLOR_BG_FUDGED(color) __extension__ ({ \
151 TCOLOR_BG(_c & 7) | ((_c & 8) << 20); \
154 #define TCOLOR_256TO16(color) __extension__ ({ \
159 _c = teken_256to16(_c); \
163 #define TCHAR_CREATE(c, a) ((c) | TFORMAT((a)->ta_format) | \
164 TCOLOR_FG_FUDGED(TCOLOR_256TO16((a)->ta_fgcolor)) | \
165 TCOLOR_BG_FUDGED(TCOLOR_256TO16((a)->ta_bgcolor)))
168 terminal_init(struct terminal *tm)
172 if (tm->tm_flags & TF_CONS)
173 mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
175 teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
178 TUNABLE_INT_FETCH("teken.fg_color", &fg);
179 TUNABLE_INT_FETCH("teken.bg_color", &bg);
182 default_message.ta_fgcolor = fg;
183 kernel_message.ta_fgcolor = fg;
186 default_message.ta_bgcolor = bg;
187 kernel_message.ta_bgcolor = bg;
190 if (default_message.ta_bgcolor == TC_WHITE) {
191 default_message.ta_bgcolor |= TC_LIGHT;
192 kernel_message.ta_bgcolor |= TC_LIGHT;
195 if (default_message.ta_bgcolor == TC_BLACK &&
196 default_message.ta_fgcolor < TC_NCOLORS)
197 kernel_message.ta_fgcolor |= TC_LIGHT;
198 teken_set_defattr(&tm->tm_emulator, &default_message);
202 terminal_alloc(const struct terminal_class *tc, void *softc)
206 tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
210 tm->tm_softc = softc;
216 terminal_sync_ttysize(struct terminal *tm)
225 tty_set_winsize(tp, &tm->tm_winsize);
230 terminal_maketty(struct terminal *tm, const char *fmt, ...)
237 vsnrprintf(name, sizeof name, 32, fmt, ap);
240 tp = tty_alloc(&terminal_tty_class, tm);
241 tty_makedev(tp, NULL, "%s", name);
243 terminal_sync_ttysize(tm);
247 terminal_set_cursor(struct terminal *tm, const term_pos_t *pos)
250 teken_set_cursor(&tm->tm_emulator, pos);
254 terminal_set_winsize_blank(struct terminal *tm, const struct winsize *size,
255 int blank, const term_attr_t *attr)
259 tm->tm_winsize = *size;
261 r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
262 r.tr_end.tp_row = size->ws_row;
263 r.tr_end.tp_col = size->ws_col;
267 teken_set_winsize_noreset(&tm->tm_emulator, &r.tr_end);
269 teken_set_winsize(&tm->tm_emulator, &r.tr_end);
272 if ((blank != 0) && !(tm->tm_flags & TF_MUTE))
273 tm->tm_class->tc_fill(tm, &r,
274 TCHAR_CREATE((teken_char_t)' ', attr));
276 terminal_sync_ttysize(tm);
280 terminal_set_winsize(struct terminal *tm, const struct winsize *size)
283 terminal_set_winsize_blank(tm, size, 1,
284 (const term_attr_t *)&default_message);
288 * XXX: This function is a kludge. Drivers like vt(4) need to
289 * temporarily stop input when resizing, etc. This should ideally be
290 * handled within the driver.
294 terminal_mute(struct terminal *tm, int yes)
299 tm->tm_flags |= TF_MUTE;
301 tm->tm_flags &= ~TF_MUTE;
306 terminal_input_char(struct terminal *tm, term_char_t c)
315 * Strip off any attributes. Also ignore input of second part of
316 * CJK fullwidth characters, as we don't want to return these
319 if (TCHAR_FORMAT(c) & TF_CJK_RIGHT)
321 c = TCHAR_CHARACTER(c);
325 * Conversion to UTF-8.
328 ttydisc_rint(tp, c, 0);
329 } else if (c < 0x800) {
335 ttydisc_rint_simple(tp, str, sizeof str);
336 } else if (c < 0x10000) {
339 0x80 | ((c >> 6) & 0x3f),
343 ttydisc_rint_simple(tp, str, sizeof str);
347 0x80 | ((c >> 12) & 0x3f),
348 0x80 | ((c >> 6) & 0x3f),
352 ttydisc_rint_simple(tp, str, sizeof str);
354 ttydisc_rint_done(tp);
359 terminal_input_raw(struct terminal *tm, char c)
368 ttydisc_rint(tp, c, 0);
369 ttydisc_rint_done(tp);
374 terminal_input_special(struct terminal *tm, unsigned int k)
383 str = teken_get_sequence(&tm->tm_emulator, k);
388 ttydisc_rint_simple(tp, str, strlen(str));
389 ttydisc_rint_done(tp);
394 * Binding with the TTY layer.
398 termtty_open(struct tty *tp)
400 struct terminal *tm = tty_softc(tp);
402 tm->tm_class->tc_opened(tm, 1);
407 termtty_close(struct tty *tp)
409 struct terminal *tm = tty_softc(tp);
411 tm->tm_class->tc_opened(tm, 0);
415 termtty_outwakeup(struct tty *tp)
417 struct terminal *tm = tty_softc(tp);
420 unsigned int flags = 0;
422 while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
423 TERMINAL_LOCK_TTY(tm);
424 if (!(tm->tm_flags & TF_MUTE)) {
425 tm->tm_flags &= ~TF_BELL;
426 teken_input(&tm->tm_emulator, obuf, olen);
427 flags |= tm->tm_flags;
429 TERMINAL_UNLOCK_TTY(tm);
432 TERMINAL_LOCK_TTY(tm);
433 if (!(tm->tm_flags & TF_MUTE))
434 tm->tm_class->tc_done(tm);
435 TERMINAL_UNLOCK_TTY(tm);
437 tm->tm_class->tc_bell(tm);
441 termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
443 struct terminal *tm = tty_softc(tp);
448 vid_info_t *vi = (vid_info_t *)data;
449 const teken_pos_t *p;
452 if (vi->size != sizeof(vid_info_t))
455 /* Already help the console driver by filling in some data. */
456 p = teken_get_cursor(&tm->tm_emulator);
457 vi->mv_row = p->tp_row;
458 vi->mv_col = p->tp_col;
460 p = teken_get_winsize(&tm->tm_emulator);
461 vi->mv_rsz = p->tp_row;
462 vi->mv_csz = p->tp_col;
464 teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
465 vi->mv_norm.fore = fg;
466 vi->mv_norm.back = bg;
467 /* XXX: keep vidcontrol happy; bold backgrounds. */
468 vi->mv_rev.fore = bg;
469 vi->mv_rev.back = fg & 0x7;
475 * Unlike various other drivers, this driver will never
476 * deallocate TTYs. This means it's safe to temporarily unlock
477 * the TTY when handling ioctls.
480 error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
482 if ((error == 0) && (cmd == CONS_CLRHIST)) {
484 * Scrollback history has been successfully cleared,
485 * so reset the cursor position to the top left of the screen.
490 teken_set_cursor(&tm->tm_emulator, &p);
496 termtty_mmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t * paddr,
497 int nprot, vm_memattr_t *memattr)
499 struct terminal *tm = tty_softc(tp);
501 return (tm->tm_class->tc_mmap(tm, offset, paddr, nprot, memattr));
505 * Binding with the kernel and debug console.
508 static cn_probe_t termcn_cnprobe;
509 static cn_init_t termcn_cninit;
510 static cn_term_t termcn_cnterm;
511 static cn_getc_t termcn_cngetc;
512 static cn_putc_t termcn_cnputc;
513 static cn_grab_t termcn_cngrab;
514 static cn_ungrab_t termcn_cnungrab;
516 const struct consdev_ops termcn_cnops = {
517 .cn_probe = termcn_cnprobe,
518 .cn_init = termcn_cninit,
519 .cn_term = termcn_cnterm,
520 .cn_getc = termcn_cngetc,
521 .cn_putc = termcn_cnputc,
522 .cn_grab = termcn_cngrab,
523 .cn_ungrab = termcn_cnungrab,
527 termcn_cnregister(struct terminal *tm)
533 cp = malloc(sizeof(struct consdev), M_TERMINAL,
535 cp->cn_ops = &termcn_cnops;
537 cp->cn_pri = CN_INTERNAL;
538 sprintf(cp->cn_name, "ttyv0");
540 tm->tm_flags = TF_CONS;
546 /* Attach terminal as console. */
551 termcn_cngrab(struct consdev *cp)
553 struct terminal *tm = cp->cn_arg;
555 tm->tm_class->tc_cngrab(tm);
559 termcn_cnungrab(struct consdev *cp)
561 struct terminal *tm = cp->cn_arg;
563 tm->tm_class->tc_cnungrab(tm);
567 termcn_cnprobe(struct consdev *cp)
569 struct terminal *tm = cp->cn_arg;
572 cp->cn_pri = CN_DEAD;
579 tm->tm_class->tc_cnprobe(tm, cp);
583 termcn_cninit(struct consdev *cp)
589 termcn_cnterm(struct consdev *cp)
595 termcn_cngetc(struct consdev *cp)
597 struct terminal *tm = cp->cn_arg;
599 return (tm->tm_class->tc_cngetc(tm));
603 termcn_cnputc(struct consdev *cp, int c)
605 struct terminal *tm = cp->cn_arg;
609 TERMINAL_LOCK_CONS(tm);
610 if (!(tm->tm_flags & TF_MUTE)) {
611 backup = *teken_get_curattr(&tm->tm_emulator);
612 teken_set_curattr(&tm->tm_emulator, &kernel_message);
613 teken_input(&tm->tm_emulator, &cv, 1);
614 teken_set_curattr(&tm->tm_emulator, &backup);
615 tm->tm_class->tc_done(tm);
617 TERMINAL_UNLOCK_CONS(tm);
621 * Binding with the terminal emulator.
625 termteken_bell(void *softc)
627 struct terminal *tm = softc;
629 tm->tm_flags |= TF_BELL;
633 termteken_cursor(void *softc, const teken_pos_t *p)
635 struct terminal *tm = softc;
637 tm->tm_class->tc_cursor(tm, p);
641 termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
642 const teken_attr_t *a)
644 struct terminal *tm = softc;
646 tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
650 termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
651 const teken_attr_t *a)
653 struct terminal *tm = softc;
655 tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
659 termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
661 struct terminal *tm = softc;
663 tm->tm_class->tc_copy(tm, r, p);
667 termteken_pre_input(void *softc)
669 struct terminal *tm = softc;
671 tm->tm_class->tc_pre_input(tm);
675 termteken_post_input(void *softc)
677 struct terminal *tm = softc;
679 tm->tm_class->tc_post_input(tm);
683 termteken_param(void *softc, int cmd, unsigned int arg)
685 struct terminal *tm = softc;
687 tm->tm_class->tc_param(tm, cmd, arg);
691 termteken_respond(void *softc, const void *buf, size_t len)
694 struct terminal *tm = softc;
698 * Only inject a response into the TTY if the data actually
699 * originated from the TTY.
701 * XXX: This cannot be done right now. The TTY could pick up
702 * other locks. It could also in theory cause loops, when the
703 * TTY performs echoing of a command that generates even more
710 ttydisc_rint_simple(tp, buf, len);
711 ttydisc_rint_done(tp);