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