include/linux/fb.h

   1 #ifndef _LINUX_FB_H
   2 #define _LINUX_FB_H
   3
   4 #include <asm/types.h>
   5
   6 /* Definitions of frame buffers                                         */
   7
   8 #define FB_MAJOR        29
   9
  10 #define FB_MODES_SHIFT          5       /* 32 modes per framebuffer */
  11 #define FB_NUM_MINORS           256     /* 256 Minors               */
  12 #define FB_MAX                  (FB_NUM_MINORS / (1 << FB_MODES_SHIFT))
  13 #define GET_FB_IDX(node)        (MINOR(node) >> FB_MODES_SHIFT)
  14
  15 /* ioctls
  16    0x46 is 'F'                                                          */
  17 #define FBIOGET_VSCREENINFO     0x4600
  18 #define FBIOPUT_VSCREENINFO     0x4601
  19 #define FBIOGET_FSCREENINFO     0x4602
  20 #define FBIOGETCMAP             0x4604
  21 #define FBIOPUTCMAP             0x4605
  22 #define FBIOPAN_DISPLAY         0x4606
  23 /* 0x4607-0x460B are defined below */
  24 /* #define FBIOGET_MONITORSPEC  0x460C */
  25 /* #define FBIOPUT_MONITORSPEC  0x460D */
  26 /* #define FBIOSWITCH_MONIBIT   0x460E */
  27 #define FBIOGET_CON2FBMAP       0x460F
  28 #define FBIOPUT_CON2FBMAP       0x4610
  29
  30 #define FB_TYPE_PACKED_PIXELS           0       /* Packed Pixels        */
  31 #define FB_TYPE_PLANES                  1       /* Non interleaved planes */
  32 #define FB_TYPE_INTERLEAVED_PLANES      2       /* Interleaved planes   */
  33 #define FB_TYPE_TEXT                    3       /* Text/attributes      */
  34 #define FB_TYPE_VGA_PLANES              4       /* EGA/VGA planes       */
  35
  36 #define FB_AUX_TEXT_MDA         0       /* Monochrome text */
  37 #define FB_AUX_TEXT_CGA         1       /* CGA/EGA/VGA Color text */
  38 #define FB_AUX_TEXT_S3_MMIO     2       /* S3 MMIO fasttext */
  39 #define FB_AUX_TEXT_MGA_STEP16  3       /* MGA Millenium I: text, attr, 14 reserved bytes */
  40 #define FB_AUX_TEXT_MGA_STEP8   4       /* other MGAs:      text, attr,  6 reserved bytes */
  41
  42 #define FB_VISUAL_MONO01                0       /* Monochr. 1=Black 0=White */
  43 #define FB_VISUAL_MONO10                1       /* Monochr. 1=White 0=Black */
  44 #define FB_VISUAL_TRUECOLOR             2       /* True color   */
  45 #define FB_VISUAL_PSEUDOCOLOR           3       /* Pseudo color (like atari) */
  46 #define FB_VISUAL_DIRECTCOLOR           4       /* Direct color */
  47 #define FB_VISUAL_STATIC_PSEUDOCOLOR    5       /* Pseudo color readonly */
  48
  49 #define FB_ACCEL_NONE           0       /* no hardware accelerator      */
  50 #define FB_ACCEL_ATARIBLITT     1       /* Atari Blitter                */
  51 #define FB_ACCEL_AMIGABLITT     2       /* Amiga Blitter                */
  52 #define FB_ACCEL_S3_TRIO64      3       /* Cybervision64 (S3 Trio64)    */
  53 #define FB_ACCEL_NCR_77C32BLT   4       /* RetinaZ3 (NCR 77C32BLT)      */
  54 #define FB_ACCEL_S3_VIRGE       5       /* Cybervision64/3D (S3 ViRGE)  */
  55 #define FB_ACCEL_ATI_MACH64GX   6       /* ATI Mach 64GX family         */
  56 #define FB_ACCEL_DEC_TGA        7       /* DEC 21030 TGA                */
  57 #define FB_ACCEL_ATI_MACH64CT   8       /* ATI Mach 64CT family         */
  58 #define FB_ACCEL_ATI_MACH64VT   9       /* ATI Mach 64CT family VT class */
  59 #define FB_ACCEL_ATI_MACH64GT   10      /* ATI Mach 64CT family GT class */
  60 #define FB_ACCEL_SUN_CREATOR    11      /* Sun Creator/Creator3D        */
  61 #define FB_ACCEL_SUN_CGSIX      12      /* Sun cg6                      */
  62 #define FB_ACCEL_SUN_LEO        13      /* Sun leo/zx                   */
  63 #define FB_ACCEL_IMS_TWINTURBO  14      /* IMS Twin Turbo               */
  64 #define FB_ACCEL_3DLABS_PERMEDIA2 15    /* 3Dlabs Permedia 2            */
  65 #define FB_ACCEL_MATROX_MGA2064W 16     /* Matrox MGA2064W (Millenium)  */
  66 #define FB_ACCEL_MATROX_MGA1064SG 17    /* Matrox MGA1064SG (Mystique)  */
  67 #define FB_ACCEL_MATROX_MGA2164W 18     /* Matrox MGA2164W (Millenium II) */
  68 #define FB_ACCEL_MATROX_MGA2164W_AGP 19 /* Matrox MGA2164W (Millenium II) */
  69 #define FB_ACCEL_MATROX_MGAG100 20      /* Matrox G100 (Productiva G100) */
  70 #define FB_ACCEL_MATROX_MGAG200 21      /* Matrox G200 (Myst, Mill, ...) */
  71 #define FB_ACCEL_SUN_CG14       22      /* Sun cgfourteen                */
  72 #define FB_ACCEL_SUN_BWTWO      23      /* Sun bwtwo                     */
  73 #define FB_ACCEL_SUN_CGTHREE    24      /* Sun cgthree                   */
  74 #define FB_ACCEL_SUN_TCX        25      /* Sun tcx                       */
  75
  76 struct fb_fix_screeninfo {
  77         char id[16];                    /* identification string eg "TT Builtin" */
  78         char *smem_start;               /* Start of frame buffer mem */
  79                                         /* (physical address) */
  80         __u32 smem_len;                 /* Length of frame buffer mem */
  81         __u32 type;                     /* see FB_TYPE_*                */
  82         __u32 type_aux;                 /* Interleave for interleaved Planes */
  83         __u32 visual;                   /* see FB_VISUAL_*              */
  84         __u16 xpanstep;                 /* zero if no hardware panning  */
  85         __u16 ypanstep;                 /* zero if no hardware panning  */
  86         __u16 ywrapstep;                /* zero if no hardware ywrap    */
  87         __u32 line_length;              /* length of a line in bytes    */
  88         char *mmio_start;               /* Start of Memory Mapped I/O   */
  89                                         /* (physical address) */
  90         __u32 mmio_len;                 /* Length of Memory Mapped I/O  */
  91         __u32 accel;                    /* Type of acceleration available */
  92         __u16 reserved[3];              /* Reserved for future compatibility */
  93 };
  94
  95 /* Interpretation of offset for color fields: All offsets are from the right,
  96  * inside a "pixel" value, which is exactly 'bits_per_pixel' wide (means: you
  97  * can use the offset as right argument to <<). A pixel afterwards is a bit
  98  * stream and is written to video memory as that unmodified. This implies
  99  * big-endian byte order if bits_per_pixel is greater than 8.
 100  */
 101 struct fb_bitfield {
 102         __u32 offset;                   /* beginning of bitfield        */
 103         __u32 length;                   /* length of bitfield           */
 104         __u32 msb_right;                /* != 0 : Most significant bit is */
 105                                         /* right */
 106 };
 107
 108 #define FB_NONSTD_HAM           1       /* Hold-And-Modify (HAM)        */
 109
 110 #define FB_ACTIVATE_NOW         0       /* set values immediately (or vbl)*/
 111 #define FB_ACTIVATE_NXTOPEN     1       /* activate on next open        */
 112 #define FB_ACTIVATE_TEST        2       /* don't set, round up impossible */
 113 #define FB_ACTIVATE_MASK       15
 114                                         /* values                       */
 115 #define FB_ACTIVATE_VBL        16       /* activate values on next vbl  */
 116 #define FB_CHANGE_CMAP_VBL     32       /* change colormap on vbl       */
 117 #define FB_ACTIVATE_ALL        64       /* change all VCs on this fb    */
 118
 119 #define FB_ACCELF_TEXT          1       /* text mode acceleration */
 120
 121 #define FB_SYNC_HOR_HIGH_ACT    1       /* horizontal sync high active  */
 122 #define FB_SYNC_VERT_HIGH_ACT   2       /* vertical sync high active    */
 123 #define FB_SYNC_EXT             4       /* external sync                */
 124 #define FB_SYNC_COMP_HIGH_ACT   8       /* composite sync high active   */
 125 #define FB_SYNC_BROADCAST       16      /* broadcast video timings      */
 126                                         /* vtotal = 144d/288n/576i => PAL  */
 127                                         /* vtotal = 121d/242n/484i => NTSC */
 128 #define FB_SYNC_ON_GREEN        32      /* sync on green */
 129
 130 #define FB_VMODE_NONINTERLACED  0       /* non interlaced */
 131 #define FB_VMODE_INTERLACED     1       /* interlaced   */
 132 #define FB_VMODE_DOUBLE         2       /* double scan */
 133 #define FB_VMODE_MASK           255
 134
 135 #define FB_VMODE_YWRAP          256     /* ywrap instead of panning     */
 136 #define FB_VMODE_SMOOTH_XPAN    512     /* smooth xpan possible (internally used) */
 137 #define FB_VMODE_CONUPDATE      512     /* don't update x/yoffset       */
 138
 139 struct fb_var_screeninfo {
 140         __u32 xres;                     /* visible resolution           */
 141         __u32 yres;
 142         __u32 xres_virtual;             /* virtual resolution           */
 143         __u32 yres_virtual;
 144         __u32 xoffset;                  /* offset from virtual to visible */
 145         __u32 yoffset;                  /* resolution                   */
 146
 147         __u32 bits_per_pixel;           /* guess what                   */
 148         __u32 grayscale;                /* != 0 Graylevels instead of colors */
 149
 150         struct fb_bitfield red;         /* bitfield in fb mem if true color, */
 151         struct fb_bitfield green;       /* else only length is significant */
 152         struct fb_bitfield blue;
 153         struct fb_bitfield transp;      /* transparency                 */
 154
 155         __u32 nonstd;                   /* != 0 Non standard pixel format */
 156
 157         __u32 activate;                 /* see FB_ACTIVATE_*            */
 158
 159         __u32 height;                   /* height of picture in mm    */
 160         __u32 width;                    /* width of picture in mm     */
 161
 162         __u32 accel_flags;              /* acceleration flags (hints)   */
 163
 164         /* Timing: All values in pixclocks, except pixclock (of course) */
 165         __u32 pixclock;                 /* pixel clock in ps (pico seconds) */
 166         __u32 left_margin;              /* time from sync to picture    */
 167         __u32 right_margin;             /* time from picture to sync    */
 168         __u32 upper_margin;             /* time from sync to picture    */
 169         __u32 lower_margin;
 170         __u32 hsync_len;                /* length of horizontal sync    */
 171         __u32 vsync_len;                /* length of vertical sync      */
 172         __u32 sync;                     /* see FB_SYNC_*                */
 173         __u32 vmode;                    /* see FB_VMODE_*               */
 174         __u32 reserved[6];              /* Reserved for future compatibility */
 175 };
 176
 177 struct fb_cmap {
 178         __u32 start;                    /* First entry  */
 179         __u32 len;                      /* Number of entries */
 180         __u16 *red;                     /* Red values   */
 181         __u16 *green;
 182         __u16 *blue;
 183         __u16 *transp;                  /* transparency, can be NULL */
 184 };
 185
 186 struct fb_con2fbmap {
 187         __u32 console;
 188         __u32 framebuffer;
 189 };
 190
 191 struct fb_monspecs {
 192         __u32 hfmin;                    /* hfreq lower limit (Hz) */
 193         __u32 hfmax;                    /* hfreq upper limit (Hz) */
 194         __u16 vfmin;                    /* vfreq lower limit (Hz) */
 195         __u16 vfmax;                    /* vfreq upper limit (Hz) */
 196         unsigned dpms : 1;              /* supports DPMS */
 197 };
 198
 199 #ifdef __KERNEL__
 200
 201 #include <linux/fs.h>
 202
 203
 204 struct fb_info;
 205 struct fb_info_gen;
 206 struct vm_area_struct;
 207 struct file;
 208
 209     /*
 210      *  Frame buffer operations
 211      */
 212
 213 struct fb_ops {
 214     /* open/release and usage marking */
 215     int (*fb_open)(struct fb_info *info, int user);
 216     int (*fb_release)(struct fb_info *info, int user);
 217     /* get non settable parameters */
 218     int (*fb_get_fix)(struct fb_fix_screeninfo *fix, int con,
 219                       struct fb_info *info);
 220     /* get settable parameters */
 221     int (*fb_get_var)(struct fb_var_screeninfo *var, int con,
 222                       struct fb_info *info);
 223     /* set settable parameters */
 224     int (*fb_set_var)(struct fb_var_screeninfo *var, int con,
 225                       struct fb_info *info);
 226     /* get colormap */
 227     int (*fb_get_cmap)(struct fb_cmap *cmap, int kspc, int con,
 228                        struct fb_info *info);
 229     /* set colormap */
 230     int (*fb_set_cmap)(struct fb_cmap *cmap, int kspc, int con,
 231                        struct fb_info *info);
 232     /* pan display */
 233     int (*fb_pan_display)(struct fb_var_screeninfo *var, int con,
 234                           struct fb_info *info);
 235     /* perform fb specific ioctl */
 236     int (*fb_ioctl)(struct inode *inode, struct file *file, unsigned int cmd,
 237                     unsigned long arg, int con, struct fb_info *info);
 238     /* perform fb specific mmap */
 239     int (*fb_mmap)(struct fb_info *info, struct file *file, struct vm_area_struct *vma);
 240     /* switch to/from raster image mode */
 241     int (*fb_rasterimg)(struct fb_info *info, int start);
 242 };
 243
 244
 245    /*
 246     *    This is the interface between the low-level console driver and the
 247     *    low-level frame buffer device
 248     */
 249
 250 struct display {
 251     /* Filled in by the frame buffer device */
 252
 253     struct fb_var_screeninfo var;   /* variable infos. yoffset and vmode */
 254                                     /* are updated by fbcon.c */
 255     struct fb_cmap cmap;            /* colormap */
 256     char *screen_base;              /* pointer to top of virtual screen */
 257                                     /* (virtual address) */
 258     int visual;
 259     int type;                       /* see FB_TYPE_* */
 260     int type_aux;                   /* Interleave for interleaved Planes */
 261     u_short ypanstep;               /* zero if no hardware ypan */
 262     u_short ywrapstep;              /* zero if no hardware ywrap */
 263     u_long line_length;             /* length of a line in bytes */
 264     u_short can_soft_blank;         /* zero if no hardware blanking */
 265     u_short inverse;                /* != 0 text black on white as default */
 266     struct display_switch *dispsw;  /* low level operations */
 267     void *dispsw_data;              /* optional dispsw helper data */
 268
 269 #if 0
 270     struct fb_fix_cursorinfo fcrsr;
 271     struct fb_var_cursorinfo *vcrsr;
 272     struct fb_cursorstate crsrstate;
 273 #endif
 274
 275     /* Filled in by the low-level console driver */
 276
 277     struct vc_data *conp;           /* pointer to console data */
 278     struct fb_info *fb_info;        /* frame buffer for this console */
 279     int vrows;                      /* number of virtual rows */
 280     unsigned short cursor_x;        /* current cursor position */
 281     unsigned short cursor_y;
 282     int fgcol;                      /* text colors */
 283     int bgcol;
 284     u_long next_line;               /* offset to one line below */
 285     u_long next_plane;              /* offset to next plane */
 286     u_char *fontdata;               /* Font associated to this display */
 287     unsigned short _fontheightlog;
 288     unsigned short _fontwidthlog;
 289     unsigned short _fontheight;
 290     unsigned short _fontwidth;
 291     int userfont;                   /* != 0 if fontdata kmalloc()ed */
 292     u_short scrollmode;             /* Scroll Method */
 293     short yscroll;                  /* Hardware scrolling */
 294     unsigned char fgshift, bgshift;
 295     unsigned short charmask;        /* 0xff or 0x1ff */
 296 };
 297
 298
 299 struct fb_info {
 300    char modename[40];                   /* default video mode */
 301    kdev_t node;
 302    int flags;
 303 #define FBINFO_FLAG_MODULE      1       /* Low-level driver is a module */
 304    struct fb_ops *fbops;
 305    struct fb_monspecs monspecs;
 306    struct display *disp;                /* initial display variable */
 307    struct vc_data *display_fg;          /* Console visible on this display */
 308    char fontname[40];                   /* default font name */
 309    int (*changevar)(int);               /* tell console var has changed */
 310    int (*switch_con)(int, struct fb_info*);
 311                                         /* tell fb to switch consoles */
 312    int (*updatevar)(int, struct fb_info*);
 313                                         /* tell fb to update the vars */
 314    void (*blank)(int, struct fb_info*); /* tell fb to (un)blank the screen */
 315                                         /* arg = 0: unblank */
 316                                         /* arg > 0: VESA level (arg-1) */
 317
 318    /* From here on everything is device dependent */
 319 };
 320
 321 #ifdef MODULE
 322 #define FBINFO_FLAG_DEFAULT     FBINFO_FLAG_MODULE
 323 #else
 324 #define FBINFO_FLAG_DEFAULT     0
 325 #endif
 326
 327     /*
 328      *  This structure abstracts from the underlying hardware. It is not
 329      *  mandatory but used by the `generic' frame buffer operations.
 330      *  Read drivers/video/skeletonfb.c for more information.
 331      */
 332
 333 struct fbgen_hwswitch {
 334     void (*detect)(void);
 335     int (*encode_fix)(struct fb_fix_screeninfo *fix, const void *par,
 336                       struct fb_info_gen *info);
 337     int (*decode_var)(const struct fb_var_screeninfo *var, void *par,
 338                       struct fb_info_gen *info);
 339     int (*encode_var)(struct fb_var_screeninfo *var, const void *par,
 340                       struct fb_info_gen *info);
 341     void (*get_par)(void *par, struct fb_info_gen *info);
 342     void (*set_par)(const void *par, struct fb_info_gen *info);
 343     int (*getcolreg)(unsigned regno, unsigned *red, unsigned *green,
 344                      unsigned *blue, unsigned *transp, struct fb_info *info);
 345     int (*setcolreg)(unsigned regno, unsigned red, unsigned green,
 346                      unsigned blue, unsigned transp, struct fb_info *info);
 347     int (*pan_display)(const struct fb_var_screeninfo *var,
 348                        struct fb_info_gen *info);
 349     int (*blank)(int blank_mode, struct fb_info_gen *info);
 350     void (*set_disp)(const void *par, struct display *disp,
 351                      struct fb_info_gen *info);
 352 };
 353
 354 struct fb_info_gen {
 355     struct fb_info info;
 356
 357     /* Entries for a generic frame buffer device */
 358     /* Yes, this starts looking like C++ */
 359     u_int parsize;
 360     struct fbgen_hwswitch *fbhw;
 361
 362    /* From here on everything is device dependent */
 363 };
 364
 365     /*
 366      *  `Generic' versions of the frame buffer device operations
 367      */
 368
 369 extern int fbgen_get_fix(struct fb_fix_screeninfo *fix, int con,
 370                          struct fb_info *info);
 371 extern int fbgen_get_var(struct fb_var_screeninfo *var, int con,
 372                          struct fb_info *info);
 373 extern int fbgen_set_var(struct fb_var_screeninfo *var, int con,
 374                          struct fb_info *info);
 375 extern int fbgen_get_cmap(struct fb_cmap *cmap, int kspc, int con,
 376                           struct fb_info *info);
 377 extern int fbgen_set_cmap(struct fb_cmap *cmap, int kspc, int con,
 378                           struct fb_info *info);
 379 extern int fbgen_pan_display(struct fb_var_screeninfo *var, int con,
 380                              struct fb_info *info);
 381 extern int fbgen_ioctl(struct inode *inode, struct file *file,
 382                        unsigned int cmd, unsigned long arg, int con,
 383                        struct fb_info *info);
 384
 385     /*
 386      *  Helper functions
 387      */
 388
 389 extern int fbgen_do_set_var(struct fb_var_screeninfo *var, int isactive,
 390                             struct fb_info_gen *info);
 391 extern void fbgen_set_disp(int con, struct fb_info_gen *info);
 392 extern void fbgen_install_cmap(int con, struct fb_info_gen *info);
 393 extern int fbgen_update_var(int con, struct fb_info *info);
 394 extern int fbgen_switch(int con, struct fb_info *info);
 395 extern void fbgen_blank(int blank, struct fb_info *info);
 396
 397
 398 struct fb_videomode {
 399     const char *name;
 400     struct fb_var_screeninfo var;
 401 };
 402
 403
 404 /* drivers/char/fbmem.c */
 405 extern int register_framebuffer(struct fb_info *fb_info);
 406 extern int unregister_framebuffer(const struct fb_info *fb_info);
 407 extern int fbmon_valid_timings(u_int pixclock, u_int htotal, u_int vtotal,
 408                                const struct fb_info *fb_info);
 409 extern int fbmon_dpms(const struct fb_info *fb_info);
 410
 411
 412 extern int num_registered_fb;
 413 extern struct fb_info *registered_fb[FB_MAX];
 414 extern char con2fb_map[MAX_NR_CONSOLES];
 415
 416 /* drivers/video/fbcon.c */
 417 extern struct display fb_display[MAX_NR_CONSOLES];
 418
 419 /* drivers/video/fbcmap.c */
 420 extern int fb_alloc_cmap(struct fb_cmap *cmap, int len, int transp);
 421 extern void fb_copy_cmap(struct fb_cmap *from, struct fb_cmap *to,
 422                          int fsfromto);
 423 extern int fb_get_cmap(struct fb_cmap *cmap, int kspc,
 424                        int (*getcolreg)(u_int, u_int *, u_int *, u_int *,
 425                                         u_int *, struct fb_info *),
 426                        struct fb_info *fb_info);
 427 extern int fb_set_cmap(struct fb_cmap *cmap, int kspc,
 428                        int (*setcolreg)(u_int, u_int, u_int, u_int, u_int,
 429                                         struct fb_info *),
 430                        struct fb_info *fb_info);
 431 extern struct fb_cmap *fb_default_cmap(int len);
 432 extern void fb_invert_cmaps(void);
 433
 434 /* VESA Blanking Levels */
 435 #define VESA_NO_BLANKING        0
 436 #define VESA_VSYNC_SUSPEND      1
 437 #define VESA_HSYNC_SUSPEND      2
 438 #define VESA_POWERDOWN          3
 439
 440 #endif /* __KERNEL__ */
 441
 442 #if 1
 443
 444 #define FBCMD_GET_CURRENTPAR    0xDEAD0005
 445 #define FBCMD_SET_CURRENTPAR    0xDEAD8005
 446
 447 #endif
 448
 449
 450 #if 1 /* Preliminary */
 451
 452    /*
 453     *    Hardware Cursor
 454     */
 455
 456 #define FBIOGET_FCURSORINFO     0x4607
 457 #define FBIOGET_VCURSORINFO     0x4608
 458 #define FBIOPUT_VCURSORINFO     0x4609
 459 #define FBIOGET_CURSORSTATE     0x460A
 460 #define FBIOPUT_CURSORSTATE     0x460B
 461
 462
 463 struct fb_fix_cursorinfo {
 464         __u16 crsr_width;               /* width and height of the cursor in */
 465         __u16 crsr_height;              /* pixels (zero if no cursor)   */
 466         __u16 crsr_xsize;               /* cursor size in display pixels */
 467         __u16 crsr_ysize;
 468         __u16 crsr_color1;              /* colormap entry for cursor color1 */
 469         __u16 crsr_color2;              /* colormap entry for cursor color2 */
 470 };
 471
 472 struct fb_var_cursorinfo {
 473         __u16 width;
 474         __u16 height;
 475         __u16 xspot;
 476         __u16 yspot;
 477         __u8 data[1];                   /* field with [height][width]        */
 478 };
 479
 480 struct fb_cursorstate {
 481         __s16 xoffset;
 482         __s16 yoffset;
 483         __u16 mode;
 484 };
 485
 486 #define FB_CURSOR_OFF           0
 487 #define FB_CURSOR_ON            1
 488 #define FB_CURSOR_FLASH         2
 489
 490 #endif /* Preliminary */
 491
 492 #endif /* _LINUX_FB_H */