wsdisplayvar.h revision 1.10
1/* $OpenBSD: wsdisplayvar.h,v 1.10 2001/05/08 22:28:43 mickey Exp $ */ 2/* $NetBSD: wsdisplayvar.h,v 1.14.4.1 2000/06/30 16:27:53 simonb Exp $ */ 3 4/* 5 * Copyright (c) 1996, 1997 Christopher G. Demetriou. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Christopher G. Demetriou 18 * for the NetBSD Project. 19 * 4. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34struct device; 35 36/* 37 * WSDISPLAY interfaces 38 */ 39 40/* 41 * Emulation functions, for displays that can support glass-tty terminal 42 * emulations. These are character oriented, with row and column 43 * numbers starting at zero in the upper left hand corner of the 44 * screen. 45 * 46 * These are used only when emulating a terminal. Therefore, displays 47 * drivers which cannot emulate terminals do not have to provide them. 48 * 49 * There is a "void *" cookie provided by the display driver associated 50 * with these functions, which is passed to them when they are invoked. 51 */ 52struct wsdisplay_emulops { 53 void (*cursor) __P((void *c, int on, int row, int col)); 54 int (*mapchar) __P((void *, int, unsigned int *)); 55 void (*putchar) __P((void *c, int row, int col, 56 u_int uc, long attr)); 57 void (*copycols) __P((void *c, int row, int srccol, int dstcol, 58 int ncols)); 59 void (*erasecols) __P((void *c, int row, int startcol, 60 int ncols, long)); 61 void (*copyrows) __P((void *c, int srcrow, int dstrow, 62 int nrows)); 63 void (*eraserows) __P((void *c, int row, int nrows, long)); 64 int (*alloc_attr) __P((void *c, int fg, int bg, int flags, long *)); 65/* fg / bg values. Made identical to ANSI terminal color codes. */ 66#define WSCOL_BLACK 0 67#define WSCOL_RED 1 68#define WSCOL_GREEN 2 69#define WSCOL_BROWN 3 70#define WSCOL_BLUE 4 71#define WSCOL_MAGENTA 5 72#define WSCOL_CYAN 6 73#define WSCOL_WHITE 7 74/* flag values: */ 75#define WSATTR_REVERSE 1 76#define WSATTR_HILIT 2 77#define WSATTR_BLINK 4 78#define WSATTR_UNDERLINE 8 79#define WSATTR_WSCOLORS 16 80 /* XXX need a free_attr() ??? */ 81}; 82 83#define WSSCREEN_NAME_SIZE 16 84 85struct wsscreen_descr { 86 char name[WSSCREEN_NAME_SIZE]; 87 int ncols, nrows; 88 const struct wsdisplay_emulops *textops; 89 int fontwidth, fontheight; 90 int capabilities; 91#define WSSCREEN_WSCOLORS 1 /* minimal color capability */ 92#define WSSCREEN_REVERSE 2 /* can display reversed */ 93#define WSSCREEN_HILIT 4 /* can highlight (however) */ 94#define WSSCREEN_BLINK 8 /* can blink */ 95#define WSSCREEN_UNDERLINE 16 /* can underline */ 96}; 97 98struct wsdisplay_font; 99/* 100 * Display access functions, invoked by user-land programs which require 101 * direct device access, such as X11. 102 * 103 * There is a "void *" cookie provided by the display driver associated 104 * with these functions, which is passed to them when they are invoked. 105 */ 106struct wsdisplay_accessops { 107 int (*ioctl) __P((void *v, u_long cmd, caddr_t data, int flag, 108 struct proc *p)); 109 paddr_t (*mmap) __P((void *v, off_t off, int prot)); 110 int (*alloc_screen) __P((void *, const struct wsscreen_descr *, 111 void **, int *, int *, long *)); 112 void (*free_screen) __P((void *, void *)); 113 int (*show_screen) __P((void *, void *, int, 114 void (*) (void *, int, int), void *)); 115 int (*load_font) __P((void *, void *, struct wsdisplay_font *)); 116 void (*scrollback) __P((void *, void *, int)); 117 u_int16_t (*getchar) __P((void *, int, int)); 118 void (*burn_screen) __P((void *, u_int, u_int)); 119 void (*pollc) __P((void *, int)); 120}; 121 122/* 123 * Attachment information provided by wsdisplaydev devices when attaching 124 * wsdisplay units. 125 */ 126struct wsdisplaydev_attach_args { 127 const struct wsdisplay_accessops *accessops; /* access ops */ 128 void *accesscookie; /* access cookie */ 129}; 130 131/* passed to wscons by the video driver to tell about its capabilities */ 132struct wsscreen_list { 133 int nscreens; 134 const struct wsscreen_descr **screens; 135}; 136 137/* 138 * Attachment information provided by wsemuldisplaydev devices when attaching 139 * wsdisplay units. 140 */ 141struct wsemuldisplaydev_attach_args { 142 int console; /* is it console? */ 143 const struct wsscreen_list *scrdata; /* screen cfg info */ 144 const struct wsdisplay_accessops *accessops; /* access ops */ 145 void *accesscookie; /* access cookie */ 146}; 147 148#define WSEMULDISPLAYDEVCF_CONSOLE 0 149#define wsemuldisplaydevcf_console cf_loc[WSEMULDISPLAYDEVCF_CONSOLE] /* spec'd as console? */ 150#define WSEMULDISPLAYDEVCF_CONSOLE_UNK -1 151 152struct wscons_syncops { 153 int (*detach) __P((void *, int, void (*)(void *, int, int), void *)); 154 int (*attach) __P((void *, int, void (*)(void *, int, int), void *)); 155 int (*check) __P((void *)); 156 void (*destroy) __P((void *)); 157}; 158 159/* 160 * Autoconfiguration helper functions. 161 */ 162void wsdisplay_cnattach __P((const struct wsscreen_descr *, void *, 163 int, int, long)); 164int wsdisplaydevprint __P((void *, const char *)); 165int wsemuldisplaydevprint __P((void *, const char *)); 166 167/* 168 * Console interface. 169 */ 170void wsdisplay_cnputc __P((dev_t dev, int i)); 171 172/* 173 * for use by compatibility code 174 */ 175struct wsdisplay_softc; 176struct wsscreen; 177int wsscreen_attach_sync __P((struct wsscreen *, 178 const struct wscons_syncops *, void *)); 179int wsscreen_detach_sync __P((struct wsscreen *)); 180int wsscreen_lookup_sync __P((struct wsscreen *, 181 const struct wscons_syncops *, void **)); 182 183int wsdisplay_maxscreenidx __P((struct wsdisplay_softc *)); 184int wsdisplay_screenstate __P((struct wsdisplay_softc *, int)); 185int wsdisplay_getactivescreen __P((struct wsdisplay_softc *)); 186int wsscreen_switchwait __P((struct wsdisplay_softc *, int)); 187 188int wsdisplay_internal_ioctl __P((struct wsdisplay_softc *sc, 189 struct wsscreen *, 190 u_long cmd, caddr_t data, 191 int flag, struct proc *p)); 192 193int wsdisplay_usl_ioctl1 __P((struct wsdisplay_softc *, 194 u_long, caddr_t, int, struct proc *)); 195 196int wsdisplay_usl_ioctl2 __P((struct wsdisplay_softc *, struct wsscreen *, 197 u_long, caddr_t, int, struct proc *)); 198 199int wsdisplay_cfg_ioctl __P((struct wsdisplay_softc *sc, 200 u_long cmd, caddr_t data, 201 int flag, struct proc *p)); 202 203/* 204 * for general use 205 */ 206#define WSDISPLAY_NULLSCREEN -1 207void wsdisplay_switchtoconsole __P((void)); 208const struct wsscreen_descr * 209 wsdisplay_screentype_pick __P((const struct wsscreen_list *, const char *)); 210 211/* 212 * for use by wskbd 213 */ 214void wsdisplay_burn __P((void *v, u_int flags)); 215void wsscrollback __P((void *v, int op)); 216 217#define WSDISPLAY_SCROLL_BACKWARD 0 218#define WSDISPLAY_SCROLL_FORWARD 1 219#define WSDISPLAY_SCROLL_RESET 2 220 221/* 222 * screen burner 223 */ 224#define WSDISPLAY_DEFBURNOUT 600000 /* ms */ 225#define WSDISPLAY_DEFBURNIN 250 /* ms */ 226 227