wsconsio.h revision 1.4 
1/* $OpenBSD: wsconsio.h,v 1.4 2001/02/05 23:39:01 matthieu 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
52/*
53 * Common event structure (used by keyboard and mouse)
54 */
55struct wscons_event {
56	u_int		type;
57	int		value;
58	struct timespec	time;
59};
60
61/* Event type definitions.  Comment for each is information in value. */
62#define	WSCONS_EVENT_KEY_UP		1	/* key code */
63#define	WSCONS_EVENT_KEY_DOWN		2	/* key code */
64#define	WSCONS_EVENT_ALL_KEYS_UP	3	/* void */
65#define	WSCONS_EVENT_MOUSE_UP		4	/* button # (leftmost = 0) */
66#define	WSCONS_EVENT_MOUSE_DOWN		5	/* button # (leftmost = 0)  */
67#define	WSCONS_EVENT_MOUSE_DELTA_X	6	/* X delta amount */
68#define	WSCONS_EVENT_MOUSE_DELTA_Y	7	/* Y delta amount */
69#define	WSCONS_EVENT_MOUSE_ABSOLUTE_X	8	/* X location */
70#define	WSCONS_EVENT_MOUSE_ABSOLUTE_Y	9	/* Y location */
71#define	WSCONS_EVENT_MOUSE_DELTA_Z	10	/* Z delta amount */
72#define	WSCONS_EVENT_MOUSE_ABSOLUTE_Z	11	/* Z location */
73
74
75/*
76 * Keyboard ioctls (0 - 31)
77 */
78
79/* Get keyboard type. */
80#define	WSKBDIO_GTYPE		_IOR('W', 0, u_int)
81#define		WSKBD_TYPE_LK201	1	/* lk-201 */
82#define		WSKBD_TYPE_LK401	2	/* lk-401 */
83#define		WSKBD_TYPE_PC_XT	3	/* PC-ish, XT scancode */
84#define		WSKBD_TYPE_PC_AT	4	/* PC-ish, AT scancode */
85#define		WSKBD_TYPE_USB		5	/* USB, XT scancode */
86#define		WSKBD_TYPE_NEXT		6	/* NeXT keyboard */
87#define		WSKBD_TYPE_HPC_KBD	7	/* HPC bultin keyboard */
88#define		WSKBD_TYPE_HPC_BTN	8	/* HPC/PsPC buttons */
89#define		WSKBD_TYPE_ARCHIMEDES	9	/* Archimedes keyboard */
90
91/* Manipulate the keyboard bell. */
92struct wskbd_bell_data {
93	u_int	which;				/* values to get/set */
94	u_int	pitch;				/* pitch, in Hz */
95	u_int	period;				/* period, in milliseconds */
96	u_int	volume;				/* percentage of max volume */
97};
98#define		WSKBD_BELL_DOPITCH	0x1		/* get/set pitch */
99#define		WSKBD_BELL_DOPERIOD	0x2		/* get/set period */
100#define		WSKBD_BELL_DOVOLUME	0x4		/* get/set volume */
101#define		WSKBD_BELL_DOALL	0x7		/* all of the above */
102
103#define	WSKBDIO_BELL		_IO('W', 1)
104#define	WSKBDIO_COMPLEXBELL	_IOW('W', 2, struct wskbd_bell_data)
105#define	WSKBDIO_SETBELL		_IOW('W', 3, struct wskbd_bell_data)
106#define	WSKBDIO_GETBELL		_IOR('W', 4, struct wskbd_bell_data)
107#define	WSKBDIO_SETDEFAULTBELL	_IOW('W', 5, struct wskbd_bell_data)
108#define	WSKBDIO_GETDEFAULTBELL	_IOR('W', 6, struct wskbd_bell_data)
109
110/* Manipulate the emulation key repeat settings. */
111struct wskbd_keyrepeat_data {
112	u_int	which;				/* values to get/set */
113	u_int	del1;				/* delay before first, ms */
114	u_int	delN;				/* delay before rest, ms */
115};
116#define		WSKBD_KEYREPEAT_DODEL1	0x1		/* get/set del1 */
117#define		WSKBD_KEYREPEAT_DODELN	0x2		/* get/set delN */
118#define		WSKBD_KEYREPEAT_DOALL	0x3		/* all of the above */
119
120#define	WSKBDIO_SETKEYREPEAT	_IOW('W', 7, struct wskbd_keyrepeat_data)
121#define	WSKBDIO_GETKEYREPEAT	_IOR('W', 8, struct wskbd_keyrepeat_data)
122#define	WSKBDIO_SETDEFAULTKEYREPEAT \
123	    _IOW('W', 9, struct wskbd_keyrepeat_data)
124#define	WSKBDIO_GETDEFAULTKEYREPEAT \
125	    _IOR('W', 10, struct wskbd_keyrepeat_data)
126
127/* Get/set keyboard leds */
128#define		WSKBD_LED_CAPS		0x01
129#define		WSKBD_LED_NUM		0x02
130#define		WSKBD_LED_SCROLL	0x04
131#define		WSKBD_LED_COMPOSE	0x08
132
133#define	WSKBDIO_SETLEDS		_IOW('W', 11, int)
134#define	WSKBDIO_GETLEDS		_IOR('W', 12, int)
135
136/* Manipulate keysym groups. */
137struct wskbd_map_data {
138	u_int	maplen;				/* number of entries in map */
139	struct wscons_keymap *map;		/* map to get or set */
140};
141#define WSKBDIO_GETMAP		_IOWR('W', 13, struct wskbd_map_data)
142#define WSKBDIO_SETMAP		_IOW('W', 14, struct wskbd_map_data)
143#define WSKBDIO_GETENCODING	_IOR('W', 15, kbd_t)
144#define WSKBDIO_SETENCODING	_IOW('W', 16, kbd_t)
145
146/* internal use only */
147#define WSKBDIO_SETMODE		_IOW('W', 19, int)
148#define WSKBDIO_GETMODE		_IOR('W', 20, int)
149#define		WSKBD_TRANSLATED	0
150#define		WSKBD_RAW		1
151
152/*
153 * Mouse ioctls (32 - 63)
154 */
155
156/* Get mouse type */
157#define	WSMOUSEIO_GTYPE		_IOR('W', 32, u_int)
158#define		WSMOUSE_TYPE_VSXXX	1	/* DEC serial */
159#define		WSMOUSE_TYPE_PS2	2	/* PS/2-compatible */
160#define		WSMOUSE_TYPE_USB	3	/* USB mouse */
161#define		WSMOUSE_TYPE_LMS	4	/* Logitech busmouse */
162#define		WSMOUSE_TYPE_MMS	5	/* Microsoft InPort mouse */
163#define		WSMOUSE_TYPE_TPANEL	6	/* Generic Touch Panel */
164#define		WSMOUSE_TYPE_NEXT	7	/* NeXT mouse */
165#define		WSMOUSE_TYPE_ARCHIMEDES	8	/* Archimedes mouse */
166
167/* Set resolution.  Not applicable to all mouse types. */
168#define	WSMOUSEIO_SRES		_IOW('W', 33, u_int)
169#define		WSMOUSE_RES_MIN		0
170#define		WSMOUSE_RES_DEFAULT	75
171#define		WSMOUSE_RES_MAX		100
172
173/* Set scale factor (num / den).  Not applicable to all mouse types. */
174#define	WSMOUSEIO_SSCALE	_IOW('W', 34, u_int[2])
175
176/* Set sample rate.  Not applicable to all mouse types. */
177#define	WSMOUSEIO_SRATE		_IOW('W', 35, u_int)
178#define		WSMOUSE_RATE_MIN	0
179#define		WSMOUSE_RATE_DEFAULT	50
180#define		WSMOUSE_RATE_MAX	100
181
182/* Set/get sample coordinates for calibration */
183#define	WSMOUSE_CALIBCOORDS_MAX		16
184#define	WSMOUSE_CALIBCOORDS_RESET	-1
185struct wsmouse_calibcoords {
186	int minx, miny;		/* minimum value of X/Y */
187	int maxx, maxy;		/* maximum value of X/Y */
188	int samplelen;		/* number of samples available or
189				   WSMOUSE_CALIBCOORDS_RESET for raw mode */
190	struct wsmouse_calibcoord {
191		int rawx, rawy;	/* raw coordinate */
192		int x, y;	/* translated coordinate */
193	} samples[WSMOUSE_CALIBCOORDS_MAX];	/* sample coordinates */
194};
195#define	WSMOUSEIO_SCALIBCOORDS	_IOW('W', 36, struct wsmouse_calibcoords)
196#define	WSMOUSEIO_GCALIBCOORDS	_IOR('W', 37, struct wsmouse_calibcoords)
197
198/*
199 * Display ioctls (64 - 95)
200 */
201
202/* Get display type */
203#define	WSDISPLAYIO_GTYPE	_IOR('W', 64, u_int)
204#define		WSDISPLAY_TYPE_UNKNOWN	0	/* unknown */
205#define		WSDISPLAY_TYPE_PM_MONO	1	/* DEC [23]100 mono */
206#define		WSDISPLAY_TYPE_PM_COLOR	2	/* DEC [23]100 color */
207#define		WSDISPLAY_TYPE_CFB	3	/* DEC TC CFB (CX) */
208#define		WSDISPLAY_TYPE_XCFB	4	/* DEC `maxine' onboard fb */
209#define		WSDISPLAY_TYPE_MFB	5	/* DEC TC MFB (MX) */
210#define		WSDISPLAY_TYPE_SFB	6	/* DEC TC SFB (HX) */
211#define		WSDISPLAY_TYPE_ISAVGA	7	/* (generic) ISA VGA */
212#define		WSDISPLAY_TYPE_PCIVGA	8	/* (generic) PCI VGA */
213#define		WSDISPLAY_TYPE_TGA	9	/* DEC PCI TGA */
214#define		WSDISPLAY_TYPE_SFBP	10	/* DEC TC SFB+ (HX+) */
215#define		WSDISPLAY_TYPE_PCIMISC	11	/* (generic) PCI misc. disp. */
216#define		WSDISPLAY_TYPE_NEXTMONO	12	/* NeXT mono display */
217#define		WSDISPLAY_TYPE_PX	13	/* DEC TC PX */
218#define		WSDISPLAY_TYPE_PXG	14	/* DEC TC PXG */
219#define		WSDISPLAY_TYPE_TX	15	/* DEC TC TX */
220#define		WSDISPLAY_TYPE_HPCFB	16	/* Handheld/PalmSize PC */
221#define		WSDISPLAY_TYPE_VIDC	17	/* Acorn/ARM VIDC */
222#define		WSDISPLAY_TYPE_SPX	18	/* DEC SPX (VS3100/VS4000) */
223#define		WSDISPLAY_TYPE_GPX	19	/* DEC GPX (uVAX/VS2K/VS3100 */
224#define		WSDISPLAY_TYPE_LCG	20	/* DEC LCG (VS4000) */
225#define		WSDISPLAY_TYPE_VAX_MONO	21	/* DEC VS2K/VS3100 mono */
226#define		WSDISPLAY_TYPE_SB_P9100	22	/* Tadpole SPARCbook P9100 */
227#define		WSDISPLAY_TYPE_EGA	23	/* (generic) EGA */
228
229/* Basic display information.  Not applicable to all display types. */
230struct wsdisplay_fbinfo {
231	u_int	height;				/* height in pixels */
232	u_int	width;				/* width in pixels */
233	u_int	depth;				/* bits per pixel */
234	u_int	cmsize;				/* color map size (entries) */
235};
236#define	WSDISPLAYIO_GINFO	_IOR('W', 65, struct wsdisplay_fbinfo)
237
238/* Colormap operations.  Not applicable to all display types. */
239struct wsdisplay_cmap {
240	u_int	index;				/* first element (0 origin) */
241	u_int	count;				/* number of elements */
242	u_char	*red;				/* red color map elements */
243	u_char	*green;				/* green color map elements */
244	u_char	*blue;				/* blue color map elements */
245};
246#define WSDISPLAYIO_GETCMAP	_IOW('W', 66, struct wsdisplay_cmap)
247#define WSDISPLAYIO_PUTCMAP	_IOW('W', 67, struct wsdisplay_cmap)
248
249/* Video control.  Not applicable to all display types. */
250#define	WSDISPLAYIO_GVIDEO	_IOR('W', 68, u_int)
251#define	WSDISPLAYIO_SVIDEO	_IOW('W', 69, u_int)
252#define		WSDISPLAYIO_VIDEO_OFF	0	/* video off */
253#define		WSDISPLAYIO_VIDEO_ON	1	/* video on */
254
255/* Cursor control.  Not applicable to all display types. */
256struct wsdisplay_curpos {			/* cursor "position" */
257	u_int x, y;
258};
259
260struct wsdisplay_cursor {
261	u_int	which;				/* values to get/set */
262	u_int	enable;				/* enable/disable */
263	struct wsdisplay_curpos pos;		/* position */
264	struct wsdisplay_curpos hot;		/* hot spot */
265	struct wsdisplay_cmap cmap;		/* color map info */
266	struct wsdisplay_curpos size;		/* bit map size */
267	u_char *image;				/* image data */
268	u_char *mask;				/* mask data */
269};
270#define		WSDISPLAY_CURSOR_DOCUR		0x01	/* get/set enable */
271#define		WSDISPLAY_CURSOR_DOPOS		0x02	/* get/set pos */
272#define		WSDISPLAY_CURSOR_DOHOT		0x04	/* get/set hot spot */
273#define		WSDISPLAY_CURSOR_DOCMAP		0x08	/* get/set cmap */
274#define		WSDISPLAY_CURSOR_DOSHAPE	0x10	/* get/set img/mask */
275#define		WSDISPLAY_CURSOR_DOALL		0x1f	/* all of the above */
276
277/* Cursor control: get and set position */
278#define	WSDISPLAYIO_GCURPOS	_IOR('W', 70, struct wsdisplay_curpos)
279#define	WSDISPLAYIO_SCURPOS	_IOW('W', 71, struct wsdisplay_curpos)
280
281/* Cursor control: get maximum size */
282#define	WSDISPLAYIO_GCURMAX	_IOR('W', 72, struct wsdisplay_curpos)
283
284/* Cursor control: get/set cursor attributes/shape */
285#define	WSDISPLAYIO_GCURSOR	_IOWR('W', 73, struct wsdisplay_cursor)
286#define	WSDISPLAYIO_SCURSOR	_IOW('W', 74, struct wsdisplay_cursor)
287
288/* Display mode: Emulation (text) vs. Mapped (graphics) mode */
289#define	WSDISPLAYIO_GMODE	_IOR('W', 75, u_int)
290#define	WSDISPLAYIO_SMODE	_IOW('W', 76, u_int)
291#define		WSDISPLAYIO_MODE_EMUL	0	/* emulation (text) mode */
292#define		WSDISPLAYIO_MODE_MAPPED	1	/* mapped (graphics) mode */
293
294/*
295 * XXX WARNING
296 * XXX The following definitions are very preliminary and are likely
297 * XXX to be changed without care about backwards compatibility!
298 */
299struct wsdisplay_font {
300	char *name;
301	int firstchar, numchars;
302	int encoding;
303#define WSDISPLAY_FONTENC_ISO 0
304#define WSDISPLAY_FONTENC_IBM 1
305#define WSDISPLAY_FONTENC_PCVT 2
306	int fontwidth, fontheight, stride;
307	int bitorder, byteorder;
308#define	WSDISPLAY_FONTORDER_KNOWN	0	/* i.e, no need to convert */
309#define	WSDISPLAY_FONTORDER_L2R		1
310#define	WSDISPLAY_FONTORDER_R2L		2
311	void *data;
312};
313#define WSDISPLAYIO_LDFONT	_IOW('W', 77, struct wsdisplay_font)
314
315struct wsdisplay_addscreendata {
316	int idx; /* screen index */
317	char *screentype;
318	char *emul;
319};
320#define WSDISPLAYIO_ADDSCREEN _IOW('W', 78, struct wsdisplay_addscreendata)
321
322struct wsdisplay_delscreendata {
323	int idx; /* screen index */
324	int flags;
325#define WSDISPLAY_DELSCR_FORCE 1
326};
327#define WSDISPLAYIO_DELSCREEN _IOW('W', 79, struct wsdisplay_delscreendata)
328
329struct wsdisplay_usefontdata {
330	char *name;
331};
332#define WSDISPLAYIO_USEFONT	_IOW('W', 80, struct wsdisplay_usefontdata)
333
334/* Replaced by WSMUX_{ADD,REMOVE}_DEVICE */
335struct wsdisplay_kbddata {
336	int op;
337#define _O_WSDISPLAY_KBD_ADD 0
338#define _O_WSDISPLAY_KBD_DEL 1
339	int idx;
340};
341#define _O_WSDISPLAYIO_SETKEYBOARD _IOWR('W', 81, struct wsdisplay_kbddata)
342
343/* XXX NOT YET DEFINED */
344/* Mapping information retrieval. */
345
346/* Mux ioctls (96 - 127) */
347#define WSMUX_INJECTEVENT	_IOW('W', 96, struct wscons_event)
348
349struct wsmux_device {
350	int type;
351#define WSMUX_MOUSE	1
352#define WSMUX_KBD	2
353#define WSMUX_MUX	3
354	int idx;
355};
356#define WSMUX_ADD_DEVICE	_IOW('W', 97, struct wsmux_device)
357#define WSMUX_REMOVE_DEVICE	_IOW('W', 98, struct wsmux_device)
358
359#define WSMUX_MAXDEV 32
360struct wsmux_device_list {
361	int ndevices;
362	struct wsmux_device devices[WSMUX_MAXDEV];
363};
364#define WSMUX_LIST_DEVICES	_IOWR('W', 99, struct wsmux_device_list)
365
366#endif /* _DEV_WSCONS_WSCONSIO_H_ */
367