xref: /openbsd/sys/dev/wscons/wskbdvar.h (revision 133306f0)
1 /* $OpenBSD: wskbdvar.h,v 1.1 2000/05/16 23:49:12 mickey Exp $ */
2 /* $NetBSD: wskbdvar.h,v 1.8 1999/12/01 23:22:59 augustss 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 /*
35  * WSKBD interfaces.
36  */
37 
38 /*
39  * Keyboard access functions (must be provided by all keyboards).
40  *
41  * There is a "void *" cookie provided by the keyboard driver associated
42  * with these functions, which is passed to them when they are invoked.
43  */
44 struct wskbd_accessops {
45 	int	(*enable) __P((void *, int));
46 	void    (*set_leds) __P((void *, int));
47 	int     (*ioctl) __P((void *v, u_long cmd, caddr_t data, int flag,
48 			      struct proc *p));
49 };
50 
51 /*
52  * Keyboard console functions (must be provided by console input keyboards).
53  *
54  * There is a "void *" cookie provided by the keyboard driver associated
55  * with these functions, which is passed to them when they are invoked.
56  */
57 struct wskbd_consops {
58 	void    (*getc) __P((void *, u_int *, int *));
59 	void    (*pollc) __P((void *, int));
60 	void	(*bell) __P((void *, u_int, u_int, u_int));
61 };
62 
63 /*
64  * Attachment information provided by wskbddev devices when attaching
65  * wskbd units.
66  */
67 struct wskbddev_attach_args {
68 	int	console;				/* is it console? */
69 	const struct wskbd_mapdata *keymap;
70 
71 	const struct wskbd_accessops *accessops;        /* access ops */
72 	void	*accesscookie;				/* access cookie */
73 };
74 
75 #define	WSKBDDEVCF_CONSOLE	0
76 #define	wskbddevcf_console	cf_loc[WSKBDDEVCF_CONSOLE]	/* spec'd as console? */
77 #define	WSKBDDEVCF_CONSOLE_UNK	-1
78 
79 #define	WSKBDDEVCF_MUX		1
80 #define	wskbddevcf_mux		cf_loc[WSKBDDEVCF_MUX]
81 
82 /*
83  * Autoconfiguration helper functions.
84  */
85 void	wskbd_cnattach __P((const struct wskbd_consops *, void *,
86 			    const struct wskbd_mapdata *));
87 void	wskbd_cndetach __P((void));
88 int	wskbddevprint __P((void *, const char *));
89 
90 /*
91  * Callbacks from the keyboard driver to the wskbd interface driver.
92  */
93 void	wskbd_input __P((struct device *kbddev, u_int type, int value));
94 /* for WSDISPLAY_COMPAT_RAWKBD */
95 void	wskbd_rawinput __P((struct device *, u_char *, int));
96 
97 /*
98  * Console interface.
99  */
100 int	wskbd_cngetc __P((dev_t dev));
101 void	wskbd_cnpollc __P((dev_t dev, int poll));
102 void	wskbd_cnbell __P((dev_t, u_int, u_int, u_int));
103