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