fbcon: fix color generation for monochrome framebuffer
[linux-2.6.git] / 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/types.h>
15 #include <linux/vt_buffer.h>
16 #include <linux/vt_kern.h>
17
18 #include <asm/io.h>
19
20 #define FBCON_FLAGS_INIT         1
21 #define FBCON_FLAGS_CURSOR_TIMER 2
22
23    /*
24     *    This is the interface between the low-level console driver and the
25     *    low-level frame buffer device
26     */
27
28 struct display {
29     /* Filled in by the low-level console driver */
30     const u_char *fontdata;
31     int userfont;                   /* != 0 if fontdata kmalloc()ed */
32     u_short scrollmode;             /* Scroll Method */
33     u_short inverse;                /* != 0 text black on white as default */
34     short yscroll;                  /* Hardware scrolling */
35     int vrows;                      /* number of virtual rows */
36     int cursor_shape;
37     int con_rotate;
38     u32 xres_virtual;
39     u32 yres_virtual;
40     u32 height;
41     u32 width;
42     u32 bits_per_pixel;
43     u32 grayscale;
44     u32 nonstd;
45     u32 accel_flags;
46     u32 rotate;
47     struct fb_bitfield red;
48     struct fb_bitfield green;
49     struct fb_bitfield blue;
50     struct fb_bitfield transp;
51     const struct fb_videomode *mode;
52 };
53
54 struct fbcon_ops {
55         void (*bmove)(struct vc_data *vc, struct fb_info *info, int sy,
56                       int sx, int dy, int dx, int height, int width);
57         void (*clear)(struct vc_data *vc, struct fb_info *info, int sy,
58                       int sx, int height, int width);
59         void (*putcs)(struct vc_data *vc, struct fb_info *info,
60                       const unsigned short *s, int count, int yy, int xx,
61                       int fg, int bg);
62         void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
63                               int bottom_only);
64         void (*cursor)(struct vc_data *vc, struct fb_info *info, int mode,
65                        int softback_lines, int fg, int bg);
66         int  (*update_start)(struct fb_info *info);
67         int  (*rotate_font)(struct fb_info *info, struct vc_data *vc);
68         struct fb_var_screeninfo var;  /* copy of the current fb_var_screeninfo */
69         struct timer_list cursor_timer; /* Cursor timer */
70         struct fb_cursor cursor_state;
71         struct display *p;
72         int    currcon;                 /* Current VC. */
73         int    cursor_flash;
74         int    cursor_reset;
75         int    blank_state;
76         int    graphics;
77         int    flags;
78         int    rotate;
79         int    cur_rotate;
80         char  *cursor_data;
81         u8    *fontbuffer;
82         u8    *fontdata;
83         u8    *cursor_src;
84         u32    cursor_size;
85         u32    fd_size;
86 };
87     /*
88      *  Attribute Decoding
89      */
90
91 /* Color */
92 #define attr_fgcol(fgshift,s)    \
93         (((s) >> (fgshift)) & 0x0f)
94 #define attr_bgcol(bgshift,s)    \
95         (((s) >> (bgshift)) & 0x0f)
96
97 /* Monochrome */
98 #define attr_bold(s) \
99         ((s) & 0x200)
100 #define attr_reverse(s) \
101         ((s) & 0x800)
102 #define attr_underline(s) \
103         ((s) & 0x400)
104 #define attr_blink(s) \
105         ((s) & 0x8000)
106         
107 #define mono_col(info)                                                  \
108         (~(0xfff << (max((info)->var.green.length,                      \
109                          max((info)->var.red.length,                    \
110                              (info)->var.blue.length)))) & 0xff)
111
112 static inline int attr_col_ec(int shift, struct vc_data *vc,
113                               struct fb_info *info, int is_fg)
114 {
115         int is_mono01;
116         int col;
117         int fg;
118         int bg;
119
120         if (!vc)
121                 return 0;
122
123         if (vc->vc_can_do_color)
124                 return is_fg ? attr_fgcol(shift,vc->vc_video_erase_char)
125                         : attr_bgcol(shift,vc->vc_video_erase_char);
126
127         if (!info)
128                 return 0;
129
130         col = mono_col(info);
131         is_mono01 = info->fix.visual == FB_VISUAL_MONO01;
132
133         if (attr_reverse(vc->vc_video_erase_char)) {
134                 fg = is_mono01 ? col : 0;
135                 bg = is_mono01 ? 0 : col;
136         }
137         else {
138                 fg = is_mono01 ? 0 : col;
139                 bg = is_mono01 ? col : 0;
140         }
141
142         return is_fg ? fg : bg;
143 }
144
145 #define attr_bgcol_ec(bgshift,vc,info)          \
146         attr_col_ec(bgshift,vc,info,0);
147 #define attr_fgcol_ec(fgshift,vc,info)          \
148         attr_col_ec(fgshift,vc,info,1);
149
150 /* Font */
151 #define REFCOUNT(fd)    (((int *)(fd))[-1])
152 #define FNTSIZE(fd)     (((int *)(fd))[-2])
153 #define FNTCHARCNT(fd)  (((int *)(fd))[-3])
154 #define FNTSUM(fd)      (((int *)(fd))[-4])
155 #define FONT_EXTRA_WORDS 4
156
157     /*
158      *  Scroll Method
159      */
160      
161 /* There are several methods fbcon can use to move text around the screen:
162  *
163  *                     Operation   Pan    Wrap
164  *---------------------------------------------
165  * SCROLL_MOVE         copyarea    No     No
166  * SCROLL_PAN_MOVE     copyarea    Yes    No
167  * SCROLL_WRAP_MOVE    copyarea    No     Yes
168  * SCROLL_REDRAW       imageblit   No     No
169  * SCROLL_PAN_REDRAW   imageblit   Yes    No
170  * SCROLL_WRAP_REDRAW  imageblit   No     Yes
171  *
172  * (SCROLL_WRAP_REDRAW is not implemented yet)
173  *
174  * In general, fbcon will choose the best scrolling
175  * method based on the rule below:
176  *
177  * Pan/Wrap > accel imageblit > accel copyarea >
178  * soft imageblit > (soft copyarea)
179  *
180  * Exception to the rule: Pan + accel copyarea is
181  * preferred over Pan + accel imageblit.
182  *
183  * The above is typical for PCI/AGP cards. Unless
184  * overridden, fbcon will never use soft copyarea.
185  *
186  * If you need to override the above rule, set the
187  * appropriate flags in fb_info->flags.  For example,
188  * to prefer copyarea over imageblit, set
189  * FBINFO_READS_FAST.
190  *
191  * Other notes:
192  * + use the hardware engine to move the text
193  *    (hw-accelerated copyarea() and fillrect())
194  * + use hardware-supported panning on a large virtual screen
195  * + amifb can not only pan, but also wrap the display by N lines
196  *    (i.e. visible line i = physical line (i+N) % yres).
197  * + read what's already rendered on the screen and
198  *     write it in a different place (this is cfb_copyarea())
199  * + re-render the text to the screen
200  *
201  * Whether to use wrapping or panning can only be figured out at
202  * runtime (when we know whether our font height is a multiple
203  * of the pan/wrap step)
204  *
205  */
206
207 #define SCROLL_MOVE        0x001
208 #define SCROLL_PAN_MOVE    0x002
209 #define SCROLL_WRAP_MOVE   0x003
210 #define SCROLL_REDRAW      0x004
211 #define SCROLL_PAN_REDRAW  0x005
212
213 #ifdef CONFIG_FB_TILEBLITTING
214 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info);
215 #endif
216 extern void fbcon_set_bitops(struct fbcon_ops *ops);
217 extern int  soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
218
219 #define FBCON_ATTRIBUTE_UNDERLINE 1
220 #define FBCON_ATTRIBUTE_REVERSE   2
221 #define FBCON_ATTRIBUTE_BOLD      4
222
223 static inline int real_y(struct display *p, int ypos)
224 {
225         int rows = p->vrows;
226
227         ypos += p->yscroll;
228         return ypos < rows ? ypos : ypos - rows;
229 }
230
231
232 static inline int get_attribute(struct fb_info *info, u16 c)
233 {
234         int attribute = 0;
235
236         if (fb_get_color_depth(&info->var, &info->fix) == 1) {
237                 if (attr_underline(c))
238                         attribute |= FBCON_ATTRIBUTE_UNDERLINE;
239                 if (attr_reverse(c))
240                         attribute |= FBCON_ATTRIBUTE_REVERSE;
241                 if (attr_bold(c))
242                         attribute |= FBCON_ATTRIBUTE_BOLD;
243         }
244
245         return attribute;
246 }
247
248 #define FBCON_SWAP(i,r,v) ({ \
249         typeof(r) _r = (r);  \
250         typeof(v) _v = (v);  \
251         (void) (&_r == &_v); \
252         (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
253
254 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
255 extern void fbcon_set_rotate(struct fbcon_ops *ops);
256 #else
257 #define fbcon_set_rotate(x) do {} while(0)
258 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
259
260 #endif /* _VIDEO_FBCON_H */
261