xref: /openbsd/sys/dev/wscons/wsconsio.h (revision db233230)
1 /* $OpenBSD: wsconsio.h,v 1.102 2024/09/30 01:41:49 jsg Exp $ */
2 /* $NetBSD: wsconsio.h,v 1.74 2005/04/28 07:15:44 martin 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-127	mux ioctls (WSMUXIO)
45  *	128-159 driver private ioctls
46  *	160-255 reserved for future use
47  */
48 
49 #include <sys/types.h>
50 #include <sys/ioccom.h>
51 #include <dev/wscons/wsksymvar.h>
52 
53 #include <sys/pciio.h>
54 
55 #define	WSSCREEN_NAME_SIZE	16
56 #define	WSEMUL_NAME_SIZE	16
57 #define	WSFONT_NAME_SIZE	32
58 
59 /*
60  * Common event structure (used by keyboard and mouse)
61  */
62 struct wscons_event {
63 	u_int		type;
64 	int		value;
65 	struct timespec	time;
66 };
67 
68 /* Event type definitions.  Comment for each is information in value. */
69 #define	WSCONS_EVENT_KEY_UP		1	/* key code */
70 #define	WSCONS_EVENT_KEY_DOWN		2	/* key code */
71 #define	WSCONS_EVENT_ALL_KEYS_UP	3	/* void */
72 #define	WSCONS_EVENT_MOUSE_UP		4	/* button # (leftmost = 0) */
73 #define	WSCONS_EVENT_MOUSE_DOWN		5	/* button # (leftmost = 0)  */
74 #define	WSCONS_EVENT_MOUSE_DELTA_X	6	/* X delta amount */
75 #define	WSCONS_EVENT_MOUSE_DELTA_Y	7	/* Y delta amount */
76 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_X	8	/* X location */
77 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_Y	9	/* Y location */
78 #define	WSCONS_EVENT_MOUSE_DELTA_Z	10	/* Z delta amount */
79 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_Z	11	/* (legacy, see below) */
80 				     /*	12-15, see below */
81 #define	WSCONS_EVENT_MOUSE_DELTA_W	16	/* W delta amount */
82 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_W	17	/* (legacy, see below) */
83 #define	WSCONS_EVENT_SYNC		18
84 /*
85  * Following events are not real wscons_event but are used as parameters of the
86  * WSDISPLAYIO_WSMOUSED ioctl
87  */
88 #define WSCONS_EVENT_WSMOUSED_ON	12	/* wsmoused(8) active */
89 #define WSCONS_EVENT_WSMOUSED_OFF	13	/* wsmoused(8) inactive */
90 
91 #define IS_MOTION_EVENT(type) (((type) == WSCONS_EVENT_MOUSE_DELTA_X) || \
92 			       ((type) == WSCONS_EVENT_MOUSE_DELTA_Y) || \
93 			       ((type) == WSCONS_EVENT_MOUSE_DELTA_Z) || \
94 			       ((type) == WSCONS_EVENT_MOUSE_DELTA_W))
95 #define IS_BUTTON_EVENT(type) (((type) == WSCONS_EVENT_MOUSE_UP) || \
96 			       ((type) == WSCONS_EVENT_MOUSE_DOWN))
97 #define IS_CTRL_EVENT(type) ((type == WSCONS_EVENT_WSMOUSED_ON) || \
98 			     (type == WSCONS_EVENT_WSMOUSED_OFF))
99 
100 
101 /*
102  * (Single-) Touch Events
103  *
104  * A RESET event will be generated whenever a change of X and Y is
105  * coupled with a change of the contact count, or with a change of
106  * the pointer-controlling MT slot.
107  */
108 #define	WSCONS_EVENT_TOUCH_PRESSURE	WSCONS_EVENT_MOUSE_ABSOLUTE_Z
109 #define	WSCONS_EVENT_TOUCH_CONTACTS	WSCONS_EVENT_MOUSE_ABSOLUTE_W
110 
111 #define	WSCONS_EVENT_TOUCH_WIDTH	24	/* contact width */
112 #define	WSCONS_EVENT_TOUCH_RESET	25	/* (no value) */
113 
114 /*
115  * Precision Scrolling
116  */
117 #define WSCONS_EVENT_HSCROLL		26	/* dx * 4096 / scroll_unit */
118 #define WSCONS_EVENT_VSCROLL		27	/* dy * 4096 / scroll_unit */
119 
120 /*
121  * Keyboard ioctls (0 - 31)
122  */
123 
124 /* Get keyboard type. */
125 #define	WSKBDIO_GTYPE		_IOR('W', 0, u_int)
126 #define		WSKBD_TYPE_LK201	1	/* lk-201 */
127 #define		WSKBD_TYPE_LK401	2	/* lk-401 */
128 #define		WSKBD_TYPE_PC_XT	3	/* PC-ish, XT scancode */
129 #define		WSKBD_TYPE_PC_AT	4	/* PC-ish, AT scancode */
130 #define		WSKBD_TYPE_USB		5	/* USB, XT scancode */
131 #define		WSKBD_TYPE_NEXT		6	/* NeXT keyboard */
132 #define		WSKBD_TYPE_HPC_KBD	7	/* HPC builtin keyboard */
133 #define		WSKBD_TYPE_HPC_BTN	8	/* HPC/PsPC buttons */
134 #define		WSKBD_TYPE_ARCHIMEDES	9	/* Archimedes keyboard */
135 #define		WSKBD_TYPE_ADB		10	/* Apple ADB keyboard */
136 #define		WSKBD_TYPE_SUN		11	/* Sun Type3/4 */
137 #define		WSKBD_TYPE_SUN5		12	/* Sun Type5 */
138 #define		WSKBD_TYPE_HIL		13	/* HP HIL */
139 #define		WSKBD_TYPE_GSC		14	/* HP PS/2 */
140 #define		WSKBD_TYPE_LUNA		15	/* OMRON Luna */
141 #define		WSKBD_TYPE_ZAURUS	16	/* Sharp Zaurus */
142 #define		WSKBD_TYPE_DOMAIN	17	/* Apollo Domain */
143 #define		WSKBD_TYPE_BLUETOOTH	18	/* Bluetooth keyboard */
144 #define		WSKBD_TYPE_KPC		19	/* Palm keypad */
145 #define		WSKBD_TYPE_SGI		20	/* SGI serial keyboard */
146 
147 /* Manipulate the keyboard bell. */
148 struct wskbd_bell_data {
149 	u_int	which;				/* values to get/set */
150 	u_int	pitch;				/* pitch, in Hz */
151 	u_int	period;				/* period, in milliseconds */
152 	u_int	volume;				/* percentage of max volume */
153 };
154 #define		WSKBD_BELL_DOPITCH	0x1		/* get/set pitch */
155 #define		WSKBD_BELL_DOPERIOD	0x2		/* get/set period */
156 #define		WSKBD_BELL_DOVOLUME	0x4		/* get/set volume */
157 #define		WSKBD_BELL_DOALL	0x7		/* all of the above */
158 
159 #define	WSKBDIO_BELL		_IO('W', 1)
160 #define	WSKBDIO_COMPLEXBELL	_IOW('W', 2, struct wskbd_bell_data)
161 #define	WSKBDIO_SETBELL		_IOW('W', 3, struct wskbd_bell_data)
162 #define	WSKBDIO_GETBELL		_IOR('W', 4, struct wskbd_bell_data)
163 #define	WSKBDIO_SETDEFAULTBELL	_IOW('W', 5, struct wskbd_bell_data)
164 #define	WSKBDIO_GETDEFAULTBELL	_IOR('W', 6, struct wskbd_bell_data)
165 
166 /* Manipulate the emulation key repeat settings. */
167 struct wskbd_keyrepeat_data {
168 	u_int	which;				/* values to get/set */
169 	u_int	del1;				/* delay before first, ms */
170 	u_int	delN;				/* delay before rest, ms */
171 };
172 #define		WSKBD_KEYREPEAT_DODEL1	0x1		/* get/set del1 */
173 #define		WSKBD_KEYREPEAT_DODELN	0x2		/* get/set delN */
174 #define		WSKBD_KEYREPEAT_DOALL	0x3		/* all of the above */
175 
176 #define	WSKBDIO_SETKEYREPEAT	_IOW('W', 7, struct wskbd_keyrepeat_data)
177 #define	WSKBDIO_GETKEYREPEAT	_IOR('W', 8, struct wskbd_keyrepeat_data)
178 #define	WSKBDIO_SETDEFAULTKEYREPEAT \
179 	    _IOW('W', 9, struct wskbd_keyrepeat_data)
180 #define	WSKBDIO_GETDEFAULTKEYREPEAT \
181 	    _IOR('W', 10, struct wskbd_keyrepeat_data)
182 
183 /* Get/set keyboard leds */
184 #define		WSKBD_LED_CAPS		0x01
185 #define		WSKBD_LED_NUM		0x02
186 #define		WSKBD_LED_SCROLL	0x04
187 #define		WSKBD_LED_COMPOSE	0x08
188 
189 #define	WSKBDIO_SETLEDS		_IOW('W', 11, int)
190 #define	WSKBDIO_GETLEDS		_IOR('W', 12, int)
191 
192 /* Manipulate keysym groups. */
193 struct wskbd_map_data {
194 	u_int	maplen;				/* number of entries in map */
195 #define WSKBDIO_MAXMAPLEN	65536
196 	struct wscons_keymap *map;		/* map to get or set */
197 };
198 #define WSKBDIO_GETMAP		_IOWR('W', 13, struct wskbd_map_data)
199 #define WSKBDIO_SETMAP		_IOW('W', 14, struct wskbd_map_data)
200 #define WSKBDIO_GETENCODING	_IOR('W', 15, kbd_t)
201 #define WSKBDIO_SETENCODING	_IOW('W', 16, kbd_t)
202 
203 /* Get/set keyboard backlight.  Not applicable to all keyboard types. */
204 struct wskbd_backlight {
205 	unsigned int min, max, curval;
206 };
207 #define	WSKBDIO_GETBACKLIGHT	_IOR('W', 17, struct wskbd_backlight)
208 #define	WSKBDIO_SETBACKLIGHT	_IOW('W', 18, struct wskbd_backlight)
209 
210 /* internal use only */
211 #define WSKBDIO_SETMODE		_IOW('W', 19, int)
212 #define WSKBDIO_GETMODE		_IOR('W', 20, int)
213 #define		WSKBD_TRANSLATED	0
214 #define		WSKBD_RAW		1
215 
216 struct wskbd_encoding_data {
217 	int	nencodings;
218 	kbd_t	*encodings;
219 };
220 #define WSKBDIO_GETENCODINGS	_IOWR('W', 21, struct wskbd_encoding_data)
221 
222 /*
223  * Mouse ioctls (32 - 63)
224  */
225 
226 /* Get mouse type */
227 #define	WSMOUSEIO_GTYPE		_IOR('W', 32, u_int)
228 #define		WSMOUSE_TYPE_VSXXX	1	/* DEC serial */
229 #define		WSMOUSE_TYPE_PS2	2	/* PS/2-compatible */
230 #define		WSMOUSE_TYPE_USB	3	/* USB mouse */
231 #define		WSMOUSE_TYPE_LMS	4	/* Logitech busmouse */
232 #define		WSMOUSE_TYPE_MMS	5	/* Microsoft InPort mouse */
233 #define		WSMOUSE_TYPE_TPANEL	6	/* Generic Touch Panel */
234 #define		WSMOUSE_TYPE_NEXT	7	/* NeXT mouse */
235 #define		WSMOUSE_TYPE_ARCHIMEDES	8	/* Archimedes mouse */
236 #define		WSMOUSE_TYPE_ADB	9	/* ADB */
237 #define		WSMOUSE_TYPE_HIL	10	/* HP HIL */
238 #define		WSMOUSE_TYPE_LUNA	11	/* OMRON Luna */
239 #define		WSMOUSE_TYPE_DOMAIN	12	/* Apollo Domain */
240 #define		WSMOUSE_TYPE_BLUETOOTH	13	/* Bluetooth mouse */
241 #define		WSMOUSE_TYPE_SUN	14	/* SUN serial mouse */
242 #define		WSMOUSE_TYPE_SYNAPTICS	15	/* Synaptics touchpad */
243 #define		WSMOUSE_TYPE_ALPS	16	/* ALPS touchpad */
244 #define		WSMOUSE_TYPE_SGI	17	/* SGI serial mouse */
245 #define		WSMOUSE_TYPE_ELANTECH	18	/* Elantech touchpad */
246 #define		WSMOUSE_TYPE_SYNAP_SBTN	19	/* Synaptics soft buttons */
247 #define		WSMOUSE_TYPE_TOUCHPAD	20	/* Generic touchpad */
248 
249 /* Set resolution.  Not applicable to all mouse types. */
250 #define	WSMOUSEIO_SRES		_IOW('W', 33, u_int)
251 #define		WSMOUSE_RES_MIN		0
252 #define		WSMOUSE_RES_DEFAULT	75
253 #define		WSMOUSE_RES_MAX		100
254 
255 /* Set/get sample coordinates for calibration */
256 #define	WSMOUSE_CALIBCOORDS_MAX		16
257 #define	WSMOUSE_CALIBCOORDS_RESET	-1
258 struct wsmouse_calibcoords {
259 	int minx, miny;		/* minimum value of X/Y */
260 	int maxx, maxy;		/* maximum value of X/Y */
261 	int swapxy;		/* swap X/Y axis */
262 	int resx, resy;		/* X/Y resolution */
263 	int samplelen;		/* number of samples available or
264 				   WSMOUSE_CALIBCOORDS_RESET for raw mode */
265 	struct wsmouse_calibcoord {
266 		int rawx, rawy;	/* raw coordinate */
267 		int x, y;	/* translated coordinate */
268 	} samples[WSMOUSE_CALIBCOORDS_MAX];	/* sample coordinates */
269 };
270 #define	WSMOUSEIO_SCALIBCOORDS	_IOW('W', 36, struct wsmouse_calibcoords)
271 #define	WSMOUSEIO_GCALIBCOORDS	_IOR('W', 37, struct wsmouse_calibcoords)
272 
273 #define	WSMOUSEIO_SETMODE	_IOW('W', 38, int)
274 #define		WSMOUSE_COMPAT		0
275 #define		WSMOUSE_NATIVE		1
276 
277 /*
278  * Keys of the configuration parameters in WSMOUSEIO_GETPARAMS/
279  * WSMOUSEIO_SETPARAMS calls. Arbitrary subsets can be passed, provided
280  * that all keys are valid and that the number of key/value pairs doesn't
281  * exceed WSMOUSECFG_MAX.
282  *
283  * The keys are divided into various groups, which end with marker entries
284  * of the form WSMOUSECFG__*.
285  */
286 enum wsmousecfg {
287  	/*
288  	 * Coordinate handling.
289  	 */
290 	WSMOUSECFG_DX_SCALE = 0,/* Xscale factor in [*.12] fixed-point format */
291 	WSMOUSECFG_DY_SCALE,	/* Yscale factor in [*.12] fixed-point format */
292 	WSMOUSECFG_PRESSURE_LO,	/* pressure limits defining start of touch */
293 	WSMOUSECFG_PRESSURE_HI,	/* pressure limits defining end of touch */
294 	WSMOUSECFG_TRKMAXDIST,	/* max distance to pair points for MT contact */
295 	WSMOUSECFG_SWAPXY,	/* swap X- and Y-axis */
296 	WSMOUSECFG_X_INV,	/* map absolute coordinate X to (INV - X) */
297 	WSMOUSECFG_Y_INV,	/* map absolute coordinate Y to (INV - Y) */
298 	WSMOUSECFG_REVERSE_SCROLLING,
299 				/* reverse scroll directions */
300 
301         WSMOUSECFG__FILTERS,
302 
303 	/*
304 	 * Coordinate handling, applying only in WSMOUSE_COMPAT  mode.
305 	 */
306 	WSMOUSECFG_DX_MAX = 32,	/* ignore X deltas greater than this limit */
307 	WSMOUSECFG_DY_MAX,	/* ignore Y deltas greater than this limit */
308 	WSMOUSECFG_X_HYSTERESIS,/* retard value for X coordinates */
309 	WSMOUSECFG_Y_HYSTERESIS,/* retard value for Y coordinates */
310 	WSMOUSECFG_DECELERATION,/* threshold (distance) for deceleration */
311 	WSMOUSECFG_STRONG_HYSTERESIS,	/* FALSE and read-only, the fea-
312 					   ture is not supported anymore. */
313 	WSMOUSECFG_SMOOTHING,	/* smoothing factor (0-7) */
314 
315 	WSMOUSECFG__TPFILTERS,
316 
317 	/*
318 	 * Touchpad features
319 	 */
320 	WSMOUSECFG_SOFTBUTTONS = 64,	/* 2 soft-buttons at the bottom edge */
321 	WSMOUSECFG_SOFTMBTN,		/* add a middle-button area */
322 	WSMOUSECFG_TOPBUTTONS,		/* 3 soft-buttons at the top edge */
323 	WSMOUSECFG_TWOFINGERSCROLL,	/* enable two-finger scrolling */
324 	WSMOUSECFG_EDGESCROLL,		/* enable edge scrolling */
325 	WSMOUSECFG_HORIZSCROLL,		/* enable horizontal edge scrolling */
326 	WSMOUSECFG_SWAPSIDES,		/* invert soft-button/scroll areas */
327 	WSMOUSECFG_DISABLE,		/* disable all output except for
328 					   clicks in the top-button area */
329 	WSMOUSECFG_MTBUTTONS,		/* multi-touch buttons */
330 
331 	WSMOUSECFG__TPFEATURES,
332 
333 	/*
334 	 * Touchpad options
335 	 */
336 	WSMOUSECFG_LEFT_EDGE = 128,	/* ratio: left edge / total width */
337 	WSMOUSECFG_RIGHT_EDGE,		/* ratio: right edge / total width */
338 	WSMOUSECFG_TOP_EDGE,		/* ratio: top edge / total height */
339 	WSMOUSECFG_BOTTOM_EDGE,		/* ratio: bottom edge / total height */
340 	WSMOUSECFG_CENTERWIDTH,		/* ratio: center width / total width */
341 	WSMOUSECFG_HORIZSCROLLDIST,	/* distance mapped to a scroll event */
342 	WSMOUSECFG_VERTSCROLLDIST,	/* distance mapped to a scroll event */
343 	WSMOUSECFG_F2WIDTH,		/* width limit for single touches */
344 	WSMOUSECFG_F2PRESSURE,		/* pressure limit for single touches */
345 	WSMOUSECFG_TAP_MAXTIME,		/* max. duration of tap contacts (ms) */
346 	WSMOUSECFG_TAP_CLICKTIME,	/* time between the end of a tap and
347 					   the button-up-event (ms) */
348 	WSMOUSECFG_TAP_LOCKTIME,	/* time between a tap-and-drag action
349 					   and the button-up-event (ms) */
350 	WSMOUSECFG_TAP_ONE_BTNMAP,	/* one-finger tap button mapping */
351 	WSMOUSECFG_TAP_TWO_BTNMAP,	/* two-finger tap button mapping */
352 	WSMOUSECFG_TAP_THREE_BTNMAP,	/* three-finger tap button mapping */
353 	WSMOUSECFG_MTBTN_MAXDIST,	/* MTBUTTONS: distance limit for
354 					   two-finger clicks */
355 
356 	WSMOUSECFG__TPSETUP,
357 
358 	/*
359 	 * Enable/Disable debug output.
360 	 */
361 	WSMOUSECFG_LOG_INPUT = 256,
362 	WSMOUSECFG_LOG_EVENTS,
363 
364 	WSMOUSECFG__DEBUG,
365 };
366 
367 #define WSMOUSECFG_MAX ((WSMOUSECFG__FILTERS - WSMOUSECFG_DX_SCALE)	\
368     + (WSMOUSECFG__TPFILTERS - WSMOUSECFG_DX_MAX)			\
369     + (WSMOUSECFG__TPFEATURES - WSMOUSECFG_SOFTBUTTONS)			\
370     + (WSMOUSECFG__TPSETUP - WSMOUSECFG_LEFT_EDGE)			\
371     + (WSMOUSECFG__DEBUG - WSMOUSECFG_LOG_INPUT))
372 
373 struct wsmouse_param {
374 	enum wsmousecfg key;
375 	int value;
376 };
377 
378 struct wsmouse_parameters {
379 	struct wsmouse_param *params;
380 	u_int nparams;
381 };
382 
383 #define WSMOUSEIO_GETPARAMS	_IOW('W', 39, struct wsmouse_parameters)
384 #define WSMOUSEIO_SETPARAMS	_IOW('W', 40, struct wsmouse_parameters)
385 
386 /*
387  * Display ioctls (64 - 95)
388  */
389 
390 /* Get display type */
391 #define	WSDISPLAYIO_GTYPE	_IOR('W', 64, u_int)
392 #define		WSDISPLAY_TYPE_UNKNOWN	0	/* unknown */
393 #define		WSDISPLAY_TYPE_PM_MONO	1	/* DEC [23]100 mono */
394 #define		WSDISPLAY_TYPE_PM_COLOR	2	/* DEC [23]100 color */
395 #define		WSDISPLAY_TYPE_CFB	3	/* DEC TC CFB (CX) */
396 #define		WSDISPLAY_TYPE_XCFB	4	/* DEC `maxine' onboard fb */
397 #define		WSDISPLAY_TYPE_MFB	5	/* DEC TC MFB (MX) */
398 #define		WSDISPLAY_TYPE_SFB	6	/* DEC TC SFB (HX) */
399 #define		WSDISPLAY_TYPE_ISAVGA	7	/* (generic) ISA VGA */
400 #define		WSDISPLAY_TYPE_PCIVGA	8	/* (generic) PCI VGA */
401 #define		WSDISPLAY_TYPE_TGA	9	/* DEC PCI TGA */
402 #define		WSDISPLAY_TYPE_SFBP	10	/* DEC TC SFB+ (HX+) */
403 #define		WSDISPLAY_TYPE_PCIMISC	11	/* (generic) PCI misc. disp. */
404 #define		WSDISPLAY_TYPE_NEXTMONO	12	/* NeXT mono display */
405 #define		WSDISPLAY_TYPE_PX	13	/* DEC TC PX */
406 #define		WSDISPLAY_TYPE_PXG	14	/* DEC TC PXG */
407 #define		WSDISPLAY_TYPE_TX	15	/* DEC TC TX */
408 #define		WSDISPLAY_TYPE_HPCFB	16	/* Handheld/PalmSize PC */
409 #define		WSDISPLAY_TYPE_VIDC	17	/* Acorn/ARM VIDC */
410 #define		WSDISPLAY_TYPE_SPX	18	/* DEC SPX (VS3100/VS4000) */
411 #define		WSDISPLAY_TYPE_GPX	19	/* DEC GPX (uVAX/VS2K/VS3100) */
412 #define		WSDISPLAY_TYPE_LCG	20	/* DEC LCG (VS4000) */
413 #define		WSDISPLAY_TYPE_VAX_MONO	21	/* DEC VS2K/VS3100 mono */
414 #define		WSDISPLAY_TYPE_SB_P9100	22	/* Tadpole SPARCbook P9100 */
415 #define		WSDISPLAY_TYPE_EGA	23	/* (generic) EGA */
416 #define		WSDISPLAY_TYPE_DCPVR	24	/* Dreamcast PowerVR */
417 #define		WSDISPLAY_TYPE_SUN24	25	/* Sun 24 bit framebuffers */
418 #define		WSDISPLAY_TYPE_SUNBW	26	/* Sun black and white fb */
419 #define		WSDISPLAY_TYPE_STI	27	/* HP STI framebuffers */
420 #define		WSDISPLAY_TYPE_SUNCG3	28	/* Sun cgthree */
421 #define		WSDISPLAY_TYPE_SUNCG6	29	/* Sun cgsix */
422 #define		WSDISPLAY_TYPE_SUNFFB	30	/* Sun creator FFB */
423 #define		WSDISPLAY_TYPE_SUNCG14	31	/* Sun cgfourteen */
424 #define		WSDISPLAY_TYPE_SUNCG2	32	/* Sun cgtwo */
425 #define		WSDISPLAY_TYPE_SUNCG4	33	/* Sun cgfour */
426 #define		WSDISPLAY_TYPE_SUNCG8	34	/* Sun cgeight */
427 #define		WSDISPLAY_TYPE_SUNTCX	35	/* Sun TCX */
428 #define		WSDISPLAY_TYPE_AGTEN	36	/* AG10E */
429 #define		WSDISPLAY_TYPE_XVIDEO	37	/* Xvideo */
430 #define		WSDISPLAY_TYPE_SUNCG12	38	/* Sun cgtwelve */
431 #define		WSDISPLAY_TYPE_MGX	39	/* SMS MGX */
432 #define		WSDISPLAY_TYPE_SB_P9000	40	/* Tadpole SPARCbook P9000 */
433 #define		WSDISPLAY_TYPE_RFLEX	41	/* RasterFlex series */
434 #define		WSDISPLAY_TYPE_LUNA	42	/* OMRON Luna */
435 #define		WSDISPLAY_TYPE_DVBOX	43	/* HP DaVinci */
436 #define		WSDISPLAY_TYPE_GBOX	44	/* HP Gatorbox */
437 #define		WSDISPLAY_TYPE_RBOX	45	/* HP Renaissance */
438 #define		WSDISPLAY_TYPE_HYPERION	46	/* HP Hyperion */
439 #define		WSDISPLAY_TYPE_TOPCAT	47	/* HP Topcat */
440 #define		WSDISPLAY_TYPE_PXALCD	48	/* PXALCD (Zaurus) */
441 #define		WSDISPLAY_TYPE_MAC68K	49	/* Generic mac68k framebuffer */
442 #define		WSDISPLAY_TYPE_SUNLEO	50	/* Sun ZX/Leo */
443 #define		WSDISPLAY_TYPE_TVRX	51	/* HP TurboVRX */
444 #define		WSDISPLAY_TYPE_CFXGA	52	/* CF VoyagerVGA */
445 #define		WSDISPLAY_TYPE_LCSPX	53	/* DEC LCSPX (VS4000) */
446 #define		WSDISPLAY_TYPE_GBE	54	/* SGI GBE frame buffer */
447 #define		WSDISPLAY_TYPE_LEGSS	55	/* DEC LEGSS (VS35x0) */
448 #define		WSDISPLAY_TYPE_IFB	56	/* Sun Expert3D{,-Lite} */
449 #define		WSDISPLAY_TYPE_RAPTOR	57	/* Tech Source Raptor */
450 #define		WSDISPLAY_TYPE_DL	58	/* DisplayLink DL-120/DL-160 */
451 #define		WSDISPLAY_TYPE_MACHFB	59	/* Sun PGX/PGX64 */
452 #define		WSDISPLAY_TYPE_GFXP	60	/* Sun PGX32 */
453 #define		WSDISPLAY_TYPE_RADEONFB	61	/* Sun XVR-100 */
454 #define		WSDISPLAY_TYPE_SMFB	62	/* SiliconMotion SM712 */
455 #define		WSDISPLAY_TYPE_SISFB	63	/* SiS 315 Pro */
456 #define		WSDISPLAY_TYPE_ODYSSEY	64	/* SGI Odyssey */
457 #define		WSDISPLAY_TYPE_IMPACT	65	/* SGI Impact */
458 #define		WSDISPLAY_TYPE_GRTWO	66	/* SGI GR2 */
459 #define		WSDISPLAY_TYPE_NEWPORT	67	/* SGI Newport */
460 #define		WSDISPLAY_TYPE_LIGHT	68	/* SGI Light */
461 #define		WSDISPLAY_TYPE_INTELDRM	69	/* Intel KMS framebuffer */
462 #define		WSDISPLAY_TYPE_RADEONDRM 70	/* ATI Radeon KMS framebuffer */
463 #define		WSDISPLAY_TYPE_EFIFB	71	/* EFI framebuffer */
464 #define		WSDISPLAY_TYPE_KMS	72	/* Generic KMS framebuffer */
465 #define		WSDISPLAY_TYPE_ASTFB	73	/* AST framebuffer */
466 #define		WSDISPLAY_TYPE_VIOGPU	74	/* VirtIO GPU */
467 
468 /* Basic display information.  Not applicable to all display types. */
469 struct wsdisplay_fbinfo {
470 	u_int	height;				/* height in pixels */
471 	u_int	width;				/* width in pixels */
472 	u_int	depth;				/* bits per pixel */
473 	u_int	stride;				/* bytes per line */
474 	u_int	offset;				/* first pixel offset (bytes) */
475 	u_int	cmsize;				/* color map size (entries) */
476 };
477 #define	WSDISPLAYIO_GINFO	_IOR('W', 65, struct wsdisplay_fbinfo)
478 
479 /* Colormap operations.  Not applicable to all display types. */
480 struct wsdisplay_cmap {
481 	u_int	index;				/* first element (0 origin) */
482 	u_int	count;				/* number of elements */
483 	u_char	*red;				/* red color map elements */
484 	u_char	*green;				/* green color map elements */
485 	u_char	*blue;				/* blue color map elements */
486 };
487 #define WSDISPLAYIO_GETCMAP	_IOW('W', 66, struct wsdisplay_cmap)
488 #define WSDISPLAYIO_PUTCMAP	_IOW('W', 67, struct wsdisplay_cmap)
489 
490 /* Video control.  Not applicable to all display types. */
491 #define	WSDISPLAYIO_GVIDEO	_IOR('W', 68, u_int)
492 #define	WSDISPLAYIO_SVIDEO	_IOW('W', 69, u_int)
493 #define		WSDISPLAYIO_VIDEO_OFF	0	/* video off */
494 #define		WSDISPLAYIO_VIDEO_ON	1	/* video on */
495 
496 /* Cursor control.  Not applicable to all display types. */
497 struct wsdisplay_curpos {			/* cursor "position" */
498 	u_int x, y;
499 };
500 
501 struct wsdisplay_cursor {
502 	u_int	which;				/* values to get/set */
503 	u_int	enable;				/* enable/disable */
504 	struct wsdisplay_curpos pos;		/* position */
505 	struct wsdisplay_curpos hot;		/* hot spot */
506 	struct wsdisplay_cmap cmap;		/* color map info */
507 	struct wsdisplay_curpos size;		/* bit map size */
508 	u_char *image;				/* image data */
509 	u_char *mask;				/* mask data */
510 };
511 #define		WSDISPLAY_CURSOR_DOCUR		0x01	/* get/set enable */
512 #define		WSDISPLAY_CURSOR_DOPOS		0x02	/* get/set pos */
513 #define		WSDISPLAY_CURSOR_DOHOT		0x04	/* get/set hot spot */
514 #define		WSDISPLAY_CURSOR_DOCMAP		0x08	/* get/set cmap */
515 #define		WSDISPLAY_CURSOR_DOSHAPE	0x10	/* get/set img/mask */
516 #define		WSDISPLAY_CURSOR_DOALL		0x1f	/* all of the above */
517 
518 /* Cursor control: get and set position */
519 #define	WSDISPLAYIO_GCURPOS	_IOR('W', 70, struct wsdisplay_curpos)
520 #define	WSDISPLAYIO_SCURPOS	_IOW('W', 71, struct wsdisplay_curpos)
521 
522 /* Cursor control: get maximum size */
523 #define	WSDISPLAYIO_GCURMAX	_IOR('W', 72, struct wsdisplay_curpos)
524 
525 /* Cursor control: get/set cursor attributes/shape */
526 #define	WSDISPLAYIO_GCURSOR	_IOWR('W', 73, struct wsdisplay_cursor)
527 #define	WSDISPLAYIO_SCURSOR	_IOW('W', 74, struct wsdisplay_cursor)
528 
529 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */
530 #define	WSDISPLAYIO_GMODE	_IOR('W', 75, u_int)
531 #define	WSDISPLAYIO_SMODE	_IOW('W', 76, u_int)
532 #define		WSDISPLAYIO_MODE_EMUL	0	/* emulation (text) mode */
533 #define		WSDISPLAYIO_MODE_MAPPED	1	/* mapped (graphics) mode */
534 #define		WSDISPLAYIO_MODE_DUMBFB	2	/* mapped (graphics) fb mode */
535 
536 struct wsdisplay_font {
537 	char name[WSFONT_NAME_SIZE];
538 	int index;
539 #define WSDISPLAY_MAXFONTCOUNT	8
540 	int firstchar, numchars;
541 	int encoding;
542 #define WSDISPLAY_FONTENC_ISO 0
543 #define WSDISPLAY_FONTENC_IBM 1
544 	u_int fontwidth, fontheight, stride;
545 #define WSDISPLAY_MAXFONTSZ	(512*1024)
546 	int bitorder, byteorder;
547 #define	WSDISPLAY_FONTORDER_KNOWN	0	/* i.e, no need to convert */
548 #define	WSDISPLAY_FONTORDER_L2R		1
549 #define	WSDISPLAY_FONTORDER_R2L		2
550 	void *cookie;
551 	void *data;
552 };
553 #define WSDISPLAYIO_LDFONT	_IOW ('W', 77, struct wsdisplay_font)
554 #define	WSDISPLAYIO_LSFONT	_IOWR('W', 78, struct wsdisplay_font)
555 #define	WSDISPLAYIO_DELFONT	_IOW ('W', 79, struct wsdisplay_font)
556 #define WSDISPLAYIO_USEFONT	_IOW ('W', 80, struct wsdisplay_font)
557 
558 struct wsdisplay_burner {
559 	u_int	off;
560 	u_int	on;
561 	u_int	flags;
562 #define	WSDISPLAY_BURN_VBLANK	0x0001
563 #define	WSDISPLAY_BURN_KBD	0x0002
564 #define	WSDISPLAY_BURN_MOUSE	0x0004
565 #define	WSDISPLAY_BURN_OUTPUT	0x0008
566 };
567 #define	WSDISPLAYIO_SBURNER	_IOW('W', 81, struct wsdisplay_burner)
568 #define	WSDISPLAYIO_GBURNER	_IOR('W', 82, struct wsdisplay_burner)
569 
570 /*
571  * XXX WARNING
572  * XXX The following definitions are very preliminary and are likely
573  * XXX to be changed without care about backwards compatibility!
574  */
575 struct wsdisplay_addscreendata {
576 	int idx; /* screen index */
577 	char screentype[WSSCREEN_NAME_SIZE];
578 	char emul[WSEMUL_NAME_SIZE];
579 };
580 #define WSDISPLAYIO_ADDSCREEN	_IOW('W', 83, struct wsdisplay_addscreendata)
581 
582 struct wsdisplay_delscreendata {
583 	int idx; /* screen index */
584 	int flags;
585 #define	WSDISPLAY_DELSCR_FORCE	0x01
586 #define	WSDISPLAY_DELSCR_QUIET	0x02
587 };
588 #define WSDISPLAYIO_DELSCREEN	_IOW('W', 84, struct wsdisplay_delscreendata)
589 
590 #define WSDISPLAYIO_GETSCREEN	_IOWR('W', 85, struct wsdisplay_addscreendata)
591 #define	WSDISPLAYIO_SETSCREEN	_IOW('W', 86, u_int)
592 
593 /* Display information: number of bytes per row, may be same as pixels */
594 #define	WSDISPLAYIO_LINEBYTES	_IOR('W', 95, u_int)
595 
596 /* Mouse console support */
597 #define WSDISPLAYIO_WSMOUSED	_IOW('W', 88, struct wscons_event)
598 
599 /* Misc control.  Not applicable to all display types. */
600 struct wsdisplay_param {
601         int param;
602 #define	WSDISPLAYIO_PARAM_BACKLIGHT	1
603 #define	WSDISPLAYIO_PARAM_BRIGHTNESS	2
604 #define	WSDISPLAYIO_PARAM_CONTRAST	3
605         int min, max, curval;
606         int reserved[4];
607 };
608 #define	WSDISPLAYIO_GETPARAM	_IOWR('W', 89, struct wsdisplay_param)
609 #define	WSDISPLAYIO_SETPARAM	_IOWR('W', 90, struct wsdisplay_param)
610 
611 #define WSDISPLAYIO_GPCIID	_IOR('W', 91, struct pcisel)
612 
613 /* graphical mode control */
614 
615 #define WSDISPLAYIO_DEPTH_1		0x1
616 #define WSDISPLAYIO_DEPTH_4		0x2
617 #define WSDISPLAYIO_DEPTH_8		0x4
618 #define WSDISPLAYIO_DEPTH_15		0x8
619 #define WSDISPLAYIO_DEPTH_16		0x10
620 #define WSDISPLAYIO_DEPTH_24_24		0x20
621 #define WSDISPLAYIO_DEPTH_24_32		0x40
622 #define WSDISPLAYIO_DEPTH_24 (WSDISPLAYIO_DEPTH_24_24|WSDISPLAYIO_DEPTH_24_32)
623 #define WSDISPLAYIO_DEPTH_30		0x80
624 
625 #define WSDISPLAYIO_GETSUPPORTEDDEPTH	_IOR('W', 92, unsigned int)
626 
627 struct wsdisplay_gfx_mode {
628 	int width;
629 	int height;
630 	int depth;
631 };
632 
633 #define WSDISPLAYIO_SETGFXMODE	_IOW('W', 92, struct wsdisplay_gfx_mode)
634 
635 struct wsdisplay_screentype {
636 	int idx;
637 	int nidx;
638 	char name[WSSCREEN_NAME_SIZE];
639 	int ncols, nrows;
640 	int fontwidth, fontheight;
641 };
642 
643 #define	WSDISPLAYIO_GETSCREENTYPE	_IOWR('W', 93, struct wsdisplay_screentype)
644 
645 struct wsdisplay_emultype {
646 	int idx;
647 	char name[WSSCREEN_NAME_SIZE];
648 };
649 
650 #define	WSDISPLAYIO_GETEMULTYPE	_IOWR('W', 94, struct wsdisplay_emultype)
651 
652 /* XXX NOT YET DEFINED */
653 /* Mapping information retrieval. */
654 
655 /*
656  * Mux ioctls (96 - 127)
657  */
658 
659 #define WSMUXIO_INJECTEVENT	_IOW('W', 96, struct wscons_event)
660 
661 struct wsmux_device {
662 	int type;
663 #define WSMUX_MOUSE	1
664 #define WSMUX_KBD	2
665 #define WSMUX_MUX	3
666 	int idx;
667 };
668 #define WSMUXIO_ADD_DEVICE	_IOW('W', 97, struct wsmux_device)
669 #define WSMUXIO_REMOVE_DEVICE	_IOW('W', 98, struct wsmux_device)
670 
671 #define WSMUX_MAXDEV 32
672 struct wsmux_device_list {
673 	int ndevices;
674 	struct wsmux_device devices[WSMUX_MAXDEV];
675 };
676 #define WSMUXIO_LIST_DEVICES	_IOWR('W', 99, struct wsmux_device_list)
677 
678 #endif /* _DEV_WSCONS_WSCONSIO_H_ */
679