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
;
56 void (*bmove
)(struct vc_data
*vc
, struct fb_info
*info
, int sy
,
57 int sx
, int dy
, int dx
, int height
, int width
);
58 void (*clear
)(struct vc_data
*vc
, struct fb_info
*info
, int sy
,
59 int sx
, int height
, int width
);
60 void (*putcs
)(struct vc_data
*vc
, struct fb_info
*info
,
61 const unsigned short *s
, int count
, int yy
, int xx
,
63 void (*clear_margins
)(struct vc_data
*vc
, struct fb_info
*info
,
65 void (*cursor
)(struct vc_data
*vc
, struct fb_info
*info
, int mode
,
66 int softback_lines
, int fg
, int bg
);
67 int (*update_start
)(struct fb_info
*info
);
68 int (*rotate_font
)(struct fb_info
*info
, struct vc_data
*vc
);
69 struct fb_var_screeninfo var
; /* copy of the current fb_var_screeninfo */
70 struct timer_list cursor_timer
; /* Cursor timer */
71 struct fb_cursor cursor_state
;
73 int currcon
; /* Current VC. */
91 #define attr_fgcol(fgshift,s) \
92 (((s) >> (fgshift)) & 0x0f)
93 #define attr_bgcol(bgshift,s) \
94 (((s) >> (bgshift)) & 0x0f)
95 #define attr_bgcol_ec(bgshift,vc) \
96 ((vc) ? (((vc)->vc_video_erase_char >> (bgshift)) & 0x0f) : 0)
97 #define attr_fgcol_ec(fgshift,vc) \
98 ((vc) ? (((vc)->vc_video_erase_char >> (fgshift)) & 0x0f) : 0)
101 #define attr_bold(s) \
103 #define attr_reverse(s) \
105 #define attr_underline(s) \
107 #define attr_blink(s) \
111 #define REFCOUNT(fd) (((int *)(fd))[-1])
112 #define FNTSIZE(fd) (((int *)(fd))[-2])
113 #define FNTCHARCNT(fd) (((int *)(fd))[-3])
114 #define FNTSUM(fd) (((int *)(fd))[-4])
115 #define FONT_EXTRA_WORDS 4
121 /* There are several methods fbcon can use to move text around the screen:
124 *---------------------------------------------
125 * SCROLL_MOVE copyarea No No
126 * SCROLL_PAN_MOVE copyarea Yes No
127 * SCROLL_WRAP_MOVE copyarea No Yes
128 * SCROLL_REDRAW imageblit No No
129 * SCROLL_PAN_REDRAW imageblit Yes No
130 * SCROLL_WRAP_REDRAW imageblit No Yes
132 * (SCROLL_WRAP_REDRAW is not implemented yet)
134 * In general, fbcon will choose the best scrolling
135 * method based on the rule below:
137 * Pan/Wrap > accel imageblit > accel copyarea >
138 * soft imageblit > (soft copyarea)
140 * Exception to the rule: Pan + accel copyarea is
141 * preferred over Pan + accel imageblit.
143 * The above is typical for PCI/AGP cards. Unless
144 * overridden, fbcon will never use soft copyarea.
146 * If you need to override the above rule, set the
147 * appropriate flags in fb_info->flags. For example,
148 * to prefer copyarea over imageblit, set
152 * + use the hardware engine to move the text
153 * (hw-accelerated copyarea() and fillrect())
154 * + use hardware-supported panning on a large virtual screen
155 * + amifb can not only pan, but also wrap the display by N lines
156 * (i.e. visible line i = physical line (i+N) % yres).
157 * + read what's already rendered on the screen and
158 * write it in a different place (this is cfb_copyarea())
159 * + re-render the text to the screen
161 * Whether to use wrapping or panning can only be figured out at
162 * runtime (when we know whether our font height is a multiple
163 * of the pan/wrap step)
167 #define SCROLL_MOVE 0x001
168 #define SCROLL_PAN_MOVE 0x002
169 #define SCROLL_WRAP_MOVE 0x003
170 #define SCROLL_REDRAW 0x004
171 #define SCROLL_PAN_REDRAW 0x005
173 #ifdef CONFIG_FB_TILEBLITTING
174 extern void fbcon_set_tileops(struct vc_data
*vc
, struct fb_info
*info
);
176 extern void fbcon_set_bitops(struct fbcon_ops
*ops
);
177 extern int soft_cursor(struct fb_info
*info
, struct fb_cursor
*cursor
);
179 #define FBCON_ATTRIBUTE_UNDERLINE 1
180 #define FBCON_ATTRIBUTE_REVERSE 2
181 #define FBCON_ATTRIBUTE_BOLD 4
183 static inline int real_y(struct display
*p
, int ypos
)
188 return ypos
< rows
? ypos
: ypos
- rows
;
192 static inline int get_attribute(struct fb_info
*info
, u16 c
)
196 if (fb_get_color_depth(&info
->var
, &info
->fix
) == 1) {
197 if (attr_underline(c
))
198 attribute
|= FBCON_ATTRIBUTE_UNDERLINE
;
200 attribute
|= FBCON_ATTRIBUTE_REVERSE
;
202 attribute
|= FBCON_ATTRIBUTE_BOLD
;
208 #define FBCON_SWAP(i,r,v) ({ \
209 typeof(r) _r = (r); \
210 typeof(v) _v = (v); \
211 (void) (&_r == &_v); \
212 (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
214 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
215 extern void fbcon_set_rotate(struct fbcon_ops
*ops
);
217 #define fbcon_set_rotate(x) do {} while(0)
218 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
220 #endif /* _VIDEO_FBCON_H */