/* $NetBSD: lca_dma.c,v 1.28 2023/08/01 21:26:27 andvar Exp $ */

/*-
* Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
* NASA Ames Research Center.
*
* 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: lca_dma.c,v 1.28 2023/08/01 21:26:27 andvar Exp $");

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

#define _ALPHA_BUS_DMA_PRIVATE
#include <sys/bus.h>

#include <dev/pci/pcireg.h>
#include <dev/pci/pcivar.h>
#include <alpha/pci/lcareg.h>
#include <alpha/pci/lcavar.h>

static bus_dma_tag_t lca_dma_get_tag(bus_dma_tag_t, alpha_bus_t);

static int      lca_bus_dmamap_load_sgmap(bus_dma_tag_t, bus_dmamap_t, void *,
                   bus_size_t, struct proc *, int);

static int      lca_bus_dmamap_load_mbuf_sgmap(bus_dma_tag_t, bus_dmamap_t,
                   struct mbuf *, int);

static int      lca_bus_dmamap_load_uio_sgmap(bus_dma_tag_t, bus_dmamap_t,
                   struct uio *, int);

static int      lca_bus_dmamap_load_raw_sgmap(bus_dma_tag_t, bus_dmamap_t,
                   bus_dma_segment_t *, int, bus_size_t, int);

static void     lca_bus_dmamap_unload_sgmap(bus_dma_tag_t, bus_dmamap_t);

/*
* Direct-mapped window: 1G at 1G
*/
#define LCA_DIRECT_MAPPED_BASE  (1*1024*1024*1024)
#define LCA_DIRECT_MAPPED_SIZE  (1*1024*1024*1024)

/*
* SGMAP window: 8M at 8M
*/
#define LCA_SGMAP_MAPPED_BASE   (8*1024*1024)
#define LCA_SGMAP_MAPPED_SIZE   (8*1024*1024)

/*
* The LCA doesn't have a DMA prefetch threshold.  However, it is known
* to lose if we don't allocate a spill page.  So initialize it to 256.
*/
#define LCA_SGMAP_PFTHRESH      256

/*
* Macro to flush LCA scatter/gather TLB.
*/
#define LCA_TLB_INVALIDATE() \
do { \
       alpha_mb(); \
       REGVAL64(LCA_IOC_TBIA) = 0; \
       alpha_mb(); \
} while (0)

void
lca_dma_init(struct lca_config *lcp)
{
       bus_dma_tag_t t;

       /*
        * Initialize the DMA tag used for direct-mapped DMA.
        */
       t = &lcp->lc_dmat_direct;
       t->_cookie = lcp;
       t->_wbase = LCA_DIRECT_MAPPED_BASE;
       t->_wsize = LCA_DIRECT_MAPPED_SIZE;
       t->_next_window = NULL;
       t->_boundary = 0;
       t->_sgmap = NULL;
       t->_get_tag = lca_dma_get_tag;
       t->_dmamap_create = _bus_dmamap_create;
       t->_dmamap_destroy = _bus_dmamap_destroy;
       t->_dmamap_load = _bus_dmamap_load_direct;
       t->_dmamap_load_mbuf = _bus_dmamap_load_mbuf_direct;
       t->_dmamap_load_uio = _bus_dmamap_load_uio_direct;
       t->_dmamap_load_raw = _bus_dmamap_load_raw_direct;
       t->_dmamap_unload = _bus_dmamap_unload;
       t->_dmamap_sync = _bus_dmamap_sync;

       t->_dmamem_alloc = _bus_dmamem_alloc;
       t->_dmamem_free = _bus_dmamem_free;
       t->_dmamem_map = _bus_dmamem_map;
       t->_dmamem_unmap = _bus_dmamem_unmap;
       t->_dmamem_mmap = _bus_dmamem_mmap;

       /*
        * Initialize the DMA tag used for sgmap-mapped DMA.
        */
       t = &lcp->lc_dmat_sgmap;
       t->_cookie = lcp;
       t->_wbase = LCA_SGMAP_MAPPED_BASE;
       t->_wsize = LCA_SGMAP_MAPPED_SIZE;
       t->_next_window = NULL;
       t->_boundary = 0;
       t->_sgmap = &lcp->lc_sgmap;
       t->_pfthresh = LCA_SGMAP_PFTHRESH;
       t->_get_tag = lca_dma_get_tag;
       t->_dmamap_create = alpha_sgmap_dmamap_create;
       t->_dmamap_destroy = alpha_sgmap_dmamap_destroy;
       t->_dmamap_load = lca_bus_dmamap_load_sgmap;
       t->_dmamap_load_mbuf = lca_bus_dmamap_load_mbuf_sgmap;
       t->_dmamap_load_uio = lca_bus_dmamap_load_uio_sgmap;
       t->_dmamap_load_raw = lca_bus_dmamap_load_raw_sgmap;
       t->_dmamap_unload = lca_bus_dmamap_unload_sgmap;
       t->_dmamap_sync = _bus_dmamap_sync;

       t->_dmamem_alloc = _bus_dmamem_alloc;
       t->_dmamem_free = _bus_dmamem_free;
       t->_dmamem_map = _bus_dmamem_map;
       t->_dmamem_unmap = _bus_dmamem_unmap;
       t->_dmamem_mmap = _bus_dmamem_mmap;

       /* Initialize window 1 as a direct-mapped window. */
       REGVAL64(LCA_IOC_W_BASE1) = LCA_DIRECT_MAPPED_BASE | IOC_W_BASE_WEN;
       REGVAL64(LCA_IOC_W_MASK1) = IOC_W_MASK_1G;
       alpha_mb();

       /* Disable window 0 while we set it up. */
       REGVAL64(LCA_IOC_W_BASE0) = 0;
       alpha_mb();

       /*
        * Initialize the SGMAP.
        */
       alpha_sgmap_init(t, &lcp->lc_sgmap, "lca_sgmap",
           LCA_SGMAP_MAPPED_BASE, 0, LCA_SGMAP_MAPPED_SIZE,
           sizeof(uint64_t), NULL, 0);

       /*
        * Set up window 0 as an 8MB SGMAP-mapped window
        * starting at 8MB.
        */
       REGVAL64(LCA_IOC_W_BASE0) = LCA_SGMAP_MAPPED_BASE |
           IOC_W_BASE_SG | IOC_W_BASE_WEN;
       REGVAL64(LCA_IOC_W_MASK0) = IOC_W_MASK_8M;
       alpha_mb();

       if ((lcp->lc_sgmap.aps_ptpa & IOC_W_T_BASE) !=
           lcp->lc_sgmap.aps_ptpa)
               panic("lca_dma_init: bad page table address");
       REGVAL64(LCA_IOC_W_T_BASE0) = lcp->lc_sgmap.aps_ptpa;
       alpha_mb();

       /* Enable the scatter/gather TLB. */
       REGVAL64(LCA_IOC_TB_ENA) = IOC_TB_ENA_TEN;
       alpha_mb();

       LCA_TLB_INVALIDATE();
}

