1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2009 The FreeBSD Foundation 5 * 6 * This software was developed by Ed Schouten under sponsorship from the 7 * FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 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. 17 * 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 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _SYS_TERMINAL_H_ 34 #define _SYS_TERMINAL_H_ 35 36 #include <sys/param.h> 37 #include <sys/_lock.h> 38 #include <sys/_mutex.h> 39 #include <sys/cons.h> 40 #include <sys/linker_set.h> 41 #include <sys/ttycom.h> 42 43 #include <teken/teken.h> 44 45 #include "opt_syscons.h" 46 #include "opt_teken.h" 47 48 struct terminal; 49 struct thread; 50 struct tty; 51 52 /* 53 * The terminal layer is an abstraction on top of the TTY layer and the 54 * console interface. It can be used by system console drivers to 55 * easily interact with the kernel console and TTYs. 56 * 57 * Terminals contain terminal emulators, which means console drivers 58 * don't need to implement their own terminal emulator. The terminal 59 * emulator deals with UTF-8 exclusively. This means that term_char_t, 60 * the data type used to store input/output characters will always 61 * contain Unicode codepoints. 62 * 63 * To save memory usage, the top bits of term_char_t will contain other 64 * attributes, like colors. Right now term_char_t is composed as 65 * follows: 66 * 67 * Bits Meaning 68 * 0-20: Character value 69 * 21-25: Bold, underline, blink, reverse, right part of CJK fullwidth character 70 * 26-28: Foreground color 71 * 29-31: Background color 72 */ 73 74 typedef uint32_t term_char_t; 75 #define TCHAR_CHARACTER(c) ((c) & 0x1fffff) 76 #define TCHAR_FORMAT(c) (((c) >> 21) & 0x1f) 77 #define TCHAR_FGCOLOR(c) (((c) >> 26) & 0x7) 78 #define TCHAR_BGCOLOR(c) (((c) >> 29) & 0x7) 79 80 typedef teken_attr_t term_attr_t; 81 82 typedef teken_color_t term_color_t; 83 #define TCOLOR_FG(c) (((c) & 0x7) << 26) 84 #define TCOLOR_BG(c) (((c) & 0x7) << 29) 85 #define TCOLOR_LIGHT(c) ((c) | 0x8) 86 #define TCOLOR_DARK(c) ((c) & ~0x8) 87 88 #define TFORMAT(c) (((c) & 0x1f) << 21) 89 90 /* syscons(4) compatible color attributes for foreground text */ 91 #define FG_BLACK TCOLOR_FG(TC_BLACK) 92 #define FG_BLUE TCOLOR_FG(TC_BLUE) 93 #define FG_GREEN TCOLOR_FG(TC_GREEN) 94 #define FG_CYAN TCOLOR_FG(TC_CYAN) 95 #define FG_RED TCOLOR_FG(TC_RED) 96 #define FG_MAGENTA TCOLOR_FG(TC_MAGENTA) 97 #define FG_BROWN TCOLOR_FG(TC_BROWN) 98 #define FG_LIGHTGREY TCOLOR_FG(TC_WHITE) 99 #define FG_DARKGREY (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BLACK)) 100 #define FG_LIGHTBLUE (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BLUE)) 101 #define FG_LIGHTGREEN (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_GREEN)) 102 #define FG_LIGHTCYAN (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_CYAN)) 103 #define FG_LIGHTRED (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_RED)) 104 #define FG_LIGHTMAGENTA (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_MAGENTA)) 105 #define FG_YELLOW (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BROWN)) 106 #define FG_WHITE (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_WHITE)) 107 #define FG_BLINK TFORMAT(TF_BLINK) 108 109 /* syscons(4) compatible color attributes for text background */ 110 #define BG_BLACK TCOLOR_BG(TC_BLACK) 111 #define BG_BLUE TCOLOR_BG(TC_BLUE) 112 #define BG_GREEN TCOLOR_BG(TC_GREEN) 113 #define BG_CYAN TCOLOR_BG(TC_CYAN) 114 #define BG_RED TCOLOR_BG(TC_RED) 115 #define BG_MAGENTA TCOLOR_BG(TC_MAGENTA) 116 #define BG_BROWN TCOLOR_BG(TC_BROWN) 117 #define BG_LIGHTGREY TCOLOR_BG(TC_WHITE) 118 #define BG_DARKGREY (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BLACK)) 119 #define BG_LIGHTBLUE (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BLUE)) 120 #define BG_LIGHTGREEN (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_GREEN)) 121 #define BG_LIGHTCYAN (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_CYAN)) 122 #define BG_LIGHTRED (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_RED)) 123 #define BG_LIGHTMAGENTA (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_MAGENTA)) 124 #define BG_YELLOW (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BROWN)) 125 #define BG_WHITE (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_WHITE)) 126 127 #ifndef TERMINAL_NORM_ATTR 128 #ifdef SC_NORM_ATTR 129 #define TERMINAL_NORM_ATTR SC_NORM_ATTR 130 #else 131 #define TERMINAL_NORM_ATTR (FG_LIGHTGREY | BG_BLACK) 132 #endif 133 #endif 134 135 #ifndef TERMINAL_KERN_ATTR 136 #ifdef SC_KERNEL_CONS_ATTR 137 #define TERMINAL_KERN_ATTR SC_KERNEL_CONS_ATTR 138 #else 139 #define TERMINAL_KERN_ATTR (FG_WHITE | BG_BLACK) 140 #endif 141 #endif 142 143 typedef teken_pos_t term_pos_t; 144 typedef teken_rect_t term_rect_t; 145 146 typedef void tc_cursor_t(struct terminal *tm, const term_pos_t *p); 147 typedef void tc_putchar_t(struct terminal *tm, const term_pos_t *p, 148 term_char_t c); 149 typedef void tc_fill_t(struct terminal *tm, const term_rect_t *r, 150 term_char_t c); 151 typedef void tc_copy_t(struct terminal *tm, const term_rect_t *r, 152 const term_pos_t *p); 153 typedef void tc_pre_input_t(struct terminal *tm); 154 typedef void tc_post_input_t(struct terminal *tm); 155 typedef void tc_param_t(struct terminal *tm, int cmd, unsigned int arg); 156 typedef void tc_done_t(struct terminal *tm); 157 158 typedef void tc_cnprobe_t(struct terminal *tm, struct consdev *cd); 159 typedef int tc_cngetc_t(struct terminal *tm); 160 161 typedef void tc_cngrab_t(struct terminal *tm); 162 typedef void tc_cnungrab_t(struct terminal *tm); 163 164 typedef void tc_opened_t(struct terminal *tm, int opened); 165 typedef int tc_ioctl_t(struct terminal *tm, u_long cmd, caddr_t data, 166 struct thread *td); 167 typedef int tc_mmap_t(struct terminal *tm, vm_ooffset_t offset, 168 vm_paddr_t * paddr, int nprot, vm_memattr_t *memattr); 169 typedef void tc_bell_t(struct terminal *tm); 170 171 struct terminal_class { 172 /* Terminal emulator. */ 173 tc_cursor_t *tc_cursor; 174 tc_putchar_t *tc_putchar; 175 tc_fill_t *tc_fill; 176 tc_copy_t *tc_copy; 177 tc_pre_input_t *tc_pre_input; 178 tc_post_input_t *tc_post_input; 179 tc_param_t *tc_param; 180 tc_done_t *tc_done; 181 182 /* Low-level console interface. */ 183 tc_cnprobe_t *tc_cnprobe; 184 tc_cngetc_t *tc_cngetc; 185 186 /* DDB & panic handling. */ 187 tc_cngrab_t *tc_cngrab; 188 tc_cnungrab_t *tc_cnungrab; 189 190 /* Misc. */ 191 tc_opened_t *tc_opened; 192 tc_ioctl_t *tc_ioctl; 193 tc_mmap_t *tc_mmap; 194 tc_bell_t *tc_bell; 195 }; 196 197 struct terminal { 198 const struct terminal_class *tm_class; 199 void *tm_softc; 200 struct mtx tm_mtx; 201 struct tty *tm_tty; 202 teken_t tm_emulator; 203 struct winsize tm_winsize; 204 unsigned int tm_flags; 205 #define TF_MUTE 0x1 /* Drop incoming data. */ 206 #define TF_BELL 0x2 /* Bell needs to be sent. */ 207 #define TF_CONS 0x4 /* Console device (needs spinlock). */ 208 struct consdev *consdev; 209 }; 210 211 #ifdef _KERNEL 212 213 struct terminal *terminal_alloc(const struct terminal_class *tc, void *softc); 214 void terminal_maketty(struct terminal *tm, const char *fmt, ...); 215 void terminal_set_cursor(struct terminal *tm, const term_pos_t *pos); 216 void terminal_set_winsize_blank(struct terminal *tm, 217 const struct winsize *size, int blank, const term_attr_t *attr); 218 void terminal_set_winsize(struct terminal *tm, const struct winsize *size); 219 void terminal_mute(struct terminal *tm, int yes); 220 void terminal_input_char(struct terminal *tm, term_char_t c); 221 void terminal_input_raw(struct terminal *tm, char c); 222 void terminal_input_special(struct terminal *tm, unsigned int k); 223 224 void termcn_cnregister(struct terminal *tm); 225 226 /* Kernel console helper interface. */ 227 extern const struct consdev_ops termcn_cnops; 228 229 #define TERMINAL_DECLARE_EARLY(name, class, softc) \ 230 static struct terminal name = { \ 231 .tm_class = &class, \ 232 .tm_softc = softc, \ 233 .tm_flags = TF_CONS, \ 234 }; \ 235 CONSOLE_DEVICE(name ## _consdev, termcn_cnops, &name) 236 237 #endif /* _KERNEL */ 238 239 #endif /* !_SYS_TERMINAL_H_ */ 240