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