wsdisplayvar.h revision 1.7
1/* $OpenBSD: wsdisplayvar.h,v 1.7 2001/02/10 19:42:06 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 83struct wsscreen_descr { 84 char *name; 85 int ncols, nrows; 86 const struct wsdisplay_emulops *textops; 87 int fontwidth, fontheight; 88 int capabilities; 89#define WSSCREEN_WSCOLORS 1 /* minimal color capability */ 90#define WSSCREEN_REVERSE 2 /* can display reversed */ 91#define WSSCREEN_HILIT 4 /* can highlight (however) */ 92#define WSSCREEN_BLINK 8 /* can blink */ 93#define WSSCREEN_UNDERLINE 16 /* can underline */ 94}; 95 96struct wsdisplay_font; 97/* 98 * Display access functions, invoked by user-land programs which require 99 * direct device access, such as X11. 100 * 101 * There is a "void *" cookie provided by the display driver associated 102 * with these functions, which is passed to them when they are invoked. 103 */ 104struct wsdisplay_accessops { 105 int (*ioctl) __P((void *v, u_long cmd, caddr_t data, int flag, 106 struct proc *p)); 107 paddr_t (*mmap) __P((void *v, off_t off, int prot)); 108 int (*alloc_screen) __P((void *, const struct wsscreen_descr *, 109 void **, int *, int *, long *)); 110 void (*free_screen) __P((void *, void *)); 111 int (*show_screen) __P((void *, void *, int, 112 void (*) (void *, int, int), void *)); 113 int (*load_font) __P((void *, void *, struct wsdisplay_font *)); 114 void (*scrollback) __P((void *, void *, int)); 115 void (*pollc) __P((void *, int)); 116}; 117 118/* 119 * Attachment information provided by wsdisplaydev devices when attaching 120 * wsdisplay units. 121 */ 122struct wsdisplaydev_attach_args { 123 const struct wsdisplay_accessops *accessops; /* access ops */ 124 void *accesscookie; /* access cookie */ 125}; 126 127/* passed to wscons by the video driver to tell about its capabilities */ 128struct wsscreen_list { 129 int nscreens; 130 const struct wsscreen_descr **screens; 131}; 132 133/* 134 * Attachment information provided by wsemuldisplaydev devices when attaching 135 * wsdisplay units. 136 */ 137struct wsemuldisplaydev_attach_args { 138 int console; /* is it console? */ 139 const struct wsscreen_list *scrdata; /* screen cfg info */ 140 const struct wsdisplay_accessops *accessops; /* access ops */ 141 void *accesscookie; /* access cookie */ 142}; 143 144#define WSEMULDISPLAYDEVCF_CONSOLE 0 145#define wsemuldisplaydevcf_console cf_loc[WSEMULDISPLAYDEVCF_CONSOLE] /* spec'd as console? */ 146#define WSEMULDISPLAYDEVCF_CONSOLE_UNK -1 147 148struct wscons_syncops { 149 int (*detach) __P((void *, int, void (*)(void *, int, int), void *)); 150 int (*attach) __P((void *, int, void (*)(void *, int, int), void *)); 151 int (*check) __P((void *)); 152 void (*destroy) __P((void *)); 153}; 154 155/* 156 * Autoconfiguration helper functions. 157 */ 158void wsdisplay_cnattach __P((const struct wsscreen_descr *, void *, 159 int, int, long)); 160int wsdisplaydevprint __P((void *, const char *)); 161int wsemuldisplaydevprint __P((void *, const char *)); 162 163/* 164 * Console interface. 165 */ 166void wsdisplay_cnputc __P((dev_t dev, int i)); 167 168/* 169 * for use by compatibility code 170 */ 171struct wsdisplay_softc; 172struct wsscreen; 173int wsscreen_attach_sync __P((struct wsscreen *, 174 const struct wscons_syncops *, void *)); 175int wsscreen_detach_sync __P((struct wsscreen *)); 176int wsscreen_lookup_sync __P((struct wsscreen *, 177 const struct wscons_syncops *, void **)); 178 179int wsdisplay_maxscreenidx __P((struct wsdisplay_softc *)); 180int wsdisplay_screenstate __P((struct wsdisplay_softc *, int)); 181int wsdisplay_getactivescreen __P((struct wsdisplay_softc *)); 182int wsscreen_switchwait __P((struct wsdisplay_softc *, int)); 183 184int wsdisplay_internal_ioctl __P((struct wsdisplay_softc *sc, 185 struct wsscreen *, 186 u_long cmd, caddr_t data, 187 int flag, struct proc *p)); 188 189int wsdisplay_usl_ioctl1 __P((struct wsdisplay_softc *, 190 u_long, caddr_t, int, struct proc *)); 191 192int wsdisplay_usl_ioctl2 __P((struct wsdisplay_softc *, struct wsscreen *, 193 u_long, caddr_t, int, struct proc *)); 194 195int wsdisplay_cfg_ioctl __P((struct wsdisplay_softc *sc, 196 u_long cmd, caddr_t data, 197 int flag, struct proc *p)); 198 199/* 200 * for general use 201 */ 202#define WSDISPLAY_NULLSCREEN -1 203void wsdisplay_switchtoconsole __P((void)); 204const struct wsscreen_descr * 205 wsdisplay_screentype_pick __P((const struct wsscreen_list *, const char *)); 206 207/* 208 * for use by wskbd 209 */ 210void wsscrollback __P((void *, int op)); 211 212#define WSDISPLAY_SCROLL_BACKWARD 0 213#define WSDISPLAY_SCROLL_FORWARD 1 214#define WSDISPLAY_SCROLL_RESET 2 215