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