| 1 | /* $NetBSD: rasops.h,v 1.31 2012/04/19 06:57:39 macallan 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 <dev/wscons/wsconsio.h> |
| 36 | #include <dev/wsfont/wsfont.h> |
| 37 | |
| 38 | /* For rasops_info::ri_flg */ |
| 39 | #define RI_FULLCLEAR 0x01 /* eraserows() hack to clear full screen */ |
| 40 | #define RI_FORCEMONO 0x02 /* monochrome output even if we can do color */ |
| 41 | #define RI_BSWAP 0x04 /* framebuffer endianness doesn't match CPU */ |
| 42 | #define RI_CURSOR 0x08 /* cursor is switched on */ |
| 43 | #define RI_CLEAR 0x10 /* clear display on startup */ |
| 44 | #define RI_CENTER 0x20 /* center onscreen output */ |
| 45 | #define RI_CURSORCLIP 0x40 /* cursor is currently clipped */ |
| 46 | #define RI_CFGDONE 0x80 /* rasops_reconfig() completed successfully */ |
| 47 | #define RI_ROTATE_CW 0x100 /* display is rotated, quarter clockwise */ |
| 48 | #define RI_ROTATE_CCW 0x200 /* display is rotated, quarter counter-clockwise */ |
| 49 | #define RI_ROTATE_UD 0x400 /* display is rotated, upside-down */ |
| 50 | #define RI_ROTATE_MASK 0x700 |
| 51 | /* |
| 52 | * if you call rasops_init() or rasops_reconfig() in a context where it is not |
| 53 | * safe to call kmem_alloc(), like early on during kernel startup, you MUST set |
| 54 | * RI_NO_AUTO to keep rasops from trying to allocate memory for autogenerated |
| 55 | * box drawing characters |
| 56 | */ |
| 57 | #define RI_NO_AUTO 0x800 /* do not generate box drawing characters */ |
| 58 | /* |
| 59 | * Set this if your driver's putchar() method supports anti-aliased fonts in |
| 60 | * the given video mode. Without this flag rasops_init() will only ever pick |
| 61 | * monochrome bitmap fonts. |
| 62 | */ |
| 63 | #define RI_ENABLE_ALPHA 0x1000 |
| 64 | /* set this in order to use r3g3b2 'true' colour in 8 bit */ |
| 65 | #define RI_8BIT_IS_RGB 0x2000 |
| 66 | |
| 67 | struct rasops_info { |
| 68 | /* These must be filled in by the caller */ |
| 69 | int ri_depth; /* depth in bits */ |
| 70 | u_char *ri_bits; /* ptr to bits */ |
| 71 | int ri_width; /* width (pels) */ |
| 72 | int ri_height; /* height (pels) */ |
| 73 | int ri_stride; /* stride in bytes */ |
| 74 | |
| 75 | /* |
| 76 | * If you want shadow framebuffer support, point ri_hwbits |
| 77 | * to the real framebuffer, and ri_bits to the shadow framebuffer |
| 78 | */ |
| 79 | u_char *ri_hwbits; |
| 80 | |
| 81 | /* |
| 82 | * These can optionally be left zeroed out. If you fill ri_font, |
| 83 | * but aren't using wsfont, set ri_wsfcookie to -1. |
| 84 | */ |
| 85 | struct wsdisplay_font *ri_font; |
| 86 | struct wsdisplay_font ri_optfont; |
| 87 | int ri_wsfcookie; /* wsfont cookie */ |
| 88 | void *ri_hw; /* driver private data; ignored by rasops */ |
| 89 | int ri_crow; /* cursor row */ |
| 90 | int ri_ccol; /* cursor column */ |
| 91 | int ri_flg; /* various operational flags */ |
| 92 | |
| 93 | /* |
| 94 | * These are optional and will default if zero. Meaningless |
| 95 | * on depths other than 15, 16, 24 and 32 bits per pel. On |
| 96 | * 24 bit displays, ri_{r,g,b}num must be 8. |
| 97 | */ |
| 98 | u_char ri_rnum; |
| 99 | /* number of bits for red */ |
| 100 | u_char ri_gnum; /* number of bits for green */ |
| 101 | u_char ri_bnum; /* number of bits for blue */ |
| 102 | u_char ri_rpos; /* which bit red starts at */ |
| 103 | u_char ri_gpos; /* which bit green starts at */ |
| 104 | u_char ri_bpos; /* which bit blue starts at */ |
| 105 | |
| 106 | /* These are filled in by rasops_init() */ |
| 107 | int ri_emuwidth; /* width we actually care about */ |
| 108 | int ri_emuheight; /* height we actually care about */ |
| 109 | int ri_emustride; /* bytes per row we actually care about */ |
| 110 | int ri_rows; /* number of rows (characters, not pels) */ |
| 111 | int ri_cols; /* number of columns (characters, not pels) */ |
| 112 | int ri_delta; /* row delta in bytes */ |
| 113 | int ri_pelbytes; /* bytes per pel (may be zero) */ |
| 114 | int ri_fontscale; /* fontheight * fontstride */ |
| 115 | int ri_xscale; /* fontwidth * pelbytes */ |
| 116 | int ri_yscale; /* fontheight * stride */ |
| 117 | u_char *ri_origbits; /* where screen bits actually start */ |
| 118 | u_char *ri_hworigbits; /* where hw bits actually start */ |
| 119 | int ri_xorigin; /* where ri_bits begins (x) */ |
| 120 | int ri_yorigin; /* where ri_bits begins (y) */ |
| 121 | int32_t ri_devcmap[16]; /* color -> framebuffer data */ |
| 122 | |
| 123 | /* The emulops you need to use, and the screen caps for wscons */ |
| 124 | struct wsdisplay_emulops ri_ops; |
| 125 | int ri_caps; |
| 126 | |
| 127 | /* Callbacks so we can share some code */ |
| 128 | void (*ri_do_cursor)(struct rasops_info *); |
| 129 | |
| 130 | #if NRASOPS_ROTATION > 0 |
| 131 | /* Used to intercept putchar to permit display rotation */ |
| 132 | struct wsdisplay_emulops ri_real_ops; |
| 133 | #endif |
| 134 | }; |
| 135 | |
| 136 | #define DELTA(p, d, cast) ((p) = (cast)((char *)(p) + (d))) |
| 137 | |
| 138 | #define CHAR_IN_FONT(c,font) \ |
| 139 | ((c) >= (font)->firstchar && \ |
| 140 | ((c) - (font)->firstchar) < (font)->numchars) |
| 141 | |
| 142 | #define PICK_FONT(ri, c) (((c & WSFONT_FLAGS_MASK) == WSFONT_FLAG_OPT) && \ |
| 143 | (ri->ri_optfont.data != NULL)) ? \ |
| 144 | &ri->ri_optfont : ri->ri_font |
| 145 | |
| 146 | /* |
| 147 | * rasops_init(). |
| 148 | * |
| 149 | * Integer parameters are the number of rows and columns we'd *like*. |
| 150 | * |
| 151 | * In terms of optimization, fonts that are a multiple of 8 pixels wide |
| 152 | * work the best. |
| 153 | * |
| 154 | * rasops_init() takes care of rasops_reconfig(). The parameters to both |
| 155 | * are the same. If calling rasops_reconfig() to change the font and |
| 156 | * ri_wsfcookie >= 0, you must call wsfont_unlock() on it, and reset it |
| 157 | * to -1 (or a new, valid cookie). |
| 158 | */ |
| 159 | |
| 160 | /* |
| 161 | * Per-depth initialization functions. These should not be called outside |
| 162 | * the rasops code. |
| 163 | */ |
| 164 | void rasops1_init(struct rasops_info *); |
| 165 | void rasops2_init(struct rasops_info *); |
| 166 | void rasops4_init(struct rasops_info *); |
| 167 | void rasops8_init(struct rasops_info *); |
| 168 | void rasops15_init(struct rasops_info *); |
| 169 | void rasops24_init(struct rasops_info *); |
| 170 | void rasops32_init(struct rasops_info *); |
| 171 | |
| 172 | /* rasops.c */ |
| 173 | int rasops_init(struct rasops_info *, int, int); |
| 174 | int rasops_reconfig(struct rasops_info *, int, int); |
| 175 | void rasops_unpack_attr(long, int *, int *, int *); |
| 176 | void rasops_eraserows(void *, int, int, long); |
| 177 | void rasops_erasecols(void *, int, int, int, long); |
| 178 | void rasops_copycols(void *, int, int, int, int); |
| 179 | int rasops_get_cmap(struct rasops_info *, uint8_t *, size_t); |
| 180 | |
| 181 | |
| 182 | extern const u_char rasops_isgray[16]; |
| 183 | extern const u_char rasops_cmap[256*3]; |
| 184 | |
| 185 | #endif /* _RASOPS_H_ */ |
| 186 | |