1 /* $NetBSD: wsconsio.h,v 1.50 2002/04/07 09:25:47 hannken 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 74 75 /* 76 * Keyboard ioctls (0 - 31) 77 */ 78 79 /* Get keyboard type. */ 80 #define WSKBDIO_GTYPE _IOR('W', 0, u_int) 81 #define WSKBD_TYPE_LK201 1 /* lk-201 */ 82 #define WSKBD_TYPE_LK401 2 /* lk-401 */ 83 #define WSKBD_TYPE_PC_XT 3 /* PC-ish, XT scancode */ 84 #define WSKBD_TYPE_PC_AT 4 /* PC-ish, AT scancode */ 85 #define WSKBD_TYPE_USB 5 /* USB, XT scancode */ 86 #define WSKBD_TYPE_NEXT 6 /* NeXT keyboard */ 87 #define WSKBD_TYPE_HPC_KBD 7 /* HPC bultin keyboard */ 88 #define WSKBD_TYPE_HPC_BTN 8 /* HPC/PsPC buttons */ 89 #define WSKBD_TYPE_ARCHIMEDES 9 /* Archimedes keyboard */ 90 #define WSKBD_TYPE_RISCPC 10 /* RiscPC keyboard, resembling AT codes */ 91 #define WSKBD_TYPE_ADB 11 /* ADB */ 92 #define WSKBD_TYPE_HIL 12 /* HIL keyboard */ 93 #define WSKBD_TYPE_AMIGA 13 /* Amiga keyboard */ 94 95 /* Manipulate the keyboard bell. */ 96 struct wskbd_bell_data { 97 u_int which; /* values to get/set */ 98 u_int pitch; /* pitch, in Hz */ 99 u_int period; /* period, in milliseconds */ 100 u_int volume; /* percentage of max volume */ 101 }; 102 #define WSKBD_BELL_DOPITCH 0x1 /* get/set pitch */ 103 #define WSKBD_BELL_DOPERIOD 0x2 /* get/set period */ 104 #define WSKBD_BELL_DOVOLUME 0x4 /* get/set volume */ 105 #define WSKBD_BELL_DOALL 0x7 /* all of the above */ 106 107 #define WSKBDIO_BELL _IO('W', 1) 108 #define WSKBDIO_COMPLEXBELL _IOW('W', 2, struct wskbd_bell_data) 109 #define WSKBDIO_SETBELL _IOW('W', 3, struct wskbd_bell_data) 110 #define WSKBDIO_GETBELL _IOR('W', 4, struct wskbd_bell_data) 111 #define WSKBDIO_SETDEFAULTBELL _IOW('W', 5, struct wskbd_bell_data) 112 #define WSKBDIO_GETDEFAULTBELL _IOR('W', 6, struct wskbd_bell_data) 113 114 /* Manipulate the emulation key repeat settings. */ 115 struct wskbd_keyrepeat_data { 116 u_int which; /* values to get/set */ 117 u_int del1; /* delay before first, ms */ 118 u_int delN; /* delay before rest, ms */ 119 }; 120 #define WSKBD_KEYREPEAT_DODEL1 0x1 /* get/set del1 */ 121 #define WSKBD_KEYREPEAT_DODELN 0x2 /* get/set delN */ 122 #define WSKBD_KEYREPEAT_DOALL 0x3 /* all of the above */ 123 124 #define WSKBDIO_SETKEYREPEAT _IOW('W', 7, struct wskbd_keyrepeat_data) 125 #define WSKBDIO_GETKEYREPEAT _IOR('W', 8, struct wskbd_keyrepeat_data) 126 #define WSKBDIO_SETDEFAULTKEYREPEAT \ 127 _IOW('W', 9, struct wskbd_keyrepeat_data) 128 #define WSKBDIO_GETDEFAULTKEYREPEAT \ 129 _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 178 /* Set resolution. Not applicable to all mouse types. */ 179 #define WSMOUSEIO_SRES _IOW('W', 33, u_int) 180 #define WSMOUSE_RES_MIN 0 181 #define WSMOUSE_RES_DEFAULT 75 182 #define WSMOUSE_RES_MAX 100 183 184 /* Set scale factor (num / den). Not applicable to all mouse types. */ 185 #define WSMOUSEIO_SSCALE _IOW('W', 34, u_int[2]) 186 187 /* Set sample rate. Not applicable to all mouse types. */ 188 #define WSMOUSEIO_SRATE _IOW('W', 35, u_int) 189 #define WSMOUSE_RATE_MIN 0 190 #define WSMOUSE_RATE_DEFAULT 50 191 #define WSMOUSE_RATE_MAX 100 192 193 /* Set/get sample coordinates for calibration */ 194 #define WSMOUSE_CALIBCOORDS_MAX 16 195 #define WSMOUSE_CALIBCOORDS_RESET -1 196 struct wsmouse_calibcoords { 197 int minx, miny; /* minimum value of X/Y */ 198 int maxx, maxy; /* maximum value of X/Y */ 199 int samplelen; /* number of samples available or 200 WSMOUSE_CALIBCOORDS_RESET for raw mode */ 201 struct wsmouse_calibcoord { 202 int rawx, rawy; /* raw coordinate */ 203 int x, y; /* translated coordinate */ 204 } samples[WSMOUSE_CALIBCOORDS_MAX]; /* sample coordinates */ 205 }; 206 #define WSMOUSEIO_SCALIBCOORDS _IOW('W', 36, struct wsmouse_calibcoords) 207 #define WSMOUSEIO_GCALIBCOORDS _IOR('W', 37, struct wsmouse_calibcoords) 208 209 /* 210 * Display ioctls (64 - 95) 211 */ 212 213 /* Get display type */ 214 #define WSDISPLAYIO_GTYPE _IOR('W', 64, u_int) 215 #define WSDISPLAY_TYPE_UNKNOWN 0 /* unknown */ 216 #define WSDISPLAY_TYPE_PM_MONO 1 /* DEC [23]100 mono */ 217 #define WSDISPLAY_TYPE_PM_COLOR 2 /* DEC [23]100 color */ 218 #define WSDISPLAY_TYPE_CFB 3 /* DEC TC CFB (CX) */ 219 #define WSDISPLAY_TYPE_XCFB 4 /* DEC `maxine' onboard fb */ 220 #define WSDISPLAY_TYPE_MFB 5 /* DEC TC MFB (MX) */ 221 #define WSDISPLAY_TYPE_SFB 6 /* DEC TC SFB (HX) */ 222 #define WSDISPLAY_TYPE_ISAVGA 7 /* (generic) ISA VGA */ 223 #define WSDISPLAY_TYPE_PCIVGA 8 /* (generic) PCI VGA */ 224 #define WSDISPLAY_TYPE_TGA 9 /* DEC PCI TGA */ 225 #define WSDISPLAY_TYPE_SFBP 10 /* DEC TC SFB+ (HX+) */ 226 #define WSDISPLAY_TYPE_PCIMISC 11 /* (generic) PCI misc. disp. */ 227 #define WSDISPLAY_TYPE_NEXTMONO 12 /* NeXT mono display */ 228 #define WSDISPLAY_TYPE_PX 13 /* DEC TC PX */ 229 #define WSDISPLAY_TYPE_PXG 14 /* DEC TC PXG */ 230 #define WSDISPLAY_TYPE_TX 15 /* DEC TC TX */ 231 #define WSDISPLAY_TYPE_HPCFB 16 /* Handheld/PalmSize PC */ 232 #define WSDISPLAY_TYPE_VIDC 17 /* Acorn/ARM VIDC */ 233 #define WSDISPLAY_TYPE_SPX 18 /* DEC SPX (VS3100/VS4000) */ 234 #define WSDISPLAY_TYPE_GPX 19 /* DEC GPX (uVAX/VS2K/VS3100 */ 235 #define WSDISPLAY_TYPE_LCG 20 /* DEC LCG (VS4000) */ 236 #define WSDISPLAY_TYPE_VAX_MONO 21 /* DEC VS2K/VS3100 mono */ 237 #define WSDISPLAY_TYPE_SB_P9100 22 /* Tadpole SPARCbook P9100 */ 238 #define WSDISPLAY_TYPE_EGA 23 /* (generic) EGA */ 239 #define WSDISPLAY_TYPE_DCPVR 24 /* Dreamcast PowerVR */ 240 #define WSDISPLAY_TYPE_GATOR 25 /* HP Gator */ 241 #define WSDISPLAY_TYPE_TOPCAT 26 /* HP TopCat */ 242 #define WSDISPLAY_TYPE_RENAISSANCE 27 /* HP Renaissance */ 243 #define WSDISPLAY_TYPE_CATSEYE 28 /* HP CatsEye */ 244 #define WSDISPLAY_TYPE_DAVINCI 29 /* HP DaVinci */ 245 #define WSDISPLAY_TYPE_TIGER 30 /* HP Tiger */ 246 #define WSDISPLAY_TYPE_HYPERION 31 /* HP Hyperion */ 247 #define WSDISPLAY_TYPE_AMIGACC 32 /* Amiga custom chips */ 248 249 /* Basic display information. Not applicable to all display types. */ 250 struct wsdisplay_fbinfo { 251 u_int height; /* height in pixels */ 252 u_int width; /* width in pixels */ 253 u_int depth; /* bits per pixel */ 254 u_int cmsize; /* color map size (entries) */ 255 }; 256 #define WSDISPLAYIO_GINFO _IOR('W', 65, struct wsdisplay_fbinfo) 257 258 /* Colormap operations. Not applicable to all display types. */ 259 struct wsdisplay_cmap { 260 u_int index; /* first element (0 origin) */ 261 u_int count; /* number of elements */ 262 u_char *red; /* red color map elements */ 263 u_char *green; /* green color map elements */ 264 u_char *blue; /* blue color map elements */ 265 }; 266 #define WSDISPLAYIO_GETCMAP _IOW('W', 66, struct wsdisplay_cmap) 267 #define WSDISPLAYIO_PUTCMAP _IOW('W', 67, struct wsdisplay_cmap) 268 269 /* Video control. Not applicable to all display types. */ 270 #define WSDISPLAYIO_GVIDEO _IOR('W', 68, u_int) 271 #define WSDISPLAYIO_SVIDEO _IOW('W', 69, u_int) 272 #define WSDISPLAYIO_VIDEO_OFF 0 /* video off */ 273 #define WSDISPLAYIO_VIDEO_ON 1 /* video on */ 274 275 /* Cursor control. Not applicable to all display types. */ 276 struct wsdisplay_curpos { /* cursor "position" */ 277 u_int x, y; 278 }; 279 280 struct wsdisplay_cursor { 281 u_int which; /* values to get/set */ 282 u_int enable; /* enable/disable */ 283 struct wsdisplay_curpos pos; /* position */ 284 struct wsdisplay_curpos hot; /* hot spot */ 285 struct wsdisplay_cmap cmap; /* color map info */ 286 struct wsdisplay_curpos size; /* bit map size */ 287 u_char *image; /* image data */ 288 u_char *mask; /* mask data */ 289 }; 290 #define WSDISPLAY_CURSOR_DOCUR 0x01 /* get/set enable */ 291 #define WSDISPLAY_CURSOR_DOPOS 0x02 /* get/set pos */ 292 #define WSDISPLAY_CURSOR_DOHOT 0x04 /* get/set hot spot */ 293 #define WSDISPLAY_CURSOR_DOCMAP 0x08 /* get/set cmap */ 294 #define WSDISPLAY_CURSOR_DOSHAPE 0x10 /* get/set img/mask */ 295 #define WSDISPLAY_CURSOR_DOALL 0x1f /* all of the above */ 296 297 /* Cursor control: get and set position */ 298 #define WSDISPLAYIO_GCURPOS _IOR('W', 70, struct wsdisplay_curpos) 299 #define WSDISPLAYIO_SCURPOS _IOW('W', 71, struct wsdisplay_curpos) 300 301 /* Cursor control: get maximum size */ 302 #define WSDISPLAYIO_GCURMAX _IOR('W', 72, struct wsdisplay_curpos) 303 304 /* Cursor control: get/set cursor attributes/shape */ 305 #define WSDISPLAYIO_GCURSOR _IOWR('W', 73, struct wsdisplay_cursor) 306 #define WSDISPLAYIO_SCURSOR _IOW('W', 74, struct wsdisplay_cursor) 307 308 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */ 309 #define WSDISPLAYIO_GMODE _IOR('W', 75, u_int) 310 #define WSDISPLAYIO_SMODE _IOW('W', 76, u_int) 311 #define WSDISPLAYIO_MODE_EMUL 0 /* emulation (text) mode */ 312 #define WSDISPLAYIO_MODE_MAPPED 1 /* mapped (graphics) mode */ 313 314 /* 315 * XXX WARNING 316 * XXX The following definitions are very preliminary and are likely 317 * XXX to be changed without care about backwards compatibility! 318 */ 319 struct wsdisplay_font { 320 char *name; 321 int firstchar, numchars; 322 int encoding; 323 #define WSDISPLAY_FONTENC_ISO 0 324 #define WSDISPLAY_FONTENC_IBM 1 325 #define WSDISPLAY_FONTENC_PCVT 2 326 #define WSDISPLAY_FONTENC_ISO7 3 /* greek */ 327 #define WSDISPLAY_FONTENC_ISO2 4 /* east european */ 328 u_int fontwidth, fontheight, stride; 329 #define WSDISPLAY_MAXFONTSZ (512*1024) 330 int bitorder, byteorder; 331 #define WSDISPLAY_FONTORDER_KNOWN 0 /* i.e, no need to convert */ 332 #define WSDISPLAY_FONTORDER_L2R 1 333 #define WSDISPLAY_FONTORDER_R2L 2 334 void *data; 335 }; 336 #define WSDISPLAYIO_LDFONT _IOW('W', 77, struct wsdisplay_font) 337 338 struct wsdisplay_addscreendata { 339 int idx; /* screen index */ 340 char *screentype; 341 char *emul; 342 }; 343 #define WSDISPLAYIO_ADDSCREEN _IOW('W', 78, struct wsdisplay_addscreendata) 344 345 struct wsdisplay_delscreendata { 346 int idx; /* screen index */ 347 int flags; 348 #define WSDISPLAY_DELSCR_FORCE 1 349 }; 350 #define WSDISPLAYIO_DELSCREEN _IOW('W', 79, struct wsdisplay_delscreendata) 351 352 struct wsdisplay_usefontdata { 353 char *name; 354 }; 355 #define WSDISPLAYIO_SFONT _IOW('W', 80, struct wsdisplay_usefontdata) 356 357 /* Obsolete, replaced by WSMUXIO_{ADD,REMOVE}_DEVICE */ 358 struct wsdisplay_kbddata { 359 int op; 360 #define _O_WSDISPLAY_KBD_ADD 0 361 #define _O_WSDISPLAY_KBD_DEL 1 362 int idx; 363 }; 364 #define _O_WSDISPLAYIO_SETKEYBOARD _IOWR('W', 81, struct wsdisplay_kbddata) 365 366 /* Misc control. Not applicable to all display types. */ 367 struct wsdisplay_param { 368 int param; 369 #define WSDISPLAYIO_PARAM_BACKLIGHT 1 370 #define WSDISPLAYIO_PARAM_BRIGHTNESS 2 371 #define WSDISPLAYIO_PARAM_CONTRAST 3 372 int min, max, curval; 373 int reserved[4]; 374 }; 375 #define WSDISPLAYIO_GETPARAM _IOWR('W', 82, struct wsdisplay_param) 376 #define WSDISPLAYIO_SETPARAM _IOWR('W', 83, struct wsdisplay_param) 377 378 /* XXX NOT YET DEFINED */ 379 /* Mapping information retrieval. */ 380 381 /* Mux ioctls (96 - 127) */ 382 #define WSMUXIO_INJECTEVENT _IOW('W', 96, struct wscons_event) 383 #define WSMUX_INJECTEVENT WSMUXIO_INJECTEVENT /* XXX compat */ 384 385 struct wsmux_device { 386 int type; 387 #define WSMUX_MOUSE 1 388 #define WSMUX_KBD 2 389 #define WSMUX_MUX 3 390 int idx; 391 }; 392 #define WSMUXIO_ADD_DEVICE _IOW('W', 97, struct wsmux_device) 393 #define WSMUX_ADD_DEVICE WSMUXIO_ADD_DEVICE /* XXX compat */ 394 #define WSMUXIO_REMOVE_DEVICE _IOW('W', 98, struct wsmux_device) 395 #define WSMUX_REMOVE_DEVICE WSMUXIO_REMOVE_DEVICE /* XXX compat */ 396 397 #define WSMUX_MAXDEV 32 398 struct wsmux_device_list { 399 int ndevices; 400 struct wsmux_device devices[WSMUX_MAXDEV]; 401 }; 402 #define WSMUXIO_LIST_DEVICES _IOWR('W', 99, struct wsmux_device_list) 403 #define WSMUX_LIST_DEVICES WSMUXIO_LIST_DEVICES /* XXX compat */ 404 405 #endif /* _DEV_WSCONS_WSCONSIO_H_ */ 406