/* $NetBSD: wskbd.c,v 1.148 2026/06/06 17:56:03 kre Exp $ */

/*
 * Copyright (c) 1996, 1997 Christopher G. Demetriou.  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.
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Christopher G. Demetriou
 *      for the NetBSD Project.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

/*
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 *  All rights reserved.
 *
 * Keysym translator contributed to The NetBSD Foundation by
 * Juergen Hannken-Illjes.
 *
 * 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.
 * 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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``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 FOUNDATION OR CONTRIBUTORS
 * 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.
 */

/*
 * Copyright (c) 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This software was developed by the Computer Systems Engineering group
 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
 * contributed to Berkeley.
 *
 * All advertising materials mentioning features or use of this software
 * must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Lawrence Berkeley Laboratory.
 *
 * 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.
 * 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.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
 *
 *      @(#)kbd.c       8.2 (Berkeley) 10/30/93
 */

/*
 * Keyboard driver (/dev/wskbd*).  Translates incoming bytes to ASCII or
 * to `wscons_events' and passes them up to the appropriate reader.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: wskbd.c,v 1.148 2026/06/06 17:56:03 kre Exp $");

#ifdef _KERNEL_OPT
#include "opt_ddb.h"
#include "opt_kgdb.h"
#include "opt_wsdisplay_compat.h"
#endif

#include "wsdisplay.h"
#include "wskbd.h"
#include "wsmux.h"

#include <sys/param.h>
#include <sys/conf.h>
#include <sys/device.h>
#include <sys/ioctl.h>
#include <sys/poll.h>
#include <sys/kernel.h>
#include <sys/proc.h>
#include <sys/syslog.h>
#include <sys/systm.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/tty.h>
#include <sys/signalvar.h>
#include <sys/errno.h>
#include <sys/fcntl.h>
#include <sys/vnode.h>
#include <sys/kauth.h>

#include <dev/wscons/wsconsio.h>
#include <dev/wscons/wskbdvar.h>
#include <dev/wscons/wsksymdef.h>
#include <dev/wscons/wsksymvar.h>
#include <dev/wscons/wsdisplayvar.h>
#include <dev/wscons/wseventvar.h>
#include <dev/wscons/wscons_callbacks.h>
#include <dev/wscons/wsbelldata.h>
#include <dev/wscons/wsmuxvar.h>

#ifdef KGDB
#include <sys/kgdb.h>
#endif

#include "ioconf.h"

#ifdef WSKBD_DEBUG
#define DPRINTF(x)      if (wskbddebug) printf x
int     wskbddebug = 0;
#else
#define DPRINTF(x)
#endif

struct wskbd_internal {
        const struct wskbd_mapdata *t_keymap;

        const struct wskbd_consops *t_consops;
        void    *t_consaccesscookie;

        int     t_modifiers;
        int     t_composelen;           /* remaining entries in t_composebuf */
        keysym_t t_composebuf[2];

        int t_flags;
#define WSKFL_METAESC 1

#define MAXKEYSYMSPERKEY 2 /* ESC <key> at max */
        keysym_t t_symbols[MAXKEYSYMSPERKEY];

        struct wskbd_softc *t_sc;       /* back pointer */
};

struct wskbd_softc {
        struct wsevsrc sc_base;

        struct wskbd_internal *id;

        const struct wskbd_accessops *sc_accessops;
        void *sc_accesscookie;

        int     sc_ledstate;

        int     sc_isconsole;

        struct wskbd_bell_data sc_bell_data;
        struct wskbd_keyrepeat_data sc_keyrepeat_data;
#ifdef WSDISPLAY_SCROLLSUPPORT
        struct wskbd_scroll_data sc_scroll_data;
#endif

        int     sc_repeating;           /* we've called timeout() */
        callout_t sc_repeat_ch;
        u_int   sc_repeat_type;
        int     sc_repeat_value;

        int     sc_translating;         /* xlate to chars for emulation */

        int     sc_maplen;              /* number of entries in sc_map */
        struct wscons_keymap *sc_map;   /* current translation map */
        kbd_t sc_layout; /* current layout */

        int             sc_refcnt;
        u_char          sc_dying;       /* device is being detached */

        wskbd_hotkey_plugin *sc_hotkey;
        void *sc_hotkeycookie;

        /* optional table to translate scancodes in event mode */
        int             sc_evtrans_len;
        keysym_t        *sc_evtrans;
};

#define MOD_SHIFT_L             (1 << 0)
#define MOD_SHIFT_R             (1 << 1)
#define MOD_SHIFTLOCK           (1 << 2)
#define MOD_CAPSLOCK            (1 << 3)
#define MOD_CONTROL_L           (1 << 4)
#define MOD_CONTROL_R           (1 << 5)
#define MOD_META_L              (1 << 6)
#define MOD_META_R              (1 << 7)
#define MOD_MODESHIFT           (1 << 8)
#define MOD_NUMLOCK             (1 << 9)
#define MOD_COMPOSE             (1 << 10)
#define MOD_HOLDSCREEN          (1 << 11)
#define MOD_COMMAND             (1 << 12)
#define MOD_COMMAND1            (1 << 13)
#define MOD_COMMAND2            (1 << 14)

#define MOD_ANYSHIFT            (MOD_SHIFT_L | MOD_SHIFT_R | MOD_SHIFTLOCK)
#define MOD_ANYCONTROL          (MOD_CONTROL_L | MOD_CONTROL_R)
#define MOD_ANYMETA             (MOD_META_L | MOD_META_R)

#define MOD_ONESET(id, mask)    (((id)->t_modifiers & (mask)) != 0)
#define MOD_ALLSET(id, mask)    (((id)->t_modifiers & (mask)) == (mask))

#define GETMODSTATE(src, dst)           \
        do {                                                    \
                dst |= (src & MOD_SHIFT_L) ? MOD_SHIFT_L : 0; \
                dst |= (src & MOD_SHIFT_R) ? MOD_SHIFT_R : 0; \
                dst |= (src & MOD_CONTROL_L) ? MOD_CONTROL_L : 0; \
                dst |= (src & MOD_CONTROL_R) ? MOD_CONTROL_R : 0; \
                dst |= (src & MOD_META_L) ? MOD_META_L : 0; \
                dst |= (src & MOD_META_R) ? MOD_META_R : 0; \
        } while (0)

static int  wskbd_match(device_t, cfdata_t, void *);
static void wskbd_attach(device_t, device_t, void *);
static int  wskbd_detach(device_t, int);
static int  wskbd_activate(device_t, enum devact);

static int  wskbd_displayioctl(device_t, u_long, void *, int,
                              struct lwp *);
#if NWSDISPLAY > 0
static int  wskbd_set_display(device_t, struct wsevsrc *);
#else
#define wskbd_set_display NULL
#endif

static inline void update_leds(struct wskbd_internal *);
static inline void update_modifier(struct wskbd_internal *, u_int, int, int);
static int internal_command(struct wskbd_softc *, u_int *, keysym_t, keysym_t);
static int wskbd_translate(struct wskbd_internal *, u_int, int);
static int wskbd_enable(struct wskbd_softc *, int);
#if NWSDISPLAY > 0
static void change_displayparam(struct wskbd_softc *, int, int, int);
static void wskbd_holdscreen(struct wskbd_softc *, int);
#endif

static int wskbd_do_ioctl_sc(struct wskbd_softc *, u_long, void *, int,
                             struct lwp *);
static void wskbd_deliver_event(struct wskbd_softc *sc, u_int type, int value);

#if NWSMUX > 0
static int wskbd_mux_open(struct wsevsrc *, struct wseventvar *);
static int wskbd_mux_close(struct wsevsrc *);
#else
#define wskbd_mux_open NULL
#define wskbd_mux_close NULL
#endif

