Home | History | Annotate | Line # | Download | only in wscons
wsconsio.h revision 1.3 
      1 /* $NetBSD: wsconsio.h,v 1.3 1998/06/11 22:15:14 drochner 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-255	reserved for future use
     44  */
     45 
     46 #include <sys/types.h>
     47 #include <sys/ioccom.h>
     48 #include <dev/wscons/wsksymvar.h>
     49 
     50 
     51 /*
     52  * Common event structure (used by keyboard and mouse)
     53  */
     54 struct wscons_event {
     55 	u_int		type;
     56 	int		value;
     57 	struct timespec	time;
     58 };
     59 
     60 /* Event type definitions.  Comment for each is information in value. */
     61 #define	WSCONS_EVENT_KEY_UP		1	/* key code */
     62 #define	WSCONS_EVENT_KEY_DOWN		2	/* key code */
     63 #define	WSCONS_EVENT_KEY_OTHER		3	/* key code */
     64 #define	WSCONS_EVENT_MOUSE_UP		4	/* button # (leftmost = 0) */
     65 #define	WSCONS_EVENT_MOUSE_DOWN		5	/* button # (leftmost = 0)  */
     66 #define	WSCONS_EVENT_MOUSE_DELTA_X	6	/* X delta amount */
     67 #define	WSCONS_EVENT_MOUSE_DELTA_Y	7	/* Y delta amount */
     68 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_X	8	/* X location */
     69 #define	WSCONS_EVENT_MOUSE_ABSOLUTE_Y	9	/* Y location */
     70 
     71 
     72 /*
     73  * Keyboard ioctls (0 - 31)
     74  */
     75 
     76 /* Get keyboard type. */
     77 #define	WSKBDIO_GTYPE		_IOR('W', 0, u_int)
     78 #define		WSKBD_TYPE_LK201	1	/* lk-201 */
     79 #define		WSKBD_TYPE_LK401	2	/* lk-401 */
     80 #define		WSKBD_TYPE_PC_XT	3	/* PC-ish, XT scancode */
     81 #define		WSKBD_TYPE_PC_AT	4	/* PC-ish, AT scancode */
     82 
     83 /* Manipulate the keyboard bell. */
     84 struct wskbd_bell_data {
     85 	u_int	which;				/* values to get/set */
     86 	u_int	pitch;				/* pitch, in Hz */
     87 	u_int	period;				/* period, in milliseconds */
     88 	u_int	volume;				/* percentage of max volume */
     89 };
     90 #define		WSKBD_BELL_DOPITCH	0x1		/* get/set pitch */
     91 #define		WSKBD_BELL_DOPERIOD	0x2		/* get/set period */
     92 #define		WSKBD_BELL_DOVOLUME	0x4		/* get/set volume */
     93 #define		WSKBD_BELL_DOALL	0x7		/* all of the above */
     94 
     95 #define	WSKBDIO_BELL		_IO('W', 1)
     96 #define	WSKBDIO_COMPLEXBELL	_IOW('W', 2, struct wskbd_bell_data)
     97 #define	WSKBDIO_SETBELL		_IOW('W', 3, struct wskbd_bell_data)
     98 #define	WSKBDIO_GETBELL		_IOR('W', 4, struct wskbd_bell_data)
     99 #define	WSKBDIO_SETDEFAULTBELL	_IOW('W', 5, struct wskbd_bell_data)
    100 #define	WSKBDIO_GETDEFAULTBELL	_IOR('W', 6, struct wskbd_bell_data)
    101 
    102 /* Manipulate the emulation key repeat settings. */
    103 struct wskbd_keyrepeat_data {
    104 	u_int	which;				/* values to get/set */
    105 	u_int	del1;				/* delay before first, ms */
    106 	u_int	delN;				/* delay before rest, ms */
    107 };
    108 #define		WSKBD_KEYREPEAT_DODEL1	0x1		/* get/set del1 */
    109 #define		WSKBD_KEYREPEAT_DODELN	0x2		/* get/set delN */
    110 #define		WSKBD_KEYREPEAT_DOALL	0x3		/* all of the above */
    111 
    112 #define	WSKBDIO_SETKEYREPEAT	_IOW('W', 7, struct wskbd_keyrepeat_data)
    113 #define	WSKBDIO_GETKEYREPEAT	_IOR('W', 8, struct wskbd_keyrepeat_data)
    114 #define	WSKBDIO_SETDEFAULTKEYREPEAT \
    115 	    _IOW('W', 9, struct wskbd_keyrepeat_data)
    116 #define	WSKBDIO_GETDEFAULTKEYREPEAT \
    117 	    _IOR('W', 10, struct wskbd_keyrepeat_data)
    118 
    119 /* Get/set keyboard leds */
    120 #define		WSKBD_LED_CAPS		0x01
    121 #define		WSKBD_LED_NUM		0x02
    122 #define		WSKBD_LED_SCROLL	0x04
    123 #define		WSKBD_LED_COMPOSE	0x08
    124 
    125 #define	WSKBDIO_SETLEDS		_IOR('W', 11, int)
    126 #define	WSKBDIO_GETLEDS		_IOW('W', 12, int)
    127 
    128 /* Manipulate keysym groups. */
    129 struct wskbd_map_data {
    130 	u_int	maplen;				/* number of entries in map */
    131 	struct wscons_keymap *map;		/* map to get or set */
    132 };
    133 #define WSKBDIO_GETMAP		_IOWR('W', 13, struct wskbd_map_data)
    134 #define WSKBDIO_SETMAP		_IOW('W', 14, struct wskbd_map_data)
    135 #define WSKBDIO_GETENCODING	_IOR('W', 15, int)
    136 #define WSKBDIO_SETENCODING	_IOW('W', 16, int)
    137 
    138 /* Manipulate strings of function keys */
    139 struct wskbd_string_data {
    140 	u_int	keycode;			/* keycode to change */
    141 	char	value[WSKBD_STRING_LEN];	/* string data */
    142 };
    143 #define WSKBDIO_GETSTRING	_IOR('W', 17, struct wskbd_string_data)
    144 #define WSKBDIO_SETSTRING	_IOW('W', 18, struct wskbd_string_data)
    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 keyboard type */
    157 #define	WSMOUSEIO_GTYPE		_IOR('W', 32, u_int)
    158 #define		WSMOUSE_TYPE_VSXXX	1	/* DEC TC(?) serial */
    159 #define		WSMOUSE_TYPE_PS2	2	/* PS/2-compatible */
    160 
    161 /*
    162  * Display ioctls (64 - 95)
    163  */
    164 
    165 /* Get display type */
    166 #define	WSDISPLAYIO_GTYPE	_IOR('W', 64, u_int)
    167 #define		WSDISPLAY_TYPE_PM_MONO	1	/* ??? */
    168 #define		WSDISPLAY_TYPE_PM_COLOR	2	/* ??? */
    169 #define		WSDISPLAY_TYPE_CFB	3	/* DEC TC CFB */
    170 #define		WSDISPLAY_TYPE_XCFB	4	/* ??? */
    171 #define		WSDISPLAY_TYPE_MFB	5	/* DEC TC MFB */
    172 #define		WSDISPLAY_TYPE_SFB	6	/* DEC TC SFB */
    173 #define		WSDISPLAY_TYPE_ISAVGA	7	/* (generic) ISA VGA */
    174 #define		WSDISPLAY_TYPE_PCIVGA	8	/* (generic) PCI VGA */
    175 #define		WSDISPLAY_TYPE_TGA	9	/* DEC PCI TGA */
    176 #define		WSDISPLAY_TYPE_SFBP	10	/* DEC TC SFB+ */
    177 #define		WSDISPLAY_TYPE_PCIMISC	11	/* (generic) PCI misc. disp. */
    178 
    179 /* Basic display information.  Not applicable to all display types. */
    180 struct wsdisplay_fbinfo {
    181 	u_int	height;				/* height in pixels */
    182 	u_int	width;				/* width in pixels */
    183 	u_int	depth;				/* bits per pixel */
    184 	u_int	cmsize;				/* color map size (entries) */
    185 };
    186 #define	WSDISPLAYIO_GINFO	_IOR('W', 65, struct wsdisplay_fbinfo)
    187 
    188 /* Colormap operations.  Not applicable to all display types. */
    189 struct wsdisplay_cmap {
    190 	u_int	index;				/* first element (0 origin) */
    191 	u_int	count;				/* number of elements */
    192 	u_char	*red;				/* red color map elements */
    193 	u_char	*green;				/* green color map elements */
    194 	u_char	*blue;				/* blue color map elements */
    195 };
    196 #define WSDISPLAYIO_GETCMAP	_IOW('W', 66, struct wsdisplay_cmap)
    197 #define WSDISPLAYIO_PUTCMAP	_IOW('W', 67, struct wsdisplay_cmap)
    198 
    199 /* Video control.  Not applicable to all display types. */
    200 #define	WSDISPLAYIO_GVIDEO	_IOR('W', 68, u_int)
    201 #define	WSDISPLAYIO_SVIDEO	_IOW('W', 69, u_int)
    202 #define		WSDISPLAYIO_VIDEO_OFF	0	/* video off */
    203 #define		WSDISPLAYIO_VIDEO_ON	1	/* video on */
    204 
    205 /* Cursor control.  Not applicable to all display types. */
    206 struct wsdisplay_curpos {			/* cursor "position" */
    207 	u_int x, y;
    208 };
    209 
    210 struct wsdisplay_cursor {
    211 	u_int	which;				/* values to get/set */
    212 	u_int	enable;				/* enable/disable */
    213 	struct wsdisplay_curpos pos;		/* position */
    214 	struct wsdisplay_curpos hot;		/* hot spot */
    215 	struct wsdisplay_cmap cmap;		/* color map info */
    216 	struct wsdisplay_curpos size;		/* bit map size */
    217 	u_char *image;				/* image data */
    218 	u_char *mask;				/* mask data */
    219 };
    220 #define		WSDISPLAY_CURSOR_DOCUR		0x01	/* get/set enable */
    221 #define		WSDISPLAY_CURSOR_DOPOS		0x02	/* get/set pos */
    222 #define		WSDISPLAY_CURSOR_DOHOT		0x04	/* get/set hot spot */
    223 #define		WSDISPLAY_CURSOR_DOCMAP		0x08	/* get/set cmap */
    224 #define		WSDISPLAY_CURSOR_DOSHAPE	0x10	/* get/set img/mask */
    225 #define		WSDISPLAY_CURSOR_DOALL		0x1f	/* all of the above */
    226 
    227 /* Cursor control: get and set position */
    228 #define	WSDISPLAYIO_GCURPOS	_IOR('W', 70, struct wsdisplay_curpos)
    229 #define	WSDISPLAYIO_SCURPOS	_IOW('W', 71, struct wsdisplay_curpos)
    230 
    231 /* Cursor control: get maximum size */
    232 #define	WSDISPLAYIO_GCURMAX	_IOR('W', 72, struct wsdisplay_curpos)
    233 
    234 /* Cursor control: get/set cursor attributes/shape */
    235 #define	WSDISPLAYIO_GCURSOR	_IOWR('W', 73, struct wsdisplay_cursor)
    236 #define	WSDISPLAYIO_SCURSOR	_IOW('W', 74, struct wsdisplay_cursor)
    237 
    238 /* Display mode: Emulation (text) vs. Mapped (graphics) mode */
    239 #define	WSDISPLAYIO_GMODE	_IOR('W', 75, u_int)
    240 #define	WSDISPLAYIO_SMODE	_IOW('W', 76, u_int)
    241 #define		WSDISPLAYIO_MODE_EMUL	0	/* emulation (text) mode */
    242 #define		WSDISPLAYIO_MODE_MAPPED	1	/* mapped (graphics) mode */
    243 
    244 struct wsdisplay_font {
    245 	int firstchar, numchars;
    246 	int fontwidth, fontheight, stride;
    247 	void *data;
    248 };
    249 #define WSDISPLAYIO_SFONT	_IOW('W', 77, struct wsdisplay_font)
    250 
    251 /* XXX NOT YET DEFINED */
    252 /* Mapping information retrieval. */
    253 
    254 #endif /* _DEV_WSCONS_WSCONSIO_H_ */
    255