xref: /netbsd/sys/dev/wscons/wskbdvar.h (revision 6550d01e)
1 /* $NetBSD: wskbdvar.h,v 1.17 2010/10/26 05:12:34 jruoho 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 /*
34  * WSKBD interfaces.
35  */
36 
37 /*
38  * Keyboard access functions (must be provided by all keyboards).
39  *
40  * There is a "void *" cookie provided by the keyboard driver associated
41  * with these functions, which is passed to them when they are invoked.
42  */
43 struct wskbd_accessops {
44 	int	(*enable)(void *, int);
45 	void    (*set_leds)(void *, int);
46 	int     (*ioctl)(void *, u_long, void *, int, struct lwp *);
47 };
48 
49 /*
50  * Keyboard console functions (must be provided by console input keyboards).
51  *
52  * There is a "void *" cookie provided by the keyboard driver associated
53  * with these functions, which is passed to them when they are invoked.
54  */
55 struct wskbd_consops {
56 	void    (*getc)(void *, u_int *, int *);
57 	void    (*pollc)(void *, int);
58 	void	(*bell)(void *, u_int, u_int, u_int);
59 };
60 
61 /*
62  * Attachment information provided by wskbddev devices when attaching
63  * wskbd units.
64  */
65 struct wskbddev_attach_args {
66 	int	console;				/* is it console? */
67 	const struct wskbd_mapdata *keymap;
68 
69 	const struct wskbd_accessops *accessops;        /* access ops */
70 	void	*accesscookie;				/* access cookie */
71 };
72 
73 #include "locators.h"
74 
75 #define	wskbddevcf_console		cf_loc[WSKBDDEVCF_CONSOLE]	/* spec'd as console? */
76 #define	WSKBDDEVCF_CONSOLE_UNK		(WSKBDDEVCF_CONSOLE_DEFAULT)
77 
78 #define	wskbddevcf_mux		cf_loc[WSKBDDEVCF_MUX]
79 
80 /*
81  * Autoconfiguration helper functions.
82  */
83 void	wskbd_cnattach(const struct wskbd_consops *, void *,
84 			    const struct wskbd_mapdata *);
85 void	wskbd_cndetach(void);
86 int	wskbddevprint(void *, const char *);
87 
88 /*
89  * Callbacks from the keyboard driver to the wskbd interface driver.
90  */
91 void	wskbd_input(device_t, u_int, int);
92 /* for WSDISPLAY_COMPAT_RAWKBD */
93 void	wskbd_rawinput(device_t, u_char *, int);
94 
95 /*
96  * Callbacks for (ACPI) hotkey drivers which generate
97  * keycodes.
98  */
99 struct wskbd_softc;
100 typedef int (wskbd_hotkey_plugin)(struct wskbd_softc *, void *, u_int, int);
101 
102 device_t wskbd_hotkey_register(device_t, void *, wskbd_hotkey_plugin *);
103 void	 wskbd_hotkey_deregister(device_t);
104 
105 /*
106  * Console interface.
107  */
108 int	wskbd_cngetc(dev_t);
109 void	wskbd_cnpollc(dev_t, int);
110 void	wskbd_cnbell(dev_t, u_int, u_int, u_int);
111