/*      $NetBSD: isa_io.c,v 1.13 2023/12/20 13:55:18 thorpej Exp $      */

/*
 * Copyright 1997
 * Digital Equipment Corporation. All rights reserved.
 *
 * This software is furnished under license and may be used and
 * copied only in accordance with the following terms and conditions.
 * Subject to these conditions, you may download, copy, install,
 * use, modify and distribute this software in source and/or binary
 * form. No title or ownership is transferred hereby.
 *
 * 1) Any source code used, modified or distributed must reproduce
 *    and retain this copyright notice and list of conditions as
 *    they appear in the source file.
 *
 * 2) No right is granted to use any trade name, trademark, or logo of
 *    Digital Equipment Corporation. Neither the "Digital Equipment
 *    Corporation" name nor any trademark or logo of Digital Equipment
 *    Corporation may be used to endorse or promote products derived
 *    from this software without the prior written permission of
 *    Digital Equipment Corporation.
 *
 * 3) This software is provided "AS-IS" and any express or implied
 *    warranties, including but not limited to, any implied warranties
 *    of merchantability, fitness for a particular purpose, or
 *    non-infringement are disclaimed. In no event shall DIGITAL be
 *    liable for any damages whatsoever, and in particular, DIGITAL
 *    shall not be liable for special, indirect, consequential, or
 *    incidental damages or damages for lost profits, loss of
 *    revenue or loss of use, whether such damages arise in contract,
 *    negligence, tort, under statute, in equity, at law or otherwise,
 *    even if advised of the possibility of such damage.
 */

/*
 * bus_space I/O functions for isa
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: isa_io.c,v 1.13 2023/12/20 13:55:18 thorpej Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/vmem_impl.h>
#include <sys/bus.h>
#include <machine/pio.h>
#include <machine/isa_machdep.h>

/* Proto types for all the bus_space structure functions */

bs_protos(isa);
bs_protos(bs_notimpl);

/*
 * Declare the isa bus space tags
 * The IO and MEM structs are identical, except for the cookies,
 * which contain the address space bases.
 */

/*
 * NOTE: ASSEMBLY LANGUAGE RELIES ON THE COOKIE -- THE FIRST MEMBER OF 
 *       THIS STRUCTURE -- TO BE THE VIRTUAL ADDRESS OF 16 BIT ISA/IO!
 */
struct bus_space isa_io_bs_tag = {
        /* cookie */
        .bs_cookie = NULL, /* initialized below */

        /* mapping/unmapping */
        .bs_map = isa_bs_map,
        .bs_unmap = isa_bs_unmap,
        .bs_subregion = isa_bs_subregion,

        /* allocation/deallocation */
        .bs_alloc = isa_bs_alloc,
        .bs_free = isa_bs_free,

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

        /* mmap bus space for userland */
        .bs_mmap = bs_notimpl_bs_mmap,          /* XXX possible even? XXX */

        /* barrier */
        .bs_barrier = isa_bs_barrier,

        /* read (single) */
        .bs_r_1 = isa_bs_r_1,
        .bs_r_2 = isa_bs_r_2,
        .bs_r_4 = isa_bs_r_4,
        .bs_r_8 = bs_notimpl_bs_r_8,

        /* read multiple */
        .bs_rm_1 = isa_bs_rm_1,
        .bs_rm_2 = isa_bs_rm_2,
        .bs_rm_4 = isa_bs_rm_4,
        .bs_rm_8 = bs_notimpl_bs_rm_8,

        /* read region */
        .bs_rr_1 = isa_bs_rr_1,
        .bs_rr_2 = isa_bs_rr_2,
        .bs_rr_4 = isa_bs_rr_4,
        .bs_rr_8 = bs_notimpl_bs_rr_8,

        /* write (single) */
        .bs_w_1 = isa_bs_w_1,
        .bs_w_2 = isa_bs_w_2,
        .bs_w_4 = isa_bs_w_4,
        .bs_w_8 = bs_notimpl_bs_w_8,

