1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
5 * 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 as
12 * the first lines of this file unmodified.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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
43 /* keyboard function table */
44 typedef int kbd_probe_t(int unit, void *arg, int flags);
45 typedef int kbd_init_t(int unit, keyboard_t **kbdp, void *arg,
46 int flags);
47 typedef int kbd_term_t(keyboard_t *kbd);
48 typedef int kbd_intr_t(keyboard_t *kbd, void *arg);
49 typedef int kbd_test_if_t(keyboard_t *kbd);
50 typedef int kbd_enable_t(keyboard_t *kbd);
51 typedef int kbd_disable_t(keyboard_t *kbd);
52 typedef int kbd_read_t(keyboard_t *kbd, int wait);
53 typedef int kbd_check_t(keyboard_t *kbd);
54 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait);
55 typedef int kbd_check_char_t(keyboard_t *kbd);
56 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data);
57 typedef int kbd_lock_t(keyboard_t *kbd, int lock);
58 typedef void kbd_clear_state_t(keyboard_t *kbd);
59 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len);
60 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len);
61 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey,
62 size_t *len);
63 typedef int kbd_poll_mode_t(keyboard_t *kbd, int on);
64 typedef void kbd_diag_t(keyboard_t *kbd, int level);
65
66 /* event types */
67 #define KBDIO_KEYINPUT 0
68 #define KBDIO_UNLOADING 1
69
70 typedef struct keyboard_callback {
71 kbd_callback_func_t *kc_func;
72 void *kc_arg;
73 } keyboard_callback_t;
74
75 typedef struct keyboard_switch {
76 kbd_probe_t *probe;
77 kbd_init_t *init;
78 kbd_term_t *term;
79 kbd_intr_t *intr;
80 kbd_test_if_t *test_if;
81 kbd_enable_t *enable;
82 kbd_disable_t *disable;
83 kbd_read_t *read;
84 kbd_check_t *check;
85 kbd_read_char_t *read_char;
86 kbd_check_char_t *check_char;
87 kbd_ioctl_t *ioctl;
88 kbd_lock_t *lock;
89 kbd_clear_state_t *clear_state;
90 kbd_get_state_t *get_state;
91 kbd_set_state_t *set_state;
92 kbd_get_fkeystr_t *get_fkeystr;
93 kbd_poll_mode_t *poll;
94 kbd_diag_t *diag;
95 } keyboard_switch_t;
96
97 /*
98 * Keyboard driver definition. Some of these be immutable after definition
99 * time, e.g. one shouldn't be able to rename a driver or use a different kbdsw
100 * entirely, but patching individual methods is acceptable.
101 */
102 typedef struct keyboard_driver {
103 SLIST_ENTRY(keyboard_driver) link;
104 const char * const name;
105 keyboard_switch_t * const kbdsw;
106 /* backdoor for the console driver */
107 int (* const configure)(int);
108 int flags;
109 } keyboard_driver_t;
110
111 #define KBDF_REGISTERED 0x0001
112
113 /* keyboard */
114 struct keyboard {
115 /* the following fields are managed by kbdio */
116 int kb_index; /* kbdio index# */
117 int kb_minor; /* minor number of the sub-device */
118 int kb_flags; /* internal flags */
119 #define KB_VALID (1 << 16) /* this entry is valid */
120 #define KB_NO_DEVICE (1 << 17) /* device not present */
121 #define KB_PROBED (1 << 18) /* device probed */
122 #define KB_INITIALIZED (1 << 19) /* device initialized */
123 #define KB_REGISTERED (1 << 20) /* device registered to kbdio */
124 #define KB_BUSY (1 << 21) /* device used by a client */
125 #define KB_POLLED (1 << 22) /* device is polled */
126 int kb_active; /* 0: inactive */
127 void *kb_token; /* id of the current client */
128 keyboard_callback_t kb_callback;/* callback function */
129
130 /*
131 * Device configuration flags:
132 * The upper 16 bits are common between various keyboard devices.
133 * The lower 16 bits are device-specific.
134 */
135 int kb_config;
136 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */
137
138 /* the following fields are set up by the driver */
139 char *kb_name; /* driver name */
140 int kb_unit; /* unit # */
141 int kb_type; /* KB_84, KB_101, KB_OTHER,... */
142 int kb_io_base; /* port# if any */
143 int kb_io_size; /* # of occupied port */
144 int kb_led; /* LED status */
145 struct keymap *kb_keymap; /* key map */
146 struct accentmap *kb_accentmap; /* accent map */
147 struct fkeytab *kb_fkeytab; /* function key strings */
148 int kb_fkeytab_size;/* # of function key strings */
149 void *kb_data; /* the driver's private data */
150 int kb_delay1;
151 int kb_delay2;
152 #define KB_DELAY1 500
153 #define KB_DELAY2 100
154 unsigned long kb_count; /* # of processed key strokes */
155 u_char kb_lastact[NUM_KEYS/2];
156 struct cdev *kb_dev;
157 const keyboard_driver_t *kb_drv;
158 };
159
160 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID)
161 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID)
162 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID)
163 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE))
164 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE)
165 #define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED)
166 #define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED)
167 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED)
168 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED)
169 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED)
170 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED)
171 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY)
172 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY)
173 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY)
174 #define KBD_IS_POLLED(k) ((k)->kb_flags & KB_POLLED)
175 #define KBD_POLL(k) ((k)->kb_flags |= KB_POLLED)
176 #define KBD_UNPOLL(k) ((k)->kb_flags &= ~KB_POLLED)
177 #define KBD_IS_ACTIVE(k) ((k)->kb_active)
178 #define KBD_ACTIVATE(k) (++(k)->kb_active)
179 #define KBD_DEACTIVATE(k) (--(k)->kb_active)
180 #define KBD_LED_VAL(k) ((k)->kb_led)
181
182 /*
183 * Keyboard disciplines: call actual handlers via kbdsw[].
184 */
185 static __inline int
kbdd_probe(keyboard_t * kbd,int unit,void * arg,int flags)186 kbdd_probe(keyboard_t *kbd, int unit, void *arg, int flags)
187 {
188
189 return ((*kbd->kb_drv->kbdsw->probe)(unit, arg, flags));
190 }
191
192 static __inline int
kbdd_init(keyboard_t * kbd,int unit,keyboard_t ** kbdpp,void * arg,int flags)193 kbdd_init(keyboard_t *kbd, int unit, keyboard_t **kbdpp, void *arg, int flags)
194 {
195
196 return ((*kbd->kb_drv->kbdsw->init)(unit, kbdpp, arg, flags));
197 }
198
199 static __inline int
kbdd_term(keyboard_t * kbd)200 kbdd_term(keyboard_t *kbd)
201 {
202
203 return ((*kbd->kb_drv->kbdsw->term)(kbd));
204 }
205
206 static __inline int
kbdd_intr(keyboard_t * kbd,void * arg)207 kbdd_intr(keyboard_t *kbd, void *arg)
208 {
209
210 return ((*kbd->kb_drv->kbdsw->intr)(kbd, arg));
211 }
212
213 static __inline int
kbdd_test_if(keyboard_t * kbd)214 kbdd_test_if(keyboard_t *kbd)
215 {
216
217 return ((*kbd->kb_drv->kbdsw->test_if)(kbd));
218 }
219
220 static __inline int
kbdd_enable(keyboard_t * kbd)221 kbdd_enable(keyboard_t *kbd)
222 {
223
224 return ((*kbd->kb_drv->kbdsw->enable)(kbd));
225 }
226
227 static __inline int
kbdd_disable(keyboard_t * kbd)228 kbdd_disable(keyboard_t *kbd)
229 {
230
231 return ((*kbd->kb_drv->kbdsw->disable)(kbd));
232 }
233
234 static __inline int
kbdd_read(keyboard_t * kbd,int wait)235 kbdd_read(keyboard_t *kbd, int wait)
236 {
237
238 return ((*kbd->kb_drv->kbdsw->read)(kbd, wait));
239 }
240
241 static __inline int
kbdd_check(keyboard_t * kbd)242 kbdd_check(keyboard_t *kbd)
243 {
244
245 return ((*kbd->kb_drv->kbdsw->check)(kbd));
246 }
247
248 static __inline u_int
kbdd_read_char(keyboard_t * kbd,int wait)249 kbdd_read_char(keyboard_t *kbd, int wait)
250 {
251
252 return ((*kbd->kb_drv->kbdsw->read_char)(kbd, wait));
253 }
254
255 static __inline int
kbdd_check_char(keyboard_t * kbd)256 kbdd_check_char(keyboard_t *kbd)
257 {
258
259 return ((*kbd->kb_drv->kbdsw->check_char)(kbd));
260 }
261
262 static __inline int
kbdd_ioctl(keyboard_t * kbd,u_long cmd,caddr_t data)263 kbdd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t data)
264 {
265
266 if (kbd == NULL)
267 return (ENODEV);
268 return ((*kbd->kb_drv->kbdsw->ioctl)(kbd, cmd, data));
269 }
270
271 static __inline int
kbdd_lock(keyboard_t * kbd,int lock)272 kbdd_lock(keyboard_t *kbd, int lock)
273 {
274
275 return ((*kbd->kb_drv->kbdsw->lock)(kbd, lock));
276 }
277
278 static __inline void
kbdd_clear_state(keyboard_t * kbd)279 kbdd_clear_state(keyboard_t *kbd)
280 {
281
282 (*kbd->kb_drv->kbdsw->clear_state)(kbd);
283 }
284
285 static __inline int
kbdd_get_state(keyboard_t * kbd,void * buf,int len)286 kbdd_get_state(keyboard_t *kbd, void *buf, int len)
287 {
288
289 return ((*kbd->kb_drv->kbdsw->get_state)(kbd, buf, len));
290 }
291
292 static __inline int
kbdd_set_state(keyboard_t * kbd,void * buf,int len)293 kbdd_set_state(keyboard_t *kbd, void *buf, int len)
294 {
295
296 return ((*kbd->kb_drv->kbdsw->set_state)(kbd, buf, len));
297 }
298
299 static __inline u_char *
kbdd_get_fkeystr(keyboard_t * kbd,int fkey,size_t * len)300 kbdd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len)
301 {
302
303 return ((*kbd->kb_drv->kbdsw->get_fkeystr)(kbd, fkey, len));
304 }
305
306 static __inline int
kbdd_poll(keyboard_t * kbd,int on)307 kbdd_poll(keyboard_t *kbd, int on)
308 {
309
310 return ((*kbd->kb_drv->kbdsw->poll)(kbd, on));
311 }
312
313 static __inline void
kbdd_diag(keyboard_t * kbd,int level)314 kbdd_diag(keyboard_t *kbd, int level)
315 {
316
317 (*kbd->kb_drv->kbdsw->diag)(kbd, level);
318 }
319
320 #define KEYBOARD_DRIVER(name, sw, config) \
321 static struct keyboard_driver name##_kbd_driver = { \
322 { NULL }, #name, &sw, config \
323 }; \
324 DATA_SET(kbddriver_set, name##_kbd_driver);
325
326 /* functions for the keyboard driver */
327 int kbd_add_driver(keyboard_driver_t *driver);
328 int kbd_delete_driver(keyboard_driver_t *driver);
329 int kbd_register(keyboard_t *kbd);
330 int kbd_unregister(keyboard_t *kbd);
331 keyboard_switch_t *kbd_get_switch(char *driver);
332 void kbd_init_struct(keyboard_t *kbd, char *name, int type,
333 int unit, int config, int port,
334 int port_size);
335 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap,
336 struct accentmap *accmap,
337 struct fkeytab *fkeymap, int fkeymap_size);
338
339 /* functions for the keyboard client */
340 int kbd_allocate(char *driver, int unit, void *id,
341 kbd_callback_func_t *func, void *arg);
342 int kbd_release(keyboard_t *kbd, void *id);
343 int kbd_change_callback(keyboard_t *kbd, void *id,
344 kbd_callback_func_t *func, void *arg);
345 int kbd_find_keyboard(char *driver, int unit);
346 int kbd_find_keyboard2(char *driver, int unit, int index);
347 keyboard_t *kbd_get_keyboard(int index);
348
349 /* a back door for the console driver to tickle the keyboard driver XXX */
350 int kbd_configure(int flags);
351 /* see `kb_config' above for flag bit definitions */
352
353 /* evdev2kbd mappings */
354 void kbd_ev_event(keyboard_t *kbd, uint16_t type,
355 uint16_t code, int32_t value);
356
357 #ifdef KBD_INSTALL_CDEV
358
359 /* virtual keyboard cdev driver functions */
360 int kbd_attach(keyboard_t *kbd);
361 int kbd_detach(keyboard_t *kbd);
362
363 #endif /* KBD_INSTALL_CDEV */
364
365 /* generic low-level keyboard functions */
366
367 /* shift key state */
368 #define SHIFTS1 (1 << 16)
369 #define SHIFTS2 (1 << 17)
370 #define SHIFTS (SHIFTS1 | SHIFTS2)
371 #define CTLS1 (1 << 18)
372 #define CTLS2 (1 << 19)
373 #define CTLS (CTLS1 | CTLS2)
374 #define ALTS1 (1 << 20)
375 #define ALTS2 (1 << 21)
376 #define ALTS (ALTS1 | ALTS2)
377 #define AGRS1 (1 << 22)
378 #define AGRS2 (1 << 23)
379 #define AGRS (AGRS1 | AGRS2)
380 #define METAS1 (1 << 24)
381 #define METAS2 (1 << 25)
382 #define METAS (METAS1 | METAS2)
383 #define NLKDOWN (1 << 26)
384 #define SLKDOWN (1 << 27)
385 #define CLKDOWN (1 << 28)
386 #define ALKDOWN (1 << 29)
387 #define SHIFTAON (1 << 30)
388 /* lock key state (defined in sys/kbio.h) */
389 /*
390 #define CLKED LED_CAP
391 #define NLKED LED_NUM
392 #define SLKED LED_SCR
393 #define ALKED (1 << 3)
394 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED)
395 #define LED_CAP (1 << 0)
396 #define LED_NUM (1 << 1)
397 #define LED_SCR (1 << 2)
398 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR)
399 */
400
401 /* Initialization for the kbd layer, performed by cninit. */
402 void kbdinit(void);
403
404 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg);
405 int genkbd_keyaction(keyboard_t *kbd, int keycode, int up,
406 int *shiftstate, int *accents);
407
408 #endif /* !_DEV_KBD_KBDREG_H_ */
409