2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
31 #ifndef _DEV_KBD_KBDREG_H_
32 #define _DEV_KBD_KBDREG_H_
34 /* forward declarations */
35 typedef struct keyboard keyboard_t;
41 /* call back funcion */
42 typedef int kbd_callback_func_t(keyboard_t *kbd, int event,
45 /* keyboard function table */
46 typedef int kbd_probe_t(int unit, void *arg, int flags);
47 typedef int kbd_init_t(int unit, keyboard_t **kbdp, void *arg,
49 typedef int kbd_term_t(keyboard_t *kbd);
50 typedef int kbd_intr_t(keyboard_t *kbd, void *arg);
51 typedef int kbd_test_if_t(keyboard_t *kbd);
52 typedef int kbd_enable_t(keyboard_t *kbd);
53 typedef int kbd_disable_t(keyboard_t *kbd);
54 typedef int kbd_read_t(keyboard_t *kbd, int wait);
55 typedef int kbd_check_t(keyboard_t *kbd);
56 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait);
57 typedef int kbd_check_char_t(keyboard_t *kbd);
58 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data);
59 typedef int kbd_lock_t(keyboard_t *kbd, int lock);
60 typedef void kbd_clear_state_t(keyboard_t *kbd);
61 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len);
62 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len);
63 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey,
65 typedef int kbd_poll_mode_t(keyboard_t *kbd, int on);
66 typedef void kbd_diag_t(keyboard_t *kbd, int level);
69 #define KBDIO_KEYINPUT 0
70 #define KBDIO_UNLOADING 1
72 typedef struct keyboard_callback {
73 kbd_callback_func_t *kc_func;
75 } keyboard_callback_t;
77 typedef struct keyboard_switch {
82 kbd_test_if_t *test_if;
84 kbd_disable_t *disable;
87 kbd_read_char_t *read_char;
88 kbd_check_char_t *check_char;
91 kbd_clear_state_t *clear_state;
92 kbd_get_state_t *get_state;
93 kbd_set_state_t *set_state;
94 kbd_get_fkeystr_t *get_fkeystr;
95 kbd_poll_mode_t *poll;
100 * Keyboard driver definition. Some of these be immutable after definition
101 * time, e.g. one shouldn't be able to rename a driver or use a different kbdsw
102 * entirely, but patching individual methods is acceptable.
104 typedef struct keyboard_driver {
105 SLIST_ENTRY(keyboard_driver) link;
106 const char * const name;
107 keyboard_switch_t * const kbdsw;
108 /* backdoor for the console driver */
109 int (* const configure)(int);
114 /* the following fields are managed by kbdio */
115 int kb_index; /* kbdio index# */
116 int kb_minor; /* minor number of the sub-device */
117 int kb_flags; /* internal flags */
118 #define KB_VALID (1 << 16) /* this entry is valid */
119 #define KB_NO_DEVICE (1 << 17) /* device not present */
120 #define KB_PROBED (1 << 18) /* device probed */
121 #define KB_INITIALIZED (1 << 19) /* device initialized */
122 #define KB_REGISTERED (1 << 20) /* device registered to kbdio */
123 #define KB_BUSY (1 << 21) /* device used by a client */
124 #define KB_POLLED (1 << 22) /* device is polled */
125 int kb_active; /* 0: inactive */
126 void *kb_token; /* id of the current client */
127 keyboard_callback_t kb_callback;/* callback function */
130 * Device configuration flags:
131 * The upper 16 bits are common between various keyboard devices.
132 * The lower 16 bits are device-specific.
135 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */
137 /* the following fields are set up by the driver */
138 char *kb_name; /* driver name */
139 int kb_unit; /* unit # */
140 int kb_type; /* KB_84, KB_101, KB_OTHER,... */
141 int kb_io_base; /* port# if any */
142 int kb_io_size; /* # of occupied port */
143 int kb_led; /* LED status */
144 struct keymap *kb_keymap; /* key map */
145 struct accentmap *kb_accentmap; /* accent map */
146 struct fkeytab *kb_fkeytab; /* function key strings */
147 int kb_fkeytab_size;/* # of function key strings */
148 void *kb_data; /* the driver's private data */
151 #define KB_DELAY1 500
152 #define KB_DELAY2 100
153 unsigned long kb_count; /* # of processed key strokes */
154 u_char kb_lastact[NUM_KEYS/2];
156 const keyboard_driver_t *kb_drv;
159 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID)
160 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID)
161 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID)
162 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE))
163 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE)
164 #define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED)
165 #define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED)
166 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED)
167 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED)
168 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED)
169 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED)
170 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY)
171 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY)
172 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY)
173 #define KBD_IS_POLLED(k) ((k)->kb_flags & KB_POLLED)
174 #define KBD_POLL(k) ((k)->kb_flags |= KB_POLLED)
175 #define KBD_UNPOLL(k) ((k)->kb_flags &= ~KB_POLLED)
176 #define KBD_IS_ACTIVE(k) ((k)->kb_active)
177 #define KBD_ACTIVATE(k) (++(k)->kb_active)
178 #define KBD_DEACTIVATE(k) (--(k)->kb_active)
179 #define KBD_LED_VAL(k) ((k)->kb_led)
182 * Keyboard disciplines: call actual handlers via kbdsw[].
185 kbdd_probe(keyboard_t *kbd, int unit, void *arg, int flags)
188 return ((*kbd->kb_drv->kbdsw->probe)(unit, arg, flags));
192 kbdd_init(keyboard_t *kbd, int unit, keyboard_t **kbdpp, void *arg, int flags)
195 return ((*kbd->kb_drv->kbdsw->init)(unit, kbdpp, arg, flags));
199 kbdd_term(keyboard_t *kbd)
202 return ((*kbd->kb_drv->kbdsw->term)(kbd));
206 kbdd_intr(keyboard_t *kbd, void *arg)
209 return ((*kbd->kb_drv->kbdsw->intr)(kbd, arg));
213 kbdd_test_if(keyboard_t *kbd)
216 return ((*kbd->kb_drv->kbdsw->test_if)(kbd));
220 kbdd_enable(keyboard_t *kbd)
223 return ((*kbd->kb_drv->kbdsw->enable)(kbd));
227 kbdd_disable(keyboard_t *kbd)
230 return ((*kbd->kb_drv->kbdsw->disable)(kbd));
234 kbdd_read(keyboard_t *kbd, int wait)
237 return ((*kbd->kb_drv->kbdsw->read)(kbd, wait));
241 kbdd_check(keyboard_t *kbd)
244 return ((*kbd->kb_drv->kbdsw->check)(kbd));
247 static __inline u_int
248 kbdd_read_char(keyboard_t *kbd, int wait)
251 return ((*kbd->kb_drv->kbdsw->read_char)(kbd, wait));
255 kbdd_check_char(keyboard_t *kbd)
258 return ((*kbd->kb_drv->kbdsw->check_char)(kbd));
262 kbdd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t data)
267 return ((*kbd->kb_drv->kbdsw->ioctl)(kbd, cmd, data));
271 kbdd_lock(keyboard_t *kbd, int lock)
274 return ((*kbd->kb_drv->kbdsw->lock)(kbd, lock));
278 kbdd_clear_state(keyboard_t *kbd)
281 (*kbd->kb_drv->kbdsw->clear_state)(kbd);
285 kbdd_get_state(keyboard_t *kbd, void *buf, int len)
288 return ((*kbd->kb_drv->kbdsw->get_state)(kbd, buf, len));
292 kbdd_set_state(keyboard_t *kbd, void *buf, int len)
295 return ((*kbd->kb_drv->kbdsw->set_state)(kbd, buf, len));
298 static __inline u_char *
299 kbdd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len)
302 return ((*kbd->kb_drv->kbdsw->get_fkeystr)(kbd, fkey, len));
306 kbdd_poll(keyboard_t *kbd, int on)
309 return ((*kbd->kb_drv->kbdsw->poll)(kbd, on));
313 kbdd_diag(keyboard_t *kbd, int level)
316 (*kbd->kb_drv->kbdsw->diag)(kbd, level);
319 #define KEYBOARD_DRIVER(name, sw, config) \
320 static struct keyboard_driver name##_kbd_driver = { \
321 { NULL }, #name, &sw, config \
323 DATA_SET(kbddriver_set, name##_kbd_driver);
325 /* functions for the keyboard driver */
326 int kbd_add_driver(keyboard_driver_t *driver);
327 int kbd_delete_driver(keyboard_driver_t *driver);
328 int kbd_register(keyboard_t *kbd);
329 int kbd_unregister(keyboard_t *kbd);
330 keyboard_switch_t *kbd_get_switch(char *driver);
331 void kbd_init_struct(keyboard_t *kbd, char *name, int type,
332 int unit, int config, int port,
334 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap,
335 struct accentmap *accmap,
336 struct fkeytab *fkeymap, int fkeymap_size);
338 /* functions for the keyboard client */
339 int kbd_allocate(char *driver, int unit, void *id,
340 kbd_callback_func_t *func, void *arg);
341 int kbd_release(keyboard_t *kbd, void *id);
342 int kbd_change_callback(keyboard_t *kbd, void *id,
343 kbd_callback_func_t *func, void *arg);
344 int kbd_find_keyboard(char *driver, int unit);
345 int kbd_find_keyboard2(char *driver, int unit, int index);
346 keyboard_t *kbd_get_keyboard(int index);
348 /* a back door for the console driver to tickle the keyboard driver XXX */
349 int kbd_configure(int flags);
350 /* see `kb_config' above for flag bit definitions */
352 /* evdev2kbd mappings */
353 void kbd_ev_event(keyboard_t *kbd, uint16_t type,
354 uint16_t code, int32_t value);
356 #ifdef KBD_INSTALL_CDEV
358 /* virtual keyboard cdev driver functions */
359 int kbd_attach(keyboard_t *kbd);
360 int kbd_detach(keyboard_t *kbd);
362 #endif /* KBD_INSTALL_CDEV */
364 /* generic low-level keyboard functions */
366 /* shift key state */
367 #define SHIFTS1 (1 << 16)
368 #define SHIFTS2 (1 << 17)
369 #define SHIFTS (SHIFTS1 | SHIFTS2)
370 #define CTLS1 (1 << 18)
371 #define CTLS2 (1 << 19)
372 #define CTLS (CTLS1 | CTLS2)
373 #define ALTS1 (1 << 20)
374 #define ALTS2 (1 << 21)
375 #define ALTS (ALTS1 | ALTS2)
376 #define AGRS1 (1 << 22)
377 #define AGRS2 (1 << 23)
378 #define AGRS (AGRS1 | AGRS2)
379 #define METAS1 (1 << 24)
380 #define METAS2 (1 << 25)
381 #define METAS (METAS1 | METAS2)
382 #define NLKDOWN (1 << 26)
383 #define SLKDOWN (1 << 27)
384 #define CLKDOWN (1 << 28)
385 #define ALKDOWN (1 << 29)
386 #define SHIFTAON (1 << 30)
387 /* lock key state (defined in sys/kbio.h) */
389 #define CLKED LED_CAP
390 #define NLKED LED_NUM
391 #define SLKED LED_SCR
392 #define ALKED (1 << 3)
393 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED)
394 #define LED_CAP (1 << 0)
395 #define LED_NUM (1 << 1)
396 #define LED_SCR (1 << 2)
397 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR)
400 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg);
401 int genkbd_keyaction(keyboard_t *kbd, int keycode, int up,
402 int *shiftstate, int *accents);
404 #endif /* !_DEV_KBD_KBDREG_H_ */