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 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 cur_blink_jiffies;
74 int cursor_flash;
75 int cursor_reset;
76 int blank_state;
77 int graphics;
78 int save_graphics; /* for debug enter/leave */
79 int flags;
80 int rotate;
81 int cur_rotate;
82 char *cursor_data;
83 u8 *fontbuffer;
84 u8 *fontdata;
85 u8 *cursor_src;
86 u32 cursor_size;
87 u32 fd_size;
88 };
89 /*
90 * Attribute Decoding
91 */
92
93 /* Color */
94 #define attr_fgcol(fgshift,s) \
95 (((s) >> (fgshift)) & 0x0f)
96 #define attr_bgcol(bgshift,s) \
97 (((s) >> (bgshift)) & 0x0f)
98
99 /* Monochrome */
100 #define attr_bold(s) \
101 ((s) & 0x200)
102 #define attr_reverse(s) \
103 ((s) & 0x800)
104 #define attr_underline(s) \
105 ((s) & 0x400)
106 #define attr_blink(s) \
107 ((s) & 0x8000)
108
109
mono_col(const struct fb_info * info)110 static inline int mono_col(const struct fb_info *info)
111 {
112 __u32 max_len;
113 max_len = max(info->var.green.length, info->var.red.length);
114 max_len = max(info->var.blue.length, max_len);
115 return (~(0xfff << max_len)) & 0xff;
116 }
117
attr_col_ec(int shift,struct vc_data * vc,struct fb_info * info,int is_fg)118 static inline int attr_col_ec(int shift, struct vc_data *vc,
119 struct fb_info *info, int is_fg)
120 {
121 int is_mono01;
122 int col;
123 int fg;
124 int bg;
125
126 if (!vc)
127 return 0;
128
129 if (vc->vc_can_do_color)
130 return is_fg ? attr_fgcol(shift,vc->vc_video_erase_char)
131 : attr_bgcol(shift,vc->vc_video_erase_char);
132
133 if (!info)
134 return 0;
135
136 col = mono_col(info);
137 is_mono01 = info->fix.visual == FB_VISUAL_MONO01;
138
139 if (attr_reverse(vc->vc_video_erase_char)) {
140 fg = is_mono01 ? col : 0;
141 bg = is_mono01 ? 0 : col;
142 }
143 else {
144 fg = is_mono01 ? 0 : col;
145 bg = is_mono01 ? col : 0;
146 }
147
148 return is_fg ? fg : bg;
149 }
150
151 #define attr_bgcol_ec(bgshift, vc, info) attr_col_ec(bgshift, vc, info, 0)
152 #define attr_fgcol_ec(fgshift, vc, info) attr_col_ec(fgshift, vc, info, 1)
153
154 /*
155 * Scroll Method
156 */
157
158 /* There are several methods fbcon can use to move text around the screen:
159 *
160 * Operation Pan Wrap
161 *---------------------------------------------
162 * SCROLL_MOVE copyarea No No
163 * SCROLL_PAN_MOVE copyarea Yes No
164 * SCROLL_WRAP_MOVE copyarea No Yes
165 * SCROLL_REDRAW imageblit No No
166 * SCROLL_PAN_REDRAW imageblit Yes No
167 * SCROLL_WRAP_REDRAW imageblit No Yes
168 *
169 * (SCROLL_WRAP_REDRAW is not implemented yet)
170 *
171 * In general, fbcon will choose the best scrolling
172 * method based on the rule below:
173 *
174 * Pan/Wrap > accel imageblit > accel copyarea >
175 * soft imageblit > (soft copyarea)
176 *
177 * Exception to the rule: Pan + accel copyarea is
178 * preferred over Pan + accel imageblit.
179 *
180 * The above is typical for PCI/AGP cards. Unless
181 * overridden, fbcon will never use soft copyarea.
182 *
183 * If you need to override the above rule, set the
184 * appropriate flags in fb_info->flags. For example,
185 * to prefer copyarea over imageblit, set
186 * FBINFO_READS_FAST.
187 *
188 * Other notes:
189 * + use the hardware engine to move the text
190 * (hw-accelerated copyarea() and fillrect())
191 * + use hardware-supported panning on a large virtual screen
192 * + amifb can not only pan, but also wrap the display by N lines
193 * (i.e. visible line i = physical line (i+N) % yres).
194 * + read what's already rendered on the screen and
195 * write it in a different place (this is cfb_copyarea())
196 * + re-render the text to the screen
197 *
198 * Whether to use wrapping or panning can only be figured out at
199 * runtime (when we know whether our font height is a multiple
200 * of the pan/wrap step)
201 *
202 */
203
204 #define SCROLL_MOVE 0x001
205 #define SCROLL_PAN_MOVE 0x002
206 #define SCROLL_WRAP_MOVE 0x003
207 #define SCROLL_REDRAW 0x004
208 #define SCROLL_PAN_REDRAW 0x005
209
210 #ifdef CONFIG_FB_TILEBLITTING
211 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info);
212 #endif
213 extern void fbcon_set_bitops(struct fbcon_ops *ops);
214 extern int soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
215
216 #define FBCON_ATTRIBUTE_UNDERLINE 1
217 #define FBCON_ATTRIBUTE_REVERSE 2
218 #define FBCON_ATTRIBUTE_BOLD 4
219
real_y(struct display * p,int ypos)220 static inline int real_y(struct display *p, int ypos)
221 {
222 int rows = p->vrows;
223
224 ypos += p->yscroll;
225 return ypos < rows ? ypos : ypos - rows;
226 }
227
228
get_attribute(struct fb_info * info,u16 c)229 static inline int get_attribute(struct fb_info *info, u16 c)
230 {
231 int attribute = 0;
232
233 if (fb_get_color_depth(&info->var, &info->fix) == 1) {
234 if (attr_underline(c))
235 attribute |= FBCON_ATTRIBUTE_UNDERLINE;
236 if (attr_reverse(c))
237 attribute |= FBCON_ATTRIBUTE_REVERSE;
238 if (attr_bold(c))
239 attribute |= FBCON_ATTRIBUTE_BOLD;
240 }
241
242 return attribute;
243 }
244
245 #define FBCON_SWAP(i,r,v) ({ \
246 typeof(r) _r = (r); \
247 typeof(v) _v = (v); \
248 (void) (&_r == &_v); \
249 (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
250
251 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
252 extern void fbcon_set_rotate(struct fbcon_ops *ops);
253 #else
254 #define fbcon_set_rotate(x) do {} while(0)
255 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
256
257 #endif /* _VIDEO_FBCON_H */
258
259