root/sys/dev/wscons/wsdisplay_compat_usl.c
/* $OpenBSD: wsdisplay_compat_usl.c,v 1.34 2024/04/13 23:44:11 jsg Exp $ */
/* $NetBSD: wsdisplay_compat_usl.c,v 1.12 2000/03/23 07:01:47 thorpej Exp $ */

/*
 * Copyright (c) 1998
 *      Matthias Drochner.  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.
 *
 * 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.
 *
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/timeout.h>
#include <sys/kernel.h>
#include <sys/proc.h>
#include <sys/signalvar.h>
#include <sys/malloc.h>
#include <sys/errno.h>
#include <sys/fcntl.h>

#include <dev/wscons/wsconsio.h>
#include <dev/wscons/wsdisplayvar.h>
#include <dev/wscons/wscons_callbacks.h>
#include <dev/wscons/wsdisplay_usl_io.h>

#ifdef WSDISPLAY_DEBUG
#define DPRINTF(x)       if (wsdisplaydebug) printf x
int     wsdisplaydebug = 0;
#else
#define DPRINTF(x)
#endif

struct usl_syncdata {
        struct wsscreen *s_scr;
        struct process *s_process;
        pid_t s_pid;
        int s_flags;
#define SF_DETACHPENDING 1
#define SF_ATTACHPENDING 2
        int s_acqsig, s_relsig;
        int s_frsig; /* unused */
        void (*s_callback)(void *, int, int);
        void *s_cbarg;
        struct timeout s_attach_ch;
        struct timeout s_detach_ch;
};

int usl_sync_init(struct wsscreen *, struct usl_syncdata **,
                       struct process *, int, int, int);
void usl_sync_done(struct usl_syncdata *);
int usl_sync_check(struct usl_syncdata *);
struct usl_syncdata *usl_sync_get(struct wsscreen *);

int usl_detachproc(void *, int, void (*)(void *, int, int), void *);
int usl_detachack(struct usl_syncdata *, int);
void usl_detachtimeout(void *);
int usl_attachproc(void *, int, void (*)(void *, int, int), void *);
int usl_attachack(struct usl_syncdata *, int);
void usl_attachtimeout(void *);

static const struct wscons_syncops usl_syncops = {
        usl_detachproc,
        usl_attachproc,
#define _usl_sync_check ((int (*)(void *))usl_sync_check)
        _usl_sync_check,
#define _usl_sync_destroy ((void (*)(void *))usl_sync_done)
        _usl_sync_destroy
};

#ifndef WSCOMPAT_USL_SYNCTIMEOUT
#define WSCOMPAT_USL_SYNCTIMEOUT 5 /* seconds */
#endif
static int wscompat_usl_synctimeout = WSCOMPAT_USL_SYNCTIMEOUT;

int
usl_sync_init(struct wsscreen *scr, struct usl_syncdata **sdp,
    struct process *pr, int acqsig, int relsig, int frsig)
{
        struct usl_syncdata *sd;
        int res;

        if (acqsig <= 0 || acqsig >= NSIG || relsig <= 0 || relsig >= NSIG ||
            frsig <= 0 || frsig >= NSIG)
                return (EINVAL);
        sd = malloc(sizeof(*sd), M_DEVBUF, M_NOWAIT);
        if (!sd)
                return (ENOMEM);
        sd->s_scr = scr;
        sd->s_process = pr;
        sd->s_pid = pr->ps_pid;
        sd->s_flags = 0;
        sd->s_acqsig = acqsig;
        sd->s_relsig = relsig;
        sd->s_frsig = frsig;
        timeout_set(&sd->s_attach_ch, usl_attachtimeout, sd);
        timeout_set(&sd->s_detach_ch, usl_detachtimeout, sd);
        res = wsscreen_attach_sync(scr, &usl_syncops, sd);
        if (res) {
                free(sd, M_DEVBUF, sizeof(*sd));
                return (res);
        }
        *sdp = sd;
        return (0);
}

void
usl_sync_done(struct usl_syncdata *sd)
{
        if (sd->s_flags & SF_DETACHPENDING) {
                timeout_del(&sd->s_detach_ch);
                (*sd->s_callback)(sd->s_cbarg, 0, 0);
        }
        if (sd->s_flags & SF_ATTACHPENDING) {
                timeout_del(&sd->s_attach_ch);
                (*sd->s_callback)(sd->s_cbarg, ENXIO, 0);
        }
        wsscreen_detach_sync(sd->s_scr);
        free(sd, M_DEVBUF, sizeof(*sd));
}

int
usl_sync_check(struct usl_syncdata *sd)
{
        if (sd->s_process == prfind(sd->s_pid))
                return (1);
        DPRINTF(("usl_sync_check: process %d died\n", sd->s_pid));
        usl_sync_done(sd);
        return (0);
}

struct usl_syncdata *
usl_sync_get(struct wsscreen *scr)
{
        struct usl_syncdata *sd;

        if (wsscreen_lookup_sync(scr, &usl_syncops, (void **)&sd))
                return (0);
        return (sd);
}

