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