/*      $NetBSD: i80321_space.c,v 1.18 2018/11/21 19:03:18 macallan Exp $       */

/*
 * Copyright (c) 2001, 2002 Wasabi Systems, Inc.
 * All rights reserved.
 *
 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
 *
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed for the NetBSD Project by
 *      Wasabi Systems, Inc.
 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
 *    or promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``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 WASABI SYSTEMS, INC
 * 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.
 */

/*
 * bus_space functions for i80321 I/O Processor.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: i80321_space.c,v 1.18 2018/11/21 19:03:18 macallan Exp $");

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

#include <uvm/uvm_extern.h>

#include <sys/bus.h>

#include <arm/xscale/i80321reg.h>
#include <arm/xscale/i80321var.h>

#include "opt_i80321.h"

/* Prototypes for all the bus_space structure functions */
bs_protos(i80321);
bs_protos(i80321_io);
bs_protos(i80321_mem);
bs_protos(generic);
bs_protos(generic_armv4);
bs_protos(bs_notimpl);

/*
 * Template bus_space -- copied, and the bits that are NULL are
 * filled in.
 */
const struct bus_space i80321_bs_tag_template = {
        /* cookie */
        .bs_cookie = (void *) 0,

        /* mapping/unmapping */
        .bs_map = NULL,
        .bs_unmap = NULL,
        .bs_subregion = i80321_bs_subregion,

        /* allocation/deallocation */
        .bs_alloc = NULL,
        .bs_free = NULL,

        /* get kernel virtual address */
        .bs_vaddr = i80321_bs_vaddr,

        /* mmap */
        .bs_mmap = i80321_bs_mmap,

        /* barrier */
        .bs_barrier = i80321_bs_barrier,

        /* read (single) */
        .bs_r_1 = generic_bs_r_1,
        .bs_r_2 = generic_armv4_bs_r_2,
        .bs_r_4 = generic_bs_r_4,
        .bs_r_8 = bs_notimpl_bs_r_8,

#ifdef __BUS_SPACE_HAS_STREAM_METHODS
        /* read (single, stream) */
        .bs_r_1_s = generic_bs_r_1,
        .bs_r_2_s = generic_armv4_bs_r_2,
        .bs_r_4_s = generic_bs_r_4,
        .bs_r_8_s = bs_notimpl_bs_r_8,
#endif

        /* read multiple */
        .bs_rm_1 = generic_bs_rm_1,
        .bs_rm_2 = generic_armv4_bs_rm_2,
        .bs_rm_4 = generic_bs_rm_4,
        .bs_rm_8 = bs_notimpl_bs_rm_8,

#ifdef __BUS_SPACE_HAS_STREAM_METHODS
        /* read multiple, stream */
        .bs_rm_1_s = generic_bs_rm_1,
        .bs_rm_2_s = generic_armv4_bs_rm_2,
        .bs_rm_4_s = generic_bs_rm_4,
        .bs_rm_8_s = bs_notimpl_bs_rm_8,
#endif

        /* read region */
        .bs_rr_1 = generic_bs_rr_1,
        .bs_rr_2 = generic_armv4_bs_rr_2,
        .bs_rr_4 = generic_bs_rr_4,
        .bs_rr_8 = bs_notimpl_bs_rr_8,

#ifdef __BUS_SPACE_HAS_STREAM_METHODS
        /* read region, stream */
        .bs_rr_1_s = generic_bs_rr_1,
        .bs_rr_2_s = generic_armv4_bs_rr_2,
        .bs_rr_4_s = generic_bs_rr_4,
        .bs_rr_8_s = bs_notimpl_bs_rr_8,
#endif

        /* write (single) */
        .bs_w_1 = generic_bs_w_1,
        .bs_w_2 = generic_armv4_bs_w_2,
        .bs_w_4 = generic_bs_w_4,
        .bs_w_8 = bs_notimpl_bs_w_8,

#ifdef __BUS_SPACE_HAS_STREAM_METHODS
        /* write (single, stream) */
        .bs_w_1_s = generic_bs_w_1,
        .bs_w_2_s = generic_armv4_bs_w_2,
        .bs_w_4_s = generic_bs_w_4,
        .bs_w_8_s = bs_notimpl_bs_w_8,
#endif

        /* write multiple */
        .bs_wm_1 = generic_bs_wm_1,
        .bs_wm_2 = generic_armv4_bs_wm_2,
        .bs_wm_4 = generic_bs_wm_4,
        .bs_wm_8 = bs_notimpl_bs_wm_8,

#ifdef __BUS_SPACE_HAS_STREAM_METHODS
        /* write multiple, stream */
        .bs_wm_1_s = generic_bs_wm_1,
        .bs_wm_2_s = generic_armv4_bs_wm_2,
        .bs_wm_4_s = generic_bs_wm_4,
        .bs_wm_8_s = bs_notimpl_bs_wm_8,
#endif

        /* write region */
        .bs_wr_1 = generic_bs_wr_1,
        .bs_wr_2 = generic_armv4_bs_wr_2,
        .bs_wr_4 = generic_bs_wr_4,
        .bs_wr_8 = bs_notimpl_bs_wr_8,

#ifdef __BUS_SPACE_HAS_STREAM_METHODS
        /* write region, stream */
        .bs_wr_1_s = generic_bs_wr_1,
        .bs_wr_2_s = generic_armv4_bs_wr_2,
        .bs_wr_4_s = generic_bs_wr_4,
        .bs_wr_8_s = bs_notimpl_bs_wr_8,
#endif

        /* set multiple */
        .bs_sm_1 = bs_notimpl_bs_sm_1,
        .bs_sm_2 = bs_notimpl_bs_sm_2,
        .bs_sm_4 = bs_notimpl_bs_sm_4,
        .bs_sm_8 = bs_notimpl_bs_sm_8,

        /* set region */
        .bs_sr_1 = bs_notimpl_bs_sr_1,
        .bs_sr_2 = generic_armv4_bs_sr_2,
        .bs_sr_4 = generic_bs_sr_4,
        .bs_sr_8 = bs_notimpl_bs_sr_8,

        /* copy */
        .bs_c_1 = bs_notimpl_bs_c_1,
        .bs_c_2 = generic_armv4_bs_c_2,
        .bs_c_4 = bs_notimpl_bs_c_4,
        .bs_c_8 = bs_notimpl_bs_c_8,
};

