2 * Copyright (c) 2009 The FreeBSD Foundation
5 * This software was developed by Ed Schouten under sponsorship from the
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
35 #include <sys/consio.h>
36 #include <sys/kernel.h>
38 #include <sys/malloc.h>
39 #include <sys/mutex.h>
40 #include <sys/systm.h>
41 #include <sys/terminal.h>
44 #include <machine/stdarg.h>
46 static MALLOC_DEFINE(M_TERMINAL, "terminal", "terminal device");
51 * Normally we don't need to lock down the terminal emulator, because
52 * the TTY lock is already held when calling teken_input().
53 * Unfortunately this is not the case when the terminal acts as a
54 * console device, because cnputc() can be called at the same time.
55 * This means terminals may need to be locked down using a spin lock.
57 #define TERMINAL_LOCK(tm) do { \
58 if ((tm)->tm_flags & TF_CONS) \
59 mtx_lock_spin(&(tm)->tm_mtx); \
60 else if ((tm)->tm_tty != NULL) \
61 tty_lock((tm)->tm_tty); \
63 #define TERMINAL_UNLOCK(tm) do { \
64 if ((tm)->tm_flags & TF_CONS) \
65 mtx_unlock_spin(&(tm)->tm_mtx); \
66 else if ((tm)->tm_tty != NULL) \
67 tty_unlock((tm)->tm_tty); \
69 #define TERMINAL_LOCK_TTY(tm) do { \
70 if ((tm)->tm_flags & TF_CONS) \
71 mtx_lock_spin(&(tm)->tm_mtx); \
73 #define TERMINAL_UNLOCK_TTY(tm) do { \
74 if ((tm)->tm_flags & TF_CONS) \
75 mtx_unlock_spin(&(tm)->tm_mtx); \
77 #define TERMINAL_LOCK_CONS(tm) mtx_lock_spin(&(tm)->tm_mtx)
78 #define TERMINAL_UNLOCK_CONS(tm) mtx_unlock_spin(&(tm)->tm_mtx)
84 static tsw_open_t termtty_open;
85 static tsw_close_t termtty_close;
86 static tsw_outwakeup_t termtty_outwakeup;
87 static tsw_ioctl_t termtty_ioctl;
88 static tsw_mmap_t termtty_mmap;
90 static struct ttydevsw terminal_tty_class = {
91 .tsw_open = termtty_open,
92 .tsw_close = termtty_close,
93 .tsw_outwakeup = termtty_outwakeup,
94 .tsw_ioctl = termtty_ioctl,
95 .tsw_mmap = termtty_mmap,
99 * Terminal emulator routines.
102 static tf_bell_t termteken_bell;
103 static tf_cursor_t termteken_cursor;
104 static tf_putchar_t termteken_putchar;
105 static tf_fill_t termteken_fill;
106 static tf_copy_t termteken_copy;
107 static tf_param_t termteken_param;
108 static tf_respond_t termteken_respond;
110 static teken_funcs_t terminal_drawmethods = {
111 .tf_bell = termteken_bell,
112 .tf_cursor = termteken_cursor,
113 .tf_putchar = termteken_putchar,
114 .tf_fill = termteken_fill,
115 .tf_copy = termteken_copy,
116 .tf_param = termteken_param,
117 .tf_respond = termteken_respond,
120 /* Kernel message formatting. */
121 static const teken_attr_t kernel_message = {
122 .ta_fgcolor = TCHAR_FGCOLOR(TERMINAL_KERN_ATTR),
123 .ta_bgcolor = TCHAR_BGCOLOR(TERMINAL_KERN_ATTR),
124 .ta_format = TCHAR_FORMAT(TERMINAL_KERN_ATTR)
127 static const teken_attr_t default_message = {
128 .ta_fgcolor = TCHAR_FGCOLOR(TERMINAL_NORM_ATTR),
129 .ta_bgcolor = TCHAR_BGCOLOR(TERMINAL_NORM_ATTR),
130 .ta_format = TCHAR_FORMAT(TERMINAL_NORM_ATTR)
133 /* Fudge fg brightness as TF_BOLD (shifted). */
134 #define TCOLOR_FG_FUDGED(color) __extension__ ({ \
138 TCOLOR_FG(_c & 7) | ((_c & 8) << 18); \
141 /* Fudge bg brightness as TF_BLINK (shifted). */
142 #define TCOLOR_BG_FUDGED(color) __extension__ ({ \
146 TCOLOR_BG(_c & 7) | ((_c & 8) << 20); \
149 #define TCOLOR_256TO16(color) __extension__ ({ \
154 _c = teken_256to16(_c); \
158 #define TCHAR_CREATE(c, a) ((c) | TFORMAT((a)->ta_format) | \
159 TCOLOR_FG_FUDGED(TCOLOR_256TO16((a)->ta_fgcolor)) | \
160 TCOLOR_BG_FUDGED(TCOLOR_256TO16((a)->ta_bgcolor)))
163 terminal_init(struct terminal *tm)
166 if (tm->tm_flags & TF_CONS)
167 mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
168 teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
169 teken_set_defattr(&tm->tm_emulator, &default_message);
173 terminal_alloc(const struct terminal_class *tc, void *softc)
177 tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
181 tm->tm_softc = softc;
187 terminal_sync_ttysize(struct terminal *tm)
196 tty_set_winsize(tp, &tm->tm_winsize);
201 terminal_maketty(struct terminal *tm, const char *fmt, ...)
208 vsnrprintf(name, sizeof name, 32, fmt, ap);
211 tp = tty_alloc(&terminal_tty_class, tm);
212 tty_makedev(tp, NULL, "%s", name);
214 terminal_sync_ttysize(tm);
218 terminal_set_cursor(struct terminal *tm, const term_pos_t *pos)
221 teken_set_cursor(&tm->tm_emulator, pos);
225 terminal_set_winsize_blank(struct terminal *tm, const struct winsize *size,
226 int blank, const term_attr_t *attr)
230 tm->tm_winsize = *size;
232 r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
233 r.tr_end.tp_row = size->ws_row;
234 r.tr_end.tp_col = size->ws_col;
238 teken_set_winsize_noreset(&tm->tm_emulator, &r.tr_end);
240 teken_set_winsize(&tm->tm_emulator, &r.tr_end);
243 if ((blank != 0) && !(tm->tm_flags & TF_MUTE))
244 tm->tm_class->tc_fill(tm, &r,
245 TCHAR_CREATE((teken_char_t)' ', attr));
247 terminal_sync_ttysize(tm);
251 terminal_set_winsize(struct terminal *tm, const struct winsize *size)
254 terminal_set_winsize_blank(tm, size, 1,
255 (const term_attr_t *)&default_message);
259 * XXX: This function is a kludge. Drivers like vt(4) need to
260 * temporarily stop input when resizing, etc. This should ideally be
261 * handled within the driver.
265 terminal_mute(struct terminal *tm, int yes)
270 tm->tm_flags |= TF_MUTE;
272 tm->tm_flags &= ~TF_MUTE;
277 terminal_input_char(struct terminal *tm, term_char_t c)
286 * Strip off any attributes. Also ignore input of second part of
287 * CJK fullwidth characters, as we don't want to return these
290 if (TCHAR_FORMAT(c) & TF_CJK_RIGHT)
292 c = TCHAR_CHARACTER(c);
296 * Conversion to UTF-8.
299 ttydisc_rint(tp, c, 0);
300 } else if (c < 0x800) {
306 ttydisc_rint_simple(tp, str, sizeof str);
307 } else if (c < 0x10000) {
310 0x80 | ((c >> 6) & 0x3f),
314 ttydisc_rint_simple(tp, str, sizeof str);
318 0x80 | ((c >> 12) & 0x3f),
319 0x80 | ((c >> 6) & 0x3f),
323 ttydisc_rint_simple(tp, str, sizeof str);
325 ttydisc_rint_done(tp);
330 terminal_input_raw(struct terminal *tm, char c)
339 ttydisc_rint(tp, c, 0);
340 ttydisc_rint_done(tp);
345 terminal_input_special(struct terminal *tm, unsigned int k)
354 str = teken_get_sequence(&tm->tm_emulator, k);
359 ttydisc_rint_simple(tp, str, strlen(str));
360 ttydisc_rint_done(tp);
365 * Binding with the TTY layer.
369 termtty_open(struct tty *tp)
371 struct terminal *tm = tty_softc(tp);
373 tm->tm_class->tc_opened(tm, 1);
378 termtty_close(struct tty *tp)
380 struct terminal *tm = tty_softc(tp);
382 tm->tm_class->tc_opened(tm, 0);
386 termtty_outwakeup(struct tty *tp)
388 struct terminal *tm = tty_softc(tp);
391 unsigned int flags = 0;
393 while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
394 TERMINAL_LOCK_TTY(tm);
395 if (!(tm->tm_flags & TF_MUTE)) {
396 tm->tm_flags &= ~TF_BELL;
397 teken_input(&tm->tm_emulator, obuf, olen);
398 flags |= tm->tm_flags;
400 TERMINAL_UNLOCK_TTY(tm);
403 TERMINAL_LOCK_TTY(tm);
404 if (!(tm->tm_flags & TF_MUTE))
405 tm->tm_class->tc_done(tm);
406 TERMINAL_UNLOCK_TTY(tm);
408 tm->tm_class->tc_bell(tm);
412 termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
414 struct terminal *tm = tty_softc(tp);
419 vid_info_t *vi = (vid_info_t *)data;
420 const teken_pos_t *p;
423 if (vi->size != sizeof(vid_info_t))
426 /* Already help the console driver by filling in some data. */
427 p = teken_get_cursor(&tm->tm_emulator);
428 vi->mv_row = p->tp_row;
429 vi->mv_col = p->tp_col;
431 p = teken_get_winsize(&tm->tm_emulator);
432 vi->mv_rsz = p->tp_row;
433 vi->mv_csz = p->tp_col;
435 teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
436 vi->mv_norm.fore = fg;
437 vi->mv_norm.back = bg;
438 /* XXX: keep vidcontrol happy; bold backgrounds. */
439 vi->mv_rev.fore = bg;
440 vi->mv_rev.back = fg & 0x7;
446 * Unlike various other drivers, this driver will never
447 * deallocate TTYs. This means it's safe to temporarily unlock
448 * the TTY when handling ioctls.
451 error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
457 termtty_mmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t * paddr,
458 int nprot, vm_memattr_t *memattr)
460 struct terminal *tm = tty_softc(tp);
462 return (tm->tm_class->tc_mmap(tm, offset, paddr, nprot, memattr));
466 * Binding with the kernel and debug console.
469 static cn_probe_t termcn_cnprobe;
470 static cn_init_t termcn_cninit;
471 static cn_term_t termcn_cnterm;
472 static cn_getc_t termcn_cngetc;
473 static cn_putc_t termcn_cnputc;
474 static cn_grab_t termcn_cngrab;
475 static cn_ungrab_t termcn_cnungrab;
477 const struct consdev_ops termcn_cnops = {
478 .cn_probe = termcn_cnprobe,
479 .cn_init = termcn_cninit,
480 .cn_term = termcn_cnterm,
481 .cn_getc = termcn_cngetc,
482 .cn_putc = termcn_cnputc,
483 .cn_grab = termcn_cngrab,
484 .cn_ungrab = termcn_cnungrab,
488 termcn_cnregister(struct terminal *tm)
494 cp = malloc(sizeof(struct consdev), M_TERMINAL,
496 cp->cn_ops = &termcn_cnops;
498 cp->cn_pri = CN_INTERNAL;
499 sprintf(cp->cn_name, "ttyv0");
501 tm->tm_flags = TF_CONS;
507 /* Attach terminal as console. */
512 termcn_cngrab(struct consdev *cp)
514 struct terminal *tm = cp->cn_arg;
516 tm->tm_class->tc_cngrab(tm);
520 termcn_cnungrab(struct consdev *cp)
522 struct terminal *tm = cp->cn_arg;
524 tm->tm_class->tc_cnungrab(tm);
528 termcn_cnprobe(struct consdev *cp)
530 struct terminal *tm = cp->cn_arg;
533 cp->cn_pri = CN_DEAD;
540 tm->tm_class->tc_cnprobe(tm, cp);
544 termcn_cninit(struct consdev *cp)
550 termcn_cnterm(struct consdev *cp)
556 termcn_cngetc(struct consdev *cp)
558 struct terminal *tm = cp->cn_arg;
560 return (tm->tm_class->tc_cngetc(tm));
564 termcn_cnputc(struct consdev *cp, int c)
566 struct terminal *tm = cp->cn_arg;
570 TERMINAL_LOCK_CONS(tm);
571 if (!(tm->tm_flags & TF_MUTE)) {
572 backup = *teken_get_curattr(&tm->tm_emulator);
573 teken_set_curattr(&tm->tm_emulator, &kernel_message);
574 teken_input(&tm->tm_emulator, &cv, 1);
575 teken_set_curattr(&tm->tm_emulator, &backup);
576 tm->tm_class->tc_done(tm);
578 TERMINAL_UNLOCK_CONS(tm);
582 * Binding with the terminal emulator.
586 termteken_bell(void *softc)
588 struct terminal *tm = softc;
590 tm->tm_flags |= TF_BELL;
594 termteken_cursor(void *softc, const teken_pos_t *p)
596 struct terminal *tm = softc;
598 tm->tm_class->tc_cursor(tm, p);
602 termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
603 const teken_attr_t *a)
605 struct terminal *tm = softc;
607 tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
611 termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
612 const teken_attr_t *a)
614 struct terminal *tm = softc;
616 tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
620 termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
622 struct terminal *tm = softc;
624 tm->tm_class->tc_copy(tm, r, p);
628 termteken_param(void *softc, int cmd, unsigned int arg)
630 struct terminal *tm = softc;
632 tm->tm_class->tc_param(tm, cmd, arg);
636 termteken_respond(void *softc, const void *buf, size_t len)
639 struct terminal *tm = softc;
643 * Only inject a response into the TTY if the data actually
644 * originated from the TTY.
646 * XXX: This cannot be done right now. The TTY could pick up
647 * other locks. It could also in theory cause loops, when the
648 * TTY performs echoing of a command that generates even more
655 ttydisc_rint_simple(tp, buf, len);
656 ttydisc_rint_done(tp);