/*      $NetBSD: qec.c,v 1.55 2022/09/25 18:03:04 thorpej Exp $ */

/*-
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Paul Kranenburg.
 *
 * 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: qec.c,v 1.55 2022/09/25 18:03:04 thorpej Exp $");

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

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

#include <dev/sbus/sbusvar.h>
#include <dev/sbus/qecreg.h>
#include <dev/sbus/qecvar.h>

static int      qecprint(void *, const char *);
static int      qecmatch(device_t, cfdata_t, void *);
static void     qecattach(device_t, device_t, void *);
void            qec_init(struct qec_softc *);

static int qec_bus_map(
                bus_space_tag_t,
                bus_addr_t,             /*coded slot+offset*/
                bus_size_t,             /*size*/
                int,                    /*flags*/
                vaddr_t,                /*preferred virtual address */
                bus_space_handle_t *);
static void *qec_intr_establish(
                bus_space_tag_t,
                int,                    /*bus interrupt priority*/
                int,                    /*`device class' interrupt level*/
                int (*)(void *),        /*handler*/
                void *,                 /*arg*/
                void (*)(void));        /*optional fast trap handler*/

CFATTACH_DECL_NEW(qec, sizeof(struct qec_softc),
    qecmatch, qecattach, NULL, NULL);

int
qecprint(void *aux, const char *busname)
{
        struct sbus_attach_args *sa = aux;
        bus_space_tag_t t = sa->sa_bustag;
        struct qec_softc *sc = t->cookie;

        sa->sa_bustag = sc->sc_bustag;  /* XXX */
        sbus_print(aux, busname);       /* XXX */
        sa->sa_bustag = t;              /* XXX */
        return (UNCONF);
}

int
qecmatch(device_t parent, cfdata_t cf, void *aux)
{
        struct sbus_attach_args *sa = aux;

        return (strcmp(cf->cf_name, sa->sa_name) == 0);
}

/*
 * Attach all the sub-devices we can find
 */