int
usl_detachproc(void *cookie, int waitok, void (*callback)(void *, int, int),
    void *cbarg)
{
        struct usl_syncdata *sd = cookie;

        if (!usl_sync_check(sd))
                return (0);

        /* we really need a callback */
        if (!callback)
                return (EINVAL);

        /*
         * Normally, this is called from the controlling process.
         * It is supposed to reply with a VT_RELDISP ioctl(), so
         * it is not useful to tsleep() here.
         */
        sd->s_callback = callback;
        sd->s_cbarg = cbarg;
        sd->s_flags |= SF_DETACHPENDING;
        prsignal(sd->s_process, sd->s_relsig);
        timeout_add_sec(&sd->s_detach_ch, wscompat_usl_synctimeout);

        return (EAGAIN);
}

int
usl_detachack(struct usl_syncdata *sd, int ack)
{
        if (!(sd->s_flags & SF_DETACHPENDING)) {
                DPRINTF(("usl_detachack: not detaching\n"));
                return (EINVAL);
        }

        timeout_del(&sd->s_detach_ch);
        sd->s_flags &= ~SF_DETACHPENDING;

        if (sd->s_callback)
                (*sd->s_callback)(sd->s_cbarg, (ack ? 0 : EIO), 1);

        return (0);
}

void
usl_detachtimeout(void *arg)
{
        struct usl_syncdata *sd = arg;

        DPRINTF(("usl_detachtimeout\n"));

        if (!(sd->s_flags & SF_DETACHPENDING)) {
                DPRINTF(("usl_detachtimeout: not detaching\n"));
                return;
        }

        sd->s_flags &= ~SF_DETACHPENDING;

        if (sd->s_callback)
                (*sd->s_callback)(sd->s_cbarg, EIO, 0);

        (void) usl_sync_check(sd);
}

int
usl_attachproc(void *cookie, int waitok, void (*callback)(void *, int, int),
    void *cbarg)
{
        struct usl_syncdata *sd = cookie;

        if (!usl_sync_check(sd))
                return (0);

        /* we really need a callback */
        if (!callback)
                return (EINVAL);

        sd->s_callback = callback;
        sd->s_cbarg = cbarg;
        sd->s_flags |= SF_ATTACHPENDING;
        prsignal(sd->s_process, sd->s_acqsig);
        timeout_add_sec(&sd->s_attach_ch, wscompat_usl_synctimeout);

        return (EAGAIN);
}

int
usl_attachack(struct usl_syncdata *sd, int ack)
{
        if (!(sd->s_flags & SF_ATTACHPENDING)) {
                DPRINTF(("usl_attachack: not attaching\n"));
                return (EINVAL);
        }

        timeout_del(&sd->s_attach_ch);
        sd->s_flags &= ~SF_ATTACHPENDING;

        if (sd->s_callback)
                (*sd->s_callback)(sd->s_cbarg, (ack ? 0 : EIO), 1);

        return (0);
}

void
usl_attachtimeout(void *arg)
{
        struct usl_syncdata *sd = arg;

        DPRINTF(("usl_attachtimeout\n"));

        if (!(sd->s_flags & SF_ATTACHPENDING)) {
                DPRINTF(("usl_attachtimeout: not attaching\n"));
                return;
        }

        sd->s_flags &= ~SF_ATTACHPENDING;

        if (sd->s_callback)
                (*sd->s_callback)(sd->s_cbarg, EIO, 0);

        (void) usl_sync_check(sd);
}

int
wsdisplay_usl_ioctl1(struct wsdisplay_softc *sc, u_long cmd, caddr_t data,
    int flag, struct proc *p)
{
        int idx, maxidx;

        switch (cmd) {
            case VT_OPENQRY:
                maxidx = wsdisplay_maxscreenidx(sc);
                for (idx = 0; idx <= maxidx; idx++) {
                        if (wsdisplay_screenstate(sc, idx) == 0) {
                                *(int *)data = idx + 1;
                                return (0);
                        }
                }
                return (ENXIO);
            case VT_GETACTIVE:
                idx = wsdisplay_getactivescreen(sc);
                *(int *)data = idx + 1;
                return (0);
            case VT_ACTIVATE:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                idx = *(long *)data - 1;
                if (idx < 0)
                        return (EINVAL);
                return (wsdisplay_switch((struct device *)sc, idx, 1));
            case VT_WAITACTIVE:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                idx = *(long *)data - 1;
                if (idx < 0)
                        return (EINVAL);
                return (wsscreen_switchwait(sc, idx));
            case VT_GETSTATE:
#define ss ((struct vt_stat *)data)
                idx = wsdisplay_getactivescreen(sc);
                ss->v_active = idx + 1;
                ss->v_state = 0;
                maxidx = wsdisplay_maxscreenidx(sc);
                for (idx = 0; idx <= maxidx; idx++)
                        if (wsdisplay_screenstate(sc, idx) == EBUSY)
                                ss->v_state |= (1 << (idx + 1));
#undef ss
                return (0);

            default:
                return (-1);
        }

        return (0);
}

