xref: /openbsd/sys/dev/wscons/wskbdvar.h (revision 7d7b0e49)
1 /* $OpenBSD: wskbdvar.h,v 1.4 2022/02/16 06:23:42 anton 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)(void *, int);
46 	void    (*set_leds)(void *, int);
47 	int     (*ioctl)(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)(void *, u_int *, int *);
59 	void    (*pollc)(void *, int);
60 	void	(*bell)(void *, u_int, u_int, u_int);
61 	void	(*debugger)(void *);
62 };
63 
64 /*
65  * Attachment information provided by wskbddev devices when attaching
66  * wskbd units.
67  */
68 struct wskbddev_attach_args {
69 	int	console;				/* is it console? */
70 	const struct wskbd_mapdata *keymap;
71 
72 	const struct wskbd_accessops *accessops;        /* access ops */
73 	void	*accesscookie;				/* access cookie */
74 
75 	void	*audiocookie;
76 };
77 
78 #define	WSKBDDEVCF_CONSOLE	0
79 #define	wskbddevcf_console	cf_loc[WSKBDDEVCF_CONSOLE]	/* spec'd as console? */
80 #define	WSKBDDEVCF_CONSOLE_UNK	-1
81 
82 #define	WSKBDDEVCF_MUX		1
83 #define	wskbddevcf_mux		cf_loc[WSKBDDEVCF_MUX]
84 
85 /*
86  * Autoconfiguration helper functions.
87  */
88 void	wskbd_cnattach(const struct wskbd_consops *, void *,
89 			    const struct wskbd_mapdata *);
90 void	wskbd_cndetach(void);
91 int	wskbddevprint(void *, const char *);
92 
93 /*
94  * Callbacks from the keyboard driver to the wskbd interface driver.
95  */
96 void	wskbd_input(struct device *kbddev, u_int type, int value);
97 /* for WSDISPLAY_COMPAT_RAWKBD */
98 void	wskbd_rawinput(struct device *, u_char *, int);
99 
100 /*
101  * Console interface.
102  */
103 int	wskbd_cngetc(dev_t dev);
104 void	wskbd_cnpollc(dev_t dev, int poll);
105 void	wskbd_cnbell(dev_t, u_int, u_int, u_int);
106