1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * console_struct.h
4  *
5  * Data structure describing single virtual console except for data
6  * used by vt.c.
7  *
8  * Fields marked with [#] must be set by the low-level driver.
9  * Fields marked with [!] can be changed by the low-level driver
10  * to achieve effects such as fast scrolling by changing the origin.
11  */
12 
13 #ifndef _LINUX_CONSOLE_STRUCT_H
14 #define _LINUX_CONSOLE_STRUCT_H
15 
16 #include <linux/wait.h>
17 #include <linux/vt.h>
18 #include <linux/workqueue.h>
19 
20 struct uni_pagedict;
21 struct uni_screen;
22 
23 #define NPAR 16
24 #define VC_TABSTOPS_COUNT	256U
25 
26 enum vc_intensity {
27 	VCI_HALF_BRIGHT,
28 	VCI_NORMAL,
29 	VCI_BOLD,
30 	VCI_MASK = 0x3,
31 };
32 
33 /**
34  * struct vc_state -- state of a VC
35  * @x: cursor's x-position
36  * @y: cursor's y-position
37  * @color: foreground & background colors
38  * @Gx_charset: what's G0/G1 slot set to (like GRAF_MAP, LAT1_MAP)
39  * @charset: what character set to use (0=G0 or 1=G1)
40  * @intensity: see enum vc_intensity for values
41  * @reverse: reversed foreground/background colors
42  *
43  * These members are defined separately from struct vc_data as we save &
44  * restore them at times.
45  */
46 struct vc_state {
47 	unsigned int	x, y;
48 
49 	unsigned char	color;
50 
51 	unsigned char	Gx_charset[2];
52 	unsigned int	charset		: 1;
53 
54 	/* attribute flags */
55 	enum vc_intensity intensity;
56 	bool		italic;
57 	bool		underline;
58 	bool		blink;
59 	bool		reverse;
60 };
61 
62 /*
63  * Example: vc_data of a console that was scrolled 3 lines down.
64  *
65  *                              Console buffer
66  * vc_screenbuf ---------> +----------------------+-.
67  *                         | initializing W       |  \
68  *                         | initializing X       |   |
69  *                         | initializing Y       |    > scroll-back area
70  *                         | initializing Z       |   |
71  *                         |                      |  /
72  * vc_visible_origin ---> ^+----------------------+-:
73  * (changes by scroll)    || Welcome to linux     |  \
74  *                        ||                      |   |
75  *           vc_rows --->< | login: root          |   |  visible on console
76  *                        || password:            |    > (vc_screenbuf_size is
77  * vc_origin -----------> ||                      |   |   vc_size_row * vc_rows)
78  * (start when no scroll) || Last login: 12:28    |  /
79  *                        v+----------------------+-:
80  *                         | Have a lot of fun... |  \
81  * vc_pos -----------------|--------v             |   > scroll-front area
82  *                         | ~ # cat_             |  /
83  * vc_scr_end -----------> +----------------------+-:
84  * (vc_origin +            |                      |  \ EMPTY, to be filled by
85  *  vc_screenbuf_size)     |                      |  / vc_video_erase_char
86  *                         +----------------------+-'
87  *                         <---- 2 * vc_cols ----->
88  *                         <---- vc_size_row ----->
89  *
90  * Note that every character in the console buffer is accompanied with an
91  * attribute in the buffer right after the character. This is not depicted
92  * in the figure.
93  */
94 struct vc_data {
95 	struct tty_port port;			/* Upper level data */
96 
97 	struct vc_state state, saved_state;
98 
99 	unsigned short	vc_num;			/* Console number */
100 	unsigned int	vc_cols;		/* [#] Console size */
101 	unsigned int	vc_rows;
102 	unsigned int	vc_size_row;		/* Bytes per row */
103 	unsigned int	vc_scan_lines;		/* # of scan lines */
104 	unsigned int	vc_cell_height;		/* CRTC character cell height */
105 	unsigned long	vc_origin;		/* [!] Start of real screen */
106 	unsigned long	vc_scr_end;		/* [!] End of real screen */
107 	unsigned long	vc_visible_origin;	/* [!] Top of visible window */
108 	unsigned int	vc_top, vc_bottom;	/* Scrolling region */
109 	const struct consw *vc_sw;
110 	unsigned short	*vc_screenbuf;		/* In-memory character/attribute buffer */
111 	unsigned int	vc_screenbuf_size;
112 	unsigned char	vc_mode;		/* KD_TEXT, ... */
113 	/* attributes for all characters on screen */
114 	unsigned char	vc_attr;		/* Current attributes */
115 	unsigned char	vc_def_color;		/* Default colors */
116 	unsigned char	vc_ulcolor;		/* Color for underline mode */
117 	unsigned char   vc_itcolor;
118 	unsigned char	vc_halfcolor;		/* Color for half intensity mode */
119 	/* cursor */
120 	unsigned int	vc_cursor_type;
121 	unsigned short	vc_complement_mask;	/* [#] Xor mask for mouse pointer */
122 	unsigned short	vc_s_complement_mask;	/* Saved mouse pointer mask */
123 	unsigned long	vc_pos;			/* Cursor address */
124 	/* fonts */
125 	unsigned short	vc_hi_font_mask;	/* [#] Attribute set for upper 256 chars of font or 0 if not supported */
126 	struct console_font vc_font;		/* Current VC font set */
127 	unsigned short	vc_video_erase_char;	/* Background erase character */
128 	/* VT terminal data */
129 	unsigned int	vc_state;		/* Escape sequence parser state */
130 	unsigned int	vc_npar,vc_par[NPAR];	/* Parameters of current escape sequence */
131 	/* data for manual vt switching */
132 	struct vt_mode	vt_mode;
133 	struct pid 	*vt_pid;
134 	int		vt_newvt;
135 	wait_queue_head_t paste_wait;
136 	/* mode flags */
137 	unsigned int	vc_disp_ctrl	: 1;	/* Display chars < 32? */
138 	unsigned int	vc_toggle_meta	: 1;	/* Toggle high bit? */
139 	unsigned int	vc_decscnm	: 1;	/* Screen Mode */
140 	unsigned int	vc_decom	: 1;	/* Origin Mode */
141 	unsigned int	vc_decawm	: 1;	/* Autowrap Mode */
142 	unsigned int	vc_deccm	: 1;	/* Cursor Visible */
143 	unsigned int	vc_decim	: 1;	/* Insert Mode */
144 	/* misc */
145 	unsigned int	vc_priv		: 3;
146 	unsigned int	vc_need_wrap	: 1;
147 	unsigned int	vc_can_do_color	: 1;
148 	unsigned int	vc_report_mouse : 2;
149 	unsigned char	vc_utf		: 1;	/* Unicode UTF-8 encoding */
150 	unsigned char	vc_utf_count;
151 		 int	vc_utf_char;
152 	DECLARE_BITMAP(vc_tab_stop, VC_TABSTOPS_COUNT);	/* Tab stops. 256 columns. */
153 	unsigned char   vc_palette[16*3];       /* Colour palette for VGA+ */
154 	unsigned short * vc_translate;
155 	unsigned int    vc_resize_user;         /* resize request from user */
156 	unsigned int	vc_bell_pitch;		/* Console bell pitch */
157 	unsigned int	vc_bell_duration;	/* Console bell duration */
158 	unsigned short	vc_cur_blink_ms;	/* Cursor blink duration */
159 	struct vc_data **vc_display_fg;		/* [!] Ptr to var holding fg console for this display */
160 	struct uni_pagedict *uni_pagedict;
161 	struct uni_pagedict **uni_pagedict_loc; /* [!] Location of uni_pagedict variable for this console */
162 	struct uni_screen *vc_uni_screen;	/* unicode screen content */
163 	/* additional information is in vt_kern.h */
164 };
165 
166 struct vc {
167 	struct vc_data *d;
168 	struct work_struct SAK_work;
169 
170 	/* might add  scrmem, kbd  at some time,
171 	   to have everything in one place */
172 };
173 
174 extern struct vc vc_cons [MAX_NR_CONSOLES];
175 extern void vc_SAK(struct work_struct *work);
176 
177 #define CUR_MAKE(size, change, set)	((size) | ((change) << 8) |	\
178 		((set) << 16))
179 #define CUR_SIZE(c)		 ((c) & 0x00000f)
180 # define CUR_DEF			       0
181 # define CUR_NONE			       1
182 # define CUR_UNDERLINE			       2
183 # define CUR_LOWER_THIRD		       3
184 # define CUR_LOWER_HALF			       4
185 # define CUR_TWO_THIRDS			       5
186 # define CUR_BLOCK			       6
187 #define CUR_SW				0x000010
188 #define CUR_ALWAYS_BG			0x000020
189 #define CUR_INVERT_FG_BG		0x000040
190 #define CUR_FG				0x000700
191 #define CUR_BG				0x007000
192 #define CUR_CHANGE(c)		 ((c) & 0x00ff00)
193 #define CUR_SET(c)		(((c) & 0xff0000) >> 8)
194 
195 bool con_is_visible(const struct vc_data *vc);
196 
197 #endif /* _LINUX_CONSOLE_STRUCT_H */
198