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