/*      $NetBSD: kd.c,v 1.61 2024/12/21 17:40:11 tsutsui Exp $  */

/*-
* Copyright (c) 1996 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Gordon W. Ross.
*
* 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.
*/

/*
* Keyboard/Display device.
*
* This driver exists simply to provide a tty device that
* the indirect console driver can point to.
* The kbd driver sends its input here.
* Output goes to the screen via PROM printf.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: kd.c,v 1.61 2024/12/21 17:40:11 tsutsui Exp $");

#include <sys/param.h>
#include <sys/proc.h>
#include <sys/systm.h>
#include <sys/ioctl.h>
#include <sys/tty.h>
#include <sys/file.h>
#include <sys/conf.h>
#include <sys/device.h>
#include <sys/kauth.h>

#include <machine/autoconf.h>
#include <machine/cpu.h>
#include <machine/mon.h>
#include <machine/psl.h>

#include <dev/cons.h>
#include <dev/sun/event_var.h>
#include <dev/sun/kbd_xlate.h>
#include <dev/sun/kbdvar.h>
#include <sun3/dev/zs_cons.h>

#include "fb.h"

#define PUT_WSIZE       64

struct kd_softc {
       struct  tty *kd_tty;

       /* Console input hook */
       struct cons_channel *kd_in;
};

/*
* There is no point in pretending there might be
* more than one keyboard/display device.
*/
static struct kd_softc kd_softc;
static int kd_is_console;

static int kdparam(struct tty *, struct termios *);
static void kdstart(struct tty *);
static void kd_init(struct kd_softc *);
static void kd_cons_input(int);
static void kd_later(void *);

static dev_type_open(kdopen);
static dev_type_close(kdclose);
static dev_type_read(kdread);
static dev_type_write(kdwrite);
static dev_type_ioctl(kdioctl);
static dev_type_tty(kdtty);
static dev_type_poll(kdpoll);

const struct cdevsw kd_cdevsw = {
       .d_open = kdopen,
       .d_close = kdclose,
       .d_read = kdread,
       .d_write = kdwrite,
       .d_ioctl = kdioctl,
       .d_stop = nostop,
       .d_tty = kdtty,
       .d_poll = kdpoll,
       .d_mmap = nommap,
       .d_kqfilter = ttykqfilter,
       .d_discard = nodiscard,
       .d_flag = D_TTY
};

/*
* Prepare the console tty; called on first open of /dev/console
*/
void
kd_init(struct kd_softc *kd)
{
       struct tty *tp;

       tp = tty_alloc();
       callout_setfunc(&tp->t_rstrt_ch, kd_later, tp);

       tp->t_oproc = kdstart;
       tp->t_param = kdparam;
       tp->t_dev = makedev(cdevsw_lookup_major(&kd_cdevsw), 0);

       tty_attach(tp);
       kd->kd_tty = tp;

       return;
}

static struct tty *
kdtty(dev_t dev)
{
       struct kd_softc *kd;

       kd = &kd_softc;         /* XXX */
       return (kd->kd_tty);
}

static int
kdopen(dev_t dev, int flag, int mode, struct lwp *l)
{
       struct kd_softc *kd;
       int error, s, unit;
       struct tty *tp;
static  int firstopen = 1;

       unit = minor(dev);
       if (unit != 0)
               return ENXIO;
       kd = &kd_softc;         /* XXX */
       if (firstopen) {
               kd_init(kd);
               firstopen = 0;
       }
       tp = kd->kd_tty;

       /* It's simpler to do this up here. */
       if (kauth_authorize_device_tty(l->l_cred, KAUTH_DEVICE_TTY_OPEN, tp))
               return (EBUSY);

       s = spltty();

       if ((tp->t_state & TS_ISOPEN) == 0) {
               /* First open. */

               /* Notify the input device that serves us */
               struct cons_channel *cc = kd->kd_in;
               if (cc != NULL &&
                   (error = (*cc->cc_iopen)(cc)) != 0) {
                       return (error);
               }

               ttychars(tp);
               tp->t_iflag = TTYDEF_IFLAG;
               tp->t_oflag = TTYDEF_OFLAG;
               tp->t_cflag = TTYDEF_CFLAG;
               tp->t_lflag = TTYDEF_LFLAG;
               tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
               (void) kdparam(tp, &tp->t_termios);
               ttsetwater(tp);
               /* Flush pending input?  Clear translator? */
               /* This (pseudo)device always has SOFTCAR */
               tp->t_state |= TS_CARR_ON;
       }

       splx(s);

       return ((*tp->t_linesw->l_open)(dev, tp));
}

