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.
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.
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]
23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
27 /* Copyright (c) 1990, 1991 UNIX System Laboratories, Inc. */
29 /* Copyright (c) 1984, 1986, 1987, 1988, 1989, 1990 AT&T */
30 /* All Rights Reserved */
32 #ifndef _SYS_TEM_IMPL_H
33 #define _SYS_TEM_IMPL_H
39 #include <sys/types.h>
40 #include <sys/sunddi.h>
41 #include <sys/sunldi.h>
42 #include <sys/visual_io.h>
49 * definitions for ANSI x3.64 terminal control language parser
52 #define TEM_MAXPARAMS 5 /* maximum number of ANSI paramters */
53 #define TEM_MAXTAB 40 /* maximum number of tab stops */
54 #define TEM_MAXFKEY 30 /* max length of function key with <ESC>Q */
55 #define MAX_TEM 2 /* max number of loadable terminal emulators */
57 #define TEM_SCROLL_UP 0
58 #define TEM_SCROLL_DOWN 1
59 #define TEM_SHIFT_LEFT 0
60 #define TEM_SHIFT_RIGHT 1
62 #define TEM_ATTR_NORMAL 0x0000
63 #define TEM_ATTR_REVERSE 0x0001
64 #define TEM_ATTR_BOLD 0x0002
65 #define TEM_ATTR_BLINK 0x0004
66 #define TEM_ATTR_TRANSPARENT 0x0008
67 #define TEM_ATTR_SCREEN_REVERSE 0x0010
68 #define TEM_ATTR_BRIGHT_FG 0x0020
69 #define TEM_ATTR_BRIGHT_BG 0x0040
71 #define ANSI_COLOR_BLACK 0
72 #define ANSI_COLOR_WHITE 7
74 #define TEM_TEXT_WHITE 0
75 #define TEM_TEXT_BLACK 1
76 #define TEM_TEXT_BLACK24_RED 0x00
77 #define TEM_TEXT_BLACK24_GREEN 0x00
78 #define TEM_TEXT_BLACK24_BLUE 0x00
79 #define TEM_TEXT_WHITE24_RED 0xff
80 #define TEM_TEXT_WHITE24_GREEN 0xff
81 #define TEM_TEXT_WHITE24_BLUE 0xff
83 #define A_STATE_START 0
86 #define A_STATE_CSI_QMARK 3
87 #define A_STATE_CSI_EQUAL 4
90 * Default number of rows and columns
92 #define TEM_DEFAULT_ROWS 34
93 #define TEM_DEFAULT_COLS 80
96 * Default foreground/background color
99 #ifdef _HAVE_TEM_FIRMWARE
100 #define DEFAULT_ANSI_FOREGROUND ANSI_COLOR_BLACK
101 #define DEFAULT_ANSI_BACKGROUND ANSI_COLOR_WHITE
102 #else /* _HAVE_TEM_FIRMWARE */
103 #define DEFAULT_ANSI_FOREGROUND ANSI_COLOR_WHITE
104 #define DEFAULT_ANSI_BACKGROUND ANSI_COLOR_BLACK
108 #define BUF_LEN 160 /* Two lines of data can be processed at a time */
110 typedef uint8_t text_color_t
;
112 typedef struct tem_color
{
113 text_color_t fg_color
;
114 text_color_t bg_color
;
115 unsigned short a_flags
;
118 enum called_from
{ CALLED_FROM_NORMAL
, CALLED_FROM_STANDALONE
};
125 struct tem_char_pos
{
132 screen_size_t height
;
141 extern text_cmap_t cmap4_to_24
;
144 * State structure for each virtual terminal emulator
146 struct tem_vt_state
{
148 uchar_t tvs_fbmode
; /* framebuffer mode */
149 unsigned short tvs_flags
; /* flags for this x3.64 terminal */
150 int tvs_state
; /* state in output esc seq processing */
151 boolean_t tvs_gotparam
; /* does output esc seq have a param */
153 int tvs_curparam
; /* current param # of output esc seq */
154 int tvs_paramval
; /* value of current param */
155 int tvs_params
[TEM_MAXPARAMS
]; /* parameters of output esc seq */
156 screen_pos_t tvs_tabs
[TEM_MAXTAB
]; /* tab stops */
157 int tvs_ntabs
; /* number of tabs used */
158 int tvs_nscroll
; /* number of lines to scroll */
160 struct tem_char_pos tvs_s_cursor
; /* start cursor position */
161 struct tem_char_pos tvs_c_cursor
; /* current cursor position */
162 struct tem_char_pos tvs_r_cursor
; /* remembered cursor position */
164 unsigned char *tvs_outbuf
; /* place to keep incomplete lines */
166 int tvs_outindex
; /* index into a_outbuf */
167 void *tvs_pix_data
; /* pointer to tmp bitmap area */
168 int tvs_pix_data_size
;
169 text_color_t tvs_fg_color
;
170 text_color_t tvs_bg_color
;
171 int tvs_first_line
; /* kernel console output begins */
173 unsigned char *tvs_screen_buf
; /* whole screen buffer */
174 int tvs_screen_buf_size
;
175 text_color_t
*tvs_fg_buf
; /* fg_color attribute cache */
176 text_color_t
*tvs_bg_buf
; /* bg_color attribute cache */
177 int tvs_color_buf_size
;
179 boolean_t tvs_isactive
;
180 int tvs_initialized
; /* initialization flag */
182 list_node_t tvs_list_node
;
184 _NOTE(MUTEX_PROTECTS_DATA(tem_vt_state::tvs_lock
, tem_vt_state
))
186 typedef struct tem_safe_callbacks
{
187 void (*tsc_display
)(struct tem_vt_state
*, unsigned char *, int,
188 screen_pos_t
, screen_pos_t
, unsigned char, unsigned char,
189 cred_t
*, enum called_from
);
190 void (*tsc_copy
)(struct tem_vt_state
*,
191 screen_pos_t
, screen_pos_t
, screen_pos_t
, screen_pos_t
,
192 screen_pos_t
, screen_pos_t
, cred_t
*, enum called_from
);
193 void (*tsc_cursor
)(struct tem_vt_state
*, short, cred_t
*,
195 void (*tsc_bit2pix
)(struct tem_vt_state
*, unsigned char,
196 unsigned char, unsigned char);
197 void (*tsc_cls
)(struct tem_vt_state
*, int,
198 screen_pos_t
, screen_pos_t
, cred_t
*, enum called_from
);
199 } tem_safe_callbacks_t
;
202 * common term soft state structure shared by all virtual terminal emulators
204 typedef struct tem_state
{
205 ldi_handle_t ts_hdl
; /* Framework handle for layered on dev */
206 screen_size_t ts_linebytes
; /* Layered on bytes per scan line */
208 int ts_display_mode
; /* What mode we are in */
209 struct vis_polledio
*ts_fb_polledio
;
211 struct tem_size ts_c_dimension
; /* window dimensions in characters */
212 struct tem_size ts_p_dimension
; /* screen dimensions in pixels */
213 struct tem_pix_pos ts_p_offset
; /* pix offset to center the display */
215 int ts_pix_data_size
; /* size of bitmap data areas */
216 int ts_pdepth
; /* pixel depth */
217 struct font ts_font
; /* font table */
219 unsigned char *ts_blank_line
; /* a blank line for scrolling */
220 tem_safe_callbacks_t
*ts_callbacks
; /* internal output functions */
222 int ts_initialized
; /* initialization flag */
224 tem_modechg_cb_t ts_modechg_cb
;
225 tem_modechg_cb_arg_t ts_modechg_arg
;
227 tem_color_t ts_init_color
; /* initial color and attributes */
229 struct tem_vt_state
*ts_active
;
231 list_t ts_list
; /* chain of all tems */
234 extern tem_state_t tems
;
235 extern tem_safe_callbacks_t tem_safe_text_callbacks
;
236 extern tem_safe_callbacks_t tem_safe_pix_callbacks
;
240 * tems_* fuctions mean that they just operate on the common soft state
241 * (tem_state_t), and tem_* functions mean that they operate on the
242 * per-tem structure (tem_vt_state). All "safe" interfaces are in tem_safe.c.
244 void tems_display_layered(struct vis_consdisplay
*, cred_t
*);
245 void tems_copy_layered(struct vis_conscopy
*, cred_t
*);
246 void tems_cursor_layered(struct vis_conscursor
*, cred_t
*);
247 void tems_safe_copy(struct vis_conscopy
*, cred_t
*, enum called_from
);
249 void tem_pix_align(struct tem_vt_state
*, cred_t
*, enum called_from
);
250 void tem_safe_check_first_time(struct tem_vt_state
*tem
, cred_t
*,
252 void tem_safe_reset_display(struct tem_vt_state
*, cred_t
*,
253 enum called_from
, boolean_t
, boolean_t
);
254 void tem_safe_terminal_emulate(struct tem_vt_state
*, uchar_t
*, int,
255 cred_t
*, enum called_from
);
256 void tem_safe_text_display(struct tem_vt_state
*, uchar_t
*,
257 int, screen_pos_t
, screen_pos_t
,
258 text_color_t
, text_color_t
,
259 cred_t
*, enum called_from
);
260 void tem_safe_text_copy(struct tem_vt_state
*,
261 screen_pos_t
, screen_pos_t
,
262 screen_pos_t
, screen_pos_t
,
263 screen_pos_t
, screen_pos_t
,
264 cred_t
*, enum called_from
);
265 void tem_safe_text_cursor(struct tem_vt_state
*, short, cred_t
*,
267 void tem_safe_text_cls(struct tem_vt_state
*,
268 int count
, screen_pos_t row
, screen_pos_t col
,
269 cred_t
*credp
, enum called_from called_from
);
270 void tem_safe_pix_display(struct tem_vt_state
*, uchar_t
*,
271 int, screen_pos_t
, screen_pos_t
,
272 text_color_t
, text_color_t
,
273 cred_t
*, enum called_from
);
274 void tem_safe_pix_copy(struct tem_vt_state
*,
275 screen_pos_t
, screen_pos_t
,
276 screen_pos_t
, screen_pos_t
,
277 screen_pos_t
, screen_pos_t
,
278 cred_t
*, enum called_from
);
279 void tem_safe_pix_cursor(struct tem_vt_state
*, short, cred_t
*,
281 void tem_safe_pix_bit2pix(struct tem_vt_state
*, unsigned char,
282 unsigned char, unsigned char);
283 void tem_safe_pix_cls(struct tem_vt_state
*, int, screen_pos_t
, screen_pos_t
,
284 cred_t
*, enum called_from
);
285 void tem_safe_pix_cls_range(struct tem_vt_state
*,
286 screen_pos_t
, int, int,
287 screen_pos_t
, int, int,
288 boolean_t
, cred_t
*, enum called_from
);
290 void tem_safe_pix_clear_entire_screen(struct tem_vt_state
*,
291 cred_t
*, enum called_from
);
293 void tem_safe_get_color(struct tem_vt_state
*, text_color_t
*,
294 text_color_t
*, uint8_t);
295 void set_font(struct font
*, short *, short *, short, short);
297 void tem_safe_blank_screen(struct tem_vt_state
*, cred_t
*,
299 void tem_safe_unblank_screen(struct tem_vt_state
*, cred_t
*,
306 #endif /* _SYS_TEM_IMPL_H */