Home | History | Annotate | Line # | Download | only in wscons
wsdisplayvar.h revision 1.20
      1 /* $NetBSD: wsdisplayvar.h,v 1.20 2001/10/13 15:56:15 augustss 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)(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 
     78 struct 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 
     91 struct wsdisplay_font;
     92 /*
     93  * Display access functions, invoked by user-land programs which require
     94  * direct device access, such as X11.
     95  *
     96  * There is a "void *" cookie provided by the display driver associated
     97  * with these functions, which is passed to them when they are invoked.
     98  */
     99 struct wsdisplay_accessops {
    100 	int	(*ioctl)(void *v, u_long cmd, caddr_t data, int flag,
    101 		    struct proc *p);
    102 	paddr_t	(*mmap)(void *v, off_t off, int prot);
    103 	int	(*alloc_screen)(void *, const struct wsscreen_descr *,
    104 				     void **, int *, int *, long *);
    105 	void	(*free_screen)(void *, void *);
    106 	int	(*show_screen)(void *, void *, int,
    107 				    void (*) (void *, int, int), void *);
    108 	int	(*load_font)(void *, void *, struct wsdisplay_font *);
    109 	void	(*pollc)(void *, int);
    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 #include "locators.h"
    139 
    140 #define	wsemuldisplaydevcf_console	cf_loc[WSEMULDISPLAYDEVCF_CONSOLE]	/* spec'd as console? */
    141 #define	WSEMULDISPLAYDEVCF_CONSOLE_UNK	(WSEMULDISPLAYDEVCF_CONSOLE_DEFAULT)
    142 #define	wsemuldisplaydevcf_kbdmux	cf_loc[WSEMULDISPLAYDEVCF_KBDMUX]
    143 #define	wsdisplaydevcf_kbdmux		cf_loc[WSDISPLAYDEVCF_KBDMUX]
    144 
    145 struct wscons_syncops {
    146 	int (*detach)(void *, int, void (*)(void *, int, int), void *);
    147 	int (*attach)(void *, int, void (*)(void *, int, int), void *);
    148 	int (*check)(void *);
    149 	void (*destroy)(void *);
    150 };
    151 
    152 /*
    153  * Autoconfiguration helper functions.
    154  */
    155 void	wsdisplay_cnattach(const struct wsscreen_descr *, void *,int,int, long);
    156 int	wsdisplaydevprint(void *, const char *);
    157 int	wsemuldisplaydevprint(void *, const char *);
    158 
    159 /*
    160  * Console interface.
    161  */
    162 void	wsdisplay_cnputc(dev_t dev, int i);
    163 
    164 /*
    165  * for use by compatibility code
    166  */
    167 struct wsdisplay_softc;
    168 struct wsscreen;
    169 int wsscreen_attach_sync(struct wsscreen *,
    170 			 const struct wscons_syncops *, void *);
    171 int wsscreen_detach_sync(struct wsscreen *);
    172 int wsscreen_lookup_sync(struct wsscreen *,
    173 			 const struct wscons_syncops *, void **);
    174 
    175 int wsdisplay_maxscreenidx(struct wsdisplay_softc *);
    176 int wsdisplay_screenstate(struct wsdisplay_softc *, int);
    177 int wsdisplay_getactivescreen(struct wsdisplay_softc *);
    178 int wsscreen_switchwait(struct wsdisplay_softc *, int);
    179 
    180 int wsdisplay_internal_ioctl(struct wsdisplay_softc *sc, struct wsscreen *,
    181 			     u_long cmd, caddr_t data,int flag, struct proc *p);
    182 
    183 int wsdisplay_usl_ioctl1(struct wsdisplay_softc *,
    184 			 u_long, caddr_t, int, struct proc *);
    185 
    186 int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *,
    187 			 u_long, caddr_t, int, struct proc *);
    188 
    189 int wsdisplay_cfg_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data,
    190 			int flag, struct proc *p);
    191 
    192 /*
    193  * for general use
    194  */
    195 #define WSDISPLAY_NULLSCREEN	-1
    196 void wsdisplay_switchtoconsole(void);
    197 const struct wsscreen_descr *
    198     wsdisplay_screentype_pick(const struct wsscreen_list *, const char *);
    199