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 27 /* Copyright (c) 1990, 1991 UNIX System Laboratories, Inc. */ 28 29 /* Copyright (c) 1984, 1986, 1987, 1988, 1989, 1990 AT&T */ 30 /* All Rights Reserved */ 31 32 #ifndef _SYS_TEM_IMPL_H 33 #define _SYS_TEM_IMPL_H 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #include <sys/types.h> 40 #include <sys/font.h> 41 #include <sys/rgb.h> 42 #if !defined(_BOOT) 43 #include <sys/sunddi.h> 44 #include <sys/sunldi.h> 45 #include <sys/visual_io.h> 46 #include <sys/list.h> 47 #include <sys/tem.h> 48 #include <sys/note.h> 49 #endif 50 51 /* 52 * Definitions for ANSI x3.64 terminal control language parser. 53 * With UTF-8 support we use 32-bit value for Unicode codepoints. 54 * 55 * However, as we only need 21 bits for unicode char, we will use the 56 * rest of the bits for attributes, so we can save memory and 57 * have combined attribute+char in screen buffer. This will also allow us 58 * to keep better track about attributes and apply other optimizations. 59 * 60 * This setup will give us 11 bits for attributes (mask 0x7FF). 61 * Bits Meaning 62 * 0-20 char 63 * 21-31 attributes 64 * 65 * The current implementation is building the screen buffer in three parts, 66 * tvs_screen_buf is implementing the character array and the foreground 67 * and the background colors have tvs_fg_color and tvs_bg_color arrays. 68 * The character and color arrays are currently only used to restore the 69 * screen from tem switch (vt switch, or switch from Xorg session). 70 * To implement the console history, this buffering needs to be reviewed. 71 */ 72 73 #define TEM_ATTR_MASK 0x7FF 74 #define TEM_CHAR(c) ((c) & 0x1fffff) 75 #define TEM_CHAR_ATTR(c) (((c) >> 21) & TEM_ATTR_MASK) 76 #define TEM_ATTR(c) (((c) & TEM_ATTR_MASK) << 21) 77 #define TEM_ATTR_ISSET(c, a) ((TEM_CHAR_ATTR(c) & (a)) == (a)) 78 79 #define TEM_MAXPARAMS 5 /* maximum number of ANSI paramters */ 80 #define TEM_MAXTAB 40 /* maximum number of tab stops */ 81 #define TEM_MAXFKEY 30 /* max length of function key with <ESC>Q */ 82 83 #define TEM_SCROLL_UP 0 84 #define TEM_SCROLL_DOWN 1 85 #define TEM_SHIFT_LEFT 0 86 #define TEM_SHIFT_RIGHT 1 87 88 /* Attributes 0-0x7ff */ 89 #define TEM_ATTR_NORMAL 0x0000 90 #define TEM_ATTR_REVERSE 0x0001 91 #define TEM_ATTR_BOLD 0x0002 92 #define TEM_ATTR_BLINK 0x0004 93 #define TEM_ATTR_UNDERLINE 0x0008 94 #define TEM_ATTR_SCREEN_REVERSE 0x0010 95 #define TEM_ATTR_BRIGHT_FG 0x0020 96 #define TEM_ATTR_BRIGHT_BG 0x0040 97 #define TEM_ATTR_TRANSPARENT 0x0080 98 #define TEM_ATTR_IMAGE 0x0100 99 100 #define ANSI_COLOR_BLACK 0 101 #define ANSI_COLOR_RED 1 102 #define ANSI_COLOR_GREEN 2 103 #define ANSI_COLOR_BROWN 3 104 #define ANSI_COLOR_BLUE 4 105 #define ANSI_COLOR_MAGENTA 5 106 #define ANSI_COLOR_CYAN 6 107 #define ANSI_COLOR_WHITE 7 108 109 #define TEM_TEXT_WHITE 0 110 #define TEM_TEXT_BLACK 1 111 #define TEM_TEXT_BLACK24_RED 0x00 112 #define TEM_TEXT_BLACK24_GREEN 0x00 113 #define TEM_TEXT_BLACK24_BLUE 0x00 114 #define TEM_TEXT_WHITE24_RED 0xff 115 #define TEM_TEXT_WHITE24_GREEN 0xff 116 #define TEM_TEXT_WHITE24_BLUE 0xff 117 118 #define A_STATE_START 0 119 #define A_STATE_ESC 1 120 #define A_STATE_CSI 2 121 #define A_STATE_CSI_QMARK 3 122 #define A_STATE_CSI_EQUAL 4 123 124 /* 125 * Default number of rows and columns 126 */ 127 #ifdef _HAVE_TEM_FIRMWARE 128 #define TEM_DEFAULT_ROWS 34 129 #define TEM_DEFAULT_COLS 80 130 #else 131 #define TEM_DEFAULT_ROWS 25 132 #define TEM_DEFAULT_COLS 80 133 #endif 134 135 /* 136 * Default foreground/background color 137 */ 138 139 #define DEFAULT_ANSI_FOREGROUND ANSI_COLOR_BLACK 140 #define DEFAULT_ANSI_BACKGROUND ANSI_COLOR_WHITE 141 142 typedef uint32_t tem_char_t; /* 32bit char to support UTF-8 */ 143 typedef uint8_t text_color_t; 144 typedef uint16_t text_attr_t; 145 146 #if !defined(_BOOT) 147 typedef struct tem_color { 148 text_color_t fg_color; 149 text_color_t bg_color; 150 text_attr_t a_flags; 151 } tem_color_t; 152 153 enum called_from { CALLED_FROM_NORMAL, CALLED_FROM_STANDALONE }; 154 155 struct tem_pix_pos { 156 screen_pos_t x; 157 screen_pos_t y; 158 }; 159 160 struct tem_char_pos { 161 screen_pos_t col; 162 screen_pos_t row; 163 }; 164 165 struct tem_size { 166 screen_size_t width; 167 screen_size_t height; 168 }; 169 170 /* Combined color and 32bit tem char */ 171 typedef struct term_char { 172 text_color_t tc_fg_color; 173 text_color_t tc_bg_color; 174 tem_char_t tc_char; 175 } term_char_t; 176 177 /* 178 * State structure for each virtual terminal emulator 179 */ 180 struct tem_vt_state { 181 kmutex_t tvs_lock; 182 uchar_t tvs_fbmode; /* framebuffer mode */ 183 text_attr_t tvs_flags; /* flags for this x3.64 terminal */ 184 int tvs_state; /* state in output esc seq processing */ 185 boolean_t tvs_gotparam; /* does output esc seq have a param */ 186 187 int tvs_curparam; /* current param # of output esc seq */ 188 int tvs_paramval; /* value of current param */ 189 int tvs_params[TEM_MAXPARAMS]; /* parameters of output esc seq */ 190 screen_pos_t tvs_tabs[TEM_MAXTAB]; /* tab stops */ 191 int tvs_ntabs; /* number of tabs used */ 192 int tvs_nscroll; /* number of lines to scroll */ 193 194 struct tem_char_pos tvs_s_cursor; /* start cursor position */ 195 struct tem_char_pos tvs_c_cursor; /* current cursor position */ 196 struct tem_char_pos tvs_r_cursor; /* remembered cursor position */ 197 198 term_char_t *tvs_outbuf; /* place to keep incomplete lines */ 199 size_t tvs_outbuf_size; 200 size_t tvs_outindex; /* index into a_outbuf */ 201 void *tvs_pix_data; /* pointer to tmp bitmap area */ 202 size_t tvs_pix_data_size; 203 text_color_t tvs_fg_color; 204 text_color_t tvs_bg_color; 205 int tvs_first_line; /* kernel console output begins */ 206 207 term_char_t *tvs_screen_buf; /* whole screen buffer */ 208 term_char_t **tvs_screen_rows; /* screen buffer rows */ 209 size_t tvs_screen_buf_size; 210 size_t tvs_screen_history_size; 211 212 unsigned tvs_utf8_left; /* UTF-8 code points */ 213 tem_char_t tvs_utf8_partial; /* UTF-8 char being completed */ 214 215 boolean_t tvs_isactive; 216 boolean_t tvs_initialized; /* initialization flag */ 217 218 list_node_t tvs_list_node; 219 }; 220 _NOTE(MUTEX_PROTECTS_DATA(tem_vt_state::tvs_lock, tem_vt_state)) 221 222 typedef struct tem_safe_callbacks { 223 void (*tsc_display)(struct tem_vt_state *, term_char_t *, int, 224 screen_pos_t, screen_pos_t, cred_t *, enum called_from); 225 void (*tsc_copy)(struct tem_vt_state *, 226 screen_pos_t, screen_pos_t, screen_pos_t, screen_pos_t, 227 screen_pos_t, screen_pos_t, cred_t *, enum called_from); 228 void (*tsc_cursor)(struct tem_vt_state *, short, cred_t *, 229 enum called_from); 230 void (*tsc_bit2pix)(struct tem_vt_state *, term_char_t); 231 void (*tsc_cls)(struct tem_vt_state *, int, 232 screen_pos_t, screen_pos_t, cred_t *, enum called_from); 233 } tem_safe_callbacks_t; 234 235 /* 236 * common term soft state structure shared by all virtual terminal emulators 237 */ 238 typedef struct tem_state { 239 ldi_handle_t ts_hdl; /* Framework handle for layered on dev */ 240 screen_size_t ts_linebytes; /* Layered on bytes per scan line */ 241 242 int ts_display_mode; /* What mode we are in */ 243 struct vis_polledio *ts_fb_polledio; 244 245 struct tem_size ts_c_dimension; /* window dimensions in characters */ 246 struct tem_size ts_p_dimension; /* screen dimensions in pixels */ 247 struct tem_pix_pos ts_p_offset; /* pix offset to center the display */ 248 249 int ts_pix_data_size; /* size of bitmap data areas */ 250 int ts_pdepth; /* pixel depth */ 251 struct font ts_font; /* font table */ 252 253 term_char_t *ts_blank_line; /* a blank line for scrolling */ 254 tem_safe_callbacks_t *ts_callbacks; /* internal output functions */ 255 256 int ts_initialized; /* initialization flag */ 257 258 tem_modechg_cb_t ts_modechg_cb; 259 tem_modechg_cb_arg_t ts_modechg_arg; 260 261 color_map_fn_t ts_color_map; 262 263 tem_color_t ts_init_color; /* initial color and attributes */ 264 265 struct tem_vt_state *ts_active; 266 kmutex_t ts_lock; 267 list_t ts_list; /* chain of all tems */ 268 } tem_state_t; 269 270 extern tem_state_t tems; 271 extern tem_safe_callbacks_t tem_safe_text_callbacks; 272 extern tem_safe_callbacks_t tem_safe_pix_callbacks; 273 274 275 /* 276 * tems_* fuctions mean that they just operate on the common soft state 277 * (tem_state_t), and tem_* functions mean that they operate on the 278 * per-tem structure (tem_vt_state). All "safe" interfaces are in tem_safe.c. 279 */ 280 int tems_cls_layered(struct vis_consclear *, cred_t *); 281 void tems_display_layered(struct vis_consdisplay *, cred_t *); 282 void tems_copy_layered(struct vis_conscopy *, cred_t *); 283 void tems_cursor_layered(struct vis_conscursor *, cred_t *); 284 void tems_safe_copy(struct vis_conscopy *, cred_t *, enum called_from); 285 286 void tem_align(struct tem_vt_state *, cred_t *, enum called_from); 287 void tem_safe_check_first_time(struct tem_vt_state *tem, cred_t *, 288 enum called_from); 289 void tem_safe_reset_display(struct tem_vt_state *, cred_t *, 290 enum called_from, boolean_t, boolean_t); 291 void tem_safe_terminal_emulate(struct tem_vt_state *, uchar_t *, int, 292 cred_t *, enum called_from); 293 void tem_safe_text_display(struct tem_vt_state *, term_char_t *, 294 int, screen_pos_t, screen_pos_t, cred_t *, enum called_from); 295 void tem_safe_text_copy(struct tem_vt_state *, 296 screen_pos_t, screen_pos_t, 297 screen_pos_t, screen_pos_t, 298 screen_pos_t, screen_pos_t, 299 cred_t *, enum called_from); 300 void tem_safe_text_cursor(struct tem_vt_state *, short, cred_t *, 301 enum called_from); 302 void tem_safe_text_cls(struct tem_vt_state *, 303 int count, screen_pos_t row, screen_pos_t col, 304 cred_t *credp, enum called_from called_from); 305 void tem_safe_pix_display(struct tem_vt_state *, term_char_t *, 306 int, screen_pos_t, screen_pos_t, cred_t *, enum called_from); 307 void tem_safe_pix_copy(struct tem_vt_state *, 308 screen_pos_t, screen_pos_t, 309 screen_pos_t, screen_pos_t, 310 screen_pos_t, screen_pos_t, 311 cred_t *, enum called_from); 312 void tem_safe_pix_cursor(struct tem_vt_state *, short, cred_t *, 313 enum called_from); 314 void tem_safe_pix_bit2pix(struct tem_vt_state *, term_char_t); 315 void tem_safe_pix_cls(struct tem_vt_state *, int, screen_pos_t, screen_pos_t, 316 cred_t *, enum called_from); 317 void tem_safe_pix_cls_range(struct tem_vt_state *, 318 screen_pos_t, int, int, 319 screen_pos_t, int, int, 320 boolean_t, cred_t *, enum called_from); 321 322 void tem_safe_pix_clear_entire_screen(struct tem_vt_state *, 323 cred_t *, enum called_from); 324 325 void tem_safe_get_attr(struct tem_vt_state *, text_color_t *, 326 text_color_t *, text_attr_t *, uint8_t); 327 328 void tem_safe_blank_screen(struct tem_vt_state *, cred_t *, 329 enum called_from); 330 void tem_safe_unblank_screen(struct tem_vt_state *, cred_t *, 331 enum called_from); 332 #endif /* _BOOT */ 333 334 #ifdef __cplusplus 335 } 336 #endif 337 338 #endif /* _SYS_TEM_IMPL_H */ 339