sys/sys/fbio.h

   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 /*
 116  * RGB offsets as returned by FBIO_GETRGBOFFS.
 117  */
 118 struct fb_rgboffs {
 119         int             red;
 120         int             green;
 121         int             blue;
 122 };
 123
 124 #ifdef  _KERNEL
 125
 126 struct fb_info;
 127
 128 typedef int fb_enter_t(void *priv);
 129 typedef int fb_leave_t(void *priv);
 130 typedef int fb_setblankmode_t(void *priv, int mode);
 131
 132 struct fb_info {
 133         /* Raw copy of fbtype. Do not change. */
 134         int             fb_type;        /* as defined above */
 135         int             fb_height;      /* in pixels */
 136         int             fb_width;       /* in pixels */
 137         int             fb_depth;       /* bits to define color */
 138         int             fb_cmsize;      /* size of color map (entries) */
 139         int             fb_size;        /* total size in bytes */
 140
 141         struct cdev     *fb_cdev;
 142
 143         device_t         fb_fbd_dev;    /* "fbd" device. */
 144         device_t         fb_video_dev;  /* Video adapter. */
 145
 146         fb_enter_t      *enter;
 147         fb_leave_t      *leave;
 148         fb_setblankmode_t *setblankmode;
 149
 150         vm_paddr_t      fb_pbase;       /* For FB mmap. */
 151         vm_offset_t     fb_vbase;       /* if NULL, use fb_write/fb_read. */
 152         void            *fb_priv;       /* First argument for read/write. */
 153         const char      *fb_name;
 154         uint32_t        fb_flags;
 155 #define FB_FLAG_NOMMAP          1       /* mmap unsupported. */
 156 #define FB_FLAG_NOWRITE         2       /* disable writes for the time being */
 157 #define FB_FLAG_MEMATTR         4       /* override memattr for mmap */
 158         vm_memattr_t    fb_memattr;
 159         int             fb_stride;
 160         int             fb_bpp;         /* bits per pixel */
 161         uint32_t        fb_cmap[16];
 162
 163         struct fb_rgboffs fb_rgboffs;   /* RGB offsets */
 164 };
 165
 166 int fbd_list(void);
 167 int fbd_register(struct fb_info *);
 168 int fbd_unregister(struct fb_info *);
 169
 170 static inline int
 171 register_framebuffer(struct fb_info *info)
 172 {
 173
 174         EVENTHANDLER_INVOKE(register_framebuffer, info);
 175         return (0);
 176 }
 177
 178 static inline int
 179 unregister_framebuffer(struct fb_info *info)
 180 {
 181
 182         EVENTHANDLER_INVOKE(unregister_framebuffer, info);
 183         return (0);
 184 }
 185 #endif
 186
 187 /*
 188  * Color map I/O.
 189  */
 190 struct fbcmap {
 191         int     index;          /* first element (0 origin) */
 192         int     count;          /* number of elements */
 193         u_char  *red;           /* red color map elements */
 194         u_char  *green;         /* green color map elements */
 195         u_char  *blue;          /* blue color map elements */
 196 };
 197 #define FBIOPUTCMAP     _IOW('F', 3, struct fbcmap)
 198 #define FBIOGETCMAP     _IOW('F', 4, struct fbcmap)
 199
 200 /* The new style frame buffer ioctls. */
 201
 202 /* video mode information block */
 203 struct video_info {
 204     int                 vi_mode;        /* mode number, see below */
 205     int                 vi_flags;
 206 #define V_INFO_COLOR    (1 << 0)
 207 #define V_INFO_GRAPHICS (1 << 1)
 208 #define V_INFO_LINEAR   (1 << 2)
 209 #define V_INFO_VESA     (1 << 3)
 210 #define V_INFO_NONVGA   (1 << 4)
 211 #define V_INFO_CWIDTH9  (1 << 5)
 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     vm_offset_t         vi_window;      /* physical address */
 219     size_t              vi_window_size;
 220     size_t              vi_window_gran;
 221     vm_offset_t         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     vm_offset_t         vi_registers;   /* physical address */
 240     vm_offset_t         vi_registers_size;
 241 };
 242 typedef struct video_info video_info_t;
 243
 244 /* adapter infromation block */
 245 struct video_adapter {
 246     int                 va_index;
 247     int                 va_type;
 248 #define KD_OTHER        0               /* unknown */
 249 #define KD_MONO         1               /* monochrome adapter */
 250 #define KD_HERCULES     2               /* hercules adapter */
 251 #define KD_CGA          3               /* color graphics adapter */
 252 #define KD_EGA          4               /* enhanced graphics adapter */
 253 #define KD_VGA          5               /* video graphics adapter */
 254 #define KD_TGA          7               /* TGA */
 255 #define KD_TGA2         8               /* TGA2 */
 256     char                *va_name;
 257     int                 va_unit;
 258     int                 va_minor;
 259     int                 va_flags;
 260 #define V_ADP_COLOR     (1 << 0)
 261 #define V_ADP_MODECHANGE (1 << 1)
 262 #define V_ADP_STATESAVE (1 << 2)
 263 #define V_ADP_STATELOAD (1 << 3)
 264 #define V_ADP_FONT      (1 << 4)
 265 #define V_ADP_PALETTE   (1 << 5)
 266 #define V_ADP_BORDER    (1 << 6)
 267 #define V_ADP_VESA      (1 << 7)
 268 #define V_ADP_BOOTDISPLAY (1 << 8)
 269 #define V_ADP_PROBED    (1 << 16)
 270 #define V_ADP_INITIALIZED (1 << 17)
 271 #define V_ADP_REGISTERED (1 << 18)
 272 #define V_ADP_ATTACHED  (1 << 19)
 273 #define V_ADP_DAC8      (1 << 20)
 274 #define V_ADP_CWIDTH9   (1 << 21)
 275     vm_offset_t         va_io_base;
 276     int                 va_io_size;
 277     vm_offset_t         va_crtc_addr;
 278     vm_offset_t         va_mem_base;
 279     int                 va_mem_size;
 280     vm_offset_t         va_window;      /* virtual address */
 281     size_t              va_window_size;
 282     size_t              va_window_gran;
 283     u_int               va_window_orig;
 284     vm_offset_t         va_buffer;      /* virtual address */
 285     size_t              va_buffer_size;
 286     int                 va_initial_mode;
 287     int                 va_initial_bios_mode;
 288     int                 va_mode;
 289     struct video_info   va_info;
 290     int                 va_line_width;
 291     struct {
 292         int             x;
 293         int             y;
 294     }                   va_disp_start;
 295     void                *va_token;
 296     int                 va_model;
 297     int                 va_little_bitian;
 298     int                 va_little_endian;
 299     int                 va_buffer_alias;
 300     vm_offset_t         va_registers;   /* virtual address */
 301     vm_offset_t         va_registers_size;
 302 };
 303 typedef struct video_adapter video_adapter_t;
 304
 305 struct video_adapter_info {
 306     int                 va_index;
 307     int                 va_type;
 308     char                va_name[16];
 309     int                 va_unit;
 310     int                 va_flags;
 311     vm_offset_t         va_io_base;
 312     int                 va_io_size;
 313     vm_offset_t         va_crtc_addr;
 314     vm_offset_t         va_mem_base;
 315     int                 va_mem_size;
 316     vm_offset_t         va_window;      /* virtual address */
 317     size_t              va_window_size;
 318     size_t              va_window_gran;
 319     vm_offset_t         va_unused0;
 320     size_t              va_buffer_size;
 321     int                 va_initial_mode;
 322     int                 va_initial_bios_mode;
 323     int                 va_mode;
 324     int                 va_line_width;
 325     struct {
 326         int             x;
 327         int             y;
 328     }                   va_disp_start;
 329     u_int               va_window_orig;
 330     /* reserved */
 331     u_char              va_reserved[64];
 332 };
 333 typedef struct video_adapter_info video_adapter_info_t;
 334
 335 /* some useful video adapter index */
 336 #define V_ADP_PRIMARY   0
 337 #define V_ADP_SECONDARY 1
 338
 339 /* video mode numbers */
 340
 341 #define M_B40x25        0       /* black & white 40 columns */
 342 #define M_C40x25        1       /* color 40 columns */
 343 #define M_B80x25        2       /* black & white 80 columns */
 344 #define M_C80x25        3       /* color 80 columns */
 345 #define M_BG320         4       /* black & white graphics 320x200 */
 346 #define M_CG320         5       /* color graphics 320x200 */
 347 #define M_BG640         6       /* black & white graphics 640x200 hi-res */
 348 #define M_EGAMONO80x25  7       /* ega-mono 80x25 */
 349 #define M_CG320_D       13      /* ega mode D */
 350 #define M_CG640_E       14      /* ega mode E */
 351 #define M_EGAMONOAPA    15      /* ega mode F */
 352 #define M_CG640x350     16      /* ega mode 10 */
 353 #define M_ENHMONOAPA2   17      /* ega mode F with extended memory */
 354 #define M_ENH_CG640     18      /* ega mode 10* */
 355 #define M_ENH_B40x25    19      /* ega enhanced black & white 40 columns */
 356 #define M_ENH_C40x25    20      /* ega enhanced color 40 columns */
 357 #define M_ENH_B80x25    21      /* ega enhanced black & white 80 columns */
 358 #define M_ENH_C80x25    22      /* ega enhanced color 80 columns */
 359 #define M_VGA_C40x25    23      /* vga 8x16 font on color */
 360 #define M_VGA_C80x25    24      /* vga 8x16 font on color */
 361 #define M_VGA_M80x25    25      /* vga 8x16 font on mono */
 362
 363 #define M_VGA11         26      /* vga 640x480 2 colors */
 364 #define M_BG640x480     26
 365 #define M_VGA12         27      /* vga 640x480 16 colors */
 366 #define M_CG640x480     27
 367 #define M_VGA13         28      /* vga 320x200 256 colors */
 368 #define M_VGA_CG320     28
 369
 370 #define M_VGA_C80x50    30      /* vga 8x8 font on color */
 371 #define M_VGA_M80x50    31      /* vga 8x8 font on color */
 372 #define M_VGA_C80x30    32      /* vga 8x16 font on color */
 373 #define M_VGA_M80x30    33      /* vga 8x16 font on color */
 374 #define M_VGA_C80x60    34      /* vga 8x8 font on color */
 375 #define M_VGA_M80x60    35      /* vga 8x8 font on color */
 376 #define M_VGA_CG640     36      /* vga 640x400 256 color */
 377 #define M_VGA_MODEX     37      /* vga 320x240 256 color */
 378
 379 #define M_VGA_C90x25    40      /* vga 8x16 font on color */
 380 #define M_VGA_M90x25    41      /* vga 8x16 font on mono */
 381 #define M_VGA_C90x30    42      /* vga 8x16 font on color */
 382 #define M_VGA_M90x30    43      /* vga 8x16 font on mono */
 383 #define M_VGA_C90x43    44      /* vga 8x8 font on color */
 384 #define M_VGA_M90x43    45      /* vga 8x8 font on mono */
 385 #define M_VGA_C90x50    46      /* vga 8x8 font on color */
 386 #define M_VGA_M90x50    47      /* vga 8x8 font on mono */
 387 #define M_VGA_C90x60    48      /* vga 8x8 font on color */
 388 #define M_VGA_M90x60    49      /* vga 8x8 font on mono */
 389
 390 #define M_ENH_B80x43    0x70    /* ega black & white 80x43 */
 391 #define M_ENH_C80x43    0x71    /* ega color 80x43 */
 392
 393 #define M_HGC_P0        0xe0    /* hercules graphics - page 0 @ B0000 */
 394 #define M_HGC_P1        0xe1    /* hercules graphics - page 1 @ B8000 */
 395 #define M_MCA_MODE      0xff    /* monochrome adapter mode */
 396
 397 #define M_TEXT_80x25    200     /* generic text modes */
 398 #define M_TEXT_80x30    201
 399 #define M_TEXT_80x43    202
 400 #define M_TEXT_80x50    203
 401 #define M_TEXT_80x60    204
 402 #define M_TEXT_132x25   205
 403 #define M_TEXT_132x30   206
 404 #define M_TEXT_132x43   207
 405 #define M_TEXT_132x50   208
 406 #define M_TEXT_132x60   209
 407
 408 #define M_VESA_BASE             0x100   /* VESA mode number base */
 409 #define M_VESA_CG640x400        0x100   /* 640x400, 256 color */
 410 #define M_VESA_CG640x480        0x101   /* 640x480, 256 color */
 411 #define M_VESA_800x600          0x102   /* 800x600, 16 color */
 412 #define M_VESA_CG800x600        0x103   /* 800x600, 256 color */
 413 #define M_VESA_1024x768         0x104   /* 1024x768, 16 color */
 414 #define M_VESA_CG1024x768       0x105   /* 1024x768, 256 color */
 415 #define M_VESA_1280x1024        0x106   /* 1280x1024, 16 color */
 416 #define M_VESA_CG1280x1024      0x107   /* 1280x1024, 256 color */
 417 #define M_VESA_C80x60           0x108   /* 8x8 font */
 418 #define M_VESA_C132x25          0x109   /* 8x16 font */
 419 #define M_VESA_C132x43          0x10a   /* 8x14 font */
 420 #define M_VESA_C132x50          0x10b   /* 8x8 font */
 421 #define M_VESA_C132x60          0x10c   /* 8x8 font */
 422 #define M_VESA_32K_320          0x10d   /* 320x200, 5:5:5 */
 423 #define M_VESA_64K_320          0x10e   /* 320x200, 5:6:5 */
 424 #define M_VESA_FULL_320         0x10f   /* 320x200, 8:8:8 */
 425 #define M_VESA_32K_640          0x110   /* 640x480, 5:5:5 */
 426 #define M_VESA_64K_640          0x111   /* 640x480, 5:6:5 */
 427 #define M_VESA_FULL_640         0x112   /* 640x480, 8:8:8 */
 428 #define M_VESA_32K_800          0x113   /* 800x600, 5:5:5 */
 429 #define M_VESA_64K_800          0x114   /* 800x600, 5:6:5 */
 430 #define M_VESA_FULL_800         0x115   /* 800x600, 8:8:8 */
 431 #define M_VESA_32K_1024         0x116   /* 1024x768, 5:5:5 */
 432 #define M_VESA_64K_1024         0x117   /* 1024x768, 5:6:5 */
 433 #define M_VESA_FULL_1024        0x118   /* 1024x768, 8:8:8 */
 434 #define M_VESA_32K_1280         0x119   /* 1280x1024, 5:5:5 */
 435 #define M_VESA_64K_1280         0x11a   /* 1280x1024, 5:6:5 */
 436 #define M_VESA_FULL_1280        0x11b   /* 1280x1024, 8:8:8 */
 437 #define M_VESA_MODE_MAX         0x1ff
 438
 439 struct video_display_start {
 440         int             x;
 441         int             y;
 442 };
 443 typedef struct video_display_start video_display_start_t;
 444
 445 struct video_color_palette {
 446         int             index;          /* first element (zero-based) */
 447         int             count;          /* number of elements */
 448         u_char          *red;           /* red */
 449         u_char          *green;         /* green */
 450         u_char          *blue;          /* blue */
 451         u_char          *transparent;   /* may be NULL */
 452 };
 453 typedef struct video_color_palette video_color_palette_t;
 454
 455 /* adapter info. */
 456 #define FBIO_ADAPTER    _IOR('F', 100, int)
 457 #define FBIO_ADPTYPE    _IOR('F', 101, int)
 458 #define FBIO_ADPINFO    _IOR('F', 102, struct video_adapter_info)
 459
 460 /* video mode control */
 461 #define FBIO_MODEINFO   _IOWR('F', 103, struct video_info)
 462 #define FBIO_FINDMODE   _IOWR('F', 104, struct video_info)
 463 #define FBIO_GETMODE    _IOR('F', 105, int)
 464 #define FBIO_SETMODE    _IOW('F', 106, int)
 465
 466 /* get/set frame buffer window origin */
 467 #define FBIO_GETWINORG  _IOR('F', 107, u_int)
 468 #define FBIO_SETWINORG  _IOW('F', 108, u_int)
 469
 470 /* get/set display start address */
 471 #define FBIO_GETDISPSTART       _IOR('F', 109, video_display_start_t)
 472 #define FBIO_SETDISPSTART       _IOW('F', 110, video_display_start_t)
 473
 474 /* get/set scan line width */
 475 #define FBIO_GETLINEWIDTH       _IOR('F', 111, u_int)
 476 #define FBIO_SETLINEWIDTH       _IOW('F', 112, u_int)
 477
 478 /* color palette control */
 479 #define FBIO_GETPALETTE _IOW('F', 113, video_color_palette_t)
 480 #define FBIO_SETPALETTE _IOW('F', 114, video_color_palette_t)
 481
 482 /* blank display */
 483 #define V_DISPLAY_ON            0
 484 #define V_DISPLAY_BLANK         1
 485 #define V_DISPLAY_STAND_BY      2
 486 #define V_DISPLAY_SUSPEND       3
 487
 488 #define FBIO_BLANK      _IOW('F', 115, int)
 489
 490 /* get RGB offsets */
 491 #define FBIO_GETRGBOFFS _IOR('F', 116, struct fb_rgboffs)
 492
 493 #endif /* !_SYS_FBIO_H_ */