void
i80321_bs_init(bus_space_tag_t bs, void *cookie)
{

        *bs = i80321_bs_tag_template;
        bs->bs_cookie = cookie;
}

void
i80321_io_bs_init(bus_space_tag_t bs, void *cookie)
{

        *bs = i80321_bs_tag_template;
        bs->bs_cookie = cookie;

        bs->bs_map = i80321_io_bs_map;
        bs->bs_unmap = i80321_io_bs_unmap;
        bs->bs_alloc = i80321_io_bs_alloc;
        bs->bs_free = i80321_io_bs_free;

        bs->bs_vaddr = i80321_io_bs_vaddr;
        bs->bs_mmap = i80321_io_bs_mmap;
}

void
i80321_mem_bs_init(bus_space_tag_t bs, void *cookie)
{

        *bs = i80321_bs_tag_template;
        bs->bs_cookie = cookie;

        bs->bs_map = i80321_mem_bs_map;
        bs->bs_unmap = i80321_mem_bs_unmap;
        bs->bs_alloc = i80321_mem_bs_alloc;
        bs->bs_free = i80321_mem_bs_free;
        bs->bs_mmap = i80321_mem_bs_mmap;
}

/* *** Routines shared by i80321, PCI IO, and PCI MEM. *** */

int
i80321_bs_subregion(void *t, bus_space_handle_t bsh, bus_size_t offset,
    bus_size_t size, bus_space_handle_t *nbshp)
{

        *nbshp = bsh + offset;
        return (0);
}

void
i80321_bs_barrier(void *t, bus_space_handle_t bsh, bus_size_t offset,
    bus_size_t len, int flags)
{

        /* Nothing to do. */
}

