/*      $NetBSD: asc.c,v 1.24 2023/12/20 15:29:05 thorpej Exp $ */
/*-
* Copyright (c) 2000 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Wayne Knowles
*
* 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.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: asc.c,v 1.24 2023/12/20 15:29:05 thorpej Exp $");

#include <sys/types.h>
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/errno.h>
#include <sys/device.h>
#include <sys/buf.h>

#include <uvm/uvm_extern.h>

#include <dev/scsipi/scsi_all.h>
#include <dev/scsipi/scsipi_all.h>
#include <dev/scsipi/scsiconf.h>
#include <dev/scsipi/scsi_message.h>

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

#include <mipsco/obio/rambo.h>

#include <dev/ic/ncr53c9xreg.h>
#include <dev/ic/ncr53c9xvar.h>

struct asc_softc {
       struct ncr53c9x_softc   sc_ncr53c9x;    /* glue to MI code */
       struct evcnt            sc_intrcnt;     /* Interrupt counter */
       bus_space_tag_t         sc_bst;
       bus_space_handle_t      sc_bsh;         /* NCR 53c94 registers */
       bus_space_handle_t      dm_bsh;         /* RAMBO registers */
       bus_dma_tag_t           sc_dmat;
       bus_dmamap_t            sc_dmamap;
       uint8_t                 **sc_dmaaddr;
       size_t                  *sc_dmalen;
       size_t                  sc_dmasize;
       int                     sc_flags;
#define DMA_IDLE        0x0
#define DMA_PULLUP      0x1
#define DMA_ACTIVE      0x2
#define DMA_MAPLOADED   0x4
       uint32_t                dm_mode;
       int                     dm_curseg;
};

static int      ascmatch(device_t, cfdata_t, void *);
static void     ascattach(device_t, device_t, void *);

CFATTACH_DECL_NEW(asc, sizeof(struct asc_softc),
   ascmatch, ascattach, NULL, NULL);

/*
* Functions and the switch for the MI code.
*/
static uint8_t  asc_read_reg(struct ncr53c9x_softc *, int);
static void     asc_write_reg(struct ncr53c9x_softc *, int, uint8_t);
static int      asc_dma_isintr(struct ncr53c9x_softc *);
static void     asc_dma_reset(struct ncr53c9x_softc *);
static int      asc_dma_intr(struct ncr53c9x_softc *);
static int      asc_dma_setup(struct ncr53c9x_softc *, uint8_t **,
                                   size_t *, int, size_t *);
static void     asc_dma_go(struct ncr53c9x_softc *);
static void     asc_dma_stop(struct ncr53c9x_softc *);
static int      asc_dma_isactive(struct ncr53c9x_softc *);

static struct ncr53c9x_glue asc_glue = {
       asc_read_reg,
       asc_write_reg,
       asc_dma_isintr,
       asc_dma_reset,
       asc_dma_intr,
       asc_dma_setup,
       asc_dma_go,
       asc_dma_stop,
       asc_dma_isactive,
       NULL,                   /* gl_clear_latched_intr */
};

static int      asc_intr(void *);

#define MAX_SCSI_XFER   (64 * 1024)
#define MAX_DMA_SZ      MAX_SCSI_XFER
#define DMA_SEGS        (MAX_DMA_SZ / PAGE_SIZE)

static int
ascmatch(device_t parent, cfdata_t cf, void *aux)
{

       return 1;
}

