wsconsio.h revision 1.23 1 /* $NetBSD: wsconsio.h,v 1.23 2000/01/07 03:13:23 enami 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 #define WSKBD_TYPE_NEXT 6 /* NeXT keyboard */
86
87 /* Manipulate the keyboard bell. */
88 struct wskbd_bell_data {
89 u_int which; /* values to get/set */
90 u_int pitch; /* pitch, in Hz */
91 u_int period; /* period, in milliseconds */
92 u_int volume; /* percentage of max volume */
93 };
94 #define WSKBD_BELL_DOPITCH 0x1 /* get/set pitch */
95 #define WSKBD_BELL_DOPERIOD 0x2 /* get/set period */
96 #define WSKBD_BELL_DOVOLUME 0x4 /* get/set volume */
97 #define WSKBD_BELL_DOALL 0x7 /* all of the above */
98
99 #define WSKBDIO_BELL _IO('W', 1)
100 #define WSKBDIO_COMPLEXBELL _IOW('W', 2, struct wskbd_bell_data)
101 #define WSKBDIO_SETBELL _IOW('W', 3, struct wskbd_bell_data)
102 #define WSKBDIO_GETBELL _IOR('W', 4, struct wskbd_bell_data)
103 #define WSKBDIO_SETDEFAULTBELL _IOW('W', 5, struct wskbd_bell_data)
104 #define WSKBDIO_GETDEFAULTBELL _IOR('W', 6, struct wskbd_bell_data)
105
106 /* Manipulate the emulation key repeat settings. */
107 struct wskbd_keyrepeat_data {
108 u_int which; /* values to get/set */
109 u_int del1; /* delay before first, ms */
110 u_int delN; /* delay before rest, ms */
111 };
112 #define WSKBD_KEYREPEAT_DODEL1 0x1 /* get/set del1 */
113 #define WSKBD_KEYREPEAT_DODELN 0x2 /* get/set delN */
114 #define WSKBD_KEYREPEAT_DOALL 0x3 /* all of the above */
115
116 #define WSKBDIO_SETKEYREPEAT _IOW('W', 7, struct wskbd_keyrepeat_data)
117 #define WSKBDIO_GETKEYREPEAT _IOR('W', 8, struct wskbd_keyrepeat_data)
118 #define WSKBDIO_SETDEFAULTKEYREPEAT \
119 _IOW('W', 9, struct wskbd_keyrepeat_data)
120 #define WSKBDIO_GETDEFAULTKEYREPEAT \
121 _IOR('W', 10, struct wskbd_keyrepeat_data)
122
123 /* Get/set keyboard leds */
124 #define WSKBD_LED_CAPS 0x01
125 #define WSKBD_LED_NUM 0x02
126 #define WSKBD_LED_SCROLL 0x04
127 #define WSKBD_LED_COMPOSE 0x08
128
129 #define WSKBDIO_SETLEDS _IOW('W', 11, int)
130 #define WSKBDIO_GETLEDS _IOR('W', 12, int)
131
132 /* Manipulate keysym groups. */
133 struct wskbd_map_data {
134 u_int maplen; /* number of entries in map */
135 struct wscons_keymap *map; /* map to get or set */
136 };
137 #define WSKBDIO_GETMAP _IOWR('W', 13, struct wskbd_map_data)
138 #define WSKBDIO_SETMAP _IOW('W', 14, struct wskbd_map_data)
139 #define WSKBDIO_GETENCODING _IOR('W', 15, int)
140 #define WSKBDIO_SETENCODING _IOW('W', 16, int)
141
142 /* internal use only */
143 #define WSKBDIO_SETMODE _IOW('W', 19, int)
144 #define WSKBDIO_GETMODE _IOR('W', 20, int)
145 #define WSKBD_TRANSLATED 0
146 #define WSKBD_RAW 1
147
148 /*
149 * Mouse ioctls (32 - 63)
150 */
151
152 /* Get mouse type */
153 #define WSMOUSEIO_GTYPE _IOR('W', 32, u_int)
154 #define WSMOUSE_TYPE_VSXXX 1 /* DEC serial */
155 #define WSMOUSE_TYPE_PS2 2 /* PS/2-compatible */
156 #define WSMOUSE_TYPE_USB 3 /* USB mouse */
157 #define WSMOUSE_TYPE_LMS 4 /* Logitech busmouse */
158 #define WSMOUSE_TYPE_MMS 5 /* Microsoft InPort mouse */
159
160 /* Set resolution. Not applicable to all mouse types. */
161 #define WSMOUSEIO_SRES _IOR('W', 33, u_int)
162 #define WSMOUSE_RES_MIN 0
163 #define WSMOUSE_RES_DEFAULT 75
164 #define WSMOUSE_RES_MAX 100
165
166 /* Set scale factor (num / den). Not applicable to all mouse types. */
167 #define WSMOUSEIO_SSCALE _IOR('W', 34, u_int[2])
168
169 /* Set sample rate. Not applicable to all mouse types. */
170 #define WSMOUSEIO_SRATE _IOR('W', 35, u_int)
171 #define WSMOUSE_RATE_MIN 0
172 #define WSMOUSE_RATE_DEFAULT 50
173 #define WSMOUSE_RATE_MAX 100
174
175 /*
176 * Display ioctls (64 - 95)
177 */
178
179 /* Get display type */
180 #define WSDISPLAYIO_GTYPE _IOR('W', 64, u_int)
181 #define WSDISPLAY_TYPE_UNKNOWN 0 /* unknown */
182 #define WSDISPLAY_TYPE_PM_MONO 1 /* DEC [23]100 mono */
183 #define WSDISPLAY_TYPE_PM_COLOR 2 /* DEC [23]100 color */
184 #define WSDISPLAY_TYPE_CFB 3 /* DEC TC CFB (CX) */
185 #define WSDISPLAY_TYPE_XCFB 4 /* DEC `maxine' onboard fb */
186 #define WSDISPLAY_TYPE_MFB 5 /* DEC TC MFB (MX) */
187 #define WSDISPLAY_TYPE_SFB 6 /* DEC TC SFB (HX) */
188 #define WSDISPLAY_TYPE_ISAVGA 7 /* (generic) ISA VGA */
189 #define WSDISPLAY_TYPE_PCIVGA 8 /* (generic) PCI VGA */
190 #define WSDISPLAY_TYPE_TGA 9 /* DEC PCI TGA */
191 #define WSDISPLAY_TYPE_SFBP 10 /* DEC TC SFB+ (HX+) */
192 #define WSDISPLAY_TYPE_PCIMISC 11 /* (generic) PCI misc. disp. */
193 #define WSDISPLAY_TYPE_NEXTMONO 12 /* NeXT mono display */
194 #define WSDISPLAY_TYPE_PX 13 /* DEC TC PX */
195 #define WSDISPLAY_TYPE_PXG 14 /* DEC TC PXG */
196 #define WSDISPLAY_TYPE_TX 15 /* DEC TC TX */
197
198 /* Basic display information. Not applicable to all display types. */
199 struct wsdisplay_fbinfo {
200 u_int height; /* height in pixels */
201 u_int width; /* width in pixels */
202 u_int depth; /* bits per pixel */
203 u_int cmsize; /* color map size (entries) */
204 };
205 #define WSDISPLAYIO_GINFO _IOR('W', 65, struct wsdisplay_fbinfo)
206
207 /* Colormap operations. Not applicable to all display types. */
208 struct wsdisplay_cmap {
209 u_int index; /* first element (0 origin) */
210 u_int count; /* number of elements */
211 u_char *red; /* red color map elements */
212 u_char *green; /* green color map elements */
213 u_char *blue; /* blue color map elements */
214 };
215 #define WSDISPLAYIO_GETCMAP _IOW('W', 66, struct wsdisplay_cmap)
216 #define WSDISPLAYIO_PUTCMAP _IOW('W', 67, struct wsdisplay_cmap)
217
218 /* Video control. Not applicable to all display types. */
219 #define WSDISPLAYIO_GVIDEO _IOR('W', 68, u_int)
220 #define WSDISPLAYIO_SVIDEO _IOW('W', 69, u_int)
221 #define WSDISPLAYIO_VIDEO_OFF 0 /* video off */
222 #define WSDISPLAYIO_VIDEO_ON 1 /* video on */
223
224 /* Cursor control. Not applicable to all display types. */
225 struct wsdisplay_curpos { /* cursor "position" */
226 u_int x, y;
227 };
228
229 struct wsdisplay_cursor {
230 u_int which; /* values to get/set */
231 u_int enable; /* enable/disable */
232 struct wsdisplay_curpos pos; /* position */
233 struct wsdisplay_curpos hot; /* hot spot */
234 struct wsdisplay_cmap cmap; /* color map info */
235 struct wsdisplay_curpos size; /* bit map size */
236 u_char *image; /* image data */
237 u_char *mask; /* mask data */
238 };
239 #define WSDISPLAY_CURSOR_DOCUR 0x01 /* get/set enable */
240 #define WSDISPLAY_CURSOR_DOPOS 0x02 /* get/set pos */
241 #define WSDISPLAY_CURSOR_DOHOT 0x04 /* get/set hot spot */
242 #define WSDISPLAY_CURSOR_DOCMAP 0x08 /* get/set cmap */
243 #define WSDISPLAY_CURSOR_DOSHAPE 0x10 /* get/set img/mask */
244 #define WSDISPLAY_CURSOR_DOALL 0x1f /* all of the above */
245
246 /* Cursor control: get and set position */
247 #define WSDISPLAYIO_GCURPOS _IOR('W', 70, struct wsdisplay_curpos)
248 #define WSDISPLAYIO_SCURPOS _IOW('W', 71, struct wsdisplay_curpos)
249
250 /* Cursor control: get maximum size */
251 #define WSDISPLAYIO_GCURMAX _IOR('W', 72, struct wsdisplay_curpos)
252
253 /* Cursor control: get/set cursor attributes/shape */
254 #define WSDISPLAYIO_GCURSOR _IOWR('W', 73, struct wsdisplay_cursor)
255 #define WSDISPLAYIO_SCURSOR _IOW('W', 74, struct wsdisplay_cursor)
256
257 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */
258 #define WSDISPLAYIO_GMODE _IOR('W', 75, u_int)
259 #define WSDISPLAYIO_SMODE _IOW('W', 76, u_int)
260 #define WSDISPLAYIO_MODE_EMUL 0 /* emulation (text) mode */
261 #define WSDISPLAYIO_MODE_MAPPED 1 /* mapped (graphics) mode */
262
263 /*
264 * XXX WARNING
265 * XXX The following definitions are very preliminary and are likely
266 * XXX to be changed without care about backwards compatibility!
267 */
268 struct wsdisplay_font {
269 char *name;
270 int firstchar, numchars;
271 int encoding;
272 #define WSDISPLAY_FONTENC_ISO 0
273 #define WSDISPLAY_FONTENC_IBM 1
274 #define WSDISPLAY_FONTENC_PCVT 2
275 int fontwidth, fontheight, stride;
276 int bitorder, byteorder;
277 #define WSDISPLAY_FONTORDER_KNOWN 0 /* i.e, no need to convert */
278 #define WSDISPLAY_FONTORDER_L2R 1
279 #define WSDISPLAY_FONTORDER_R2L 2
280 void *data;
281 };
282 #define WSDISPLAYIO_LDFONT _IOW('W', 77, struct wsdisplay_font)
283
284 struct wsdisplay_addscreendata {
285 int idx; /* screen index */
286 char *screentype;
287 char *emul;
288 };
289 #define WSDISPLAYIO_ADDSCREEN _IOW('W', 78, struct wsdisplay_addscreendata)
290
291 struct wsdisplay_delscreendata {
292 int idx; /* screen index */
293 int flags;
294 #define WSDISPLAY_DELSCR_FORCE 1
295 };
296 #define WSDISPLAYIO_DELSCREEN _IOW('W', 79, struct wsdisplay_delscreendata)
297
298 struct wsdisplay_usefontdata {
299 char *name;
300 };
301 #define WSDISPLAYIO_USEFONT _IOW('W', 80, struct wsdisplay_usefontdata)
302
303 /* Replaced by WSMUX_{ADD,REMOVE}_DEVICE */
304 struct wsdisplay_kbddata {
305 int op;
306 #define _O_WSDISPLAY_KBD_ADD 0
307 #define _O_WSDISPLAY_KBD_DEL 1
308 int idx;
309 };
310 #define _O_WSDISPLAYIO_SETKEYBOARD _IOWR('W', 81, struct wsdisplay_kbddata)
311
312 /* XXX NOT YET DEFINED */
313 /* Mapping information retrieval. */
314
315 /* Mux ioctls (96 - 127) */
316 #define WSMUX_INJECTEVENT _IOW('W', 96, struct wscons_event)
317
318 struct wsmux_device {
319 int type;
320 #define WSMUX_MOUSE 1
321 #define WSMUX_KBD 2
322 #define WSMUX_MUX 3
323 int idx;
324 };
325 #define WSMUX_ADD_DEVICE _IOW('W', 97, struct wsmux_device)
326 #define WSMUX_REMOVE_DEVICE _IOW('W', 98, struct wsmux_device)
327
328 #define WSMUX_MAXDEV 32
329 struct wsmux_device_list {
330 int ndevices;
331 struct wsmux_device devices[WSMUX_MAXDEV];
332 };
333 #define WSMUX_LIST_DEVICES _IOWR('W', 99, struct wsmux_device_list)
334
335 #endif /* _DEV_WSCONS_WSCONSIO_H_ */
336