1 | /* $NetBSD: wsdisplayvar.h,v 1.51 2014/01/21 00:08:27 mlelstv 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 | */ |
54 | struct 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 | |
90 | struct 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 | |
104 | struct wsdisplay_font; |
105 | struct 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 | */ |
113 | struct 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 | */ |
130 | struct 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 */ |
136 | struct 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 | */ |
145 | struct 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 | |
152 | struct 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 | */ |
162 | void wsdisplay_cnattach(const struct wsscreen_descr *, void *, int, int, |
163 | long); |
164 | void wsdisplay_preattach(const struct wsscreen_descr *, void *, int, int, |
165 | long); |
166 | void wsdisplay_cndetach(void); |
167 | |
168 | int wsdisplaydevprint(void *, const char *); |
169 | int wsemuldisplaydevprint(void *, const char *); |
170 | |
171 | int wsdisplay_handlex(int); |
172 | |
173 | /* |
174 | * Console interface. |
175 | */ |
176 | void wsdisplay_cnputc(dev_t, int); |
177 | |
178 | /* |
179 | * for use by compatibility code |
180 | */ |
181 | struct wsdisplay_softc; |
182 | struct wsscreen; |
183 | int wsscreen_attach_sync(struct wsscreen *, |
184 | const struct wscons_syncops *, void *); |
185 | int wsscreen_detach_sync(struct wsscreen *); |
186 | int wsscreen_lookup_sync(struct wsscreen *, |
187 | const struct wscons_syncops *, void **); |
188 | |
189 | int wsdisplay_maxscreenidx(struct wsdisplay_softc *); |
190 | int wsdisplay_screenstate(struct wsdisplay_softc *, int); |
191 | int wsdisplay_getactivescreen(struct wsdisplay_softc *); |
192 | int wsscreen_switchwait(struct wsdisplay_softc *, int); |
193 | |
194 | int wsdisplay_internal_ioctl(struct wsdisplay_softc *, struct wsscreen *, |
195 | u_long, void *, int, struct lwp *); |
196 | |
197 | int wsdisplay_usl_ioctl1(device_t, u_long, void *, int, struct lwp *); |
198 | |
199 | int wsdisplay_usl_ioctl2(struct wsdisplay_softc *, struct wsscreen *, |
200 | u_long, void *, int, struct lwp *); |
201 | |
202 | int wsdisplay_stat_ioctl(struct wsdisplay_softc *, u_long, void *, |
203 | int, struct lwp *); |
204 | |
205 | int wsdisplay_cfg_ioctl(struct wsdisplay_softc *, u_long, void *, |
206 | int, struct lwp *); |
207 | |
208 | struct wsdisplayio_edid_info; |
209 | int wsdisplayio_get_edid(device_t, struct wsdisplayio_edid_info *); |
210 | |
211 | struct wsdisplayio_fbinfo; |
212 | struct rasops_info; |
213 | int wsdisplayio_get_fbinfo(struct rasops_info *, struct wsdisplayio_fbinfo *); |
214 | |
215 | #ifdef WSDISPLAY_SCROLLSUPPORT |
216 | void wsdisplay_scroll(void *, int); |
217 | #endif |
218 | |
219 | #define WSDISPLAY_SCROLL_BACKWARD 1 |
220 | #define WSDISPLAY_SCROLL_FORWARD (1 << 1) |
221 | #define WSDISPLAY_SCROLL_RESET (1 << 2) |
222 | #define WSDISPLAY_SCROLL_LOW (1 << 3) |
223 | |
224 | int wsdisplay_stat_inject(device_t, u_int, int); |
225 | |
226 | /* |
227 | * for general use |
228 | */ |
229 | #define WSDISPLAY_NULLSCREEN -1 |
230 | const struct wsscreen_descr *wsdisplay_screentype_pick( |
231 | const struct wsscreen_list *, const char *); |
232 | |
233 | #if defined(_KERNEL) |
234 | # if defined(_KERNEL_OPT) |
235 | # include "opt_wsmsgattrs.h" |
236 | # endif |
237 | # if !defined(WS_DEFAULT_FG) |
238 | # define WS_DEFAULT_FG WSCOL_WHITE |
239 | # endif |
240 | # if !defined(WS_DEFAULT_BG) |
241 | # define WS_DEFAULT_BG WSCOL_BLACK |
242 | # endif |
243 | # if !defined(WS_DEFAULT_COLATTR) |
244 | # define WS_DEFAULT_COLATTR 0 |
245 | # endif |
246 | # if !defined(WS_DEFAULT_MONOATTR) |
247 | # define WS_DEFAULT_MONOATTR 0 |
248 | # endif |
249 | # if defined(WS_KERNEL_FG) || defined(WS_KERNEL_BG) || \ |
250 | defined(WS_KERNEL_COLATTR) || defined(WS_KERNEL_MONOATTR) |
251 | # define WS_KERNEL_CUSTOMIZED |
252 | # else |
253 | # undef WS_KERNEL_CUSTOMIZED |
254 | # endif |
255 | # if !defined(WS_KERNEL_FG) |
256 | # define WS_KERNEL_FG WS_DEFAULT_FG |
257 | # endif |
258 | # if !defined(WS_KERNEL_BG) |
259 | # define WS_KERNEL_BG WS_DEFAULT_BG |
260 | # endif |
261 | # if !defined(WS_KERNEL_COLATTR) |
262 | # define WS_KERNEL_COLATTR WS_DEFAULT_COLATTR |
263 | # endif |
264 | # if !defined(WS_KERNEL_MONOATTR) |
265 | # define WS_KERNEL_MONOATTR WS_DEFAULT_MONOATTR |
266 | # endif |
267 | # if !defined(WSDISPLAY_BORDER_COLOR) |
268 | # define WSDISPLAY_BORDER_COLOR WSCOL_BLACK |
269 | # endif |
270 | #endif /* _KERNEL */ |
271 | |
272 | #endif /* !_DEV_WSCONS_WSDISPLAYVAR_H */ |
273 | |