        /* write multiple */
        .bs_wm_1 = isa_bs_wm_1,
        .bs_wm_2 = isa_bs_wm_2,
        .bs_wm_4 = isa_bs_wm_4,
        .bs_wm_8 = bs_notimpl_bs_wm_8,

        /* write region */
        .bs_wr_1 = isa_bs_wr_1,
        .bs_wr_2 = isa_bs_wr_2,
        .bs_wr_4 = isa_bs_wr_4,
        .bs_wr_8 = bs_notimpl_bs_wr_8,

        /* 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 = isa_bs_sr_2,
        .bs_sr_4 = bs_notimpl_bs_sr_4,
        .bs_sr_8 = bs_notimpl_bs_sr_8,

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

/*
 * NOTE: ASSEMBLY LANGUAGE RELIES ON THE COOKIE -- THE FIRST MEMBER OF 
 *       THIS STRUCTURE -- TO BE THE VIRTUAL ADDRESS OF ISA/MEMORY!
 */
struct bus_space isa_mem_bs_tag = {
        /* cookie */
        .bs_cookie = NULL, /* initialized below */

        /* mapping/unmapping */
        .bs_map = isa_bs_map,
        .bs_unmap = isa_bs_unmap,
        .bs_subregion = isa_bs_subregion,

        /* allocation/deallocation */
        .bs_alloc = isa_bs_alloc,
        .bs_free = isa_bs_free,

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

        /* mmap bus space for userland */
        .bs_mmap = bs_notimpl_bs_mmap,          /* XXX open for now ... XXX */

        /* barrier */
        .bs_barrier = isa_bs_barrier,

        /* read (single) */
        .bs_r_1 = isa_bs_r_1,
        .bs_r_2 = isa_bs_r_2,
        .bs_r_4 = isa_bs_r_4,
        .bs_r_8 = bs_notimpl_bs_r_8,

        /* read multiple */
        .bs_rm_1 = isa_bs_rm_1,
        .bs_rm_2 = isa_bs_rm_2,
        .bs_rm_4 = isa_bs_rm_4,
        .bs_rm_8 = bs_notimpl_bs_rm_8,

        /* read region */
        .bs_rr_1 = isa_bs_rr_1,
        .bs_rr_2 = isa_bs_rr_2,
        .bs_rr_4 = isa_bs_rr_4,
        .bs_rr_8 = bs_notimpl_bs_rr_8,

        /* write (single) */
        .bs_w_1 = isa_bs_w_1,
        .bs_w_2 = isa_bs_w_2,
        .bs_w_4 = isa_bs_w_4,
        .bs_w_8 = bs_notimpl_bs_w_8,

        /* write multiple */
        .bs_wm_1 = isa_bs_wm_1,
        .bs_wm_2 = isa_bs_wm_2,
        .bs_wm_4 = isa_bs_wm_4,
        .bs_wm_8 = bs_notimpl_bs_wm_8,

        /* write region */
        .bs_wr_1 = isa_bs_wr_1,
        .bs_wr_2 = isa_bs_wr_2,
        .bs_wr_4 = isa_bs_wr_4,
        .bs_wr_8 = bs_notimpl_bs_wr_8,

