/*      $NetBSD: bmd.c,v 1.28 2024/01/07 07:58:33 isaki Exp $   */

/*
* Copyright (c) 2002 Tetsuya Isaki. 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.
*/

/*
* Nereid bank memory disk
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: bmd.c,v 1.28 2024/01/07 07:58:33 isaki Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/buf.h>
#include <sys/conf.h>
#include <sys/device.h>
#include <sys/kernel.h>
#include <sys/stat.h>
#include <sys/disk.h>
#include <sys/disklabel.h>
#include <sys/ioctl.h>
#include <sys/fcntl.h>
#include <sys/proc.h>

#include <machine/bus.h>
#include <machine/cpu.h>

#include <arch/x68k/dev/intiovar.h>

#include "ioconf.h"

#define BMD_ADDR1       (0xece3f0)
#define BMD_ADDR2       (0xecebf0)

#define BMD_PAGESIZE    (0x10000)       /* 64KB */
#define BMD_BSIZE       (512)
#define BLKS_PER_PAGE   (BMD_PAGESIZE / BMD_BSIZE)

#define BMD_PAGE        (0)
#define BMD_CTRL        (1)
#define BMD_CTRL_ENABLE (0x80)  /* DIP8: 1=Enable, 0=Disable */
#define BMD_CTRL_MEMORY (0x40)  /*       1=16M available, 0=4M available */
#define BMD_CTRL_WINDOW (0x20)  /* DIP6: 1=0xee0000, 0=0xef0000 */


#define BMD_UNIT(dev)   (minor(dev) / 8)

#ifdef BMD_DEBUG
#define DPRINTF(x)      printf x
#else
#define DPRINTF(x)      /* nothing */
#endif

struct bmd_softc {
       struct disk sc_dkdev;
       bus_space_tag_t    sc_iot;
       bus_space_handle_t sc_ioh;
       bus_space_handle_t sc_bank;

       int sc_maxpage;
       int sc_window;

       int sc_flags;
#define BMD_OPENBLK     (0x01)
#define BMD_OPENCHR     (0x02)
#define BMD_OPEN        (BMD_OPENBLK | BMD_OPENCHR)
};

static int  bmd_match(device_t, cfdata_t, void *);
static void bmd_attach(device_t, device_t, void *);
static int  bmd_getdisklabel(struct bmd_softc *, dev_t);

CFATTACH_DECL_NEW(bmd, sizeof(struct bmd_softc),
       bmd_match, bmd_attach, NULL, NULL);

dev_type_open(bmdopen);
dev_type_close(bmdclose);
dev_type_read(bmdread);
dev_type_write(bmdwrite);
dev_type_ioctl(bmdioctl);
dev_type_strategy(bmdstrategy);
dev_type_dump(bmddump);
dev_type_size(bmdsize);

const struct bdevsw bmd_bdevsw = {
       .d_open = bmdopen,
       .d_close = bmdclose,
       .d_strategy = bmdstrategy,
       .d_ioctl = bmdioctl,
       .d_dump = bmddump,
       .d_psize = bmdsize,
       .d_discard = nodiscard,
       .d_flag = D_DISK
};

const struct cdevsw bmd_cdevsw = {
       .d_open = bmdopen,
       .d_close = bmdclose,
       .d_read = bmdread,
       .d_write = bmdwrite,
       .d_ioctl = bmdioctl,
       .d_stop = nostop,
       .d_tty = notty,
       .d_poll = nopoll,
       .d_mmap = nommap,
       .d_kqfilter = nokqfilter,
       .d_discard = nodiscard,
       .d_flag = D_DISK
};

struct dkdriver bmddkdriver = {
       .d_strategy = bmdstrategy
};

static int
bmd_match(device_t parent, cfdata_t cf, void *aux)
{
       struct intio_attach_args *ia = aux;
       bus_space_tag_t iot = ia->ia_bst;
       bus_space_handle_t ioh;
       int window;
       int r;

       if (ia->ia_addr == INTIOCF_ADDR_DEFAULT)
               ia->ia_addr = BMD_ADDR1;

       /* fixed parameter */
       if (ia->ia_addr != BMD_ADDR1 && ia->ia_addr != BMD_ADDR2)
               return (0);

       /* Check CTRL addr */
       if (badaddr((void *)IIOV(ia->ia_addr)))
               return (0);

       ia->ia_size = 2;
       if (bus_space_map(iot, ia->ia_addr, ia->ia_size, 0, &ioh))
               return (0);

       /* Check window addr */
       r = bus_space_read_1(iot, ioh, BMD_CTRL);
       bus_space_unmap(iot, ioh, ia->ia_size);

       if ((r & BMD_CTRL_WINDOW))
               window = 0xef0000;
       else
               window = 0xee0000;
       if (badaddr((void *)IIOV(window)))
               return (0);

       return (1);
}

