xref: /dragonfly/sys/sys/fbio.h (revision 2cd2d2b5)
1 /*
2  * Copyright (c) 1992, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software developed by the Computer Systems
6  * Engineering group at Lawrence Berkeley Laboratory under DARPA
7  * contract BG 91-66 and contributed to Berkeley.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)fbio.h	8.2 (Berkeley) 10/30/93
38  *
39  * $FreeBSD: src/sys/sys/fbio.h,v 1.9.2.1 2000/05/05 09:16:16 nyan Exp $
40  * $DragonFly: src/sys/sys/fbio.h,v 1.2 2003/06/17 04:28:58 dillon Exp $
41  */
42 
43 #ifndef _SYS_FBIO_H_
44 #define _SYS_FBIO_H_
45 
46 #ifndef _KERNEL
47 #include <sys/types.h>
48 #endif
49 #include <sys/ioccom.h>
50 
51 /*
52  * Frame buffer ioctls (from Sprite, trimmed to essentials for X11).
53  */
54 
55 /*
56  * Frame buffer type codes.
57  */
58 #define	FBTYPE_SUN1BW		0	/* multibus mono */
59 #define	FBTYPE_SUN1COLOR	1	/* multibus color */
60 #define	FBTYPE_SUN2BW		2	/* memory mono */
61 #define	FBTYPE_SUN2COLOR	3	/* color w/rasterop chips */
62 #define	FBTYPE_SUN2GP		4	/* GP1/GP2 */
63 #define	FBTYPE_SUN5COLOR	5	/* RoadRunner accelerator */
64 #define	FBTYPE_SUN3COLOR	6	/* memory color */
65 #define	FBTYPE_MEMCOLOR		7	/* memory 24-bit */
66 #define	FBTYPE_SUN4COLOR	8	/* memory color w/overlay */
67 
68 #define	FBTYPE_NOTSUN1		9	/* reserved for customer */
69 #define	FBTYPE_NOTSUN2		10	/* reserved for customer */
70 #define	FBTYPE_NOTSUN3		11	/* reserved for customer */
71 
72 #define	FBTYPE_SUNFAST_COLOR	12	/* accelerated 8bit */
73 #define	FBTYPE_SUNROP_COLOR	13	/* MEMCOLOR with rop h/w */
74 #define	FBTYPE_SUNFB_VIDEO	14	/* Simple video mixing */
75 #define	FBTYPE_RESERVED5	15	/* reserved, do not use */
76 #define	FBTYPE_RESERVED4	16	/* reserved, do not use */
77 #define	FBTYPE_RESERVED3	17	/* reserved, do not use */
78 #define	FBTYPE_RESERVED2	18	/* reserved, do not use */
79 #define	FBTYPE_RESERVED1	19	/* reserved, do not use */
80 
81 #define	FBTYPE_MDA		20
82 #define	FBTYPE_HERCULES		21
83 #define	FBTYPE_CGA		22
84 #define	FBTYPE_EGA		23
85 #define	FBTYPE_VGA		24
86 #define	FBTYPE_PC98		25
87 #define	FBTYPE_TGA		26
88 
89 #define	FBTYPE_LASTPLUSONE	27	/* max number of fbs (change as add) */
90 
91 /*
92  * Frame buffer descriptor as returned by FBIOGTYPE.
93  */
94 struct fbtype {
95 	int	fb_type;	/* as defined above */
96 	int	fb_height;	/* in pixels */
97 	int	fb_width;	/* in pixels */
98 	int	fb_depth;	/* bits per pixel */
99 	int	fb_cmsize;	/* size of color map (entries) */
100 	int	fb_size;	/* total size in bytes */
101 };
102 #define	FBIOGTYPE	_IOR('F', 0, struct fbtype)
103 
104 #ifdef notdef
105 /*
106  * General purpose structure for passing info in and out of frame buffers
107  * (used for gp1) -- unsupported.
108  */
109 struct fbinfo {
110 	int	fb_physaddr;	/* physical frame buffer address */
111 	int	fb_hwwidth;	/* fb board width */
112 	int	fb_hwheight;	/* fb board height */
113 	int	fb_addrdelta;	/* phys addr diff between boards */
114 	u_char	*fb_ropaddr;	/* fb virtual addr */
115 	int	fb_unit;	/* minor devnum of fb */
116 };
117 #define	FBIOGINFO	_IOR('F', 2, struct fbinfo)
118 #endif
119 
120 /*
121  * Color map I/O.
122  */
123 struct fbcmap {
124 	int	index;		/* first element (0 origin) */
125 	int	count;		/* number of elements */
126 	u_char	*red;		/* red color map elements */
127 	u_char	*green;		/* green color map elements */
128 	u_char	*blue;		/* blue color map elements */
129 };
130 #define	FBIOPUTCMAP	_IOW('F', 3, struct fbcmap)
131 #define	FBIOGETCMAP	_IOW('F', 4, struct fbcmap)
132 
133 /*
134  * Set/get attributes.
135  */
136 #define	FB_ATTR_NDEVSPECIFIC	8	/* no. of device specific values */
137 #define	FB_ATTR_NEMUTYPES	4	/* no. of emulation types */
138 
139 struct fbsattr {
140 	int	flags;			/* flags; see below */
141 	int	emu_type;		/* emulation type (-1 if unused) */
142 	int	dev_specific[FB_ATTR_NDEVSPECIFIC];	/* catchall */
143 };
144 #define	FB_ATTR_AUTOINIT	1	/* emulation auto init flag */
145 #define	FB_ATTR_DEVSPECIFIC	2	/* dev. specific stuff valid flag */
146 
147 struct fbgattr {
148 	int	real_type;		/* real device type */
149 	int	owner;			/* PID of owner, 0 if myself */
150 	struct	fbtype fbtype;		/* fbtype info for real device */
151 	struct	fbsattr sattr;		/* see above */
152 	int	emu_types[FB_ATTR_NEMUTYPES];	/* possible emulations */
153 						/* (-1 if unused) */
154 };
155 /*	FBIOSATTR	_IOW('F', 5, struct fbsattr) -- unsupported */
156 #define	FBIOGATTR	_IOR('F', 6, struct fbgattr)
157 
158 /*
159  * Video control.
160  */
161 #define	FBVIDEO_OFF		0
162 #define	FBVIDEO_ON		1
163 
164 #define	FBIOSVIDEO	_IOW('F', 7, int)
165 #define	FBIOGVIDEO	_IOR('F', 8, int)
166 
167 /*
168  * Hardware cursor control (for, e.g., CG6).  A rather complex and icky
169  * interface that smells like VMS, but there it is....
170  */
171 struct fbcurpos {
172 	short	x;
173 	short	y;
174 };
175 
176 struct fbcursor {
177 	short	set;		/* flags; see below */
178 	short	enable;		/* nonzero => cursor on, 0 => cursor off */
179 	struct	fbcurpos pos;	/* position on display */
180 	struct	fbcurpos hot;	/* hot-spot within cursor */
181 	struct	fbcmap cmap;	/* cursor color map */
182 	struct	fbcurpos size;	/* number of valid bits in image & mask */
183 	caddr_t	image;		/* cursor image bits */
184 	caddr_t	mask;		/* cursor mask bits */
185 };
186 #define	FB_CUR_SETCUR	0x01	/* set on/off (i.e., obey fbcursor.enable) */
187 #define	FB_CUR_SETPOS	0x02	/* set position */
188 #define	FB_CUR_SETHOT	0x04	/* set hot-spot */
189 #define	FB_CUR_SETCMAP	0x08	/* set cursor color map */
190 #define	FB_CUR_SETSHAPE	0x10	/* set size & bits */
191 #define	FB_CUR_SETALL	(FB_CUR_SETCUR | FB_CUR_SETPOS | FB_CUR_SETHOT | \
192 			 FB_CUR_SETCMAP | FB_CUR_SETSHAPE)
193 
194 /* controls for cursor attributes & shape (including position) */
195 #define	FBIOSCURSOR	_IOW('F', 24, struct fbcursor)
196 #define	FBIOGCURSOR	_IOWR('F', 25, struct fbcursor)
197 
198 /* controls for cursor position only */
199 #define	FBIOSCURPOS	_IOW('F', 26, struct fbcurpos)
200 #define	FBIOGCURPOS	_IOW('F', 27, struct fbcurpos)
201 
202 /* get maximum cursor size */
203 #define	FBIOGCURMAX	_IOR('F', 28, struct fbcurpos)
204 
205 /* The new style frame buffer ioctls. */
206 
207 /* video mode information block */
208 struct video_info {
209     int			vi_mode;	/* mode number, see below */
210     int			vi_flags;
211 #define V_INFO_COLOR	(1 << 0)
212 #define V_INFO_GRAPHICS	(1 << 1)
213 #define V_INFO_LINEAR	(1 << 2)
214 #define V_INFO_VESA	(1 << 3)
215     int			vi_width;
216     int			vi_height;
217     int			vi_cwidth;
218     int			vi_cheight;
219     int			vi_depth;
220     int			vi_planes;
221     u_int		vi_window;	/* physical address */
222     size_t		vi_window_size;
223     size_t		vi_window_gran;
224     u_int		vi_buffer;	/* physical address */
225     size_t		vi_buffer_size;
226     int			vi_mem_model;
227 #define V_INFO_MM_OTHER  (-1)
228 #define V_INFO_MM_TEXT	 0
229 #define V_INFO_MM_PLANAR 1
230 #define V_INFO_MM_PACKED 2
231 #define V_INFO_MM_DIRECT 3
232 #define V_INFO_MM_CGA	 100
233 #define V_INFO_MM_HGC	 101
234 #define V_INFO_MM_VGAX	 102
235     /* for MM_PACKED and MM_DIRECT only */
236     int			vi_pixel_size;	/* in bytes */
237     /* for MM_DIRECT only */
238     int			vi_pixel_fields[4];	/* RGB and reserved fields */
239     int			vi_pixel_fsizes[4];
240     /* reserved */
241     u_char		vi_reserved[64];
242 };
243 typedef struct video_info video_info_t;
244 
245 /* adapter infromation block */
246 struct video_adapter {
247     int			va_index;
248     int			va_type;
249 #define KD_OTHER	0		/* unknown */
250 #define KD_MONO		1		/* monochrome adapter */
251 #define KD_HERCULES	2		/* hercules adapter */
252 #define KD_CGA		3		/* color graphics adapter */
253 #define KD_EGA		4		/* enhanced graphics adapter */
254 #define KD_VGA		5		/* video graphics adapter */
255 #define KD_PC98		6		/* PC-98 display */
256 #define KD_TGA		7		/* TGA */
257     char		*va_name;
258     int			va_unit;
259     int			va_minor;
260     int			va_flags;
261 #define V_ADP_COLOR	(1 << 0)
262 #define V_ADP_MODECHANGE (1 << 1)
263 #define V_ADP_STATESAVE	(1 << 2)
264 #define V_ADP_STATELOAD	(1 << 3)
265 #define V_ADP_FONT	(1 << 4)
266 #define V_ADP_PALETTE	(1 << 5)
267 #define V_ADP_BORDER	(1 << 6)
268 #define V_ADP_VESA	(1 << 7)
269 #define V_ADP_PROBED	(1 << 16)
270 #define V_ADP_INITIALIZED (1 << 17)
271 #define V_ADP_REGISTERED (1 << 18)
272     int			va_io_base;
273     int			va_io_size;
274     int			va_crtc_addr;
275     int			va_mem_base;
276     int			va_mem_size;
277     vm_offset_t		va_window;	/* virtual address */
278     size_t		va_window_size;
279     size_t		va_window_gran;
280     u_int		va_window_orig;
281     vm_offset_t		va_buffer;	/* virtual address */
282     size_t		va_buffer_size;
283     int			va_initial_mode;
284     int			va_initial_bios_mode;
285     int			va_mode;
286     struct video_info	va_info;
287     int			va_line_width;
288     struct {
289 	int		x;
290 	int		y;
291     } 			va_disp_start;
292     void		*va_token;
293 };
294 typedef struct video_adapter video_adapter_t;
295 
296 struct video_adapter_info {
297     int			va_index;
298     int			va_type;
299     char		va_name[16];
300     int			va_unit;
301     int			va_flags;
302     int			va_io_base;
303     int			va_io_size;
304     int			va_crtc_addr;
305     int			va_mem_base;
306     int			va_mem_size;
307     u_int		va_window;	/* virtual address */
308     size_t		va_window_size;
309     size_t		va_window_gran;
310     u_int		va_unused0;
311     size_t		va_buffer_size;
312     int			va_initial_mode;
313     int			va_initial_bios_mode;
314     int			va_mode;
315     int			va_line_width;
316     struct {
317 	int		x;
318 	int		y;
319     } 			va_disp_start;
320     u_int		va_window_orig;
321     /* reserved */
322     u_char		va_reserved[64];
323 };
324 typedef struct video_adapter_info video_adapter_info_t;
325 
326 /* some useful video adapter index */
327 #define V_ADP_PRIMARY	0
328 #define V_ADP_SECONDARY	1
329 
330 /* video mode numbers */
331 
332 #define M_B40x25	0	/* black & white 40 columns */
333 #define M_C40x25	1	/* color 40 columns */
334 #define M_B80x25	2	/* black & white 80 columns */
335 #define M_C80x25	3	/* color 80 columns */
336 #define M_BG320		4	/* black & white graphics 320x200 */
337 #define M_CG320		5	/* color graphics 320x200 */
338 #define M_BG640		6	/* black & white graphics 640x200 hi-res */
339 #define M_EGAMONO80x25  7       /* ega-mono 80x25 */
340 #define M_CG320_D	13	/* ega mode D */
341 #define M_CG640_E	14	/* ega mode E */
342 #define M_EGAMONOAPA	15	/* ega mode F */
343 #define M_CG640x350	16	/* ega mode 10 */
344 #define M_ENHMONOAPA2	17	/* ega mode F with extended memory */
345 #define M_ENH_CG640	18	/* ega mode 10* */
346 #define M_ENH_B40x25    19      /* ega enhanced black & white 40 columns */
347 #define M_ENH_C40x25    20      /* ega enhanced color 40 columns */
348 #define M_ENH_B80x25    21      /* ega enhanced black & white 80 columns */
349 #define M_ENH_C80x25    22      /* ega enhanced color 80 columns */
350 #define M_VGA_C40x25	23	/* vga 8x16 font on color */
351 #define M_VGA_C80x25	24	/* vga 8x16 font on color */
352 #define M_VGA_M80x25	25	/* vga 8x16 font on mono */
353 
354 #define M_VGA11		26	/* vga 640x480 2 colors */
355 #define M_BG640x480	26
356 #define M_VGA12		27	/* vga 640x480 16 colors */
357 #define M_CG640x480	27
358 #define M_VGA13		28	/* vga 320x200 256 colors */
359 #define M_VGA_CG320	28
360 
361 #define M_VGA_C80x50	30	/* vga 8x8 font on color */
362 #define M_VGA_M80x50	31	/* vga 8x8 font on color */
363 #define M_VGA_C80x30	32	/* vga 8x16 font on color */
364 #define M_VGA_M80x30	33	/* vga 8x16 font on color */
365 #define M_VGA_C80x60	34	/* vga 8x8 font on color */
366 #define M_VGA_M80x60	35	/* vga 8x8 font on color */
367 #define M_VGA_CG640	36	/* vga 640x400 256 color */
368 #define M_VGA_MODEX	37	/* vga 320x240 256 color */
369 
370 #define M_VGA_C90x25	40	/* vga 8x16 font on color */
371 #define M_VGA_M90x25	41	/* vga 8x16 font on mono */
372 #define M_VGA_C90x30	42	/* vga 8x16 font on color */
373 #define M_VGA_M90x30	43	/* vga 8x16 font on mono */
374 #define M_VGA_C90x43	44	/* vga 8x8 font on color */
375 #define M_VGA_M90x43	45	/* vga 8x8 font on mono */
376 #define M_VGA_C90x50	46	/* vga 8x8 font on color */
377 #define M_VGA_M90x50	47	/* vga 8x8 font on mono */
378 #define M_VGA_C90x60	48	/* vga 8x8 font on color */
379 #define M_VGA_M90x60	49	/* vga 8x8 font on mono */
380 
381 #define M_ENH_B80x43	0x70	/* ega black & white 80x43 */
382 #define M_ENH_C80x43	0x71	/* ega color 80x43 */
383 
384 #define M_PC98_80x25		98	/* PC98 text 80x25 */
385 #define M_PC98_80x30		99	/* PC98 text 80x30 */
386 #define M_PC98_EGC640x400	100	/* PC98 graphic 640x400 16 colors */
387 #define M_PC98_PEGC640x400	101	/* PC98 graphic 640x400 256 colors */
388 #define M_PC98_PEGC640x480	102	/* PC98 graphic 640x480 256 colors */
389 
390 #define M_HGC_P0	0xe0	/* hercules graphics - page 0 @ B0000 */
391 #define M_HGC_P1	0xe1	/* hercules graphics - page 1 @ B8000 */
392 #define M_MCA_MODE	0xff	/* monochrome adapter mode */
393 
394 #define M_TEXT_80x25	200	/* generic text modes */
395 #define M_TEXT_80x30	201
396 #define M_TEXT_80x43	202
397 #define M_TEXT_80x50	203
398 #define M_TEXT_80x60	204
399 #define M_TEXT_132x25	205
400 #define M_TEXT_132x30	206
401 #define M_TEXT_132x43	207
402 #define M_TEXT_132x50	208
403 #define M_TEXT_132x60	209
404 
405 #define M_VESA_BASE		0x100	/* VESA mode number base */
406 #define M_VESA_CG640x400	0x100	/* 640x400, 256 color */
407 #define M_VESA_CG640x480	0x101	/* 640x480, 256 color */
408 #define M_VESA_800x600		0x102	/* 800x600, 16 color */
409 #define M_VESA_CG800x600	0x103	/* 800x600, 256 color */
410 #define M_VESA_1024x768		0x104	/* 1024x768, 16 color */
411 #define M_VESA_CG1024x768	0x105	/* 1024x768, 256 color */
412 #define M_VESA_1280x1024	0x106	/* 1280x1024, 16 color */
413 #define M_VESA_CG1280x1024	0x107	/* 1280x1024, 256 color */
414 #define M_VESA_C80x60		0x108	/* 8x8 font */
415 #define M_VESA_C132x25		0x109	/* 8x16 font */
416 #define M_VESA_C132x43		0x10a	/* 8x14 font */
417 #define M_VESA_C132x50		0x10b	/* 8x8 font */
418 #define M_VESA_C132x60		0x10c	/* 8x8 font */
419 #define M_VESA_32K_320		0x10d	/* 320x200, 5:5:5 */
420 #define M_VESA_64K_320		0x10e	/* 320x200, 5:6:5 */
421 #define M_VESA_FULL_320		0x10f	/* 320x200, 8:8:8 */
422 #define M_VESA_32K_640		0x110	/* 640x480, 5:5:5 */
423 #define M_VESA_64K_640		0x111	/* 640x480, 5:6:5 */
424 #define M_VESA_FULL_640		0x112	/* 640x480, 8:8:8 */
425 #define M_VESA_32K_800		0x113	/* 800x600, 5:5:5 */
426 #define M_VESA_64K_800		0x114	/* 800x600, 5:6:5 */
427 #define M_VESA_FULL_800		0x115	/* 800x600, 8:8:8 */
428 #define M_VESA_32K_1024		0x116	/* 1024x768, 5:5:5 */
429 #define M_VESA_64K_1024		0x117	/* 1024x768, 5:6:5 */
430 #define M_VESA_FULL_1024	0x118	/* 1024x768, 8:8:8 */
431 #define M_VESA_32K_1280		0x119	/* 1280x1024, 5:5:5 */
432 #define M_VESA_64K_1280		0x11a	/* 1280x1024, 5:6:5 */
433 #define M_VESA_FULL_1280	0x11b	/* 1280x1024, 8:8:8 */
434 #define M_VESA_MODE_MAX		0x1ff
435 
436 struct video_display_start {
437 	int		x;
438 	int		y;
439 };
440 typedef struct video_display_start video_display_start_t;
441 
442 struct video_color_palette {
443 	int		index;		/* first element (zero-based) */
444 	int		count;		/* number of elements */
445 	u_char		*red;		/* red */
446 	u_char		*green;		/* green */
447 	u_char		*blue;		/* blue */
448 	u_char		*transparent;	/* may be NULL */
449 };
450 typedef struct video_color_palette video_color_palette_t;
451 
452 /* adapter info. */
453 #define FBIO_ADAPTER	_IOR('F', 100, int)
454 #define FBIO_ADPTYPE	_IOR('F', 101, int)
455 #define FBIO_ADPINFO	_IOR('F', 102, struct video_adapter_info)
456 
457 /* video mode control */
458 #define FBIO_MODEINFO	_IOWR('F', 103, struct video_info)
459 #define FBIO_FINDMODE	_IOWR('F', 104, struct video_info)
460 #define FBIO_GETMODE	_IOR('F', 105, int)
461 #define FBIO_SETMODE	_IOW('F', 106, int)
462 
463 /* get/set frame buffer window origin */
464 #define FBIO_GETWINORG	_IOR('F', 107, u_int)
465 #define FBIO_SETWINORG	_IOW('F', 108, u_int)
466 
467 /* get/set display start address */
468 #define FBIO_GETDISPSTART	_IOR('F', 109, video_display_start_t)
469 #define FBIO_SETDISPSTART	_IOW('F', 110, video_display_start_t)
470 
471 /* get/set scan line width */
472 #define FBIO_GETLINEWIDTH	_IOR('F', 111, u_int)
473 #define FBIO_SETLINEWIDTH	_IOW('F', 112, u_int)
474 
475 /* color palette control */
476 #define FBIO_GETPALETTE	_IOW('F', 113, video_color_palette_t)
477 #define FBIO_SETPALETTE	_IOW('F', 114, video_color_palette_t)
478 
479 #endif /* !_SYS_FBIO_H_ */
480