wsconsio.h revision 1.54 1 /* $NetBSD: wsconsio.h,v 1.54 2003/01/03 04:36:28 takemura 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-127 mux ioctls (WSMUXIO)
44 * 128-255 reserved for future use
45 */
46
47 #include <sys/types.h>
48 #include <sys/ioccom.h>
49 #include <dev/wscons/wsksymvar.h>
50
51
52 /*
53 * Common event structure (used by keyboard and mouse)
54 */
55 struct wscons_event {
56 u_int type;
57 int value;
58 struct timespec time;
59 };
60
61 /* Event type definitions. Comment for each is information in value. */
62 #define WSCONS_EVENT_KEY_UP 1 /* key code */
63 #define WSCONS_EVENT_KEY_DOWN 2 /* key code */
64 #define WSCONS_EVENT_ALL_KEYS_UP 3 /* void */
65 #define WSCONS_EVENT_MOUSE_UP 4 /* button # (leftmost = 0) */
66 #define WSCONS_EVENT_MOUSE_DOWN 5 /* button # (leftmost = 0) */
67 #define WSCONS_EVENT_MOUSE_DELTA_X 6 /* X delta amount */
68 #define WSCONS_EVENT_MOUSE_DELTA_Y 7 /* Y delta amount */
69 #define WSCONS_EVENT_MOUSE_ABSOLUTE_X 8 /* X location */
70 #define WSCONS_EVENT_MOUSE_ABSOLUTE_Y 9 /* Y location */
71 #define WSCONS_EVENT_MOUSE_DELTA_Z 10 /* Z delta amount */
72 #define WSCONS_EVENT_MOUSE_ABSOLUTE_Z 11 /* Z location */
73 #define WSCONS_EVENT_SCREEN_SWITCH 12 /* New screen number */
74
75
76 /*
77 * Keyboard ioctls (0 - 31)
78 */
79
80 /* Get keyboard type. */
81 #define WSKBDIO_GTYPE _IOR('W', 0, u_int)
82 #define WSKBD_TYPE_LK201 1 /* lk-201 */
83 #define WSKBD_TYPE_LK401 2 /* lk-401 */
84 #define WSKBD_TYPE_PC_XT 3 /* PC-ish, XT scancode */
85 #define WSKBD_TYPE_PC_AT 4 /* PC-ish, AT scancode */
86 #define WSKBD_TYPE_USB 5 /* USB, XT scancode */
87 #define WSKBD_TYPE_NEXT 6 /* NeXT keyboard */
88 #define WSKBD_TYPE_HPC_KBD 7 /* HPC bultin keyboard */
89 #define WSKBD_TYPE_HPC_BTN 8 /* HPC/PsPC buttons */
90 #define WSKBD_TYPE_ARCHIMEDES 9 /* Archimedes keyboard */
91 #define WSKBD_TYPE_RISCPC 10 /* RiscPC keyboard, resembling AT codes */
92 #define WSKBD_TYPE_ADB 11 /* ADB */
93 #define WSKBD_TYPE_HIL 12 /* HIL keyboard */
94 #define WSKBD_TYPE_AMIGA 13 /* Amiga keyboard */
95 #define WSKBD_TYPE_MAPLE 14 /* Dreamcast Maple keyboard */
96
97 /* Manipulate the keyboard bell. */
98 struct wskbd_bell_data {
99 u_int which; /* values to get/set */
100 u_int pitch; /* pitch, in Hz */
101 u_int period; /* period, in milliseconds */
102 u_int volume; /* percentage of max volume */
103 };
104 #define WSKBD_BELL_DOPITCH 0x1 /* get/set pitch */
105 #define WSKBD_BELL_DOPERIOD 0x2 /* get/set period */
106 #define WSKBD_BELL_DOVOLUME 0x4 /* get/set volume */
107 #define WSKBD_BELL_DOALL 0x7 /* all of the above */
108
109 #define WSKBDIO_BELL _IO('W', 1)
110 #define WSKBDIO_COMPLEXBELL _IOW('W', 2, struct wskbd_bell_data)
111 #define WSKBDIO_SETBELL _IOW('W', 3, struct wskbd_bell_data)
112 #define WSKBDIO_GETBELL _IOR('W', 4, struct wskbd_bell_data)
113 #define WSKBDIO_SETDEFAULTBELL _IOW('W', 5, struct wskbd_bell_data)
114 #define WSKBDIO_GETDEFAULTBELL _IOR('W', 6, struct wskbd_bell_data)
115
116 /* Manipulate the emulation key repeat settings. */
117 struct wskbd_keyrepeat_data {
118 u_int which; /* values to get/set */
119 u_int del1; /* delay before first, ms */
120 u_int delN; /* delay before rest, ms */
121 };
122 #define WSKBD_KEYREPEAT_DODEL1 0x1 /* get/set del1 */
123 #define WSKBD_KEYREPEAT_DODELN 0x2 /* get/set delN */
124 #define WSKBD_KEYREPEAT_DOALL 0x3 /* all of the above */
125
126 #define WSKBDIO_SETKEYREPEAT _IOW('W', 7, struct wskbd_keyrepeat_data)
127 #define WSKBDIO_GETKEYREPEAT _IOR('W', 8, struct wskbd_keyrepeat_data)
128 #define WSKBDIO_SETDEFAULTKEYREPEAT _IOW('W', 9, struct wskbd_keyrepeat_data)
129 #define WSKBDIO_GETDEFAULTKEYREPEAT _IOR('W', 10, struct wskbd_keyrepeat_data)
130
131 /* Get/set keyboard leds */
132 #define WSKBD_LED_CAPS 0x01
133 #define WSKBD_LED_NUM 0x02
134 #define WSKBD_LED_SCROLL 0x04
135 #define WSKBD_LED_COMPOSE 0x08
136
137 #define WSKBDIO_SETLEDS _IOW('W', 11, int)
138 #define WSKBDIO_GETLEDS _IOR('W', 12, int)
139
140 /* Manipulate keysym groups. */
141 struct wskbd_map_data {
142 u_int maplen; /* number of entries in map */
143 #define WSKBDIO_MAXMAPLEN 65536
144 struct wscons_keymap *map; /* map to get or set */
145 };
146 #define WSKBDIO_GETMAP _IOWR('W', 13, struct wskbd_map_data)
147 #define WSKBDIO_SETMAP _IOW('W', 14, struct wskbd_map_data)
148 #define WSKBDIO_GETENCODING _IOR('W', 15, kbd_t)
149 #define WSKBDIO_SETENCODING _IOW('W', 16, kbd_t)
150
151 /* internal use only */
152 #define WSKBDIO_SETMODE _IOW('W', 19, int)
153 #define WSKBDIO_GETMODE _IOR('W', 20, int)
154 #define WSKBD_TRANSLATED 0
155 #define WSKBD_RAW 1
156
157 #define WSKBDIO_SETKEYCLICK _IOW('W', 21, int)
158 #define WSKBDIO_GETKEYCLICK _IOR('W', 22, int)
159
160 /*
161 * Mouse ioctls (32 - 63)
162 */
163
164 /* Get mouse type */
165 #define WSMOUSEIO_GTYPE _IOR('W', 32, u_int)
166 #define WSMOUSE_TYPE_VSXXX 1 /* DEC serial */
167 #define WSMOUSE_TYPE_PS2 2 /* PS/2-compatible */
168 #define WSMOUSE_TYPE_USB 3 /* USB mouse */
169 #define WSMOUSE_TYPE_LMS 4 /* Logitech busmouse */
170 #define WSMOUSE_TYPE_MMS 5 /* Microsoft InPort mouse */
171 #define WSMOUSE_TYPE_TPANEL 6 /* Generic Touch Panel */
172 #define WSMOUSE_TYPE_NEXT 7 /* NeXT mouse */
173 #define WSMOUSE_TYPE_ARCHIMEDES 8 /* Archimedes mouse */
174 #define WSMOUSE_TYPE_HIL 9 /* HIL mouse */
175 #define WSMOUSE_TYPE_AMIGA 10 /* Amiga mouse */
176 #define WSMOUSE_TYPE_MAXINE 11 /* DEC maxine mouse */
177 #define WSMOUSE_TYPE_MAPLE 12 /* Dreamcast Maple mouse */
178
179 /* Set resolution. Not applicable to all mouse types. */
180 #define WSMOUSEIO_SRES _IOW('W', 33, u_int)
181 #define WSMOUSE_RES_MIN 0
182 #define WSMOUSE_RES_DEFAULT 75
183 #define WSMOUSE_RES_MAX 100
184
185 /* Set scale factor (num / den). Not applicable to all mouse types. */
186 #define WSMOUSEIO_SSCALE _IOW('W', 34, u_int[2])
187
188 /* Set sample rate. Not applicable to all mouse types. */
189 #define WSMOUSEIO_SRATE _IOW('W', 35, u_int)
190 #define WSMOUSE_RATE_MIN 0
191 #define WSMOUSE_RATE_DEFAULT 50
192 #define WSMOUSE_RATE_MAX 100
193
194 /* Set/get sample coordinates for calibration */
195 #define WSMOUSE_CALIBCOORDS_MAX 16
196 #define WSMOUSE_CALIBCOORDS_RESET -1
197 struct wsmouse_calibcoords {
198 int minx, miny; /* minimum value of X/Y */
199 int maxx, maxy; /* maximum value of X/Y */
200 int samplelen; /* number of samples available or
201 WSMOUSE_CALIBCOORDS_RESET for raw mode */
202 struct wsmouse_calibcoord {
203 int rawx, rawy; /* raw coordinate */
204 int x, y; /* translated coordinate */
205 } samples[WSMOUSE_CALIBCOORDS_MAX]; /* sample coordinates */
206 };
207 #define WSMOUSEIO_SCALIBCOORDS _IOW('W', 36, struct wsmouse_calibcoords)
208 #define WSMOUSEIO_GCALIBCOORDS _IOR('W', 37, struct wsmouse_calibcoords)
209
210 /* get device id for calibration */
211 #define WSMOUSE_ID_TYPE_UIDSTR 0 /* ID string (null terminated) */
212 #define WSMOUSE_ID_MAXLEN 256
213 struct wsmouse_id {
214 u_int type;
215 u_int length;
216 u_char data[WSMOUSE_ID_MAXLEN];
217 };
218 #define WSMOUSEIO_GETID _IOWR('W', 38, struct wsmouse_id)
219
220 /*
221 * Display ioctls (64 - 95)
222 */
223
224 /* Get display type */
225 #define WSDISPLAYIO_GTYPE _IOR('W', 64, u_int)
226 #define WSDISPLAY_TYPE_UNKNOWN 0 /* unknown */
227 #define WSDISPLAY_TYPE_PM_MONO 1 /* DEC [23]100 mono */
228 #define WSDISPLAY_TYPE_PM_COLOR 2 /* DEC [23]100 color */
229 #define WSDISPLAY_TYPE_CFB 3 /* DEC TC CFB (CX) */
230 #define WSDISPLAY_TYPE_XCFB 4 /* DEC `maxine' onboard fb */
231 #define WSDISPLAY_TYPE_MFB 5 /* DEC TC MFB (MX) */
232 #define WSDISPLAY_TYPE_SFB 6 /* DEC TC SFB (HX) */
233 #define WSDISPLAY_TYPE_ISAVGA 7 /* (generic) ISA VGA */
234 #define WSDISPLAY_TYPE_PCIVGA 8 /* (generic) PCI VGA */
235 #define WSDISPLAY_TYPE_TGA 9 /* DEC PCI TGA */
236 #define WSDISPLAY_TYPE_SFBP 10 /* DEC TC SFB+ (HX+) */
237 #define WSDISPLAY_TYPE_PCIMISC 11 /* (generic) PCI misc. disp. */
238 #define WSDISPLAY_TYPE_NEXTMONO 12 /* NeXT mono display */
239 #define WSDISPLAY_TYPE_PX 13 /* DEC TC PX */
240 #define WSDISPLAY_TYPE_PXG 14 /* DEC TC PXG */
241 #define WSDISPLAY_TYPE_TX 15 /* DEC TC TX */
242 #define WSDISPLAY_TYPE_HPCFB 16 /* Handheld/PalmSize PC */
243 #define WSDISPLAY_TYPE_VIDC 17 /* Acorn/ARM VIDC */
244 #define WSDISPLAY_TYPE_SPX 18 /* DEC SPX (VS3100/VS4000) */
245 #define WSDISPLAY_TYPE_GPX 19 /* DEC GPX (uVAX/VS2K/VS3100 */
246 #define WSDISPLAY_TYPE_LCG 20 /* DEC LCG (VS4000) */
247 #define WSDISPLAY_TYPE_VAX_MONO 21 /* DEC VS2K/VS3100 mono */
248 #define WSDISPLAY_TYPE_SB_P9100 22 /* Tadpole SPARCbook P9100 */
249 #define WSDISPLAY_TYPE_EGA 23 /* (generic) EGA */
250 #define WSDISPLAY_TYPE_DCPVR 24 /* Dreamcast PowerVR */
251 #define WSDISPLAY_TYPE_GATOR 25 /* HP Gator */
252 #define WSDISPLAY_TYPE_TOPCAT 26 /* HP TopCat */
253 #define WSDISPLAY_TYPE_RENAISSANCE 27 /* HP Renaissance */
254 #define WSDISPLAY_TYPE_CATSEYE 28 /* HP CatsEye */
255 #define WSDISPLAY_TYPE_DAVINCI 29 /* HP DaVinci */
256 #define WSDISPLAY_TYPE_TIGER 30 /* HP Tiger */
257 #define WSDISPLAY_TYPE_HYPERION 31 /* HP Hyperion */
258 #define WSDISPLAY_TYPE_AMIGACC 32 /* Amiga custom chips */
259
260 /* Basic display information. Not applicable to all display types. */
261 struct wsdisplay_fbinfo {
262 u_int height; /* height in pixels */
263 u_int width; /* width in pixels */
264 u_int depth; /* bits per pixel */
265 u_int cmsize; /* color map size (entries) */
266 };
267 #define WSDISPLAYIO_GINFO _IOR('W', 65, struct wsdisplay_fbinfo)
268
269 /* Colormap operations. Not applicable to all display types. */
270 struct wsdisplay_cmap {
271 u_int index; /* first element (0 origin) */
272 u_int count; /* number of elements */
273 u_char *red; /* red color map elements */
274 u_char *green; /* green color map elements */
275 u_char *blue; /* blue color map elements */
276 };
277 #define WSDISPLAYIO_GETCMAP _IOW('W', 66, struct wsdisplay_cmap)
278 #define WSDISPLAYIO_PUTCMAP _IOW('W', 67, struct wsdisplay_cmap)
279
280 /* Video control. Not applicable to all display types. */
281 #define WSDISPLAYIO_GVIDEO _IOR('W', 68, u_int)
282 #define WSDISPLAYIO_SVIDEO _IOW('W', 69, u_int)
283 #define WSDISPLAYIO_VIDEO_OFF 0 /* video off */
284 #define WSDISPLAYIO_VIDEO_ON 1 /* video on */
285
286 /* Cursor control. Not applicable to all display types. */
287 struct wsdisplay_curpos { /* cursor "position" */
288 u_int x, y;
289 };
290
291 struct wsdisplay_cursor {
292 u_int which; /* values to get/set */
293 u_int enable; /* enable/disable */
294 struct wsdisplay_curpos pos; /* position */
295 struct wsdisplay_curpos hot; /* hot spot */
296 struct wsdisplay_cmap cmap; /* color map info */
297 struct wsdisplay_curpos size; /* bit map size */
298 u_char *image; /* image data */
299 u_char *mask; /* mask data */
300 };
301 #define WSDISPLAY_CURSOR_DOCUR 0x01 /* get/set enable */
302 #define WSDISPLAY_CURSOR_DOPOS 0x02 /* get/set pos */
303 #define WSDISPLAY_CURSOR_DOHOT 0x04 /* get/set hot spot */
304 #define WSDISPLAY_CURSOR_DOCMAP 0x08 /* get/set cmap */
305 #define WSDISPLAY_CURSOR_DOSHAPE 0x10 /* get/set img/mask */
306 #define WSDISPLAY_CURSOR_DOALL 0x1f /* all of the above */
307
308 /* Cursor control: get and set position */
309 #define WSDISPLAYIO_GCURPOS _IOR('W', 70, struct wsdisplay_curpos)
310 #define WSDISPLAYIO_SCURPOS _IOW('W', 71, struct wsdisplay_curpos)
311
312 /* Cursor control: get maximum size */
313 #define WSDISPLAYIO_GCURMAX _IOR('W', 72, struct wsdisplay_curpos)
314
315 /* Cursor control: get/set cursor attributes/shape */
316 #define WSDISPLAYIO_GCURSOR _IOWR('W', 73, struct wsdisplay_cursor)
317 #define WSDISPLAYIO_SCURSOR _IOW('W', 74, struct wsdisplay_cursor)
318
319 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */
320 #define WSDISPLAYIO_GMODE _IOR('W', 75, u_int)
321 #define WSDISPLAYIO_SMODE _IOW('W', 76, u_int)
322 #define WSDISPLAYIO_MODE_EMUL 0 /* emulation (text) mode */
323 #define WSDISPLAYIO_MODE_MAPPED 1 /* mapped (graphics) mode */
324
325
326
327 /*
328 * XXX WARNING
329 * XXX The following wsdisplay definitions are very preliminary and are likely
330 * XXX to be changed without care about backwards compatibility!
331 */
332 struct wsdisplay_font {
333 char *name;
334 int firstchar, numchars;
335 int encoding;
336 #define WSDISPLAY_FONTENC_ISO 0
337 #define WSDISPLAY_FONTENC_IBM 1
338 #define WSDISPLAY_FONTENC_PCVT 2
339 #define WSDISPLAY_FONTENC_ISO7 3 /* greek */
340 #define WSDISPLAY_FONTENC_ISO2 4 /* east european */
341 u_int fontwidth, fontheight, stride;
342 #define WSDISPLAY_MAXFONTSZ (512*1024)
343 int bitorder, byteorder;
344 #define WSDISPLAY_FONTORDER_KNOWN 0 /* i.e, no need to convert */
345 #define WSDISPLAY_FONTORDER_L2R 1
346 #define WSDISPLAY_FONTORDER_R2L 2
347 void *data;
348 };
349 #define WSDISPLAYIO_LDFONT _IOW('W', 77, struct wsdisplay_font)
350
351 struct wsdisplay_addscreendata {
352 int idx; /* screen index */
353 char *screentype;
354 char *emul;
355 };
356 #define WSDISPLAYIO_ADDSCREEN _IOW('W', 78, struct wsdisplay_addscreendata)
357
358 struct wsdisplay_delscreendata {
359 int idx; /* screen index */
360 int flags;
361 #define WSDISPLAY_DELSCR_FORCE 1
362 };
363 #define WSDISPLAYIO_DELSCREEN _IOW('W', 79, struct wsdisplay_delscreendata)
364
365 struct wsdisplay_usefontdata {
366 char *name;
367 };
368 #define WSDISPLAYIO_SFONT _IOW('W', 80, struct wsdisplay_usefontdata)
369
370 /* Obsolete, replaced by WSMUXIO_{ADD,REMOVE}_DEVICE */
371 struct wsdisplay_kbddata {
372 int op;
373 #define _O_WSDISPLAY_KBD_ADD 0
374 #define _O_WSDISPLAY_KBD_DEL 1
375 int idx;
376 };
377 #define _O_WSDISPLAYIO_SETKEYBOARD _IOWR('W', 81, struct wsdisplay_kbddata)
378
379 /* Misc control. Not applicable to all display types. */
380 struct wsdisplay_param {
381 int param;
382 #define WSDISPLAYIO_PARAM_BACKLIGHT 1
383 #define WSDISPLAYIO_PARAM_BRIGHTNESS 2
384 #define WSDISPLAYIO_PARAM_CONTRAST 3
385 int min, max, curval;
386 int reserved[4];
387 };
388 #define WSDISPLAYIO_GETPARAM _IOWR('W', 82, struct wsdisplay_param)
389 #define WSDISPLAYIO_SETPARAM _IOWR('W', 83, struct wsdisplay_param)
390
391 #define WSDISPLAYIO_GETACTIVESCREEN _IOR('W', 84, int)
392
393 /* Character functions */
394 struct wsdisplay_char {
395 int row, col;
396 uint16_t letter;
397 uint8_t background, foreground;
398 char flags;
399 };
400 #define WSDISPLAY_CHAR_BRIGHT 1
401 #define WSDISPLAY_CHAR_BLINK 2
402 #define WSDISPLAYIO_GETWSCHAR _IOWR('W', 85, struct wsdisplay_char)
403 #define WSDISPLAYIO_PUTWSCHAR _IOWR('W', 86, struct wsdisplay_char)
404
405
406 /* XXX NOT YET DEFINED */
407 /* Mapping information retrieval. */
408
409
410 /*
411 * Mux ioctls (96 - 127)
412 */
413
414 #define WSMUXIO_INJECTEVENT _IOW('W', 96, struct wscons_event)
415 #define WSMUX_INJECTEVENT WSMUXIO_INJECTEVENT /* XXX compat */
416
417 struct wsmux_device {
418 int type;
419 #define WSMUX_MOUSE 1
420 #define WSMUX_KBD 2
421 #define WSMUX_MUX 3
422 int idx;
423 };
424 #define WSMUXIO_ADD_DEVICE _IOW('W', 97, struct wsmux_device)
425 #define WSMUX_ADD_DEVICE WSMUXIO_ADD_DEVICE /* XXX compat */
426 #define WSMUXIO_REMOVE_DEVICE _IOW('W', 98, struct wsmux_device)
427 #define WSMUX_REMOVE_DEVICE WSMUXIO_REMOVE_DEVICE /* XXX compat */
428
429 #define WSMUX_MAXDEV 32
430 struct wsmux_device_list {
431 int ndevices;
432 struct wsmux_device devices[WSMUX_MAXDEV];
433 };
434 #define WSMUXIO_LIST_DEVICES _IOWR('W', 99, struct wsmux_device_list)
435 #define WSMUX_LIST_DEVICES WSMUXIO_LIST_DEVICES /* XXX compat */
436
437 #endif /* _DEV_WSCONS_WSCONSIO_H_ */
438