/*      $NetBSD: uha_eisa.c,v 1.39 2021/01/27 04:35:15 thorpej Exp $    */

/*-
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Charles M. Hannum.
 *
 * 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: uha_eisa.c,v 1.39 2021/01/27 04:35:15 thorpej Exp $");

#include "opt_ddb.h"

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/kernel.h>
#include <sys/proc.h>

#include <sys/bus.h>
#include <sys/intr.h>

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

#include <dev/eisa/eisavar.h>
#include <dev/eisa/eisadevs.h>

#include <dev/ic/uhareg.h>
#include <dev/ic/uhavar.h>

#define UHA_EISA_SLOT_OFFSET    0xc80
#define UHA_EISA_IOSIZE         0x020

static int      uha_eisa_match(device_t, cfdata_t, void *);
static void     uha_eisa_attach(device_t, device_t, void *);

CFATTACH_DECL_NEW(uha_eisa, sizeof(struct uha_softc),
    uha_eisa_match, uha_eisa_attach, NULL, NULL);

#ifndef DDB
#define Debugger() panic("should call debugger here (uha_eisa.c)")
#endif /* ! DDB */

static int      u24_find(bus_space_tag_t, bus_space_handle_t,
                    struct uha_probe_data *);
static void     u24_start_mbox(struct uha_softc *, struct uha_mscp *);
static int      u24_poll(struct uha_softc *, struct scsipi_xfer *, int);
static int      u24_intr(void *);
static void     u24_init(struct uha_softc *);

static const struct device_compatible_entry compat_data[] = {
        { .compat = "USC024?",  .data = EISA_PRODUCT_USC0240 },
        DEVICE_COMPAT_EOL
};

/*
 * Check the slots looking for a board we recognise
 * If we find one, note its address (slot) and call
 * the actual probe routine to check it out.
 */
static int
uha_eisa_match(device_t parent, cfdata_t match,
    void *aux)
{
        struct eisa_attach_args *ea = aux;
        bus_space_tag_t iot = ea->ea_iot;
        bus_space_handle_t ioh;
        int rv;

        if (!eisa_compatible_match(ea, compat_data))
                return (0);

        if (bus_space_map(iot, EISA_SLOT_ADDR(ea->ea_slot) +
            UHA_EISA_SLOT_OFFSET, UHA_EISA_IOSIZE, 0, &ioh))
                return (0);

        rv = u24_find(iot, ioh, NULL);

        bus_space_unmap(iot, ioh, UHA_EISA_IOSIZE);

        return (rv);
}

/*
 * Attach all the sub-devices we can find
 */
static void
uha_eisa_attach(device_t parent, device_t self, void *aux)
{
        struct eisa_attach_args *ea = aux;
        struct uha_softc *sc = device_private(self);
        const struct device_compatible_entry *dce;
        bus_space_tag_t iot = ea->ea_iot;
        bus_dma_tag_t dmat = ea->ea_dmat;
        bus_space_handle_t ioh;
        struct uha_probe_data upd;
        eisa_chipset_tag_t ec = ea->ea_ec;
        eisa_intr_handle_t ih;
        const char *intrstr;
        char intrbuf[EISA_INTRSTR_LEN];

        dce = eisa_compatible_lookup(ea, compat_data);
        KASSERT(dce != NULL);

        printf(": %s\n", (const char *)dce->data);

        if (bus_space_map(iot, EISA_SLOT_ADDR(ea->ea_slot) +
            UHA_EISA_SLOT_OFFSET, UHA_EISA_IOSIZE, 0, &ioh))
                panic("uha_eisa_attach: could not map I/O addresses");

        sc->sc_dev = self;
        sc->sc_iot = iot;
        sc->sc_ioh = ioh;
        sc->sc_dmat = dmat;
        if (!u24_find(iot, ioh, &upd))
                panic("uha_eisa_attach: u24_find failed!");

        sc->sc_dmaflags = 0;

        if (eisa_intr_map(ec, upd.sc_irq, &ih)) {
                aprint_error_dev(sc->sc_dev, "couldn't map interrupt (%d)\n",
                    upd.sc_irq);
                return;
        }
        intrstr = eisa_intr_string(ec, ih, intrbuf, sizeof(intrbuf));
        sc->sc_ih = eisa_intr_establish(ec, ih, IST_LEVEL, IPL_BIO,
            u24_intr, sc);
        if (sc->sc_ih == NULL) {
                aprint_error_dev(sc->sc_dev, "couldn't establish interrupt");
                if (intrstr != NULL)
                        aprint_error(" at %s", intrstr);
                aprint_error("\n");
                return;
        }
        aprint_normal_dev(sc->sc_dev, "interrupting at %s\n", intrstr);

        /* Save function pointers for later use. */
        sc->start_mbox = u24_start_mbox;
        sc->poll = u24_poll;
        sc->init = u24_init;

        uha_attach(sc, &upd);
}

static int
u24_find(bus_space_tag_t iot, bus_space_handle_t ioh,
    struct uha_probe_data *sc)
{
        u_int8_t config0, config1, config2;
        int irq, drq;
        int resetcount = 4000;  /* 4 secs? */

        config0 = bus_space_read_1(iot, ioh, U24_CONFIG + 0);
        config1 = bus_space_read_1(iot, ioh, U24_CONFIG + 1);
        config2 = bus_space_read_1(iot, ioh, U24_CONFIG + 2);
        if ((config0 & U24_MAGIC1) == 0 ||
            (config1 & U24_MAGIC2) == 0)
                return (0);

