1/* $NetBSD: wsdisplayvar.h,v 1.55 2019/01/30 11:24:48 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#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#define WSATTR_USERMASK 0x0fff
87/* private flags used by the driver */
88#define WSATTR_PRIVATE1 4096
89#define WSATTR_PRIVATE2 8192
90#define WSATTR_PRIVATE3 16384
91#define WSATTR_PRIVATE4 32768
92 /* XXX need a free_attr() ??? */
93 void (*replaceattr)(void *, long, long);
94};
95
96struct wsscreen_descr {
97 const char *name;
98 int ncols, nrows;
99 const struct wsdisplay_emulops *textops;
100 int fontwidth, fontheight;
101 int capabilities;
102#define WSSCREEN_WSCOLORS 1 /* minimal color capability */
103#define WSSCREEN_REVERSE 2 /* can display reversed */
104#define WSSCREEN_HILIT 4 /* can highlight (however) */
105#define WSSCREEN_BLINK 8 /* can blink */
106#define WSSCREEN_UNDERLINE 16 /* can underline */
107#define WSSCREEN_RESIZE 32 /* can resize */
108#define WSSCREEN_FREE 64 /* free() this struct when deleting
109 * internal only, do not set */
110 void *modecookie;
111};
112
113struct wsdisplay_font;
114struct wsdisplay_char;
115/*
116 * Display access functions, invoked by user-land programs which require
117 * direct device access, such as X11.
118 *
119 * There is a "void *" cookie provided by the display driver associated
120 * with these functions, which is passed to them when they are invoked.
121 */
122struct wsdisplay_accessops {
123 int (*ioctl)(void *, void *, u_long, void *, int, struct lwp *);
124 paddr_t (*mmap)(void *, void *, off_t, int);
125 int (*alloc_screen)(void *, const struct wsscreen_descr *,
126 void **, int *, int *, long *);
127 void (*free_screen)(void *, void *);
128 int (*show_screen)(void *, void *, int,
129 void (*)(void *, int, int), void *);
130 int (*load_font)(void *, void *, struct wsdisplay_font *);
131 void (*pollc)(void *, int);
132 void (*scroll)(void *, void *, int);
133};
134
135/*
136 * Attachment information provided by wsdisplaydev devices when attaching
137 * wsdisplay units.
138 */
139struct wsdisplaydev_attach_args {
140 const struct wsdisplay_accessops *accessops; /* access ops */
141 void *accesscookie; /* access cookie */
142};
143
144/* passed to wscons by the video driver to tell about its capabilities */
145struct wsscreen_list {
146 int nscreens;
147 const struct wsscreen_descr **screens;
148};
149
150/*
151 * Attachment information provided by wsemuldisplaydev devices when attaching
152 * wsdisplay units.
153 */
154struct wsemuldisplaydev_attach_args {
155 int console; /* is it console? */
156 const struct wsscreen_list *scrdata; /* screen cfg info */
157 const struct wsdisplay_accessops *accessops; /* access ops */
158 void *accesscookie; /* access cookie */
159};
160
161struct wscons_syncops {
162 int (*detach)(void *, int, void (*)(void *, int, int), void *);
163 int (*attach)(void *, int, void (*)(void *, int, int), void *);
164 int (*check)(void *);
165 void (*destroy)(void *);
166};
167
168/*
169 * Autoconfiguration helper functions.
170 */
171void wsdisplay_cnattach(const struct wsscreen_descr *, void *, int, int,
172 long);
173void wsdisplay_preattach(const struct wsscreen_descr *, void *, int, int,
174 long);
175void wsdisplay_cndetach(void);
176void wsdisplay_multicons_suspend(bool);
177
178int wsdisplaydevprint(void *, const char *);
179int wsemuldisplaydevprint(void *, const char *);
180
181int wsdisplay_handlex(int);
182
183/*
184 * Console interface.
185 */
186void wsdisplay_cnputc(dev_t, int);
187
188/*
189 * for use by compatibility code
190 */
191struct wsdisplay_softc;
192struct wsscreen;
193int wsscreen_attach_sync(struct wsscreen *,
194 const struct wscons_syncops *, void *);
195int wsscreen_detach_sync(struct wsscreen *);
196int wsscreen_lookup_sync(struct wsscreen *,
197 const struct wscons_syncops *, void **);
198
199int wsdisplay_maxscreenidx(struct wsdisplay_softc *);
200int wsdisplay_screenstate(struct wsdisplay_softc *, int);
201int wsdisplay_getactivescreen(struct wsdisplay_softc *);
202int wsscreen_switchwait(struct wsdisplay_softc *, int);
203
204int wsdisplay_internal_ioctl(struct wsdisplay_softc *, struct wsscreen *,
205 u_long, void *, int, struct lwp *);
206
207int wsdisplay_usl_ioctl1(device_t, u_long, void *, int, struct lwp *);
208
209int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *,
210 u_long, void *, int, struct lwp *);
211
212int wsdisplay_stat_ioctl(struct wsdisplay_softc *, u_long, void *,
213 int, struct lwp *);
214
215int wsdisplay_cfg_ioctl(struct wsdisplay_softc *, u_long, void *,
216 int, struct lwp *);
217
218bool wsdisplay_isconsole(struct wsdisplay_softc *);
219
220struct wsdisplayio_edid_info;
221int wsdisplayio_get_edid(device_t, struct wsdisplayio_edid_info *);
222
223struct wsdisplayio_fbinfo;
224struct rasops_info;
225int wsdisplayio_get_fbinfo(struct rasops_info *, struct wsdisplayio_fbinfo *);
226
227#ifdef WSDISPLAY_SCROLLSUPPORT
228void wsdisplay_scroll(void *, int);
229#endif
230
231#define WSDISPLAY_SCROLL_BACKWARD 1
232#define WSDISPLAY_SCROLL_FORWARD (1 << 1)
233#define WSDISPLAY_SCROLL_RESET (1 << 2)
234#define WSDISPLAY_SCROLL_LOW (1 << 3)
235
236int wsdisplay_stat_inject(device_t, u_int, int);
237
238/*
239 * for general use
240 */
241#define WSDISPLAY_NULLSCREEN -1
242const struct wsscreen_descr *wsdisplay_screentype_pick(
243 const struct wsscreen_list *, const char *);
244
245#if defined(_KERNEL)
246# if defined(_KERNEL_OPT)
247# include "opt_wsmsgattrs.h"
248# endif
249# if !defined(WS_DEFAULT_FG)
250# define WS_DEFAULT_FG WSCOL_WHITE
251# endif
252# if !defined(WS_DEFAULT_BG)
253# define WS_DEFAULT_BG WSCOL_BLACK
254# endif
255# if !defined(WS_DEFAULT_COLATTR)
256# define WS_DEFAULT_COLATTR 0
257# endif
258# if !defined(WS_DEFAULT_MONOATTR)
259# define WS_DEFAULT_MONOATTR 0
260# endif
261# if defined(WS_KERNEL_FG) || defined(WS_KERNEL_BG) || \
262 defined(WS_KERNEL_COLATTR) || defined(WS_KERNEL_MONOATTR)
263# define WS_KERNEL_CUSTOMIZED
264# else
265# undef WS_KERNEL_CUSTOMIZED
266# endif
267# if !defined(WS_KERNEL_FG)
268# define WS_KERNEL_FG WS_DEFAULT_FG
269# endif
270# if !defined(WS_KERNEL_BG)
271# define WS_KERNEL_BG WS_DEFAULT_BG
272# endif
273# if !defined(WS_KERNEL_COLATTR)
274# define WS_KERNEL_COLATTR WS_DEFAULT_COLATTR
275# endif
276# if !defined(WS_KERNEL_MONOATTR)
277# define WS_KERNEL_MONOATTR WS_DEFAULT_MONOATTR
278# endif
279# if !defined(WSDISPLAY_BORDER_COLOR)
280# define WSDISPLAY_BORDER_COLOR WSCOL_BLACK
281# endif
282#endif /* _KERNEL */
283
284#endif /* !_DEV_WSCONS_WSDISPLAYVAR_H */
285