wsdisplayvar.h revision 1.21
1/* $NetBSD: wsdisplayvar.h,v 1.21 2002/06/26 23:05:37 christos 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 33struct device; 34 35/* 36 * WSDISPLAY interfaces 37 */ 38 39/* 40 * Emulation functions, for displays that can support glass-tty terminal 41 * emulations. These are character oriented, with row and column 42 * numbers starting at zero in the upper left hand corner of the 43 * screen. 44 * 45 * These are used only when emulating a terminal. Therefore, displays 46 * drivers which cannot emulate terminals do not have to provide them. 47 * 48 * There is a "void *" cookie provided by the display driver associated 49 * with these functions, which is passed to them when they are invoked. 50 */ 51struct wsdisplay_emulops { 52 void (*cursor)(void *c, int on, int row, int col); 53 int (*mapchar)(void *, int, unsigned int *); 54 void (*putchar)(void *c, int row, int col, u_int uc, long attr); 55 void (*copycols)(void *c, int row, int srccol, int dstcol,int ncols); 56 void (*erasecols)(void *c, int row, int startcol, int ncols, long); 57 void (*copyrows)(void *c, int srcrow, int dstrow, int nrows); 58 void (*eraserows)(void *c, int row, int nrows, long); 59 int (*alloc_attr)(void *c, int fg, int bg, int flags, long *); 60/* fg / bg values. Made identical to ANSI terminal color codes. */ 61#define WSCOL_BLACK 0 62#define WSCOL_RED 1 63#define WSCOL_GREEN 2 64#define WSCOL_BROWN 3 65#define WSCOL_BLUE 4 66#define WSCOL_MAGENTA 5 67#define WSCOL_CYAN 6 68#define WSCOL_WHITE 7 69/* flag values: */ 70#define WSATTR_REVERSE 1 71#define WSATTR_HILIT 2 72#define WSATTR_BLINK 4 73#define WSATTR_UNDERLINE 8 74#define WSATTR_WSCOLORS 16 75 /* XXX need a free_attr() ??? */ 76}; 77 78struct wsscreen_descr { 79 char *name; 80 int ncols, nrows; 81 const struct wsdisplay_emulops *textops; 82 int fontwidth, fontheight; 83 int capabilities; 84#define WSSCREEN_WSCOLORS 1 /* minimal color capability */ 85#define WSSCREEN_REVERSE 2 /* can display reversed */ 86#define WSSCREEN_HILIT 4 /* can highlight (however) */ 87#define WSSCREEN_BLINK 8 /* can blink */ 88#define WSSCREEN_UNDERLINE 16 /* can underline */ 89}; 90 91struct wsdisplay_font; 92struct wsdisplay_char; 93/* 94 * Display access functions, invoked by user-land programs which require 95 * direct device access, such as X11. 96 * 97 * There is a "void *" cookie provided by the display driver associated 98 * with these functions, which is passed to them when they are invoked. 99 */ 100struct wsdisplay_accessops { 101 int (*ioctl)(void *v, u_long cmd, caddr_t data, int flag, 102 struct proc *p); 103 paddr_t (*mmap)(void *v, off_t off, int prot); 104 int (*alloc_screen)(void *, const struct wsscreen_descr *, 105 void **, int *, int *, long *); 106 void (*free_screen)(void *, void *); 107 int (*show_screen)(void *, void *, int, 108 void (*) (void *, int, int), void *); 109 int (*load_font)(void *, void *, struct wsdisplay_font *); 110 void (*pollc)(void *, int); 111 int (*getwschar)(void *, struct wsdisplay_char *); 112 int (*putwschar)(void *, struct wsdisplay_char *); 113}; 114 115/* 116 * Attachment information provided by wsdisplaydev devices when attaching 117 * wsdisplay units. 118 */ 119struct wsdisplaydev_attach_args { 120 const struct wsdisplay_accessops *accessops; /* access ops */ 121 void *accesscookie; /* access cookie */ 122}; 123 124/* passed to wscons by the video driver to tell about its capabilities */ 125struct wsscreen_list { 126 int nscreens; 127 const struct wsscreen_descr **screens; 128}; 129 130/* 131 * Attachment information provided by wsemuldisplaydev devices when attaching 132 * wsdisplay units. 133 */ 134struct wsemuldisplaydev_attach_args { 135 int console; /* is it console? */ 136 const struct wsscreen_list *scrdata; /* screen cfg info */ 137 const struct wsdisplay_accessops *accessops; /* access ops */ 138 void *accesscookie; /* access cookie */ 139}; 140 141#include "locators.h" 142 143#define wsemuldisplaydevcf_console cf_loc[WSEMULDISPLAYDEVCF_CONSOLE] /* spec'd as console? */ 144#define WSEMULDISPLAYDEVCF_CONSOLE_UNK (WSEMULDISPLAYDEVCF_CONSOLE_DEFAULT) 145#define wsemuldisplaydevcf_kbdmux cf_loc[WSEMULDISPLAYDEVCF_KBDMUX] 146#define wsdisplaydevcf_kbdmux cf_loc[WSDISPLAYDEVCF_KBDMUX] 147 148struct wscons_syncops { 149 int (*detach)(void *, int, void (*)(void *, int, int), void *); 150 int (*attach)(void *, int, void (*)(void *, int, int), void *); 151 int (*check)(void *); 152 void (*destroy)(void *); 153}; 154 155/* 156 * Autoconfiguration helper functions. 157 */ 158void wsdisplay_cnattach(const struct wsscreen_descr *, void *,int,int, long); 159int wsdisplaydevprint(void *, const char *); 160int wsemuldisplaydevprint(void *, const char *); 161 162/* 163 * Console interface. 164 */ 165void wsdisplay_cnputc(dev_t dev, int i); 166 167/* 168 * for use by compatibility code 169 */ 170struct wsdisplay_softc; 171struct wsscreen; 172int wsscreen_attach_sync(struct wsscreen *, 173 const struct wscons_syncops *, void *); 174int wsscreen_detach_sync(struct wsscreen *); 175int wsscreen_lookup_sync(struct wsscreen *, 176 const struct wscons_syncops *, void **); 177 178int wsdisplay_maxscreenidx(struct wsdisplay_softc *); 179int wsdisplay_screenstate(struct wsdisplay_softc *, int); 180int wsdisplay_getactivescreen(struct wsdisplay_softc *); 181int wsscreen_switchwait(struct wsdisplay_softc *, int); 182 183int wsdisplay_internal_ioctl(struct wsdisplay_softc *sc, struct wsscreen *, 184 u_long cmd, caddr_t data,int flag, struct proc *p); 185 186int wsdisplay_usl_ioctl1(struct wsdisplay_softc *, 187 u_long, caddr_t, int, struct proc *); 188 189int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *, 190 u_long, caddr_t, int, struct proc *); 191 192int wsdisplay_stat_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data, 193 int flag, struct proc *p); 194 195int wsdisplay_cfg_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data, 196 int flag, struct proc *p); 197 198int wsdisplay_stat_inject(struct device *dev, u_int type, int value); 199 200/* 201 * for general use 202 */ 203#define WSDISPLAY_NULLSCREEN -1 204void wsdisplay_switchtoconsole(void); 205const struct wsscreen_descr * 206 wsdisplay_screentype_pick(const struct wsscreen_list *, const char *); 207