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