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
  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 frame buffer device */
  30     u_short inverse;                /* != 0 text black on white as default */
  31     /* Filled in by the low-level console driver */
  32     u_char *fontdata;
  33     int userfont;                   /* != 0 if fontdata kmalloc()ed */
  34     u_short scrollmode;             /* Scroll Method */
  35     short yscroll;                  /* Hardware scrolling */
  36     int vrows;                      /* number of virtual rows */
  37     int cursor_shape;
  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     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,
  65                        struct display *p, int mode, int softback_lines, int fg, int bg);
  66
  67         struct timer_list cursor_timer; /* Cursor timer */
  68         struct fb_cursor cursor_state;
  69         int    currcon;                 /* Current VC. */
  70         int    cursor_flash;
  71         int    cursor_reset;
  72         int    blank_state;
  73         int    graphics;
  74         int    flags;
  75         char  *cursor_data;
  76 };
  77     /*
  78      *  Attribute Decoding
  79      */
  80
  81 /* Color */
  82 #define attr_fgcol(fgshift,s)    \
  83         (((s) >> (fgshift)) & 0x0f)
  84 #define attr_bgcol(bgshift,s)    \
  85         (((s) >> (bgshift)) & 0x0f)
  86 #define attr_bgcol_ec(bgshift,vc) \
  87         ((vc) ? (((vc)->vc_video_erase_char >> (bgshift)) & 0x0f) : 0)
  88 #define attr_fgcol_ec(fgshift,vc) \
  89         ((vc) ? (((vc)->vc_video_erase_char >> (fgshift)) & 0x0f) : 0)
  90
  91 /* Monochrome */
  92 #define attr_bold(s) \
  93         ((s) & 0x200)
  94 #define attr_reverse(s) \
  95         ((s) & 0x800)
  96 #define attr_underline(s) \
  97         ((s) & 0x400)
  98 #define attr_blink(s) \
  99         ((s) & 0x8000)
 100
 101 /* Font */
 102 #define REFCOUNT(fd)    (((int *)(fd))[-1])
 103 #define FNTSIZE(fd)     (((int *)(fd))[-2])
 104 #define FNTCHARCNT(fd)  (((int *)(fd))[-3])
 105 #define FNTSUM(fd)      (((int *)(fd))[-4])
 106 #define FONT_EXTRA_WORDS 4
 107
 108     /*
 109      *  Scroll Method
 110      */
 111
 112 /* There are several methods fbcon can use to move text around the screen:
 113  *
 114  *                     Operation   Pan    Wrap
 115  *---------------------------------------------
 116  * SCROLL_MOVE         copyarea    No     No
 117  * SCROLL_PAN_MOVE     copyarea    Yes    No
 118  * SCROLL_WRAP_MOVE    copyarea    No     Yes
 119  * SCROLL_REDRAW       imageblit   No     No
 120  * SCROLL_PAN_REDRAW   imageblit   Yes    No
 121  * SCROLL_WRAP_REDRAW  imageblit   No     Yes
 122  *
 123  * (SCROLL_WRAP_REDRAW is not implemented yet)
 124  *
 125  * In general, fbcon will choose the best scrolling
 126  * method based on the rule below:
 127  *
 128  * Pan/Wrap > accel imageblit > accel copyarea >
 129  * soft imageblit > (soft copyarea)
 130  *
 131  * Exception to the rule: Pan + accel copyarea is
 132  * preferred over Pan + accel imageblit.
 133  *
 134  * The above is typical for PCI/AGP cards. Unless
 135  * overridden, fbcon will never use soft copyarea.
 136  *
 137  * If you need to override the above rule, set the
 138  * appropriate flags in fb_info->flags.  For example,
 139  * to prefer copyarea over imageblit, set
 140  * FBINFO_READS_FAST.
 141  *
 142  * Other notes:
 143  * + use the hardware engine to move the text
 144  *    (hw-accelerated copyarea() and fillrect())
 145  * + use hardware-supported panning on a large virtual screen
 146  * + amifb can not only pan, but also wrap the display by N lines
 147  *    (i.e. visible line i = physical line (i+N) % yres).
 148  * + read what's already rendered on the screen and
 149  *     write it in a different place (this is cfb_copyarea())
 150  * + re-render the text to the screen
 151  *
 152  * Whether to use wrapping or panning can only be figured out at
 153  * runtime (when we know whether our font height is a multiple
 154  * of the pan/wrap step)
 155  *
 156  */
 157
 158 #define SCROLL_MOVE        0x001
 159 #define SCROLL_PAN_MOVE    0x002
 160 #define SCROLL_WRAP_MOVE   0x003
 161 #define SCROLL_REDRAW      0x004
 162 #define SCROLL_PAN_REDRAW  0x005
 163
 164 #ifdef CONFIG_FB_TILEBLITTING
 165 extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info,
 166                               struct display *p, struct fbcon_ops *ops);
 167 #endif
 168 extern void fbcon_set_bitops(struct fbcon_ops *ops);
 169
 170 #endif /* _VIDEO_FBCON_H */