static int wskbd_do_open(struct wskbd_softc *, struct wseventvar *);
static int wskbd_do_ioctl(device_t, u_long, void *, int, struct lwp *);

CFATTACH_DECL_NEW(wskbd, sizeof (struct wskbd_softc),
    wskbd_match, wskbd_attach, wskbd_detach, wskbd_activate);

dev_type_open(wskbdopen);
dev_type_close(wskbdclose);
dev_type_read(wskbdread);
dev_type_ioctl(wskbdioctl);
dev_type_poll(wskbdpoll);
dev_type_kqfilter(wskbdkqfilter);

const struct cdevsw wskbd_cdevsw = {
        .d_open = wskbdopen,
        .d_close = wskbdclose,
        .d_read = wskbdread,
        .d_write = nowrite,
        .d_ioctl = wskbdioctl,
        .d_stop = nostop,
        .d_tty = notty,
        .d_poll = wskbdpoll,
        .d_mmap = nommap,
        .d_kqfilter = wskbdkqfilter,
        .d_discard = nodiscard,
        .d_flag = D_OTHER
};

#ifdef WSDISPLAY_SCROLLSUPPORT
struct wskbd_scroll_data wskbd_default_scroll_data = {
        WSKBD_SCROLL_DOALL,
        WSKBD_SCROLL_MODE_NORMAL,
#ifdef WSDISPLAY_SCROLLCOMBO
        WSDISPLAY_SCROLLCOMBO,
#else
        MOD_SHIFT_L,
#endif
};
#endif

#ifndef WSKBD_DEFAULT_KEYREPEAT_DEL1
#define WSKBD_DEFAULT_KEYREPEAT_DEL1    400     /* 400ms to start repeating */
#endif
#ifndef WSKBD_DEFAULT_KEYREPEAT_DELN
#define WSKBD_DEFAULT_KEYREPEAT_DELN    100     /* 100ms to between repeats */
#endif

struct wskbd_keyrepeat_data wskbd_default_keyrepeat_data = {
        WSKBD_KEYREPEAT_DOALL,
        WSKBD_DEFAULT_KEYREPEAT_DEL1,
        WSKBD_DEFAULT_KEYREPEAT_DELN,
};

#if NWSDISPLAY > 0 || NWSMUX > 0
struct wssrcops wskbd_srcops = {
        WSMUX_KBD,
        wskbd_mux_open, wskbd_mux_close, wskbd_do_ioctl,
        wskbd_displayioctl, wskbd_set_display
};
#endif

static bool wskbd_suspend(device_t dv, const pmf_qual_t *);
static void wskbd_repeat(void *v);

static int wskbd_console_initted;
static struct wskbd_softc *wskbd_console_device;
static struct wskbd_internal wskbd_console_data;

static void wskbd_update_layout(struct wskbd_internal *, kbd_t);

static void
wskbd_update_layout(struct wskbd_internal *id, kbd_t enc)
{

        if (enc & KB_METAESC)
                id->t_flags |= WSKFL_METAESC;
        else
                id->t_flags &= ~WSKFL_METAESC;
}

/*
 * Print function (for parent devices).
 */
int
wskbddevprint(void *aux, const char *pnp)
{
#if 0
        struct wskbddev_attach_args *ap = aux;
#endif

        if (pnp)
                aprint_normal("wskbd at %s", pnp);
#if 0
        aprint_normal(" console %d", ap->console);
#endif

        return (UNCONF);
}

int
wskbd_match(device_t parent, cfdata_t match, void *aux)
{
        struct wskbddev_attach_args *ap = aux;

        if (match->wskbddevcf_console != WSKBDDEVCF_CONSOLE_UNK) {
                /*
                 * If console-ness of device specified, either match
                 * exactly (at high priority), or fail.
                 */
                if (match->wskbddevcf_console != 0 && ap->console != 0)
                        return (10);
                else
                        return (0);
        }

        /* If console-ness unspecified, it wins. */
        return (1);
}

void
wskbd_attach(device_t parent, device_t self, void *aux)
{
        struct wskbd_softc *sc = device_private(self);
        struct wskbddev_attach_args *ap = aux;
#if NWSMUX > 0
        int mux, error;
#endif

        sc->sc_base.me_dv = self;
        sc->sc_isconsole = ap->console;
        sc->sc_hotkey = NULL;
        sc->sc_hotkeycookie = NULL;
        sc->sc_evtrans_len = 0;
        sc->sc_evtrans = NULL;

#if NWSMUX > 0 || NWSDISPLAY > 0
        sc->sc_base.me_ops = &wskbd_srcops;
#endif
#if NWSMUX > 0
        mux = device_cfdata(sc->sc_base.me_dv)->wskbddevcf_mux;
        if (ap->console) {
                /* Ignore mux for console; it always goes to the console mux. */
                /* printf(" (mux %d ignored for console)", mux); */
                mux = -1;
        }
        if (mux >= 0)
                aprint_normal(" mux %d", mux);
#else
        if (device_cfdata(sc->sc_base.me_dv)->wskbddevcf_mux >= 0)
                aprint_normal(" (mux ignored)");
#endif

        if (ap->console) {
                sc->id = &wskbd_console_data;
        } else {
                sc->id = malloc(sizeof(struct wskbd_internal),
                                M_DEVBUF, M_WAITOK|M_ZERO);
                sc->id->t_keymap = ap->keymap;
                wskbd_update_layout(sc->id, ap->keymap->layout);
        }

        callout_init(&sc->sc_repeat_ch, 0);
        callout_setfunc(&sc->sc_repeat_ch, wskbd_repeat, sc);

        sc->id->t_sc = sc;

        sc->sc_accessops = ap->accessops;
        sc->sc_accesscookie = ap->accesscookie;
        sc->sc_repeating = 0;
        sc->sc_translating = 1;
        sc->sc_ledstate = -1; /* force update */

        if (wskbd_load_keymap(sc->id->t_keymap,
                              &sc->sc_map, &sc->sc_maplen) != 0)
                panic("cannot load keymap");

        sc->sc_layout = sc->id->t_keymap->layout;

        /* set default bell and key repeat data */
        sc->sc_bell_data = wskbd_default_bell_data;
        sc->sc_keyrepeat_data = wskbd_default_keyrepeat_data;

#ifdef WSDISPLAY_SCROLLSUPPORT
        sc->sc_scroll_data = wskbd_default_scroll_data;
#endif

        if (ap->console) {
                KASSERT(wskbd_console_initted);
                KASSERT(wskbd_console_device == NULL);

                wskbd_console_device = sc;

                aprint_naive(": console keyboard");
                aprint_normal(": console keyboard");

#if NWSDISPLAY > 0
                wsdisplay_set_console_kbd(&sc->sc_base); /* sets me_dispv */
                if (sc->sc_base.me_dispdv != NULL)
                        aprint_normal(", using %s",
                            device_xname(sc->sc_base.me_dispdv));
#endif
        }
        aprint_naive("\n");
        aprint_normal("\n");

#if NWSMUX > 0
        if (mux >= 0) {
                error = wsmux_attach_sc(wsmux_getmux(mux), &sc->sc_base);
                if (error)
                        aprint_error_dev(sc->sc_base.me_dv,
                            "attach error=%d\n", error);
        }
#endif

        if (!pmf_device_register(self, wskbd_suspend, NULL))
                aprint_error_dev(self, "couldn't establish power handler\n");
        else if (!pmf_class_input_register(self))
                aprint_error_dev(self, "couldn't register as input device\n");
}

static bool
wskbd_suspend(device_t dv, const pmf_qual_t *qual)
{
        struct wskbd_softc *sc = device_private(dv);

        sc->sc_repeating = 0;
        callout_stop(&sc->sc_repeat_ch);

        return true;
}

