summaryrefslogtreecommitdiffstats
path: root/sys/dev/kbd/kbdreg.h
diff options
context:
space:
mode:
authoryokota <yokota@FreeBSD.org>1999-01-09 02:44:50 +0000
committeryokota <yokota@FreeBSD.org>1999-01-09 02:44:50 +0000
commitf10c5df4354e9dcf241989c9490f57fcd2ced1fc (patch)
tree595cc3d8efe3870b612f2264ba6a30474322c94c /sys/dev/kbd/kbdreg.h
parentdc29b5609b3591deb088424bce52f2d654b06b2c (diff)
downloadFreeBSD-src-f10c5df4354e9dcf241989c9490f57fcd2ced1fc.zip
FreeBSD-src-f10c5df4354e9dcf241989c9490f57fcd2ced1fc.tar.gz
Add the new keyboard driver and video card driver. They will be
used by console drivers. (They are not yet activated yet. Wait for announcement later.)
Diffstat (limited to 'sys/dev/kbd/kbdreg.h')
-rw-r--r--sys/dev/kbd/kbdreg.h270
1 files changed, 270 insertions, 0 deletions
diff --git a/sys/dev/kbd/kbdreg.h b/sys/dev/kbd/kbdreg.h
new file mode 100644
index 0000000..f1a6c8b
--- /dev/null
+++ b/sys/dev/kbd/kbdreg.h
@@ -0,0 +1,270 @@
+/*-
+ * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer as
+ * the first lines of this file unmodified.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * $Id: $
+ */
+
+#ifndef _DEV_KBD_KBDREG_H_
+#define _DEV_KBD_KBDREG_H_
+
+/* forward declarations */
+typedef struct keyboard keyboard_t;
+struct keymap;
+struct accentmap;
+struct fkeytab;
+
+/* call back funcion */
+typedef int kbd_callback_func_t(keyboard_t *kbd, int event,
+ void *arg);
+/* event types */
+#define KBDIO_KEYINPUT 0
+#define KBDIO_UNLOADING 1
+
+typedef struct keyboard_callback {
+ kbd_callback_func_t *kc_func;
+ void *kc_arg;
+} keyboard_callback_t;
+
+/* keyboard */
+struct keyboard {
+ /* the following fields are managed by kbdio */
+ int kb_index; /* kbdio index# */
+ int kb_minor; /* minor number of the sub-device */
+ int kb_flags; /* internal flags */
+#define KB_VALID (1 << 16) /* this entry is valid */
+#define KB_NO_DEVICE (1 << 17) /* device not present */
+#define KB_PROBED (1 << 18) /* device probed */
+#define KB_INITIALIZED (1 << 19) /* device initialized */
+#define KB_REGISTERED (1 << 20) /* device registered to kbdio */
+#define KB_BUSY (1 << 21) /* device used by a client */
+ int kb_active; /* 0: inactive */
+ void *kb_token; /* id of the current client */
+ keyboard_callback_t kb_callback;/* callback function */
+
+ /*
+ * Device configuration flags:
+ * The upper 16 bits are common between various keyboard devices.
+ * The lower 16 bits are device-specific.
+ */
+ int kb_config;
+#define KB_CONF_PROBE_ONLY (1 << 16) /* probe only, don't initialize */
+
+ /* the following fields are set up by the driver */
+ char *kb_name; /* driver name */
+ int kb_unit; /* unit # */
+ int kb_type; /* KB_84, KB_101, KB_OTHER,... */
+ int kb_io_base; /* port# if any */
+ int kb_io_size; /* # of occupied port */
+ int kb_led; /* LED status */
+ struct keymap *kb_keymap; /* key map */
+ struct accentmap *kb_accentmap; /* accent map */
+ struct fkeytab *kb_fkeytab; /* function key strings */
+ int kb_fkeytab_size;/* # of function key strings */
+ void *kb_data; /* the driver's private data */
+};
+
+#define KBD_IS_VALID(k) ((k)->kb_flags & KB_VALID)
+#define KBD_VALID(k) ((k)->kb_flags |= KB_VALID)
+#define KBD_INVALID(k) ((k)->kb_flags &= ~KB_VALID)
+#define KBD_HAS_DEVICE(k) (!((k)->kb_flags & KB_NO_DEVICE))
+#define KBD_FOUND_DEVICE(k) ((k)->kb_flags &= ~KB_NO_DEVICE)
+#define KBD_IS_PROBED(k) ((k)->kb_flags & KB_PROBED)
+#define KBD_PROBE_DONE(k) ((k)->kb_flags |= KB_PROBED)
+#define KBD_IS_INITIALIZED(k) ((k)->kb_flags & KB_INITIALIZED)
+#define KBD_INIT_DONE(k) ((k)->kb_flags |= KB_INITIALIZED)
+#define KBD_IS_CONFIGURED(k) ((k)->kb_flags & KB_REGISTERED)
+#define KBD_CONFIG_DONE(k) ((k)->kb_flags |= KB_REGISTERED)
+#define KBD_IS_BUSY(k) ((k)->kb_flags & KB_BUSY)
+#define KBD_BUSY(k) ((k)->kb_flags |= KB_BUSY)
+#define KBD_UNBUSY(k) ((k)->kb_flags &= ~KB_BUSY)
+#define KBD_IS_ACTIVE(k) ((k)->kb_active)
+#define KBD_ACTIVATE(k) (++(k)->kb_active)
+#define KBD_DEACTIVATE(k) (--(k)->kb_active)
+#define KBD_LED_VAL(k) ((k)->kb_led)
+
+/* keyboard function table */
+typedef int kbd_probe_t(int unit, keyboard_t **kbdp, void *arg,
+ int flags);
+typedef int kbd_init_t(keyboard_t *kbd);
+typedef int kbd_term_t(keyboard_t *kbd);
+typedef int kbd_intr_t(keyboard_t *kbd, void *arg);
+typedef int kbd_test_if_t(keyboard_t *kbd);
+typedef int kbd_enable_t(keyboard_t *kbd);
+typedef int kbd_disable_t(keyboard_t *kbd);
+typedef int kbd_read_t(keyboard_t *kbd, int wait);
+typedef int kbd_check_t(keyboard_t *kbd);
+typedef u_int kbd_read_char_t(keyboard_t *kbd, int wait);
+typedef int kbd_check_char_t(keyboard_t *kbd);
+typedef int kbd_ioctl_t(keyboard_t *kbd, u_long cmd, caddr_t data);
+typedef int kbd_lock_t(keyboard_t *kbd, int lock);
+typedef void kbd_clear_state_t(keyboard_t *kbd);
+typedef int kbd_get_state_t(keyboard_t *kbd, void *buf, size_t len);
+typedef int kbd_set_state_t(keyboard_t *kbd, void *buf, size_t len);
+typedef u_char *kbd_get_fkeystr_t(keyboard_t *kbd, int fkey,
+ size_t *len);
+typedef void kbd_diag_t(keyboard_t *kbd, int level);
+
+typedef struct keyboard_switch {
+ kbd_probe_t *probe;
+ kbd_init_t *init;
+ kbd_term_t *term;
+ kbd_intr_t *intr;
+ kbd_test_if_t *test_if;
+ kbd_enable_t *enable;
+ kbd_disable_t *disable;
+ kbd_read_t *read;
+ kbd_check_t *check;
+ kbd_read_char_t *read_char;
+ kbd_check_char_t *check_char;
+ kbd_ioctl_t *ioctl;
+ kbd_lock_t *lock;
+ kbd_clear_state_t *clear_state;
+ kbd_get_state_t *get_state;
+ kbd_set_state_t *set_state;
+ kbd_get_fkeystr_t *get_fkeystr;
+ kbd_diag_t *diag;
+} keyboard_switch_t;
+
+/* keyboard driver */
+typedef struct keyboard_driver {
+ char *name;
+ keyboard_switch_t *kbdsw;
+ int (*configure)(int); /* backdoor for the console driver */
+} keyboard_driver_t;
+
+#ifdef KERNEL
+
+#define KEYBOARD_DRIVER(name, sw, config) \
+ static struct keyboard_driver name##_driver = { \
+ #name, &sw, config \
+ }; \
+ DATA_SET(kbddriver_set, name##_driver);
+
+/* global variables */
+extern keyboard_switch_t **kbdsw;
+extern struct linker_set kbddriver_set;
+
+/* functions for the keyboard driver */
+int kbd_register(keyboard_t *kbd);
+int kbd_unregister(keyboard_t *kbd);
+keyboard_switch_t *kbd_get_switch(char *driver);
+void kbd_init_struct(keyboard_t *kbd, char *name, int type,
+ int unit, int config, int port,
+ int port_size);
+void kbd_set_maps(keyboard_t *kbd, struct keymap *keymap,
+ struct accentmap *accmap,
+ struct fkeytab *fkeymap, int fkeymap_size);
+
+/* functions for the keyboard client */
+int kbd_allocate(char *driver, int unit, void *id,
+ kbd_callback_func_t *func, void *arg);
+int kbd_release(keyboard_t *kbd, void *id);
+int kbd_change_callback(keyboard_t *kbd, void *id,
+ kbd_callback_func_t *func, void *arg);
+int kbd_find_keyboard(char *driver, int unit);
+keyboard_t *kbd_get_keyboard(int index);
+
+/* a back door for the console driver to tickle the keyboard driver XXX */
+int kbd_configure(int flags);
+ /* see `kb_config' above for flag bit definitions */
+
+#ifdef KBD_INSTALL_CDEV
+
+/* virtual keyboard cdev driver functions */
+
+int kbd_attach(dev_t dev, keyboard_t *kbd,
+ struct cdevsw *sw);
+int kbd_detach(dev_t dev, keyboard_t *kbd,
+ struct cdevsw *sw);
+
+/* generic keyboard cdev driver functions */
+
+typedef struct genkbd_softc {
+ int gkb_flags; /* flag/status bits */
+#define KB_ASLEEP (1 << 0)
+ struct clist gkb_q; /* input queue */
+ struct selinfo gkb_rsel;
+} genkbd_softc_t;
+
+int genkbdopen(genkbd_softc_t *sc, keyboard_t *kbd, int flag, int mode,
+ struct proc *p);
+int genkbdclose(genkbd_softc_t *sc, keyboard_t *kbd, int flag, int mode,
+ struct proc *p);
+int genkbdread(genkbd_softc_t *sc, keyboard_t *kbd, struct uio *uio,
+ int flag);
+int genkbdwrite(genkbd_softc_t *sc, keyboard_t *kbd, struct uio *uio,
+ int flag);
+int genkbdioctl(genkbd_softc_t *sc, keyboard_t *kbd, u_long cmd,
+ caddr_t arg, int flag, struct proc *p);
+int genkbdpoll(genkbd_softc_t *sc, keyboard_t *kbd, int event,
+ struct proc *p);
+
+#endif /* KBD_INSTALL_CDEV */
+
+/* generic low-level keyboard functions */
+
+/* shift key state */
+#define SHIFTS1 (1 << 16)
+#define SHIFTS2 (1 << 17)
+#define SHIFTS (SHIFTS1 | SHIFTS2)
+#define CTLS1 (1 << 18)
+#define CTLS2 (1 << 19)
+#define CTLS (CTLS1 | CTLS2)
+#define ALTS1 (1 << 20)
+#define ALTS2 (1 << 21)
+#define ALTS (ALTS1 | ALTS2)
+#define AGRS1 (1 << 22)
+#define AGRS2 (1 << 23)
+#define AGRS (AGRS1 | AGRS2)
+#define METAS1 (1 << 24)
+#define METAS2 (1 << 25)
+#define METAS (METAS1 | METAS2)
+#define NLKDOWN (1 << 26)
+#define SLKDOWN (1 << 27)
+#define CLKDOWN (1 << 28)
+#define ALKDOWN (1 << 29)
+/* lock key state (defined in machine/console.h) */
+/*
+#define CLKED LED_CAP
+#define NLKED LED_NUM
+#define SLKED LED_SCR
+#define ALKED (1 << 3)
+#define LOCK_MASK (CLKED | NLKED | SLKED | ALKED)
+#define LED_CAP (1 << 0)
+#define LED_NUM (1 << 1)
+#define LED_SCR (1 << 2)
+#define LED_MASK (LED_CAP | LED_NUM | LED_SCR)
+*/
+
+kbd_get_fkeystr_t genkbd_get_fkeystr;
+kbd_diag_t genkbd_diag;
+
+int genkbd_commonioctl(keyboard_t *kbd, u_long cmd, caddr_t arg);
+int genkbd_keyaction(keyboard_t *kbd, int keycode, int down,
+ int *shiftstate, int *accents);
+
+#endif /* KERNEL */
+
+#endif /* !_DEV_KBD_KBDREG_H_ */
OpenPOWER on IntegriCloud