static void
bmd_attach(device_t parent, device_t self, void *aux)
{
       struct bmd_softc *sc = device_private(self);
       struct intio_attach_args *ia = aux;
       bus_space_tag_t iot = ia->ia_bst;
       bus_space_handle_t ioh;
       u_int8_t r;

       aprint_normal(": Nereid Bank Memory Disk\n");

       /* Map I/O space */
       ia->ia_size = 2;
       if (bus_space_map(iot, ia->ia_addr, ia->ia_size, 0, &ioh)) {
               aprint_error_dev(self, "can't map I/O space\n");
               return;
       }

       sc->sc_iot = iot;
       sc->sc_ioh = ioh;

       /* read control register */
       r = bus_space_read_1(sc->sc_iot, sc->sc_ioh, BMD_CTRL);

       /* check enable-bit */
       if ((r & BMD_CTRL_ENABLE) == 0) {
               aprint_error_dev(self, "disabled by DIP-SW 8\n");
               return;
       }

       if ((r & BMD_CTRL_MEMORY))
               sc->sc_maxpage = 256;
       else
               sc->sc_maxpage = 64;

       if ((r & BMD_CTRL_WINDOW))
               sc->sc_window = 0xef0000;
       else
               sc->sc_window = 0xee0000;

       /* Map bank area */
       if (bus_space_map(iot, sc->sc_window, BMD_PAGESIZE, 0, &sc->sc_bank)) {
               aprint_error_dev(self, "can't map bank area: 0x%x\n",
                       sc->sc_window);
               return;
       }

       aprint_normal_dev(self, "%d MB, 0x%x(64KB) x %d pages\n",
               (sc->sc_maxpage / 16), sc->sc_window, sc->sc_maxpage);

       disk_init(&sc->sc_dkdev, device_xname(self), &bmddkdriver);
       disk_attach(&sc->sc_dkdev);
}

int
bmdopen(dev_t dev, int oflags, int devtype, struct lwp *l)
{
       struct bmd_softc *sc;

       DPRINTF(("%s%d\n", __func__, BMD_UNIT(dev)));

       sc = device_lookup_private(&bmd_cd, BMD_UNIT(dev));
       if (sc == NULL)
               return ENXIO;

       switch (devtype) {
       case S_IFCHR:
               sc->sc_flags |= BMD_OPENCHR;
               break;
       case S_IFBLK:
               sc->sc_flags |= BMD_OPENBLK;
               break;
       }

       bmd_getdisklabel(sc, dev);

       return (0);
}

int
bmdclose(dev_t dev, int fflag, int devtype, struct lwp *l)
{
       struct bmd_softc *sc = device_lookup_private(&bmd_cd, BMD_UNIT(dev));

       DPRINTF(("%s%d\n", __func__, BMD_UNIT(dev)));

       switch (devtype) {
       case S_IFCHR:
               sc->sc_flags &= ~BMD_OPENCHR;
               break;
       case S_IFBLK:
               sc->sc_flags &= ~BMD_OPENBLK;
               break;
       }

       return (0);
}