void
wskbd_cnattach(const struct wskbd_consops *consops, void *conscookie,
        const struct wskbd_mapdata *mapdata)
{
        KASSERT(!wskbd_console_initted);

        wskbd_console_data.t_keymap = mapdata;
        wskbd_update_layout(&wskbd_console_data, mapdata->layout);

        wskbd_console_data.t_consops = consops;
        wskbd_console_data.t_consaccesscookie = conscookie;

#if NWSDISPLAY > 0
        wsdisplay_set_cons_kbd(wskbd_cngetc, wskbd_cnpollc, wskbd_cnbell);
#endif

        wskbd_console_initted = 1;
}

void
wskbd_cndetach(void)
{
        KASSERT(wskbd_console_initted);

        wskbd_console_data.t_keymap = 0;

        wskbd_console_data.t_consops = 0;
        wskbd_console_data.t_consaccesscookie = 0;

#if NWSDISPLAY > 0
        wsdisplay_unset_cons_kbd();
#endif

        wskbd_console_initted = 0;
}

static void
wskbd_repeat(void *v)
{
        struct wskbd_softc *sc = (struct wskbd_softc *)v;
        int s = spltty();

        if (!sc->sc_repeating) {
                /*
                 * race condition: a "key up" event came in when wskbd_repeat()
                 * was already called but not yet spltty()'d
                 */
                splx(s);
                return;
        }
        if (sc->sc_translating) {
                /* deliver keys */
#if NWSDISPLAY > 0
                if (sc->sc_base.me_dispdv != NULL) {
                        int i;
                        for (i = 0; i < sc->sc_repeating; i++)
                                wsdisplay_kbdinput(sc->sc_base.me_dispdv,
                                                   sc->id->t_symbols[i]);
                }
#endif
        } else {
#if defined(WSKBD_EVENT_AUTOREPEAT)
                /* queue event */
                wskbd_deliver_event(sc, sc->sc_repeat_type,
                                    sc->sc_repeat_value);
#endif /* defined(WSKBD_EVENT_AUTOREPEAT) */
        }
        callout_schedule(&sc->sc_repeat_ch, mstohz(sc->sc_keyrepeat_data.delN));
        splx(s);
}

int
wskbd_activate(device_t self, enum devact act)
{
        struct wskbd_softc *sc = device_private(self);

        if (act == DVACT_DEACTIVATE)
                sc->sc_dying = 1;
        return (0);
}

/*
 * Detach a keyboard.  To keep track of users of the softc we keep
 * a reference count that's incremented while inside, e.g., read.
 * If the keyboard is active and the reference count is > 0 (0 is the
 * normal state) we post an event and then wait for the process
 * that had the reference to wake us up again.  Then we blow away the
 * vnode and return (which will deallocate the softc).
 */
int
wskbd_detach(device_t self, int flags)
{
        struct wskbd_softc *sc = device_private(self);
        struct wseventvar *evar;
        int maj, mn;
        int s;

#if NWSMUX > 0
        /* Tell parent mux we're leaving. */
        if (sc->sc_base.me_parent != NULL)
                wsmux_detach_sc(&sc->sc_base);
#endif

        callout_halt(&sc->sc_repeat_ch, NULL);
        callout_destroy(&sc->sc_repeat_ch);

        if (sc->sc_isconsole) {
                KASSERT(wskbd_console_device == sc);
                wskbd_console_device = NULL;
        }

        pmf_device_deregister(self);

        evar = sc->sc_base.me_evp;
        if (evar != NULL && evar->io != NULL) {
                s = spltty();
                if (--sc->sc_refcnt >= 0) {
                        struct wscons_event event;

                        /* Wake everyone by generating a dummy event. */
                        event.type = 0;
                        event.value = 0;
                        if (wsevent_inject(evar, &event, 1) != 0)
                                wsevent_wakeup(evar);

                        /* Wait for processes to go away. */
                        if (tsleep(sc, PZERO, "wskdet", hz * 60))
                                aprint_error("wskbd_detach: %s didn't detach\n",
                                       device_xname(self));
                }
                splx(s);
        }

        /* locate the major number */
        maj = cdevsw_lookup_major(&wskbd_cdevsw);

        /* Nuke the vnodes for any open instances. */
        mn = device_unit(self);
        vdevgone(maj, mn, mn, VCHR);

        return (0);
}

void
wskbd_input(device_t dev, u_int type, int value)
{
        struct wskbd_softc *sc = device_private(dev);
#if NWSDISPLAY > 0
        int num, i;
#endif

        if (sc->sc_repeating) {
                sc->sc_repeating = 0;
                callout_stop(&sc->sc_repeat_ch);
        }

        device_active(dev, DVA_HARDWARE);

#if NWSDISPLAY > 0
        /*
         * If /dev/wskbdN is not connected in event mode translate and
         * send upstream.
         */
        if (sc->sc_translating) {
                num = wskbd_translate(sc->id, type, value);
                if (num > 0) {
                        if (sc->sc_base.me_dispdv != NULL) {
#ifdef WSDISPLAY_SCROLLSUPPORT
                                if (sc->id->t_symbols [0] != KS_Print_Screen) {
                                        wsdisplay_scroll(sc->sc_base.
                                        me_dispdv, WSDISPLAY_SCROLL_RESET);
                                }
#endif
                                for (i = 0; i < num; i++)
                                        wsdisplay_kbdinput(
                                                sc->sc_base.me_dispdv,
                                                sc->id->t_symbols[i]);
                        }

                        if (sc->sc_keyrepeat_data.del1 != 0) {
                                sc->sc_repeating = num;
                                callout_schedule(&sc->sc_repeat_ch,
                                    mstohz(sc->sc_keyrepeat_data.del1));
                        }
                }
                return;
        }
#endif

        wskbd_deliver_event(sc, type, value);

#if defined(WSKBD_EVENT_AUTOREPEAT)
        /* Repeat key presses if set. */
        if (type == WSCONS_EVENT_KEY_DOWN && sc->sc_keyrepeat_data.del1 != 0) {
                sc->sc_repeat_type = type;
                sc->sc_repeat_value = value;
                sc->sc_repeating = 1;
                callout_schedule(&sc->sc_repeat_ch,
                    mstohz(sc->sc_keyrepeat_data.del1));
        }
#endif /* defined(WSKBD_EVENT_AUTOREPEAT) */
}

/*
 * Keyboard is generating events.  Turn this keystroke into an
 * event and put it in the queue.  If the queue is full, the
 * keystroke is lost (sorry!).
 */
static void
wskbd_deliver_event(struct wskbd_softc *sc, u_int type, int value)
{
        struct wseventvar *evar;
        struct wscons_event event;

        evar = sc->sc_base.me_evp;

        if (evar == NULL || evar->q == NULL) {
                DPRINTF(("wskbd_input: not open\n"));
                return;
        }

        event.type = type;
        event.value = 0;
        DPRINTF(("%d ->", value));
        if (sc->sc_evtrans_len > 0) {
                if (sc->sc_evtrans_len > value) {
                        DPRINTF(("%d", sc->sc_evtrans[value]));
                        event.value = sc->sc_evtrans[value];
                }
        } else {
                event.value = value;
        }
        DPRINTF(("\n"));
        if (wsevent_inject(evar, &event, 1) != 0)
                log(LOG_WARNING, "%s: event queue overflow\n",
                    device_xname(sc->sc_base.me_dv));
}

#ifdef WSDISPLAY_COMPAT_RAWKBD
void
wskbd_rawinput(device_t dev, u_char *tbuf, int len)
{
#if NWSDISPLAY > 0
        struct wskbd_softc *sc = device_private(dev);
        int i;

        if (sc->sc_base.me_dispdv != NULL)
                for (i = 0; i < len; i++)
                        wsdisplay_kbdinput(sc->sc_base.me_dispdv, tbuf[i]);
        /* this is KS_GROUP_Plain */
#endif
}
#endif /* WSDISPLAY_COMPAT_RAWKBD */

