drivers/video/console/fbcon.h

   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/config.h>
  15 #include <linux/types.h>
  16 #include <linux/vt_buffer.h>
  17 #include <linux/vt_kern.h>
  18
  19 #include <asm/io.h>
  20
  21 #define FBCON_FLAGS_INIT         1
  22 #define FBCON_FLAGS_CURSOR_TIMER 2
  23
  24    /*
  25     *    This is the interface between the low-level console driver and the
  26     *    low-level frame buffer device
  27     */
  28
  29 struct display {
  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 */
  37     int cursor_shape;
  38     int con_rotate;
  39     u32 xres_virtual;
  40     u32 yres_virtual;
  41     u32 height;
  42     u32 width;
  43     u32 bits_per_pixel;
  44     u32 grayscale;
  45     u32 nonstd;
  46     u32 accel_flags;
  47     u32 rotate;
  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;
  53 };
  54
  55 struct fbcon_ops {
  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,
  62                       int fg, int bg);
  63         void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
  64                               int bottom_only);
  65         void (*cursor)(struct vc_data *vc, struct fb_info *info,
  66                        struct display *p, int mode, int softback_lines,
  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 display *p);
  71         struct fb_var_screeninfo var;  /* copy of the current fb_var_screeninfo */
  72         struct timer_list cursor_timer; /* Cursor timer */
  73         struct fb_cursor cursor_state;
  74         struct display *p;
  75         int    currcon;                 /* Current VC. */
  76         int    cursor_flash;
  77         int    cursor_reset;
  78         int    blank_state;
  79         int    graphics;
  80         int    flags;
  81         int    rotate;
  82         int    cur_rotate;
  83         char  *cursor_data;
  84         u8    *fontbuffer;
  85         u8    *fontdata;
  86         u32    fd_size;
  87 };
  88     /*
  89      *  Attribute Decoding
  90      */
  91
  92 /* Color */
  93 #define attr_fgcol(fgshift,s)    \
  94         (((s) >> (fgshift)) & 0x0f)
  95 #define attr_bgcol(bgshift,s)    \
  96         (((s) >> (bgshift)) & 0x0f)
  97 #define attr_bgcol_ec(bgshift,vc) \
  98         ((vc) ? (((vc)->vc_video_erase_char >> (bgshift)) & 0x0f) : 0)
  99 #define attr_fgcol_ec(fgshift,vc) \
 100         ((vc) ? (((vc)->vc_video_erase_char >> (fgshift)) & 0x0f) : 0)
 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 /* Font */
 113 #define REFCOUNT(fd)    (((int *)(fd))[-1])
 114 #define FNTSIZE(fd)     (((int *)(fd))[-2])
 115 #define FNTCHARCNT(fd)  (((int *)(fd))[-3])
 116 #define FNTSUM(fd)      (((int *)(fd))[-4])
 117 #define FONT_EXTRA_WORDS 4
 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
 175 #ifdef CONFIG_FB_TILEBLITTING
 176 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info,
 177                               struct display *p, struct fbcon_ops *ops);
 178 #endif
 179 extern void fbcon_set_bitops(struct fbcon_ops *ops);
 180 extern int  soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
 181
 182 #define FBCON_ATTRIBUTE_UNDERLINE 1
 183 #define FBCON_ATTRIBUTE_REVERSE   2
 184 #define FBCON_ATTRIBUTE_BOLD      4
 185
 186 static inline int real_y(struct display *p, int ypos)
 187 {
 188         int rows = p->vrows;
 189
 190         ypos += p->yscroll;
 191         return ypos < rows ? ypos : ypos - rows;
 192 }
 193
 194
 195 static inline int get_attribute(struct fb_info *info, u16 c)
 196 {
 197         int attribute = 0;
 198
 199         if (fb_get_color_depth(&info->var, &info->fix) == 1) {
 200                 if (attr_underline(c))
 201                         attribute |= FBCON_ATTRIBUTE_UNDERLINE;
 202                 if (attr_reverse(c))
 203                         attribute |= FBCON_ATTRIBUTE_REVERSE;
 204                 if (attr_bold(c))
 205                         attribute |= FBCON_ATTRIBUTE_BOLD;
 206         }
 207
 208         return attribute;
 209 }
 210
 211 #define FBCON_SWAP(i,r,v) ({ \
 212         typeof(r) _r = (r);  \
 213         typeof(v) _v = (v);  \
 214         (void) (&_r == &_v); \
 215         (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
 216
 217 #ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
 218 extern void fbcon_set_rotate(struct fbcon_ops *ops);
 219 #else
 220 #define fbcon_set_rotate(x) do {} while(0)
 221 #endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
 222
 223 #endif /* _VIDEO_FBCON_H */
 224