Sync usage with man page.

[netbsd-mini2440.git] / sys / arch / pmax / tc / asc_ioasic.c

/* $NetBSD: asc_ioasic.c,v 1.22 2009/08/12 14:06:13 tsutsui Exp $ */

/*-
 * Copyright (c) 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Tohru Nishimura.
 *
 * 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>                  /* RCS ID & Copyright macro defns */
__KERNEL_RCSID(0, "$NetBSD: asc_ioasic.c,v 1.22 2009/08/12 14:06:13 tsutsui Exp $");

#include <sys/types.h>
#include <sys/param.h>
#include <sys/systm.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/bus.h>

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

#include <dev/tc/tcvar.h>
#include <dev/tc/ioasicvar.h>
#include <dev/tc/ioasicreg.h>

struct asc_softc {
        struct ncr53c9x_softc sc_ncr53c9x;      /* glue to MI code */
        bus_space_tag_t sc_bst;                 /* bus space tag */
        bus_space_handle_t sc_bsh;              /* bus space handle */
        bus_space_handle_t sc_scsi_bsh;         /* ASC register handle */
        bus_dma_tag_t sc_dmat;                  /* bus dma tag */
        bus_dmamap_t sc_dmamap;                 /* bus dmamap */
        uint8_t **sc_dmaaddr;
        size_t *sc_dmalen;
        size_t sc_dmasize;
        unsigned int sc_flags;
#define ASC_ISPULLUP            0x0001
#define ASC_DMAACTIVE           0x0002
#define ASC_MAPLOADED           0x0004
};

#define ASC_READ_REG(asc, reg)                                          \
        ((uint8_t)bus_space_read_4((asc)->sc_bst, (asc)->sc_scsi_bsh,   \
            (reg) * sizeof(uint32_t)))
#define ASC_WRITE_REG(asc, reg, val)                                    \
        bus_space_write_4((asc)->sc_bst, (asc)->sc_scsi_bsh,            \
            (reg) * sizeof(uint32_t), (uint8_t)(val))

static int  asc_ioasic_match(device_t, cfdata_t, void *);
static void asc_ioasic_attach(device_t, device_t, void *);

CFATTACH_DECL_NEW(asc_ioasic, sizeof(struct asc_softc),
    asc_ioasic_match, asc_ioasic_attach, NULL, NULL);

static uint8_t  asc_read_reg(struct ncr53c9x_softc *, int);
static void     asc_write_reg(struct ncr53c9x_softc *, int, u_char);
static int      asc_dma_isintr(struct ncr53c9x_softc *sc);
static void     asc_ioasic_reset(struct ncr53c9x_softc *);
static int      asc_ioasic_intr(struct ncr53c9x_softc *);
static int      asc_ioasic_setup(struct ncr53c9x_softc *,
                    uint8_t **, size_t *, int, size_t *);
static void     asc_ioasic_go(struct ncr53c9x_softc *);
static void     asc_ioasic_stop(struct ncr53c9x_softc *);
static int      asc_dma_isactive(struct ncr53c9x_softc *);

static struct ncr53c9x_glue asc_ioasic_glue = {
        asc_read_reg,
        asc_write_reg,
        asc_dma_isintr,
        asc_ioasic_reset,
        asc_ioasic_intr,
        asc_ioasic_setup,
        asc_ioasic_go,
        asc_ioasic_stop,
        asc_dma_isactive,
        NULL,
};

static int
asc_ioasic_match(device_t parent, cfdata_t cf, void *aux)
{
        struct ioasicdev_attach_args *d = aux;
        
        if (strncmp("asc", d->iada_modname, TC_ROM_LLEN))
                return 0;

        return 1;
}