static int
kdclose(dev_t dev, int flag, int mode, struct lwp *l)
{
       struct kd_softc *kd;
       struct tty *tp;
       struct cons_channel *cc;

       kd = &kd_softc;         /* XXX */
       tp = kd->kd_tty;

       /* XXX This is for cons.c. */
       if ((tp->t_state & TS_ISOPEN) == 0)
               return 0;

       (*tp->t_linesw->l_close)(tp, flag);
       ttyclose(tp);
       if ((cc = kd->kd_in) != NULL)
               (void)(*cc->cc_iclose)(cc);
       return (0);
}

static int
kdread(dev_t dev, struct uio *uio, int flag)
{
       struct kd_softc *kd;
       struct tty *tp;

       kd = &kd_softc;         /* XXX */
       tp = kd->kd_tty;

       return ((*tp->t_linesw->l_read)(tp, uio, flag));
}

static int
kdwrite(dev_t dev, struct uio *uio, int flag)
{
       struct kd_softc *kd;
       struct tty *tp;

       kd = &kd_softc;         /* XXX */
       tp = kd->kd_tty;

       return ((*tp->t_linesw->l_write)(tp, uio, flag));
}

static int
kdpoll(dev_t dev, int events, struct lwp *l)
{
       struct kd_softc *kd;
       struct tty *tp;

       kd = &kd_softc;         /* XXX */
       tp = kd->kd_tty;

       return ((*tp->t_linesw->l_poll)(tp, events, l));
}

static int
kdioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
{
       struct kd_softc *kd;
       struct tty *tp;
       int error;

       kd = &kd_softc;         /* XXX */
       tp = kd->kd_tty;

       error = (*tp->t_linesw->l_ioctl)(tp, cmd, data, flag, l);
       if (error != EPASSTHROUGH)
               return error;

       error = ttioctl(tp, cmd, data, flag, l);
       if (error != EPASSTHROUGH)
               return error;

       /* Handle any ioctl commands specific to kbd/display. */
       /* XXX - Send KB* ioctls to kbd module? */
       /* XXX - Send FB* ioctls to fb module?  */

       return EPASSTHROUGH;
}

static int
kdparam(struct tty *tp, struct termios *t)
{
       /* XXX - These are ignored... */
       tp->t_ispeed = t->c_ispeed;
       tp->t_ospeed = t->c_ospeed;
       tp->t_cflag = t->c_cflag;
       return 0;
}


static void kd_putfb(struct tty *);

static void
kdstart(struct tty *tp)
{
       struct clist *cl;
       int s1, s2;

       s1 = splsoftclock();
       s2 = spltty();
       if (tp->t_state & (TS_BUSY|TS_TTSTOP|TS_TIMEOUT))
               goto out;

       cl = &tp->t_outq;
       if (ttypull(tp)) {
               if (kd_is_console) {
                       tp->t_state |= TS_BUSY;
                       if ((s1 & PSL_IPL) == 0) {
                               /* called at level zero - update screen now. */
                               splx(s2);
                               kd_putfb(tp);
                               s2 = spltty();
                               tp->t_state &= ~TS_BUSY;
                       } else {
                               /* called at interrupt level - do it later */
                               callout_schedule(&tp->t_rstrt_ch, 0);
                       }
               } else {
                       /*
                        * This driver uses the PROM for writing the screen,
                        * and that only works if this is the console device.
                        * If this is not the console, just flush the output.
                        * Sorry.  (In that case, use xdm instead of getty.)
                        */
                       ndflush(cl, cl->c_cc);
               }
       }
out:
       splx(s2);
       splx(s1);
}

/*
* Timeout function to do delayed writes to the screen.
* Called at splsoftclock when requested by kdstart.
*/
static void
kd_later(void *tpaddr)
{
       struct tty *tp = tpaddr;
       int s;

       kd_putfb(tp);

       s = spltty();
       tp->t_state &= ~TS_BUSY;
       (*tp->t_linesw->l_start)(tp);
       splx(s);
}