#if NWSDISPLAY > 0
static void
wskbd_holdscreen(struct wskbd_softc *sc, int hold)
{
        int new_state;

        if (sc->sc_base.me_dispdv != NULL) {
                wsdisplay_kbdholdscreen(sc->sc_base.me_dispdv, hold);
                new_state = sc->sc_ledstate;
                if (hold) {
#ifdef WSDISPLAY_SCROLLSUPPORT
                        sc->sc_scroll_data.mode = WSKBD_SCROLL_MODE_HOLD;
#endif
                        new_state |= WSKBD_LED_SCROLL;
                } else {
#ifdef WSDISPLAY_SCROLLSUPPORT
                        sc->sc_scroll_data.mode = WSKBD_SCROLL_MODE_NORMAL;
#endif
                        new_state &= ~WSKBD_LED_SCROLL;
                }
                if (new_state != sc->sc_ledstate) {
                        (*sc->sc_accessops->set_leds)(sc->sc_accesscookie,
                                                      new_state);
                        sc->sc_ledstate = new_state;
#ifdef WSDISPLAY_SCROLLSUPPORT
                        if (!hold)
                                wsdisplay_scroll(sc->sc_base.me_dispdv,
                                    WSDISPLAY_SCROLL_RESET);
#endif
                }
        }
}
#endif

static int
wskbd_enable(struct wskbd_softc *sc, int on)
{
        int error;

#if 0
/* I don't understand the purpose of this code.  And it seems to
 * break things, so it's out.  -- Lennart
 */
        if (!on && (!sc->sc_translating
#if NWSDISPLAY > 0
                    || sc->sc_base.me_dispdv
#endif
                ))
                return (EBUSY);
#endif
#if NWSDISPLAY > 0
        if (sc->sc_base.me_dispdv != NULL)
                return (0);
#endif

        /* Always cancel auto repeat when fiddling with the kbd. */
        if (sc->sc_repeating) {
                sc->sc_repeating = 0;
                callout_stop(&sc->sc_repeat_ch);
        }

        error = (*sc->sc_accessops->enable)(sc->sc_accesscookie, on);
        DPRINTF(("wskbd_enable: sc=%p on=%d res=%d\n", sc, on, error));
        return (error);
}

#if NWSMUX > 0
int
wskbd_mux_open(struct wsevsrc *me, struct wseventvar *evp)
{
        struct wskbd_softc *sc = (struct wskbd_softc *)me;

        if (sc->sc_dying)
                return (EIO);

        if (sc->sc_base.me_evp != NULL)
                return (EBUSY);

        return (wskbd_do_open(sc, evp));
}
#endif

int
wskbdopen(dev_t dev, int flags, int mode, struct lwp *l)
{
        struct wskbd_softc *sc = device_lookup_private(&wskbd_cd, minor(dev));
        struct wseventvar *evar;
        int error;

        if (sc == NULL)
                return (ENXIO);

#if NWSMUX > 0
        DPRINTF(("wskbdopen: %s mux=%p l=%p\n",
            device_xname(sc->sc_base.me_dv), sc->sc_base.me_parent, l));
#endif

        if (sc->sc_dying)
                return (EIO);

        if ((flags & (FREAD | FWRITE)) == FWRITE)
                /* Not opening for read, only ioctl is available. */
                return (0);

#if NWSMUX > 0
        if (sc->sc_base.me_parent != NULL) {
                /* Grab the keyboard out of the greedy hands of the mux. */
                DPRINTF(("wskbdopen: detach\n"));
                wsmux_detach_sc(&sc->sc_base);
        }
#endif

        if (sc->sc_base.me_evp != NULL)
                return (EBUSY);

        evar = &sc->sc_base.me_evar;
        wsevent_init(evar, l->l_proc);

        error = wskbd_do_open(sc, evar);
        if (error) {
                DPRINTF(("wskbdopen: %s open failed\n",
                         device_xname(sc->sc_base.me_dv)));
                sc->sc_base.me_evp = NULL;
                wsevent_fini(evar);
        }
        return (error);
}

int
wskbd_do_open(struct wskbd_softc *sc, struct wseventvar *evp)
{
        sc->sc_base.me_evp = evp;
        sc->sc_translating = 0;

        return (wskbd_enable(sc, 1));
}

int
wskbdclose(dev_t dev, int flags, int mode,
    struct lwp *l)
{
        struct wskbd_softc *sc =
            device_lookup_private(&wskbd_cd, minor(dev));
        struct wseventvar *evar = sc->sc_base.me_evp;

#if NWSMUX > 0
        DPRINTF(("wskbdclose: %s mux=%p p=%p\n", device_xname(sc->sc_base.me_dv),
                 sc->sc_base.me_parent, l));
#endif

        if (evar == NULL) {
                /* not open for read */
                return (0);
        }

        sc->sc_base.me_evp = NULL;
        sc->sc_translating = 1;
        (void)wskbd_enable(sc, 0);
        wsevent_fini(evar);

        return (0);
}

#if NWSMUX > 0
int
wskbd_mux_close(struct wsevsrc *me)
{
        struct wskbd_softc *sc = (struct wskbd_softc *)me;

        sc->sc_base.me_evp = NULL;
        sc->sc_translating = 1;
        (void)wskbd_enable(sc, 0);

        return (0);
}
#endif

int
wskbdread(dev_t dev, struct uio *uio, int flags)
{
        struct wskbd_softc *sc =
            device_lookup_private(&wskbd_cd, minor(dev));
        int error;

        if (sc->sc_dying)
                return (EIO);

        KASSERTMSG(sc->sc_base.me_evp != NULL, "wskbdread: evp == NULL\n");

        sc->sc_refcnt++;
        error = wsevent_read(sc->sc_base.me_evp, uio, flags);
        if (--sc->sc_refcnt < 0) {
                wakeup(sc);
                error = EIO;
        }
        return (error);
}

int
wskbdioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
{
        return (wskbd_do_ioctl(device_lookup(&wskbd_cd, minor(dev)),
            cmd, data, flag,l));
}

/* A wrapper around the ioctl() workhorse to make reference counting easy. */
int
wskbd_do_ioctl(device_t dv, u_long cmd, void *data, int flag,
        struct lwp *l)
{
        struct wskbd_softc *sc = device_private(dv);
        int error;

        sc->sc_refcnt++;
        error = wskbd_do_ioctl_sc(sc, cmd, data, flag, l);
        if (--sc->sc_refcnt < 0)
                wakeup(sc);
        return (error);
}

int
wskbd_do_ioctl_sc(struct wskbd_softc *sc, u_long cmd, void *data, int flag,
                  struct lwp *l)
{

        /*
         * Try the generic ioctls that the wskbd interface supports.
         */
        switch (cmd) {
        case FIONBIO:           /* we will remove this someday (soon???) */
                return (0);

        case FIOASYNC:
                if (sc->sc_base.me_evp == NULL)
                        return (EINVAL);
                sc->sc_base.me_evp->async = *(int *)data != 0;
                return (0);

        case FIOSETOWN:
                if (sc->sc_base.me_evp == NULL)
                        return (EINVAL);
                if (-*(int *)data != sc->sc_base.me_evp->io->p_pgid
                    && *(int *)data != sc->sc_base.me_evp->io->p_pid)
                        return (EPERM);
                return (0);

        case TIOCSPGRP:
                if (sc->sc_base.me_evp == NULL)
                        return (EINVAL);
                if (*(int *)data != sc->sc_base.me_evp->io->p_pgid)
                        return (EPERM);
                return (0);
        }

