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