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