        /*
         * Try the keyboard driver for WSKBDIO ioctls.  It returns EPASSTHROUGH
         * if it didn't recognize the request.
         */
        return (wskbd_displayioctl(sc->sc_base.me_dv, cmd, data, flag, l));
}

/*
 * WSKBDIO ioctls, handled in both emulation mode and in ``raw'' mode.
 * Some of these have no real effect in raw mode, however.
 */
static int
wskbd_displayioctl(device_t dev, u_long cmd, void *data, int flag,
        struct lwp *l)
{
#ifdef WSDISPLAY_SCROLLSUPPORT
        struct wskbd_scroll_data *usdp, *ksdp;
#endif
        struct wskbd_softc *sc = device_private(dev);
        struct wskbd_bell_data *ubdp, *kbdp;
        struct wskbd_keyrepeat_data *ukdp, *kkdp;
        struct wskbd_map_data *umdp;
        struct wskbd_mapdata md;
        kbd_t enc;
        void *tbuf;
        int len, error;

        switch (cmd) {
        case WSKBDIO_BELL:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                return ((*sc->sc_accessops->ioctl)(sc->sc_accesscookie,
                    WSKBDIO_COMPLEXBELL, (void *)&sc->sc_bell_data, flag, l));

        case WSKBDIO_COMPLEXBELL:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                ubdp = (struct wskbd_bell_data *)data;
                SETBELL(ubdp, ubdp, &sc->sc_bell_data);
                return ((*sc->sc_accessops->ioctl)(sc->sc_accesscookie,
                    WSKBDIO_COMPLEXBELL, (void *)ubdp, flag, l));

        case WSKBDIO_SETBELL:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                kbdp = &sc->sc_bell_data;
setbell:
                ubdp = (struct wskbd_bell_data *)data;
                SETBELL(kbdp, ubdp, kbdp);
                return (0);

        case WSKBDIO_GETBELL:
                kbdp = &sc->sc_bell_data;
getbell:
                ubdp = (struct wskbd_bell_data *)data;
                SETBELL(ubdp, kbdp, kbdp);
                return (0);

        case WSKBDIO_SETDEFAULTBELL:
                if ((error = kauth_authorize_device(l->l_cred,
                    KAUTH_DEVICE_WSCONS_KEYBOARD_BELL, NULL, NULL,
                    NULL, NULL)) != 0)
                        return (error);
                kbdp = &wskbd_default_bell_data;
                goto setbell;


        case WSKBDIO_GETDEFAULTBELL:
                kbdp = &wskbd_default_bell_data;
                goto getbell;

#undef SETBELL

#define SETKEYREPEAT(dstp, srcp, dfltp)                                 \
    do {                                                                \
        (dstp)->del1 = ((srcp)->which & WSKBD_KEYREPEAT_DODEL1) ?       \
            (srcp)->del1 : (dfltp)->del1;                               \
        (dstp)->delN = ((srcp)->which & WSKBD_KEYREPEAT_DODELN) ?       \
            (srcp)->delN : (dfltp)->delN;                               \
        (dstp)->which = WSKBD_KEYREPEAT_DOALL;                          \
    } while (0)

        case WSKBDIO_SETKEYREPEAT:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                kkdp = &sc->sc_keyrepeat_data;
setkeyrepeat:
                ukdp = (struct wskbd_keyrepeat_data *)data;
                SETKEYREPEAT(kkdp, ukdp, kkdp);
                return (0);

        case WSKBDIO_GETKEYREPEAT:
                kkdp = &sc->sc_keyrepeat_data;
getkeyrepeat:
                ukdp = (struct wskbd_keyrepeat_data *)data;
                SETKEYREPEAT(ukdp, kkdp, kkdp);
                return (0);

        case WSKBDIO_SETDEFAULTKEYREPEAT:
                if ((error = kauth_authorize_device(l->l_cred,
                    KAUTH_DEVICE_WSCONS_KEYBOARD_KEYREPEAT, NULL, NULL,
                    NULL, NULL)) != 0)
                        return (error);
                kkdp = &wskbd_default_keyrepeat_data;
                goto setkeyrepeat;


        case WSKBDIO_GETDEFAULTKEYREPEAT:
                kkdp = &wskbd_default_keyrepeat_data;
                goto getkeyrepeat;

#ifdef WSDISPLAY_SCROLLSUPPORT
#define SETSCROLLMOD(dstp, srcp, dfltp)                                 \
    do {                                                                \
        (dstp)->mode = ((srcp)->which & WSKBD_SCROLL_DOMODE) ?          \
            (srcp)->mode : (dfltp)->mode;                               \
        (dstp)->modifier = ((srcp)->which & WSKBD_SCROLL_DOMODIFIER) ?  \
            (srcp)->modifier : (dfltp)->modifier;                       \
        (dstp)->which = WSKBD_SCROLL_DOALL;                             \
    } while (0)

        case WSKBDIO_SETSCROLL:
                usdp = (struct wskbd_scroll_data *)data;
                ksdp = &sc->sc_scroll_data;
                SETSCROLLMOD(ksdp, usdp, ksdp);
                return (0);

        case WSKBDIO_GETSCROLL:
                usdp = (struct wskbd_scroll_data *)data;
                ksdp = &sc->sc_scroll_data;
                SETSCROLLMOD(usdp, ksdp, ksdp);
                return (0);
#else
        case WSKBDIO_GETSCROLL:
        case WSKBDIO_SETSCROLL:
                return ENODEV;
#endif

#undef SETKEYREPEAT

        case WSKBDIO_SETMAP:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                umdp = (struct wskbd_map_data *)data;
                if (umdp->maplen > WSKBDIO_MAXMAPLEN)
                        return (EINVAL);

                len = umdp->maplen*sizeof(struct wscons_keymap);
                tbuf = malloc(len, M_TEMP, M_WAITOK);
                error = copyin(umdp->map, tbuf, len);
                if (error == 0) {
                        wskbd_init_keymap(umdp->maplen,
                                          &sc->sc_map, &sc->sc_maplen);
                        memcpy(sc->sc_map, tbuf, len);
                        /* drop the variant bits handled by the map */
                        sc->sc_layout = KB_USER |
                              (KB_VARIANT(sc->sc_layout) & KB_HANDLEDBYWSKBD);
                        wskbd_update_layout(sc->id, sc->sc_layout);
                }
                free(tbuf, M_TEMP);
                return(error);

        case WSKBDIO_GETMAP: {
                int i;

                umdp = (struct wskbd_map_data *)data;
                if (sc->sc_evtrans_len > 0) {
                        /* we're translating scancodes so we need to generate an
                         * appropriate map or clients will be *very* confused */
                        int new_maplen = 0;
                        int code;
                        struct wscons_keymap new_map[256];

                        memset(new_map, 0, sizeof(new_map));
                        for (i = 0; i < sc->sc_evtrans_len; i++) {
                                code = sc->sc_evtrans[i];
                                if (code > 255) continue;
                                if (code >= new_maplen)
                                        new_maplen = code + 1;
                                /* do not overwrite entries */
                                if (new_map[code].group1[0] == 0)
                                        new_map[code] = sc->sc_map[i];
                        }
                        if (umdp->maplen > new_maplen)
                                umdp->maplen = new_maplen;
                        error = copyout(new_map, umdp->map,
                                umdp->maplen*sizeof(struct wscons_keymap));
                } else {
                        if (umdp->maplen > sc->sc_maplen)
                                umdp->maplen = sc->sc_maplen;
                        error = copyout(sc->sc_map, umdp->map,
                                umdp->maplen*sizeof(struct wscons_keymap));
                }
                return(error);
        }

        case WSKBDIO_GETENCODING:
                *((kbd_t *) data) = sc->sc_layout;
                return(0);

        case WSKBDIO_SETENCODING:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                enc = *((kbd_t *)data);
                if (KB_ENCODING(enc) == KB_USER) {
                        /* user map must already be loaded */
                        if (KB_ENCODING(sc->sc_layout) != KB_USER)
                                return (EINVAL);
                        /* map variants make no sense */
                        if (KB_VARIANT(enc) & ~KB_HANDLEDBYWSKBD)
                                return (EINVAL);
                } else {
                        md = *(sc->id->t_keymap); /* structure assignment */
                        md.layout = enc;
                        error = wskbd_load_keymap(&md, &sc->sc_map,
                                                  &sc->sc_maplen);
                        if (error)
                                return (error);
                }
                sc->sc_layout = enc;
                wskbd_update_layout(sc->id, enc);
                return (0);

        case WSKBDIO_SETVERSION:
                return wsevent_setversion(sc->sc_base.me_evp, *(int *)data);
        }

