Home | History | Annotate | Line # | Download | only in wscons
wsdisplayvar.h revision 1.4
      1 /* $NetBSD: wsdisplayvar.h,v 1.4 1998/06/20 21:52:50 drochner 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 struct 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  */
     51 struct wsdisplay_emulops {
     52 	void	(*cursor) __P((void *c, int on, int row, int col));
     53 	void	(*putchar) __P((void *c, int row, int col,
     54 				u_int uc, long attr));
     55 	void	(*copycols) __P((void *c, int row, int srccol, int dstcol,
     56 		    int ncols));
     57 	void	(*erasecols) __P((void *c, int row, int startcol,
     58 		    int ncols, long));
     59 	void	(*copyrows) __P((void *c, int srcrow, int dstrow,
     60 		    int nrows));
     61 	void	(*eraserows) __P((void *c, int row, int nrows, long));
     62 	int	(*alloc_attr) __P((void *c, int fg, int bg, int flags, 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 /* flag values: */
     73 #define WSATTR_REVERSE	1
     74 #define WSATTR_HILIT	2
     75 #define WSATTR_BLINK	4
     76 #define WSATTR_UNDERLINE 8
     77 #define WSATTR_WSCOLORS 16
     78 	/* XXX need a free_attr() ??? */
     79 };
     80 
     81 struct wsscreen_descr {
     82 	char *name;
     83 	int ncols, nrows;
     84 	const struct wsdisplay_emulops *textops;
     85 	int fontwidth, fontheight;
     86 	int capabilities;
     87 #define WSSCREEN_WSCOLORS	1	/* minimal color capability */
     88 #define WSSCREEN_REVERSE	2	/* can display reversed */
     89 #define WSSCREEN_HILIT		4	/* can highlight (however) */
     90 #define WSSCREEN_BLINK		8	/* can blink */
     91 #define WSSCREEN_UNDERLINE	16	/* can underline */
     92 };
     93 
     94 /*
     95  * Display access functions, invoked by user-land programs which require
     96  * direct device access, such as X11.
     97  *
     98  * There is a "void *" cookie provided by the display driver associated
     99  * with these functions, which is passed to them when they are invoked.
    100  */
    101 struct wsdisplay_accessops {
    102 	int	(*ioctl) __P((void *v, u_long cmd, caddr_t data, int flag,
    103 		    struct proc *p));
    104 	int	(*mmap) __P((void *v, off_t off, int prot));
    105 	int	(*alloc_screen) __P((void *, const struct wsscreen_descr *,
    106 				     void **, int *, int *, long *));
    107 	void	(*free_screen) __P((void *, void *));
    108 	void	(*show_screen) __P((void *, void *));
    109 	int	(*load_font) __P((void *, void *, int, int, int, void *));
    110 };
    111 
    112 /*
    113  * Attachment information provided by wsdisplaydev devices when attaching
    114  * wsdisplay units.
    115  */
    116 struct wsdisplaydev_attach_args {
    117 	const struct wsdisplay_accessops *accessops;	/* access ops */
    118 	void	*accesscookie;				/* access cookie */
    119 };
    120 
    121 /* passed to wscons by the video driver to tell about its capabilities */
    122 struct wsscreen_list {
    123 	int nscreens;
    124 	const struct wsscreen_descr **screens;
    125 };
    126 
    127 /*
    128  * Attachment information provided by wsemuldisplaydev devices when attaching
    129  * wsdisplay units.
    130  */
    131 struct wsemuldisplaydev_attach_args {
    132 	int	console;				/* is it console? */
    133 	const struct wsscreen_list *scrdata;		/* screen cfg info */
    134 	const struct wsdisplay_accessops *accessops;	/* access ops */
    135 	void	*accesscookie;				/* access cookie */
    136 };
    137 
    138 #define	wsemuldisplaydevcf_console	cf_loc[0]	/* spec'd as console? */
    139 #define	WSEMULDISPLAYDEVCF_CONSOLE_UNK	-1
    140 
    141 struct wscons_syncops {
    142 	int (*detach) __P((void *, int, void (*)(void *, int), void *));
    143 	int (*attach) __P((void *, int));
    144 	int (*check) __P((void *));
    145 	void (*destroy) __P((void *));
    146 };
    147 
    148 /*
    149  * Autoconfiguration helper functions.
    150  */
    151 void	wsdisplay_cnattach __P((const struct wsscreen_descr *, void *,
    152 				int, int, long));
    153 int	wsdisplaydevprint __P((void *, const char *));
    154 int	wsemuldisplaydevprint __P((void *, const char *));
    155 
    156 /*
    157  * Console interface.
    158  */
    159 void	wsdisplay_cnputc __P((dev_t dev, int i));
    160 
    161 /*
    162  * for use by compatibility code
    163  */
    164 struct wsdisplay_softc;
    165 struct wsscreen;
    166 int wsscreen_attach_sync __P((struct wsscreen *,
    167 			      const struct wscons_syncops *, void *));
    168 int wsscreen_detach_sync __P((struct wsscreen *));
    169 int wsscreen_lookup_sync __P((struct wsscreen *,
    170 			      const struct wscons_syncops *, void **));
    171 
    172 int wsdisplay_maxscreenidx __P((struct wsdisplay_softc *));
    173 int wsdisplay_screenstate __P((struct wsdisplay_softc *, int));
    174 int wsdisplay_getactivescreen __P((struct wsdisplay_softc *));
    175 int wsscreen_switchwait __P((struct wsdisplay_softc *, int));
    176 
    177 int wsdisplay_internal_ioctl __P((struct wsdisplay_softc *sc,
    178 				  struct wsscreen *,
    179 				  u_long cmd, caddr_t data,
    180 				  int flag, struct proc *p));
    181 
    182 int wsdisplay_usl_ioctl __P((struct wsdisplay_softc *, struct wsscreen *,
    183 			     u_long, caddr_t, int, struct proc *));
    184