sys/dev/misc/kbd/kbdreg.h

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