static void
ascattach(device_t parent, device_t self, void *aux)
{
       struct asc_softc *esc = device_private(self);
       struct ncr53c9x_softc *sc = &esc->sc_ncr53c9x;
       struct confargs *ca = aux;

       /*
        * Set up glue for MI code early; we use some of it here.
        */
       sc->sc_dev = self;
       sc->sc_glue = &asc_glue;

       esc->sc_bst = ca->ca_bustag;
       esc->sc_dmat = ca->ca_dmatag;

       if (bus_space_map(ca->ca_bustag, ca->ca_addr,
           16 * 4, /* sizeof (ncr53c9xreg) */
           BUS_SPACE_MAP_LINEAR,
           &esc->sc_bsh) != 0) {
               aprint_error(": cannot map registers\n");
               return;
       }

       if (bus_space_map(ca->ca_bustag, RAMBO_BASE, sizeof(struct rambo_ch),
           BUS_SPACE_MAP_LINEAR, &esc->dm_bsh) != 0) {
               aprint_error(": cannot map DMA registers\n");
               return;
       }

       if (bus_dmamap_create(esc->sc_dmat, MAX_DMA_SZ,
           DMA_SEGS, MAX_DMA_SZ, RB_BOUNDRY, BUS_DMA_WAITOK,
           &esc->sc_dmamap) != 0) {
               aprint_error(": failed to create dmamap\n");
               return;
       }

       evcnt_attach_dynamic(&esc->sc_intrcnt, EVCNT_TYPE_INTR, NULL,
           device_xname(self), "intr");

       esc->sc_flags = DMA_IDLE;
       asc_dma_reset(sc);

       /* Other settings */
       sc->sc_id = 7;
       sc->sc_freq = 24;       /* 24 MHz clock */

       /*
        * Setup for genuine NCR 53C94 SCSI Controller
        */

       sc->sc_cfg1 = sc->sc_id | NCRCFG1_PARENB;
       sc->sc_cfg2 = NCRCFG2_SCSI2 | NCRCFG2_FE;
       sc->sc_cfg3 = NCRCFG3_CDB | NCRCFG3_QTE | NCRCFG3_FSCSI;
       sc->sc_rev = NCR_VARIANT_NCR53C94;

       sc->sc_minsync = (1000 / sc->sc_freq) * 5 / 4;
       sc->sc_maxxfer = MAX_SCSI_XFER;

#ifdef OLDNCR
       if (NCR_READ_REG(sc, NCR_CFG3) == 0) {
               aprint_normal(" [old revision]");
               sc->sc_cfg2 = 0;
               sc->sc_cfg3 = 0;
               sc->sc_minsync = 0;
       }
#endif

       sc->sc_adapter.adapt_minphys = minphys;
       sc->sc_adapter.adapt_request = ncr53c9x_scsipi_request;
       ncr53c9x_attach(sc);

       bus_intr_establish(esc->sc_bst, SYS_INTR_SCSI, 0, 0, asc_intr, esc);
}

/*
* Glue functions.
*/

static uint8_t
asc_read_reg(struct ncr53c9x_softc *sc, int reg)
{
       struct asc_softc *esc = (struct asc_softc *)sc;

       return bus_space_read_1(esc->sc_bst, esc->sc_bsh, reg * 4 + 3);
}

static void
asc_write_reg(struct ncr53c9x_softc *sc, int reg, uint8_t val)
{
       struct asc_softc *esc = (struct asc_softc *)sc;

       bus_space_write_1(esc->sc_bst, esc->sc_bsh, reg * 4 + 3, val);
}

static void
dma_status(struct ncr53c9x_softc *sc)
{
       struct asc_softc *esc = (struct asc_softc *)sc;
       int    count;
       int    stat;
       void   *addr;
       uint32_t  tc;

       tc = (asc_read_reg(sc, NCR_TCM) << 8) + asc_read_reg(sc, NCR_TCL);
       count = bus_space_read_2(esc->sc_bst, esc->dm_bsh, RAMBO_BLKCNT);
       stat  = bus_space_read_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE);
       addr  = (void *)bus_space_read_4(esc->sc_bst, esc->dm_bsh, RAMBO_CADDR);

       printf("rambo status: cnt=%x addr=%p stat=%08x tc=%04x "
           "ncr_stat=0x%02x ncr_fifo=0x%02x\n",
           count, addr, stat, tc,
           asc_read_reg(sc, NCR_STAT),
           asc_read_reg(sc, NCR_FFLAG));
}

static inline void
check_fifo(struct asc_softc *esc)
{
       int i = 100;

       while (i && !(bus_space_read_4(esc->sc_bst, esc->dm_bsh,
           RAMBO_MODE) & RB_FIFO_EMPTY)) {
                DELAY(1);
               i--;
       }

       if (i == 0) {
               dma_status((void *)esc);
               panic("fifo didn't flush");
       }
}

static int
asc_dma_isintr(struct ncr53c9x_softc *sc)
{

       return NCR_READ_REG(sc, NCR_STAT) & NCRSTAT_INT;
}

static void
asc_dma_reset(struct ncr53c9x_softc *sc)
{
       struct asc_softc *esc = (struct asc_softc *)sc;

       bus_space_write_2(esc->sc_bst, esc->dm_bsh, RAMBO_BLKCNT, 0);
       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE,
           RB_CLRFIFO|RB_CLRERROR);
       DELAY(10);
       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE, 0);

       if (esc->sc_flags & DMA_MAPLOADED)
               bus_dmamap_unload(esc->sc_dmat, esc->sc_dmamap);

       esc->sc_flags = DMA_IDLE;
}

/*
* Setup a DMA transfer
*/