        drq = -1;

        switch (config0 & U24_IRQ_MASK) {
        case U24_IRQ10:
                irq = 10;
                break;
        case U24_IRQ11:
                irq = 11;
                break;
        case U24_IRQ14:
                irq = 14;
                break;
        case U24_IRQ15:
                irq = 15;
                break;
        default:
                printf("u24_find: illegal irq setting %x\n",
                    config0 & U24_IRQ_MASK);
                return (0);
        }

        bus_space_write_1(iot, ioh, U24_LINT, UHA_ASRST);

        while (--resetcount) {
                if (bus_space_read_1(iot, ioh, U24_LINT))
                        break;
                delay(1000);    /* 1 mSec per loop */
        }
        if (!resetcount) {
                printf("u24_find: board timed out during reset\n");
                return (0);
        }

        /* if we want to fill in softc, do so now */
        if (sc) {
                sc->sc_irq = irq;
                sc->sc_drq = drq;
                sc->sc_scsi_dev = config2 & U24_HOSTID_MASK;
        }

        return (1);
}

static void
u24_start_mbox(struct uha_softc *sc, struct uha_mscp *mscp)
{
        bus_space_tag_t iot = sc->sc_iot;
        bus_space_handle_t ioh = sc->sc_ioh;
        int spincount = 100000; /* 1s should be enough */

        while (--spincount) {
                if ((bus_space_read_1(iot, ioh, U24_LINT) & U24_LDIP) == 0)
                        break;
                delay(100);
        }
        if (!spincount) {
                aprint_error_dev(sc->sc_dev,
                    "uha_start_mbox, board not responding\n");
                Debugger();
        }

        bus_space_write_4(iot, ioh, U24_OGMPTR,
            sc->sc_dmamap_mscp->dm_segs[0].ds_addr + UHA_MSCP_OFF(mscp));
        if (mscp->flags & MSCP_ABORT)
                bus_space_write_1(iot, ioh, U24_OGMCMD, 0x80);
        else
                bus_space_write_1(iot, ioh, U24_OGMCMD, 0x01);
        bus_space_write_1(iot, ioh, U24_LINT, U24_OGMFULL);

        if ((mscp->xs->xs_control & XS_CTL_POLL) == 0)
                callout_reset(&mscp->xs->xs_callout,
                    mstohz(mscp->timeout), uha_timeout, mscp);
}

static int
u24_poll(struct uha_softc *sc, struct scsipi_xfer *xs, int count)
{
        bus_space_tag_t iot = sc->sc_iot;
        bus_space_handle_t ioh = sc->sc_ioh;

        while (count) {
                /*
                 * If we had interrupts enabled, would we
                 * have got an interrupt?
                 */
                if (bus_space_read_1(iot, ioh, U24_SINT) & U24_SDIP)
                        u24_intr(sc);
                if (xs->xs_status & XS_STS_DONE)
                        return (0);
                delay(1000);
                count--;
        }
        return (1);
}

static int
u24_intr(void *arg)
{
        struct uha_softc *sc = arg;
        bus_space_tag_t iot = sc->sc_iot;
        bus_space_handle_t ioh = sc->sc_ioh;
        struct uha_mscp *mscp;
        u_char uhastat;
        u_long mboxval;

#ifdef  UHADEBUG
        printf("%s: uhaintr ", device_xname(sc->sc_dev));
#endif /*UHADEBUG */

        if ((bus_space_read_1(iot, ioh, U24_SINT) & U24_SDIP) == 0)
                return (0);

        for (;;) {
                /*
                 * First get all the information and then
                 * acknowledge the interrupt
                 */
                uhastat = bus_space_read_1(iot, ioh, U24_SINT);
                mboxval = bus_space_read_4(iot, ioh, U24_ICMPTR);
                bus_space_write_1(iot, ioh, U24_SINT, U24_ICM_ACK);
                bus_space_write_1(iot, ioh, U24_ICMCMD, 0);

#ifdef  UHADEBUG
                printf("status = 0x%x ", uhastat);
#else
                __USE(uhastat);
#endif /*UHADEBUG*/

                /*
                 * Process the completed operation
                 */
                mscp = uha_mscp_phys_kv(sc, mboxval);
                if (!mscp) {
                        printf("%s: BAD MSCP RETURNED!\n",
                            device_xname(sc->sc_dev));
                        continue;       /* whatever it was, it'll timeout */
                }
                callout_stop(&mscp->xs->xs_callout);
                uha_done(sc, mscp);

                if ((bus_space_read_1(iot, ioh, U24_SINT) & U24_SDIP) == 0)
                        return (1);
        }
}

static void
u24_init(struct uha_softc *sc)
{
        bus_space_tag_t iot = sc->sc_iot;
        bus_space_handle_t ioh = sc->sc_ioh;

        /* free OGM and ICM */
        bus_space_write_1(iot, ioh, U24_OGMCMD, 0);
        bus_space_write_1(iot, ioh, U24_ICMCMD, 0);
        /* make sure interrupts are enabled */
#ifdef UHADEBUG
        printf("u24_init: lmask=%02x, smask=%02x\n",
            bus_space_read_1(iot, ioh, U24_LMASK),
            bus_space_read_1(iot, ioh, U24_SMASK));
#endif
        bus_space_write_1(iot, ioh, U24_LMASK, 0xd2);   /* XXX */
        bus_space_write_1(iot, ioh, U24_SMASK, 0x92);   /* XXX */
}