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.5 2004/09/19 02:15:44 dillon Exp $ 28 */ 29 30 #ifndef _DEV_KBD_KBDREG_H_ 31 #define _DEV_KBD_KBDREG_H_ 32 33 /* forward declarations */ 34 typedef struct keyboard keyboard_t; 35 struct keymap; 36 struct accentmap; 37 struct fkeytab; 38 struct cdevsw; 39 40 /* call back funcion */ 41 typedef int kbd_callback_func_t(keyboard_t *kbd, int event, 42 void *arg); 43 /* event types */ 44 #define KBDIO_KEYINPUT 0 45 #define KBDIO_UNLOADING 1 46 47 typedef struct keyboard_callback { 48 kbd_callback_func_t *kc_func; 49 void *kc_arg; 50 } keyboard_callback_t; 51 52 /* keyboard */ 53 struct keyboard { 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 */ 67 68 /* 69 * Device configuration flags: 70 * The upper 16 bits are common between various keyboard devices. 71 * The lower 16 bits are device-specific. 72 */ 73 int kb_config; 74 #define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */ 75 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 */ 88 int kb_delay1; 89 int kb_delay2; 90 #define KB_DELAY1 500 91 #define KB_DELAY2 100 92 unsigned long kb_count; /* # of processed key strokes */ 93 int kb_pref; /* keyboard preference */ 94 u_char kb_lastact[NUM_KEYS/2]; 95 struct callout kb_atkbd_timeout_ch; 96 }; 97 98 #define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID) 99 #define KBD_VALID(k) ((k)->kb_flags |= KB_VALID) 100 #define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID) 101 #define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE)) 102 #define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE) 103 #define KBD_LOST_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_LOST_PROBE(k) ((k)->kb_flags &= ~KB_PROBED) 107 #define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED) 108 #define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED) 109 #define KBD_LOST_INIT(k) ((k)->kb_flags &= ~KB_INITIALIZED) 110 #define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED) 111 #define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED) 112 #define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY) 113 #define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY) 114 #define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY) 115 #define KBD_IS_ACTIVE(k) ((k)->kb_active) 116 #define KBD_ACTIVATE(k) (++(k)->kb_active) 117 #define KBD_DEACTIVATE(k) (--(k)->kb_active) 118 #define KBD_LED_VAL(k) ((k)->kb_led) 119 120 /* keyboard function table */ 121 typedef int kbd_probe_t(int unit, void *arg, int flags); 122 typedef int kbd_init_t(int unit, keyboard_t **kbdp, void *arg, 123 int flags); 124 typedef int kbd_term_t(keyboard_t *kbd); 125 typedef int kbd_intr_t(keyboard_t *kbd, void *arg); 126 typedef int kbd_test_if_t(keyboard_t *kbd); 127 typedef int kbd_enable_t(keyboard_t *kbd); 128 typedef int kbd_disable_t(keyboard_t *kbd); 129 typedef int kbd_read_t(keyboard_t *kbd, int wait); 130 typedef int kbd_check_t(keyboard_t *kbd); 131 typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait); 132 typedef int kbd_check_char_t(keyboard_t *kbd); 133 typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data); 134 typedef int kbd_lock_t(keyboard_t *kbd, int lock); 135 typedef void kbd_clear_state_t(keyboard_t *kbd); 136 typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len); 137 typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len); 138 typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey, 139 size_t *len); 140 typedef int kbd_poll_mode_t(keyboard_t *kbd, int on); 141 typedef void kbd_diag_t(keyboard_t *kbd, int level); 142 143 typedef struct keyboard_switch { 144 kbd_probe_t *probe; 145 kbd_init_t *init; 146 kbd_term_t *term; 147 kbd_intr_t *intr; 148 kbd_test_if_t *test_if; 149 kbd_enable_t *enable; 150 kbd_disable_t *disable; 151 kbd_read_t *read; 152 kbd_check_t *check; 153 kbd_read_char_t *read_char; 154 kbd_check_char_t *check_char; 155 kbd_ioctl_t *ioctl; 156 kbd_lock_t *lock; 157 kbd_clear_state_t *clear_state; 158 kbd_get_state_t *get_state; 159 kbd_set_state_t *set_state; 160 kbd_get_fkeystr_t *get_fkeystr; 161 kbd_poll_mode_t *poll; 162 kbd_diag_t *diag; 163 } keyboard_switch_t; 164 165 /* keyboard driver */ 166 typedef struct keyboard_driver { 167 SLIST_ENTRY(keyboard_driver) link; 168 char *name; 169 keyboard_switch_t *kbdsw; 170 int (*configure)(int); /* backdoor for the console driver */ 171 } keyboard_driver_t; 172 173 #ifdef _KERNEL 174 175 #define KEYBOARD_DRIVER(name, sw, config) \ 176 static struct keyboard_driver name##_kbd_driver = { \ 177 { NULL }, #name, &sw, config \ 178 }; \ 179 DATA_SET(kbddriver_set, name##_kbd_driver); 180 181 /* global variables */ 182 extern keyboard_switch_t **kbdsw; 183 184 /* functions for the keyboard driver */ 185 int kbd_add_driver(keyboard_driver_t *driver); 186 int kbd_delete_driver(keyboard_driver_t *driver); 187 int kbd_register(keyboard_t *kbd); 188 int kbd_unregister(keyboard_t *kbd); 189 keyboard_switch_t *kbd_get_switch(char *driver); 190 void kbd_init_struct(keyboard_t *kbd, char *name, int type, 191 int unit, int config, int pref, 192 int port, int port_size); 193 void kbd_reinit_struct(keyboard_t *kbd, 194 int config, int pref); 195 void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap, 196 struct accentmap *accmap, 197 struct fkeytab *fkeymap, int fkeymap_size); 198 199 /* functions for the keyboard client */ 200 int kbd_allocate(char *driver, int unit, void *id, 201 kbd_callback_func_t *func, void *arg); 202 int kbd_release(keyboard_t *kbd, void *id); 203 int kbd_change_callback(keyboard_t *kbd, void *id, 204 kbd_callback_func_t *func, void *arg); 205 int kbd_find_keyboard(char *driver, int unit); 206 keyboard_t *kbd_get_keyboard(int index); 207 208 /* a back door for the console driver to tickle the keyboard driver XXX */ 209 int kbd_configure(int flags); 210 /* see `kb_config' above for flag bit definitions */ 211 212 #ifdef KBD_INSTALL_CDEV 213 214 /* virtual keyboard cdev driver functions */ 215 int kbd_attach(keyboard_t *kbd); 216 int kbd_detach(keyboard_t *kbd); 217 218 #endif /* KBD_INSTALL_CDEV */ 219 220 /* generic low-level keyboard functions */ 221 222 /* shift key state */ 223 #define SHIFTS1 (1 << 16) 224 #define SHIFTS2 (1 << 17) 225 #define SHIFTS (SHIFTS1 | SHIFTS2) 226 #define CTLS1 (1 << 18) 227 #define CTLS2 (1 << 19) 228 #define CTLS (CTLS1 | CTLS2) 229 #define ALTS1 (1 << 20) 230 #define ALTS2 (1 << 21) 231 #define ALTS (ALTS1 | ALTS2) 232 #define AGRS1 (1 << 22) 233 #define AGRS2 (1 << 23) 234 #define AGRS (AGRS1 | AGRS2) 235 #define METAS1 (1 << 24) 236 #define METAS2 (1 << 25) 237 #define METAS (METAS1 | METAS2) 238 #define NLKDOWN (1 << 26) 239 #define SLKDOWN (1 << 27) 240 #define CLKDOWN (1 << 28) 241 #define ALKDOWN (1 << 29) 242 #define SHIFTAON (1 << 30) 243 /* lock key state (defined in machine/console.h) */ 244 /* 245 #define CLKED LED_CAP 246 #define NLKED LED_NUM 247 #define SLKED LED_SCR 248 #define ALKED (1 << 3) 249 #define LOCK_MASK (CLKED | NLKED | SLKED | ALKED) 250 #define LED_CAP (1 << 0) 251 #define LED_NUM (1 << 1) 252 #define LED_SCR (1 << 2) 253 #define LED_MASK (LED_CAP | LED_NUM | LED_SCR) 254 */ 255 256 #define KB_PRI_ATKBD 50 257 #define KB_PRI_USB 60 258 259 kbd_get_fkeystr_t genkbd_get_fkeystr; 260 kbd_diag_t genkbd_diag; 261 262 int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg); 263 int genkbd_keyaction(keyboard_t *kbd, int keycode, int up, 264 int *shiftstate, int *accents); 265 266 #endif /* _KERNEL */ 267 268 #endif /* !_DEV_KBD_KBDREG_H_ */ 269