xref: /freebsd/sys/dev/syscons/syscons.h (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
1 /*-
2  * Copyright (c) 1995-1997 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  *    in this position and unchanged.
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.33 1997/09/04 23:01:06 yokota 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;\
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 
69 /* configuration flags */
70 #define VISUAL_BELL	0x00001
71 #define BLINK_CURSOR	0x00002
72 #define CHAR_CURSOR	0x00004
73 #define DETECT_KBD	0x00008
74 #define XT_KEYBD	0x00010
75 #define KBD_NORESET	0x00020
76 
77 /* attribute flags */
78 #define NORMAL_ATTR             0x00
79 #define BLINK_ATTR              0x01
80 #define BOLD_ATTR               0x02
81 #define UNDERLINE_ATTR          0x04
82 #define REVERSE_ATTR            0x08
83 #define FOREGROUND_CHANGED      0x10
84 #define BACKGROUND_CHANGED      0x20
85 
86 /* video hardware memory addresses */
87 #define VIDEOMEM	0x000A0000
88 
89 /* misc defines */
90 #define FALSE		0
91 #define TRUE		1
92 #define MAX_ESC_PAR 	5
93 #define	LOAD		1
94 #define SAVE		0
95 #define	COL		80
96 #define	ROW		25
97 #define BELL_DURATION	5
98 #define BELL_PITCH	800
99 #define CONSOLE_BUFSIZE 1024
100 #define PCBURST		128
101 #define FONT_NONE	1
102 #define FONT_8		2
103 #define FONT_14		4
104 #define FONT_16		8
105 #if !defined(SC_HISTORY_SIZE)
106 #define SC_HISTORY_SIZE	(ROW * 4)
107 #endif /* SC_HISTORY_SIZE */
108 #define HISTORY_SIZE	(COL * (SC_HISTORY_SIZE))
109 
110 /* defines related to hardware addresses */
111 #define	MONO_BASE	0x3B4			/* crt controller base mono */
112 #define	COLOR_BASE	0x3D4			/* crt controller base color */
113 #define MISC		0x3C2			/* misc output register */
114 #define ATC		IO_VGA+0x00		/* attribute controller */
115 #define TSIDX		IO_VGA+0x04		/* timing sequencer idx */
116 #define TSREG		IO_VGA+0x05		/* timing sequencer data */
117 #define PIXMASK		IO_VGA+0x06		/* pixel write mask */
118 #define PALRADR		IO_VGA+0x07		/* palette read address */
119 #define PALWADR		IO_VGA+0x08		/* palette write address */
120 #define PALDATA		IO_VGA+0x09		/* palette data register */
121 #define GDCIDX		IO_VGA+0x0E		/* graph data controller idx */
122 #define GDCREG		IO_VGA+0x0F		/* graph data controller data */
123 
124 /* special characters */
125 #define cntlc		0x03
126 #define cntld		0x04
127 #define bs		0x08
128 #define lf		0x0a
129 #define cr		0x0d
130 #define del		0x7f
131 
132 #define DEAD_CHAR 	0x07			/* char used for cursor */
133 
134 typedef struct term_stat {
135 	int 		esc;			/* processing escape sequence */
136 	int 		num_param;		/* # of parameters to ESC */
137 	int	 	last_param;		/* last parameter # */
138 	int 		param[MAX_ESC_PAR];	/* contains ESC parameters */
139 	int             cur_attr;               /* current hardware attr word */
140 	int             attr_mask;              /* current logical attr mask */
141 	int             cur_color;              /* current hardware color */
142 	int             std_color;              /* normal hardware color */
143 	int             rev_color;              /* reverse hardware color */
144 } term_stat;
145 
146 typedef struct scr_stat {
147 	u_short 	*scr_buf;		/* buffer when off screen */
148 	int 		xpos;			/* current X position */
149 	int 		ypos;			/* current Y position */
150 	int             saved_xpos;             /* saved X position */
151 	int             saved_ypos;             /* saved Y position */
152 	int 		xsize;			/* X text size */
153 	int 		ysize;			/* Y text size */
154 	int 		xpixel;			/* X graphics size */
155 	int 		ypixel;			/* Y graphics size */
156 	int		font_size;		/* fontsize in Y direction */
157 	int		start;			/* modified area start */
158 	int		end;			/* modified area end */
159 	term_stat 	term;			/* terminal emulation stuff */
160 	int	 	status;			/* status (bitfield) */
161 	u_short 	*cursor_pos;		/* cursor buffer position */
162 	u_short 	*cursor_oldpos;		/* cursor old buffer position */
163 	u_short		cursor_saveunder;	/* saved chars under cursor */
164 	char		cursor_start;		/* cursor start line # */
165 	char		cursor_end;		/* cursor end line # */
166 	u_short		*mouse_pos;		/* mouse buffer position */
167 	u_short		*mouse_oldpos;		/* mouse old buffer position */
168 	short		mouse_xpos;		/* mouse x coordinate */
169 	short		mouse_ypos;		/* mouse y coordinate */
170 	short		mouse_buttons;		/* mouse buttons */
171 	u_char		mouse_cursor[128];	/* mouse cursor bitmap store */
172 	u_short		*mouse_cut_start;	/* mouse cut start pos */
173 	u_short		*mouse_cut_end;		/* mouse cut end pos */
174 	struct proc 	*mouse_proc;		/* proc* of controlling proc */
175 	pid_t 		mouse_pid;		/* pid of controlling proc */
176 	int		mouse_signal;		/* signal # to report with */
177 	u_short		bell_duration;
178 	u_short		bell_pitch;
179 	u_char		border;			/* border color */
180 	u_char	 	mode;			/* mode */
181 	pid_t 		pid;			/* pid of controlling proc */
182 	struct proc 	*proc;			/* proc* of controlling proc */
183 	struct vt_mode 	smode;			/* switch mode */
184 	u_short		*history;		/* circular history buffer */
185 	u_short		*history_head;		/* current head position */
186 	u_short		*history_pos;		/* position shown on screen */
187 	u_short		*history_save;		/* save area index */
188 	int		history_size;		/* size of history buffer */
189 	struct apmhook  r_hook;			/* reconfiguration support */
190 } scr_stat;
191 
192 typedef struct default_attr {
193 	int             std_color;              /* normal hardware color */
194 	int             rev_color;              /* reverse hardware color */
195 } default_attr;
196 
197 /* misc prototypes used by different syscons related LKM's */
198 void set_border(u_char color);
199 void set_mode(scr_stat *scp);
200 void copy_font(int operation, int font_type, char* font_image);
201 void load_palette(char *palette);
202 int add_scrn_saver(void (*this)(int));
203 int remove_scrn_saver(void (*this)(int));
204 
205 #endif /* !_I386_ISA_SYSCONS_H_ */
206