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 #define KBDIO_KEYINPUT 0
46 #define KBDIO_UNLOADING 1
48 typedef struct keyboard_callback {
49 kbd_callback_func_t *kc_func;
51 } keyboard_callback_t;
55 /* the following fields are managed by kbdio */
56 int kb_index; /* kbdio index# */
57 int kb_minor; /* minor number of the sub-device */
58 int kb_flags; /* internal flags */
59 #define KB_VALID (1 << 16) /* this entry is valid */
60 #define KB_NO_DEVICE (1 << 17) /* device not present */
61 #define KB_PROBED (1 << 18) /* device probed */
62 #define KB_INITIALIZED (1 << 19) /* device initialized */
63 #define KB_REGISTERED (1 << 20) /* device registered to kbdio */
64 #define KB_BUSY (1 << 21) /* device used by a client */
65 #define KB_POLLED (1 << 22) /* device is polled */
66 int kb_active; /* 0: inactive */
67 void *kb_token; /* id of the current client */
68 keyboard_callback_t kb_callback;/* callback function */
71 * Device configuration flags:
72 * The upper 16 bits are common between various keyboard devices.
73 * The lower 16 bits are device-specific.
76 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */
78 /* the following fields are set up by the driver */
79 char *kb_name; /* driver name */
80 int kb_unit; /* unit # */
81 int kb_type; /* KB_84, KB_101, KB_OTHER,... */
82 int kb_io_base; /* port# if any */
83 int kb_io_size; /* # of occupied port */
84 int kb_led; /* LED status */
85 struct keymap *kb_keymap; /* key map */
86 struct accentmap *kb_accentmap; /* accent map */
87 struct fkeytab *kb_fkeytab; /* function key strings */
88 int kb_fkeytab_size;/* # of function key strings */
89 void *kb_data; /* the driver's private data */
94 unsigned long kb_count; /* # of processed key strokes */
95 u_char kb_lastact[NUM_KEYS/2];
99 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID)
100 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID)
101 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID)
102 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE))
103 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE)
104 #define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED)
105 #define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED)
106 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED)
107 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED)
108 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED)
109 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED)
110 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY)
111 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY)
112 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY)
113 #define KBD_IS_POLLED(k) ((k)->kb_flags & KB_POLLED)
114 #define KBD_POLL(k) ((k)->kb_flags |= KB_POLLED)
115 #define KBD_UNPOLL(k) ((k)->kb_flags &= ~KB_POLLED)
116 #define KBD_IS_ACTIVE(k) ((k)->kb_active)
117 #define KBD_ACTIVATE(k) (++(k)->kb_active)
118 #define KBD_DEACTIVATE(k) (--(k)->kb_active)
119 #define KBD_LED_VAL(k) ((k)->kb_led)
121 /* keyboard function table */
122 typedef int kbd_probe_t(int unit, void *arg, int flags);
123 typedef int kbd_init_t(int unit, keyboard_t **kbdp, void *arg,
125 typedef int kbd_term_t(keyboard_t *kbd);
126 typedef int kbd_intr_t(keyboard_t *kbd, void *arg);
127 typedef int kbd_test_if_t(keyboard_t *kbd);
128 typedef int kbd_enable_t(keyboard_t *kbd);
129 typedef int kbd_disable_t(keyboard_t *kbd);
130 typedef int kbd_read_t(keyboard_t *kbd, int wait);
131 typedef int kbd_check_t(keyboard_t *kbd);
132 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait);
133 typedef int kbd_check_char_t(keyboard_t *kbd);
134 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data);
135 typedef int kbd_lock_t(keyboard_t *kbd, int lock);
136 typedef void kbd_clear_state_t(keyboard_t *kbd);
137 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len);
138 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len);
139 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey,
141 typedef int kbd_poll_mode_t(keyboard_t *kbd, int on);
142 typedef void kbd_diag_t(keyboard_t *kbd, int level);
144 typedef struct keyboard_switch {
149 kbd_test_if_t *test_if;
150 kbd_enable_t *enable;
151 kbd_disable_t *disable;
154 kbd_read_char_t *read_char;
155 kbd_check_char_t *check_char;
158 kbd_clear_state_t *clear_state;
159 kbd_get_state_t *get_state;
160 kbd_set_state_t *set_state;
161 kbd_get_fkeystr_t *get_fkeystr;
162 kbd_poll_mode_t *poll;
166 /* keyboard driver */
167 typedef struct keyboard_driver {
168 SLIST_ENTRY(keyboard_driver) link;
170 keyboard_switch_t *kbdsw;
171 int (*configure)(int); /* backdoor for the console driver */
174 extern keyboard_switch_t **kbdsw;
177 * Keyboard disciplines: call actual handlers via kbdsw[].
180 kbdd_probe(keyboard_t *kbd, int unit, void *arg, int flags)
183 return ((*kbdsw[kbd->kb_index]->probe)(unit, arg, flags));
187 kbdd_init(keyboard_t *kbd, int unit, keyboard_t **kbdpp, void *arg, int flags)
190 return ((*kbdsw[kbd->kb_index]->init)(unit, kbdpp, arg, flags));
194 kbdd_term(keyboard_t *kbd)
197 return ((*kbdsw[kbd->kb_index]->term)(kbd));
201 kbdd_intr(keyboard_t *kbd, void *arg)
204 return ((*kbdsw[kbd->kb_index]->intr)(kbd, arg));
208 kbdd_test_if(keyboard_t *kbd)
211 return ((*kbdsw[kbd->kb_index]->test_if)(kbd));
215 kbdd_enable(keyboard_t *kbd)
218 return ((*kbdsw[kbd->kb_index]->enable)(kbd));
222 kbdd_disable(keyboard_t *kbd)
225 return ((*kbdsw[kbd->kb_index]->disable)(kbd));
229 kbdd_read(keyboard_t *kbd, int wait)
232 return ((*kbdsw[kbd->kb_index]->read)(kbd, wait));
236 kbdd_check(keyboard_t *kbd)
239 return ((*kbdsw[kbd->kb_index]->check)(kbd));
242 static __inline u_int
243 kbdd_read_char(keyboard_t *kbd, int wait)
246 return ((*kbdsw[kbd->kb_index]->read_char)(kbd, wait));
250 kbdd_check_char(keyboard_t *kbd)
253 return ((*kbdsw[kbd->kb_index]->check_char)(kbd));
257 kbdd_ioctl(keyboard_t *kbd, u_long cmd, caddr_t data)
262 return ((*kbdsw[kbd->kb_index]->ioctl)(kbd, cmd, data));
266 kbdd_lock(keyboard_t *kbd, int lock)
269 return ((*kbdsw[kbd->kb_index]->lock)(kbd, lock));
273 kbdd_clear_state(keyboard_t *kbd)
276 (*kbdsw[kbd->kb_index]->clear_state)(kbd);
280 kbdd_get_state(keyboard_t *kbd, void *buf, int len)
283 return ((*kbdsw[kbd->kb_index]->get_state)(kbd, buf, len));
287 kbdd_set_state(keyboard_t *kbd, void *buf, int len)
290 return ((*kbdsw[kbd->kb_index]->set_state)(kbd, buf, len));
293 static __inline u_char *
294 kbdd_get_fkeystr(keyboard_t *kbd, int fkey, size_t *len)
297 return ((*kbdsw[kbd->kb_index]->get_fkeystr)(kbd, fkey, len));
301 kbdd_poll(keyboard_t *kbd, int on)
304 return ((*kbdsw[kbd->kb_index]->poll)(kbd, on));
308 kbdd_diag(keyboard_t *kbd, int level)
311 (*kbdsw[kbd->kb_index]->diag)(kbd, level);
314 #define KEYBOARD_DRIVER(name, sw, config) \
315 static struct keyboard_driver name##_kbd_driver = { \
316 { NULL }, #name, &sw, config \
318 DATA_SET(kbddriver_set, name##_kbd_driver);
320 /* functions for the keyboard driver */
321 int kbd_add_driver(keyboard_driver_t *driver);
322 int kbd_delete_driver(keyboard_driver_t *driver);
323 int kbd_register(keyboard_t *kbd);
324 int kbd_unregister(keyboard_t *kbd);
325 keyboard_switch_t *kbd_get_switch(char *driver);
326 void kbd_init_struct(keyboard_t *kbd, char *name, int type,
327 int unit, int config, int port,
329 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap,
330 struct accentmap *accmap,
331 struct fkeytab *fkeymap, int fkeymap_size);
333 /* functions for the keyboard client */
334 int kbd_allocate(char *driver, int unit, void *id,
335 kbd_callback_func_t *func, void *arg);
336 int kbd_release(keyboard_t *kbd, void *id);
337 int kbd_change_callback(keyboard_t *kbd, void *id,
338 kbd_callback_func_t *func, void *arg);
339 int kbd_find_keyboard(char *driver, int unit);
340 int kbd_find_keyboard2(char *driver, int unit, int index);
341 keyboard_t *kbd_get_keyboard(int index);
343 /* a back door for the console driver to tickle the keyboard driver XXX */
344 int kbd_configure(int flags);
345 /* see `kb_config' above for flag bit definitions */
347 /* evdev2kbd mappings */
348 void kbd_ev_event(keyboard_t *kbd, uint16_t type,
349 uint16_t code, int32_t value);
351 #ifdef KBD_INSTALL_CDEV
353 /* virtual keyboard cdev driver functions */
354 int kbd_attach(keyboard_t *kbd);
355 int kbd_detach(keyboard_t *kbd);
357 #endif /* KBD_INSTALL_CDEV */
359 /* generic low-level keyboard functions */
361 /* shift key state */
362 #define SHIFTS1 (1 << 16)
363 #define SHIFTS2 (1 << 17)
364 #define SHIFTS (SHIFTS1 | SHIFTS2)
365 #define CTLS1 (1 << 18)
366 #define CTLS2 (1 << 19)
367 #define CTLS (CTLS1 | CTLS2)
368 #define ALTS1 (1 << 20)
369 #define ALTS2 (1 << 21)
370 #define ALTS (ALTS1 | ALTS2)
371 #define AGRS1 (1 << 22)
372 #define AGRS2 (1 << 23)
373 #define AGRS (AGRS1 | AGRS2)
374 #define METAS1 (1 << 24)
375 #define METAS2 (1 << 25)
376 #define METAS (METAS1 | METAS2)
377 #define NLKDOWN (1 << 26)
378 #define SLKDOWN (1 << 27)
379 #define CLKDOWN (1 << 28)
380 #define ALKDOWN (1 << 29)
381 #define SHIFTAON (1 << 30)
382 /* lock key state (defined in sys/kbio.h) */
384 #define CLKED LED_CAP
385 #define NLKED LED_NUM
386 #define SLKED LED_SCR
387 #define ALKED (1 << 3)
388 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED)
389 #define LED_CAP (1 << 0)
390 #define LED_NUM (1 << 1)
391 #define LED_SCR (1 << 2)
392 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR)
395 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg);
396 int genkbd_keyaction(keyboard_t *kbd, int keycode, int up,
397 int *shiftstate, int *accents);
399 #endif /* !_DEV_KBD_KBDREG_H_ */