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