/*
* Return the bus dma tag to be used for the specified bus type.
* INTERNAL USE ONLY!
*/
static bus_dma_tag_t
lca_dma_get_tag(bus_dma_tag_t t, alpha_bus_t bustype)
{
       struct lca_config *lcp = t->_cookie;

       switch (bustype) {
       case ALPHA_BUS_PCI:
       case ALPHA_BUS_EISA:
               /*
                * Systems with an LCA can only support 1G
                * of memory, so we use the direct-mapped window
                * on busses that have 32-bit DMA.
                */
               return (&lcp->lc_dmat_direct);

       case ALPHA_BUS_ISA:
               /*
                * ISA doesn't have enough address bits to use
                * the direct-mapped DMA window, so we must use
                * SGMAPs.
                */
               return (&lcp->lc_dmat_sgmap);

       default:
               panic("lca_dma_get_tag: shouldn't be here, really...");
       }
}

/*
* Load an LCA SGMAP-mapped DMA map with a linear buffer.
*/
static int
lca_bus_dmamap_load_sgmap(bus_dma_tag_t t, bus_dmamap_t map, void *buf, bus_size_t buflen, struct proc *p, int flags)
{
       int error;

       error = pci_sgmap_pte64_load(t, map, buf, buflen, p, flags,
           t->_sgmap);
       if (error == 0)
               LCA_TLB_INVALIDATE();

       return (error);
}

/*
* Load an LCA SGMAP-mapped DMA map with an mbuf chain.
*/
static int
lca_bus_dmamap_load_mbuf_sgmap(bus_dma_tag_t t, bus_dmamap_t map, struct mbuf *m, int flags)
{
       int error;

       error = pci_sgmap_pte64_load_mbuf(t, map, m, flags, t->_sgmap);
       if (error == 0)
               LCA_TLB_INVALIDATE();

       return (error);
}

/*
* Load an LCA SGMAP-mapped DMA map with a uio.
*/
static int
lca_bus_dmamap_load_uio_sgmap(bus_dma_tag_t t, bus_dmamap_t map, struct uio *uio, int flags)
{
       int error;

       error = pci_sgmap_pte64_load_uio(t, map, uio, flags, t->_sgmap);
       if (error == 0)
               LCA_TLB_INVALIDATE();

       return (error);
}

/*
* Load an LCA SGMAP-mapped DMA map with raw memory.
*/
static int
lca_bus_dmamap_load_raw_sgmap(bus_dma_tag_t t, bus_dmamap_t map, bus_dma_segment_t *segs, int nsegs, bus_size_t size, int flags)
{
       int error;

       error = pci_sgmap_pte64_load_raw(t, map, segs, nsegs, size, flags,
           t->_sgmap);
       if (error == 0)
               LCA_TLB_INVALIDATE();

       return (error);
}

/*
* Unload an LCA DMA map.
*/
static void
lca_bus_dmamap_unload_sgmap(bus_dma_tag_t t, bus_dmamap_t map)
{

       /*
        * Invalidate any SGMAP page table entries used by this
        * mapping.
        */
       pci_sgmap_pte64_unload(t, map, t->_sgmap);
       LCA_TLB_INVALIDATE();

       /*
        * Do the generic bits of the unload.
        */
       _bus_dmamap_unload_common(t, map);
}