1/* $NetBSD: rasops.h,v 1.50 2021/12/24 18:12:58 jmcneill 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 * Set this to prefer a wider font. 75 */ 76#define RI_PREFER_WIDEFONT 0x8000 77 78struct rasops_info { 79 /* These must be filled in by the caller */ 80 int ri_depth; /* depth in bits */ 81 uint8_t *ri_bits; /* ptr to bits */ 82 int ri_width; /* width (pels) */ 83 int ri_height; /* height (pels) */ 84 int ri_stride; /* stride in bytes */ 85 86 /* 87 * If you want shadow framebuffer support, point ri_hwbits 88 * to the real framebuffer, and ri_bits to the shadow framebuffer 89 */ 90 uint8_t *ri_hwbits; 91 92 /* 93 * These can optionally be left zeroed out. If you fill ri_font, 94 * but aren't using wsfont, set ri_wsfcookie to -1. 95 */ 96 struct wsdisplay_font *ri_font; 97 struct wsdisplay_font ri_optfont; 98 int ri_wsfcookie; /* wsfont cookie */ 99 void *ri_hw; /* driver private data; ignored by rasops */ 100 int ri_crow; /* cursor row */ 101 int ri_ccol; /* cursor column */ 102 int ri_flg; /* various operational flags */ 103 104 /* 105 * These are optional and will default if zero. Meaningless 106 * on depths other than 15, 16, 24 and 32 bits per pel. On 107 * 24 bit displays, ri_{r,g,b}num must be 8. 108 */ 109 uint8_t ri_rnum; /* number of bits for red */ 110 uint8_t ri_gnum; /* number of bits for green */ 111 uint8_t ri_bnum; /* number of bits for blue */ 112 uint8_t ri_rpos; /* which bit red starts at */ 113 uint8_t ri_gpos; /* which bit green starts at */ 114 uint8_t ri_bpos; /* which bit blue starts at */ 115 116 /* These are filled in by rasops_init() */ 117 int ri_emuwidth; /* width we actually care about */ 118 int ri_emuheight; /* height we actually care about */ 119 int ri_emustride; /* bytes per row we actually care about */ 120 int ri_rows; /* number of rows (characters, not pels) */ 121 int ri_cols; /* number of columns (characters, not pels) */ 122#if __NetBSD_Prereq__(9, 99, 1) 123 struct { 124 int off; /* offset of underline from bottom */ 125 int height; /* height of underline */ 126 } ri_ul; 127#else 128 /* 129 * XXX 130 * hack to keep ABI compatibility for netbsd-9, -8, and -7. 131 */ 132 // int ri_delta; /* obsoleted */ 133 struct { 134 short off; 135 short height; 136 } __packed ri_ul; 137#endif 138 int ri_pelbytes; /* bytes per pel (may be zero) */ 139 int ri_fontscale; /* fontheight * fontstride */ 140 int ri_xscale; /* fontwidth * pelbytes */ 141 int ri_yscale; /* fontheight * stride */ 142 uint8_t *ri_origbits; /* where screen bits actually start */ 143 uint8_t *ri_hworigbits; /* where hw bits actually start */ 144 int ri_xorigin; /* where ri_bits begins (x) */ 145 int ri_yorigin; /* where ri_bits begins (y) */ 146 uint32_t 147 ri_devcmap[16]; /* color -> framebuffer data */ 148 149 /* The emulops you need to use, and the screen caps for wscons */ 150 struct wsdisplay_emulops ri_ops; 151 int ri_caps; 152 153 /* Callbacks so we can share some code */ 154 void (*ri_do_cursor)(struct rasops_info *); 155 156 /* Used to intercept putchar to permit display rotation */ 157 struct wsdisplay_emulops ri_real_ops; 158}; 159 160#define CHAR_IN_FONT(c, font) \ 161 ((c) >= (font)->firstchar && \ 162 (c) - (font)->firstchar < (font)->numchars) 163 164#define PICK_FONT(ri, c) \ 165 ((((c) & WSFONT_FLAGS_MASK) == WSFONT_FLAG_OPT && \ 166 (ri)->ri_optfont.data != NULL) ? \ 167 &(ri)->ri_optfont : (ri)->ri_font) 168 169/* 170 * rasops_init(). 171 * 172 * Integer parameters are the number of rows and columns we'd *like*. 173 * 174 * In terms of optimization, fonts that are a multiple of 8 pixels wide 175 * work the best. 176 * 177 * rasops_init() takes care of rasops_reconfig(). The parameters to both 178 * are the same. If calling rasops_reconfig() to change the font and 179 * ri_wsfcookie >= 0, you must call wsfont_unlock() on it, and reset it 180 * to -1 (or a new, valid cookie). 181 */ 182 183/* rasops.c */ 184int rasops_init(struct rasops_info *, int, int); 185int rasops_reconfig(struct rasops_info *, int, int); 186void rasops_unpack_attr(long, int *, int *, int *); 187void rasops_eraserows(void *, int, int, long); 188void rasops_erasecols(void *, int, int, int, long); 189int rasops_get_cmap(struct rasops_info *, uint8_t *, size_t); 190 191extern const uint8_t rasops_cmap[256 * 3]; 192 193#ifdef _RASOPS_PRIVATE 194/* 195 * Per-depth initialization functions. 196 */ 197void rasops1_init(struct rasops_info *); 198void rasops2_init(struct rasops_info *); 199void rasops4_init(struct rasops_info *); 200void rasops8_init(struct rasops_info *); 201void rasops15_init(struct rasops_info *); 202void rasops24_init(struct rasops_info *); 203void rasops32_init(struct rasops_info *); 204 205#define ATTR_BG(ri, attr) ((ri)->ri_devcmap[((uint32_t)(attr) >> 16) & 0xf]) 206#define ATTR_FG(ri, attr) ((ri)->ri_devcmap[((uint32_t)(attr) >> 24) & 0xf]) 207 208#define ATTR_MASK_BG __BITS(16, 19) 209#define ATTR_MASK_FG __BITS(24, 27) 210 211#define DELTA(p, d, cast) ((p) = (cast)((uint8_t *)(p) + (d))) 212 213#define FBOFFSET(ri, row, col) \ 214 ((row) * (ri)->ri_yscale + (col) * (ri)->ri_xscale) 215 216#define FONT_GLYPH(uc, font, ri) \ 217 ((uint8_t *)(font)->data + ((uc) - ((font)->firstchar)) * \ 218 (ri)->ri_fontscale) 219 220static __inline void 221rasops_memset32(void *p, uint32_t val, size_t bytes) 222{ 223 int slop1, slop2, full; 224 uint8_t *dp = (uint8_t *)p; 225 226 if (bytes == 1) { 227 *dp = val; 228 return; 229 } 230 231 slop1 = (4 - ((uintptr_t)dp & 3)) & 3; 232 slop2 = (bytes - slop1) & 3; 233 full = (bytes - slop1 /* - slop2 */) >> 2; 234 235 if (slop1 & 1) 236 *dp++ = val; 237 238 if (slop1 & 2) { 239 *(uint16_t *)dp = val; 240 dp += 2; 241 } 242 243 for (; full; full--) { 244 *(uint32_t *)dp = val; 245 dp += 4; 246 } 247 248 if (slop2 & 2) { 249 *(uint16_t *)dp = val; 250 dp += 2; 251 } 252 253 if (slop2 & 1) 254 *dp = val; 255 256 return; 257} 258 259static __inline uint32_t 260rasops_be32uatoh(uint8_t *p) 261{ 262 uint32_t u; 263 264 u = p[0]; u <<= 8; 265 u |= p[1]; u <<= 8; 266 u |= p[2]; u <<= 8; 267 u |= p[3]; 268 return u; 269} 270#endif /* _RASOPS_PRIVATE */ 271 272#endif /* _RASOPS_H_ */ 273