void *
i80321_bs_vaddr(void *t, bus_space_handle_t bsh)
{

        return ((void *)bsh);
}

paddr_t
i80321_bs_mmap(void *t, bus_addr_t addr, off_t off, int prot, int flags)
{

        /* Not supported. */
        return (-1);
}

/* *** Routines for PCI IO. *** */

int
i80321_io_bs_map(void *t, bus_addr_t bpa, bus_size_t size, int flags,
    bus_space_handle_t *bshp)
{
        struct i80321_softc *sc = t;
        vaddr_t winvaddr;
        uint32_t busbase;

        if (bpa >= sc->sc_ioout_xlate &&
            bpa < (sc->sc_ioout_xlate + VERDE_OUT_XLATE_IO_WIN_SIZE)) {
                busbase = sc->sc_ioout_xlate;
                winvaddr = sc->sc_iow_vaddr;
        } else
                return (EINVAL);

        if ((bpa + size) >= (busbase + VERDE_OUT_XLATE_IO_WIN_SIZE))
                return (EINVAL);

        /*
         * Found the window -- PCI I/O space is mapped at a fixed
         * virtual address by board-specific code.  Translate the
         * bus address to the virtual address.
         */
        *bshp = winvaddr + (bpa - busbase);

        return (0);
}

paddr_t
i80321_io_bs_mmap(void *t, bus_addr_t addr, off_t off, int prot, int flags)
{
        struct i80321_softc *sc = t;
        paddr_t bpa = addr + off, winpaddr, busbase;

        if (bpa >= sc->sc_ioout_xlate &&
            bpa < (sc->sc_ioout_xlate + VERDE_OUT_XLATE_IO_WIN_SIZE)) {
                busbase = sc->sc_ioout_xlate;
                winpaddr = VERDE_OUT_XLATE_IO_WIN0_BASE;                
        } else
                return (-1);

        return (arm_btop(winpaddr + (bpa - busbase)));
}

void
i80321_io_bs_unmap(void *t, bus_space_handle_t bsh, bus_size_t size)
{

        /* Nothing to do. */
}

int
i80321_io_bs_alloc(void *t, bus_addr_t rstart, bus_addr_t rend,
    bus_size_t size, bus_size_t alignment, bus_size_t boundary, int flags,
    bus_addr_t *bpap, bus_space_handle_t *bshp)
{

        panic("i80321_io_bs_alloc(): not implemented");
}

void    
i80321_io_bs_free(void *t, bus_space_handle_t bsh, bus_size_t size)
{

        panic("i80321_io_bs_free(): not implemented");
}

void *
i80321_io_bs_vaddr(void *t, bus_space_handle_t bsh)
{

        /* Not supported. */
        return (NULL);
}

/* *** Routines for PCI MEM. *** */

