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 fbcon_display {
29 /* Filled in by the low-level console driver */
30 const u_char *fontdata;
31 int userfont; /* != 0 if fontdata kmalloc()ed */
32 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_LEGACY_ACCELERATION
33 u_short scrollmode; /* Scroll Method, use fb_scrollmode() */
34 #endif
35 u_short inverse; /* != 0 text black on white as default */
36 short yscroll; /* Hardware scrolling */
37 int vrows; /* number of virtual rows */
38 int cursor_shape;
39 int con_rotate;
40 u32 xres_virtual;
41 u32 yres_virtual;
42 u32 height;
43 u32 width;
44 u32 bits_per_pixel;
45 u32 grayscale;
46 u32 nonstd;
47 u32 accel_flags;
48 u32 rotate;
49 struct fb_bitfield red;
50 struct fb_bitfield green;
51 struct fb_bitfield blue;
52 struct fb_bitfield transp;
53 const struct fb_videomode *mode;
54 };
55
56 struct fbcon_ops {
57 void (*bmove)(struct vc_data *vc, struct fb_info *info, int sy,
58 int sx, int dy, int dx, int height, int width);
59 void (*clear)(struct vc_data *vc, struct fb_info *info, int sy,
60 int sx, int height, int width);
61 void (*putcs)(struct vc_data *vc, struct fb_info *info,
62 const unsigned short *s, int count, int yy, int xx,
63 int fg, int bg);
64 void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
65 int color, int bottom_only);
66 void (*cursor)(struct vc_data *vc, struct fb_info *info, int mode,
67 int fg, int bg);
68 int (*update_start)(struct fb_info *info);
69 int (*rotate_font)(struct fb_info *info, struct vc_data *vc);
70 struct fb_var_screeninfo var; /* copy of the current fb_var_screeninfo */
71 struct timer_list cursor_timer; /* Cursor timer */
72 struct fb_cursor cursor_state;
73 struct fbcon_display *p;
74 struct fb_info *info;
75 int currcon; /* Current VC. */
76 int cur_blink_jiffies;
77 int cursor_flash;
78 int cursor_reset;
79 int blank_state;
80 int graphics;
81 int save_graphics; /* for debug enter/leave */
82 int flags;
83 int rotate;
84 int cur_rotate;
85 char *cursor_data;
86 u8 *fontbuffer;
87 u8 *fontdata;
88 u8 *cursor_src;
89 u32 cursor_size;
90 u32 fd_size;
91 };
92 /*
93 * Attribute Decoding
94 */
95
96 /* Color */
97 #define attr_fgcol(fgshift,s) \
98 (((s) >> (fgshift)) & 0x0f)
99 #define attr_bgcol(bgshift,s) \
100 (((s) >> (bgshift)) & 0x0f)
101
102 /* Monochrome */
103 #define attr_bold(s) \
104 ((s) & 0x200)
105 #define attr_reverse(s) \
106 ((s) & 0x800)
107 #define attr_underline(s) \
108 ((s) & 0x400)
109 #define attr_blink(s) \
110 ((s) & 0x8000)
111
112
mono_col(const struct fb_info * info)113 static inline int mono_col(const struct fb_info *info)
114 {
115 __u32 max_len;
116 max_len = max(info->var.green.length, info->var.red.length);
117 max_len = max(info->var.blue.length, max_len);
118 return (~(0xfff << max_len)) & 0xff;
119 }
120
attr_col_ec(int shift,struct vc_data * vc,struct fb_info * info,int is_fg)121 static inline int attr_col_ec(int shift, struct vc_data *vc,
122 struct fb_info *info, int is_fg)
123 {
124 int is_mono01;
125 int col;
126 int fg;
127 int bg;
128
129 if (!vc)
130 return 0;
131
132 if (vc->vc_can_do_color)
133 return is_fg ? attr_fgcol(shift,vc->vc_video_erase_char)
134 : attr_bgcol(shift,vc->vc_video_erase_char);
135
136 if (!info)
137 return 0;
138
139 col = mono_col(info);
140 is_mono01 = info->fix.visual == FB_VISUAL_MONO01;
141
142 if (attr_reverse(vc->vc_video_erase_char)) {
143 fg = is_mono01 ? col : 0;
144 bg = is_mono01 ? 0 : col;
145 }
146 else {
147 fg = is_mono01 ? 0 : col;
148 bg = is_mono01 ? col : 0;
149 }
150
151 return is_fg ? fg : bg;
152 }
153
154 #define attr_bgcol_ec(bgshift, vc, info) attr_col_ec(bgshift, vc, info, 0)
155 #define attr_fgcol_ec(fgshift, vc, info) attr_col_ec(fgshift, vc, info, 1)
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
fb_scrollmode(struct fbcon_display * fb)213 static inline u_short fb_scrollmode(struct fbcon_display *fb)
214 {
215 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_LEGACY_ACCELERATION
216 return fb->scrollmode;
217 #else
218 /* hardcoded to SCROLL_REDRAW if acceleration was disabled. */
219 return SCROLL_REDRAW;
220 #endif
221 }
222
223
224 #ifdef CONFIG_FB_TILEBLITTING
225 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info);
226 #endif
227 extern void fbcon_set_bitops(struct fbcon_ops *ops);
228 extern int soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
229
230 #define FBCON_ATTRIBUTE_UNDERLINE 1
231 #define FBCON_ATTRIBUTE_REVERSE 2
232 #define FBCON_ATTRIBUTE_BOLD 4
233
real_y(struct fbcon_display * p,int ypos)234 static inline int real_y(struct fbcon_display *p, int ypos)
235 {
236 int rows = p->vrows;
237
238 ypos += p->yscroll;
239 return ypos < rows ? ypos : ypos - rows;
240 }
241
242
get_attribute(struct fb_info * info,u16 c)243 static inline int get_attribute(struct fb_info *info, u16 c)
244 {
245 int attribute = 0;
246
247 if (fb_get_color_depth(&info->var, &info->fix) == 1) {
248 if (attr_underline(c))
249 attribute |= FBCON_ATTRIBUTE_UNDERLINE;
250 if (attr_reverse(c))
251 attribute |= FBCON_ATTRIBUTE_REVERSE;
252 if (attr_bold(c))
253 attribute |= FBCON_ATTRIBUTE_BOLD;
254 }
255
256 return attribute;
257 }
258
259 #define FBCON_SWAP(i,r,v) ({ \
260 typeof(r) _r = (r); \
261 typeof(v) _v = (v); \
262 (void) (&_r == &_v); \
263 (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
264
265 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
266 extern void fbcon_set_rotate(struct fbcon_ops *ops);
267 #else
268 #define fbcon_set_rotate(x) do {} while(0)
269 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
270
271 #endif /* _VIDEO_FBCON_H */
272