wsconsio.h revision 1.14 1 /* $NetBSD: wsconsio.h,v 1.14 1999/01/26 13:43:00 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 #ifndef _DEV_WSCONS_WSCONSIO_H_
34 #define _DEV_WSCONS_WSCONSIO_H_
35
36 /*
37 * WSCONS (wsdisplay, wskbd, wsmouse) exported interfaces.
38 *
39 * Ioctls are all in group 'W'. Ioctl number space is partitioned like:
40 * 0-31 keyboard ioctls (WSKBDIO)
41 * 32-63 mouse ioctls (WSMOUSEIO)
42 * 64-95 display ioctls (WSDISPLAYIO)
43 * 96-255 reserved for future use
44 */
45
46 #include <sys/types.h>
47 #include <sys/ioccom.h>
48 #include <dev/wscons/wsksymvar.h>
49
50
51 /*
52 * Common event structure (used by keyboard and mouse)
53 */
54 struct wscons_event {
55 u_int type;
56 int value;
57 struct timespec time;
58 };
59
60 /* Event type definitions. Comment for each is information in value. */
61 #define WSCONS_EVENT_KEY_UP 1 /* key code */
62 #define WSCONS_EVENT_KEY_DOWN 2 /* key code */
63 #define WSCONS_EVENT_ALL_KEYS_UP 3 /* void */
64 #define WSCONS_EVENT_MOUSE_UP 4 /* button # (leftmost = 0) */
65 #define WSCONS_EVENT_MOUSE_DOWN 5 /* button # (leftmost = 0) */
66 #define WSCONS_EVENT_MOUSE_DELTA_X 6 /* X delta amount */
67 #define WSCONS_EVENT_MOUSE_DELTA_Y 7 /* Y delta amount */
68 #define WSCONS_EVENT_MOUSE_ABSOLUTE_X 8 /* X location */
69 #define WSCONS_EVENT_MOUSE_ABSOLUTE_Y 9 /* Y location */
70 #define WSCONS_EVENT_MOUSE_DELTA_Z 10 /* Z delta amount */
71 #define WSCONS_EVENT_MOUSE_ABSOLUTE_Z 11 /* Z location */
72
73
74 /*
75 * Keyboard ioctls (0 - 31)
76 */
77
78 /* Get keyboard type. */
79 #define WSKBDIO_GTYPE _IOR('W', 0, u_int)
80 #define WSKBD_TYPE_LK201 1 /* lk-201 */
81 #define WSKBD_TYPE_LK401 2 /* lk-401 */
82 #define WSKBD_TYPE_PC_XT 3 /* PC-ish, XT scancode */
83 #define WSKBD_TYPE_PC_AT 4 /* PC-ish, AT scancode */
84 #define WSKBD_TYPE_USB 5 /* USB, XT scancode */
85
86 /* Manipulate the keyboard bell. */
87 struct wskbd_bell_data {
88 u_int which; /* values to get/set */
89 u_int pitch; /* pitch, in Hz */
90 u_int period; /* period, in milliseconds */
91 u_int volume; /* percentage of max volume */
92 };
93 #define WSKBD_BELL_DOPITCH 0x1 /* get/set pitch */
94 #define WSKBD_BELL_DOPERIOD 0x2 /* get/set period */
95 #define WSKBD_BELL_DOVOLUME 0x4 /* get/set volume */
96 #define WSKBD_BELL_DOALL 0x7 /* all of the above */
97
98 #define WSKBDIO_BELL _IO('W', 1)
99 #define WSKBDIO_COMPLEXBELL _IOW('W', 2, struct wskbd_bell_data)
100 #define WSKBDIO_SETBELL _IOW('W', 3, struct wskbd_bell_data)
101 #define WSKBDIO_GETBELL _IOR('W', 4, struct wskbd_bell_data)
102 #define WSKBDIO_SETDEFAULTBELL _IOW('W', 5, struct wskbd_bell_data)
103 #define WSKBDIO_GETDEFAULTBELL _IOR('W', 6, struct wskbd_bell_data)
104
105 /* Manipulate the emulation key repeat settings. */
106 struct wskbd_keyrepeat_data {
107 u_int which; /* values to get/set */
108 u_int del1; /* delay before first, ms */
109 u_int delN; /* delay before rest, ms */
110 };
111 #define WSKBD_KEYREPEAT_DODEL1 0x1 /* get/set del1 */
112 #define WSKBD_KEYREPEAT_DODELN 0x2 /* get/set delN */
113 #define WSKBD_KEYREPEAT_DOALL 0x3 /* all of the above */
114
115 #define WSKBDIO_SETKEYREPEAT _IOW('W', 7, struct wskbd_keyrepeat_data)
116 #define WSKBDIO_GETKEYREPEAT _IOR('W', 8, struct wskbd_keyrepeat_data)
117 #define WSKBDIO_SETDEFAULTKEYREPEAT \
118 _IOW('W', 9, struct wskbd_keyrepeat_data)
119 #define WSKBDIO_GETDEFAULTKEYREPEAT \
120 _IOR('W', 10, struct wskbd_keyrepeat_data)
121
122 /* Get/set keyboard leds */
123 #define WSKBD_LED_CAPS 0x01
124 #define WSKBD_LED_NUM 0x02
125 #define WSKBD_LED_SCROLL 0x04
126 #define WSKBD_LED_COMPOSE 0x08
127
128 #define WSKBDIO_SETLEDS _IOW('W', 11, int)
129 #define WSKBDIO_GETLEDS _IOR('W', 12, int)
130
131 /* Manipulate keysym groups. */
132 struct wskbd_map_data {
133 u_int maplen; /* number of entries in map */
134 struct wscons_keymap *map; /* map to get or set */
135 };
136 #define WSKBDIO_GETMAP _IOWR('W', 13, struct wskbd_map_data)
137 #define WSKBDIO_SETMAP _IOW('W', 14, struct wskbd_map_data)
138 #define WSKBDIO_GETENCODING _IOR('W', 15, int)
139 #define WSKBDIO_SETENCODING _IOW('W', 16, int)
140
141 /* internal use only */
142 #define WSKBDIO_SETMODE _IOW('W', 19, int)
143 #define WSKBDIO_GETMODE _IOR('W', 20, int)
144 #define WSKBD_TRANSLATED 0
145 #define WSKBD_RAW 1
146
147 /*
148 * Mouse ioctls (32 - 63)
149 */
150
151 /* Get mouse type */
152 #define WSMOUSEIO_GTYPE _IOR('W', 32, u_int)
153 #define WSMOUSE_TYPE_VSXXX 1 /* DEC TC(?) serial */
154 #define WSMOUSE_TYPE_PS2 2 /* PS/2-compatible */
155 #define WSMOUSE_TYPE_USB 3 /* USB mouse */
156 #define WSMOUSE_TYPE_LMS 4 /* Logitech busmouse */
157 #define WSMOUSE_TYPE_MMS 5 /* Microsoft InPort mouse */
158
159 /*
160 * Display ioctls (64 - 95)
161 */
162
163 /* Get display type */
164 #define WSDISPLAYIO_GTYPE _IOR('W', 64, u_int)
165 #define WSDISPLAY_TYPE_UNKNOWN 0 /* unknown */
166 #define WSDISPLAY_TYPE_PM_MONO 1 /* ??? */
167 #define WSDISPLAY_TYPE_PM_COLOR 2 /* ??? */
168 #define WSDISPLAY_TYPE_CFB 3 /* DEC TC CFB */
169 #define WSDISPLAY_TYPE_XCFB 4 /* ??? */
170 #define WSDISPLAY_TYPE_MFB 5 /* DEC TC MFB */
171 #define WSDISPLAY_TYPE_SFB 6 /* DEC TC SFB */
172 #define WSDISPLAY_TYPE_ISAVGA 7 /* (generic) ISA VGA */
173 #define WSDISPLAY_TYPE_PCIVGA 8 /* (generic) PCI VGA */
174 #define WSDISPLAY_TYPE_TGA 9 /* DEC PCI TGA */
175 #define WSDISPLAY_TYPE_SFBP 10 /* DEC TC SFB+ */
176 #define WSDISPLAY_TYPE_PCIMISC 11 /* (generic) PCI misc. disp. */
177
178 /* Basic display information. Not applicable to all display types. */
179 struct wsdisplay_fbinfo {
180 u_int height; /* height in pixels */
181 u_int width; /* width in pixels */
182 u_int depth; /* bits per pixel */
183 u_int cmsize; /* color map size (entries) */
184 };
185 #define WSDISPLAYIO_GINFO _IOR('W', 65, struct wsdisplay_fbinfo)
186
187 /* Colormap operations. Not applicable to all display types. */
188 struct wsdisplay_cmap {
189 u_int index; /* first element (0 origin) */
190 u_int count; /* number of elements */
191 u_char *red; /* red color map elements */
192 u_char *green; /* green color map elements */
193 u_char *blue; /* blue color map elements */
194 };
195 #define WSDISPLAYIO_GETCMAP _IOW('W', 66, struct wsdisplay_cmap)
196 #define WSDISPLAYIO_PUTCMAP _IOW('W', 67, struct wsdisplay_cmap)
197
198 /* Video control. Not applicable to all display types. */
199 #define WSDISPLAYIO_GVIDEO _IOR('W', 68, u_int)
200 #define WSDISPLAYIO_SVIDEO _IOW('W', 69, u_int)
201 #define WSDISPLAYIO_VIDEO_OFF 0 /* video off */
202 #define WSDISPLAYIO_VIDEO_ON 1 /* video on */
203
204 /* Cursor control. Not applicable to all display types. */
205 struct wsdisplay_curpos { /* cursor "position" */
206 u_int x, y;
207 };
208
209 struct wsdisplay_cursor {
210 u_int which; /* values to get/set */
211 u_int enable; /* enable/disable */
212 struct wsdisplay_curpos pos; /* position */
213 struct wsdisplay_curpos hot; /* hot spot */
214 struct wsdisplay_cmap cmap; /* color map info */
215 struct wsdisplay_curpos size; /* bit map size */
216 u_char *image; /* image data */
217 u_char *mask; /* mask data */
218 };
219 #define WSDISPLAY_CURSOR_DOCUR 0x01 /* get/set enable */
220 #define WSDISPLAY_CURSOR_DOPOS 0x02 /* get/set pos */
221 #define WSDISPLAY_CURSOR_DOHOT 0x04 /* get/set hot spot */
222 #define WSDISPLAY_CURSOR_DOCMAP 0x08 /* get/set cmap */
223 #define WSDISPLAY_CURSOR_DOSHAPE 0x10 /* get/set img/mask */
224 #define WSDISPLAY_CURSOR_DOALL 0x1f /* all of the above */
225
226 /* Cursor control: get and set position */
227 #define WSDISPLAYIO_GCURPOS _IOR('W', 70, struct wsdisplay_curpos)
228 #define WSDISPLAYIO_SCURPOS _IOW('W', 71, struct wsdisplay_curpos)
229
230 /* Cursor control: get maximum size */
231 #define WSDISPLAYIO_GCURMAX _IOR('W', 72, struct wsdisplay_curpos)
232
233 /* Cursor control: get/set cursor attributes/shape */
234 #define WSDISPLAYIO_GCURSOR _IOWR('W', 73, struct wsdisplay_cursor)
235 #define WSDISPLAYIO_SCURSOR _IOW('W', 74, struct wsdisplay_cursor)
236
237 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */
238 #define WSDISPLAYIO_GMODE _IOR('W', 75, u_int)
239 #define WSDISPLAYIO_SMODE _IOW('W', 76, u_int)
240 #define WSDISPLAYIO_MODE_EMUL 0 /* emulation (text) mode */
241 #define WSDISPLAYIO_MODE_MAPPED 1 /* mapped (graphics) mode */
242
243 /*
244 * XXX WARNING
245 * XXX The following 3 definitions are very preliminary and are likely
246 * XXX to be changed without care about backwards compatibility!
247 */
248 struct wsdisplay_font {
249 char *name;
250 int firstchar, numchars;
251 int encoding;
252 #define WSDISPLAY_FONTENC_ISO 0
253 #define WSDISPLAY_FONTENC_IBM 1
254 #define WSDISPLAY_FONTENC_PCVT 2
255 int fontwidth, fontheight, stride; /* XXX endianness??? */
256 void *data;
257 };
258 #define WSDISPLAYIO_LDFONT _IOW('W', 77, struct wsdisplay_font)
259
260 struct wsdisplay_addscreendata {
261 int idx; /* screen index */
262 char *screentype;
263 char *emul;
264 };
265 #define WSDISPLAYIO_ADDSCREEN _IOW('W', 78, struct wsdisplay_addscreendata)
266
267 struct wsdisplay_delscreendata {
268 int idx; /* screen index */
269 int flags;
270 #define WSDISPLAY_DELSCR_FORCE 1
271 };
272 #define WSDISPLAYIO_DELSCREEN _IOW('W', 79, struct wsdisplay_delscreendata)
273
274 struct wsdisplay_usefontdata {
275 char *name;
276 };
277 #define WSDISPLAYIO_USEFONT _IOW('W', 80, struct wsdisplay_usefontdata)
278
279 /* XXX NOT YET DEFINED */
280 /* Mapping information retrieval. */
281
282 #endif /* _DEV_WSCONS_WSCONSIO_H_ */
283