1 /* $OpenBSD: wsconsio.h,v 1.13 2001/09/16 00:42:44 millert Exp $ */ 2 /* $NetBSD: wsconsio.h,v 1.31.2.1 2000/07/07 09:49:17 hannken Exp $ */ 3 4 /* 5 * Copyright (c) 1996, 1997 Christopher G. Demetriou. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Christopher G. Demetriou 18 * for the NetBSD Project. 19 * 4. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef _DEV_WSCONS_WSCONSIO_H_ 35 #define _DEV_WSCONS_WSCONSIO_H_ 36 37 /* 38 * WSCONS (wsdisplay, wskbd, wsmouse) exported interfaces. 39 * 40 * Ioctls are all in group 'W'. Ioctl number space is partitioned like: 41 * 0-31 keyboard ioctls (WSKBDIO) 42 * 32-63 mouse ioctls (WSMOUSEIO) 43 * 64-95 display ioctls (WSDISPLAYIO) 44 * 96-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 #define WSSCREEN_NAME_SIZE 16 52 #define WSEMUL_NAME_SIZE 16 53 #define WSFONT_NAME_SIZE 16 54 55 /* 56 * Common event structure (used by keyboard and mouse) 57 */ 58 struct wscons_event { 59 u_int type; 60 int value; 61 struct timespec time; 62 }; 63 64 /* Event type definitions. Comment for each is information in value. */ 65 #define WSCONS_EVENT_KEY_UP 1 /* key code */ 66 #define WSCONS_EVENT_KEY_DOWN 2 /* key code */ 67 #define WSCONS_EVENT_ALL_KEYS_UP 3 /* void */ 68 #define WSCONS_EVENT_MOUSE_UP 4 /* button # (leftmost = 0) */ 69 #define WSCONS_EVENT_MOUSE_DOWN 5 /* button # (leftmost = 0) */ 70 #define WSCONS_EVENT_MOUSE_DELTA_X 6 /* X delta amount */ 71 #define WSCONS_EVENT_MOUSE_DELTA_Y 7 /* Y delta amount */ 72 #define WSCONS_EVENT_MOUSE_ABSOLUTE_X 8 /* X location */ 73 #define WSCONS_EVENT_MOUSE_ABSOLUTE_Y 9 /* Y location */ 74 #define WSCONS_EVENT_MOUSE_DELTA_Z 10 /* Z delta amount */ 75 #define WSCONS_EVENT_MOUSE_ABSOLUTE_Z 11 /* Z location */ 76 #define WSCONS_EVENT_WSMOUSED_ON 12 /* wsmoused(8) active */ 77 #define WSCONS_EVENT_WSMOUSED_OFF 13 /* wsmoused(8) inactive */ 78 79 #define IS_MOTION_EVENT(type) (((type) == WSCONS_EVENT_MOUSE_DELTA_X) || \ 80 ((type) == WSCONS_EVENT_MOUSE_DELTA_Y) || \ 81 ((type) == WSCONS_EVENT_MOUSE_DELTA_Z)) 82 #define IS_BUTTON_EVENT(type) (((type) == WSCONS_EVENT_MOUSE_UP) || \ 83 ((type) == WSCONS_EVENT_MOUSE_DOWN)) 84 #define IS_CTRL_EVENT(type) ((type == WSCONS_EVENT_WSMOUSED_ON) || \ 85 (type == WSCONS_EVENT_WSMOUSED_OFF)) 86 /* 87 * Keyboard ioctls (0 - 31) 88 */ 89 90 /* Get keyboard type. */ 91 #define WSKBDIO_GTYPE _IOR('W', 0, u_int) 92 #define WSKBD_TYPE_LK201 1 /* lk-201 */ 93 #define WSKBD_TYPE_LK401 2 /* lk-401 */ 94 #define WSKBD_TYPE_PC_XT 3 /* PC-ish, XT scancode */ 95 #define WSKBD_TYPE_PC_AT 4 /* PC-ish, AT scancode */ 96 #define WSKBD_TYPE_USB 5 /* USB, XT scancode */ 97 #define WSKBD_TYPE_NEXT 6 /* NeXT keyboard */ 98 #define WSKBD_TYPE_HPC_KBD 7 /* HPC bultin keyboard */ 99 #define WSKBD_TYPE_HPC_BTN 8 /* HPC/PsPC buttons */ 100 #define WSKBD_TYPE_ARCHIMEDES 9 /* Archimedes keyboard */ 101 #define WSKBD_TYPE_ADB 10 /* Apple ADB keyboard */ 102 103 /* Manipulate the keyboard bell. */ 104 struct wskbd_bell_data { 105 u_int which; /* values to get/set */ 106 u_int pitch; /* pitch, in Hz */ 107 u_int period; /* period, in milliseconds */ 108 u_int volume; /* percentage of max volume */ 109 }; 110 #define WSKBD_BELL_DOPITCH 0x1 /* get/set pitch */ 111 #define WSKBD_BELL_DOPERIOD 0x2 /* get/set period */ 112 #define WSKBD_BELL_DOVOLUME 0x4 /* get/set volume */ 113 #define WSKBD_BELL_DOALL 0x7 /* all of the above */ 114 115 #define WSKBDIO_BELL _IO('W', 1) 116 #define WSKBDIO_COMPLEXBELL _IOW('W', 2, struct wskbd_bell_data) 117 #define WSKBDIO_SETBELL _IOW('W', 3, struct wskbd_bell_data) 118 #define WSKBDIO_GETBELL _IOR('W', 4, struct wskbd_bell_data) 119 #define WSKBDIO_SETDEFAULTBELL _IOW('W', 5, struct wskbd_bell_data) 120 #define WSKBDIO_GETDEFAULTBELL _IOR('W', 6, struct wskbd_bell_data) 121 122 /* Manipulate the emulation key repeat settings. */ 123 struct wskbd_keyrepeat_data { 124 u_int which; /* values to get/set */ 125 u_int del1; /* delay before first, ms */ 126 u_int delN; /* delay before rest, ms */ 127 }; 128 #define WSKBD_KEYREPEAT_DODEL1 0x1 /* get/set del1 */ 129 #define WSKBD_KEYREPEAT_DODELN 0x2 /* get/set delN */ 130 #define WSKBD_KEYREPEAT_DOALL 0x3 /* all of the above */ 131 132 #define WSKBDIO_SETKEYREPEAT _IOW('W', 7, struct wskbd_keyrepeat_data) 133 #define WSKBDIO_GETKEYREPEAT _IOR('W', 8, struct wskbd_keyrepeat_data) 134 #define WSKBDIO_SETDEFAULTKEYREPEAT \ 135 _IOW('W', 9, struct wskbd_keyrepeat_data) 136 #define WSKBDIO_GETDEFAULTKEYREPEAT \ 137 _IOR('W', 10, struct wskbd_keyrepeat_data) 138 139 /* Get/set keyboard leds */ 140 #define WSKBD_LED_CAPS 0x01 141 #define WSKBD_LED_NUM 0x02 142 #define WSKBD_LED_SCROLL 0x04 143 #define WSKBD_LED_COMPOSE 0x08 144 145 #define WSKBDIO_SETLEDS _IOW('W', 11, int) 146 #define WSKBDIO_GETLEDS _IOR('W', 12, int) 147 148 /* Manipulate keysym groups. */ 149 struct wskbd_map_data { 150 u_int maplen; /* number of entries in map */ 151 #define WSKBDIO_MAXMAPLEN 65536 152 struct wscons_keymap *map; /* map to get or set */ 153 }; 154 #define WSKBDIO_GETMAP _IOWR('W', 13, struct wskbd_map_data) 155 #define WSKBDIO_SETMAP _IOW('W', 14, struct wskbd_map_data) 156 #define WSKBDIO_GETENCODING _IOR('W', 15, kbd_t) 157 #define WSKBDIO_SETENCODING _IOW('W', 16, kbd_t) 158 159 /* internal use only */ 160 #define WSKBDIO_SETMODE _IOW('W', 19, int) 161 #define WSKBDIO_GETMODE _IOR('W', 20, int) 162 #define WSKBD_TRANSLATED 0 163 #define WSKBD_RAW 1 164 165 /* 166 * Mouse ioctls (32 - 63) 167 */ 168 169 /* Get mouse type */ 170 #define WSMOUSEIO_GTYPE _IOR('W', 32, u_int) 171 #define WSMOUSE_TYPE_VSXXX 1 /* DEC serial */ 172 #define WSMOUSE_TYPE_PS2 2 /* PS/2-compatible */ 173 #define WSMOUSE_TYPE_USB 3 /* USB mouse */ 174 #define WSMOUSE_TYPE_LMS 4 /* Logitech busmouse */ 175 #define WSMOUSE_TYPE_MMS 5 /* Microsoft InPort mouse */ 176 #define WSMOUSE_TYPE_TPANEL 6 /* Generic Touch Panel */ 177 #define WSMOUSE_TYPE_NEXT 7 /* NeXT mouse */ 178 #define WSMOUSE_TYPE_ARCHIMEDES 8 /* Archimedes mouse */ 179 180 /* Set resolution. Not applicable to all mouse types. */ 181 #define WSMOUSEIO_SRES _IOW('W', 33, u_int) 182 #define WSMOUSE_RES_MIN 0 183 #define WSMOUSE_RES_DEFAULT 75 184 #define WSMOUSE_RES_MAX 100 185 186 /* Set scale factor (num / den). Not applicable to all mouse types. */ 187 #define WSMOUSEIO_SSCALE _IOW('W', 34, u_int[2]) 188 189 /* Set sample rate. Not applicable to all mouse types. */ 190 #define WSMOUSEIO_SRATE _IOW('W', 35, u_int) 191 #define WSMOUSE_RATE_MIN 0 192 #define WSMOUSE_RATE_DEFAULT 50 193 #define WSMOUSE_RATE_MAX 100 194 195 /* Set/get sample coordinates for calibration */ 196 #define WSMOUSE_CALIBCOORDS_MAX 16 197 #define WSMOUSE_CALIBCOORDS_RESET -1 198 struct wsmouse_calibcoords { 199 int minx, miny; /* minimum value of X/Y */ 200 int maxx, maxy; /* maximum value of X/Y */ 201 int samplelen; /* number of samples available or 202 WSMOUSE_CALIBCOORDS_RESET for raw mode */ 203 struct wsmouse_calibcoord { 204 int rawx, rawy; /* raw coordinate */ 205 int x, y; /* translated coordinate */ 206 } samples[WSMOUSE_CALIBCOORDS_MAX]; /* sample coordinates */ 207 }; 208 #define WSMOUSEIO_SCALIBCOORDS _IOW('W', 36, struct wsmouse_calibcoords) 209 #define WSMOUSEIO_GCALIBCOORDS _IOR('W', 37, struct wsmouse_calibcoords) 210 211 /* 212 * Display ioctls (64 - 95) 213 */ 214 215 /* Get display type */ 216 #define WSDISPLAYIO_GTYPE _IOR('W', 64, u_int) 217 #define WSDISPLAY_TYPE_UNKNOWN 0 /* unknown */ 218 #define WSDISPLAY_TYPE_PM_MONO 1 /* DEC [23]100 mono */ 219 #define WSDISPLAY_TYPE_PM_COLOR 2 /* DEC [23]100 color */ 220 #define WSDISPLAY_TYPE_CFB 3 /* DEC TC CFB (CX) */ 221 #define WSDISPLAY_TYPE_XCFB 4 /* DEC `maxine' onboard fb */ 222 #define WSDISPLAY_TYPE_MFB 5 /* DEC TC MFB (MX) */ 223 #define WSDISPLAY_TYPE_SFB 6 /* DEC TC SFB (HX) */ 224 #define WSDISPLAY_TYPE_ISAVGA 7 /* (generic) ISA VGA */ 225 #define WSDISPLAY_TYPE_PCIVGA 8 /* (generic) PCI VGA */ 226 #define WSDISPLAY_TYPE_TGA 9 /* DEC PCI TGA */ 227 #define WSDISPLAY_TYPE_SFBP 10 /* DEC TC SFB+ (HX+) */ 228 #define WSDISPLAY_TYPE_PCIMISC 11 /* (generic) PCI misc. disp. */ 229 #define WSDISPLAY_TYPE_NEXTMONO 12 /* NeXT mono display */ 230 #define WSDISPLAY_TYPE_PX 13 /* DEC TC PX */ 231 #define WSDISPLAY_TYPE_PXG 14 /* DEC TC PXG */ 232 #define WSDISPLAY_TYPE_TX 15 /* DEC TC TX */ 233 #define WSDISPLAY_TYPE_HPCFB 16 /* Handheld/PalmSize PC */ 234 #define WSDISPLAY_TYPE_VIDC 17 /* Acorn/ARM VIDC */ 235 #define WSDISPLAY_TYPE_SPX 18 /* DEC SPX (VS3100/VS4000) */ 236 #define WSDISPLAY_TYPE_GPX 19 /* DEC GPX (uVAX/VS2K/VS3100 */ 237 #define WSDISPLAY_TYPE_LCG 20 /* DEC LCG (VS4000) */ 238 #define WSDISPLAY_TYPE_VAX_MONO 21 /* DEC VS2K/VS3100 mono */ 239 #define WSDISPLAY_TYPE_SB_P9100 22 /* Tadpole SPARCbook P9100 */ 240 #define WSDISPLAY_TYPE_EGA 23 /* (generic) EGA */ 241 #define WSDISPLAY_TYPE_DCPVR 24 /* Dreamcast PowerVR */ 242 243 /* Basic display information. Not applicable to all display types. */ 244 struct wsdisplay_fbinfo { 245 u_int height; /* height in pixels */ 246 u_int width; /* width in pixels */ 247 u_int depth; /* bits per pixel */ 248 u_int cmsize; /* color map size (entries) */ 249 }; 250 #define WSDISPLAYIO_GINFO _IOR('W', 65, struct wsdisplay_fbinfo) 251 252 /* Colormap operations. Not applicable to all display types. */ 253 struct wsdisplay_cmap { 254 u_int index; /* first element (0 origin) */ 255 u_int count; /* number of elements */ 256 u_char *red; /* red color map elements */ 257 u_char *green; /* green color map elements */ 258 u_char *blue; /* blue color map elements */ 259 }; 260 #define WSDISPLAYIO_GETCMAP _IOW('W', 66, struct wsdisplay_cmap) 261 #define WSDISPLAYIO_PUTCMAP _IOW('W', 67, struct wsdisplay_cmap) 262 263 /* Video control. Not applicable to all display types. */ 264 #define WSDISPLAYIO_GVIDEO _IOR('W', 68, u_int) 265 #define WSDISPLAYIO_SVIDEO _IOW('W', 69, u_int) 266 #define WSDISPLAYIO_VIDEO_OFF 0 /* video off */ 267 #define WSDISPLAYIO_VIDEO_ON 1 /* video on */ 268 269 /* Cursor control. Not applicable to all display types. */ 270 struct wsdisplay_curpos { /* cursor "position" */ 271 u_int x, y; 272 }; 273 274 struct wsdisplay_cursor { 275 u_int which; /* values to get/set */ 276 u_int enable; /* enable/disable */ 277 struct wsdisplay_curpos pos; /* position */ 278 struct wsdisplay_curpos hot; /* hot spot */ 279 struct wsdisplay_cmap cmap; /* color map info */ 280 struct wsdisplay_curpos size; /* bit map size */ 281 u_char *image; /* image data */ 282 u_char *mask; /* mask data */ 283 }; 284 #define WSDISPLAY_CURSOR_DOCUR 0x01 /* get/set enable */ 285 #define WSDISPLAY_CURSOR_DOPOS 0x02 /* get/set pos */ 286 #define WSDISPLAY_CURSOR_DOHOT 0x04 /* get/set hot spot */ 287 #define WSDISPLAY_CURSOR_DOCMAP 0x08 /* get/set cmap */ 288 #define WSDISPLAY_CURSOR_DOSHAPE 0x10 /* get/set img/mask */ 289 #define WSDISPLAY_CURSOR_DOALL 0x1f /* all of the above */ 290 291 /* Cursor control: get and set position */ 292 #define WSDISPLAYIO_GCURPOS _IOR('W', 70, struct wsdisplay_curpos) 293 #define WSDISPLAYIO_SCURPOS _IOW('W', 71, struct wsdisplay_curpos) 294 295 /* Cursor control: get maximum size */ 296 #define WSDISPLAYIO_GCURMAX _IOR('W', 72, struct wsdisplay_curpos) 297 298 /* Cursor control: get/set cursor attributes/shape */ 299 #define WSDISPLAYIO_GCURSOR _IOWR('W', 73, struct wsdisplay_cursor) 300 #define WSDISPLAYIO_SCURSOR _IOW('W', 74, struct wsdisplay_cursor) 301 302 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */ 303 #define WSDISPLAYIO_GMODE _IOR('W', 75, u_int) 304 #define WSDISPLAYIO_SMODE _IOW('W', 76, u_int) 305 #define WSDISPLAYIO_MODE_EMUL 0 /* emulation (text) mode */ 306 #define WSDISPLAYIO_MODE_MAPPED 1 /* mapped (graphics) mode */ 307 308 struct wsdisplay_font { 309 char name[WSFONT_NAME_SIZE]; 310 int index; 311 int firstchar, numchars; 312 int encoding; 313 #define WSDISPLAY_FONTENC_ISO 0 314 #define WSDISPLAY_FONTENC_IBM 1 315 #define WSDISPLAY_FONTENC_PCVT 2 316 #define WSDISPLAY_FONTENC_ISO7 3 /* greek */ 317 #define WSDISPLAY_FONTENC_SONY 4 318 u_int fontwidth, fontheight, stride; 319 #define WSDISPLAY_MAXFONTSZ (512*1024) 320 int bitorder, byteorder; 321 #define WSDISPLAY_FONTORDER_KNOWN 0 /* i.e, no need to convert */ 322 #define WSDISPLAY_FONTORDER_L2R 1 323 #define WSDISPLAY_FONTORDER_R2L 2 324 void *cookie; 325 void *data; 326 }; 327 #define WSDISPLAYIO_LDFONT _IOW ('W', 77, struct wsdisplay_font) 328 #define WSDISPLAYIO_LSFONT _IOWR('W', 78, struct wsdisplay_font) 329 #define WSDISPLAYIO_DELFONT _IOW ('W', 79, struct wsdisplay_font) 330 #define WSDISPLAYIO_USEFONT _IOW ('W', 80, struct wsdisplay_font) 331 332 struct wsdisplay_burner { 333 u_int off; 334 u_int on; 335 u_int flags; 336 #define WSDISPLAY_BURN_VBLANK 0x0001 337 #define WSDISPLAY_BURN_KBD 0x0002 338 #define WSDISPLAY_BURN_MOUSE 0x0004 339 #define WSDISPLAY_BURN_OUTPUT 0x0008 340 }; 341 #define WSDISPLAYIO_SBURNER _IOW('W', 81, struct wsdisplay_burner) 342 #define WSDISPLAYIO_GBURNER _IOR('W', 82, struct wsdisplay_burner) 343 344 /* 345 * XXX WARNING 346 * XXX The following definitions are very preliminary and are likely 347 * XXX to be changed without care about backwards compatibility! 348 */ 349 struct wsdisplay_addscreendata { 350 int idx; /* screen index */ 351 char screentype[WSSCREEN_NAME_SIZE]; 352 char emul[WSEMUL_NAME_SIZE]; 353 }; 354 #define WSDISPLAYIO_ADDSCREEN _IOW('W', 83, struct wsdisplay_addscreendata) 355 356 struct wsdisplay_delscreendata { 357 int idx; /* screen index */ 358 int flags; 359 #define WSDISPLAY_DELSCR_FORCE 1 360 }; 361 #define WSDISPLAYIO_DELSCREEN _IOW('W', 84, struct wsdisplay_delscreendata) 362 363 #define WSDISPLAYIO_GETSCREEN _IOWR('W', 85, struct wsdisplay_addscreendata) 364 #define WSDISPLAYIO_SETSCREEN _IOW('W', 86, u_int) 365 366 /* Display information: number of bytes per row, may be same as pixels */ 367 #define WSDISPLAYIO_LINEBYTES _IOR('W', 95, u_int) 368 369 370 /* Replaced by WSMUX_{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', 87, struct wsdisplay_kbddata) 378 379 /* Mouse console support */ 380 #define WSDISPLAYIO_WSMOUSED _IOW('W', 88, struct wscons_event) 381 382 /* Misc control. Not applicable to all display types. */ 383 struct wsdisplay_param { 384 int param; 385 #define WSDISPLAYIO_PARAM_BACKLIGHT 1 386 #define WSDISPLAYIO_PARAM_BRIGHTNESS 2 387 #define WSDISPLAYIO_PARAM_CONTRAST 3 388 int min, max, curval; 389 int reserved[4]; 390 }; 391 #define WSDISPLAYIO_GETPARAM _IOWR('W', 89, struct wsdisplay_param) 392 #define WSDISPLAYIO_SETPARAM _IOWR('W', 90, struct wsdisplay_param) 393 394 /* XXX NOT YET DEFINED */ 395 /* Mapping information retrieval. */ 396 397 /* Mux ioctls (96 - 127) */ 398 #define WSMUX_INJECTEVENT _IOW('W', 96, struct wscons_event) 399 400 struct wsmux_device { 401 int type; 402 #define WSMUX_MOUSE 1 403 #define WSMUX_KBD 2 404 #define WSMUX_MUX 3 405 int idx; 406 }; 407 #define WSMUX_ADD_DEVICE _IOW('W', 97, struct wsmux_device) 408 #define WSMUX_REMOVE_DEVICE _IOW('W', 98, struct wsmux_device) 409 410 #define WSMUX_MAXDEV 32 411 struct wsmux_device_list { 412 int ndevices; 413 struct wsmux_device devices[WSMUX_MAXDEV]; 414 }; 415 #define WSMUX_LIST_DEVICES _IOWR('W', 99, struct wsmux_device_list) 416 417 #endif /* _DEV_WSCONS_WSCONSIO_H_ */ 418