xref: /freebsd/sys/dev/syscons/syscons.h (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1 /*-
2  * Copyright (c) 1995-1998 S�ren Schmidt
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification, immediately at the beginning of the file.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  *	$Id: syscons.h,v 1.43 1998/09/29 02:00:57 ache Exp $
29  */
30 
31 #ifndef _I386_ISA_SYSCONS_H_
32 #define	_I386_ISA_SYSCONS_H_
33 
34 /* vm things */
35 #define	ISMAPPED(pa, width) \
36 	(((pa) <= (u_long)0x1000 - (width)) \
37 	 || ((pa) >= 0xa0000 && (pa) <= 0x100000 - (width)))
38 #define	pa_to_va(pa)	(KERNBASE + (pa))	/* works if ISMAPPED(pa...) */
39 
40 /* printable chars */
41 #define PRINTABLE(ch)	((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
42 			 || (ch) < 0x07)
43 
44 /* macros for "intelligent" screen update */
45 #define mark_for_update(scp, x)	{\
46 			  	    if ((x) < scp->start) scp->start = (x);\
47 				    else if ((x) > scp->end) scp->end = (x);\
48 				}
49 #define mark_all(scp)		{\
50 				    scp->start = 0;\
51 				    scp->end = scp->xsize * scp->ysize - 1;\
52 				}
53 
54 /* status flags */
55 #define LOCK_KEY_MASK	0x0000F
56 #define LED_MASK	0x00007
57 #define UNKNOWN_MODE	0x00010
58 #define KBD_RAW_MODE	0x00020
59 #define KBD_CODE_MODE	0x00040
60 #define SWITCH_WAIT_REL	0x00080
61 #define SWITCH_WAIT_ACQ	0x00100
62 #define BUFFER_SAVED	0x00200
63 #define CURSOR_ENABLED 	0x00400
64 #define MOUSE_ENABLED	0x00800
65 #define MOUSE_MOVED	0x01000
66 #define MOUSE_CUTTING	0x02000
67 #define MOUSE_VISIBLE	0x04000
68 #define GRAPHICS_MODE	0x08000
69 #define PIXEL_MODE	0x10000
70 #define SAVER_RUNNING	0x20000
71 
72 /* configuration flags */
73 #define VISUAL_BELL	0x00001
74 #define BLINK_CURSOR	0x00002
75 #define CHAR_CURSOR	0x00004
76 #define DETECT_KBD	0x00008
77 #define XT_KEYBD	0x00010
78 #define KBD_NORESET	0x00020
79 #define QUIET_BELL	0x00040
80 #define VESA800X600	0x00080
81 
82 /* attribute flags */
83 #define NORMAL_ATTR             0x00
84 #define BLINK_ATTR              0x01
85 #define BOLD_ATTR               0x02
86 #define UNDERLINE_ATTR          0x04
87 #define REVERSE_ATTR            0x08
88 #define FOREGROUND_CHANGED      0x10
89 #define BACKGROUND_CHANGED      0x20
90 
91 /* misc defines */
92 #define FALSE		0
93 #define TRUE		1
94 #define MAX_ESC_PAR 	5
95 #define	LOAD		1
96 #define SAVE		0
97 #define	COL		80
98 #define	ROW		25
99 #define BELL_DURATION	5
100 #define BELL_PITCH	800
101 #define CONSOLE_BUFSIZE 1024
102 #define PCBURST		128
103 #define FONT_NONE	1
104 #define FONT_8		2
105 #define FONT_14		4
106 #define FONT_16		8
107 
108 /* special characters */
109 #define cntlc		0x03
110 #define cntld		0x04
111 #define bs		0x08
112 #define lf		0x0a
113 #define cr		0x0d
114 #define del		0x7f
115 
116 #define DEAD_CHAR 	0x07			/* char used for cursor */
117 
118 typedef struct term_stat {
119 	int 		esc;			/* processing escape sequence */
120 	int 		num_param;		/* # of parameters to ESC */
121 	int	 	last_param;		/* last parameter # */
122 	int 		param[MAX_ESC_PAR];	/* contains ESC parameters */
123 	int             cur_attr;               /* current hardware attr word */
124 	int             attr_mask;              /* current logical attr mask */
125 	int             cur_color;              /* current hardware color */
126 	int             std_color;              /* normal hardware color */
127 	int             rev_color;              /* reverse hardware color */
128 } term_stat;
129 
130 typedef struct scr_stat {
131 	int		adp;			/* video adapter index */
132 	u_short 	*scr_buf;		/* buffer when off screen */
133 	int 		xpos;			/* current X position */
134 	int 		ypos;			/* current Y position */
135 	int             saved_xpos;             /* saved X position */
136 	int             saved_ypos;             /* saved Y position */
137 	int 		xsize;			/* X text size */
138 	int 		ysize;			/* Y text size */
139 	int 		xpixel;			/* X graphics size */
140 	int 		ypixel;			/* Y graphics size */
141 	int		xoff;			/* X offset in pixel mode */
142 	int		yoff;			/* Y offset in pixel mode */
143 	int		font_size;		/* fontsize in Y direction */
144 	int		start;			/* modified area start */
145 	int		end;			/* modified area end */
146 	term_stat 	term;			/* terminal emulation stuff */
147 	int	 	status;			/* status (bitfield) */
148 	u_short 	*cursor_pos;		/* cursor buffer position */
149 	u_short 	*cursor_oldpos;		/* cursor old buffer position */
150 	u_short		cursor_saveunder;	/* saved chars under cursor */
151 	char		cursor_start;		/* cursor start line # */
152 	char		cursor_end;		/* cursor end line # */
153 	u_short		*mouse_pos;		/* mouse buffer position */
154 	u_short		*mouse_oldpos;		/* mouse old buffer position */
155 	short		mouse_xpos;		/* mouse x coordinate */
156 	short		mouse_ypos;		/* mouse y coordinate */
157 	short		mouse_buttons;		/* mouse buttons */
158 	u_char		mouse_cursor[128];	/* mouse cursor bitmap store */
159 	u_short		*mouse_cut_start;	/* mouse cut start pos */
160 	u_short		*mouse_cut_end;		/* mouse cut end pos */
161 	struct proc 	*mouse_proc;		/* proc* of controlling proc */
162 	pid_t 		mouse_pid;		/* pid of controlling proc */
163 	int		mouse_signal;		/* signal # to report with */
164 	u_short		bell_duration;
165 	u_short		bell_pitch;
166 	u_char		border;			/* border color */
167 	int	 	initial_mode;		/* initial mode */
168 	int	 	mode;			/* mode */
169 	pid_t 		pid;			/* pid of controlling proc */
170 	struct proc 	*proc;			/* proc* of controlling proc */
171 	struct vt_mode 	smode;			/* switch mode */
172 	u_short		*history;		/* circular history buffer */
173 	u_short		*history_head;		/* current head position */
174 	u_short		*history_pos;		/* position shown on screen */
175 	u_short		*history_save;		/* save area index */
176 	int		history_size;		/* size of history buffer */
177 	struct apmhook  r_hook;			/* reconfiguration support */
178 #ifdef SC_SPLASH_SCREEN
179 	int		splash_save_mode;	/* saved mode for splash screen */
180 	int		splash_save_status;	/* saved status for splash screen */
181 #endif
182 } scr_stat;
183 
184 typedef struct default_attr {
185 	int             std_color;              /* normal hardware color */
186 	int             rev_color;              /* reverse hardware color */
187 } default_attr;
188 
189 
190 #define ISTEXTSC(scp)	(!((scp)->status 				\
191 			  & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
192 #define ISGRAPHSC(scp)	(((scp)->status 				\
193 			  & (UNKNOWN_MODE | GRAPHICS_MODE)))
194 #define ISPIXELSC(scp)	(((scp)->status 				\
195 			  & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
196 			  == PIXEL_MODE)
197 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
198 
199 #define ISFONTAVAIL(af)	((af) & V_ADP_FONT)
200 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
201 #define ISPALAVAIL(af)	((af) & V_ADP_PALETTE)
202 
203 /* misc prototypes used by different syscons related LKM's */
204 
205 /* syscons.c */
206 extern int (*sc_user_ioctl)(dev_t dev, u_long cmd, caddr_t data, int flag,
207 			    struct proc *p);
208 
209 int set_mode(scr_stat *scp);
210 scr_stat *sc_get_scr_stat(dev_t dev);
211 
212 void copy_font(scr_stat *scp, int operation, int font_size, u_char *font_image);
213 void set_border(scr_stat *scp, int color);
214 #define save_palette(scp, pal)	(*biosvidsw.save_palette)((scp)->adp, pal)
215 #define load_palette(scp, pal)	(*biosvidsw.load_palette)((scp)->adp, pal)
216 #define get_adapter(scp)	(*biosvidsw.adapter)((scp)->adp)
217 
218 int add_scrn_saver(void (*this)(int));
219 int remove_scrn_saver(void (*this)(int));
220 
221 void sc_clear_screen(scr_stat *scp);
222 void sc_move_mouse(scr_stat *scp, int x, int y);
223 int sc_clean_up(scr_stat *scp);
224 void sc_alloc_scr_buffer(scr_stat *scp, int wait, int clear);
225 void sc_alloc_cut_buffer(scr_stat *scp, int wait);
226 void sc_alloc_history_buffer(scr_stat *scp, int lines, int extra, int wait);
227 struct tty *scdevtotty(dev_t dev);
228 
229 /* scvidctl.c */
230 int sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
231 		     int xsize, int ysize, int fontsize);
232 int sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
233 int sc_set_pixel_mode(scr_stat *scp, struct tty *tp,
234 		      int xsize, int ysize, int fontsize);
235 int sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data, int flag,
236 		 struct proc *p);
237 
238 #ifdef SC_SPLASH_SCREEN
239 /* splash.c */
240 void scsplash(int);
241 int scsplash_load(scr_stat *scp);
242 int scsplash_unload(scr_stat *scp);
243 #endif
244 
245 #endif /* !_I386_ISA_SYSCONS_H_ */
246