2 * linux/drivers/video/console/fbcon.h -- Low level frame buffer based console driver
4 * Copyright (C) 1997 Geert Uytterhoeven
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
11 #ifndef _VIDEO_FBCON_H
12 #define _VIDEO_FBCON_H
14 #include <linux/config.h>
15 #include <linux/types.h>
16 #include <linux/vt_buffer.h>
17 #include <linux/vt_kern.h>
21 #define FBCON_FLAGS_INIT 1
22 #define FBCON_FLAGS_CURSOR_TIMER 2
25 * This is the interface between the low-level console driver and the
26 * low-level frame buffer device
30 /* Filled in by the low-level console driver */
31 const u_char *fontdata;
32 int userfont; /* != 0 if fontdata kmalloc()ed */
33 u_short scrollmode; /* Scroll Method */
34 u_short inverse; /* != 0 text black on white as default */
35 short yscroll; /* Hardware scrolling */
36 int vrows; /* number of virtual rows */
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;
55 extern struct display fb_display[];
58 void (*bmove)(struct vc_data *vc, struct fb_info *info, int sy,
59 int sx, int dy, int dx, int height, int width);
60 void (*clear)(struct vc_data *vc, struct fb_info *info, int sy,
61 int sx, int height, int width);
62 void (*putcs)(struct vc_data *vc, struct fb_info *info,
63 const unsigned short *s, int count, int yy, int xx,
65 void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
67 void (*cursor)(struct vc_data *vc, struct fb_info *info,
68 struct display *p, int mode, int softback_lines,
70 int (*update_start)(struct fb_info *info);
71 int (*rotate_font)(struct fb_info *info, struct vc_data *vc,
73 struct fb_var_screeninfo var; /* copy of the current fb_var_screeninfo */
74 struct timer_list cursor_timer; /* Cursor timer */
75 struct fb_cursor cursor_state;
76 int currcon; /* Current VC. */
94 #define attr_fgcol(fgshift,s) \
95 (((s) >> (fgshift)) & 0x0f)
96 #define attr_bgcol(bgshift,s) \
97 (((s) >> (bgshift)) & 0x0f)
98 #define attr_bgcol_ec(bgshift,vc) \
99 ((vc) ? (((vc)->vc_video_erase_char >> (bgshift)) & 0x0f) : 0)
100 #define attr_fgcol_ec(fgshift,vc) \
101 ((vc) ? (((vc)->vc_video_erase_char >> (fgshift)) & 0x0f) : 0)
104 #define attr_bold(s) \
106 #define attr_reverse(s) \
108 #define attr_underline(s) \
110 #define attr_blink(s) \
114 #define REFCOUNT(fd) (((int *)(fd))[-1])
115 #define FNTSIZE(fd) (((int *)(fd))[-2])
116 #define FNTCHARCNT(fd) (((int *)(fd))[-3])
117 #define FNTSUM(fd) (((int *)(fd))[-4])
118 #define FONT_EXTRA_WORDS 4
124 /* There are several methods fbcon can use to move text around the screen:
127 *---------------------------------------------
128 * SCROLL_MOVE copyarea No No
129 * SCROLL_PAN_MOVE copyarea Yes No
130 * SCROLL_WRAP_MOVE copyarea No Yes
131 * SCROLL_REDRAW imageblit No No
132 * SCROLL_PAN_REDRAW imageblit Yes No
133 * SCROLL_WRAP_REDRAW imageblit No Yes
135 * (SCROLL_WRAP_REDRAW is not implemented yet)
137 * In general, fbcon will choose the best scrolling
138 * method based on the rule below:
140 * Pan/Wrap > accel imageblit > accel copyarea >
141 * soft imageblit > (soft copyarea)
143 * Exception to the rule: Pan + accel copyarea is
144 * preferred over Pan + accel imageblit.
146 * The above is typical for PCI/AGP cards. Unless
147 * overridden, fbcon will never use soft copyarea.
149 * If you need to override the above rule, set the
150 * appropriate flags in fb_info->flags. For example,
151 * to prefer copyarea over imageblit, set
155 * + use the hardware engine to move the text
156 * (hw-accelerated copyarea() and fillrect())
157 * + use hardware-supported panning on a large virtual screen
158 * + amifb can not only pan, but also wrap the display by N lines
159 * (i.e. visible line i = physical line (i+N) % yres).
160 * + read what's already rendered on the screen and
161 * write it in a different place (this is cfb_copyarea())
162 * + re-render the text to the screen
164 * Whether to use wrapping or panning can only be figured out at
165 * runtime (when we know whether our font height is a multiple
166 * of the pan/wrap step)
170 #define SCROLL_MOVE 0x001
171 #define SCROLL_PAN_MOVE 0x002
172 #define SCROLL_WRAP_MOVE 0x003
173 #define SCROLL_REDRAW 0x004
174 #define SCROLL_PAN_REDRAW 0x005
176 #ifdef CONFIG_FB_TILEBLITTING
177 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info,
178 struct display *p, struct fbcon_ops *ops);
180 extern void fbcon_set_bitops(struct fbcon_ops *ops);
181 extern int soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
183 #define FBCON_ATTRIBUTE_UNDERLINE 1
184 #define FBCON_ATTRIBUTE_REVERSE 2
185 #define FBCON_ATTRIBUTE_BOLD 4
187 static inline int real_y(struct display *p, int ypos)
192 return ypos < rows ? ypos : ypos - rows;
196 static inline int get_attribute(struct fb_info *info, u16 c)
200 if (fb_get_color_depth(&info->var, &info->fix) == 1) {
201 if (attr_underline(c))
202 attribute |= FBCON_ATTRIBUTE_UNDERLINE;
204 attribute |= FBCON_ATTRIBUTE_REVERSE;
206 attribute |= FBCON_ATTRIBUTE_BOLD;
212 #define FBCON_SWAP(i,r,v) ({ \
213 typeof(r) _r = (r); \
214 typeof(v) _v = (v); \
215 (void) (&_r == &_v); \
216 (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
218 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
219 extern void fbcon_set_rotate(struct fbcon_ops *ops);
221 #define fbcon_set_rotate(x) do {} while(0)
222 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
224 #endif /* _VIDEO_FBCON_H */