        /*
         * Try the keyboard driver for WSKBDIO ioctls.  It returns -1
         * if it didn't recognize the request, and in turn we return
         * -1 if we didn't recognize the request.
         */
/* printf("kbdaccess\n"); */
        error = (*sc->sc_accessops->ioctl)(sc->sc_accesscookie, cmd, data,
                                           flag, l);
#ifdef WSDISPLAY_COMPAT_RAWKBD
        if (!error && cmd == WSKBDIO_SETMODE && *(int *)data == WSKBD_RAW) {
                int s = spltty();
                sc->id->t_modifiers &= ~(MOD_SHIFT_L | MOD_SHIFT_R
                                         | MOD_CONTROL_L | MOD_CONTROL_R
                                         | MOD_META_L | MOD_META_R
                                         | MOD_COMMAND
                                         | MOD_COMMAND1 | MOD_COMMAND2);
                if (sc->sc_repeating) {
                        sc->sc_repeating = 0;
                        callout_stop(&sc->sc_repeat_ch);
                }
                splx(s);
        }
#endif
        return (error);
}

int
wskbdpoll(dev_t dev, int events, struct lwp *l)
{
        struct wskbd_softc *sc =
            device_lookup_private(&wskbd_cd, minor(dev));

        if (sc->sc_base.me_evp == NULL)
                return (POLLERR);
        return (wsevent_poll(sc->sc_base.me_evp, events, l));
}

int
wskbdkqfilter(dev_t dev, struct knote *kn)
{
        struct wskbd_softc *sc =
            device_lookup_private(&wskbd_cd, minor(dev));

        if (sc->sc_base.me_evp == NULL)
                return (1);
        return (wsevent_kqfilter(sc->sc_base.me_evp, kn));
}

#if NWSDISPLAY > 0

int
wskbd_pickfree(void)
{
        int i;
        struct wskbd_softc *sc;

        for (i = 0; i < wskbd_cd.cd_ndevs; i++) {
                sc = device_lookup_private(&wskbd_cd, i);
                if (sc == NULL)
                        continue;
                if (sc->sc_base.me_dispdv == NULL)
                        return (i);
        }
        return (-1);
}

struct wsevsrc *
wskbd_set_console_display(device_t displaydv, struct wsevsrc *me)
{
        struct wskbd_softc *sc = wskbd_console_device;

        if (sc == NULL)
                return (NULL);
        sc->sc_base.me_dispdv = displaydv;
#if NWSMUX > 0
        (void)wsmux_attach_sc((struct wsmux_softc *)me, &sc->sc_base);
#endif
        return (&sc->sc_base);
}

int
wskbd_set_display(device_t dv, struct wsevsrc *me)
{
        struct wskbd_softc *sc = device_private(dv);
        device_t displaydv = me != NULL ? me->me_dispdv : NULL;
        device_t odisplaydv;
        int error;

        DPRINTF(("wskbd_set_display: %s me=%p odisp=%p disp=%p cons=%d\n",
                 device_xname(dv), me, sc->sc_base.me_dispdv, displaydv,
                 sc->sc_isconsole));

        if (sc->sc_isconsole)
                return (EBUSY);

        if (displaydv != NULL) {
                if (sc->sc_base.me_dispdv != NULL)
                        return (EBUSY);
        } else {
                if (sc->sc_base.me_dispdv == NULL)
                        return (ENXIO);
        }

        odisplaydv = sc->sc_base.me_dispdv;
        sc->sc_base.me_dispdv = NULL;
        error = wskbd_enable(sc, displaydv != NULL);
        sc->sc_base.me_dispdv = displaydv;
        if (error) {
                sc->sc_base.me_dispdv = odisplaydv;
                return (error);
        }

        if (displaydv)
                aprint_verbose_dev(sc->sc_base.me_dv, "connecting to %s\n",
                       device_xname(displaydv));
        else
                aprint_verbose_dev(sc->sc_base.me_dv, "disconnecting from %s\n",
                       device_xname(odisplaydv));

        return (0);
}

#endif /* NWSDISPLAY > 0 */

#if NWSMUX > 0
int
wskbd_add_mux(int unit, struct wsmux_softc *muxsc)
{
        struct wskbd_softc *sc = device_lookup_private(&wskbd_cd, unit);

        if (sc == NULL)
                return (ENXIO);

        if (sc->sc_base.me_parent != NULL || sc->sc_base.me_evp != NULL)
                return (EBUSY);

        return (wsmux_attach_sc(muxsc, &sc->sc_base));
}
#endif

/*
 * Console interface.
 */
int
wskbd_cngetc(dev_t dev)
{
        static int num = 0;
        static int pos;
        u_int type;
        int data;
        keysym_t ks;

        if (!wskbd_console_initted)
                return -1;

        if (wskbd_console_device != NULL &&
            !wskbd_console_device->sc_translating)
                return -1;

        for(;;) {
                if (num-- > 0) {
                        ks = wskbd_console_data.t_symbols[pos++];
                        if (KS_GROUP(ks) == KS_GROUP_Plain)
                                return (KS_VALUE(ks));
                } else {
                        (*wskbd_console_data.t_consops->getc)
                                (wskbd_console_data.t_consaccesscookie,
                                 &type, &data);
                        if (type == 0) {
                                /* No data returned */
                                return -1;
                        }
                        if (type == WSCONS_EVENT_ASCII) {
                                /*
                                 * We assume that when the driver falls back
                                 * to deliver pure ASCII it is in a state that
                                 * it can not track press/release events
                                 * reliable - so we clear all previously
                                 * accumulated modifier state.
                                 */
                                wskbd_console_data.t_modifiers = 0;
                                return(data);
                        }
                        num = wskbd_translate(&wskbd_console_data, type, data);
                        pos = 0;
                }
        }
}

void
wskbd_cnpollc(dev_t dev, int poll)
{

        if (!wskbd_console_initted)
                return;

        if (wskbd_console_device != NULL &&
            !wskbd_console_device->sc_translating)
                return;

        (*wskbd_console_data.t_consops->pollc)
            (wskbd_console_data.t_consaccesscookie, poll);
}

void
wskbd_cnbell(dev_t dev, u_int pitch, u_int period, u_int volume)
{

        if (!wskbd_console_initted)
                return;

        if (wskbd_console_data.t_consops->bell != NULL)
                (*wskbd_console_data.t_consops->bell)
                    (wskbd_console_data.t_consaccesscookie, pitch, period,
                        volume);
}

static inline void
update_leds(struct wskbd_internal *id)
{
        int new_state;

        new_state = 0;
        if (id->t_modifiers & (MOD_SHIFTLOCK | MOD_CAPSLOCK))
                new_state |= WSKBD_LED_CAPS;
        if (id->t_modifiers & MOD_NUMLOCK)
                new_state |= WSKBD_LED_NUM;
        if (id->t_modifiers & MOD_COMPOSE)
                new_state |= WSKBD_LED_COMPOSE;
        if (id->t_modifiers & MOD_HOLDSCREEN)
                new_state |= WSKBD_LED_SCROLL;

        if (id->t_sc && new_state != id->t_sc->sc_ledstate) {
                (*id->t_sc->sc_accessops->set_leds)
                    (id->t_sc->sc_accesscookie, new_state);
                id->t_sc->sc_ledstate = new_state;
        }
}