        /* 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 = isa_bs_sr_2,
        .bs_sr_4 = bs_notimpl_bs_sr_4,
        .bs_sr_8 = bs_notimpl_bs_sr_8,

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

#define ISAIO_BTAG_COUNT        VMEM_EST_BTCOUNT(1, 8)
#define ISAMEM_BTAG_COUNT       VMEM_EST_BTCOUNT(1, 8)

static struct vmem isaio_arena_store;
static struct vmem isamem_arena_store;
static struct vmem_btag isaio_btag_store[ISAIO_BTAG_COUNT];
static struct vmem_btag isamem_btag_store[ISAMEM_BTAG_COUNT];
static vmem_t *isaio_arena;
static vmem_t *isamem_arena;

/* bus space functions */

void
isa_io_init(vaddr_t isa_io_addr, vaddr_t isa_mem_addr)
{
        int error __diagused;

        isa_io_bs_tag.bs_cookie = (void *)isa_io_addr;
        isa_mem_bs_tag.bs_cookie = (void *)isa_mem_addr;

        isaio_arena = vmem_init(&isaio_arena_store,
                                "isaio",
                                0,                      /* addr */
                                0,                      /* size */
                                1,                      /* quantum */
                                NULL,                   /* importfn */
                                NULL,                   /* releasefn */
                                NULL,                   /* source */
                                0,                      /* qcache_max */
                                VM_NOSLEEP | VM_PRIVTAGS,
                                IPL_NONE);
        KASSERT(isaio_arena != NULL);

        vmem_add_bts(isaio_arena, isaio_btag_store, ISAIO_BTAG_COUNT);
        error = vmem_add(isaio_arena, 0x0, 0x10000, VM_NOSLEEP);
        KASSERT(error == 0);

        isamem_arena = vmem_init(&isamem_arena_store,
                                 "isamem",
                                 0,                     /* addr */
                                 0,                     /* size */
                                 1,                     /* quantum */
                                 NULL,                  /* importfn */
                                 NULL,                  /* releasefn */
                                 NULL,                  /* source */
                                 0,                     /* qcache_max */
                                 VM_NOSLEEP | VM_PRIVTAGS,
                                 IPL_NONE);
        KASSERT(isamem_arena != NULL);

        vmem_add_bts(isamem_arena, isamem_btag_store, ISAMEM_BTAG_COUNT);
        error = vmem_add(isamem_arena, 0x0, 0x100000, VM_NOSLEEP);
        KASSERT(error == 0);
}

/*
 * break the abstraction: sometimes, other parts of the system
 * (e.g. X servers) need to map ISA space directly.  use these
 * functions sparingly!
 */
vaddr_t
isa_io_data_vaddr(void)
{
        return (vaddr_t)isa_io_bs_tag.bs_cookie;
}

vaddr_t
isa_mem_data_vaddr(void)
{
        return (vaddr_t)isa_mem_bs_tag.bs_cookie;
}

int
isa_bs_map(void *t, bus_addr_t bpa, bus_size_t size, int cacheable, bus_space_handle_t *bshp)
{
        vmem_t *vm;
        int err;

        if (t == isa_io_bs_tag.bs_cookie) 
                vm = isaio_arena;
        else
                vm = isamem_arena;

        err = vmem_xalloc_addr(vm, bpa, size, VM_NOSLEEP);
        if (err)
                return err;

        *bshp = bpa + (bus_addr_t)t;
        return(0);
}

void
isa_bs_unmap(void *t, bus_space_handle_t bsh, bus_size_t size)
{
        isa_bs_free(t, bsh, size);
}

int
isa_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);
}

int
isa_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 cacheable,
        bus_addr_t *bpap,
        bus_space_handle_t *bshp)
{
        vmem_t *vm;
        vmem_addr_t bpa;
        int err;

        if (t == isa_io_bs_tag.bs_cookie) 
                vm = isaio_arena;
        else
                vm = isamem_arena;

        err = vmem_xalloc(vm, size,
                          alignment,            /* align */
                          0,                    /* phase */
                          boundary,             /* nocross */
                          rstart,               /* minaddr */
                          rend,                 /* maxaddr */
                          VM_BESTFIT | VM_NOSLEEP,
                          &bpa);
        if (err)
                return err;

        *bshp = *bpap = bpa + (bus_addr_t)t;
        return 0;
}

void    
isa_bs_free(void *t, bus_space_handle_t bsh, bus_size_t size)
{
        vmem_t *vm;

        if (t == isa_io_bs_tag.bs_cookie) 
                vm = isaio_arena;
        else
                vm = isamem_arena;

        vmem_xfree(vm, bsh - (bus_addr_t)t, size);
}

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

        return ((void *)bsh);
}

void
isa_bs_barrier(void *t, bus_space_handle_t bsh, bus_size_t offset, bus_size_t len, int flags)
{
        /* just return */
}