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 * $FreeBSD: src/sys/dev/kbd/kbdreg.h,v 1.9.2.2 2001/07/30 16:46:44 yokota Exp $ 27 */ 28 29 #ifndef _DEV_KBD_KBDREG_H_ 30 #define _DEV_KBD_KBDREG_H_ 31 32 #ifndef _SYS_LOCK_H_ 33 #include <sys/lock.h> 34 #endif 35 36 /* forward declarations */ 37 typedef struct keyboard keyboard_t; 38 struct keymap; 39 struct accentmap; 40 struct fkeytab; 41 struct cdevsw; 42 43 /* call back funcion */ 44 typedef int kbd_callback_func_t(keyboard_t *kbd, int event, 45 void *arg); 46 /* event types */ 47 #define KBDIO_KEYINPUT 0 48 #define KBDIO_UNLOADING 1 49 50 typedef struct keyboard_callback { 51 kbd_callback_func_t *kc_func; 52 void *kc_arg; 53 } keyboard_callback_t; 54 55 /* keyboard */ 56 struct keyboard { 57 /* the following fields are managed by kbdio */ 58 int kb_index; /* kbdio index# */ 59 int kb_minor; /* minor number of the sub-device */ 60 int kb_flags; /* internal flags */ 61 cdev_t kb_dev; /* related devfs dev */ 62 #define KB_VALID (1 << 16) /* this entry is valid */ 63 #define KB_NO_DEVICE (1 << 17) /* device not present */ 64 #define KB_PROBED (1 << 18) /* device probed */ 65 #define KB_INITIALIZED (1 << 19) /* device initialized */ 66 #define KB_REGISTERED (1 << 20) /* device registered to kbdio */ 67 #define KB_BUSY (1 << 21) /* device used by a client */ 68 #define KB_POLLED (1 << 22) /* device is polled */ 69 int kb_active; /* 0: inactive */ 70 void *kb_token; /* id of the current client */ 71 keyboard_callback_t kb_callback;/* callback function */ 72 73 /* 74 * Device configuration flags: 75 * The upper 16 bits are common between various keyboard devices. 76 * The lower 16 bits are device-specific. 77 */ 78 int kb_config; 79 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */ 80 81 /* the following fields are set up by the driver */ 82 char *kb_name; /* driver name */ 83 int kb_unit; /* unit # */ 84 int kb_type; /* KB_84, KB_101, KB_OTHER,... */ 85 int kb_io_base; /* port# if any */ 86 int kb_io_size; /* # of occupied port */ 87 int kb_led; /* LED status */ 88 int kb_savemode; /* device specific (used by usb) */ 89 struct keymap *kb_keymap; /* key map */ 90 struct accentmap *kb_accentmap; /* accent map */ 91 struct fkeytab *kb_fkeytab; /* function key strings */ 92 int kb_fkeytab_size;/* # of function key strings */ 93 void *kb_data; /* the driver's private data */ 94 int kb_delay1; 95 int kb_delay2; 96 #define KB_DELAY1 500 97 #define KB_DELAY2 100 98 unsigned long kb_count; /* # of processed key strokes */ 99 int kb_pref; /* keyboard preference */ 100 u_char kb_lastact[NUM_KEYS/2]; 101 struct callout kb_atkbd_timeout_ch; 102 struct lock kb_lock; 103 }; 104 105 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID) 106 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID) 107 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID) 108 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE)) 109 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE) 110 #define KBD_LOST_DEVICE(k) ((k)->kb_flags |= KB_NO_DEVICE) 111 #define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED) 112 #define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED) 113 #define KBD_LOST_PROBE(k) ((k)->kb_flags &= ~KB_PROBED) 114 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED) 115 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED) 116 #define KBD_LOST_INIT(k) ((k)->kb_flags &= ~KB_INITIALIZED) 117 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED) 118 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED) 119 #define KBD_CONFIG_LOST(k) ((k)->kb_flags &= ~KB_REGISTERED) 120 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY) 121 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY) 122 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY) 123 #define KBD_IS_POLLED(k) ((k)->kb_flags & KB_POLLED) 124 #define KBD_POLL(k) ((k)->kb_flags |= KB_POLLED) 125 #define KBD_UNPOLL(k) ((k)->kb_flags &= ~KB_POLLED) 126 #define KBD_IS_ACTIVE(k) ((k)->kb_active) 127 #define KBD_ACTIVATE(k) (++(k)->kb_active) 128 #define KBD_DEACTIVATE(k) (--(k)->kb_active) 129 #define KBD_LED_VAL(k) ((k)->kb_led) 130 131 #define KBD_MAXKEYBOARDS 16 132 133 /* Locking functions */ 134 135 #define KBD_LOCK_DECLARE int dont_lock 136 137 #define KBD_LOCK(k) \ 138 do { \ 139 dont_lock = (k)->kb_flags & KB_POLLED; \ 140 if (dont_lock == 0) \ 141 lockmgr(&(k)->kb_lock, LK_EXCLUSIVE); \ 142 } while (0) 143 144 #define KBD_UNLOCK(k) \ 145 do { \ 146 if (dont_lock == 0) \ 147 lockmgr(&(k)->kb_lock, LK_RELEASE); \ 148 } while (0) 149 150 #define KBD_LOCK_ASSERT(k) \ 151 KKASSERT(((k)->kb_flags & KB_POLLED) || \ 152 lockstatus(&(k)->kb_lock, curthread) == LK_EXCLUSIVE) 153 154 #define KBD_ALWAYS_LOCK(k) \ 155 lockmgr(&(k)->kb_lock, LK_EXCLUSIVE); \ 156 157 #define KBD_ALWAYS_UNLOCK(k) \ 158 lockmgr(&(k)->kb_lock, LK_RELEASE); \ 159 160 /* keyboard function table */ 161 typedef int kbd_probe_t(int unit, void *arg, int flags); 162 typedef int kbd_init_t(int unit, keyboard_t **kbdp, 163 void *arg, int flags); 164 typedef int kbd_term_t(keyboard_t *kbd); 165 typedef int kbd_intr_t(keyboard_t *kbd, void *arg); 166 typedef int kbd_test_if_t(keyboard_t *kbd); 167 typedef int kbd_enable_t(keyboard_t *kbd); 168 typedef int kbd_disable_t(keyboard_t *kbd); 169 typedef int kbd_read_t(keyboard_t *kbd, int wait); 170 typedef int kbd_check_t(keyboard_t *kbd); 171 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait); 172 typedef int kbd_check_char_t(keyboard_t *kbd); 173 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data); 174 typedef int kbd_lock_t(keyboard_t *kbd, int lock); 175 typedef void kbd_clear_state_t(keyboard_t *kbd); 176 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len); 177 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len); 178 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey, 179 size_t *len); 180 typedef int kbd_poll_mode_t(keyboard_t *kbd, int on); 181 typedef void kbd_diag_t(keyboard_t *kbd, int level); 182 183 typedef struct keyboard_switch { 184 kbd_probe_t *probe; 185 kbd_init_t *init; 186 kbd_term_t *term; 187 kbd_intr_t *intr; 188 kbd_test_if_t *test_if; 189 kbd_enable_t *enable; 190 kbd_disable_t *disable; 191 kbd_read_t *read; 192 kbd_check_t *check; 193 kbd_read_char_t *read_char; 194 kbd_check_char_t *check_char; 195 kbd_ioctl_t *ioctl; 196 kbd_lock_t *lock; 197 kbd_clear_state_t *clear_state; 198 kbd_get_state_t *get_state; 199 kbd_set_state_t *set_state; 200 kbd_get_fkeystr_t *get_fkeystr; 201 kbd_poll_mode_t *poll; 202 kbd_diag_t *diag; 203 } keyboard_switch_t; 204 205 int sw_probe(keyboard_switch_t *sw, int unit, void *arg, int flags); 206 int sw_init(keyboard_switch_t *sw, int unit, keyboard_t **kbdpp, 207 void *arg, int flags); 208 209 kbd_term_t kbd_term; 210 kbd_intr_t kbd_intr; 211 kbd_test_if_t kbd_test_if; 212 kbd_enable_t kbd_enable; 213 kbd_disable_t kbd_disable; 214 kbd_read_t kbd_read; 215 kbd_check_t kbd_check; 216 kbd_read_char_t kbd_read_char; 217 kbd_check_char_t kbd_check_char; 218 kbd_ioctl_t kbd_ioctl; 219 kbd_lock_t kbd_lock; 220 kbd_clear_state_t kbd_clear_state; 221 kbd_get_state_t kbd_get_state; 222 kbd_set_state_t kbd_set_state; 223 kbd_get_fkeystr_t kbd_get_fkeystr; 224 kbd_poll_mode_t kbd_poll; 225 kbd_diag_t kbd_diag; 226 227 /* keyboard driver */ 228 typedef struct keyboard_driver { 229 SLIST_ENTRY(keyboard_driver) link; 230 char *name; 231 keyboard_switch_t *kbdsw; 232 int (*configure)(int); /* backdoor for the console driver */ 233 } keyboard_driver_t; 234 235 #ifdef _KERNEL 236 237 #define KEYBOARD_DRIVER(name, sw, config) \ 238 static struct keyboard_driver name##_kbd_driver = { \ 239 { NULL }, #name, &sw, config \ 240 }; \ 241 DATA_SET(kbddriver_set, name##_kbd_driver) 242 243 /* global variables */ 244 extern keyboard_switch_t *kbdsw[KBD_MAXKEYBOARDS]; 245 246 /* functions for the keyboard driver */ 247 int kbd_add_driver(keyboard_driver_t *driver); 248 int kbd_delete_driver(keyboard_driver_t *driver); 249 int kbd_register(keyboard_t *kbd); 250 int kbd_unregister(keyboard_t *kbd); 251 keyboard_switch_t *kbd_get_switch(char *driver); 252 void kbd_init_struct(keyboard_t *kbd, char *name, int type, 253 int unit, int config, int pref, 254 int port, int port_size); 255 void kbd_reinit_struct(keyboard_t *kbd, 256 int config, int pref); 257 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap, 258 struct accentmap *accmap, 259 struct fkeytab *fkeymap, int fkeymap_size); 260 261 /* functions for the keyboard client */ 262 int kbd_allocate(char *driver, int unit, void *id, 263 kbd_callback_func_t *func, void *arg); 264 int kbd_release(keyboard_t *kbd, void *id); 265 int kbd_change_callback(keyboard_t *kbd, void *id, 266 kbd_callback_func_t *func, void *arg); 267 int kbd_find_keyboard(char *driver, int unit); 268 int kbd_find_keyboard2(char *driver, int unit, int index, int legacy); 269 keyboard_t *kbd_get_keyboard(int index); 270 271 /* a back door for the console driver to tickle the keyboard driver XXX */ 272 int kbd_configure(int flags); 273 /* see `kb_config' above for flag bit definitions */ 274 275 #ifdef KBD_INSTALL_CDEV 276 277 /* virtual keyboard cdev driver functions */ 278 int kbd_attach(keyboard_t *kbd); 279 int kbd_detach(keyboard_t *kbd); 280 281 #endif /* KBD_INSTALL_CDEV */ 282 283 /* generic low-level keyboard functions */ 284 285 /* shift key state */ 286 #define SHIFTS1 (1 << 16) 287 #define SHIFTS2 (1 << 17) 288 #define SHIFTS (SHIFTS1 | SHIFTS2) 289 #define CTLS1 (1 << 18) 290 #define CTLS2 (1 << 19) 291 #define CTLS (CTLS1 | CTLS2) 292 #define ALTS1 (1 << 20) 293 #define ALTS2 (1 << 21) 294 #define ALTS (ALTS1 | ALTS2) 295 #define AGRS1 (1 << 22) 296 #define AGRS2 (1 << 23) 297 #define AGRS (AGRS1 | AGRS2) 298 #define METAS1 (1 << 24) 299 #define METAS2 (1 << 25) 300 #define METAS (METAS1 | METAS2) 301 #define NLKDOWN (1 << 26) 302 #define SLKDOWN (1 << 27) 303 #define CLKDOWN (1 << 28) 304 #define ALKDOWN (1 << 29) 305 #define SHIFTAON (1 << 30) 306 /* lock key state (defined in machine/console.h) */ 307 /* 308 #define CLKED LED_CAP 309 #define NLKED LED_NUM 310 #define SLKED LED_SCR 311 #define ALKED (1 << 3) 312 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED) 313 #define LED_CAP (1 << 0) 314 #define LED_NUM (1 << 1) 315 #define LED_SCR (1 << 2) 316 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR) 317 */ 318 319 #define KB_PRI_MUX 10 320 #define KB_PRI_ATKBD 50 321 #define KB_PRI_USB 60 322 323 kbd_get_fkeystr_t genkbd_get_fkeystr; 324 kbd_diag_t genkbd_diag; 325 326 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg); 327 int genkbd_keyaction(keyboard_t *kbd, int keycode, int up, 328 int *shiftstate, int *accents); 329 330 #endif /* _KERNEL */ 331 332 #endif /* !_DEV_KBD_KBDREG_H_ */ 333