1 /* $NetBSD: rasops.h,v 1.49 2019/11/02 01:14:57 tsutsui 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 #include <sys/param.h> 36 37 #include <dev/wscons/wsconsio.h> 38 #include <dev/wsfont/wsfont.h> 39 40 /* For rasops_info::ri_flg */ 41 #define RI_FULLCLEAR 0x01 /* eraserows() hack to clear full screen */ 42 #define RI_FORCEMONO 0x02 /* monochrome output even if we can do color */ 43 #define RI_BSWAP 0x04 /* framebuffer endianness doesn't match CPU */ 44 #define RI_CURSOR 0x08 /* cursor is switched on */ 45 #define RI_CLEAR 0x10 /* clear display on startup */ 46 #define RI_CENTER 0x20 /* center onscreen output */ 47 #define RI_CURSORCLIP 0x40 /* cursor is currently clipped */ 48 #define RI_CFGDONE 0x80 /* rasops_reconfig() completed successfully */ 49 #define RI_ROTATE_CW 0x100 /* display is rotated, quarter clockwise */ 50 #define RI_ROTATE_CCW 0x200 /* display is rotated, quarter counter-clockwise */ 51 #define RI_ROTATE_UD 0x400 /* display is rotated, upside-down */ 52 #define RI_ROTATE_MASK 0x700 53 /* 54 * if you call rasops_init() or rasops_reconfig() in a context where it is not 55 * safe to call kmem_alloc(), like early on during kernel startup, you MUST set 56 * RI_NO_AUTO to keep rasops from trying to allocate memory for autogenerated 57 * box drawing characters 58 */ 59 #define RI_NO_AUTO 0x800 /* do not generate box drawing characters */ 60 /* 61 * Set this if your driver's putchar() method supports anti-aliased fonts in 62 * the given video mode. Without this flag rasops_init() will only ever pick 63 * monochrome bitmap fonts. 64 */ 65 #define RI_ENABLE_ALPHA 0x1000 66 /* set this in order to use r3g3b2 'true' colour in 8 bit */ 67 #define RI_8BIT_IS_RGB 0x2000 68 /* 69 * drivers can set this to tell the font selection code that they'd rather 70 * use alpha fonts 71 */ 72 #define RI_PREFER_ALPHA 0x4000 73 74 struct rasops_info { 75 /* These must be filled in by the caller */ 76 int ri_depth; /* depth in bits */ 77 uint8_t *ri_bits; /* ptr to bits */ 78 int ri_width; /* width (pels) */ 79 int ri_height; /* height (pels) */ 80 int ri_stride; /* stride in bytes */ 81 82 /* 83 * If you want shadow framebuffer support, point ri_hwbits 84 * to the real framebuffer, and ri_bits to the shadow framebuffer 85 */ 86 uint8_t *ri_hwbits; 87 88 /* 89 * These can optionally be left zeroed out. If you fill ri_font, 90 * but aren't using wsfont, set ri_wsfcookie to -1. 91 */ 92 struct wsdisplay_font *ri_font; 93 struct wsdisplay_font ri_optfont; 94 int ri_wsfcookie; /* wsfont cookie */ 95 void *ri_hw; /* driver private data; ignored by rasops */ 96 int ri_crow; /* cursor row */ 97 int ri_ccol; /* cursor column */ 98 int ri_flg; /* various operational flags */ 99 100 /* 101 * These are optional and will default if zero. Meaningless 102 * on depths other than 15, 16, 24 and 32 bits per pel. On 103 * 24 bit displays, ri_{r,g,b}num must be 8. 104 */ 105 uint8_t ri_rnum; /* number of bits for red */ 106 uint8_t ri_gnum; /* number of bits for green */ 107 uint8_t ri_bnum; /* number of bits for blue */ 108 uint8_t ri_rpos; /* which bit red starts at */ 109 uint8_t ri_gpos; /* which bit green starts at */ 110 uint8_t ri_bpos; /* which bit blue starts at */ 111 112 /* These are filled in by rasops_init() */ 113 int ri_emuwidth; /* width we actually care about */ 114 int ri_emuheight; /* height we actually care about */ 115 int ri_emustride; /* bytes per row we actually care about */ 116 int ri_rows; /* number of rows (characters, not pels) */ 117 int ri_cols; /* number of columns (characters, not pels) */ 118 #if __NetBSD_Prereq__(9, 99, 1) 119 struct { 120 int off; /* offset of underline from bottom */ 121 int height; /* height of underline */ 122 } ri_ul; 123 #else 124 /* 125 * XXX 126 * hack to keep ABI compatibility for netbsd-9, -8, and -7. 127 */ 128 // int ri_delta; /* obsoleted */ 129 struct { 130 short off; 131 short height; 132 } __packed ri_ul; 133 #endif 134 int ri_pelbytes; /* bytes per pel (may be zero) */ 135 int ri_fontscale; /* fontheight * fontstride */ 136 int ri_xscale; /* fontwidth * pelbytes */ 137 int ri_yscale; /* fontheight * stride */ 138 uint8_t *ri_origbits; /* where screen bits actually start */ 139 uint8_t *ri_hworigbits; /* where hw bits actually start */ 140 int ri_xorigin; /* where ri_bits begins (x) */ 141 int ri_yorigin; /* where ri_bits begins (y) */ 142 uint32_t 143 ri_devcmap[16]; /* color -> framebuffer data */ 144 145 /* The emulops you need to use, and the screen caps for wscons */ 146 struct wsdisplay_emulops ri_ops; 147 int ri_caps; 148 149 /* Callbacks so we can share some code */ 150 void (*ri_do_cursor)(struct rasops_info *); 151 152 /* Used to intercept putchar to permit display rotation */ 153 struct wsdisplay_emulops ri_real_ops; 154 }; 155 156 #define CHAR_IN_FONT(c, font) \ 157 ((c) >= (font)->firstchar && \ 158 (c) - (font)->firstchar < (font)->numchars) 159 160 #define PICK_FONT(ri, c) \ 161 ((((c) & WSFONT_FLAGS_MASK) == WSFONT_FLAG_OPT && \ 162 (ri)->ri_optfont.data != NULL) ? \ 163 &(ri)->ri_optfont : (ri)->ri_font) 164 165 /* 166 * rasops_init(). 167 * 168 * Integer parameters are the number of rows and columns we'd *like*. 169 * 170 * In terms of optimization, fonts that are a multiple of 8 pixels wide 171 * work the best. 172 * 173 * rasops_init() takes care of rasops_reconfig(). The parameters to both 174 * are the same. If calling rasops_reconfig() to change the font and 175 * ri_wsfcookie >= 0, you must call wsfont_unlock() on it, and reset it 176 * to -1 (or a new, valid cookie). 177 */ 178 179 /* rasops.c */ 180 int rasops_init(struct rasops_info *, int, int); 181 int rasops_reconfig(struct rasops_info *, int, int); 182 void rasops_unpack_attr(long, int *, int *, int *); 183 void rasops_eraserows(void *, int, int, long); 184 void rasops_erasecols(void *, int, int, int, long); 185 int rasops_get_cmap(struct rasops_info *, uint8_t *, size_t); 186 187 extern const uint8_t rasops_cmap[256 * 3]; 188 189 #ifdef _RASOPS_PRIVATE 190 /* 191 * Per-depth initialization functions. 192 */ 193 void rasops1_init(struct rasops_info *); 194 void rasops2_init(struct rasops_info *); 195 void rasops4_init(struct rasops_info *); 196 void rasops8_init(struct rasops_info *); 197 void rasops15_init(struct rasops_info *); 198 void rasops24_init(struct rasops_info *); 199 void rasops32_init(struct rasops_info *); 200 201 #define ATTR_BG(ri, attr) ((ri)->ri_devcmap[((uint32_t)(attr) >> 16) & 0xf]) 202 #define ATTR_FG(ri, attr) ((ri)->ri_devcmap[((uint32_t)(attr) >> 24) & 0xf]) 203 204 #define ATTR_MASK_BG __BITS(16, 19) 205 #define ATTR_MASK_FG __BITS(24, 27) 206 207 #define DELTA(p, d, cast) ((p) = (cast)((uint8_t *)(p) + (d))) 208 209 #define FBOFFSET(ri, row, col) \ 210 ((row) * (ri)->ri_yscale + (col) * (ri)->ri_xscale) 211 212 #define FONT_GLYPH(uc, font, ri) \ 213 ((uint8_t *)(font)->data + ((uc) - ((font)->firstchar)) * \ 214 (ri)->ri_fontscale) 215 216 static __inline void 217 rasops_memset32(void *p, uint32_t val, size_t bytes) 218 { 219 int slop1, slop2, full; 220 uint8_t *dp = (uint8_t *)p; 221 222 if (bytes == 1) { 223 *dp = val; 224 return; 225 } 226 227 slop1 = (4 - ((uintptr_t)dp & 3)) & 3; 228 slop2 = (bytes - slop1) & 3; 229 full = (bytes - slop1 /* - slop2 */) >> 2; 230 231 if (slop1 & 1) 232 *dp++ = val; 233 234 if (slop1 & 2) { 235 *(uint16_t *)dp = val; 236 dp += 2; 237 } 238 239 for (; full; full--) { 240 *(uint32_t *)dp = val; 241 dp += 4; 242 } 243 244 if (slop2 & 2) { 245 *(uint16_t *)dp = val; 246 dp += 2; 247 } 248 249 if (slop2 & 1) 250 *dp = val; 251 252 return; 253 } 254 255 static __inline uint32_t 256 rasops_be32uatoh(uint8_t *p) 257 { 258 uint32_t u; 259 260 u = p[0]; u <<= 8; 261 u |= p[1]; u <<= 8; 262 u |= p[2]; u <<= 8; 263 u |= p[3]; 264 return u; 265 } 266 #endif /* _RASOPS_PRIVATE */ 267 268 #endif /* _RASOPS_H_ */ 269