142421Syokota/*- 242421Syokota * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> 342421Syokota * All rights reserved. 442421Syokota * 542421Syokota * Redistribution and use in source and binary forms, with or without 642421Syokota * modification, are permitted provided that the following conditions 742421Syokota * are met: 842421Syokota * 1. Redistributions of source code must retain the above copyright 942421Syokota * notice, this list of conditions and the following disclaimer as 1042421Syokota * the first lines of this file unmodified. 1142421Syokota * 2. Redistributions in binary form must reproduce the above copyright 1242421Syokota * notice, this list of conditions and the following disclaimer in the 1342421Syokota * documentation and/or other materials provided with the distribution. 1442421Syokota * 1542421Syokota * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 1642421Syokota * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1742421Syokota * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 1842421Syokota * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, 1942421Syokota * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2042421Syokota * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2142421Syokota * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2242421Syokota * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2342421Syokota * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2442421Syokota * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2542421Syokota * 2650477Speter * $FreeBSD: releng/10.3/sys/dev/kbd/kbdreg.h 190870 2009-04-09 19:11:08Z emax $ 2742421Syokota */ 2842421Syokota 2942421Syokota#ifndef _DEV_KBD_KBDREG_H_ 3042421Syokota#define _DEV_KBD_KBDREG_H_ 3142421Syokota 3242421Syokota/* forward declarations */ 3342421Syokotatypedef struct keyboard keyboard_t; 3442421Syokotastruct keymap; 3542421Syokotastruct accentmap; 3642421Syokotastruct fkeytab; 3750154Syokotastruct cdevsw; 3842421Syokota 3942421Syokota/* call back funcion */ 4042421Syokotatypedef int kbd_callback_func_t(keyboard_t *kbd, int event, 4142421Syokota void *arg); 4242421Syokota/* event types */ 4342421Syokota#define KBDIO_KEYINPUT 0 4442421Syokota#define KBDIO_UNLOADING 1 4542421Syokota 4642421Syokotatypedef struct keyboard_callback { 4742421Syokota kbd_callback_func_t *kc_func; 4842421Syokota void *kc_arg; 4942421Syokota} keyboard_callback_t; 5042421Syokota 5142421Syokota/* keyboard */ 5242421Syokotastruct keyboard { 5342421Syokota /* the following fields are managed by kbdio */ 5442421Syokota int kb_index; /* kbdio index# */ 5542421Syokota int kb_minor; /* minor number of the sub-device */ 5642421Syokota int kb_flags; /* internal flags */ 5742421Syokota#define KB_VALID (1 << 16) /* this entry is valid */ 5842421Syokota#define KB_NO_DEVICE (1 << 17) /* device not present */ 5942421Syokota#define KB_PROBED (1 << 18) /* device probed */ 6042421Syokota#define KB_INITIALIZED (1 << 19) /* device initialized */ 6142421Syokota#define KB_REGISTERED (1 << 20) /* device registered to kbdio */ 6242421Syokota#define KB_BUSY (1 << 21) /* device used by a client */ 63190869Semax#define KB_POLLED (1 << 22) /* device is polled */ 6442421Syokota int kb_active; /* 0: inactive */ 6542421Syokota void *kb_token; /* id of the current client */ 6642421Syokota keyboard_callback_t kb_callback;/* callback function */ 6742421Syokota 6842421Syokota /* 6942421Syokota * Device configuration flags: 7042421Syokota * The upper 16 bits are common between various keyboard devices. 7142421Syokota * The lower 16 bits are device-specific. 7242421Syokota */ 7342421Syokota int kb_config; 7442421Syokota#define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */ 7542421Syokota 7642421Syokota /* the following fields are set up by the driver */ 7742421Syokota char *kb_name; /* driver name */ 7842421Syokota int kb_unit; /* unit # */ 7942421Syokota int kb_type; /* KB_84, KB_101, KB_OTHER,... */ 8042421Syokota int kb_io_base; /* port# if any */ 8142421Syokota int kb_io_size; /* # of occupied port */ 8242421Syokota int kb_led; /* LED status */ 8342421Syokota struct keymap *kb_keymap; /* key map */ 8442421Syokota struct accentmap *kb_accentmap; /* accent map */ 8542421Syokota struct fkeytab *kb_fkeytab; /* function key strings */ 8642421Syokota int kb_fkeytab_size;/* # of function key strings */ 8742421Syokota void *kb_data; /* the driver's private data */ 8844628Syokota int kb_delay1; 8944628Syokota int kb_delay2; 9044628Syokota#define KB_DELAY1 500 9144628Syokota#define KB_DELAY2 100 9254382Syokota unsigned long kb_count; /* # of processed key strokes */ 9380040Syokota u_char kb_lastact[NUM_KEYS/2]; 94130585Sphk struct cdev *kb_dev; 9542421Syokota}; 9642421Syokota 9742421Syokota#define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID) 9842421Syokota#define KBD_VALID(k) ((k)->kb_flags |= KB_VALID) 9942421Syokota#define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID) 10042421Syokota#define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE)) 10142421Syokota#define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE) 10242421Syokota#define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED) 10342421Syokota#define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED) 10442421Syokota#define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED) 10542421Syokota#define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED) 10642421Syokota#define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED) 10742421Syokota#define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED) 10842421Syokota#define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY) 10942421Syokota#define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY) 11042421Syokota#define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY) 111190869Semax#define KBD_IS_POLLED(k) ((k)->kb_flags & KB_POLLED) 112190869Semax#define KBD_POLL(k) ((k)->kb_flags |= KB_POLLED) 113190869Semax#define KBD_UNPOLL(k) ((k)->kb_flags &= ~KB_POLLED) 11442421Syokota#define KBD_IS_ACTIVE(k) ((k)->kb_active) 11542421Syokota#define KBD_ACTIVATE(k) (++(k)->kb_active) 11642421Syokota#define KBD_DEACTIVATE(k) (--(k)->kb_active) 11742421Syokota#define KBD_LED_VAL(k) ((k)->kb_led) 11842421Syokota 11942421Syokota/* keyboard function table */ 12044628Syokotatypedef int kbd_probe_t(int unit, void *arg, int flags); 12144628Syokotatypedef int kbd_init_t(int unit, keyboard_t **kbdp, void *arg, 12244628Syokota int flags); 12342421Syokotatypedef int kbd_term_t(keyboard_t *kbd); 12444628Syokotatypedef int kbd_intr_t(keyboard_t *kbd, void *arg); 12542421Syokotatypedef int kbd_test_if_t(keyboard_t *kbd); 12642421Syokotatypedef int kbd_enable_t(keyboard_t *kbd); 12742421Syokotatypedef int kbd_disable_t(keyboard_t *kbd); 12842421Syokotatypedef int kbd_read_t(keyboard_t *kbd, int wait); 12942421Syokotatypedef int kbd_check_t(keyboard_t *kbd); 13042421Syokotatypedef u_int kbd_read_char_t(keyboard_t *kbd, int wait); 13142421Syokotatypedef int kbd_check_char_t(keyboard_t *kbd); 13242421Syokotatypedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data); 13342421Syokotatypedef int kbd_lock_t(keyboard_t *kbd, int lock); 13442421Syokotatypedef void kbd_clear_state_t(keyboard_t *kbd); 13542421Syokotatypedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len); 13642421Syokotatypedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len); 13742421Syokotatypedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey, 13842421Syokota size_t *len); 13944628Syokotatypedef int kbd_poll_mode_t(keyboard_t *kbd, int on); 14042421Syokotatypedef void kbd_diag_t(keyboard_t *kbd, int level); 14142421Syokota 14242421Syokotatypedef struct keyboard_switch { 14342421Syokota kbd_probe_t *probe; 14442421Syokota kbd_init_t *init; 14542421Syokota kbd_term_t *term; 14642421Syokota kbd_intr_t *intr; 14742421Syokota kbd_test_if_t *test_if; 14842421Syokota kbd_enable_t *enable; 14942421Syokota kbd_disable_t *disable; 15042421Syokota kbd_read_t *read; 15142421Syokota kbd_check_t *check; 15242421Syokota kbd_read_char_t *read_char; 15342421Syokota kbd_check_char_t *check_char; 15442421Syokota kbd_ioctl_t *ioctl; 15542421Syokota kbd_lock_t *lock; 15642421Syokota kbd_clear_state_t *clear_state; 15742421Syokota kbd_get_state_t *get_state; 15842421Syokota kbd_set_state_t *set_state; 15942421Syokota kbd_get_fkeystr_t *get_fkeystr; 16044628Syokota kbd_poll_mode_t *poll; 16142421Syokota kbd_diag_t *diag; 16242421Syokota} keyboard_switch_t; 16342421Syokota 164174984Swkoszek/* 165174984Swkoszek * Keyboard disciplines: call actual handlers via kbdsw[]. 166174984Swkoszek */ 167174984Swkoszek#define kbdd_probe(kbd, unit, arg, flags) \ 168174984Swkoszek (*kbdsw[(kbd)->kb_index]->probe)((unit), (arg), (flags)) 169174984Swkoszek#define kbdd_init(kbd, unit, kbdpp, arg, flags) \ 170174984Swkoszek (*kbdsw[(kbd)->kb_index]->init)((unit), (kbdpp), (arg), (flags)) 171174984Swkoszek#define kbdd_term(kbd) \ 172174984Swkoszek (*kbdsw[(kbd)->kb_index]->term)((kbd)) 173174984Swkoszek#define kbdd_intr(kbd, arg) \ 174174984Swkoszek (*kbdsw[(kbd)->kb_index]->intr)((kbd), (arg)) 175174984Swkoszek#define kbdd_test_if(kbd) \ 176174984Swkoszek (*kbdsw[(kbd)->kb_index]->test_if)((kbd)) 177190870Semax#define kbdd_enable(kbd) \ 178174984Swkoszek (*kbdsw[(kbd)->kb_index]->enable)((kbd)) 179174984Swkoszek#define kbdd_disable(kbd) \ 180174984Swkoszek (*kbdsw[(kbd)->kb_index]->disable)((kbd)) 181174984Swkoszek#define kbdd_read(kbd, wait) \ 182174984Swkoszek (*kbdsw[(kbd)->kb_index]->read)((kbd), (wait)) 183174984Swkoszek#define kbdd_check(kbd) \ 184174984Swkoszek (*kbdsw[(kbd)->kb_index]->check)((kbd)) 185174984Swkoszek#define kbdd_read_char(kbd, wait) \ 186174984Swkoszek (*kbdsw[(kbd)->kb_index]->read_char)((kbd), (wait)) 187174984Swkoszek#define kbdd_check_char(kbd) \ 188174984Swkoszek (*kbdsw[(kbd)->kb_index]->check_char)((kbd)) 189174984Swkoszek#define kbdd_ioctl(kbd, cmd, arg) \ 190174984Swkoszek (((kbd) == NULL) ? \ 191174984Swkoszek ENODEV : \ 192174984Swkoszek (*kbdsw[(kbd)->kb_index]->ioctl)((kbd), (cmd), (arg))) 193174984Swkoszek#define kbdd_lock(kbd, lockf) \ 194174984Swkoszek (*kbdsw[(kbd)->kb_index]->lock)((kbd), (lockf)) 195174984Swkoszek#define kbdd_clear_state(kbd) \ 196174984Swkoszek (*kbdsw[(kbd)->kb_index]->clear_state)((kbd)) 197174984Swkoszek#define kbdd_get_state(kbd, buf, len) \ 198174984Swkoszek (*kbdsw[(kbd)->kb_index]->get_state)((kbd), (buf), (len)) 199174984Swkoszek#define kbdd_set_state(kbd, buf, len) \ 200174984Swkoszek (*kbdsw[(kbd)->kb_index]->set_state)((kbd), (buf), (len)) 201190870Semax#define kbdd_get_fkeystr(kbd, fkey, len) \ 202174984Swkoszek (*kbdsw[(kbd)->kb_index]->get_fkeystr)((kbd), (fkey), (len)) 203174984Swkoszek#define kbdd_poll(kbd, on) \ 204174984Swkoszek (*kbdsw[(kbd)->kb_index]->poll)((kbd), (on)) 205174984Swkoszek#define kbdd_diag(kbd, level) \ 206174984Swkoszek (*kbdsw[(kbd)->kb_index]->diag)((kbd), (leve)) 207174984Swkoszek 20842421Syokota/* keyboard driver */ 20942421Syokotatypedef struct keyboard_driver { 21060938Sjake SLIST_ENTRY(keyboard_driver) link; 21142421Syokota char *name; 21242421Syokota keyboard_switch_t *kbdsw; 21342421Syokota int (*configure)(int); /* backdoor for the console driver */ 21442421Syokota} keyboard_driver_t; 21542421Syokota 21655205Speter#ifdef _KERNEL 21742421Syokota 21842421Syokota#define KEYBOARD_DRIVER(name, sw, config) \ 21944628Syokota static struct keyboard_driver name##_kbd_driver = { \ 22054545Syokota { NULL }, #name, &sw, config \ 22142421Syokota }; \ 22244628Syokota DATA_SET(kbddriver_set, name##_kbd_driver); 22342421Syokota 22442421Syokota/* global variables */ 22542421Syokotaextern keyboard_switch_t **kbdsw; 22642421Syokota 22742421Syokota/* functions for the keyboard driver */ 22854545Syokotaint kbd_add_driver(keyboard_driver_t *driver); 22954545Syokotaint kbd_delete_driver(keyboard_driver_t *driver); 23042421Syokotaint kbd_register(keyboard_t *kbd); 23142421Syokotaint kbd_unregister(keyboard_t *kbd); 23242421Syokotakeyboard_switch_t *kbd_get_switch(char *driver); 23342421Syokotavoid kbd_init_struct(keyboard_t *kbd, char *name, int type, 23442421Syokota int unit, int config, int port, 23542421Syokota int port_size); 23642421Syokotavoid kbd_set_maps(keyboard_t *kbd, struct keymap *keymap, 23742421Syokota struct accentmap *accmap, 23842421Syokota struct fkeytab *fkeymap, int fkeymap_size); 23942421Syokota 24042421Syokota/* functions for the keyboard client */ 24142421Syokotaint kbd_allocate(char *driver, int unit, void *id, 24242421Syokota kbd_callback_func_t *func, void *arg); 24342421Syokotaint kbd_release(keyboard_t *kbd, void *id); 24442421Syokotaint kbd_change_callback(keyboard_t *kbd, void *id, 24542421Syokota kbd_callback_func_t *func, void *arg); 24642421Syokotaint kbd_find_keyboard(char *driver, int unit); 247147980Semaxint kbd_find_keyboard2(char *driver, int unit, int index); 24842421Syokotakeyboard_t *kbd_get_keyboard(int index); 24942421Syokota 25042421Syokota/* a back door for the console driver to tickle the keyboard driver XXX */ 25142421Syokotaint kbd_configure(int flags); 25242421Syokota /* see `kb_config' above for flag bit definitions */ 25342421Syokota 25442421Syokota#ifdef KBD_INSTALL_CDEV 25542421Syokota 25642421Syokota/* virtual keyboard cdev driver functions */ 25750154Syokotaint kbd_attach(keyboard_t *kbd); 25850154Syokotaint kbd_detach(keyboard_t *kbd); 25942421Syokota 26042421Syokota#endif /* KBD_INSTALL_CDEV */ 26142421Syokota 26242421Syokota/* generic low-level keyboard functions */ 26342421Syokota 26442421Syokota/* shift key state */ 26542421Syokota#define SHIFTS1 (1 << 16) 26642421Syokota#define SHIFTS2 (1 << 17) 26742421Syokota#define SHIFTS (SHIFTS1 | SHIFTS2) 26842421Syokota#define CTLS1 (1 << 18) 26942421Syokota#define CTLS2 (1 << 19) 27042421Syokota#define CTLS (CTLS1 | CTLS2) 27142421Syokota#define ALTS1 (1 << 20) 27242421Syokota#define ALTS2 (1 << 21) 27342421Syokota#define ALTS (ALTS1 | ALTS2) 27442421Syokota#define AGRS1 (1 << 22) 27542421Syokota#define AGRS2 (1 << 23) 27642421Syokota#define AGRS (AGRS1 | AGRS2) 27742421Syokota#define METAS1 (1 << 24) 27842421Syokota#define METAS2 (1 << 25) 27942421Syokota#define METAS (METAS1 | METAS2) 28042421Syokota#define NLKDOWN (1 << 26) 28142421Syokota#define SLKDOWN (1 << 27) 28242421Syokota#define CLKDOWN (1 << 28) 28342421Syokota#define ALKDOWN (1 << 29) 28455820Syokota#define SHIFTAON (1 << 30) 28566834Sphk/* lock key state (defined in sys/kbio.h) */ 28642421Syokota/* 28742421Syokota#define CLKED LED_CAP 28842421Syokota#define NLKED LED_NUM 28942421Syokota#define SLKED LED_SCR 29042421Syokota#define ALKED (1 << 3) 29142421Syokota#define LOCK_MASK (CLKED | NLKED | SLKED | ALKED) 29242421Syokota#define LED_CAP (1 << 0) 29342421Syokota#define LED_NUM (1 << 1) 29442421Syokota#define LED_SCR (1 << 2) 29542421Syokota#define LED_MASK (LED_CAP | LED_NUM | LED_SCR) 29642421Syokota*/ 29742421Syokota 29842421Syokotakbd_get_fkeystr_t genkbd_get_fkeystr; 29942421Syokotakbd_diag_t genkbd_diag; 30042421Syokota 30142421Syokotaint genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg); 30280045Syokotaint genkbd_keyaction(keyboard_t *kbd, int keycode, int up, 30342421Syokota int *shiftstate, int *accents); 30442421Syokota 30555205Speter#endif /* _KERNEL */ 30642421Syokota 30742421Syokota#endif /* !_DEV_KBD_KBDREG_H_ */ 308