1/* $NetBSD: wsdisplayvar.h,v 1.50 2013/01/31 10:57:30 macallan 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#include <sys/device.h>
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 */
54struct wsdisplay_emulops {
55	void	(*cursor)(void *, int, int, int);
56	int	(*mapchar)(void *, int, unsigned int *);
57	void	(*putchar)(void *, int, int, u_int, long);
58	void	(*copycols)(void *, int, int, int, int);
59	void	(*erasecols)(void *, int, int, int, long);
60	void	(*copyrows)(void *, int, int, int);
61	void	(*eraserows)(void *, int, int, long);
62	int	(*allocattr)(void *, int, int, int, 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 *, long, long);
88};
89
90struct 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
104struct wsdisplay_font;
105struct 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 */
113struct wsdisplay_accessops {
114	int	(*ioctl)(void *, void *, u_long, void *, int, struct lwp *);
115	paddr_t	(*mmap)(void *, void *, off_t, int);
116	int	(*alloc_screen)(void *, const struct wsscreen_descr *,
117				void **, int *, int *, long *);
118	void	(*free_screen)(void *, void *);
119	int	(*show_screen)(void *, void *, int,
120			       void (*)(void *, int, int), void *);
121	int	(*load_font)(void *, void *, struct wsdisplay_font *);
122	void	(*pollc)(void *, int);
123	void	(*scroll)(void *, void *, int);
124};
125
126/*
127 * Attachment information provided by wsdisplaydev devices when attaching
128 * wsdisplay units.
129 */
130struct wsdisplaydev_attach_args {
131	const struct wsdisplay_accessops *accessops;	/* access ops */
132	void	*accesscookie;				/* access cookie */
133};
134
135/* passed to wscons by the video driver to tell about its capabilities */
136struct wsscreen_list {
137	int nscreens;
138	const struct wsscreen_descr **screens;
139};
140
141/*
142 * Attachment information provided by wsemuldisplaydev devices when attaching
143 * wsdisplay units.
144 */
145struct wsemuldisplaydev_attach_args {
146	int	console;				/* is it console? */
147	const struct wsscreen_list *scrdata;		/* screen cfg info */
148	const struct wsdisplay_accessops *accessops;	/* access ops */
149	void	*accesscookie;				/* access cookie */
150};
151
152struct wscons_syncops {
153	int (*detach)(void *, int, void (*)(void *, int, int), void *);
154	int (*attach)(void *, int, void (*)(void *, int, int), void *);
155	int (*check)(void *);
156	void (*destroy)(void *);
157};
158
159/*
160 * Autoconfiguration helper functions.
161 */
162void	wsdisplay_cnattach(const struct wsscreen_descr *, void *, int, int,
163            long);
164void	wsdisplay_preattach(const struct wsscreen_descr *, void *, int, int,
165            long);
166
167int	wsdisplaydevprint(void *, const char *);
168int	wsemuldisplaydevprint(void *, const char *);
169
170int	wsdisplay_handlex(int);
171
172/*
173 * Console interface.
174 */
175void	wsdisplay_cnputc(dev_t, int);
176
177/*
178 * for use by compatibility code
179 */
180struct wsdisplay_softc;
181struct wsscreen;
182int wsscreen_attach_sync(struct wsscreen *,
183			 const struct wscons_syncops *, void *);
184int wsscreen_detach_sync(struct wsscreen *);
185int wsscreen_lookup_sync(struct wsscreen *,
186			 const struct wscons_syncops *, void **);
187
188int wsdisplay_maxscreenidx(struct wsdisplay_softc *);
189int wsdisplay_screenstate(struct wsdisplay_softc *, int);
190int wsdisplay_getactivescreen(struct wsdisplay_softc *);
191int wsscreen_switchwait(struct wsdisplay_softc *, int);
192
193int wsdisplay_internal_ioctl(struct wsdisplay_softc *, struct wsscreen *,
194			     u_long, void *, int, struct lwp *);
195
196int wsdisplay_usl_ioctl1(device_t, u_long, void *, int, struct lwp *);
197
198int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *,
199			 u_long, void *, int, struct lwp *);
200
201int wsdisplay_stat_ioctl(struct wsdisplay_softc *, u_long, void *,
202			 int, struct lwp *);
203
204int wsdisplay_cfg_ioctl(struct wsdisplay_softc *, u_long, void *,
205			int, struct lwp *);
206
207struct wsdisplayio_edid_info;
208int wsdisplayio_get_edid(device_t, struct wsdisplayio_edid_info *);
209
210struct wsdisplayio_fbinfo;
211struct rasops_info;
212int wsdisplayio_get_fbinfo(struct rasops_info *, struct wsdisplayio_fbinfo *);
213
214#ifdef WSDISPLAY_SCROLLSUPPORT
215void wsdisplay_scroll(void *, int);
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
223int wsdisplay_stat_inject(device_t, u_int, int);
224
225/*
226 * for general use
227 */
228#define WSDISPLAY_NULLSCREEN	-1
229const struct wsscreen_descr *wsdisplay_screentype_pick(
230    const struct wsscreen_list *, const char *);
231
232#if defined(_KERNEL)
233#  if defined(_KERNEL_OPT)
234#    include "opt_wsmsgattrs.h"
235#  endif
236#  if !defined(WS_DEFAULT_FG)
237#    define WS_DEFAULT_FG WSCOL_WHITE
238#  endif
239#  if !defined(WS_DEFAULT_BG)
240#    define WS_DEFAULT_BG WSCOL_BLACK
241#  endif
242#  if !defined(WS_DEFAULT_COLATTR)
243#    define WS_DEFAULT_COLATTR 0
244#  endif
245#  if !defined(WS_DEFAULT_MONOATTR)
246#    define WS_DEFAULT_MONOATTR 0
247#  endif
248#  if defined(WS_KERNEL_FG) || defined(WS_KERNEL_BG) || \
249      defined(WS_KERNEL_COLATTR) || defined(WS_KERNEL_MONOATTR)
250#    define WS_KERNEL_CUSTOMIZED
251#  else
252#    undef WS_KERNEL_CUSTOMIZED
253#  endif
254#  if !defined(WS_KERNEL_FG)
255#    define WS_KERNEL_FG WS_DEFAULT_FG
256#  endif
257#  if !defined(WS_KERNEL_BG)
258#    define WS_KERNEL_BG WS_DEFAULT_BG
259#  endif
260#  if !defined(WS_KERNEL_COLATTR)
261#    define WS_KERNEL_COLATTR WS_DEFAULT_COLATTR
262#  endif
263#  if !defined(WS_KERNEL_MONOATTR)
264#    define WS_KERNEL_MONOATTR WS_DEFAULT_MONOATTR
265#  endif
266#  if !defined(WSDISPLAY_BORDER_COLOR)
267#    define WSDISPLAY_BORDER_COLOR WSCOL_BLACK
268#  endif
269#endif /* _KERNEL */
270
271#endif /* !_DEV_WSCONS_WSDISPLAYVAR_H */
272