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 * $Id: $ 27 */ 28 29 #ifndef _DEV_KBD_KBDREG_H_ 30 #define _DEV_KBD_KBDREG_H_ 31 32 /* forward declarations */ 33 typedef struct keyboard keyboard_t; 34 struct keymap; 35 struct accentmap; 36 struct fkeytab; 37 38 /* call back funcion */ 39 typedef int kbd_callback_func_t(keyboard_t *kbd, int event, 40 void *arg); 41 /* event types */ 42 #define KBDIO_KEYINPUT 0 43 #define KBDIO_UNLOADING 1 44 45 typedef struct keyboard_callback { 46 kbd_callback_func_t *kc_func; 47 void *kc_arg; 48 } keyboard_callback_t; 49 50 /* keyboard */ 51 struct keyboard { 52 /* the following fields are managed by kbdio */ 53 int kb_index; /* kbdio index# */ 54 int kb_minor; /* minor number of the sub-device */ 55 int kb_flags; /* internal flags */ 56 #define KB_VALID (1 << 16) /* this entry is valid */ 57 #define KB_NO_DEVICE (1 << 17) /* device not present */ 58 #define KB_PROBED (1 << 18) /* device probed */ 59 #define KB_INITIALIZED (1 << 19) /* device initialized */ 60 #define KB_REGISTERED (1 << 20) /* device registered to kbdio */ 61 #define KB_BUSY (1 << 21) /* device used by a client */ 62 int kb_active; /* 0: inactive */ 63 void *kb_token; /* id of the current client */ 64 keyboard_callback_t kb_callback;/* callback function */ 65 66 /* 67 * Device configuration flags: 68 * The upper 16 bits are common between various keyboard devices. 69 * The lower 16 bits are device-specific. 70 */ 71 int kb_config; 72 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */ 73 74 /* the following fields are set up by the driver */ 75 char *kb_name; /* driver name */ 76 int kb_unit; /* unit # */ 77 int kb_type; /* KB_84, KB_101, KB_OTHER,... */ 78 int kb_io_base; /* port# if any */ 79 int kb_io_size; /* # of occupied port */ 80 int kb_led; /* LED status */ 81 struct keymap *kb_keymap; /* key map */ 82 struct accentmap *kb_accentmap; /* accent map */ 83 struct fkeytab *kb_fkeytab; /* function key strings */ 84 int kb_fkeytab_size;/* # of function key strings */ 85 void *kb_data; /* the driver's private data */ 86 }; 87 88 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID) 89 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID) 90 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID) 91 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE)) 92 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE) 93 #define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED) 94 #define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED) 95 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED) 96 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED) 97 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED) 98 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED) 99 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY) 100 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY) 101 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY) 102 #define KBD_IS_ACTIVE(k) ((k)->kb_active) 103 #define KBD_ACTIVATE(k) (++(k)->kb_active) 104 #define KBD_DEACTIVATE(k) (--(k)->kb_active) 105 #define KBD_LED_VAL(k) ((k)->kb_led) 106 107 /* keyboard function table */ 108 typedef int kbd_probe_t(int unit, keyboard_t **kbdp, void *arg, 109 int flags); 110 typedef int kbd_init_t(keyboard_t *kbd); 111 typedef int kbd_term_t(keyboard_t *kbd); 112 typedef int kbd_intr_t(keyboard_t *kbd, void *arg); 113 typedef int kbd_test_if_t(keyboard_t *kbd); 114 typedef int kbd_enable_t(keyboard_t *kbd); 115 typedef int kbd_disable_t(keyboard_t *kbd); 116 typedef int kbd_read_t(keyboard_t *kbd, int wait); 117 typedef int kbd_check_t(keyboard_t *kbd); 118 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait); 119 typedef int kbd_check_char_t(keyboard_t *kbd); 120 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data); 121 typedef int kbd_lock_t(keyboard_t *kbd, int lock); 122 typedef void kbd_clear_state_t(keyboard_t *kbd); 123 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len); 124 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len); 125 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey, 126 size_t *len); 127 typedef void kbd_diag_t(keyboard_t *kbd, int level); 128 129 typedef struct keyboard_switch { 130 kbd_probe_t *probe; 131 kbd_init_t *init; 132 kbd_term_t *term; 133 kbd_intr_t *intr; 134 kbd_test_if_t *test_if; 135 kbd_enable_t *enable; 136 kbd_disable_t *disable; 137 kbd_read_t *read; 138 kbd_check_t *check; 139 kbd_read_char_t *read_char; 140 kbd_check_char_t *check_char; 141 kbd_ioctl_t *ioctl; 142 kbd_lock_t *lock; 143 kbd_clear_state_t *clear_state; 144 kbd_get_state_t *get_state; 145 kbd_set_state_t *set_state; 146 kbd_get_fkeystr_t *get_fkeystr; 147 kbd_diag_t *diag; 148 } keyboard_switch_t; 149 150 /* keyboard driver */ 151 typedef struct keyboard_driver { 152 char *name; 153 keyboard_switch_t *kbdsw; 154 int (*configure)(int); /* backdoor for the console driver */ 155 } keyboard_driver_t; 156 157 #ifdef KERNEL 158 159 #define KEYBOARD_DRIVER(name, sw, config) \ 160 static struct keyboard_driver name##_driver = { \ 161 #name, &sw, config \ 162 }; \ 163 DATA_SET(kbddriver_set, name##_driver); 164 165 /* global variables */ 166 extern keyboard_switch_t **kbdsw; 167 extern struct linker_set kbddriver_set; 168 169 /* functions for the keyboard driver */ 170 int kbd_register(keyboard_t *kbd); 171 int kbd_unregister(keyboard_t *kbd); 172 keyboard_switch_t *kbd_get_switch(char *driver); 173 void kbd_init_struct(keyboard_t *kbd, char *name, int type, 174 int unit, int config, int port, 175 int port_size); 176 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap, 177 struct accentmap *accmap, 178 struct fkeytab *fkeymap, int fkeymap_size); 179 180 /* functions for the keyboard client */ 181 int kbd_allocate(char *driver, int unit, void *id, 182 kbd_callback_func_t *func, void *arg); 183 int kbd_release(keyboard_t *kbd, void *id); 184 int kbd_change_callback(keyboard_t *kbd, void *id, 185 kbd_callback_func_t *func, void *arg); 186 int kbd_find_keyboard(char *driver, int unit); 187 keyboard_t *kbd_get_keyboard(int index); 188 189 /* a back door for the console driver to tickle the keyboard driver XXX */ 190 int kbd_configure(int flags); 191 /* see `kb_config' above for flag bit definitions */ 192 193 #ifdef KBD_INSTALL_CDEV 194 195 /* virtual keyboard cdev driver functions */ 196 197 int kbd_attach(dev_t dev, keyboard_t *kbd, 198 struct cdevsw *sw); 199 int kbd_detach(dev_t dev, keyboard_t *kbd, 200 struct cdevsw *sw); 201 202 /* generic keyboard cdev driver functions */ 203 204 typedef struct genkbd_softc { 205 int gkb_flags; /* flag/status bits */ 206 #define KB_ASLEEP (1 << 0) 207 struct clist gkb_q; /* input queue */ 208 struct selinfo gkb_rsel; 209 } genkbd_softc_t; 210 211 int genkbdopen(genkbd_softc_t *sc, keyboard_t *kbd, int flag, int mode, 212 struct proc *p); 213 int genkbdclose(genkbd_softc_t *sc, keyboard_t *kbd, int flag, int mode, 214 struct proc *p); 215 int genkbdread(genkbd_softc_t *sc, keyboard_t *kbd, struct uio *uio, 216 int flag); 217 int genkbdwrite(genkbd_softc_t *sc, keyboard_t *kbd, struct uio *uio, 218 int flag); 219 int genkbdioctl(genkbd_softc_t *sc, keyboard_t *kbd, u_long cmd, 220 caddr_t arg, int flag, struct proc *p); 221 int genkbdpoll(genkbd_softc_t *sc, keyboard_t *kbd, int event, 222 struct proc *p); 223 224 #endif /* KBD_INSTALL_CDEV */ 225 226 /* generic low-level keyboard functions */ 227 228 /* shift key state */ 229 #define SHIFTS1 (1 << 16) 230 #define SHIFTS2 (1 << 17) 231 #define SHIFTS (SHIFTS1 | SHIFTS2) 232 #define CTLS1 (1 << 18) 233 #define CTLS2 (1 << 19) 234 #define CTLS (CTLS1 | CTLS2) 235 #define ALTS1 (1 << 20) 236 #define ALTS2 (1 << 21) 237 #define ALTS (ALTS1 | ALTS2) 238 #define AGRS1 (1 << 22) 239 #define AGRS2 (1 << 23) 240 #define AGRS (AGRS1 | AGRS2) 241 #define METAS1 (1 << 24) 242 #define METAS2 (1 << 25) 243 #define METAS (METAS1 | METAS2) 244 #define NLKDOWN (1 << 26) 245 #define SLKDOWN (1 << 27) 246 #define CLKDOWN (1 << 28) 247 #define ALKDOWN (1 << 29) 248 /* lock key state (defined in machine/console.h) */ 249 /* 250 #define CLKED LED_CAP 251 #define NLKED LED_NUM 252 #define SLKED LED_SCR 253 #define ALKED (1 << 3) 254 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED) 255 #define LED_CAP (1 << 0) 256 #define LED_NUM (1 << 1) 257 #define LED_SCR (1 << 2) 258 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR) 259 */ 260 261 kbd_get_fkeystr_t genkbd_get_fkeystr; 262 kbd_diag_t genkbd_diag; 263 264 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg); 265 int genkbd_keyaction(keyboard_t *kbd, int keycode, int down, 266 int *shiftstate, int *accents); 267 268 #endif /* KERNEL */ 269 270 #endif /* !_DEV_KBD_KBDREG_H_ */ 271