Manual merge with Linus
[linux-2.6] / drivers / video / console / fbcon.h
1 /*
2  *  linux/drivers/video/console/fbcon.h -- Low level frame buffer based console driver
3  *
4  *      Copyright (C) 1997 Geert Uytterhoeven
5  *
6  *  This file is subject to the terms and conditions of the GNU General Public
7  *  License.  See the file COPYING in the main directory of this archive
8  *  for more details.
9  */
10
11 #ifndef _VIDEO_FBCON_H
12 #define _VIDEO_FBCON_H
13
14 #include <linux/config.h>
15 #include <linux/types.h>
16 #include <linux/vt_buffer.h>
17 #include <linux/vt_kern.h>
18
19 #include <asm/io.h>
20
21 #define FBCON_FLAGS_INIT         1
22 #define FBCON_FLAGS_CURSOR_TIMER 2
23
24    /*
25     *    This is the interface between the low-level console driver and the
26     *    low-level frame buffer device
27     */
28
29 struct display {
30     /* Filled in by the frame buffer device */
31     u_short inverse;                /* != 0 text black on white as default */
32     /* Filled in by the low-level console driver */
33     u_char *fontdata;
34     int userfont;                   /* != 0 if fontdata kmalloc()ed */
35     u_short scrollmode;             /* Scroll Method */
36     short yscroll;                  /* Hardware scrolling */
37     int vrows;                      /* number of virtual rows */
38     int cursor_shape;
39     u32 xres_virtual;
40     u32 yres_virtual;
41     u32 height;
42     u32 width;
43     u32 bits_per_pixel;
44     u32 grayscale;
45     u32 nonstd;
46     u32 accel_flags;
47     u32 rotate;
48     struct fb_bitfield red;
49     struct fb_bitfield green;
50     struct fb_bitfield blue;
51     struct fb_bitfield transp;
52     struct fb_videomode *mode;
53 };
54
55 struct fbcon_ops {
56         void (*bmove)(struct vc_data *vc, struct fb_info *info, int sy,
57                       int sx, int dy, int dx, int height, int width);
58         void (*clear)(struct vc_data *vc, struct fb_info *info, int sy,
59                       int sx, int height, int width);
60         void (*putcs)(struct vc_data *vc, struct fb_info *info,
61                       const unsigned short *s, int count, int yy, int xx,
62                       int fg, int bg);
63         void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
64                               int bottom_only);
65         void (*cursor)(struct vc_data *vc, struct fb_info *info,
66                        struct display *p, int mode, int softback_lines, int fg, int bg);
67
68         struct timer_list cursor_timer; /* Cursor timer */
69         struct fb_cursor cursor_state;
70         int    currcon;                 /* Current VC. */
71         int    cursor_flash;
72         int    cursor_reset;
73         int    blank_state;
74         int    graphics;
75         int    flags;
76         char  *cursor_data;
77 };
78     /*
79      *  Attribute Decoding
80      */
81
82 /* Color */
83 #define attr_fgcol(fgshift,s)    \
84         (((s) >> (fgshift)) & 0x0f)
85 #define attr_bgcol(bgshift,s)    \
86         (((s) >> (bgshift)) & 0x0f)
87 #define attr_bgcol_ec(bgshift,vc) \
88         ((vc) ? (((vc)->vc_video_erase_char >> (bgshift)) & 0x0f) : 0)
89 #define attr_fgcol_ec(fgshift,vc) \
90         ((vc) ? (((vc)->vc_video_erase_char >> (fgshift)) & 0x0f) : 0)
91
92 /* Monochrome */
93 #define attr_bold(s) \
94         ((s) & 0x200)
95 #define attr_reverse(s) \
96         ((s) & 0x800)
97 #define attr_underline(s) \
98         ((s) & 0x400)
99 #define attr_blink(s) \
100         ((s) & 0x8000)
101         
102 /* Font */
103 #define REFCOUNT(fd)    (((int *)(fd))[-1])
104 #define FNTSIZE(fd)     (((int *)(fd))[-2])
105 #define FNTCHARCNT(fd)  (((int *)(fd))[-3])
106 #define FNTSUM(fd)      (((int *)(fd))[-4])
107 #define FONT_EXTRA_WORDS 4
108
109     /*
110      *  Scroll Method
111      */
112      
113 /* There are several methods fbcon can use to move text around the screen:
114  *
115  *                     Operation   Pan    Wrap
116  *---------------------------------------------
117  * SCROLL_MOVE         copyarea    No     No
118  * SCROLL_PAN_MOVE     copyarea    Yes    No
119  * SCROLL_WRAP_MOVE    copyarea    No     Yes
120  * SCROLL_REDRAW       imageblit   No     No
121  * SCROLL_PAN_REDRAW   imageblit   Yes    No
122  * SCROLL_WRAP_REDRAW  imageblit   No     Yes
123  *
124  * (SCROLL_WRAP_REDRAW is not implemented yet)
125  *
126  * In general, fbcon will choose the best scrolling
127  * method based on the rule below:
128  *
129  * Pan/Wrap > accel imageblit > accel copyarea >
130  * soft imageblit > (soft copyarea)
131  *
132  * Exception to the rule: Pan + accel copyarea is
133  * preferred over Pan + accel imageblit.
134  *
135  * The above is typical for PCI/AGP cards. Unless
136  * overridden, fbcon will never use soft copyarea.
137  *
138  * If you need to override the above rule, set the
139  * appropriate flags in fb_info->flags.  For example,
140  * to prefer copyarea over imageblit, set
141  * FBINFO_READS_FAST.
142  *
143  * Other notes:
144  * + use the hardware engine to move the text
145  *    (hw-accelerated copyarea() and fillrect())
146  * + use hardware-supported panning on a large virtual screen
147  * + amifb can not only pan, but also wrap the display by N lines
148  *    (i.e. visible line i = physical line (i+N) % yres).
149  * + read what's already rendered on the screen and
150  *     write it in a different place (this is cfb_copyarea())
151  * + re-render the text to the screen
152  *
153  * Whether to use wrapping or panning can only be figured out at
154  * runtime (when we know whether our font height is a multiple
155  * of the pan/wrap step)
156  *
157  */
158
159 #define SCROLL_MOVE        0x001
160 #define SCROLL_PAN_MOVE    0x002
161 #define SCROLL_WRAP_MOVE   0x003
162 #define SCROLL_REDRAW      0x004
163 #define SCROLL_PAN_REDRAW  0x005
164
165 #ifdef CONFIG_FB_TILEBLITTING
166 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info,
167                               struct display *p, struct fbcon_ops *ops);
168 #endif
169 extern void fbcon_set_bitops(struct fbcon_ops *ops);
170
171 #endif /* _VIDEO_FBCON_H */