xref: /linux-6.15/include/linux/console_struct.h (revision c537b994)
1 /*
2  * console_struct.h
3  *
4  * Data structure describing single virtual console except for data
5  * used by vt.c.
6  *
7  * Fields marked with [#] must be set by the low-level driver.
8  * Fields marked with [!] can be changed by the low-level driver
9  * to achieve effects such as fast scrolling by changing the origin.
10  */
11 
12 #include <linux/wait.h>
13 #include <linux/vt.h>
14 #include <linux/workqueue.h>
15 
16 struct vt_struct;
17 
18 #define NPAR 16
19 
20 struct vc_data {
21 	unsigned short	vc_num;			/* Console number */
22 	unsigned int	vc_cols;		/* [#] Console size */
23 	unsigned int	vc_rows;
24 	unsigned int	vc_size_row;		/* Bytes per row */
25 	unsigned int	vc_scan_lines;		/* # of scan lines */
26 	unsigned long	vc_origin;		/* [!] Start of real screen */
27 	unsigned long	vc_scr_end;		/* [!] End of real screen */
28 	unsigned long	vc_visible_origin;	/* [!] Top of visible window */
29 	unsigned int	vc_top, vc_bottom;	/* Scrolling region */
30 	const struct consw *vc_sw;
31 	unsigned short	*vc_screenbuf;		/* In-memory character/attribute buffer */
32 	unsigned int	vc_screenbuf_size;
33 	unsigned char	vc_mode;		/* KD_TEXT, ... */
34 	/* attributes for all characters on screen */
35 	unsigned char	vc_attr;		/* Current attributes */
36 	unsigned char	vc_def_color;		/* Default colors */
37 	unsigned char	vc_color;		/* Foreground & background */
38 	unsigned char	vc_s_color;		/* Saved foreground & background */
39 	unsigned char	vc_ulcolor;		/* Color for underline mode */
40 	unsigned char	vc_halfcolor;		/* Color for half intensity mode */
41 	/* cursor */
42 	unsigned int	vc_cursor_type;
43 	unsigned short	vc_complement_mask;	/* [#] Xor mask for mouse pointer */
44 	unsigned short	vc_s_complement_mask;	/* Saved mouse pointer mask */
45 	unsigned int	vc_x, vc_y;		/* Cursor position */
46 	unsigned int	vc_saved_x, vc_saved_y;
47 	unsigned long	vc_pos;			/* Cursor address */
48 	/* fonts */
49 	unsigned short	vc_hi_font_mask;	/* [#] Attribute set for upper 256 chars of font or 0 if not supported */
50 	struct console_font vc_font;		/* Current VC font set */
51 	unsigned short	vc_video_erase_char;	/* Background erase character */
52 	/* VT terminal data */
53 	unsigned int	vc_state;		/* Escape sequence parser state */
54 	unsigned int	vc_npar,vc_par[NPAR];	/* Parameters of current escape sequence */
55 	struct tty_struct *vc_tty;		/* TTY we are attached to */
56 	/* data for manual vt switching */
57 	struct vt_mode	vt_mode;
58 	struct pid 	*vt_pid;
59 	int		vt_newvt;
60 	wait_queue_head_t paste_wait;
61 	/* mode flags */
62 	unsigned int	vc_charset	: 1;	/* Character set G0 / G1 */
63 	unsigned int	vc_s_charset	: 1;	/* Saved character set */
64 	unsigned int	vc_disp_ctrl	: 1;	/* Display chars < 32? */
65 	unsigned int	vc_toggle_meta	: 1;	/* Toggle high bit? */
66 	unsigned int	vc_decscnm	: 1;	/* Screen Mode */
67 	unsigned int	vc_decom	: 1;	/* Origin Mode */
68 	unsigned int	vc_decawm	: 1;	/* Autowrap Mode */
69 	unsigned int	vc_deccm	: 1;	/* Cursor Visible */
70 	unsigned int	vc_decim	: 1;	/* Insert Mode */
71 	unsigned int	vc_deccolm	: 1;	/* 80/132 Column Mode */
72 	/* attribute flags */
73 	unsigned int	vc_intensity	: 2;	/* 0=half-bright, 1=normal, 2=bold */
74 	unsigned int	vc_underline	: 1;
75 	unsigned int	vc_blink	: 1;
76 	unsigned int	vc_reverse	: 1;
77 	unsigned int	vc_s_intensity	: 2;	/* saved rendition */
78 	unsigned int	vc_s_underline	: 1;
79 	unsigned int	vc_s_blink	: 1;
80 	unsigned int	vc_s_reverse	: 1;
81 	/* misc */
82 	unsigned int	vc_ques		: 1;
83 	unsigned int	vc_need_wrap	: 1;
84 	unsigned int	vc_can_do_color	: 1;
85 	unsigned int	vc_report_mouse : 2;
86 	unsigned int	vc_kmalloced	: 1;
87 	unsigned char	vc_utf		: 1;	/* Unicode UTF-8 encoding */
88 	unsigned char	vc_utf_count;
89 		 int	vc_utf_char;
90 	unsigned int	vc_tab_stop[8];		/* Tab stops. 256 columns. */
91 	unsigned char   vc_palette[16*3];       /* Colour palette for VGA+ */
92 	unsigned short * vc_translate;
93 	unsigned char 	vc_G0_charset;
94 	unsigned char 	vc_G1_charset;
95 	unsigned char 	vc_saved_G0;
96 	unsigned char 	vc_saved_G1;
97 	unsigned int	vc_bell_pitch;		/* Console bell pitch */
98 	unsigned int	vc_bell_duration;	/* Console bell duration */
99 	struct vc_data **vc_display_fg;		/* [!] Ptr to var holding fg console for this display */
100 	unsigned long	vc_uni_pagedir;
101 	unsigned long	*vc_uni_pagedir_loc;  /* [!] Location of uni_pagedir variable for this console */
102 	/* additional information is in vt_kern.h */
103 };
104 
105 struct vc {
106 	struct vc_data *d;
107 	struct work_struct SAK_work;
108 
109 	/* might add  scrmem, vt_struct, kbd  at some time,
110 	   to have everything in one place - the disadvantage
111 	   would be that vc_cons etc can no longer be static */
112 };
113 
114 extern struct vc vc_cons [MAX_NR_CONSOLES];
115 extern void vc_SAK(struct work_struct *work);
116 
117 #define CUR_DEF		0
118 #define CUR_NONE	1
119 #define CUR_UNDERLINE	2
120 #define CUR_LOWER_THIRD	3
121 #define CUR_LOWER_HALF	4
122 #define CUR_TWO_THIRDS	5
123 #define CUR_BLOCK	6
124 #define CUR_HWMASK	0x0f
125 #define CUR_SWMASK	0xfff0
126 
127 #define CUR_DEFAULT CUR_UNDERLINE
128 
129 #define CON_IS_VISIBLE(conp) (*conp->vc_display_fg == conp)
130