void
bmdstrategy(struct buf *bp)
{
       int unit = BMD_UNIT(bp->b_dev);
       struct bmd_softc *sc;
       int offset, disksize, resid;
       int page, pg_offset, pg_resid;
       void *data;

       if (unit >= bmd_cd.cd_ndevs) {
               bp->b_error = ENXIO;
               goto done;
       }

       sc = device_lookup_private(&bmd_cd, BMD_UNIT(bp->b_dev));
       if (sc == NULL) {
               bp->b_error = ENXIO;
               goto done;
       }

       DPRINTF(("bmdstrategy: %s blkno %" PRIx64 " bcount %d:",
               (bp->b_flags & B_READ) ? "read " : "write",
               bp->b_blkno, bp->b_bcount));

       bp->b_resid = bp->b_bcount;
       offset = (bp->b_blkno << DEV_BSHIFT);
       disksize = sc->sc_maxpage * BMD_PAGESIZE;
       if (offset >= disksize) {
               /* EOF if read, EIO if write */
               if (bp->b_flags & B_READ)
                       goto done;
               bp->b_error = EIO;
               goto done;
       }

       resid = bp->b_resid;
       if (resid > disksize - offset)
               resid = disksize - offset;

       data = bp->b_data;
       do {
               page = offset / BMD_PAGESIZE;
               pg_offset = offset % BMD_PAGESIZE;

               /* length */
               pg_resid = MIN(resid, BMD_PAGESIZE - pg_offset);

               /* switch bank page */
               bus_space_write_1(sc->sc_iot, sc->sc_ioh, BMD_PAGE, page);

               /* XXX we should use DMA transfer? */
               if ((bp->b_flags & B_READ)) {
                       bus_space_read_region_1(sc->sc_iot, sc->sc_bank,
                               pg_offset, data, pg_resid);
               } else {
                       bus_space_write_region_1(sc->sc_iot, sc->sc_bank,
                               pg_offset, data, pg_resid);
               }

               data = (char *)data + pg_resid;
               offset += pg_resid;
               resid -= pg_resid;
               bp->b_resid -= pg_resid;
       } while (resid > 0);

       DPRINTF(("\n"));

done:
       biodone(bp);
}

int
bmdioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
{
       struct bmd_softc *sc;
       struct disklabel dl;
       int error;

       DPRINTF(("%s%d %ld\n", __func__, BMD_UNIT(dev), cmd));

       sc = device_lookup_private(&bmd_cd, BMD_UNIT(dev));

       if (sc == NULL)
               return ENXIO;

       error = disk_ioctl(&sc->sc_dkdev, dev, cmd, data, flag, l);
       if (error != EPASSTHROUGH)
               return error;

       switch (cmd) {
       case DIOCWDINFO:
               if ((flag & FWRITE) == 0)
                       return EBADF;

               error = setdisklabel(&dl, (struct disklabel *)data, 0, NULL);
               if (error)
                       return error;
               error = writedisklabel(dev, bmdstrategy, &dl, NULL);
               return error;

       default:
               return EINVAL;
       }
       return 0;
}

int
bmddump(dev_t dev, daddr_t blkno, void *va, size_t size)
{

       DPRINTF(("%s%d ", __func__, BMD_UNIT(dev)));
       return ENODEV;
}

int
bmdsize(dev_t dev)
{
       struct bmd_softc *sc;

       DPRINTF(("%s%d ", __func__, BMD_UNIT(dev)));

       sc = device_lookup_private(&bmd_cd, BMD_UNIT(dev));
       if (sc == NULL)
               return 0;

       return (sc->sc_maxpage * BMD_PAGESIZE) >> DEV_BSHIFT;
}

int
bmdread(dev_t dev, struct uio *uio, int ioflag)
{
       return physio(bmdstrategy, NULL, dev, B_READ, minphys, uio);
}

int
bmdwrite(dev_t dev, struct uio *uio, int ioflag)
{
       return physio(bmdstrategy, NULL, dev, B_WRITE, minphys, uio);
}

static int
bmd_getdisklabel(struct bmd_softc *sc, dev_t dev)
{
       struct disklabel *lp;
       int part;

       part = DISKPART(dev);
       lp = sc->sc_dkdev.dk_label;
       memset(lp, 0, sizeof(struct disklabel));

       lp->d_secsize     = BMD_BSIZE;
       lp->d_nsectors    = BLKS_PER_PAGE;
       lp->d_ntracks     = sc->sc_maxpage;
       lp->d_ncylinders  = 1;
       lp->d_secpercyl   = lp->d_nsectors * lp->d_ntracks;
       lp->d_secperunit  = lp->d_secpercyl * lp->d_ncylinders;

       lp->d_type        = DKTYPE_LD;
       lp->d_rpm         = 300;        /* dummy */
       lp->d_interleave  = 1;  /* dummy? */

       lp->d_npartitions = part + 1;
       lp->d_bbsize = 8192;
       lp->d_sbsize = 8192;    /* ? */

       lp->d_magic       = DISKMAGIC;
       lp->d_magic2      = DISKMAGIC;
       lp->d_checksum    = dkcksum(lp);

       lp->d_partitions[part].p_size   = lp->d_secperunit;
       lp->d_partitions[part].p_fstype = FS_BSDFFS;
       lp->d_partitions[part].p_fsize  = 1024;
       lp->d_partitions[part].p_frag   = 8;

       return (0);
}