static int
asc_dma_setup(struct ncr53c9x_softc *sc, uint8_t **addr, size_t *len,
   int datain, size_t *dmasize)
{
       struct asc_softc *esc = (struct asc_softc *)sc;
       paddr_t paddr;
       size_t count, blocks;
       int prime, err;

#ifdef DIAGNOSTIC
       if (esc->sc_flags & DMA_ACTIVE) {
               dma_status(sc);
               panic("DMA active");
       }
#endif

       esc->sc_dmaaddr = addr;
       esc->sc_dmalen  = len;
       esc->sc_dmasize = *dmasize;
       esc->sc_flags   = datain ? DMA_PULLUP : 0;

       NCR_DMA(("asc_dma_setup va=%p len=%d datain=%d count=%d\n",
           *addr, *len, datain, esc->sc_dmasize));

       if (esc->sc_dmasize == 0)
               return 0;

       /* have dmamap for the transferring addresses */
       if ((err = bus_dmamap_load(esc->sc_dmat, esc->sc_dmamap,
           *esc->sc_dmaaddr, esc->sc_dmasize, NULL /* kernel address */,                   BUS_DMA_NOWAIT)) != 0)
               panic("%s: bus_dmamap_load err=%d",
                   device_xname(sc->sc_dev), err);

       esc->sc_flags |= DMA_MAPLOADED;

       paddr  = esc->sc_dmamap->dm_segs[0].ds_addr;
       count  = esc->sc_dmamap->dm_segs[0].ds_len;
       prime  = (uint32_t)paddr & 0x3f;
       blocks = (prime + count + 63) >> 6;

       esc->dm_mode = datain ? RB_DMA_WR : RB_DMA_RD;

       /* Set transfer direction and disable DMA */
       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE, esc->dm_mode);

       /* Load DMA transfer address */
       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_LADDR, paddr & ~0x3f);

       /* Load number of blocks to DMA (1 block = 64 bytes) */
       bus_space_write_2(esc->sc_bst, esc->dm_bsh, RAMBO_BLKCNT, blocks);

       /* If non block-aligned transfer prime FIFO manually */
       if (prime) {
               /* Enable DMA to prime the FIFO buffer */
               bus_space_write_4(esc->sc_bst, esc->dm_bsh,
                   RAMBO_MODE, esc->dm_mode | RB_DMA_ENABLE);

               if (esc->sc_flags & DMA_PULLUP) {
                       /* Read from NCR 53c94 controller*/
                       uint16_t *p;

                       p = (uint16_t *)((uint32_t)*esc->sc_dmaaddr & ~0x3f);
                       bus_space_write_multi_2(esc->sc_bst, esc->dm_bsh,
                           RAMBO_FIFO, p, prime>>1);
               } else
                       /* Write to NCR 53C94 controller */
                       while (prime > 0) {
                               (void)bus_space_read_2(esc->sc_bst, esc->dm_bsh,
                                   RAMBO_FIFO);
                               prime -= 2;
                       }
               /* Leave DMA disabled while we setup NCR controller */
               bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE,
                   esc->dm_mode);
       }

       bus_dmamap_sync(esc->sc_dmat, esc->sc_dmamap, 0, esc->sc_dmasize,
           datain ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);

       esc->dm_curseg = 0;
       esc->dm_mode |= RB_DMA_ENABLE;
       if (esc->sc_dmamap->dm_nsegs > 1)
               esc->dm_mode |= RB_INT_ENABLE;  /* Requires DMA chaining */

       return 0;
}

static void
asc_dma_go(struct ncr53c9x_softc *sc)
{
       struct asc_softc *esc = (struct asc_softc *)sc;

       /* Start DMA */
       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE, esc->dm_mode);

       esc->sc_flags |= DMA_ACTIVE;
}