/*
* Put text on the screen using the PROM monitor.
* This can take a while, so to avoid missing
* interrupts, this is called at splsoftclock.
*/
static void
kd_putfb(struct tty *tp)
{
       char buf[PUT_WSIZE];
       struct clist *cl = &tp->t_outq;
       char *p, *end;
       int len;

       while ((len = q_to_b(cl, buf, PUT_WSIZE-1)) > 0) {
               /* PROM will barf if high bits are set. */
               p = buf;
               end = buf + len;
               while (p < end)
                       *p++ &= 0x7f;
               (romVectorPtr->fbWriteStr)(buf, len);
       }
}

void
cons_attach_input(struct cons_channel *cc, struct consdev *cn)
{
       struct kd_softc *kd = &kd_softc;

       kd->kd_in = cc;
       cc->cc_upstream = kd_cons_input;
}

/*
* Default PROM-based console input stream
*/
static int kd_rom_iopen(struct cons_channel *);
static int kd_rom_iclose(struct cons_channel *);

static struct cons_channel prom_cons_channel;

int
kd_rom_iopen(struct cons_channel *cc)
{
       /* No-op */
       return (0);
}

int
kd_rom_iclose(struct cons_channel *cc)
{
       /* No-op */
       return (0);
}

/*
* Our "interrupt" routine for input. This is called by
* the keyboard driver (dev/sun/kbd.c) at spltty.
*/
void
kd_cons_input(int c)
{
       struct kd_softc *kd = &kd_softc;
       struct tty *tp;

       /* XXX: Make sure the device is open. */
       tp = kd->kd_tty;
       if (tp == NULL)
               return;
       if ((tp->t_state & TS_ISOPEN) == 0)
               return;

       (*tp->t_linesw->l_rint)(c, tp);
}


/****************************************************************
* kd console support
****************************************************************/

/* The debugger gets its own key translation state. */
static struct kbd_state kdcn_state;

static void kdcnprobe(struct consdev *);
static void kdcninit(struct consdev *);
static int  kdcngetc(dev_t);
static void kdcnputc(dev_t, int);
static void kdcnpollc(dev_t, int);

struct consdev consdev_kd = {
       kdcnprobe,
       kdcninit,
       kdcngetc,
       kdcnputc,
       kdcnpollc,
       NULL,
};

/* We never call this. */
static void
kdcnprobe(struct consdev *cn)
{
}

static void
kdcninit(struct consdev *cn)
{
       struct kbd_state *ks = &kdcn_state;

       cn->cn_dev = makedev(cdevsw_lookup_major(&kd_cdevsw), 0);
       cn->cn_pri = CN_INTERNAL;

       /* This prepares kbd_translate() */
       ks->kbd_id = KBD_MIN_TYPE;
       kbd_xlate_init(ks);

       /* Set up initial PROM input channel for /dev/console */
       prom_cons_channel.cc_private = NULL;
       prom_cons_channel.cc_iopen = kd_rom_iopen;
       prom_cons_channel.cc_iclose = kd_rom_iclose;
       cons_attach_input(&prom_cons_channel, cn);

       /* Indicate that it is OK to use the PROM fbwrite */
       kd_is_console = 1;
}

static int
kdcngetc(dev_t dev)
{
       struct kbd_state *ks = &kdcn_state;
       int code, class, data, keysym;

       for (;;) {
               code = zs_getc(zs_conschan);
               keysym = kbd_code_to_keysym(ks, code);
               class = KEYSYM_CLASS(keysym);

               switch (class) {
               case KEYSYM_ASCII:
                       goto out;

               case KEYSYM_CLRMOD:
               case KEYSYM_SETMOD:
                       data = (keysym & 0x1F);
                       /* Only allow ctrl or shift. */
                       if (data > KBMOD_SHIFT_R)
                               break;
                       data = 1 << data;
                       if (class == KEYSYM_SETMOD)
                               ks->kbd_modbits |= data;
                       else
                               ks->kbd_modbits &= ~data;
                       break;

               case KEYSYM_ALL_UP:
                       /* No toggle keys here. */
                       ks->kbd_modbits = 0;
                       break;

               default:        /* ignore all other keysyms */
                       break;
               }
       }
out:
       return (keysym);
}

static void
kdcnputc(dev_t dev, int c)
{
       (romVectorPtr->fbWriteChar)(c & 0x7f);
}

static void
kdcnpollc(dev_t dev, int on)
{
       struct kbd_state *ks = &kdcn_state;

       if (on) {
               /* Entering debugger. */
#if NFB > 0
               fb_unblank();
#endif
               /* Clear shift keys too. */
               ks->kbd_modbits = 0;
       } else {
               /* Resuming kernel. */
       }
}