Home | History | Annotate | Line # | Download | only in wscons
wsconsio.h revision 1.114
      1 /* $NetBSD: wsconsio.h,v 1.114 2015/07/19 13:22:42 mlelstv 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 #define WSEVENT_VERSION	1
     61 
     62 /* Event type definitions.  Comment for each is information in value. */
     63 #define	WSCONS_EVENT_KEY_UP		1	/* key code */
     64 #define	WSCONS_EVENT_KEY_DOWN		2	/* key code */
     65 #define	WSCONS_EVENT_ALL_KEYS_UP	3	/* void */
     66 #define	WSCONS_EVENT_MOUSE_UP		4	/* button # (leftmost = 0) */
     67 #define	WSCONS_EVENT_MOUSE_DOWN		5	/* button # (leftmost = 0)  */
     68 #define	WSCONS_EVENT_MOUSE_DELTA_X	6	/* X delta amount */
     69 #define	WSCONS_EVENT_MOUSE_DELTA_Y	7	/* Y delta amount */
     70 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_X	8	/* X location */
     71 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_Y	9	/* Y location */
     72 #define	WSCONS_EVENT_MOUSE_DELTA_Z	10	/* Z delta amount */
     73 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_Z	11	/* Z location */
     74 #define	WSCONS_EVENT_SCREEN_SWITCH	12	/* New screen number */
     75 #define	WSCONS_EVENT_ASCII		13	/* key code is already ascii */
     76 #define	WSCONS_EVENT_MOUSE_DELTA_W	14	/* W delta amount */
     77 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_W	15	/* W location */
     78 
     79 
     80 /*
     81  * Keyboard ioctls (0 - 31)
     82  */
     83 
     84 /* Get keyboard type. */
     85 #define	WSKBDIO_GTYPE		_IOR('W', 0, u_int)
     86 #define	WSKBD_TYPE_LK201	1	/* lk-201 */
     87 #define	WSKBD_TYPE_LK401	2	/* lk-401 */
     88 #define	WSKBD_TYPE_PC_XT	3	/* PC-ish, XT scancode */
     89 #define	WSKBD_TYPE_PC_AT	4	/* PC-ish, AT scancode */
     90 #define	WSKBD_TYPE_USB		5	/* USB, XT scancode */
     91 #define	WSKBD_TYPE_NEXT		6	/* NeXT keyboard */
     92 #define	WSKBD_TYPE_HPC_KBD	7	/* HPC bultin keyboard */
     93 #define	WSKBD_TYPE_HPC_BTN	8	/* HPC/PsPC buttons */
     94 #define	WSKBD_TYPE_ARCHIMEDES	9	/* Archimedes keyboard */
     95 #define	WSKBD_TYPE_RISCPC	10	/* RiscPC keyboard, resembling AT codes */
     96 #define	WSKBD_TYPE_ADB		11	/* ADB */
     97 #define	WSKBD_TYPE_HIL		12	/* HIL keyboard */
     98 #define	WSKBD_TYPE_AMIGA	13	/* Amiga keyboard */
     99 #define	WSKBD_TYPE_MAPLE	14	/* Dreamcast Maple keyboard */
    100 #define	WSKBD_TYPE_ATARI	15	/* Atari keyboard */
    101 #define	WSKBD_TYPE_SUN		16	/* Sun Type3/4 */
    102 #define	WSKBD_TYPE_SUN5		17	/* Sun Type5 */
    103 #define	WSKBD_TYPE_SGI		18	/* SGI keyboard */
    104 #define	WSKBD_TYPE_MATRIXKP	19	/* Matrix keypads/buttons */
    105 #define	WSKBD_TYPE_EWS4800	20	/* NEC EWS4800 */
    106 #define	WSKBD_TYPE_BLUETOOTH	21	/* Bluetooth keyboard */
    107 #define	WSKBD_TYPE_ZAURUS	22	/* Sharp Zaurus keyboard */
    108 #define	WSKBD_TYPE_LUNA		23	/* OMRON SX-9100 LUNA */
    109 #define	WSKBD_TYPE_RFB		24	/* Usermode vnc remote keyboard */
    110 #define	WSKBD_TYPE_EPOC		25	/* Psion EPOC machine keyboard */
    111 
    112 /* Manipulate the keyboard bell. */
    113 struct wskbd_bell_data {
    114 	u_int	which;				/* values to get/set */
    115 #define	WSKBD_BELL_DOPITCH	0x1		/* get/set pitch */
    116 #define	WSKBD_BELL_DOPERIOD	0x2		/* get/set period */
    117 #define	WSKBD_BELL_DOVOLUME	0x4		/* get/set volume */
    118 #define	WSKBD_BELL_DOALL	0x7		/* all of the above */
    119 	u_int	pitch;				/* pitch, in Hz */
    120 	u_int	period;				/* period, in milliseconds */
    121 	u_int	volume;				/* percentage of max volume */
    122 };
    123 
    124 #define	WSKBDIO_BELL		_IO('W', 1)
    125 #define	WSKBDIO_COMPLEXBELL	_IOW('W', 2, struct wskbd_bell_data)
    126 #define	WSKBDIO_SETBELL		_IOW('W', 3, struct wskbd_bell_data)
    127 #define	WSKBDIO_GETBELL		_IOR('W', 4, struct wskbd_bell_data)
    128 #define	WSKBDIO_SETDEFAULTBELL	_IOW('W', 5, struct wskbd_bell_data)
    129 #define	WSKBDIO_GETDEFAULTBELL	_IOR('W', 6, struct wskbd_bell_data)
    130 
    131 /* Manipulate the emulation key repeat settings. */
    132 struct wskbd_keyrepeat_data {
    133 	u_int	which;				/* values to get/set */
    134 #define	WSKBD_KEYREPEAT_DODEL1	0x1		/* get/set del1 */
    135 #define	WSKBD_KEYREPEAT_DODELN	0x2		/* get/set delN */
    136 #define	WSKBD_KEYREPEAT_DOALL	0x3		/* all of the above */
    137 	u_int	del1;				/* delay before first, ms */
    138 	u_int	delN;				/* delay before rest, ms */
    139 };
    140 
    141 #define	WSKBDIO_SETKEYREPEAT	_IOW('W', 7, struct wskbd_keyrepeat_data)
    142 #define	WSKBDIO_GETKEYREPEAT	_IOR('W', 8, struct wskbd_keyrepeat_data)
    143 #define	WSKBDIO_SETDEFAULTKEYREPEAT _IOW('W', 9, struct wskbd_keyrepeat_data)
    144 #define	WSKBDIO_GETDEFAULTKEYREPEAT _IOR('W', 10, struct wskbd_keyrepeat_data)
    145 
    146 /* Get/set keyboard leds */
    147 #define	WSKBD_LED_CAPS		0x01
    148 #define	WSKBD_LED_NUM		0x02
    149 #define	WSKBD_LED_SCROLL	0x04
    150 #define	WSKBD_LED_COMPOSE	0x08
    151 
    152 #define	WSKBDIO_SETLEDS		_IOW('W', 11, int)
    153 #define	WSKBDIO_GETLEDS		_IOR('W', 12, int)
    154 
    155 /* Manipulate keysym groups. */
    156 struct wskbd_map_data {
    157 	u_int	maplen;				/* number of entries in map */
    158 #define	WSKBDIO_MAXMAPLEN	65536
    159 	struct wscons_keymap *map;		/* map to get or set */
    160 };
    161 #define	WSKBDIO_GETMAP		_IOWR('W', 13, struct wskbd_map_data)
    162 #define	WSKBDIO_SETMAP		_IOW('W', 14, struct wskbd_map_data)
    163 #define	WSKBDIO_GETENCODING	_IOR('W', 15, kbd_t)
    164 #define	WSKBDIO_SETENCODING	_IOW('W', 16, kbd_t)
    165 
    166 /* internal use only */
    167 #define	WSKBDIO_SETMODE		_IOW('W', 19, int)
    168 #define	WSKBDIO_GETMODE		_IOR('W', 20, int)
    169 #define	WSKBD_TRANSLATED	0
    170 #define	WSKBD_RAW		1
    171 
    172 #define	WSKBDIO_SETKEYCLICK	_IOW('W', 21, int)
    173 #define	WSKBDIO_GETKEYCLICK	_IOR('W', 22, int)
    174 
    175 /* Manipulate the scrolling modifiers and mode */
    176 struct wskbd_scroll_data {
    177 	u_int		which;
    178 #define	WSKBD_SCROLL_DOMODIFIER		0x01
    179 #define	WSKBD_SCROLL_DOMODE		0x02
    180 #define	WSKBD_SCROLL_DOALL		0x03
    181 	u_int		mode;
    182 #define	WSKBD_SCROLL_MODE_NORMAL	0x00
    183 #define	WSKBD_SCROLL_MODE_HOLD		0x01
    184 	u_int		modifier;
    185 };
    186 
    187 #define	WSKBDIO_GETSCROLL	_IOR('W', 23, struct wskbd_scroll_data)
    188 #define	WSKBDIO_SETSCROLL	_IOW('W', 24, struct wskbd_scroll_data)
    189 
    190 /* Set event struct version */
    191 #define WSKBDIO_SETVERSION	_IOW('W', 25, int)
    192 #define WSKBDIO_EVENT_VERSION	WSEVENT_VERSION
    193 
    194 /*
    195  * Mouse ioctls (32 - 63)
    196  */
    197 
    198 /* Get mouse type */
    199 #define	WSMOUSEIO_GTYPE		_IOR('W', 32, u_int)
    200 #define	WSMOUSE_TYPE_VSXXX	1	/* DEC serial */
    201 #define	WSMOUSE_TYPE_PS2	2	/* PS/2-compatible */
    202 #define	WSMOUSE_TYPE_USB	3	/* USB mouse */
    203 #define	WSMOUSE_TYPE_LMS	4	/* Logitech busmouse */
    204 #define	WSMOUSE_TYPE_MMS	5	/* Microsoft InPort mouse */
    205 #define	WSMOUSE_TYPE_TPANEL	6	/* Generic Touch Panel */
    206 #define	WSMOUSE_TYPE_NEXT	7	/* NeXT mouse */
    207 #define	WSMOUSE_TYPE_ARCHIMEDES	8	/* Archimedes mouse */
    208 #define	WSMOUSE_TYPE_HIL	9	/* HIL mouse */
    209 #define	WSMOUSE_TYPE_AMIGA	10	/* Amiga mouse */
    210 #define	WSMOUSE_TYPE_MAXINE	11	/* DEC maxine mouse */
    211 #define	WSMOUSE_TYPE_MAPLE	12	/* Dreamcast Maple mouse */
    212 #define	WSMOUSE_TYPE_SGI	13	/* SGI mouse */
    213 #define	WSMOUSE_TYPE_BLUETOOTH	14	/* Bluetooth mouse */
    214 #define WSMOUSE_TYPE_ADB	15	/* ADB mouse or touchpad */
    215 #define WSMOUSE_TYPE_PSEUDO	16	/* not actually a mouse */
    216 
    217 /* Set resolution.  Not applicable to all mouse types. */
    218 #define	WSMOUSEIO_SRES		_IOW('W', 33, u_int)
    219 #define	WSMOUSE_RES_MIN		0
    220 #define	WSMOUSE_RES_DEFAULT	75
    221 #define	WSMOUSE_RES_MAX		100
    222 
    223 /* Set scale factor (num / den).  Not applicable to all mouse types. */
    224 #define	WSMOUSEIO_SSCALE	_IOW('W', 34, u_int[2])
    225 
    226 /* Set sample rate.  Not applicable to all mouse types. */
    227 #define	WSMOUSEIO_SRATE		_IOW('W', 35, u_int)
    228 #define	WSMOUSE_RATE_MIN	0
    229 #define	WSMOUSE_RATE_DEFAULT	50
    230 #define	WSMOUSE_RATE_MAX	100
    231 
    232 /* Set/get sample coordinates for calibration */
    233 #define	WSMOUSE_CALIBCOORDS_MAX		16
    234 #define	WSMOUSE_CALIBCOORDS_RESET	-1
    235 struct wsmouse_calibcoords {
    236 	int minx, miny;		/* minimum value of X/Y */
    237 	int maxx, maxy;		/* maximum value of X/Y */
    238 	int samplelen;		/* number of samples available or
    239 				   WSMOUSE_CALIBCOORDS_RESET for raw mode */
    240 	struct wsmouse_calibcoord {
    241 		int rawx, rawy;	/* raw coordinate */
    242 		int x, y;	/* translated coordinate */
    243 	} samples[WSMOUSE_CALIBCOORDS_MAX];	/* sample coordinates */
    244 };
    245 #define	WSMOUSEIO_SCALIBCOORDS	_IOW('W', 36, struct wsmouse_calibcoords)
    246 #define	WSMOUSEIO_GCALIBCOORDS	_IOR('W', 37, struct wsmouse_calibcoords)
    247 
    248 /* get device id for calibration */
    249 struct wsmouse_id {
    250 	u_int type;
    251 #define	WSMOUSE_ID_TYPE_UIDSTR	0	/* ID string (null terminated) */
    252 	u_int length;
    253 #define	WSMOUSE_ID_MAXLEN	256
    254 	u_char data[WSMOUSE_ID_MAXLEN];
    255 };
    256 #define	WSMOUSEIO_GETID		_IOWR('W', 38, struct wsmouse_id)
    257 
    258 /* Get/set button repeating. */
    259 struct wsmouse_repeat {
    260 	unsigned long	wr_buttons;
    261 	unsigned int	wr_delay_first;
    262 	unsigned int	wr_delay_decrement;
    263 	unsigned int	wr_delay_minimum;
    264 };
    265 #define WSMOUSEIO_GETREPEAT	_IOR('W', 39, struct wsmouse_repeat)
    266 #define WSMOUSEIO_SETREPEAT	_IOW('W', 40, struct wsmouse_repeat)
    267 
    268 #define WSMOUSEIO_SETVERSION	_IOW('W', 41, int)
    269 #define WSMOUSE_EVENT_VERSION	WSEVENT_VERSION
    270 
    271 /*
    272  * Display ioctls (64 - 95)
    273  */
    274 
    275 /* Get display type */
    276 #define	WSDISPLAYIO_GTYPE	_IOR('W', 64, u_int)
    277 #define	WSDISPLAY_TYPE_UNKNOWN	0	/* unknown */
    278 #define	WSDISPLAY_TYPE_PM_MONO	1	/* DEC [23]100 mono */
    279 #define	WSDISPLAY_TYPE_PM_COLOR	2	/* DEC [23]100 color */
    280 #define	WSDISPLAY_TYPE_CFB	3	/* DEC TC CFB (CX) */
    281 #define	WSDISPLAY_TYPE_XCFB	4	/* DEC `maxine' onboard fb */
    282 #define	WSDISPLAY_TYPE_MFB	5	/* DEC TC MFB (MX) */
    283 #define	WSDISPLAY_TYPE_SFB	6	/* DEC TC SFB (HX) */
    284 #define	WSDISPLAY_TYPE_ISAVGA	7	/* (generic) ISA VGA */
    285 #define	WSDISPLAY_TYPE_PCIVGA	8	/* (generic) PCI VGA */
    286 #define	WSDISPLAY_TYPE_TGA	9	/* DEC PCI TGA */
    287 #define	WSDISPLAY_TYPE_SFBP	10	/* DEC TC SFB+ (HX+) */
    288 #define	WSDISPLAY_TYPE_PCIMISC	11	/* (generic) PCI misc. disp. */
    289 #define	WSDISPLAY_TYPE_NEXTMONO	12	/* NeXT mono display */
    290 #define	WSDISPLAY_TYPE_PX	13	/* DEC TC PX */
    291 #define	WSDISPLAY_TYPE_PXG	14	/* DEC TC PXG */
    292 #define	WSDISPLAY_TYPE_TX	15	/* DEC TC TX */
    293 #define	WSDISPLAY_TYPE_HPCFB	16	/* Handheld/PalmSize PC */
    294 #define	WSDISPLAY_TYPE_VIDC	17	/* Acorn/ARM VIDC */
    295 #define	WSDISPLAY_TYPE_SPX	18	/* DEC SPX (VS3100/VS4000) */
    296 #define	WSDISPLAY_TYPE_GPX	19	/* DEC GPX (uVAX/VS2K/VS3100 */
    297 #define	WSDISPLAY_TYPE_LCG	20	/* DEC LCG (VS4000) */
    298 #define	WSDISPLAY_TYPE_VAX_MONO	21	/* DEC VS2K/VS3100 mono */
    299 #define	WSDISPLAY_TYPE_SB_P9100	22	/* Tadpole SPARCbook P9100 */
    300 #define	WSDISPLAY_TYPE_EGA	23	/* (generic) EGA */
    301 #define	WSDISPLAY_TYPE_DCPVR	24	/* Dreamcast PowerVR */
    302 #define	WSDISPLAY_TYPE_GBOX	25	/* HP Gator */
    303 #define	WSDISPLAY_TYPE_TOPCAT	26	/* HP TopCat */
    304 #define	WSDISPLAY_TYPE_RBOX	27	/* HP Renaissance */
    305 #define	WSDISPLAY_TYPE_CATSEYE	28	/* HP CatsEye */
    306 #define	WSDISPLAY_TYPE_DVBOX	29	/* HP DaVinci */
    307 #define	WSDISPLAY_TYPE_TVRX	30	/* HP TigerShark */
    308 #define	WSDISPLAY_TYPE_HYPERION	31	/* HP Hyperion */
    309 #define	WSDISPLAY_TYPE_AMIGACC	32	/* Amiga custom chips */
    310 #define	WSDISPLAY_TYPE_SUN24	33	/* Sun 24 bit framebuffers */
    311 #define	WSDISPLAY_TYPE_NEWPORT	34	/* SGI Newport */
    312 #define	WSDISPLAY_TYPE_GR2	35	/* SGI GR2 */
    313 #define	WSDISPLAY_TYPE_SUNCG12	36	/* Sun cgtwelve */
    314 #define	WSDISPLAY_TYPE_SUNCG14	37	/* Sun cgfourteen */
    315 #define	WSDISPLAY_TYPE_SUNTCX	38	/* Sun TCX */
    316 #define	WSDISPLAY_TYPE_SUNFFB	39	/* Sun creator FFB */
    317 #define	WSDISPLAY_TYPE_STI	40	/* HP STI framebuffers */
    318 #define	WSDISPLAY_TYPE_HDLCD	41	/* Hitachi HD44780 based LCDs */
    319 #define	WSDISPLAY_TYPE_VESA	42	/* VESA BIOS framebuffer */
    320 #define	WSDISPLAY_TYPE_XILFB	43 	/* Xilinx TFT cores */
    321 #define	WSDISPLAY_TYPE_LIGHT	44	/* SGI Light (a.k.a. Entry/Starter) */
    322 #define	WSDISPLAY_TYPE_GENFB	45	/* generic nondescript framebuffer */
    323 #define	WSDISPLAY_TYPE_CRIME	46	/* SGI O2 */
    324 #define	WSDISPLAY_TYPE_PXALCD	47	/* PXA2x0 LCD controller */
    325 #define	WSDISPLAY_TYPE_AG10	48	/* Fujitsu AG-10e */
    326 #define	WSDISPLAY_TYPE_DL	49	/* DisplayLink DL-1x0/DL-1x5 */
    327 #define	WSDISPLAY_TYPE_XVR1000	50	/* Sun XVR-1000 */
    328 #define	WSDISPLAY_TYPE_LUNA	51	/* OMRON SX-9100 LUNA */
    329 #define	WSDISPLAY_TYPE_GRF	52	/* wsdisplay on top of grf(4) */
    330 #define	WSDISPLAY_TYPE_VNC	53	/* Usermode vnc framebuffer */
    331 #define	WSDISPLAY_TYPE_VALKYRIE	54	/* Apple onboard video 'valkyrie' */
    332 #define	WSDISPLAY_TYPE_IMXIPU	55	/* i.MX ipu */
    333 #define	WSDISPLAY_TYPE_VC4	56	/* Broadcom VideoCore 4 */
    334 #define	WSDISPLAY_TYPE_OMAP3	57	/* OMAP 3530 */
    335 #define	WSDISPLAY_TYPE_WINDERMERE 58	/* SoC for EPOC32 Series 5mx */
    336 #define	WSDISPLAY_TYPE_CLPS711X	59	/* CL PS-711x  */
    337 #define	WSDISPLAY_TYPE_ALLWINNER 60	/* Allwinner ARM SoC */
    338 #define	WSDISPLAY_TYPE_MGX	61	/* SSB 4096V-MGX */
    339 #define	WSDISPLAY_TYPE_MESON	62	/* Amlogic Meson ARM SoC */
    340 #define	WSDISPLAY_TYPE_TEGRA	63	/* NVIDIA Tegra ARM SoC */
    341 
    342 /* Basic display information.  Not applicable to all display types. */
    343 struct wsdisplay_fbinfo {
    344 	u_int	height;				/* height in pixels */
    345 	u_int	width;				/* width in pixels */
    346 	u_int	depth;				/* bits per pixel */
    347 	u_int	cmsize;				/* color map size (entries) */
    348 };
    349 #define	WSDISPLAYIO_GINFO	_IOR('W', 65, struct wsdisplay_fbinfo)
    350 
    351 /* Colormap operations.  Not applicable to all display types. */
    352 struct wsdisplay_cmap {
    353 	u_int	index;				/* first element (0 origin) */
    354 	u_int	count;				/* number of elements */
    355 	u_char	*red;				/* red color map elements */
    356 	u_char	*green;				/* green color map elements */
    357 	u_char	*blue;				/* blue color map elements */
    358 };
    359 #define	WSDISPLAYIO_GETCMAP	_IOW('W', 66, struct wsdisplay_cmap)
    360 #define	WSDISPLAYIO_PUTCMAP	_IOW('W', 67, struct wsdisplay_cmap)
    361 
    362 /* Video control.  Not applicable to all display types. */
    363 #define	WSDISPLAYIO_GVIDEO	_IOR('W', 68, u_int)
    364 #define	WSDISPLAYIO_SVIDEO	_IOW('W', 69, u_int)
    365 #define	WSDISPLAYIO_VIDEO_OFF	0	/* video off */
    366 #define	WSDISPLAYIO_VIDEO_ON	1	/* video on */
    367 
    368 /* Cursor control.  Not applicable to all display types. */
    369 struct wsdisplay_curpos {			/* cursor "position" */
    370 	u_int x, y;
    371 };
    372 
    373 struct wsdisplay_cursor {
    374 	u_int	which;				/* values to get/set */
    375 #define	WSDISPLAY_CURSOR_DOCUR		0x01	/* get/set enable */
    376 #define	WSDISPLAY_CURSOR_DOPOS		0x02	/* get/set pos */
    377 #define	WSDISPLAY_CURSOR_DOHOT		0x04	/* get/set hot spot */
    378 #define	WSDISPLAY_CURSOR_DOCMAP		0x08	/* get/set cmap */
    379 #define	WSDISPLAY_CURSOR_DOSHAPE	0x10	/* get/set img/mask */
    380 #define	WSDISPLAY_CURSOR_DOALL		0x1f	/* all of the above */
    381 	u_int	enable;				/* enable/disable */
    382 	struct wsdisplay_curpos pos;		/* position */
    383 	struct wsdisplay_curpos hot;		/* hot spot */
    384 	struct wsdisplay_cmap cmap;		/* color map info */
    385 	struct wsdisplay_curpos size;		/* bit map size */
    386 	u_char *image;				/* image data */
    387 	u_char *mask;				/* mask data */
    388 };
    389 
    390 /* Cursor control: get and set position */
    391 #define	WSDISPLAYIO_GCURPOS	_IOR('W', 70, struct wsdisplay_curpos)
    392 #define	WSDISPLAYIO_SCURPOS	_IOW('W', 71, struct wsdisplay_curpos)
    393 
    394 /* Cursor control: get maximum size */
    395 #define	WSDISPLAYIO_GCURMAX	_IOR('W', 72, struct wsdisplay_curpos)
    396 
    397 /* Cursor control: get/set cursor attributes/shape */
    398 #define	WSDISPLAYIO_GCURSOR	_IOWR('W', 73, struct wsdisplay_cursor)
    399 #define	WSDISPLAYIO_SCURSOR	_IOW('W', 74, struct wsdisplay_cursor)
    400 
    401 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */
    402 #define	WSDISPLAYIO_GMODE	_IOR('W', 75, u_int)
    403 #define	WSDISPLAYIO_SMODE	_IOW('W', 76, u_int)
    404 #define	WSDISPLAYIO_MODE_EMUL	0	/* emulation (text) mode */
    405 #define	WSDISPLAYIO_MODE_MAPPED	1	/* mapped (graphics) mode */
    406 #define	WSDISPLAYIO_MODE_DUMBFB	2	/* mapped (graphics) fb mode */
    407 
    408 
    409 /*
    410  * XXX WARNING
    411  * XXX The following wsdisplay definitions are very preliminary and are likely
    412  * XXX to be changed without care about backwards compatibility!
    413  */
    414 struct wsdisplay_font {
    415 	const char *name;
    416 	int firstchar, numchars;
    417 	int encoding;
    418 #define	WSDISPLAY_FONTENC_ISO 0
    419 #define	WSDISPLAY_FONTENC_IBM 1
    420 #define	WSDISPLAY_FONTENC_PCVT 2
    421 #define	WSDISPLAY_FONTENC_ISO7 3 /* greek */
    422 #define	WSDISPLAY_FONTENC_ISO2 4 /* east european */
    423 #define	WSDISPLAY_FONTENC_KOI8_R 5 /* russian */
    424 	u_int fontwidth, fontheight, stride;
    425 #define	WSDISPLAY_MAXFONTSZ	(512*1024)
    426 	int bitorder, byteorder;
    427 #define	WSDISPLAY_FONTORDER_KNOWN 0	/* i.e, no need to convert */
    428 #define	WSDISPLAY_FONTORDER_L2R 1
    429 #define	WSDISPLAY_FONTORDER_R2L 2
    430 	void *data;
    431 };
    432 #define	WSDISPLAYIO_LDFONT	_IOW('W', 77, struct wsdisplay_font)
    433 
    434 struct wsdisplay_addscreendata {
    435 	int idx; /* screen index */
    436 	char *screentype;
    437 	char *emul;
    438 };
    439 #define	WSDISPLAYIO_ADDSCREEN	_IOW('W', 78, struct wsdisplay_addscreendata)
    440 
    441 struct wsdisplay_delscreendata {
    442 	int idx; /* screen index */
    443 	int flags;
    444 #define	WSDISPLAY_DELSCR_FORCE 1
    445 };
    446 #define	WSDISPLAYIO_DELSCREEN	_IOW('W', 79, struct wsdisplay_delscreendata)
    447 
    448 struct wsdisplay_usefontdata {
    449 	char *name;
    450 };
    451 #define	WSDISPLAYIO_SFONT	_IOW('W', 80, struct wsdisplay_usefontdata)
    452 
    453 /* Obsolete, replaced by WSMUXIO_{ADD,REMOVE}_DEVICE */
    454 struct wsdisplay_kbddata {
    455 	int op;
    456 #define	_O_WSDISPLAY_KBD_ADD 0
    457 #define	_O_WSDISPLAY_KBD_DEL 1
    458 	int idx;
    459 };
    460 #define	_O_WSDISPLAYIO_SETKEYBOARD	_IOWR('W', 81, struct wsdisplay_kbddata)
    461 
    462 /*
    463  * Misc control.  Not applicable to all display types.
    464  * - WSDISPLAYIO_PARAM_BACKLIGHT should be an on/off switch for screensavers,
    465  *   it should turn the display dark / turn the backlight off without changing
    466  *   the brightness value so screensavers and such can just flip the switch
    467  *   without caring about actual brightness settings
    468  * - WSDISPLAYIO_PARAM_BRIGHTNESS should set display / backlight brightness
    469  */
    470 struct wsdisplay_param {
    471 	int param;
    472 #define	WSDISPLAYIO_PARAM_BACKLIGHT	1
    473 #define	WSDISPLAYIO_PARAM_BRIGHTNESS	2
    474 #define	WSDISPLAYIO_PARAM_CONTRAST	3
    475 	int min, max, curval;
    476 	int reserved[4];
    477 };
    478 #define	WSDISPLAYIO_GETPARAM	_IOWR('W', 82, struct wsdisplay_param)
    479 #define	WSDISPLAYIO_SETPARAM	_IOWR('W', 83, struct wsdisplay_param)
    480 
    481 #define	WSDISPLAYIO_GETACTIVESCREEN	_IOR('W', 84, int)
    482 
    483 /* Character functions */
    484 struct wsdisplay_char {
    485 	int row, col;
    486 	uint16_t letter;
    487 	uint8_t background, foreground;
    488 	char flags;
    489 #define	WSDISPLAY_CHAR_BRIGHT 1
    490 #define	WSDISPLAY_CHAR_BLINK  2
    491 };
    492 #define	WSDISPLAYIO_GETWSCHAR	_IOWR('W', 85, struct wsdisplay_char)
    493 #define	WSDISPLAYIO_PUTWSCHAR	_IOWR('W', 86, struct wsdisplay_char)
    494 
    495 /* Manipulate the scrolling values (how many lines to scroll) */
    496 
    497 struct wsdisplay_scroll_data {
    498 	u_int		which;
    499 #define	WSDISPLAY_SCROLL_DOFASTLINES	0x01
    500 #define	WSDISPLAY_SCROLL_DOSLOWLINES	0x02
    501 #define	WSDISPLAY_SCROLL_DOALL		0x03
    502 	u_int		fastlines;
    503 	u_int		slowlines;
    504 };
    505 
    506 #define	WSDISPLAYIO_DGSCROLL	_IOR('W', 87, struct wsdisplay_scroll_data)
    507 #define	WSDISPLAYIO_DSSCROLL	_IOW('W', 88, struct wsdisplay_scroll_data)
    508 
    509 struct wsdisplay_msgattrs {
    510 	int default_attrs, default_bg, default_fg;
    511 	int kernel_attrs, kernel_bg, kernel_fg;
    512 };
    513 
    514 #define	WSDISPLAYIO_GMSGATTRS	_IOR('W', 89, struct wsdisplay_msgattrs)
    515 #define	WSDISPLAYIO_SMSGATTRS	_IOW('W', 90, struct wsdisplay_msgattrs)
    516 
    517 #define	WSDISPLAYIO_GBORDER	_IOR('W', 91, int)
    518 #define	WSDISPLAYIO_SBORDER	_IOW('W', 92, int)
    519 
    520 /* Splash screen control */
    521 #define	WSDISPLAYIO_SSPLASH	_IOW('W', 93, int)
    522 #define	WSDISPLAYIO_SPROGRESS	_IOW('W', 94, int)
    523 
    524 /* XXX NOT YET DEFINED */
    525 /* Mapping information retrieval. */
    526 
    527 /* Display information: number of bytes per row, may be same as pixels */
    528 #define	WSDISPLAYIO_LINEBYTES	_IOR('W', 95, u_int)
    529 
    530 /* WSMUXIO_OINJECTEVENT	was 96, but does not conflict because arg sizes */
    531 
    532 #define WSDISPLAYIO_SETVERSION	_IOW('W', 96, int)
    533 #define WSDISPLAYIO_EVENT_VERSION	WSEVENT_VERSION
    534 
    535 /*
    536  * Mux ioctls (97 - 127)
    537  */
    538 
    539 struct wsmux_device {
    540 	int type;
    541 #define	WSMUX_MOUSE	1
    542 #define	WSMUX_KBD	2
    543 #define	WSMUX_MUX	3
    544 	int idx;
    545 };
    546 #define	WSMUXIO_ADD_DEVICE	_IOW('W', 97, struct wsmux_device)
    547 #define	WSMUX_ADD_DEVICE	WSMUXIO_ADD_DEVICE /* XXX compat */
    548 #define	WSMUXIO_REMOVE_DEVICE	_IOW('W', 98, struct wsmux_device)
    549 #define	WSMUX_REMOVE_DEVICE	WSMUXIO_REMOVE_DEVICE /* XXX compat */
    550 
    551 #define	WSMUX_MAXDEV 32
    552 struct wsmux_device_list {
    553 	int ndevices;
    554 	struct wsmux_device devices[WSMUX_MAXDEV];
    555 };
    556 #define	WSMUXIO_LIST_DEVICES	_IOWR('W', 99, struct wsmux_device_list)
    557 #define	WSMUX_LIST_DEVICES	WSMUXIO_LIST_DEVICES /* XXX compat */
    558 
    559 #define	WSMUXIO_INJECTEVENT	_IOW('W', 100, struct wscons_event)
    560 #define	WSMUX_INJECTEVENT	WSMUXIO_INJECTEVENT /* XXX compat */
    561 
    562 /* Mapping information retrieval. */
    563 struct wsdisplayio_bus_id {
    564     u_int bus_type;
    565 #define WSDISPLAYIO_BUS_PCI	0
    566 #define WSDISPLAYIO_BUS_SBUS	1
    567 #define WSDISPLAYIO_BUS_SOC	2
    568     union bus_data {
    569         struct bus_pci {
    570             uint32_t domain;
    571             uint32_t bus;
    572             uint32_t device;
    573             uint32_t function;
    574         } pci;
    575         struct bus_sbus {
    576             uint32_t fb_instance;
    577         } sbus;
    578         /* so the size doesn't change if we add more bus types */
    579         char pad[32];
    580     } ubus;
    581 };
    582 
    583 #define WSDISPLAYIO_GET_BUSID	_IOR('W', 101, struct wsdisplayio_bus_id)
    584 
    585 /*
    586  * retrieving EDID data from a wsdisplay driver
    587  * The EDID block will be written into a buffer pointed at by edid_data,
    588  * the caller must fill in buffer_size and edid_data, the driver will set
    589  * data_size to the number of bytes actually written.
    590  * If the buffer is too small the call will fail with EAGAIN and the driver
    591  * will set data_size without writing anything into the buffer.
    592  */
    593 
    594 struct wsdisplayio_edid_info {
    595 	uint32_t buffer_size;
    596 	uint32_t data_size;
    597 	void *edid_data;
    598 };
    599 #define WSDISPLAYIO_GET_EDID	_IOWR('W', 102, struct wsdisplayio_edid_info)
    600 
    601 /*
    602  * this is for enabling and disabling interrupt-driven drawing
    603  * pass 1 to enable polling, 0 to go back to normal
    604  * the kernel itself will call this on the console device when entering or
    605  * leaving ddb and on panic
    606  * may have side effects like hard switching to the virtual console which
    607  * shows kernel output, resetting the video hardware etc. - not really for
    608  * userland to mess with
    609  */
    610 #define WSDISPLAYIO_SET_POLLING	_IOW('W', 103, int)
    611 #define WSDISPLAYIOMGWEHITANDKILLEDASKUNK WSDISPLAYIO_SET_POLLING
    612 
    613 /*
    614  * this is supposed to replace WSDISPLAYIO_GINFO, WSDISPLAYIO_GTYPE,
    615  * WSDISPLAYIO_LINEBYTES etc.
    616  */
    617 
    618 /* format type - colour index, 'true' colour etc. */
    619 #define WSFB_RGB	0
    620 #define WSFB_CI		1	/* colour indexed, see subtype */
    621 #define WSFB_GREYSCALE	2
    622 #define WSFB_YUV	3
    623 
    624 struct wsdisplayio_fbinfo {
    625 	uint64_t fbi_fbsize;		/* framebuffer size in bytes */
    626 	uint64_t fbi_fboffset;		/* start of visible fb, in bytes */
    627 	uint32_t fbi_width;		/* in pixels */
    628 	uint32_t fbi_height;		/* in lines */
    629 	uint32_t fbi_stride;		/* in bytes */
    630 	uint32_t fbi_bitsperpixel;
    631 	uint32_t fbi_pixeltype;		/* see above */
    632 	union _fbi_subtype {
    633 		struct _fbi_rgbmasks {
    634 			/* offsets from the right, size in bits */
    635 			uint32_t red_offset;
    636 			uint32_t red_size;
    637 			uint32_t green_offset;
    638 			uint32_t green_size;
    639 			uint32_t blue_offset;
    640 			uint32_t blue_size;
    641 			uint32_t alpha_offset;
    642 			uint32_t alpha_size;
    643 		} fbi_rgbmasks;
    644 		struct _fbi_cmapinfo {
    645 			uint32_t cmap_entries;
    646 		} fbi_cmapinfo;
    647 		/*
    648 		 * TODO:
    649 		 * add parameter blocks for greyscale, yuv etc.
    650 		 */
    651 	} fbi_subtype;
    652 	uint32_t fbi_flags;
    653 };
    654 
    655 /* fbi_flags */
    656 #define WSFB_VRAM_IS_RAM	1	/* hint for wsfb - don't shadow */
    657 
    658 #define WSDISPLAYIO_GET_FBINFO	_IOWR('W', 104, struct wsdisplayio_fbinfo)
    659 
    660 struct wsdisplayio_blit {
    661 	uint32_t serial;
    662 	uint32_t op;
    663 	uint32_t srcx;
    664 	uint32_t srcy;
    665 	uint32_t dstx;
    666 	uint32_t dsty;
    667 	uint32_t width;
    668 	uint32_t height;
    669 	uint32_t pen;
    670 };
    671 
    672 /* blit ops */
    673 #define WSFB_BLIT_FILL		1	/* fill rectangle */
    674 #define WSFB_BLIT_COPY		2	/* copy rectangle */
    675 #define WSFB_BLIT_TRANS		3	/* copy rectangle with color key */
    676 
    677 #define WSDISPLAYIO_DOBLIT   	_IOWR('W', 105, struct wsdisplayio_blit)
    678 #define WSDISPLAYIO_WAITBLIT 	_IOWR('W', 106, struct wsdisplayio_blit)
    679 
    680 #endif /* _DEV_WSCONS_WSCONSIO_H_ */
    681