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