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