static void
asc_ioasic_attach(device_t parent, device_t self, void *aux)
{
        struct asc_softc *asc = device_private(self);   
        struct ncr53c9x_softc *sc = &asc->sc_ncr53c9x;
        struct ioasicdev_attach_args *d = aux;
        struct ioasic_softc *isc = device_private(parent);

        /*
         * Set up glue for MI code early; we use some of it here.
         */
        sc->sc_dev = self;
        sc->sc_glue = &asc_ioasic_glue;
        asc->sc_bst = isc->sc_bst;
        asc->sc_bsh = isc->sc_bsh;
        if (bus_space_subregion(asc->sc_bst, asc->sc_bsh,
            IOASIC_SLOT_12_START, 0x100, &asc->sc_scsi_bsh)) {
                aprint_error(": failed to map device registers\n");
                return;
        }
        asc->sc_dmat = isc->sc_dmat;
        if (bus_dmamap_create(asc->sc_dmat, PAGE_SIZE * 2,
            2, PAGE_SIZE, PAGE_SIZE, BUS_DMA_NOWAIT,
            &asc->sc_dmamap)) {
                aprint_error(": failed to create DMA map\n");
                return;
        }

        sc->sc_id = 7;
        sc->sc_freq = 25000000;

        /* gimme MHz */
        sc->sc_freq /= 1000000;

        ioasic_intr_establish(parent, d->iada_cookie, TC_IPL_BIO,
            ncr53c9x_intr, sc);

        /*
         * XXX More of this should be in ncr53c9x_attach(), but
         * XXX should we really poke around the chip that much in
         * XXX the MI code?  Think about this more...
         */

        /*
         * Set up static configuration info.
         */
        sc->sc_cfg1 = sc->sc_id | NCRCFG1_PARENB;
        sc->sc_cfg2 = NCRCFG2_SCSI2;
        sc->sc_cfg3 = 0;
        sc->sc_rev = NCR_VARIANT_NCR53C94;

        /*
         * XXX minsync and maxxfer _should_ be set up in MI code,
         * XXX but it appears to have some dependency on what sort
         * XXX of DMA we're hooked up to, etc.
         */

        /*
         * This is the value used to start sync negotiations
         * Note that the NCR register "SYNCTP" is programmed
         * in "clocks per byte", and has a minimum value of 4.
         * The SCSI period used in negotiation is one-fourth
         * of the time (in nanoseconds) needed to transfer one byte.
         * Since the chip's clock is given in MHz, we have the following
         * formula: 4 * period = (1000 / freq) * 4
         */
        sc->sc_minsync = (1000 / sc->sc_freq) * 5 / 4 ;
        sc->sc_maxxfer = 64 * 1024;

        /* Do the common parts of attachment. */
        sc->sc_adapter.adapt_minphys = minphys;
        sc->sc_adapter.adapt_request = ncr53c9x_scsipi_request;
        ncr53c9x_attach(sc);
}

void
asc_ioasic_reset(struct ncr53c9x_softc *sc)
{
        struct asc_softc *asc = (struct asc_softc *)sc;
        uint32_t ssr;

        ssr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR);
        ssr &= ~IOASIC_CSR_DMAEN_SCSI;
        bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR, ssr);
        bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_SCSI_SCR, 0);

        if (asc->sc_flags & ASC_MAPLOADED)
                bus_dmamap_unload(asc->sc_dmat, asc->sc_dmamap);
        asc->sc_flags &= ~(ASC_DMAACTIVE|ASC_MAPLOADED);
}

#define TWOPAGE(a)      (PAGE_SIZE*2 - ((a) & (PAGE_SIZE-1)))

