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/types.h>
 
  15 #include <linux/vt_buffer.h>
 
  16 #include <linux/vt_kern.h>
 
  20 #define FBCON_FLAGS_INIT         1
 
  21 #define FBCON_FLAGS_CURSOR_TIMER 2
 
  24     *    This is the interface between the low-level console driver and the
 
  25     *    low-level frame buffer device
 
  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 */
 
  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;
 
  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,
 
  62         void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
 
  64         void (*cursor)(struct vc_data *vc, struct fb_info *info, int mode,
 
  65                        int softback_lines, 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;
 
  72         int    currcon;                 /* Current VC. */
 
  92 #define attr_fgcol(fgshift,s)    \
 
  93         (((s) >> (fgshift)) & 0x0f)
 
  94 #define attr_bgcol(bgshift,s)    \
 
  95         (((s) >> (bgshift)) & 0x0f)
 
  98 #define attr_bold(s) \
 
 100 #define attr_reverse(s) \
 
 102 #define attr_underline(s) \
 
 104 #define attr_blink(s) \
 
 107 #define mono_col(info)                                                  \
 
 108         (~(0xfff << (max((info)->var.green.length,                      \
 
 109                          max((info)->var.red.length,                    \
 
 110                              (info)->var.blue.length)))) & 0xff)
 
 112 static inline int attr_col_ec(int shift, struct vc_data *vc,
 
 113                               struct fb_info *info, int is_fg)
 
 123         if (vc->vc_can_do_color)
 
 124                 return is_fg ? attr_fgcol(shift,vc->vc_video_erase_char)
 
 125                         : attr_bgcol(shift,vc->vc_video_erase_char);
 
 130         col = mono_col(info);
 
 131         is_mono01 = info->fix.visual == FB_VISUAL_MONO01;
 
 133         if (attr_reverse(vc->vc_video_erase_char)) {
 
 134                 fg = is_mono01 ? col : 0;
 
 135                 bg = is_mono01 ? 0 : col;
 
 138                 fg = is_mono01 ? 0 : col;
 
 139                 bg = is_mono01 ? col : 0;
 
 142         return is_fg ? fg : bg;
 
 145 #define attr_bgcol_ec(bgshift,vc,info)          \
 
 146         attr_col_ec(bgshift,vc,info,0);
 
 147 #define attr_fgcol_ec(fgshift,vc,info)          \
 
 148         attr_col_ec(fgshift,vc,info,1);
 
 151 #define REFCOUNT(fd)    (((int *)(fd))[-1])
 
 152 #define FNTSIZE(fd)     (((int *)(fd))[-2])
 
 153 #define FNTCHARCNT(fd)  (((int *)(fd))[-3])
 
 154 #define FNTSUM(fd)      (((int *)(fd))[-4])
 
 155 #define FONT_EXTRA_WORDS 4
 
 161 /* There are several methods fbcon can use to move text around the screen:
 
 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
 
 172  * (SCROLL_WRAP_REDRAW is not implemented yet)
 
 174  * In general, fbcon will choose the best scrolling
 
 175  * method based on the rule below:
 
 177  * Pan/Wrap > accel imageblit > accel copyarea >
 
 178  * soft imageblit > (soft copyarea)
 
 180  * Exception to the rule: Pan + accel copyarea is
 
 181  * preferred over Pan + accel imageblit.
 
 183  * The above is typical for PCI/AGP cards. Unless
 
 184  * overridden, fbcon will never use soft copyarea.
 
 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
 
 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
 
 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)
 
 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
 
 213 #ifdef CONFIG_FB_TILEBLITTING
 
 214 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info);
 
 216 extern void fbcon_set_bitops(struct fbcon_ops *ops);
 
 217 extern int  soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
 
 219 #define FBCON_ATTRIBUTE_UNDERLINE 1
 
 220 #define FBCON_ATTRIBUTE_REVERSE   2
 
 221 #define FBCON_ATTRIBUTE_BOLD      4
 
 223 static inline int real_y(struct display *p, int ypos)
 
 228         return ypos < rows ? ypos : ypos - rows;
 
 232 static inline int get_attribute(struct fb_info *info, u16 c)
 
 236         if (fb_get_color_depth(&info->var, &info->fix) == 1) {
 
 237                 if (attr_underline(c))
 
 238                         attribute |= FBCON_ATTRIBUTE_UNDERLINE;
 
 240                         attribute |= FBCON_ATTRIBUTE_REVERSE;
 
 242                         attribute |= FBCON_ATTRIBUTE_BOLD;
 
 248 #define FBCON_SWAP(i,r,v) ({ \
 
 249         typeof(r) _r = (r);  \
 
 250         typeof(v) _v = (v);  \
 
 251         (void) (&_r == &_v); \
 
 252         (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
 
 254 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
 
 255 extern void fbcon_set_rotate(struct fbcon_ops *ops);
 
 257 #define fbcon_set_rotate(x) do {} while(0)
 
 258 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
 
 260 #endif /* _VIDEO_FBCON_H */