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