int
asc_ioasic_setup(struct ncr53c9x_softc *sc, uint8_t **addr, size_t *len,
    int ispullup, size_t *dmasize)
{
        struct asc_softc *asc = (struct asc_softc *)sc;
        uint32_t ssr, scr, *p;
        size_t size;
        vaddr_t cp;

        NCR_DMA(("%s: start %d@%p,%s\n", sc->sc_dev.dv_xname,
            *asc->sc_dmalen, *asc->sc_dmaaddr, ispullup ? "IN" : "OUT"));

        /* upto two 4KB pages */
        size = min(*dmasize, TWOPAGE((size_t)*addr));
        asc->sc_dmaaddr = addr;
        asc->sc_dmalen = len;
        asc->sc_dmasize = size;
        asc->sc_flags = (ispullup) ? ASC_ISPULLUP : 0;
        *dmasize = size; /* return trimmed transfer size */

        /* stop DMA engine first */
        ssr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR);
        ssr &= ~IOASIC_CSR_DMAEN_SCSI;
        bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR, ssr);

        /* have dmamap for the transfering addresses */
        if (bus_dmamap_load(asc->sc_dmat, asc->sc_dmamap,
            *addr, size, NULL /* kernel address */, BUS_DMA_NOWAIT))
                panic("%s: cannot allocate DMA address",
                    device_xname(sc->sc_dev));

        /* take care of 8B constraint on starting address */
        cp = (vaddr_t)*addr;
        if ((cp & 7) == 0) {
                /* comfortably aligned to 8B boundary */
                scr = 0;
        }
        else {
                /* truncate to the boundary */
                p = (uint32_t *)(cp & ~7);
                /* how many 16bit quantities in subject */
                scr = (cp & 7) >> 1;
                /* trim down physical address too */
                asc->sc_dmamap->dm_segs[0].ds_addr &= ~7;
                asc->sc_dmamap->dm_segs[0].ds_len += (cp & 6);
                if ((asc->sc_flags & ASC_ISPULLUP) == 0) {
                        /* push down to SCSI device */
                        scr |= 4;
                        /* round up physical address in this case */
                        asc->sc_dmamap->dm_segs[0].ds_addr += 8;
                        /* don't care excess cache flush */
                }
                /* pack fixup data in SDR0/SDR1 pair and instruct SCR */
                bus_space_write_4(asc->sc_bst, asc->sc_bsh,
                    IOASIC_SCSI_SDR0, p[0]);
                bus_space_write_4(asc->sc_bst, asc->sc_bsh,
                    IOASIC_SCSI_SDR1, p[1]);
        }
        bus_space_write_4(asc->sc_bst, asc->sc_bsh,
            IOASIC_SCSI_DMAPTR,
            IOASIC_DMA_ADDR(asc->sc_dmamap->dm_segs[0].ds_addr));
        bus_space_write_4(asc->sc_bst, asc->sc_bsh,
            IOASIC_SCSI_NEXTPTR,
            (asc->sc_dmamap->dm_nsegs == 1) ?
            ~0 : IOASIC_DMA_ADDR(asc->sc_dmamap->dm_segs[1].ds_addr));
        bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_SCSI_SCR, scr);

        /* synchronize dmamap contents with memory image */
        bus_dmamap_sync(asc->sc_dmat, asc->sc_dmamap,
            0, size,
            (ispullup) ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);

        asc->sc_flags |= ASC_MAPLOADED;
        return 0;
}

void
asc_ioasic_go(struct ncr53c9x_softc *sc)
{
        struct asc_softc *asc = (struct asc_softc *)sc;
        uint32_t ssr;

        ssr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR);
        if (asc->sc_flags & ASC_ISPULLUP)
                ssr |= IOASIC_CSR_SCSI_DIR;
        else {
                /* ULTRIX does in this way */
                ssr &= ~IOASIC_CSR_SCSI_DIR;
                bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR, ssr);
                ssr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR);
        }
        ssr |= IOASIC_CSR_DMAEN_SCSI;
        bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR, ssr);
        asc->sc_flags |= ASC_DMAACTIVE;
}

