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 };
  37
  38 /* drivers/video/console/fbcon.c */
  39 extern signed char con2fb_map[MAX_NR_CONSOLES];
  40 extern int set_con2fb_map(int unit, int newidx);
  41
  42     /*
  43      *  Attribute Decoding
  44      */
  45
  46 /* Color */
  47 #define attr_fgcol(fgshift,s)    \
  48         (((s) >> (fgshift)) & 0x0f)
  49 #define attr_bgcol(bgshift,s)    \
  50         (((s) >> (bgshift)) & 0x0f)
  51 #define attr_bgcol_ec(bgshift,vc) \
  52         ((vc) ? (((vc)->vc_video_erase_char >> (bgshift)) & 0x0f) : 0)
  53 #define attr_fgcol_ec(fgshift,vc) \
  54         ((vc) ? (((vc)->vc_video_erase_char >> (fgshift)) & 0x0f) : 0)
  55
  56 /* Monochrome */
  57 #define attr_bold(s) \
  58         ((s) & 0x200)
  59 #define attr_reverse(s, inverse) \
  60         (((s) & 0x800) ^ (inverse ? 0x800 : 0))
  61 #define attr_underline(s) \
  62         ((s) & 0x400)
  63 #define attr_blink(s) \
  64         ((s) & 0x8000)
  65
  66     /*
  67      *  Scroll Method
  68      */
  69
  70 /* There are several methods fbcon can use to move text around the screen:
  71  *
  72  *                     Operation   Pan    Wrap
  73  *---------------------------------------------
  74  * SCROLL_MOVE         copyarea    No     No
  75  * SCROLL_PAN_MOVE     copyarea    Yes    No
  76  * SCROLL_WRAP_MOVE    copyarea    No     Yes
  77  * SCROLL_REDRAW       imageblit   No     No
  78  * SCROLL_PAN_REDRAW   imageblit   Yes    No
  79  * SCROLL_WRAP_REDRAW  imageblit   No     Yes
  80  *
  81  * (SCROLL_WRAP_REDRAW is not implemented yet)
  82  *
  83  * In general, fbcon will choose the best scrolling
  84  * method based on the rule below:
  85  *
  86  * Pan/Wrap > accel imageblit > accel copyarea >
  87  * soft imageblit > (soft copyarea)
  88  *
  89  * Exception to the rule: Pan + accel copyarea is
  90  * preferred over Pan + accel imageblit.
  91  *
  92  * The above is typical for PCI/AGP cards. Unless
  93  * overridden, fbcon will never use soft copyarea.
  94  *
  95  * If you need to override the above rule, set the
  96  * appropriate flags in fb_info->flags.  For example,
  97  * to prefer copyarea over imageblit, set
  98  * FBINFO_READS_FAST.
  99  *
 100  * Other notes:
 101  * + use the hardware engine to move the text
 102  *    (hw-accelerated copyarea() and fillrect())
 103  * + use hardware-supported panning on a large virtual screen
 104  * + amifb can not only pan, but also wrap the display by N lines
 105  *    (i.e. visible line i = physical line (i+N) % yres).
 106  * + read what's already rendered on the screen and
 107  *     write it in a different place (this is cfb_copyarea())
 108  * + re-render the text to the screen
 109  *
 110  * Whether to use wrapping or panning can only be figured out at
 111  * runtime (when we know whether our font height is a multiple
 112  * of the pan/wrap step)
 113  *
 114  */
 115
 116 #define SCROLL_MOVE        0x001
 117 #define SCROLL_PAN_MOVE    0x002
 118 #define SCROLL_WRAP_MOVE   0x003
 119 #define SCROLL_REDRAW      0x004
 120 #define SCROLL_PAN_REDRAW  0x005
 121
 122 extern int fb_console_init(void);
 123
 124 #endif /* _VIDEO_FBCON_H */