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