static inline void
update_modifier(struct wskbd_internal *id, u_int type, int toggle, int mask)
{
        if (toggle) {
                if (type == WSCONS_EVENT_KEY_DOWN)
                        id->t_modifiers ^= mask;
        } else {
                if (type == WSCONS_EVENT_KEY_DOWN)
                        id->t_modifiers |= mask;
                else
                        id->t_modifiers &= ~mask;
        }
}

#if NWSDISPLAY > 0
static void
change_displayparam(struct wskbd_softc *sc, int param, int updown,
        int wraparound)
{
        int res;
        struct wsdisplay_param dp;

        dp.param = param;
        res = wsdisplay_param(sc->sc_base.me_dispdv, WSDISPLAYIO_GETPARAM, &dp);

        if (res == EINVAL)
                return; /* no such parameter */

        dp.curval += updown;
        if (dp.max < dp.curval)
                dp.curval = wraparound ? dp.min : dp.max;
        else
        if (dp.curval < dp.min)
                dp.curval = wraparound ? dp.max : dp.min;
        wsdisplay_param(sc->sc_base.me_dispdv, WSDISPLAYIO_SETPARAM, &dp);
}
#endif

static int
internal_command(struct wskbd_softc *sc, u_int *type, keysym_t ksym,
        keysym_t ksym2)
{
#if NWSDISPLAY > 0 && defined(WSDISPLAY_SCROLLSUPPORT)
        u_int state = 0;
#endif
        switch (ksym) {
        case KS_Cmd_VolumeToggle:
                if (*type == WSCONS_EVENT_KEY_DOWN)
                        pmf_event_inject(NULL, PMFE_AUDIO_VOLUME_TOGGLE);
                break;
        case KS_Cmd_VolumeUp:
                if (*type == WSCONS_EVENT_KEY_DOWN)
                        pmf_event_inject(NULL, PMFE_AUDIO_VOLUME_UP);
                break;
        case KS_Cmd_VolumeDown:
                if (*type == WSCONS_EVENT_KEY_DOWN)
                        pmf_event_inject(NULL, PMFE_AUDIO_VOLUME_DOWN);
                break;
#if NWSDISPLAY > 0 && defined(WSDISPLAY_SCROLLSUPPORT)
        case KS_Cmd_ScrollFastUp:
        case KS_Cmd_ScrollFastDown:
                if (*type == WSCONS_EVENT_KEY_DOWN) {
                        GETMODSTATE(sc->id->t_modifiers, state);
                        if ((sc->sc_scroll_data.mode == WSKBD_SCROLL_MODE_HOLD
                                && MOD_ONESET(sc->id, MOD_HOLDSCREEN))
                        || (sc->sc_scroll_data.mode == WSKBD_SCROLL_MODE_NORMAL
                                && sc->sc_scroll_data.modifier == state)) {
                                        update_modifier(sc->id, *type, 0, MOD_COMMAND);
                                        wsdisplay_scroll(sc->sc_base.me_dispdv,
                                                (ksym == KS_Cmd_ScrollFastUp) ?
                                                WSDISPLAY_SCROLL_BACKWARD :
                                                WSDISPLAY_SCROLL_FORWARD);
                                        return (1);
                        } else {
                                return (0);
                        }
                } else
                        update_modifier(sc->id, *type, 0, MOD_COMMAND);
                break;

        case KS_Cmd_ScrollSlowUp:
        case KS_Cmd_ScrollSlowDown:
                if (*type == WSCONS_EVENT_KEY_DOWN) {
                        GETMODSTATE(sc->id->t_modifiers, state);
                        if ((sc->sc_scroll_data.mode == WSKBD_SCROLL_MODE_HOLD
                                && MOD_ONESET(sc->id, MOD_HOLDSCREEN))
                        || (sc->sc_scroll_data.mode == WSKBD_SCROLL_MODE_NORMAL
                                && sc->sc_scroll_data.modifier == state)) {
                                        update_modifier(sc->id, *type, 0, MOD_COMMAND);
                                        wsdisplay_scroll(sc->sc_base.me_dispdv,
                                                (ksym == KS_Cmd_ScrollSlowUp) ?
                                                WSDISPLAY_SCROLL_BACKWARD | WSDISPLAY_SCROLL_LOW:
                                                WSDISPLAY_SCROLL_FORWARD | WSDISPLAY_SCROLL_LOW);
                                        return (1);
                        } else {
                                return (0);
                        }
                } else
                        update_modifier(sc->id, *type, 0, MOD_COMMAND);
                break;
#endif

        case KS_Cmd:
                update_modifier(sc->id, *type, 0, MOD_COMMAND);
                ksym = ksym2;
                break;

        case KS_Cmd1:
                update_modifier(sc->id, *type, 0, MOD_COMMAND1);
                break;

        case KS_Cmd2:
                update_modifier(sc->id, *type, 0, MOD_COMMAND2);
                break;
        }

        if (*type != WSCONS_EVENT_KEY_DOWN ||
            (! MOD_ONESET(sc->id, MOD_COMMAND) &&
             ! MOD_ALLSET(sc->id, MOD_COMMAND1 | MOD_COMMAND2)))
                return (0);

#if defined(DDB) || defined(KGDB)
        if (ksym == KS_Cmd_Debugger) {
                if (sc->sc_isconsole) {
#ifdef DDB
                        console_debugger();
#endif
#ifdef KGDB
                        kgdb_connect(1);
#endif
                }
                /* discard this key (ddb discarded command modifiers) */
                *type = WSCONS_EVENT_KEY_UP;
                return (1);
        }
#endif

#if NWSDISPLAY > 0
        if (sc->sc_base.me_dispdv == NULL)
                return (0);

        switch (ksym) {
        case KS_Cmd_Screen0:
        case KS_Cmd_Screen1:
        case KS_Cmd_Screen2:
        case KS_Cmd_Screen3:
        case KS_Cmd_Screen4:
        case KS_Cmd_Screen5:
        case KS_Cmd_Screen6:
        case KS_Cmd_Screen7:
        case KS_Cmd_Screen8:
        case KS_Cmd_Screen9:
                wsdisplay_switch(sc->sc_base.me_dispdv, ksym - KS_Cmd_Screen0, 0);
                return (1);
        case KS_Cmd_ResetEmul:
                wsdisplay_reset(sc->sc_base.me_dispdv, WSDISPLAY_RESETEMUL);
                return (1);
        case KS_Cmd_ResetClose:
                wsdisplay_reset(sc->sc_base.me_dispdv, WSDISPLAY_RESETCLOSE);
                return (1);
        case KS_Cmd_BacklightOn:
        case KS_Cmd_BacklightOff:
        case KS_Cmd_BacklightToggle:
                change_displayparam(sc, WSDISPLAYIO_PARAM_BACKLIGHT,
                                    ksym == KS_Cmd_BacklightOff ? -1 : 1,
                                    ksym == KS_Cmd_BacklightToggle ? 1 : 0);
                return (1);
        case KS_Cmd_BrightnessUp:
        case KS_Cmd_BrightnessDown:
        case KS_Cmd_BrightnessRotate:
                change_displayparam(sc, WSDISPLAYIO_PARAM_BRIGHTNESS,
                                    ksym == KS_Cmd_BrightnessDown ? -1 : 1,
                                    ksym == KS_Cmd_BrightnessRotate ? 1 : 0);
                return (1);
        case KS_Cmd_ContrastUp:
        case KS_Cmd_ContrastDown:
        case KS_Cmd_ContrastRotate:
                change_displayparam(sc, WSDISPLAYIO_PARAM_CONTRAST,
                                    ksym == KS_Cmd_ContrastDown ? -1 : 1,
                                    ksym == KS_Cmd_ContrastRotate ? 1 : 0);
                return (1);
        }
#endif

        return (0);
}

