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