Home | History | Annotate | Line # | Download | only in wscons
wsdisplayvar.h revision 1.35
      1 /* $NetBSD: wsdisplayvar.h,v 1.35 2006/02/19 15:10:31 jmcneill 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 struct device;
     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 *c, int on, int row, int col);
     56 	int	(*mapchar)(void *, int, unsigned int *);
     57 	void	(*putchar)(void *c, int row, int col, u_int uc, long attr);
     58 	void	(*copycols)(void *c, int row, int srccol, int dstcol,int ncols);
     59 	void	(*erasecols)(void *c, int row, int startcol, int ncols, long);
     60 	void	(*copyrows)(void *c, int srcrow, int dstrow, int nrows);
     61 	void	(*eraserows)(void *c, int row, int nrows, long);
     62 	int	(*allocattr)(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 #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 *c, long oldattr, long newattr);
     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 	void *modecookie;
    102 };
    103 
    104 struct wsdisplay_font;
    105 struct wsdisplay_char;
    106 /*
    107  * Display access functions, invoked by user-land programs which require
    108  * direct device access, such as X11.
    109  *
    110  * There is a "void *" cookie provided by the display driver associated
    111  * with these functions, which is passed to them when they are invoked.
    112  */
    113 struct wsdisplay_accessops {
    114 	int	(*ioctl)(void *v, u_long cmd, caddr_t data, int flag,
    115 		    struct lwp *l);
    116 	paddr_t	(*mmap)(void *v, off_t off, int prot);
    117 	int	(*alloc_screen)(void *, const struct wsscreen_descr *,
    118 				     void **, int *, int *, long *);
    119 	void	(*free_screen)(void *, void *);
    120 	int	(*show_screen)(void *, void *, int,
    121 				    void (*) (void *, int, int), void *);
    122 	int	(*load_font)(void *, void *, struct wsdisplay_font *);
    123 	void	(*pollc)(void *, int);
    124 	int	(*getwschar)(void *, struct wsdisplay_char *);
    125 	int	(*putwschar)(void *, struct wsdisplay_char *);
    126 	void	(*scroll)(void *, void *, int);
    127 	u_int	(*getborder)(void *);
    128 	int	(*setborder)(void *, u_int);
    129 };
    130 
    131 /*
    132  * Attachment information provided by wsdisplaydev devices when attaching
    133  * wsdisplay units.
    134  */
    135 struct wsdisplaydev_attach_args {
    136 	const struct wsdisplay_accessops *accessops;	/* access ops */
    137 	void	*accesscookie;				/* access cookie */
    138 };
    139 
    140 /* passed to wscons by the video driver to tell about its capabilities */
    141 struct wsscreen_list {
    142 	int nscreens;
    143 	const struct wsscreen_descr **screens;
    144 };
    145 
    146 /*
    147  * Attachment information provided by wsemuldisplaydev devices when attaching
    148  * wsdisplay units.
    149  */
    150 struct wsemuldisplaydev_attach_args {
    151 	int	console;				/* is it console? */
    152 	const struct wsscreen_list *scrdata;		/* screen cfg info */
    153 	const struct wsdisplay_accessops *accessops;	/* access ops */
    154 	void	*accesscookie;				/* access cookie */
    155 };
    156 
    157 #include "locators.h"
    158 
    159 #define	wsemuldisplaydevcf_console	cf_loc[WSEMULDISPLAYDEVCF_CONSOLE]	/* spec'd as console? */
    160 #define	WSEMULDISPLAYDEVCF_CONSOLE_UNK	(WSEMULDISPLAYDEVCF_CONSOLE_DEFAULT)
    161 #define	wsemuldisplaydevcf_kbdmux	cf_loc[WSEMULDISPLAYDEVCF_KBDMUX]
    162 #define	wsdisplaydevcf_kbdmux		cf_loc[WSDISPLAYDEVCF_KBDMUX]
    163 
    164 struct wscons_syncops {
    165 	int (*detach)(void *, int, void (*)(void *, int, int), void *);
    166 	int (*attach)(void *, int, void (*)(void *, int, int), void *);
    167 	int (*check)(void *);
    168 	void (*destroy)(void *);
    169 };
    170 
    171 /*
    172  * Autoconfiguration helper functions.
    173  */
    174 void	wsdisplay_cnattach(const struct wsscreen_descr *, void *,int,int, long);
    175 int	wsdisplaydevprint(void *, const char *);
    176 int	wsemuldisplaydevprint(void *, const char *);
    177 
    178 /*
    179  * Console interface.
    180  */
    181 void	wsdisplay_cnputc(dev_t dev, int i);
    182 
    183 /*
    184  * for use by compatibility code
    185  */
    186 struct wsdisplay_softc;
    187 struct wsscreen;
    188 int wsscreen_attach_sync(struct wsscreen *,
    189 			 const struct wscons_syncops *, void *);
    190 int wsscreen_detach_sync(struct wsscreen *);
    191 int wsscreen_lookup_sync(struct wsscreen *,
    192 			 const struct wscons_syncops *, void **);
    193 
    194 int wsdisplay_maxscreenidx(struct wsdisplay_softc *);
    195 int wsdisplay_screenstate(struct wsdisplay_softc *, int);
    196 int wsdisplay_getactivescreen(struct wsdisplay_softc *);
    197 int wsscreen_switchwait(struct wsdisplay_softc *, int);
    198 
    199 int wsdisplay_internal_ioctl(struct wsdisplay_softc *sc, struct wsscreen *,
    200 			     u_long cmd, caddr_t data,int flag, struct lwp *l);
    201 
    202 int wsdisplay_usl_ioctl1(struct wsdisplay_softc *,
    203 			 u_long, caddr_t, int, struct lwp *);
    204 
    205 int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *,
    206 			 u_long, caddr_t, int, struct lwp *);
    207 
    208 int wsdisplay_stat_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data,
    209 			 int flag, struct lwp *l);
    210 
    211 int wsdisplay_cfg_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data,
    212 			int flag, struct lwp *l);
    213 
    214 #ifdef WSDISPLAY_SCROLLSUPPORT
    215 void wsdisplay_scroll (void *v, int op);
    216 #endif
    217 
    218 #define WSDISPLAY_SCROLL_BACKWARD	1
    219 #define WSDISPLAY_SCROLL_FORWARD	(1 << 1)
    220 #define WSDISPLAY_SCROLL_RESET		(1 << 2)
    221 #define WSDISPLAY_SCROLL_LOW		(1 << 3)
    222 
    223 int wsdisplay_stat_inject(struct device *dev, u_int type, int value);
    224 
    225 /*
    226  * for general use
    227  */
    228 #define WSDISPLAY_NULLSCREEN	-1
    229 void wsdisplay_switchtoconsole(void);
    230 const struct wsscreen_descr *
    231     wsdisplay_screentype_pick(const struct wsscreen_list *, const char *);
    232 
    233 #if defined(_KERNEL)
    234 #  if defined(_KERNEL_OPT)
    235 #    include "opt_wsmsgattrs.h"
    236 #    include "opt_wsdisplay_border.h"
    237 #  endif
    238 #  if !defined(WS_DEFAULT_FG)
    239 #    define WS_DEFAULT_FG WSCOL_WHITE
    240 #  endif
    241 #  if !defined(WS_DEFAULT_BG)
    242 #    define WS_DEFAULT_BG WSCOL_BLACK
    243 #  endif
    244 #  if !defined(WS_DEFAULT_COLATTR)
    245 #    define WS_DEFAULT_COLATTR 0
    246 #  endif
    247 #  if !defined(WS_DEFAULT_MONOATTR)
    248 #    define WS_DEFAULT_MONOATTR 0
    249 #  endif
    250 #  if defined(WS_KERNEL_FG) || defined(WS_KERNEL_BG) || \
    251       defined(WS_KERNEL_COLATTR) || defined(WS_KERNEL_MONOATTR)
    252 #    define WS_KERNEL_CUSTOMIZED
    253 #  else
    254 #    undef WS_KERNEL_CUSTOMIZED
    255 #  endif
    256 #  if !defined(WS_KERNEL_FG)
    257 #    define WS_KERNEL_FG WS_DEFAULT_FG
    258 #  endif
    259 #  if !defined(WS_KERNEL_BG)
    260 #    define WS_KERNEL_BG WS_DEFAULT_BG
    261 #  endif
    262 #  if !defined(WS_KERNEL_COLATTR)
    263 #    define WS_KERNEL_COLATTR WS_DEFAULT_COLATTR
    264 #  endif
    265 #  if !defined(WS_KERNEL_MONOATTR)
    266 #    define WS_KERNEL_MONOATTR WS_DEFAULT_MONOATTR
    267 #  endif
    268 #  if !defined(WSDISPLAY_BORDER_COLOR)
    269 #    define WSDISPLAY_BORDER_COLOR WSCOL_BLACK
    270 #  endif
    271 #endif /* _KERNEL */
    272 
    273 #endif /* !_DEV_WSCONS_WSDISPLAYVAR_H */
    274