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