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