1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 /* Copyright (c) 1990, 1991 UNIX System Laboratories, Inc. */ 27 28 /* Copyright (c) 1984, 1986, 1987, 1988, 1989, 1990 AT&T */ 29 /* All Rights Reserved */ 30 31 #ifndef _SYS_TEM_H 32 #define _SYS_TEM_H 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 #include <sys/types.h> 39 #include <sys/visual_io.h> 40 #include <sys/font.h> 41 #include <sys/list.h> 42 #include <sys/tem.h> 43 #include <sys/rgb.h> 44 #include <bootstrap.h> 45 #include <stdbool.h> 46 47 /* 48 * Definitions for ANSI x3.64 terminal control language parser. 49 * With UTF-8 support we use 32-bit value for Unicode codepoints. 50 * 51 * However, as we only need 21 bits for unicode char, we will use the 52 * rest of the bits for attributes, so we can save memory and 53 * have combined attribute+char in screen buffer. This will also allow us 54 * to keep better track about attributes and apply other optimizations. 55 * 56 * Bits Meaning 57 * 0-20 char 58 * 21-31 attributes 59 */ 60 61 typedef uint32_t tem_char_t; /* 32bit char to support UTF-8 */ 62 #define TEM_ATTR_MASK 0x7FF 63 #define TEM_CHAR(c) ((c) & 0x1fffff) 64 #define TEM_CHAR_ATTR(c) (((c) >> 21) & TEM_ATTR_MASK) 65 #define TEM_ATTR(c) (((c) & TEM_ATTR_MASK) << 21) 66 67 #define TEM_MAXPARAMS 5 /* maximum number of ANSI paramters */ 68 #define TEM_MAXTAB 40 /* maximum number of tab stops */ 69 #define TEM_MAXFKEY 30 /* max length of function key with <ESC>Q */ 70 #define MAX_TEM 2 /* max number of loadable terminal emulators */ 71 72 #define TEM_SCROLL_UP 0 73 #define TEM_SCROLL_DOWN 1 74 #define TEM_SHIFT_LEFT 0 75 #define TEM_SHIFT_RIGHT 1 76 77 /* Attributes 0-0x7ff */ 78 #define TEM_ATTR_NORMAL 0x0000 79 #define TEM_ATTR_REVERSE 0x0001 80 #define TEM_ATTR_BOLD 0x0002 81 #define TEM_ATTR_BLINK 0x0004 82 #define TEM_ATTR_UNDERLINE 0x0008 83 #define TEM_ATTR_SCREEN_REVERSE 0x0010 84 #define TEM_ATTR_BRIGHT_FG 0x0020 85 #define TEM_ATTR_BRIGHT_BG 0x0040 86 #define TEM_ATTR_TRANSPARENT 0x0080 87 #define TEM_ATTR_IMAGE 0x0100 88 89 #define ANSI_COLOR_BLACK 0 90 #define ANSI_COLOR_RED 1 91 #define ANSI_COLOR_GREEN 2 92 #define ANSI_COLOR_YELLOW 3 93 #define ANSI_COLOR_BLUE 4 94 #define ANSI_COLOR_MAGENTA 5 95 #define ANSI_COLOR_CYAN 6 96 #define ANSI_COLOR_WHITE 7 97 98 #define TEM_TEXT_WHITE 0 99 #define TEM_TEXT_BLACK 1 100 #define TEM_TEXT_BLACK24_RED 0x00 101 #define TEM_TEXT_BLACK24_GREEN 0x00 102 #define TEM_TEXT_BLACK24_BLUE 0x00 103 #define TEM_TEXT_WHITE24_RED 0xff 104 #define TEM_TEXT_WHITE24_GREEN 0xff 105 #define TEM_TEXT_WHITE24_BLUE 0xff 106 107 #define A_STATE_START 0 108 #define A_STATE_ESC 1 109 #define A_STATE_CSI 2 110 #define A_STATE_CSI_QMARK 3 111 #define A_STATE_CSI_EQUAL 4 112 113 /* 114 * Default number of rows and columns 115 */ 116 #define TEM_DEFAULT_ROWS 25 117 #define TEM_DEFAULT_COLS 80 118 119 /* 120 * Default foreground/background color 121 */ 122 123 #define DEFAULT_ANSI_FOREGROUND ANSI_COLOR_BLACK 124 #define DEFAULT_ANSI_BACKGROUND ANSI_COLOR_WHITE 125 126 127 #define BUF_LEN 160 /* Two lines of data can be processed at a time */ 128 129 typedef uint8_t text_color_t; 130 typedef uint16_t text_attr_t; 131 132 typedef struct tem_color { 133 text_color_t fg_color; 134 text_color_t bg_color; 135 text_attr_t a_flags; 136 } tem_color_t; 137 138 struct tem_pix_pos { 139 screen_pos_t x; 140 screen_pos_t y; 141 }; 142 143 struct tem_char_pos { 144 screen_pos_t col; 145 screen_pos_t row; 146 }; 147 148 struct tem_size { 149 screen_size_t width; 150 screen_size_t height; 151 }; 152 153 /* Combined color and 32bit tem char */ 154 typedef struct term_char { 155 text_color_t tc_fg_color; 156 text_color_t tc_bg_color; 157 tem_char_t tc_char; 158 } term_char_t; 159 160 /* 161 * State structure for each virtual terminal emulator 162 */ 163 struct tem_vt_state { 164 uint8_t tvs_fbmode; /* framebuffer mode */ 165 text_attr_t tvs_flags; /* flags for this x3.64 terminal */ 166 int tvs_state; /* state in output esc seq processing */ 167 bool tvs_gotparam; /* does output esc seq have a param */ 168 169 int tvs_curparam; /* current param # of output esc seq */ 170 int tvs_paramval; /* value of current param */ 171 int tvs_params[TEM_MAXPARAMS]; /* parameters of output esc seq */ 172 screen_pos_t tvs_tabs[TEM_MAXTAB]; /* tab stops */ 173 int tvs_ntabs; /* number of tabs used */ 174 int tvs_nscroll; /* number of lines to scroll */ 175 176 struct tem_char_pos tvs_s_cursor; /* start cursor position */ 177 struct tem_char_pos tvs_c_cursor; /* current cursor position */ 178 struct tem_char_pos tvs_r_cursor; /* remembered cursor position */ 179 180 term_char_t *tvs_outbuf; /* place to keep incomplete lines */ 181 int tvs_outindex; /* index into a_outbuf */ 182 void *tvs_pix_data; /* pointer to tmp bitmap area */ 183 int tvs_pix_data_size; 184 text_color_t tvs_fg_color; 185 text_color_t tvs_bg_color; 186 int tvs_first_line; /* kernel console output begins */ 187 188 term_char_t *tvs_screen_buf; /* whole screen buffer */ 189 unsigned tvs_utf8_left; /* UTF-8 code points */ 190 tem_char_t tvs_utf8_partial; /* UTF-8 char being completed */ 191 192 bool tvs_isactive; 193 bool tvs_initialized; /* initialization flag */ 194 195 list_node_t tvs_list_node; 196 }; 197 198 typedef struct tem_callbacks { 199 void (*tsc_display)(struct tem_vt_state *, term_char_t *, int, 200 screen_pos_t, screen_pos_t); 201 void (*tsc_copy)(struct tem_vt_state *, 202 screen_pos_t, screen_pos_t, screen_pos_t, screen_pos_t, 203 screen_pos_t, screen_pos_t); 204 void (*tsc_cursor)(struct tem_vt_state *, short); 205 void (*tsc_bit2pix)(struct tem_vt_state *, term_char_t); 206 void (*tsc_cls)(struct tem_vt_state *, int, screen_pos_t, screen_pos_t); 207 } tem_callbacks_t; 208 209 typedef struct __tem_modechg_cb_arg *tem_modechg_cb_arg_t; 210 typedef void (*tem_modechg_cb_t) (tem_modechg_cb_arg_t arg); 211 typedef struct __tem_vt_state *tem_vt_state_t; 212 213 /* 214 * common term soft state structure shared by all virtual terminal emulators 215 */ 216 typedef struct tem_state { 217 struct console *ts_hdl; /* Framework handle for dev */ 218 screen_size_t ts_linebytes; /* Layered on bytes per scan line */ 219 220 int ts_display_mode; /* What mode we are in */ 221 222 struct tem_size ts_c_dimension; /* window dimensions in characters */ 223 struct tem_size ts_p_dimension; /* screen dimensions in pixels */ 224 struct tem_pix_pos ts_p_offset; /* pix offset to center the display */ 225 226 int ts_pix_data_size; /* size of bitmap data areas */ 227 int ts_pdepth; /* pixel depth */ 228 struct font ts_font; /* font table */ 229 bool update_font; /* flag the font change */ 230 231 tem_callbacks_t *ts_callbacks; /* internal output functions */ 232 233 int ts_initialized; /* initialization flag */ 234 235 tem_modechg_cb_t ts_modechg_cb; 236 tem_modechg_cb_arg_t ts_modechg_arg; 237 238 color_map_fn_t ts_color_map; 239 240 tem_color_t ts_init_color; /* initial color and attributes */ 241 242 struct tem_vt_state *ts_active; 243 list_t ts_list; /* chain of all tems */ 244 } tem_state_t; 245 246 extern tem_state_t tems; 247 /* 248 * tems_* fuctions mean that they just operate on the common soft state 249 * (tem_state_t), and tem_* functions mean that they operate on the 250 * per-tem structure (tem_vt_state). All "safe" interfaces are in tem_safe.c. 251 */ 252 int tems_cls(struct vis_consclear *); 253 void tems_display(struct vis_consdisplay *); 254 void tems_copy(struct vis_conscopy *); 255 void tems_cursor(struct vis_conscursor *); 256 257 int tem_initialized(tem_vt_state_t); 258 259 tem_vt_state_t tem_init(void); 260 261 int tem_info_init(struct console *); 262 void tem_write(tem_vt_state_t, uint8_t *, ssize_t); 263 void tem_get_size(uint16_t *, uint16_t *, uint16_t *, uint16_t *); 264 void tem_save_state(void); 265 void tem_register_modechg_cb(tem_modechg_cb_t, tem_modechg_cb_arg_t); 266 void tem_activate(tem_vt_state_t, boolean_t); 267 void tem_get_colors(tem_vt_state_t, text_color_t *, text_color_t *); 268 void tem_image_display(struct tem_vt_state *, screen_pos_t, screen_pos_t, 269 screen_pos_t, screen_pos_t); 270 271 #ifdef __cplusplus 272 } 273 #endif 274 275 #endif /* _SYS_TEM_H */ 276