2 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
26 * $FreeBSD: src/sys/dev/kbd/kbdreg.h,v 1.9.2.2 2001/07/30 16:46:44 yokota Exp $
27 * $DragonFly: src/sys/dev/misc/kbd/kbdreg.h,v 1.3 2003/11/10 06:12:05 dillon Exp $
30 #ifndef _DEV_KBD_KBDREG_H_
31 #define _DEV_KBD_KBDREG_H_
33 /* forward declarations */
34 typedef struct keyboard keyboard_t;
40 /* call back funcion */
41 typedef int kbd_callback_func_t(keyboard_t *kbd, int event,
44 #define KBDIO_KEYINPUT 0
45 #define KBDIO_UNLOADING 1
47 typedef struct keyboard_callback {
48 kbd_callback_func_t *kc_func;
50 } keyboard_callback_t;
54 /* the following fields are managed by kbdio */
55 int kb_index; /* kbdio index# */
56 int kb_minor; /* minor number of the sub-device */
57 int kb_flags; /* internal flags */
58 #define KB_VALID (1 << 16) /* this entry is valid */
59 #define KB_NO_DEVICE (1 << 17) /* device not present */
60 #define KB_PROBED (1 << 18) /* device probed */
61 #define KB_INITIALIZED (1 << 19) /* device initialized */
62 #define KB_REGISTERED (1 << 20) /* device registered to kbdio */
63 #define KB_BUSY (1 << 21) /* device used by a client */
64 int kb_active; /* 0: inactive */
65 void *kb_token; /* id of the current client */
66 keyboard_callback_t kb_callback;/* callback function */
69 * Device configuration flags:
70 * The upper 16 bits are common between various keyboard devices.
71 * The lower 16 bits are device-specific.
74 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */
76 /* the following fields are set up by the driver */
77 char *kb_name; /* driver name */
78 int kb_unit; /* unit # */
79 int kb_type; /* KB_84, KB_101, KB_OTHER,... */
80 int kb_io_base; /* port# if any */
81 int kb_io_size; /* # of occupied port */
82 int kb_led; /* LED status */
83 struct keymap *kb_keymap; /* key map */
84 struct accentmap *kb_accentmap; /* accent map */
85 struct fkeytab *kb_fkeytab; /* function key strings */
86 int kb_fkeytab_size;/* # of function key strings */
87 void *kb_data; /* the driver's private data */
92 unsigned long kb_count; /* # of processed key strokes */
93 u_char kb_lastact[NUM_KEYS/2];
96 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID)
97 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID)
98 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID)
99 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE))
100 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE)
101 #define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED)
102 #define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED)
103 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED)
104 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED)
105 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED)
106 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED)
107 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY)
108 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY)
109 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY)
110 #define KBD_IS_ACTIVE(k) ((k)->kb_active)
111 #define KBD_ACTIVATE(k) (++(k)->kb_active)
112 #define KBD_DEACTIVATE(k) (--(k)->kb_active)
113 #define KBD_LED_VAL(k) ((k)->kb_led)
115 /* keyboard function table */
116 typedef int kbd_probe_t(int unit, void *arg, int flags);
117 typedef int kbd_init_t(int unit, keyboard_t **kbdp, void *arg,
119 typedef int kbd_term_t(keyboard_t *kbd);
120 typedef int kbd_intr_t(keyboard_t *kbd, void *arg);
121 typedef int kbd_test_if_t(keyboard_t *kbd);
122 typedef int kbd_enable_t(keyboard_t *kbd);
123 typedef int kbd_disable_t(keyboard_t *kbd);
124 typedef int kbd_read_t(keyboard_t *kbd, int wait);
125 typedef int kbd_check_t(keyboard_t *kbd);
126 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait);
127 typedef int kbd_check_char_t(keyboard_t *kbd);
128 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data);
129 typedef int kbd_lock_t(keyboard_t *kbd, int lock);
130 typedef void kbd_clear_state_t(keyboard_t *kbd);
131 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len);
132 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len);
133 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey,
135 typedef int kbd_poll_mode_t(keyboard_t *kbd, int on);
136 typedef void kbd_diag_t(keyboard_t *kbd, int level);
138 typedef struct keyboard_switch {
143 kbd_test_if_t *test_if;
144 kbd_enable_t *enable;
145 kbd_disable_t *disable;
148 kbd_read_char_t *read_char;
149 kbd_check_char_t *check_char;
152 kbd_clear_state_t *clear_state;
153 kbd_get_state_t *get_state;
154 kbd_set_state_t *set_state;
155 kbd_get_fkeystr_t *get_fkeystr;
156 kbd_poll_mode_t *poll;
160 /* keyboard driver */
161 typedef struct keyboard_driver {
162 SLIST_ENTRY(keyboard_driver) link;
164 keyboard_switch_t *kbdsw;
165 int (*configure)(int); /* backdoor for the console driver */
170 #define KEYBOARD_DRIVER(name, sw, config) \
171 static struct keyboard_driver name##_kbd_driver = { \
172 { NULL }, #name, &sw, config \
174 DATA_SET(kbddriver_set, name##_kbd_driver);
176 /* global variables */
177 extern keyboard_switch_t **kbdsw;
179 /* functions for the keyboard driver */
180 int kbd_add_driver(keyboard_driver_t *driver);
181 int kbd_delete_driver(keyboard_driver_t *driver);
182 int kbd_register(keyboard_t *kbd);
183 int kbd_unregister(keyboard_t *kbd);
184 keyboard_switch_t *kbd_get_switch(char *driver);
185 void kbd_init_struct(keyboard_t *kbd, char *name, int type,
186 int unit, int config, int port,
188 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap,
189 struct accentmap *accmap,
190 struct fkeytab *fkeymap, int fkeymap_size);
192 /* functions for the keyboard client */
193 int kbd_allocate(char *driver, int unit, void *id,
194 kbd_callback_func_t *func, void *arg);
195 int kbd_release(keyboard_t *kbd, void *id);
196 int kbd_change_callback(keyboard_t *kbd, void *id,
197 kbd_callback_func_t *func, void *arg);
198 int kbd_find_keyboard(char *driver, int unit);
199 keyboard_t *kbd_get_keyboard(int index);
201 /* a back door for the console driver to tickle the keyboard driver XXX */
202 int kbd_configure(int flags);
203 /* see `kb_config' above for flag bit definitions */
205 #ifdef KBD_INSTALL_CDEV
207 /* virtual keyboard cdev driver functions */
208 int kbd_attach(keyboard_t *kbd);
209 int kbd_detach(keyboard_t *kbd);
211 #endif /* KBD_INSTALL_CDEV */
213 /* generic low-level keyboard functions */
215 /* shift key state */
216 #define SHIFTS1 (1 << 16)
217 #define SHIFTS2 (1 << 17)
218 #define SHIFTS (SHIFTS1 | SHIFTS2)
219 #define CTLS1 (1 << 18)
220 #define CTLS2 (1 << 19)
221 #define CTLS (CTLS1 | CTLS2)
222 #define ALTS1 (1 << 20)
223 #define ALTS2 (1 << 21)
224 #define ALTS (ALTS1 | ALTS2)
225 #define AGRS1 (1 << 22)
226 #define AGRS2 (1 << 23)
227 #define AGRS (AGRS1 | AGRS2)
228 #define METAS1 (1 << 24)
229 #define METAS2 (1 << 25)
230 #define METAS (METAS1 | METAS2)
231 #define NLKDOWN (1 << 26)
232 #define SLKDOWN (1 << 27)
233 #define CLKDOWN (1 << 28)
234 #define ALKDOWN (1 << 29)
235 #define SHIFTAON (1 << 30)
236 /* lock key state (defined in machine/console.h) */
238 #define CLKED LED_CAP
239 #define NLKED LED_NUM
240 #define SLKED LED_SCR
241 #define ALKED (1 << 3)
242 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED)
243 #define LED_CAP (1 << 0)
244 #define LED_NUM (1 << 1)
245 #define LED_SCR (1 << 2)
246 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR)
249 kbd_get_fkeystr_t genkbd_get_fkeystr;
250 kbd_diag_t genkbd_diag;
252 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg);
253 int genkbd_keyaction(keyboard_t *kbd, int keycode, int up,
254 int *shiftstate, int *accents);
258 #endif /* !_DEV_KBD_KBDREG_H_ */