wsdisplayvar.h revision 1.32 1 /* $NetBSD: wsdisplayvar.h,v 1.32 2005/05/23 09:44:57 martin 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 (*allocattr)(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 #define WSCOL_LIGHT_GREY (WSCOL_BLACK+8)
70 #define WSCOL_LIGHT_RED (WSCOL_RED+8)
71 #define WSCOL_LIGHT_GREEN (WSCOL_GREEN+8)
72 #define WSCOL_LIGHT_BROWN (WSCOL_BROWN+8)
73 #define WSCOL_LIGHT_BLUE (WSCOL_BLUE+8)
74 #define WSCOL_LIGHT_MAGENTA (WSCOL_MAGENTA+8)
75 #define WSCOL_LIGHT_CYAN (WSCOL_CYAN+8)
76 #define WSCOL_LIGHT_WHITE (WSCOL_WHITE+8)
77 /* flag values: */
78 #define WSATTR_REVERSE 1
79 #define WSATTR_HILIT 2
80 #define WSATTR_BLINK 4
81 #define WSATTR_UNDERLINE 8
82 #define WSATTR_WSCOLORS 16
83 /* XXX need a free_attr() ??? */
84 void (*replaceattr)(void *c, long oldattr, long newattr);
85 };
86
87 struct wsscreen_descr {
88 char *name;
89 int ncols, nrows;
90 const struct wsdisplay_emulops *textops;
91 int fontwidth, fontheight;
92 int capabilities;
93 #define WSSCREEN_WSCOLORS 1 /* minimal color capability */
94 #define WSSCREEN_REVERSE 2 /* can display reversed */
95 #define WSSCREEN_HILIT 4 /* can highlight (however) */
96 #define WSSCREEN_BLINK 8 /* can blink */
97 #define WSSCREEN_UNDERLINE 16 /* can underline */
98 void *modecookie;
99 };
100
101 struct wsdisplay_font;
102 struct wsdisplay_char;
103 /*
104 * Display access functions, invoked by user-land programs which require
105 * direct device access, such as X11.
106 *
107 * There is a "void *" cookie provided by the display driver associated
108 * with these functions, which is passed to them when they are invoked.
109 */
110 struct wsdisplay_accessops {
111 int (*ioctl)(void *v, u_long cmd, caddr_t data, int flag,
112 struct proc *p);
113 paddr_t (*mmap)(void *v, off_t off, int prot);
114 int (*alloc_screen)(void *, const struct wsscreen_descr *,
115 void **, int *, int *, long *);
116 void (*free_screen)(void *, void *);
117 int (*show_screen)(void *, void *, int,
118 void (*) (void *, int, int), void *);
119 int (*load_font)(void *, void *, struct wsdisplay_font *);
120 void (*pollc)(void *, int);
121 int (*getwschar)(void *, struct wsdisplay_char *);
122 int (*putwschar)(void *, struct wsdisplay_char *);
123 void (*scroll)(void *, void *, int);
124 u_int (*getborder)(void *);
125 int (*setborder)(void *, u_int);
126 };
127
128 /*
129 * Attachment information provided by wsdisplaydev devices when attaching
130 * wsdisplay units.
131 */
132 struct wsdisplaydev_attach_args {
133 const struct wsdisplay_accessops *accessops; /* access ops */
134 void *accesscookie; /* access cookie */
135 };
136
137 /* passed to wscons by the video driver to tell about its capabilities */
138 struct wsscreen_list {
139 int nscreens;
140 const struct wsscreen_descr **screens;
141 };
142
143 /*
144 * Attachment information provided by wsemuldisplaydev devices when attaching
145 * wsdisplay units.
146 */
147 struct wsemuldisplaydev_attach_args {
148 int console; /* is it console? */
149 const struct wsscreen_list *scrdata; /* screen cfg info */
150 const struct wsdisplay_accessops *accessops; /* access ops */
151 void *accesscookie; /* access cookie */
152 };
153
154 #include "locators.h"
155
156 #define wsemuldisplaydevcf_console cf_loc[WSEMULDISPLAYDEVCF_CONSOLE] /* spec'd as console? */
157 #define WSEMULDISPLAYDEVCF_CONSOLE_UNK (WSEMULDISPLAYDEVCF_CONSOLE_DEFAULT)
158 #define wsemuldisplaydevcf_kbdmux cf_loc[WSEMULDISPLAYDEVCF_KBDMUX]
159 #define wsdisplaydevcf_kbdmux cf_loc[WSDISPLAYDEVCF_KBDMUX]
160
161 struct 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 */
171 void wsdisplay_cnattach(const struct wsscreen_descr *, void *,int,int, long);
172 int wsdisplaydevprint(void *, const char *);
173 int wsemuldisplaydevprint(void *, const char *);
174
175 /*
176 * Console interface.
177 */
178 void wsdisplay_cnputc(dev_t dev, int i);
179
180 /*
181 * for use by compatibility code
182 */
183 struct wsdisplay_softc;
184 struct wsscreen;
185 int wsscreen_attach_sync(struct wsscreen *,
186 const struct wscons_syncops *, void *);
187 int wsscreen_detach_sync(struct wsscreen *);
188 int wsscreen_lookup_sync(struct wsscreen *,
189 const struct wscons_syncops *, void **);
190
191 int wsdisplay_maxscreenidx(struct wsdisplay_softc *);
192 int wsdisplay_screenstate(struct wsdisplay_softc *, int);
193 int wsdisplay_getactivescreen(struct wsdisplay_softc *);
194 int wsscreen_switchwait(struct wsdisplay_softc *, int);
195
196 int wsdisplay_internal_ioctl(struct wsdisplay_softc *sc, struct wsscreen *,
197 u_long cmd, caddr_t data,int flag, struct proc *p);
198
199 int wsdisplay_usl_ioctl1(struct wsdisplay_softc *,
200 u_long, caddr_t, int, struct proc *);
201
202 int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *,
203 u_long, caddr_t, int, struct proc *);
204
205 int wsdisplay_stat_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data,
206 int flag, struct proc *p);
207
208 int wsdisplay_cfg_ioctl(struct wsdisplay_softc *sc, u_long cmd, caddr_t data,
209 int flag, struct proc *p);
210
211 #ifdef WSDISPLAY_SCROLLSUPPORT
212 void wsdisplay_scroll (void *v, int op);
213 #endif
214
215 #define WSDISPLAY_SCROLL_BACKWARD 1
216 #define WSDISPLAY_SCROLL_FORWARD (1 << 1)
217 #define WSDISPLAY_SCROLL_RESET (1 << 2)
218 #define WSDISPLAY_SCROLL_LOW (1 << 3)
219
220 int wsdisplay_stat_inject(struct device *dev, u_int type, int value);
221
222 /*
223 * for general use
224 */
225 #define WSDISPLAY_NULLSCREEN -1
226 void wsdisplay_switchtoconsole(void);
227 const struct wsscreen_descr *
228 wsdisplay_screentype_pick(const struct wsscreen_list *, const char *);
229
230 #if defined(_KERNEL)
231 # if defined(_KERNEL_OPT)
232 # include "opt_wsmsgattrs.h"
233 # include "opt_wsdisplay_border.h"
234 # endif
235 # if !defined(WS_DEFAULT_FG)
236 # define WS_DEFAULT_FG WSCOL_WHITE
237 # endif
238 # if !defined(WS_DEFAULT_BG)
239 # define WS_DEFAULT_BG WSCOL_BLACK
240 # endif
241 # if !defined(WS_DEFAULT_COLATTR)
242 # define WS_DEFAULT_COLATTR 0
243 # endif
244 # if !defined(WS_DEFAULT_MONOATTR)
245 # define WS_DEFAULT_MONOATTR 0
246 # endif
247 # if defined(WS_KERNEL_FG) || defined(WS_KERNEL_BG) || \
248 defined(WS_KERNEL_COLATTR) || defined(WS_KERNEL_MONOATTR)
249 # define WS_KERNEL_CUSTOMIZED
250 # else
251 # undef WS_KERNEL_CUSTOMIZED
252 # endif
253 # if !defined(WS_KERNEL_FG)
254 # define WS_KERNEL_FG WS_DEFAULT_FG
255 # endif
256 # if !defined(WS_KERNEL_BG)
257 # define WS_KERNEL_BG WS_DEFAULT_BG
258 # endif
259 # if !defined(WS_KERNEL_COLATTR)
260 # define WS_KERNEL_COLATTR WS_DEFAULT_COLATTR
261 # endif
262 # if !defined(WS_KERNEL_MONOATTR)
263 # define WS_KERNEL_MONOATTR WS_DEFAULT_MONOATTR
264 # endif
265 # if !defined(WSDISPLAY_BORDER_COLOR)
266 # define WSDISPLAY_BORDER_COLOR WSCOL_BLACK
267 # endif
268 #endif /* _KERNEL */
269