void
qecattach(device_t parent, device_t self, void *aux)
{
        struct sbus_attach_args *sa = aux;
        struct qec_softc *sc = device_private(self);
        struct sbus_softc *sbsc = device_private(parent);
        int node;
        int sbusburst;
        bus_space_tag_t sbt;
        bus_space_handle_t bh;
        int error;

        sc->sc_dev = self;
        sc->sc_bustag = sa->sa_bustag;
        sc->sc_dmatag = sa->sa_dmatag;
        node = sa->sa_node;

        if (sa->sa_nreg < 2) {
                printf("%s: only %d register sets\n",
                        device_xname(self), sa->sa_nreg);
                return;
        }

        if (sbus_bus_map(sa->sa_bustag,
                         sa->sa_reg[0].oa_space,
                         sa->sa_reg[0].oa_base,
                         sa->sa_reg[0].oa_size,
                         0, &sc->sc_regs) != 0) {
                aprint_error_dev(self, "attach: cannot map registers\n");
                return;
        }

        /*
         * This device's "register space 1" is just a buffer where the
         * Lance ring-buffers can be stored. Note the buffer's location
         * and size, so the child driver can pick them up.
         */
        if (sbus_bus_map(sa->sa_bustag,
                         sa->sa_reg[1].oa_space,
                         sa->sa_reg[1].oa_base,
                         sa->sa_reg[1].oa_size,
                         BUS_SPACE_MAP_LINEAR, &bh) != 0) {
                aprint_error_dev(self, "attach: cannot map registers\n");
                return;
        }
        sc->sc_buffer = (void *)bus_space_vaddr(sa->sa_bustag, bh);
        sc->sc_bufsiz = (bus_size_t)sa->sa_reg[1].oa_size;

        /* Get number of on-board channels */
        sc->sc_nchannels = prom_getpropint(node, "#channels", -1);
        if (sc->sc_nchannels == -1) {
                printf(": no channels\n");
                return;
        }

        /*
         * Get transfer burst size from PROM
         */
        sbusburst = sbsc->sc_burst;
        if (sbusburst == 0)
                sbusburst = SBUS_BURST_32 - 1; /* 1->16 */

        sc->sc_burst = prom_getpropint(node, "burst-sizes", -1);
        if (sc->sc_burst == -1)
                /* take SBus burst sizes */
                sc->sc_burst = sbusburst;

        /* Clamp at parent's burst sizes */
        sc->sc_burst &= sbusburst;

        /* Allocate a bus tag */
        sbt = bus_space_tag_alloc(sc->sc_bustag, sc);
        if (sbt == NULL) {
                aprint_error_dev(self, "attach: out of memory\n");
                return;
        }

        sbt->sparc_bus_map = qec_bus_map;
        sbt->sparc_intr_establish = qec_intr_establish;

        /*
         * Collect address translations from the OBP.
         */
        error = prom_getprop(node, "ranges", sizeof(struct openprom_range),
                         &sbt->nranges, &sbt->ranges);
        switch (error) {
        case 0:
                break;
        case ENOENT:
        default:
                panic("%s: error getting ranges property", device_xname(self));
        }

        /*
         * Save interrupt information for use in our qec_intr_establish()
         * function below. Apparently, the intr level for the quad
         * ethernet board (qe) is stored in the QEC node rather than
         * separately in each of the QE nodes.
         *
         * XXX - qe.c should call bus_intr_establish() with `level = 0'..
         * XXX - maybe we should have our own attach args for all that.
         */
        sc->sc_intr = sa->sa_intr;

        printf(": %dK memory\n", sc->sc_bufsiz / 1024);

        qec_init(sc);

        /* search through children */
        devhandle_t selfh = device_handle(self);
        for (node = firstchild(node); node; node = nextsibling(node)) {
                struct sbus_attach_args sax;
                sbus_setup_attach_args(sbsc,
                                       sbt, sc->sc_dmatag, node, &sax);
                (void)config_found(self, (void *)&sax, qecprint,
                    CFARGS(.devhandle = prom_node_to_devhandle(selfh, node)));
                sbus_destroy_attach_args(&sax);
        }
}

int
qec_bus_map(bus_space_tag_t t, bus_addr_t ba, bus_size_t size, int flags,
    vaddr_t va, bus_space_handle_t *hp)
        /* va:   Ignored */
{
        int error;

        if ((error = bus_space_translate_address_generic(
                                t->ranges, t->nranges, &ba)) != 0)
                return (error);

        return (bus_space_map(t->parent, ba, size, flags, hp));
}

void *
qec_intr_establish(bus_space_tag_t t, int pri, int level,
    int (*handler)(void *), void *arg, void (*fastvec)(void))
        /* (*fastvec)(void): ignored */
{
        struct qec_softc *sc = t->cookie;

        if (pri == 0) {
                /*
                 * qe.c calls bus_intr_establish() with `pri == 0'
                 * XXX - see also comment in qec_attach().
                 */
                if (sc->sc_intr == NULL) {
                        printf("%s: warning: no interrupts\n",
                                device_xname(sc->sc_dev));
                        return (NULL);
                }
                pri = sc->sc_intr->oi_pri;
        }

        return (bus_intr_establish(t->parent, pri, level, handler, arg));
}