static int
asc_ioasic_intr(struct ncr53c9x_softc *sc)
{
        struct asc_softc *asc = (struct asc_softc *)sc;
        ssize_t trans, resid;
        u_int tcl, tcm, ssr, scr, intr;
        
        if ((asc->sc_flags & ASC_DMAACTIVE) == 0)
                panic("%s: DMA wasn't active", __func__);

#define IOASIC_ASC_ERRORS \
    (IOASIC_INTR_SCSI_PTR_LOAD|IOASIC_INTR_SCSI_OVRUN|IOASIC_INTR_SCSI_READ_E)
        /*
         * When doing polled I/O, the SCSI bits in the interrupt register won't
         * get cleared by the interrupt processing.  This will cause the DMA
         * address registers to not load on the next DMA transfer.
         * Check for these bits here, and clear them if needed.
         */
        intr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_INTR);
        if ((intr & IOASIC_ASC_ERRORS) != 0) {
                intr &= ~IOASIC_ASC_ERRORS;
                bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_INTR, intr);
        }

        /* DMA has stopped */
        ssr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR);
        ssr &= ~IOASIC_CSR_DMAEN_SCSI;
        bus_space_write_4(asc->sc_bst, asc->sc_bsh, IOASIC_CSR, ssr);

        asc->sc_flags &= ~ASC_DMAACTIVE;

        if (asc->sc_dmasize == 0) {
                /* A "Transfer Pad" operation completed */
                tcl = ASC_READ_REG(asc, NCR_TCL); 
                tcm = ASC_READ_REG(asc, NCR_TCM);
                NCR_DMA(("ioasic_intr: discarded %d bytes (tcl=%d, tcm=%d)\n",
                    tcl | (tcm << 8), tcl, tcm));
                return 0;
        }

        resid = 0;
        if ((asc->sc_flags & ASC_ISPULLUP) == 0 &&
            (resid = (ASC_READ_REG(asc, NCR_FFLAG) & NCRFIFO_FF)) != 0) {
                NCR_DMA(("ioasic_intr: empty FIFO of %d ", resid));
                DELAY(1);
        }

        resid += (tcl = ASC_READ_REG(asc, NCR_TCL));
        resid += (tcm = ASC_READ_REG(asc, NCR_TCM)) << 8;

        trans = asc->sc_dmasize - resid;
        if (trans < 0) {                        /* transferred < 0 ? */
                printf("ioasic_intr: xfer (%zd) > req (%zu)\n",
                    trans, asc->sc_dmasize);
                trans = asc->sc_dmasize;
        }
        NCR_DMA(("ioasic_intr: tcl=%d, tcm=%d; trans=%d, resid=%d\n",
            tcl, tcm, trans, resid));

        bus_dmamap_sync(asc->sc_dmat, asc->sc_dmamap,
            0, asc->sc_dmasize,
            (asc->sc_flags & ASC_ISPULLUP) ?
            BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);

        scr = bus_space_read_4(asc->sc_bst, asc->sc_bsh, IOASIC_SCSI_SCR);
        if ((asc->sc_flags & ASC_ISPULLUP) && scr != 0) {
                uint32_t sdr[2], ptr;

                sdr[0] = bus_space_read_4(asc->sc_bst, asc->sc_bsh,
                    IOASIC_SCSI_SDR0);
                sdr[1] = bus_space_read_4(asc->sc_bst, asc->sc_bsh,
                    IOASIC_SCSI_SDR1);
                ptr = bus_space_read_4(asc->sc_bst, asc->sc_bsh,
                    IOASIC_SCSI_DMAPTR);
                ptr = (ptr >> 3) & 0x1ffffffc;
                /*
                 * scr: 1 -> short[0]
                 *      2 -> short[0] + short[1]
                 *      3 -> short[0] + short[1] + short[2]
                 */
                scr &= IOASIC_SCR_WORD;
                memcpy((void *)MIPS_PHYS_TO_KSEG0(ptr), sdr, scr << 1);
        }

        bus_dmamap_unload(asc->sc_dmat, asc->sc_dmamap);
        asc->sc_flags &= ~ASC_MAPLOADED;

        *asc->sc_dmalen -= trans;
        *asc->sc_dmaaddr += trans;
        
        return 0;
}


void
asc_ioasic_stop(struct ncr53c9x_softc *sc)
{
        struct asc_softc *asc = (struct asc_softc *)sc;

        if (asc->sc_flags & ASC_MAPLOADED) {
                bus_dmamap_sync(asc->sc_dmat, asc->sc_dmamap,
                    0, asc->sc_dmasize,
                    (asc->sc_flags & ASC_ISPULLUP) ?
                    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
                bus_dmamap_unload(asc->sc_dmat, asc->sc_dmamap);
        }

        asc->sc_flags &= ~(ASC_DMAACTIVE|ASC_MAPLOADED);
}

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

        return ASC_READ_REG(asc, reg);
}

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

        ASC_WRITE_REG(asc, reg, val);
}

static int
asc_dma_isintr(struct ncr53c9x_softc *sc)
{
        struct asc_softc *asc = (struct asc_softc *)sc;

        return (ASC_READ_REG(asc, NCR_STAT) & NCRSTAT_INT) != 0;
}

static int
asc_dma_isactive(struct ncr53c9x_softc *sc)
{
        struct asc_softc *asc = (struct asc_softc *)sc;

        return (asc->sc_flags & ASC_DMAACTIVE) != 0;
}