static int
asc_dma_intr(struct ncr53c9x_softc *sc)
{
       struct asc_softc *esc = (struct asc_softc *)sc;

       size_t      resid, len;
       int         trans;
       uint32_t    status;
       u_int tcl, tcm;

#ifdef DIAGNOSTIC
       if ((esc->sc_flags & DMA_ACTIVE) == 0) {
               dma_status(sc);
               panic("DMA not active");
       }
#endif

       resid = 0;
       if ((esc->sc_flags & DMA_PULLUP) == 0 &&
           (resid = (NCR_READ_REG(sc, NCR_FFLAG) & NCRFIFO_FF)) != 0) {
               NCR_DMA(("asc_intr: empty FIFO of %d ", resid));
               DELAY(10);
       }

       resid += (tcl = NCR_READ_REG(sc, NCR_TCL)) +
           ((tcm = NCR_READ_REG(sc, NCR_TCM)) << 8);

       if (esc->sc_dmasize == 0) { /* Transfer pad operation */
               NCR_DMA(("asc_intr: discard %d bytes\n", resid));
               return 0;
       }

       trans = esc->sc_dmasize - resid;
       if (trans < 0) {                        /* transferred < 0 ? */
               printf("%s: xfer (%d) > req (%d)\n",
                   __func__, trans, esc->sc_dmasize);
               trans = esc->sc_dmasize;
       }

       NCR_DMA(("asc_intr: tcl=%d, tcm=%d; trans=%d, resid=%d\n",
           tcl, tcm, trans, resid));

       status = bus_space_read_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE);

       if ((status & RB_FIFO_EMPTY) == 0) { /* Data left in RAMBO FIFO */
               if ((esc->sc_flags & DMA_PULLUP) != 0) { /* SCSI Read */
                       paddr_t ptr;
                       uint16_t *p;

                       resid  = status & 0x1f;

                       /* take the address of block to fixed up */
                       ptr = bus_space_read_4(esc->sc_bst, esc->dm_bsh,
                           RAMBO_CADDR);
                       /* find the starting address of fractional data */
                       p = (uint16_t *)MIPS_PHYS_TO_KSEG0(ptr + (resid << 1));

                       /* duplicate trailing data to FIFO for force flush */
                       len = RB_BLK_CNT - resid;
                       bus_space_write_multi_2(esc->sc_bst, esc->dm_bsh,
                           RAMBO_FIFO, p, len);
                       check_fifo(esc);
               } else {                /* SCSI Write */
                       bus_space_write_4(esc->sc_bst, esc->dm_bsh,
                           RAMBO_MODE, 0);
                       bus_space_write_4(esc->sc_bst, esc->dm_bsh,
                           RAMBO_MODE, RB_CLRFIFO);
               }
       }

       bus_space_write_2(esc->sc_bst, esc->dm_bsh, RAMBO_BLKCNT, 0);

       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE, 0);

       bus_dmamap_sync(esc->sc_dmat, esc->sc_dmamap,
           0, esc->sc_dmasize,
           (esc->sc_flags & DMA_PULLUP) != 0 ?
           BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
       bus_dmamap_unload(esc->sc_dmat, esc->sc_dmamap);

       *esc->sc_dmaaddr += trans;
       *esc->sc_dmalen  -= trans;

       esc->sc_flags = DMA_IDLE;

       return 0;
}


static void
asc_dma_stop(struct ncr53c9x_softc *sc)
{
       struct asc_softc *esc = (struct asc_softc *)sc;

       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE, 0);
       if ((esc->sc_flags & DMA_MAPLOADED) != 0)
               bus_dmamap_unload(esc->sc_dmat, esc->sc_dmamap);
       esc->sc_flags = DMA_IDLE;
}

static int
asc_dma_isactive(struct ncr53c9x_softc *sc)
{
       struct asc_softc *esc = (struct asc_softc *)sc;
       return (esc->sc_flags & DMA_ACTIVE) != 0 ? 1 : 0;
}

static void
rambo_dma_chain(struct asc_softc *esc)
{
       int seg;
       size_t  count, blocks;
       paddr_t paddr;

       seg = ++esc->dm_curseg;

#ifdef DIAGNOSTIC
       if ((esc->sc_flags & DMA_ACTIVE) == 0 || seg > esc->sc_dmamap->dm_nsegs)
               panic("Unexpected DMA chaining intr");

       /* Interrupt can only occur at terminal count, but double check */
       if (bus_space_read_2(esc->sc_bst, esc->dm_bsh, RAMBO_BLKCNT)) {
               dma_status((void *)esc);
               panic("rambo blkcnt != 0");
       }
#endif

       paddr  = esc->sc_dmamap->dm_segs[seg].ds_addr;
       count  = esc->sc_dmamap->dm_segs[seg].ds_len;
       blocks = (count + 63) >> 6;

       /* Disable DMA interrupt if last segment */
       if (seg + 1 > esc->sc_dmamap->dm_nsegs) {
               bus_space_write_4(esc->sc_bst, esc->dm_bsh,
                   RAMBO_MODE, esc->dm_mode & ~RB_INT_ENABLE);
       }

       /* Load transfer address for next DMA chain */
       bus_space_write_4(esc->sc_bst, esc->dm_bsh, RAMBO_LADDR, paddr);

       /* DMA restarts when we enter a new block count */
       bus_space_write_2(esc->sc_bst, esc->dm_bsh, RAMBO_BLKCNT, blocks);
}

static int
asc_intr(void *arg)
{
       uint32_t dma_stat;
       struct asc_softc *esc = arg;
       struct ncr53c9x_softc *sc = &esc->sc_ncr53c9x;

       esc->sc_intrcnt.ev_count++;

       /* Check for RAMBO DMA Interrupt */
       dma_stat = bus_space_read_4(esc->sc_bst, esc->dm_bsh, RAMBO_MODE);
       if ((dma_stat & RB_INTR_PEND) != 0) {
               rambo_dma_chain(esc);
       }
       /* Check for NCR 53c94 interrupt */
       if (NCR_READ_REG(sc, NCR_STAT) & NCRSTAT_INT) {
               ncr53c9x_intr(sc);
       }
       return 0;
}