xref: /freebsd/sys/sys/consio.h (revision 38069501)
1 /*-
2  * Copyright (c) 1991-1996 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  * $FreeBSD$
29  */
30 
31 #ifndef	_SYS_CONSIO_H_
32 #define	_SYS_CONSIO_H_
33 
34 #ifndef _KERNEL
35 #include <sys/types.h>
36 #endif
37 #include <sys/ioccom.h>
38 
39 /*
40  * Console ioctl commands.  Some commands are named as KDXXXX, GIO_XXX, and
41  * PIO_XXX, rather than CONS_XXX, for historical and compatibility reasons.
42  * Some other CONS_XXX commands are works as wrapper around frame buffer
43  * ioctl commands FBIO_XXX.  Do not try to change all these commands,
44  * otherwise we shall have compatibility problems.
45  */
46 
47 /* get/set video mode */
48 #define KD_TEXT		0		/* set text mode restore fonts  */
49 #define KD_TEXT0	0		/* ditto			*/
50 #define KD_GRAPHICS	1		/* set graphics mode 		*/
51 #define KD_TEXT1	2		/* set text mode !restore fonts */
52 #define KD_PIXEL	3		/* set pixel mode		*/
53 #define KDGETMODE	_IOR('K', 9, int)
54 #define KDSETMODE	_IOWINT('K', 10)
55 
56 /* set border color */
57 #define KDSBORDER	_IOWINT('K', 13)
58 
59 /* set up raster(pixel) text mode */
60 struct _scr_size {
61 	int		scr_size[3];
62 };
63 typedef struct _scr_size	scr_size_t;
64 
65 #define KDRASTER	_IOW('K', 100, scr_size_t)
66 
67 /* get/set screen char map */
68 struct _scrmap {
69 	char		scrmap[256];
70 };
71 typedef struct _scrmap	scrmap_t;
72 
73 #define GIO_SCRNMAP	_IOR('k', 2, scrmap_t)
74 #define PIO_SCRNMAP	_IOW('k', 3, scrmap_t)
75 
76 /* get the current text attribute */
77 #define GIO_ATTR	_IOR('a', 0, int)
78 
79 /* get the current text color */
80 #define GIO_COLOR	_IOR('c', 0, int)
81 
82 /* get the adapter type (equivalent to FBIO_ADPTYPE) */
83 #define CONS_CURRENT	_IOR('c', 1, int)
84 
85 /* get the current video mode (equivalent to FBIO_GETMODE) */
86 #define CONS_GET	_IOR('c', 2, int)
87 
88 /* not supported? */
89 #define CONS_IO		_IO('c', 3)
90 
91 /* set blank time interval */
92 #define CONS_BLANKTIME	_IOW('c', 4, int)
93 
94 /* set/get the screen saver (these ioctls are current noop) */
95 struct ssaver	{
96 #define MAXSSAVER	16
97 	char		name[MAXSSAVER];
98 	int		num;
99 	long		time;
100 };
101 typedef struct ssaver	ssaver_t;
102 
103 #define CONS_SSAVER	_IOW('c', 5, ssaver_t)
104 #define CONS_GSAVER	_IOWR('c', 6, ssaver_t)
105 
106 /*
107  * Set the text cursor type.
108  *
109  * This is an old interface extended to support the CONS_HIDDEN_CURSOR bit.
110  * New code should use CONS_CURSORSHAPE.  CONS_CURSOR_ATTRS gives the 3
111  * bits supported by the (extended) old interface.  The old interface is
112  * especially unusable for hiding the cursor (even with its extension)
113  * since it changes the cursor on all vtys.
114  */
115 #define CONS_CURSORTYPE	_IOW('c', 7, int)
116 
117 /* set the bell type to audible or visual */
118 #define CONS_VISUAL_BELL (1 << 0)
119 #define CONS_QUIET_BELL	(1 << 1)
120 #define CONS_BELLTYPE	_IOW('c', 8, int)
121 
122 /* set the history (scroll back) buffer size (in lines) */
123 #define CONS_HISTORY	_IOW('c', 9, int)
124 
125 /* clear the history (scroll back) buffer */
126 #define CONS_CLRHIST	_IO('c', 10)
127 
128 /* mouse cursor ioctl */
129 struct mouse_data {
130 	int		x;
131 	int 		y;
132 	int 		z;
133 	int 		buttons;
134 };
135 typedef struct mouse_data mouse_data_t;
136 
137 struct mouse_mode {
138 	int		mode;
139 	int		signal;
140 };
141 typedef struct mouse_mode mouse_mode_t;
142 
143 struct mouse_event {
144 	int		id;			/* one based */
145 	int		value;
146 };
147 typedef struct mouse_event mouse_event_t;
148 
149 struct mouse_info {
150 	int		operation;
151 #define MOUSE_SHOW	0x01
152 #define MOUSE_HIDE	0x02
153 #define MOUSE_MOVEABS	0x03
154 #define MOUSE_MOVEREL	0x04
155 #define MOUSE_GETINFO	0x05
156 #define MOUSE_MODE	0x06
157 #define MOUSE_ACTION	0x07
158 #define MOUSE_MOTION_EVENT	0x08
159 #define MOUSE_BUTTON_EVENT	0x09
160 #define MOUSE_MOUSECHAR	0x0a
161 	union {
162 		mouse_data_t	data;
163 		mouse_mode_t	mode;
164 		mouse_event_t	event;
165 		int		mouse_char;
166 	}		u;
167 };
168 typedef struct mouse_info mouse_info_t;
169 
170 #define CONS_MOUSECTL	_IOWR('c', 10, mouse_info_t)
171 
172 /* see if the vty has been idle */
173 #define CONS_IDLE	_IOR('c', 11, int)
174 
175 /* set the screen saver mode */
176 #define CONS_NO_SAVER	(-1)
177 #define CONS_LKM_SAVER	0
178 #define CONS_USR_SAVER	1
179 #define CONS_SAVERMODE	_IOW('c', 12, int)
180 
181 /* start the screen saver */
182 #define CONS_SAVERSTART	_IOW('c', 13, int)
183 
184 /* set the text cursor shape (see also CONS_CURSORTYPE above) */
185 #define CONS_BLINK_CURSOR	(1 << 0)
186 #define CONS_CHAR_CURSOR	(1 << 1)
187 #define CONS_HIDDEN_CURSOR	(1 << 2)
188 #define CONS_CURSOR_ATTRS	(CONS_BLINK_CURSOR | CONS_CHAR_CURSOR |	\
189 				 CONS_HIDDEN_CURSOR)
190 #define CONS_CHARCURSOR_COLORS	(1 << 26)
191 #define CONS_MOUSECURSOR_COLORS	(1 << 27)
192 #define CONS_DEFAULT_CURSOR	(1 << 28)
193 #define CONS_SHAPEONLY_CURSOR	(1 << 29)
194 #define CONS_RESET_CURSOR	(1 << 30)
195 #define CONS_LOCAL_CURSOR	(1U << 31)
196 struct cshape {
197 	/* shape[0]: flags, shape[1]: base, shape[2]: height */
198 	int		shape[3];
199 };
200 #define CONS_GETCURSORSHAPE _IOWR('c', 14, struct cshape)
201 #define CONS_SETCURSORSHAPE _IOW('c', 15, struct cshape)
202 
203 /* set/get font data */
204 struct fnt8 {
205 	char		fnt8x8[8*256];
206 };
207 typedef struct fnt8	fnt8_t;
208 
209 struct fnt14 {
210 	char		fnt8x14[14*256];
211 };
212 typedef struct fnt14	fnt14_t;
213 
214 struct fnt16 {
215 	char		fnt8x16[16*256];
216 };
217 typedef struct fnt16	fnt16_t;
218 
219 struct vfnt_map {
220 	uint32_t	src;
221 	uint16_t	dst;
222 	uint16_t	len;
223 };
224 typedef struct vfnt_map	vfnt_map_t;
225 
226 #define VFNT_MAP_NORMAL		0
227 #define VFNT_MAP_NORMAL_RIGHT	1
228 #define VFNT_MAP_BOLD		2
229 #define VFNT_MAP_BOLD_RIGHT	3
230 #define VFNT_MAPS		4
231 struct vfnt {
232 	vfnt_map_t	*map[VFNT_MAPS];
233 	uint8_t		*glyphs;
234 	unsigned int	map_count[VFNT_MAPS];
235 	unsigned int	glyph_count;
236 	unsigned int	width;
237 	unsigned int	height;
238 };
239 typedef struct vfnt	vfnt_t;
240 
241 #define PIO_FONT8x8	_IOW('c', 64, fnt8_t)
242 #define GIO_FONT8x8	_IOR('c', 65, fnt8_t)
243 #define PIO_FONT8x14	_IOW('c', 66, fnt14_t)
244 #define GIO_FONT8x14	_IOR('c', 67, fnt14_t)
245 #define PIO_FONT8x16	_IOW('c', 68, fnt16_t)
246 #define GIO_FONT8x16	_IOR('c', 69, fnt16_t)
247 #define PIO_VFONT	_IOW('c', 70, vfnt_t)
248 #define GIO_VFONT	_IOR('c', 71, vfnt_t)
249 #define PIO_VFONT_DEFAULT _IO('c', 72)
250 
251 /* get video mode information */
252 struct colors	{
253 	char		fore;
254 	char		back;
255 };
256 
257 struct vid_info {
258 	short		size;
259 	short		m_num;
260 	u_short		font_size;
261 	u_short		mv_row, mv_col;
262 	u_short		mv_rsz, mv_csz;
263 	u_short		mv_hsz;
264 	struct colors	mv_norm,
265 			mv_rev,
266 			mv_grfc;
267 	u_char		mv_ovscan;
268 	u_char		mk_keylock;
269 };
270 typedef struct vid_info vid_info_t;
271 
272 #define CONS_GETINFO    _IOWR('c', 73, vid_info_t)
273 
274 /* get version */
275 #define CONS_GETVERS	_IOR('c', 74, int)
276 
277 /* get the video adapter index (equivalent to FBIO_ADAPTER) */
278 #define CONS_CURRENTADP	_IOR('c', 100, int)
279 
280 /* get the video adapter information (equivalent to FBIO_ADPINFO) */
281 #define CONS_ADPINFO	_IOWR('c', 101, video_adapter_info_t)
282 
283 /* get the video mode information (equivalent to FBIO_MODEINFO) */
284 #define CONS_MODEINFO	_IOWR('c', 102, video_info_t)
285 
286 /* find a video mode (equivalent to FBIO_FINDMODE) */
287 #define CONS_FINDMODE	_IOWR('c', 103, video_info_t)
288 
289 /* set the frame buffer window origin (equivalent to FBIO_SETWINORG) */
290 #define CONS_SETWINORG	_IOWINT('c', 104)
291 
292 /* use the specified keyboard */
293 #define CONS_SETKBD	_IOWINT('c', 110)
294 
295 /* release the current keyboard */
296 #define CONS_RELKBD	_IO('c', 111)
297 
298 struct scrshot {
299 	int		x;
300 	int		y;
301 	int		xsize;
302 	int		ysize;
303 	u_int16_t*	buf;
304 };
305 typedef struct scrshot scrshot_t;
306 
307 /* Snapshot the current video buffer */
308 #define CONS_SCRSHOT	_IOWR('c', 105, scrshot_t)
309 
310 /* get/set the current terminal emulator info. */
311 #define TI_NAME_LEN	32
312 #define TI_DESC_LEN	64
313 
314 struct term_info {
315 	int		ti_index;
316 	int		ti_flags;
317 	u_char		ti_name[TI_NAME_LEN];
318 	u_char		ti_desc[TI_DESC_LEN];
319 };
320 typedef struct term_info term_info_t;
321 
322 #define CONS_GETTERM	_IOWR('c', 112, term_info_t)
323 #define CONS_SETTERM	_IOW('c', 113, term_info_t)
324 
325 /*
326  * Vty switching ioctl commands.
327  */
328 
329 /* get the next available vty */
330 #define VT_OPENQRY	_IOR('v', 1, int)
331 
332 /* set/get vty switching mode */
333 #ifndef _VT_MODE_DECLARED
334 #define	_VT_MODE_DECLARED
335 struct vt_mode {
336 	char		mode;
337 #define VT_AUTO		0		/* switching is automatic 	*/
338 #define VT_PROCESS	1		/* switching controlled by prog */
339 #define VT_KERNEL	255		/* switching controlled in kernel */
340 	char		waitv;		/* not implemented yet 	SOS	*/
341 	short		relsig;
342 	short		acqsig;
343 	short		frsig;		/* not implemented yet	SOS	*/
344 };
345 typedef struct vt_mode vtmode_t;
346 #endif /* !_VT_MODE_DECLARED */
347 
348 #define VT_SETMODE	_IOW('v', 2, vtmode_t)
349 #define VT_GETMODE	_IOR('v', 3, vtmode_t)
350 
351 /* acknowledge release or acquisition of a vty */
352 #define VT_FALSE	0
353 #define VT_TRUE		1
354 #define VT_ACKACQ	2
355 #define VT_RELDISP	_IOWINT('v', 4)
356 
357 /* activate the specified vty */
358 #define VT_ACTIVATE	_IOWINT('v', 5)
359 
360 /* wait until the specified vty is activate */
361 #define VT_WAITACTIVE	_IOWINT('v', 6)
362 
363 /* get the currently active vty */
364 #define VT_GETACTIVE	_IOR('v', 7, int)
365 
366 /* get the index of the vty */
367 #define VT_GETINDEX	_IOR('v', 8, int)
368 
369 /* prevent switching vtys */
370 #define VT_LOCKSWITCH	_IOW('v', 9, int)
371 
372 /*
373  * Video mode switching ioctl.  See sys/fbio.h for mode numbers.
374  */
375 
376 #define SW_B40x25 	_IO('S', M_B40x25)
377 #define SW_C40x25  	_IO('S', M_C40x25)
378 #define SW_B80x25  	_IO('S', M_B80x25)
379 #define SW_C80x25  	_IO('S', M_C80x25)
380 #define SW_BG320   	_IO('S', M_BG320)
381 #define SW_CG320   	_IO('S', M_CG320)
382 #define SW_BG640   	_IO('S', M_BG640)
383 #define SW_EGAMONO80x25 _IO('S', M_EGAMONO80x25)
384 #define SW_CG320_D    	_IO('S', M_CG320_D)
385 #define SW_CG640_E    	_IO('S', M_CG640_E)
386 #define SW_EGAMONOAPA 	_IO('S', M_EGAMONOAPA)
387 #define SW_CG640x350  	_IO('S', M_CG640x350)
388 #define SW_ENH_MONOAPA2 _IO('S', M_ENHMONOAPA2)
389 #define SW_ENH_CG640  	_IO('S', M_ENH_CG640)
390 #define SW_ENH_B40x25  	_IO('S', M_ENH_B40x25)
391 #define SW_ENH_C40x25  	_IO('S', M_ENH_C40x25)
392 #define SW_ENH_B80x25  	_IO('S', M_ENH_B80x25)
393 #define SW_ENH_C80x25  	_IO('S', M_ENH_C80x25)
394 #define SW_ENH_B80x43  	_IO('S', M_ENH_B80x43)
395 #define SW_ENH_C80x43  	_IO('S', M_ENH_C80x43)
396 #define SW_MCAMODE    	_IO('S', M_MCA_MODE)
397 #define SW_VGA_C40x25	_IO('S', M_VGA_C40x25)
398 #define SW_VGA_C80x25	_IO('S', M_VGA_C80x25)
399 #define SW_VGA_C80x30	_IO('S', M_VGA_C80x30)
400 #define SW_VGA_C80x50	_IO('S', M_VGA_C80x50)
401 #define SW_VGA_C80x60	_IO('S', M_VGA_C80x60)
402 #define SW_VGA_M80x25	_IO('S', M_VGA_M80x25)
403 #define SW_VGA_M80x30	_IO('S', M_VGA_M80x30)
404 #define SW_VGA_M80x50	_IO('S', M_VGA_M80x50)
405 #define SW_VGA_M80x60	_IO('S', M_VGA_M80x60)
406 #define SW_VGA11	_IO('S', M_VGA11)
407 #define SW_BG640x480	_IO('S', M_VGA11)
408 #define SW_VGA12	_IO('S', M_VGA12)
409 #define SW_CG640x480	_IO('S', M_VGA12)
410 #define SW_VGA13	_IO('S', M_VGA13)
411 #define SW_VGA_CG320	_IO('S', M_VGA13)
412 #define SW_VGA_CG640	_IO('S', M_VGA_CG640)
413 #define SW_VGA_MODEX	_IO('S', M_VGA_MODEX)
414 
415 #define SW_VGA_C90x25	_IO('S', M_VGA_C90x25)
416 #define SW_VGA_M90x25	_IO('S', M_VGA_M90x25)
417 #define SW_VGA_C90x30	_IO('S', M_VGA_C90x30)
418 #define SW_VGA_M90x30	_IO('S', M_VGA_M90x30)
419 #define SW_VGA_C90x43	_IO('S', M_VGA_C90x43)
420 #define SW_VGA_M90x43	_IO('S', M_VGA_M90x43)
421 #define SW_VGA_C90x50	_IO('S', M_VGA_C90x50)
422 #define SW_VGA_M90x50	_IO('S', M_VGA_M90x50)
423 #define SW_VGA_C90x60	_IO('S', M_VGA_C90x60)
424 #define SW_VGA_M90x60	_IO('S', M_VGA_M90x60)
425 
426 #define SW_TEXT_80x25	_IO('S', M_TEXT_80x25)
427 #define SW_TEXT_80x30	_IO('S', M_TEXT_80x30)
428 #define SW_TEXT_80x43	_IO('S', M_TEXT_80x43)
429 #define SW_TEXT_80x50	_IO('S', M_TEXT_80x50)
430 #define SW_TEXT_80x60	_IO('S', M_TEXT_80x60)
431 #define SW_TEXT_132x25	_IO('S', M_TEXT_132x25)
432 #define SW_TEXT_132x30	_IO('S', M_TEXT_132x30)
433 #define SW_TEXT_132x43	_IO('S', M_TEXT_132x43)
434 #define SW_TEXT_132x50	_IO('S', M_TEXT_132x50)
435 #define SW_TEXT_132x60	_IO('S', M_TEXT_132x60)
436 
437 #define SW_VESA_CG640x400	_IO('V', M_VESA_CG640x400 - M_VESA_BASE)
438 #define SW_VESA_CG640x480	_IO('V', M_VESA_CG640x480 - M_VESA_BASE)
439 #define SW_VESA_800x600		_IO('V', M_VESA_800x600 - M_VESA_BASE)
440 #define SW_VESA_CG800x600	_IO('V', M_VESA_CG800x600 - M_VESA_BASE)
441 #define SW_VESA_1024x768	_IO('V', M_VESA_1024x768 - M_VESA_BASE)
442 #define SW_VESA_CG1024x768	_IO('V', M_VESA_CG1024x768 - M_VESA_BASE)
443 #define SW_VESA_1280x1024	_IO('V', M_VESA_1280x1024 - M_VESA_BASE)
444 #define SW_VESA_CG1280x1024	_IO('V', M_VESA_CG1280x1024 - M_VESA_BASE)
445 #define SW_VESA_C80x60		_IO('V', M_VESA_C80x60 - M_VESA_BASE)
446 #define SW_VESA_C132x25		_IO('V', M_VESA_C132x25 - M_VESA_BASE)
447 #define SW_VESA_C132x43		_IO('V', M_VESA_C132x43 - M_VESA_BASE)
448 #define SW_VESA_C132x50		_IO('V', M_VESA_C132x50 - M_VESA_BASE)
449 #define SW_VESA_C132x60		_IO('V', M_VESA_C132x60 - M_VESA_BASE)
450 #define SW_VESA_32K_320		_IO('V', M_VESA_32K_320 - M_VESA_BASE)
451 #define SW_VESA_64K_320		_IO('V', M_VESA_64K_320 - M_VESA_BASE)
452 #define SW_VESA_FULL_320	_IO('V', M_VESA_FULL_320 - M_VESA_BASE)
453 #define SW_VESA_32K_640		_IO('V', M_VESA_32K_640 - M_VESA_BASE)
454 #define SW_VESA_64K_640		_IO('V', M_VESA_64K_640 - M_VESA_BASE)
455 #define SW_VESA_FULL_640	_IO('V', M_VESA_FULL_640 - M_VESA_BASE)
456 #define SW_VESA_32K_800		_IO('V', M_VESA_32K_800 - M_VESA_BASE)
457 #define SW_VESA_64K_800		_IO('V', M_VESA_64K_800 - M_VESA_BASE)
458 #define SW_VESA_FULL_800	_IO('V', M_VESA_FULL_800 - M_VESA_BASE)
459 #define SW_VESA_32K_1024	_IO('V', M_VESA_32K_1024 - M_VESA_BASE)
460 #define SW_VESA_64K_1024	_IO('V', M_VESA_64K_1024 - M_VESA_BASE)
461 #define SW_VESA_FULL_1024	_IO('V', M_VESA_FULL_1024 - M_VESA_BASE)
462 #define SW_VESA_32K_1280	_IO('V', M_VESA_32K_1280 - M_VESA_BASE)
463 #define SW_VESA_64K_1280	_IO('V', M_VESA_64K_1280 - M_VESA_BASE)
464 #define SW_VESA_FULL_1280	_IO('V', M_VESA_FULL_1280 - M_VESA_BASE)
465 
466 #endif /* !_SYS_CONSIO_H_ */
467