sys/dev/rasops/rasops.h

   1 /*      $NetBSD: rasops.h,v 1.21 2007/03/04 06:02:39 christos Exp $ */
   2
   3 /*-
   4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Andrew Doran.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _RASOPS_H_
  33 #define _RASOPS_H_ 1
  34
  35 struct wsdisplay_font;
  36
  37 /* For rasops_info::ri_flg */
  38 #define RI_FULLCLEAR    0x01    /* eraserows() hack to clear full screen */
  39 #define RI_FORCEMONO    0x02    /* monochrome output even if we can do color */
  40 #define RI_BSWAP        0x04    /* framebuffer endianness doesn't match CPU */
  41 #define RI_CURSOR       0x08    /* cursor is switched on */
  42 #define RI_CLEAR        0x10    /* clear display on startup */
  43 #define RI_CENTER       0x20    /* center onscreen output */
  44 #define RI_CURSORCLIP   0x40    /* cursor is currently clipped */
  45 #define RI_CFGDONE      0x80    /* rasops_reconfig() completed successfully */
  46 #define RI_ROTATE_CW    0x100   /* display is rotated, quarter clockwise */
  47
  48 struct rasops_info {
  49         /* These must be filled in by the caller */
  50         int     ri_depth;       /* depth in bits */
  51         u_char  *ri_bits;       /* ptr to bits */
  52         int     ri_width;       /* width (pels) */
  53         int     ri_height;      /* height (pels) */
  54         int     ri_stride;      /* stride in bytes */
  55
  56         /*
  57          * If you want shadow framebuffer support, point ri_hwbits
  58          * to the real framebuffer, and ri_bits to the shadow framebuffer
  59          */
  60         u_char  *ri_hwbits;
  61
  62         /*
  63          * These can optionally be left zeroed out. If you fill ri_font,
  64          * but aren't using wsfont, set ri_wsfcookie to -1.
  65          */
  66         struct  wsdisplay_font *ri_font;
  67         int     ri_wsfcookie;   /* wsfont cookie */
  68         void    *ri_hw;         /* driver private data; ignored by rasops */
  69         int     ri_crow;        /* cursor row */
  70         int     ri_ccol;        /* cursor column */
  71         int     ri_flg;         /* various operational flags */
  72
  73         /*
  74          * These are optional and will default if zero. Meaningless
  75          * on depths other than 15, 16, 24 and 32 bits per pel. On
  76          * 24 bit displays, ri_{r,g,b}num must be 8.
  77          */
  78         u_char  ri_rnum;        /* number of bits for red */
  79         u_char  ri_gnum;        /* number of bits for green */
  80         u_char  ri_bnum;        /* number of bits for blue */
  81         u_char  ri_rpos;        /* which bit red starts at */
  82         u_char  ri_gpos;        /* which bit green starts at */
  83         u_char  ri_bpos;        /* which bit blue starts at */
  84
  85         /* These are filled in by rasops_init() */
  86         int     ri_emuwidth;    /* width we actually care about */
  87         int     ri_emuheight;   /* height we actually care about */
  88         int     ri_emustride;   /* bytes per row we actually care about */
  89         int     ri_rows;        /* number of rows (characters, not pels) */
  90         int     ri_cols;        /* number of columns (characters, not pels) */
  91         int     ri_delta;       /* row delta in bytes */
  92         int     ri_pelbytes;    /* bytes per pel (may be zero) */
  93         int     ri_fontscale;   /* fontheight * fontstride */
  94         int     ri_xscale;      /* fontwidth * pelbytes */
  95         int     ri_yscale;      /* fontheight * stride */
  96         u_char  *ri_origbits;   /* where screen bits actually start */
  97         int     ri_xorigin;     /* where ri_bits begins (x) */
  98         int     ri_yorigin;     /* where ri_bits begins (y) */
  99         int32_t ri_devcmap[16]; /* color -> framebuffer data */
 100
 101         /* The emulops you need to use, and the screen caps for wscons */
 102         struct  wsdisplay_emulops ri_ops;
 103         int     ri_caps;
 104
 105         /* Callbacks so we can share some code */
 106         void    (*ri_do_cursor)(struct rasops_info *);
 107
 108 #if NRASOPS_ROTATION > 0
 109         /* Used to intercept putchar to permit display rotation */
 110         struct  wsdisplay_emulops ri_real_ops;
 111 #endif
 112 };
 113
 114 #define DELTA(p, d, cast) ((p) = (cast)((char *)(p) + (d)))
 115
 116 #define CHAR_IN_FONT(c,font)                                    \
 117        ((c) >= (font)->firstchar &&                             \
 118         ((c) - (font)->firstchar) < (font)->numchars)
 119
 120 /*
 121  * rasops_init().
 122  *
 123  * Integer parameters are the number of rows and columns we'd *like*.
 124  *
 125  * In terms of optimization, fonts that are a multiple of 8 pixels wide
 126  * work the best.
 127  *
 128  * rasops_init() takes care of rasops_reconfig(). The parameters to both
 129  * are the same. If calling rasops_reconfig() to change the font and
 130  * ri_wsfcookie >= 0, you must call wsfont_unlock() on it, and reset it
 131  * to -1 (or a new, valid cookie).
 132  */
 133
 134 /*
 135  * Per-depth initialization functions. These should not be called outside
 136  * the rasops code.
 137  */
 138 void    rasops1_init(struct rasops_info *);
 139 void    rasops2_init(struct rasops_info *);
 140 void    rasops4_init(struct rasops_info *);
 141 void    rasops8_init(struct rasops_info *);
 142 void    rasops15_init(struct rasops_info *);
 143 void    rasops24_init(struct rasops_info *);
 144 void    rasops32_init(struct rasops_info *);
 145
 146 /* rasops.c */
 147 int     rasops_init(struct rasops_info *, int, int);
 148 int     rasops_reconfig(struct rasops_info *, int, int);
 149 void    rasops_unpack_attr(long, int *, int *, int *);
 150 void    rasops_eraserows(void *, int, int, long);
 151 void    rasops_erasecols(void *, int, int, int, long);
 152 void    rasops_copycols(void *, int, int, int, int);
 153
 154 extern const u_char     rasops_isgray[16];
 155 extern const u_char     rasops_cmap[256*3];
 156
 157 #endif /* _RASOPS_H_ */