device_t
wskbd_hotkey_register(device_t self, void *cookie, wskbd_hotkey_plugin *hotkey)
{
        struct wskbd_softc *sc = device_private(self);

        KASSERT(sc != NULL);
        KASSERT(hotkey != NULL);

        sc->sc_hotkey = hotkey;
        sc->sc_hotkeycookie = cookie;

        return sc->sc_base.me_dv;
}

void
wskbd_hotkey_deregister(device_t self)
{
        struct wskbd_softc *sc = device_private(self);

        KASSERT(sc != NULL);

        sc->sc_hotkey = NULL;
        sc->sc_hotkeycookie = NULL;
}

static int
wskbd_translate(struct wskbd_internal *id, u_int type, int value)
{
        struct wskbd_softc *sc = id->t_sc;
        keysym_t ksym, res, *group;
        struct wscons_keymap kpbuf, *kp;
        int iscommand = 0;
        int ishotkey = 0;

        if (type == WSCONS_EVENT_ALL_KEYS_UP) {
                id->t_modifiers &= ~(MOD_SHIFT_L | MOD_SHIFT_R
                                | MOD_CONTROL_L | MOD_CONTROL_R
                                | MOD_META_L | MOD_META_R
                                | MOD_MODESHIFT
                                | MOD_COMMAND | MOD_COMMAND1 | MOD_COMMAND2);
                update_leds(id);
                return (0);
        }

        if (sc != NULL) {
                if (sc->sc_hotkey != NULL)
                        ishotkey = sc->sc_hotkey(sc, sc->sc_hotkeycookie,
                                                type, value);
                if (ishotkey)
                        return 0;

                if (value < 0 || value >= sc->sc_maplen) {
#ifdef DEBUG
                        printf("%s: keycode %d out of range\n",
                               __func__, value);
#endif
                        return (0);
                }
                kp = sc->sc_map + value;
        } else {
                kp = &kpbuf;
                wskbd_get_mapentry(id->t_keymap, value, kp);
        }

        /* if this key has a command, process it first */
        if (sc != NULL && kp->command != KS_voidSymbol)
                iscommand = internal_command(sc, &type, kp->command,
                                             kp->group1[0]);

        /* Now update modifiers */
        switch (kp->group1[0]) {
        case KS_Shift_L:
                update_modifier(id, type, 0, MOD_SHIFT_L);
                break;

        case KS_Shift_R:
                update_modifier(id, type, 0, MOD_SHIFT_R);
                break;

        case KS_Shift_Lock:
                update_modifier(id, type, 1, MOD_SHIFTLOCK);
                break;

        case KS_Caps_Lock:
                update_modifier(id, type, 1, MOD_CAPSLOCK);
                break;

        case KS_Control_L:
                update_modifier(id, type, 0, MOD_CONTROL_L);
                break;

        case KS_Control_R:
                update_modifier(id, type, 0, MOD_CONTROL_R);
                break;

        case KS_Alt_L:
                update_modifier(id, type, 0, MOD_META_L);
                break;

        case KS_Alt_R:
                update_modifier(id, type, 0, MOD_META_R);
                break;

        case KS_Mode_switch:
                update_modifier(id, type, 0, MOD_MODESHIFT);
                break;

        case KS_Num_Lock:
                update_modifier(id, type, 1, MOD_NUMLOCK);
                break;

#if NWSDISPLAY > 0
        case KS_Hold_Screen:
                if (sc != NULL) {
                        update_modifier(id, type, 1, MOD_HOLDSCREEN);
                        wskbd_holdscreen(sc, id->t_modifiers & MOD_HOLDSCREEN);
                }
                break;
#endif
        }

        /* If this is a key release or we are in command mode, we are done */
        if (type != WSCONS_EVENT_KEY_DOWN || iscommand) {
                update_leds(id);
                return (0);
        }

        /* Get the keysym */
        if (id->t_modifiers & MOD_MODESHIFT)
                group = & kp->group2[0];
        else
                group = & kp->group1[0];

        if ((id->t_modifiers & MOD_NUMLOCK) != 0 &&
            KS_GROUP(group[1]) == KS_GROUP_Keypad) {
                if (MOD_ONESET(id, MOD_ANYSHIFT))
                        ksym = group[0];
                else
                        ksym = group[1];
        } else if (! MOD_ONESET(id, MOD_ANYSHIFT | MOD_CAPSLOCK)) {
                ksym = group[0];
        } else if (MOD_ONESET(id, MOD_CAPSLOCK)) {
                if (! MOD_ONESET(id, MOD_SHIFT_L | MOD_SHIFT_R))
                        ksym = group[0];
                else
                        ksym = group[1];
                if (ksym >= KS_a && ksym <= KS_z)
                        ksym += KS_A - KS_a;
                else if (ksym >= KS_agrave && ksym <= KS_thorn &&
                         ksym != KS_division)
                        ksym += KS_Agrave - KS_agrave;
        } else if (MOD_ONESET(id, MOD_ANYSHIFT)) {
                ksym = group[1];
        } else {
                ksym = group[0];
        }

        /* Process compose sequence and dead accents */
        res = KS_voidSymbol;

        switch (KS_GROUP(ksym)) {
        case KS_GROUP_Plain:
        case KS_GROUP_Keypad:
        case KS_GROUP_Function:
                res = ksym;
                break;

        case KS_GROUP_Mod:
                if (ksym == KS_Multi_key) {
                        update_modifier(id, 1, 0, MOD_COMPOSE);
                        id->t_composelen = 2;
                }
                break;

        case KS_GROUP_Dead:
                if (id->t_composelen == 0) {
                        update_modifier(id, 1, 0, MOD_COMPOSE);
                        id->t_composelen = 1;
                        id->t_composebuf[0] = ksym;
                } else
                        res = ksym;
                break;
        }

        if (res == KS_voidSymbol) {
                update_leds(id);
                return (0);
        }

        if (id->t_composelen > 0) {
                id->t_composebuf[2 - id->t_composelen] = res;
                if (--id->t_composelen == 0) {
                        res = wskbd_compose_value(id->t_composebuf);
                        update_modifier(id, 0, 0, MOD_COMPOSE);
                } else {
                        return (0);
                }
        }

        update_leds(id);

        /* We are done, return the symbol */
        if (KS_GROUP(res) == KS_GROUP_Plain) {
                if (MOD_ONESET(id, MOD_ANYCONTROL)) {
                        if ((res >= KS_at && res <= KS_z) || res == KS_space)
                                res = res & 0x1f;
                        else if (res == KS_2)
                                res = 0x00;
                        else if (res >= KS_3 && res <= KS_7)
                                res = KS_Escape + (res - KS_3);
                        else if (res == KS_8)
                                res = KS_Delete;
                        /* convert CTL-/ to ^_ as xterm does (undo in emacs) */
                        else if (res == KS_slash)
                                res = KS_underscore & 0x1f;
                }
                if (MOD_ONESET(id, MOD_ANYMETA)) {
                        if (id->t_flags & WSKFL_METAESC) {
                                id->t_symbols[0] = KS_Escape;
                                id->t_symbols[1] = res;
                                return (2);
                        } else
                                res |= 0x80;
                }
        }

        id->t_symbols[0] = res;
        return (1);
}

void
wskbd_set_evtrans(device_t dev, keysym_t *tab, int len)
{
        struct wskbd_softc *sc = device_private(dev);

        sc->sc_evtrans_len = len;
        sc->sc_evtrans = tab;
}