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