void
qec_init(struct qec_softc *sc)
{
        bus_space_tag_t t = sc->sc_bustag;
        bus_space_handle_t qr = sc->sc_regs;
        uint32_t v, burst = 0, psize;
        int i;

        /* First, reset the controller */
        bus_space_write_4(t, qr, QEC_QRI_CTRL, QEC_CTRL_RESET);
        for (i = 0; i < 1000; i++) {
                DELAY(100);
                v = bus_space_read_4(t, qr, QEC_QRI_CTRL);
                if ((v & QEC_CTRL_RESET) == 0)
                        break;
        }

        /*
         * Cut available buffer size into receive and transmit buffers.
         * XXX - should probably be done in be & qe driver...
         */
        v = sc->sc_msize = sc->sc_bufsiz / sc->sc_nchannels;
        bus_space_write_4(t, qr, QEC_QRI_MSIZE, v);

        v = sc->sc_rsize = sc->sc_bufsiz / (sc->sc_nchannels * 2);
        bus_space_write_4(t, qr, QEC_QRI_RSIZE, v);
        bus_space_write_4(t, qr, QEC_QRI_TSIZE, v);

        psize = sc->sc_nchannels == 1 ? QEC_PSIZE_2048 : 0;
        bus_space_write_4(t, qr, QEC_QRI_PSIZE, psize);

        if (sc->sc_burst & SBUS_BURST_64)
                burst = QEC_CTRL_B64;
        else if (sc->sc_burst & SBUS_BURST_32)
                burst = QEC_CTRL_B32;
        else
                burst = QEC_CTRL_B16;

        v = bus_space_read_4(t, qr, QEC_QRI_CTRL);
        v = (v & QEC_CTRL_MODEMASK) | burst;
        bus_space_write_4(t, qr, QEC_QRI_CTRL, v);
}

/*
 * Common routine to initialize the QEC packet ring buffer.
 * Called from be & qe drivers.
 */
void
qec_meminit(struct qec_ring *qr, unsigned int pktbufsz)
{
        bus_addr_t txbufdma, rxbufdma;
        bus_addr_t dma;
        uint8_t *p;
        unsigned int ntbuf, nrbuf, i;

        p   = qr->rb_membase;
        dma = qr->rb_dmabase;

        ntbuf = qr->rb_ntbuf;
        nrbuf = qr->rb_nrbuf;

        /*
         * Allocate transmit descriptors
         */
        qr->rb_txd = (struct qec_xd *)p;
        qr->rb_txddma = dma;
        p   += QEC_XD_RING_MAXSIZE * sizeof(struct qec_xd);
        dma += QEC_XD_RING_MAXSIZE * sizeof(struct qec_xd);

        /*
         * Allocate receive descriptors
         */
        qr->rb_rxd = (struct qec_xd *)p;
        qr->rb_rxddma = dma;
        p   += QEC_XD_RING_MAXSIZE * sizeof(struct qec_xd);
        dma += QEC_XD_RING_MAXSIZE * sizeof(struct qec_xd);


        /*
         * Allocate transmit buffers
         */
        qr->rb_txbuf = p;
        txbufdma = dma;
        p   += ntbuf * pktbufsz;
        dma += ntbuf * pktbufsz;

        /*
         * Allocate receive buffers
         */
        qr->rb_rxbuf = p;
        rxbufdma = dma;
        p   += nrbuf * pktbufsz;
        dma += nrbuf * pktbufsz;

        /*
         * Initialize transmit buffer descriptors
         */
        for (i = 0; i < QEC_XD_RING_MAXSIZE; i++) {
                qr->rb_txd[i].xd_addr =
                    (uint32_t)(txbufdma + (i % ntbuf) * pktbufsz);
                qr->rb_txd[i].xd_flags = 0;
        }

        /*
         * Initialize receive buffer descriptors
         */
        for (i = 0; i < QEC_XD_RING_MAXSIZE; i++) {
                qr->rb_rxd[i].xd_addr =
                    (uint32_t)(rxbufdma + (i % nrbuf) * pktbufsz);
                qr->rb_rxd[i].xd_flags = (i < nrbuf)
                        ? QEC_XD_OWN | (pktbufsz & QEC_XD_LENGTH)
                        : 0;
        }

        qr->rb_tdhead = qr->rb_tdtail = 0;
        qr->rb_td_nbusy = 0;
        qr->rb_rdtail = 0;
}