int
wsdisplay_usl_ioctl2(struct wsdisplay_softc *sc, struct wsscreen *scr,
    u_long cmd, caddr_t data, int flag, struct proc *p)
{
        int intarg, res;
        u_long req;
        void *arg;
        struct usl_syncdata *sd;
        struct wskbd_bell_data bd;

        switch (cmd) {
            case VT_SETMODE:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
#define newmode ((struct vt_mode *)data)
                if (newmode->mode == VT_PROCESS) {
                        res = usl_sync_init(scr, &sd, p->p_p, newmode->acqsig,
                                            newmode->relsig, newmode->frsig);
                        if (res)
                                return (res);
                } else {
                        sd = usl_sync_get(scr);
                        if (sd)
                                usl_sync_done(sd);
                }
#undef newmode
                return (0);
            case VT_GETMODE:
#define cmode ((struct vt_mode *)data)
                sd = usl_sync_get(scr);
                if (sd) {
                        cmode->mode = VT_PROCESS;
                        cmode->relsig = sd->s_relsig;
                        cmode->acqsig = sd->s_acqsig;
                        cmode->frsig = sd->s_frsig;
                } else
                        cmode->mode = VT_AUTO;
#undef cmode
                return (0);
            case VT_RELDISP:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
#define d ((int)(*(long *)data))
                sd = usl_sync_get(scr);
                if (!sd)
                        return (EINVAL);
                switch (d) {
                    case VT_FALSE:
                    case VT_TRUE:
                        return (usl_detachack(sd, (d == VT_TRUE)));
                    case VT_ACKACQ:
                        return (usl_attachack(sd, 1));
                    default:
                        return (EINVAL);
                }
#undef d
                return (0);

            case KDENABIO:
            case KDDISABIO:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                /*
                 * This is a lie, but non-x86 platforms are not supposed to
                 * issue these ioctls anyway.
                 */
                return (0);

            case KDSETRAD:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                /* XXX ignore for now */
                return (0);

            default:
                return (-1);

            /*
             * the following are converted to wsdisplay ioctls
             */
            case KDSETMODE:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                req = WSDISPLAYIO_SMODE;
#define d ((int)(*(long *)data))
                switch (d) {
                    case KD_GRAPHICS:
                        intarg = WSDISPLAYIO_MODE_MAPPED;
                        break;
                    case KD_TEXT:
                        intarg = WSDISPLAYIO_MODE_EMUL;
                        break;
                    default:
                        return (EINVAL);
                }
#undef d
                arg = &intarg;
                break;
            case KDMKTONE:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                req = WSKBDIO_COMPLEXBELL;
#define d ((int)(*(long *)data))
                if (d) {
#define PCVT_SYSBEEPF   1193182
                        if (d >> 16) {
                                bd.which = WSKBD_BELL_DOPERIOD;
                                bd.period = d >> 16; /* ms */
                        } else
                                bd.which = 0;
                        if (d & 0xffff) {
                                bd.which |= WSKBD_BELL_DOPITCH;
                                bd.pitch = PCVT_SYSBEEPF/(d & 0xffff); /* Hz */
                        }
                } else
                        bd.which = 0; /* default */
#undef d
                arg = &bd;
                break;
            case KDSETLED:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                req = WSKBDIO_SETLEDS;
                intarg = 0;
#define d ((int)(*(long *)data))
                if (d & LED_CAP)
                        intarg |= WSKBD_LED_CAPS;
                if (d & LED_NUM)
                        intarg |= WSKBD_LED_NUM;
                if (d & LED_SCR)
                        intarg |= WSKBD_LED_SCROLL;
#undef d
                arg = &intarg;
                break;
            case KDGETLED:
                req = WSKBDIO_GETLEDS;
                arg = &intarg;
                break;
#ifdef WSDISPLAY_COMPAT_RAWKBD
            case KDSKBMODE:
                if ((flag & FWRITE) == 0)
                        return (EACCES);
                req = WSKBDIO_SETMODE;
                switch ((int)(*(long *)data)) {
                    case K_RAW:
                        intarg = WSKBD_RAW;
                        break;
                    case K_XLATE:
                        intarg = WSKBD_TRANSLATED;
                        break;
                    default:
                        return (EINVAL);
                }
                arg = &intarg;
                break;
            case KDGKBMODE:
                req = WSKBDIO_GETMODE;
                arg = &intarg;
                break;
#endif
        }

        res = wsdisplay_internal_ioctl(sc, scr, req, arg, flag, p);
        if (res)
                return (res);

        switch (cmd) {
            case KDGETLED:
#define d (*(int *)data)
                d = 0;
                if (intarg & WSKBD_LED_CAPS)
                        d |= LED_CAP;
                if (intarg & WSKBD_LED_NUM)
                        d |= LED_NUM;
                if (intarg & WSKBD_LED_SCROLL)
                        d |= LED_SCR;
#undef d
                break;
#ifdef WSDISPLAY_COMPAT_RAWKBD
            case KDGKBMODE:
                *(int *)data = (intarg == WSKBD_RAW ? K_RAW : K_XLATE);
                break;
#endif
        }

        return (0);
}