wsdisplayvar.h revision 1.53
1 /* $NetBSD: wsdisplayvar.h,v 1.53 2018/09/26 09:04:12 bouyer Exp $ */ 2 3 /* 4 * Copyright (c) 1996, 1997 Christopher G. Demetriou. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Christopher G. Demetriou 17 * for the NetBSD Project. 18 * 4. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifndef _DEV_WSCONS_WSDISPLAYVAR_H 34 #define _DEV_WSCONS_WSDISPLAYVAR_H 35 36 #include <sys/device.h> 37 38 /* 39 * WSDISPLAY interfaces 40 */ 41 42 /* 43 * Emulation functions, for displays that can support glass-tty terminal 44 * emulations. These are character oriented, with row and column 45 * numbers starting at zero in the upper left hand corner of the 46 * screen. 47 * 48 * These are used only when emulating a terminal. Therefore, displays 49 * drivers which cannot emulate terminals do not have to provide them. 50 * 51 * There is a "void *" cookie provided by the display driver associated 52 * with these functions, which is passed to them when they are invoked. 53 */ 54 struct wsdisplay_emulops { 55 void (*cursor)(void *, int, int, int); 56 int (*mapchar)(void *, int, unsigned int *); 57 void (*putchar)(void *, int, int, u_int, long); 58 void (*copycols)(void *, int, int, int, int); 59 void (*erasecols)(void *, int, int, int, long); 60 void (*copyrows)(void *, int, int, int); 61 void (*eraserows)(void *, int, int, long); 62 int (*allocattr)(void *, int, int, int, long *); 63 /* fg / bg values. Made identical to ANSI terminal color codes. */ 64 #define WSCOL_BLACK 0 65 #define WSCOL_RED 1 66 #define WSCOL_GREEN 2 67 #define WSCOL_BROWN 3 68 #define WSCOL_BLUE 4 69 #define WSCOL_MAGENTA 5 70 #define WSCOL_CYAN 6 71 #define WSCOL_WHITE 7 72 #define WSCOL_LIGHT_GREY (WSCOL_BLACK+8) 73 #define WSCOL_LIGHT_RED (WSCOL_RED+8) 74 #define WSCOL_LIGHT_GREEN (WSCOL_GREEN+8) 75 #define WSCOL_LIGHT_BROWN (WSCOL_BROWN+8) 76 #define WSCOL_LIGHT_BLUE (WSCOL_BLUE+8) 77 #define WSCOL_LIGHT_MAGENTA (WSCOL_MAGENTA+8) 78 #define WSCOL_LIGHT_CYAN (WSCOL_CYAN+8) 79 #define WSCOL_LIGHT_WHITE (WSCOL_WHITE+8) 80 /* flag values: */ 81 #define WSATTR_REVERSE 1 82 #define WSATTR_HILIT 2 83 #define WSATTR_BLINK 4 84 #define WSATTR_UNDERLINE 8 85 #define WSATTR_WSCOLORS 16 86 /* XXX need a free_attr() ??? */ 87 void (*replaceattr)(void *, long, long); 88 }; 89 90 struct wsscreen_descr { 91 const char *name; 92 int ncols, nrows; 93 const struct wsdisplay_emulops *textops; 94 int fontwidth, fontheight; 95 int capabilities; 96 #define WSSCREEN_WSCOLORS 1 /* minimal color capability */ 97 #define WSSCREEN_REVERSE 2 /* can display reversed */ 98 #define WSSCREEN_HILIT 4 /* can highlight (however) */ 99 #define WSSCREEN_BLINK 8 /* can blink */ 100 #define WSSCREEN_UNDERLINE 16 /* can underline */ 101 #define WSSCREEN_RESIZE 32 /* can resize */ 102 #define WSSCREEN_FREE 64 /* free() this struct when deleting 103 * internal only, do not set */ 104 void *modecookie; 105 }; 106 107 struct wsdisplay_font; 108 struct wsdisplay_char; 109 /* 110 * Display access functions, invoked by user-land programs which require 111 * direct device access, such as X11. 112 * 113 * There is a "void *" cookie provided by the display driver associated 114 * with these functions, which is passed to them when they are invoked. 115 */ 116 struct wsdisplay_accessops { 117 int (*ioctl)(void *, void *, u_long, void *, int, struct lwp *); 118 paddr_t (*mmap)(void *, void *, off_t, int); 119 int (*alloc_screen)(void *, const struct wsscreen_descr *, 120 void **, int *, int *, long *); 121 void (*free_screen)(void *, void *); 122 int (*show_screen)(void *, void *, int, 123 void (*)(void *, int, int), void *); 124 int (*load_font)(void *, void *, struct wsdisplay_font *); 125 void (*pollc)(void *, int); 126 void (*scroll)(void *, void *, int); 127 }; 128 129 /* 130 * Attachment information provided by wsdisplaydev devices when attaching 131 * wsdisplay units. 132 */ 133 struct wsdisplaydev_attach_args { 134 const struct wsdisplay_accessops *accessops; /* access ops */ 135 void *accesscookie; /* access cookie */ 136 }; 137 138 /* passed to wscons by the video driver to tell about its capabilities */ 139 struct wsscreen_list { 140 int nscreens; 141 const struct wsscreen_descr **screens; 142 }; 143 144 /* 145 * Attachment information provided by wsemuldisplaydev devices when attaching 146 * wsdisplay units. 147 */ 148 struct wsemuldisplaydev_attach_args { 149 int console; /* is it console? */ 150 const struct wsscreen_list *scrdata; /* screen cfg info */ 151 const struct wsdisplay_accessops *accessops; /* access ops */ 152 void *accesscookie; /* access cookie */ 153 }; 154 155 struct wscons_syncops { 156 int (*detach)(void *, int, void (*)(void *, int, int), void *); 157 int (*attach)(void *, int, void (*)(void *, int, int), void *); 158 int (*check)(void *); 159 void (*destroy)(void *); 160 }; 161 162 /* 163 * Autoconfiguration helper functions. 164 */ 165 void wsdisplay_cnattach(const struct wsscreen_descr *, void *, int, int, 166 long); 167 void wsdisplay_preattach(const struct wsscreen_descr *, void *, int, int, 168 long); 169 void wsdisplay_cndetach(void); 170 171 int wsdisplaydevprint(void *, const char *); 172 int wsemuldisplaydevprint(void *, const char *); 173 174 int wsdisplay_handlex(int); 175 176 /* 177 * Console interface. 178 */ 179 void wsdisplay_cnputc(dev_t, int); 180 181 /* 182 * for use by compatibility code 183 */ 184 struct wsdisplay_softc; 185 struct wsscreen; 186 int wsscreen_attach_sync(struct wsscreen *, 187 const struct wscons_syncops *, void *); 188 int wsscreen_detach_sync(struct wsscreen *); 189 int wsscreen_lookup_sync(struct wsscreen *, 190 const struct wscons_syncops *, void **); 191 192 int wsdisplay_maxscreenidx(struct wsdisplay_softc *); 193 int wsdisplay_screenstate(struct wsdisplay_softc *, int); 194 int wsdisplay_getactivescreen(struct wsdisplay_softc *); 195 int wsscreen_switchwait(struct wsdisplay_softc *, int); 196 197 int wsdisplay_internal_ioctl(struct wsdisplay_softc *, struct wsscreen *, 198 u_long, void *, int, struct lwp *); 199 200 int wsdisplay_usl_ioctl1(device_t, u_long, void *, int, struct lwp *); 201 202 int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *, 203 u_long, void *, int, struct lwp *); 204 205 int wsdisplay_stat_ioctl(struct wsdisplay_softc *, u_long, void *, 206 int, struct lwp *); 207 208 int wsdisplay_cfg_ioctl(struct wsdisplay_softc *, u_long, void *, 209 int, struct lwp *); 210 211 bool wsdisplay_isconsole(struct wsdisplay_softc *); 212 213 struct wsdisplayio_edid_info; 214 int wsdisplayio_get_edid(device_t, struct wsdisplayio_edid_info *); 215 216 struct wsdisplayio_fbinfo; 217 struct rasops_info; 218 int wsdisplayio_get_fbinfo(struct rasops_info *, struct wsdisplayio_fbinfo *); 219 220 #ifdef WSDISPLAY_SCROLLSUPPORT 221 void wsdisplay_scroll(void *, int); 222 #endif 223 224 #define WSDISPLAY_SCROLL_BACKWARD 1 225 #define WSDISPLAY_SCROLL_FORWARD (1 << 1) 226 #define WSDISPLAY_SCROLL_RESET (1 << 2) 227 #define WSDISPLAY_SCROLL_LOW (1 << 3) 228 229 int wsdisplay_stat_inject(device_t, u_int, int); 230 231 /* 232 * for general use 233 */ 234 #define WSDISPLAY_NULLSCREEN -1 235 const struct wsscreen_descr *wsdisplay_screentype_pick( 236 const struct wsscreen_list *, const char *); 237 238 #if defined(_KERNEL) 239 # if defined(_KERNEL_OPT) 240 # include "opt_wsmsgattrs.h" 241 # endif 242 # if !defined(WS_DEFAULT_FG) 243 # define WS_DEFAULT_FG WSCOL_WHITE 244 # endif 245 # if !defined(WS_DEFAULT_BG) 246 # define WS_DEFAULT_BG WSCOL_BLACK 247 # endif 248 # if !defined(WS_DEFAULT_COLATTR) 249 # define WS_DEFAULT_COLATTR 0 250 # endif 251 # if !defined(WS_DEFAULT_MONOATTR) 252 # define WS_DEFAULT_MONOATTR 0 253 # endif 254 # if defined(WS_KERNEL_FG) || defined(WS_KERNEL_BG) || \ 255 defined(WS_KERNEL_COLATTR) || defined(WS_KERNEL_MONOATTR) 256 # define WS_KERNEL_CUSTOMIZED 257 # else 258 # undef WS_KERNEL_CUSTOMIZED 259 # endif 260 # if !defined(WS_KERNEL_FG) 261 # define WS_KERNEL_FG WS_DEFAULT_FG 262 # endif 263 # if !defined(WS_KERNEL_BG) 264 # define WS_KERNEL_BG WS_DEFAULT_BG 265 # endif 266 # if !defined(WS_KERNEL_COLATTR) 267 # define WS_KERNEL_COLATTR WS_DEFAULT_COLATTR 268 # endif 269 # if !defined(WS_KERNEL_MONOATTR) 270 # define WS_KERNEL_MONOATTR WS_DEFAULT_MONOATTR 271 # endif 272 # if !defined(WSDISPLAY_BORDER_COLOR) 273 # define WSDISPLAY_BORDER_COLOR WSCOL_BLACK 274 # endif 275 #endif /* _KERNEL */ 276 277 #endif /* !_DEV_WSCONS_WSDISPLAYVAR_H */ 278
Indexes created Fri Sep 26 08:10:20 GMT 2025