wsdisplayvar.h revision 1.5 1 /* $NetBSD: wsdisplayvar.h,v 1.5 1998/06/26 21:10:52 drochner 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) __P((void *c, int on, int row, int col));
53 unsigned int (*mapchar) __P((void *, int));
54 void (*putchar) __P((void *c, int row, int col,
55 u_int uc, long attr));
56 void (*copycols) __P((void *c, int row, int srccol, int dstcol,
57 int ncols));
58 void (*erasecols) __P((void *c, int row, int startcol,
59 int ncols, long));
60 void (*copyrows) __P((void *c, int srcrow, int dstrow,
61 int nrows));
62 void (*eraserows) __P((void *c, int row, int nrows, long));
63 int (*alloc_attr) __P((void *c, int fg, int bg, int flags, long *));
64 /* fg / bg values. Made identical to ANSI terminal color codes. */
65 #define WSCOL_BLACK 0
66 #define WSCOL_RED 1
67 #define WSCOL_GREEN 2
68 #define WSCOL_BROWN 3
69 #define WSCOL_BLUE 4
70 #define WSCOL_MAGENTA 5
71 #define WSCOL_CYAN 6
72 #define WSCOL_WHITE 7
73 /* flag values: */
74 #define WSATTR_REVERSE 1
75 #define WSATTR_HILIT 2
76 #define WSATTR_BLINK 4
77 #define WSATTR_UNDERLINE 8
78 #define WSATTR_WSCOLORS 16
79 /* XXX need a free_attr() ??? */
80 };
81
82 struct wsscreen_descr {
83 char *name;
84 int ncols, nrows;
85 const struct wsdisplay_emulops *textops;
86 int fontwidth, fontheight;
87 int capabilities;
88 #define WSSCREEN_WSCOLORS 1 /* minimal color capability */
89 #define WSSCREEN_REVERSE 2 /* can display reversed */
90 #define WSSCREEN_HILIT 4 /* can highlight (however) */
91 #define WSSCREEN_BLINK 8 /* can blink */
92 #define WSSCREEN_UNDERLINE 16 /* can underline */
93 };
94
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) __P((void *v, u_long cmd, caddr_t data, int flag,
104 struct proc *p));
105 int (*mmap) __P((void *v, off_t off, int prot));
106 int (*alloc_screen) __P((void *, const struct wsscreen_descr *,
107 void **, int *, int *, long *));
108 void (*free_screen) __P((void *, void *));
109 void (*show_screen) __P((void *, void *));
110 int (*load_font) __P((void *, void *, int, int, int, void *));
111 };
112
113 /*
114 * Attachment information provided by wsdisplaydev devices when attaching
115 * wsdisplay units.
116 */
117 struct wsdisplaydev_attach_args {
118 const struct wsdisplay_accessops *accessops; /* access ops */
119 void *accesscookie; /* access cookie */
120 };
121
122 /* passed to wscons by the video driver to tell about its capabilities */
123 struct wsscreen_list {
124 int nscreens;
125 const struct wsscreen_descr **screens;
126 };
127
128 /*
129 * Attachment information provided by wsemuldisplaydev devices when attaching
130 * wsdisplay units.
131 */
132 struct wsemuldisplaydev_attach_args {
133 int console; /* is it console? */
134 const struct wsscreen_list *scrdata; /* screen cfg info */
135 const struct wsdisplay_accessops *accessops; /* access ops */
136 void *accesscookie; /* access cookie */
137 };
138
139 #define wsemuldisplaydevcf_console cf_loc[0] /* spec'd as console? */
140 #define WSEMULDISPLAYDEVCF_CONSOLE_UNK -1
141
142 struct wscons_syncops {
143 int (*detach) __P((void *, int, void (*)(void *, int), void *));
144 int (*attach) __P((void *, int));
145 int (*check) __P((void *));
146 void (*destroy) __P((void *));
147 };
148
149 /*
150 * Autoconfiguration helper functions.
151 */
152 void wsdisplay_cnattach __P((const struct wsscreen_descr *, void *,
153 int, int, long));
154 int wsdisplaydevprint __P((void *, const char *));
155 int wsemuldisplaydevprint __P((void *, const char *));
156
157 /*
158 * Console interface.
159 */
160 void wsdisplay_cnputc __P((dev_t dev, int i));
161
162 /*
163 * for use by compatibility code
164 */
165 struct wsdisplay_softc;
166 struct wsscreen;
167 int wsscreen_attach_sync __P((struct wsscreen *,
168 const struct wscons_syncops *, void *));
169 int wsscreen_detach_sync __P((struct wsscreen *));
170 int wsscreen_lookup_sync __P((struct wsscreen *,
171 const struct wscons_syncops *, void **));
172
173 int wsdisplay_maxscreenidx __P((struct wsdisplay_softc *));
174 int wsdisplay_screenstate __P((struct wsdisplay_softc *, int));
175 int wsdisplay_getactivescreen __P((struct wsdisplay_softc *));
176 int wsscreen_switchwait __P((struct wsdisplay_softc *, int));
177
178 int wsdisplay_internal_ioctl __P((struct wsdisplay_softc *sc,
179 struct wsscreen *,
180 u_long cmd, caddr_t data,
181 int flag, struct proc *p));
182
183 int wsdisplay_usl_ioctl __P((struct wsdisplay_softc *, struct wsscreen *,
184 u_long, caddr_t, int, struct proc *));
185