int
i80321_mem_bs_map(void *t, bus_addr_t bpa, bus_size_t size, int flags,
    bus_space_handle_t *bshp)
{

#ifndef I80321_USE_DIRECT_WIN
        struct i80321_softc *sc = t;
#endif
        vaddr_t va;
        uint32_t busbase;
        paddr_t pa, endpa, physbase;

#ifdef I80321_USE_DIRECT_WIN
        if (
#if VERDE_OUT_DIRECT_WIN_BASE != 0
            bpa >= (VERDE_OUT_DIRECT_WIN_BASE) &&
#endif
            bpa < (VERDE_OUT_DIRECT_WIN_BASE + VERDE_OUT_DIRECT_WIN_SIZE)) {
                busbase = VERDE_OUT_DIRECT_WIN_BASE;
                physbase = VERDE_OUT_DIRECT_WIN_BASE;
        } else
                return (EINVAL);
        if ((bpa + size) >= (VERDE_OUT_DIRECT_WIN_BASE +
            VERDE_OUT_DIRECT_WIN_SIZE))
                return (EINVAL);
#else
        if (bpa >= sc->sc_owin[0].owin_xlate_lo &&
            bpa < (sc->sc_owin[0].owin_xlate_lo +
                   VERDE_OUT_XLATE_MEM_WIN_SIZE)) {
                busbase = sc->sc_owin[0].owin_xlate_lo;
                physbase = sc->sc_iwin[1].iwin_xlate;
        } else
                return (EINVAL);

        if ((bpa + size) >= (busbase + VERDE_OUT_XLATE_MEM_WIN_SIZE))
                return (EINVAL);
#endif

        /*
         * Found the window -- PCI MEM space is now mapped by allocating
         * some kernel VA space and mapping the pages with pmap_enter().
         * pmap_enter() will map unmanaged pages as non-cacheable.
         */
        pa = trunc_page((bpa - busbase) + physbase);
        endpa = round_page(((bpa - busbase) + physbase) + size);

        va = uvm_km_alloc(kernel_map, endpa - pa, 0,
            UVM_KMF_VAONLY | UVM_KMF_NOWAIT);
        if (va == 0)
                return (ENOMEM);

        *bshp = va + (bpa & PAGE_MASK);

        for (; pa < endpa; pa += PAGE_SIZE, va += PAGE_SIZE) {
                pmap_enter(pmap_kernel(), va, pa,
                    VM_PROT_READ | VM_PROT_WRITE,
                    VM_PROT_READ | VM_PROT_WRITE | PMAP_WIRED |
                    ((flags & BUS_SPACE_MAP_PREFETCHABLE) ?
                       ARM_MMAP_WRITECOMBINE : 0));
        }
        pmap_update(pmap_kernel());

        return (0);
}

void
i80321_mem_bs_unmap(void *t, bus_space_handle_t bsh, bus_size_t size)
{
        vaddr_t va, endva;

        va = trunc_page(bsh);
        endva = round_page(bsh + size);

        pmap_remove(pmap_kernel(), va, endva - va);
        pmap_update(pmap_kernel());

        /* Free the kernel virtual mapping. */
        uvm_km_free(kernel_map, va, endva - va, UVM_KMF_VAONLY);
}

int
i80321_mem_bs_alloc(void *t, bus_addr_t rstart, bus_addr_t rend,
    bus_size_t size, bus_size_t alignment, bus_size_t boundary, int flags,
    bus_addr_t *bpap, bus_space_handle_t *bshp)
{

        panic("i80321_mem_bs_alloc(): not implemented");
}

void    
i80321_mem_bs_free(void *t, bus_space_handle_t bsh, bus_size_t size)
{

        panic("i80321_mem_bs_free(): not implemented");
}

paddr_t
i80321_mem_bs_mmap(void *t, bus_addr_t addr, off_t off, int prot, int flags)
{
#ifndef I80321_USE_DIRECT_WIN
        struct i80321_softc *sc = t;
#endif
        uint32_t busbase;
        paddr_t pa, physbase, bpa = addr + off, pflags = 0;

#ifdef I80321_USE_DIRECT_WIN
        if (
#if VERDE_OUT_DIRECT_WIN_BASE != 0
            bpa >= (VERDE_OUT_DIRECT_WIN_BASE) &&
#endif
            bpa < (VERDE_OUT_DIRECT_WIN_BASE + VERDE_OUT_DIRECT_WIN_SIZE)) {
                busbase = VERDE_OUT_DIRECT_WIN_BASE;
                physbase = VERDE_OUT_DIRECT_WIN_BASE;
        } else
                return (-1);
#else
        if (bpa >= sc->sc_owin[0].owin_xlate_lo &&
            bpa < (sc->sc_owin[0].owin_xlate_lo +
                   VERDE_OUT_XLATE_MEM_WIN_SIZE)) {
                busbase = sc->sc_owin[0].owin_xlate_lo;
                physbase = sc->sc_iwin[1].iwin_xlate;
        } else
                return (-1);
#endif

        pa = trunc_page((bpa - busbase) + physbase);
        if (flags & BUS_SPACE_MAP_PREFETCHABLE) {
                pflags = ARM_MMAP_WRITECOMBINE;
        }
        return (arm_btop(pa) | pflags);
}