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