xref: /freebsd/sys/dev/kbd/kbdreg.h (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
1 /*-
2  * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer as
10  *    the first lines of this file unmodified.
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  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $Id: kbdreg.h,v 1.3 1999/03/10 10:36:52 yokota Exp $
27  */
28 
29 #ifndef _DEV_KBD_KBDREG_H_
30 #define _DEV_KBD_KBDREG_H_
31 
32 /* forward declarations */
33 typedef struct keyboard keyboard_t;
34 struct keymap;
35 struct accentmap;
36 struct fkeytab;
37 struct cdevsw;
38 
39 /* call back funcion */
40 typedef int		kbd_callback_func_t(keyboard_t *kbd, int event,
41 					    void *arg);
42 /* event types */
43 #define KBDIO_KEYINPUT	0
44 #define KBDIO_UNLOADING	1
45 
46 typedef struct keyboard_callback {
47 	kbd_callback_func_t *kc_func;
48 	void		*kc_arg;
49 } keyboard_callback_t;
50 
51 /* keyboard */
52 struct keyboard {
53 	/* the following fields are managed by kbdio */
54 	int		kb_index;	/* kbdio index# */
55 	int		kb_minor;	/* minor number of the sub-device */
56 	int		kb_flags;	/* internal flags */
57 #define KB_VALID	(1 << 16)	/* this entry is valid */
58 #define KB_NO_DEVICE	(1 << 17)	/* device not present */
59 #define KB_PROBED	(1 << 18)	/* device probed */
60 #define KB_INITIALIZED	(1 << 19)	/* device initialized */
61 #define KB_REGISTERED	(1 << 20)	/* device registered to kbdio */
62 #define KB_BUSY		(1 << 21)	/* device used by a client */
63 	int		kb_active;	/* 0: inactive */
64 	void		*kb_token;	/* id of the current client */
65 	keyboard_callback_t kb_callback;/* callback function */
66 
67 	/*
68 	 * Device configuration flags:
69 	 * The upper 16 bits are common between various keyboard devices.
70 	 * The lower 16 bits are device-specific.
71 	 */
72 	int		kb_config;
73 #define KB_CONF_PROBE_ONLY (1 << 16)	/* probe only, don't initialize */
74 
75 	/* the following fields are set up by the driver */
76 	char		*kb_name;	/* driver name */
77 	int		kb_unit;	/* unit # */
78 	int		kb_type;	/* KB_84, KB_101, KB_OTHER,... */
79 	int		kb_io_base;	/* port# if any */
80 	int		kb_io_size;	/* # of occupied port */
81 	int		kb_led;		/* LED status */
82 	struct keymap	*kb_keymap;	/* key map */
83 	struct accentmap *kb_accentmap;	/* accent map */
84 	struct fkeytab	*kb_fkeytab;	/* function key strings */
85 	int		kb_fkeytab_size;/* # of function key strings */
86 	void		*kb_data;	/* the driver's private data */
87 	int		kb_delay1;
88 	int		kb_delay2;
89 #define KB_DELAY1	500
90 #define KB_DELAY2	100
91 };
92 
93 #define KBD_IS_VALID(k)		((k)->kb_flags & KB_VALID)
94 #define KBD_VALID(k)		((k)->kb_flags |= KB_VALID)
95 #define KBD_INVALID(k)		((k)->kb_flags &= ~KB_VALID)
96 #define KBD_HAS_DEVICE(k)	(!((k)->kb_flags & KB_NO_DEVICE))
97 #define KBD_FOUND_DEVICE(k)	((k)->kb_flags &= ~KB_NO_DEVICE)
98 #define KBD_IS_PROBED(k)	((k)->kb_flags & KB_PROBED)
99 #define KBD_PROBE_DONE(k)	((k)->kb_flags |= KB_PROBED)
100 #define KBD_IS_INITIALIZED(k)	((k)->kb_flags & KB_INITIALIZED)
101 #define KBD_INIT_DONE(k)	((k)->kb_flags |= KB_INITIALIZED)
102 #define KBD_IS_CONFIGURED(k)	((k)->kb_flags & KB_REGISTERED)
103 #define KBD_CONFIG_DONE(k)	((k)->kb_flags |= KB_REGISTERED)
104 #define KBD_IS_BUSY(k)		((k)->kb_flags & KB_BUSY)
105 #define KBD_BUSY(k)		((k)->kb_flags |= KB_BUSY)
106 #define KBD_UNBUSY(k)		((k)->kb_flags &= ~KB_BUSY)
107 #define KBD_IS_ACTIVE(k)	((k)->kb_active)
108 #define KBD_ACTIVATE(k)		(++(k)->kb_active)
109 #define KBD_DEACTIVATE(k)	(--(k)->kb_active)
110 #define KBD_LED_VAL(k)		((k)->kb_led)
111 
112 /* keyboard function table */
113 typedef int		kbd_probe_t(int unit, void *arg, int flags);
114 typedef int		kbd_init_t(int unit, keyboard_t **kbdp, void *arg,
115 				   int flags);
116 typedef int		kbd_term_t(keyboard_t *kbd);
117 typedef int		kbd_intr_t(keyboard_t *kbd, void *arg);
118 typedef int		kbd_test_if_t(keyboard_t *kbd);
119 typedef int		kbd_enable_t(keyboard_t *kbd);
120 typedef int		kbd_disable_t(keyboard_t *kbd);
121 typedef int		kbd_read_t(keyboard_t *kbd, int wait);
122 typedef int		kbd_check_t(keyboard_t *kbd);
123 typedef u_int		kbd_read_char_t(keyboard_t *kbd, int wait);
124 typedef int		kbd_check_char_t(keyboard_t *kbd);
125 typedef int		kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data);
126 typedef int		kbd_lock_t(keyboard_t *kbd, int lock);
127 typedef void		kbd_clear_state_t(keyboard_t *kbd);
128 typedef int		kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len);
129 typedef int		kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len);
130 typedef u_char		*kbd_get_fkeystr_t(keyboard_t *kbd, int fkey,
131 					   size_t *len);
132 typedef int		kbd_poll_mode_t(keyboard_t *kbd, int on);
133 typedef void		kbd_diag_t(keyboard_t *kbd, int level);
134 
135 typedef struct keyboard_switch {
136 	kbd_probe_t	*probe;
137 	kbd_init_t	*init;
138 	kbd_term_t	*term;
139 	kbd_intr_t	*intr;
140 	kbd_test_if_t	*test_if;
141 	kbd_enable_t	*enable;
142 	kbd_disable_t	*disable;
143 	kbd_read_t	*read;
144 	kbd_check_t	*check;
145 	kbd_read_char_t	*read_char;
146 	kbd_check_char_t *check_char;
147 	kbd_ioctl_t	*ioctl;
148 	kbd_lock_t	*lock;
149 	kbd_clear_state_t *clear_state;
150 	kbd_get_state_t	*get_state;
151 	kbd_set_state_t	*set_state;
152 	kbd_get_fkeystr_t *get_fkeystr;
153 	kbd_poll_mode_t *poll;
154 	kbd_diag_t	*diag;
155 } keyboard_switch_t;
156 
157 /* keyboard driver */
158 typedef struct keyboard_driver {
159     char		*name;
160     keyboard_switch_t	*kbdsw;
161     int			(*configure)(int); /* backdoor for the console driver */
162 } keyboard_driver_t;
163 
164 #ifdef KERNEL
165 
166 #define KEYBOARD_DRIVER(name, sw, config)		\
167 	static struct keyboard_driver name##_kbd_driver = { \
168 		#name, &sw, config			\
169 	};						\
170 	DATA_SET(kbddriver_set, name##_kbd_driver);
171 
172 /* global variables */
173 extern keyboard_switch_t **kbdsw;
174 extern struct linker_set kbddriver_set;
175 
176 /* functions for the keyboard driver */
177 int			kbd_register(keyboard_t *kbd);
178 int			kbd_unregister(keyboard_t *kbd);
179 keyboard_switch_t	*kbd_get_switch(char *driver);
180 void			kbd_init_struct(keyboard_t *kbd, char *name, int type,
181 					int unit, int config, int port,
182 					int port_size);
183 void			kbd_set_maps(keyboard_t *kbd, struct keymap *keymap,
184 				     struct accentmap *accmap,
185 				     struct fkeytab *fkeymap, int fkeymap_size);
186 
187 /* functions for the keyboard client */
188 int			kbd_allocate(char *driver, int unit, void *id,
189 				     kbd_callback_func_t *func, void *arg);
190 int			kbd_release(keyboard_t *kbd, void *id);
191 int			kbd_change_callback(keyboard_t *kbd, void *id,
192 				     kbd_callback_func_t *func, void *arg);
193 int			kbd_find_keyboard(char *driver, int unit);
194 keyboard_t 		*kbd_get_keyboard(int index);
195 
196 /* a back door for the console driver to tickle the keyboard driver XXX */
197 int			kbd_configure(int flags);
198 			/* see `kb_config' above for flag bit definitions */
199 
200 #ifdef KBD_INSTALL_CDEV
201 
202 /* virtual keyboard cdev driver functions */
203 int			kbd_attach(keyboard_t *kbd);
204 int			kbd_detach(keyboard_t *kbd);
205 
206 #endif /* KBD_INSTALL_CDEV */
207 
208 /* generic low-level keyboard functions */
209 
210 /* shift key state */
211 #define SHIFTS1		(1 << 16)
212 #define SHIFTS2		(1 << 17)
213 #define SHIFTS		(SHIFTS1 | SHIFTS2)
214 #define CTLS1		(1 << 18)
215 #define CTLS2		(1 << 19)
216 #define CTLS		(CTLS1 | CTLS2)
217 #define ALTS1		(1 << 20)
218 #define ALTS2		(1 << 21)
219 #define ALTS		(ALTS1 | ALTS2)
220 #define AGRS1		(1 << 22)
221 #define AGRS2		(1 << 23)
222 #define AGRS		(AGRS1 | AGRS2)
223 #define METAS1		(1 << 24)
224 #define METAS2		(1 << 25)
225 #define METAS		(METAS1 | METAS2)
226 #define NLKDOWN		(1 << 26)
227 #define SLKDOWN		(1 << 27)
228 #define CLKDOWN		(1 << 28)
229 #define ALKDOWN		(1 << 29)
230 /* lock key state (defined in machine/console.h) */
231 /*
232 #define CLKED		LED_CAP
233 #define NLKED		LED_NUM
234 #define SLKED		LED_SCR
235 #define ALKED		(1 << 3)
236 #define LOCK_MASK	(CLKED | NLKED | SLKED | ALKED)
237 #define LED_CAP		(1 << 0)
238 #define LED_NUM		(1 << 1)
239 #define LED_SCR		(1 << 2)
240 #define LED_MASK	(LED_CAP | LED_NUM | LED_SCR)
241 */
242 
243 kbd_get_fkeystr_t	genkbd_get_fkeystr;
244 kbd_diag_t		genkbd_diag;
245 
246 int 	genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg);
247 int 	genkbd_keyaction(keyboard_t *kbd, int keycode, int down,
248 			 int *shiftstate, int *accents);
249 
250 #endif /* KERNEL */
251 
252 #endif /* !_DEV_KBD_KBDREG_H_ */
253