/*      $NetBSD: bus_defs.h,v 1.2 2019/09/23 16:17:55 skrll Exp $       */

/*-
 * Copyright (c) 1996, 1997 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.
 */

/*
 * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
 * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
 *
 * 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 by Christopher G. Demetriou
 *      for the NetBSD Project.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

#ifndef _EVBSH3_BUS_DEFS_H_
#define _EVBSH3_BUS_DEFS_H_

#ifdef _KERNEL
/*
 * Turn on BUS_SPACE_DEBUG if the global DEBUG option is enabled.
 */
#if defined(DEBUG) && !defined(BUS_SPACE_DEBUG)
#define BUS_SPACE_DEBUG
#endif

#ifdef BUS_SPACE_DEBUG
#include <sys/systm.h> /* for printf() prototype */
/*
 * Macros for checking the aligned-ness of pointers passed to bus
 * space ops.  Strict alignment is required by the Alpha architecture,
 * and a trap will occur if unaligned access is performed.  These
 * may aid in the debugging of a broken device driver by displaying
 * useful information about the problem.
 */
#define __BUS_SPACE_ALIGNED_ADDRESS(p, t)                               \
        ((((u_long)(p)) & (sizeof(t)-1)) == 0)

#define __BUS_SPACE_ADDRESS_SANITY(p, t, d)                             \
({                                                                      \
        if (__BUS_SPACE_ALIGNED_ADDRESS((p), t) == 0) {                 \
                printf("%s 0x%lx not aligned to %lu bytes %s:%d\n",     \
                    d, (u_long)(p), (u_long)sizeof(t), __FILE__, __LINE__);     \
        }                                                               \
        (void) 0;                                                       \
})

#define BUS_SPACE_ALIGNED_POINTER(p, t) __BUS_SPACE_ALIGNED_ADDRESS(p, t)
#else
#define __BUS_SPACE_ADDRESS_SANITY(p, t, d)     (void) 0
#define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
#endif /* BUS_SPACE_DEBUG */
#endif /* _KERNEL */

typedef u_long  bus_addr_t;
typedef u_long  bus_size_t;

#define PRIxBUSADDR     "lx"
#define PRIxBUSSIZE     "lx"
#define PRIuBUSSIZE     "lu"

typedef struct _bus_space *bus_space_tag_t;
typedef u_long bus_space_handle_t;

#define PRIxBSH         "lx"

struct _bus_space {
        /* cookie */
        void            *bs_cookie;

        /* mapping/unmapping */
        int             (*bs_map)(void *, bus_addr_t, bus_size_t,
                            int, bus_space_handle_t *);
        void            (*bs_unmap)(void *, bus_space_handle_t,
                            bus_size_t);
        int             (*bs_subregion)(void *, bus_space_handle_t,
                            bus_size_t, bus_size_t, bus_space_handle_t *);

        /* allocation/deallocation */
        int             (*bs_alloc)(void *, bus_addr_t, bus_addr_t,
                            bus_size_t, bus_size_t, bus_size_t, int,
                            bus_addr_t *, bus_space_handle_t *);
        void            (*bs_free)(void *, bus_space_handle_t,
                            bus_size_t);

        /* get kernel virtual address */
        void *          (*bs_vaddr)(void *, bus_space_handle_t);

        /* read (single) */
        uint8_t         (*bs_r_1)(void *, bus_space_handle_t,
                            bus_size_t);
        uint16_t        (*bs_r_2)(void *, bus_space_handle_t,
                            bus_size_t);
        uint32_t        (*bs_r_4)(void *, bus_space_handle_t,
                            bus_size_t);
        uint64_t        (*bs_r_8)(void *, bus_space_handle_t,
                            bus_size_t);

        /* read multiple */
        void            (*bs_rm_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t *, bus_size_t);
        void            (*bs_rm_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t *, bus_size_t);
        void            (*bs_rm_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t *, bus_size_t);
        void            (*bs_rm_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t *, bus_size_t);
                                        
        /* read region */
        void            (*bs_rr_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t *, bus_size_t);
        void            (*bs_rr_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t *, bus_size_t);
        void            (*bs_rr_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t *, bus_size_t);
        void            (*bs_rr_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t *, bus_size_t);

        /* read stream (single) */
        uint8_t         (*bs_rs_1)(void *, bus_space_handle_t,
                            bus_size_t);
        uint16_t        (*bs_rs_2)(void *, bus_space_handle_t,
                            bus_size_t);
        uint32_t        (*bs_rs_4)(void *, bus_space_handle_t,
                            bus_size_t);
        uint64_t        (*bs_rs_8)(void *, bus_space_handle_t,
                            bus_size_t);

        /* read multiple stream */
        void            (*bs_rms_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t *, bus_size_t);
        void            (*bs_rms_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t *, bus_size_t);
        void            (*bs_rms_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t *, bus_size_t);
        void            (*bs_rms_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t *, bus_size_t);
                                        
        /* read region stream */
        void            (*bs_rrs_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t *, bus_size_t);
        void            (*bs_rrs_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t *, bus_size_t);
        void            (*bs_rrs_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t *, bus_size_t);
        void            (*bs_rrs_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t *, bus_size_t);
                                        
        /* write (single) */
        void            (*bs_w_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t);
        void            (*bs_w_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t);
        void            (*bs_w_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t);
        void            (*bs_w_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t);

        /* write multiple */
        void            (*bs_wm_1)(void *, bus_space_handle_t,
                            bus_size_t, const uint8_t *, bus_size_t);
        void            (*bs_wm_2)(void *, bus_space_handle_t,
                            bus_size_t, const uint16_t *, bus_size_t);
        void            (*bs_wm_4)(void *, bus_space_handle_t,
                            bus_size_t, const uint32_t *, bus_size_t);
        void            (*bs_wm_8)(void *, bus_space_handle_t,
                            bus_size_t, const uint64_t *, bus_size_t);
                                        
        /* write region */
        void            (*bs_wr_1)(void *, bus_space_handle_t,
                            bus_size_t, const uint8_t *, bus_size_t);
        void            (*bs_wr_2)(void *, bus_space_handle_t,
                            bus_size_t, const uint16_t *, bus_size_t);
        void            (*bs_wr_4)(void *, bus_space_handle_t,
                            bus_size_t, const uint32_t *, bus_size_t);
        void            (*bs_wr_8)(void *, bus_space_handle_t,
                            bus_size_t, const uint64_t *, bus_size_t);

        /* write stream (single) */
        void            (*bs_ws_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t);
        void            (*bs_ws_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t);
        void            (*bs_ws_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t);
        void            (*bs_ws_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t);

        /* write multiple stream */
        void            (*bs_wms_1)(void *, bus_space_handle_t,
                            bus_size_t, const uint8_t *, bus_size_t);
        void            (*bs_wms_2)(void *, bus_space_handle_t,
                            bus_size_t, const uint16_t *, bus_size_t);
        void            (*bs_wms_4)(void *, bus_space_handle_t,
                            bus_size_t, const uint32_t *, bus_size_t);
        void            (*bs_wms_8)(void *, bus_space_handle_t,
                            bus_size_t, const uint64_t *, bus_size_t);
                                        
        /* write region stream */
        void            (*bs_wrs_1)(void *, bus_space_handle_t,
                            bus_size_t, const uint8_t *, bus_size_t);
        void            (*bs_wrs_2)(void *, bus_space_handle_t,
                            bus_size_t, const uint16_t *, bus_size_t);
        void            (*bs_wrs_4)(void *, bus_space_handle_t,
                            bus_size_t, const uint32_t *, bus_size_t);
        void            (*bs_wrs_8)(void *, bus_space_handle_t,
                            bus_size_t, const uint64_t *, bus_size_t);

        /* set multiple */
        void            (*bs_sm_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t, bus_size_t);
        void            (*bs_sm_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t, bus_size_t);
        void            (*bs_sm_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t, bus_size_t);
        void            (*bs_sm_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t, bus_size_t);

        /* set region */
        void            (*bs_sr_1)(void *, bus_space_handle_t,
                            bus_size_t, uint8_t, bus_size_t);
        void            (*bs_sr_2)(void *, bus_space_handle_t,
                            bus_size_t, uint16_t, bus_size_t);
        void            (*bs_sr_4)(void *, bus_space_handle_t,
                            bus_size_t, uint32_t, bus_size_t);
        void            (*bs_sr_8)(void *, bus_space_handle_t,
                            bus_size_t, uint64_t, bus_size_t);

        /* copy */
        void            (*bs_c_1)(void *, bus_space_handle_t, bus_size_t,
                            bus_space_handle_t, bus_size_t, bus_size_t);
        void            (*bs_c_2)(void *, bus_space_handle_t, bus_size_t,
                            bus_space_handle_t, bus_size_t, bus_size_t);
        void            (*bs_c_4)(void *, bus_space_handle_t, bus_size_t,
                            bus_space_handle_t, bus_size_t, bus_size_t);
        void            (*bs_c_8)(void *, bus_space_handle_t, bus_size_t,
                            bus_space_handle_t, bus_size_t, bus_size_t);
};

#ifdef _KERNEL

extern struct _bus_space evbsh3_bus_space;

#endif /* _KERNEL */

#define BUS_SPACE_MAP_CACHEABLE         0x01
#define BUS_SPACE_MAP_LINEAR            0x02
#define BUS_SPACE_MAP_PREFETCHABLE      0x04

#ifdef _KERNEL

#define BUS_SPACE_BARRIER_READ  0x01
#define BUS_SPACE_BARRIER_WRITE 0x02

/*
 * Bus stream operations--defined in terms of non-stream counterparts
 */
#define __BUS_SPACE_HAS_STREAM_METHODS

#endif /* _KERNEL */

/*
 * Flags used in various bus DMA methods.
 */
#define BUS_DMA_WAITOK          0x000   /* safe to sleep (pseudo-flag) */
#define BUS_DMA_NOWAIT          0x001   /* not safe to sleep */
#define BUS_DMA_ALLOCNOW        0x002   /* perform resource allocation now */
#define BUS_DMA_COHERENT        0x004   /* map memory to not require sync */
#define BUS_DMA_STREAMING       0x008   /* hint: sequential, unidirectional */
#define BUS_DMA_BUS1            0x010   /* placeholders for bus functions... */
#define BUS_DMA_BUS2            0x020
#define BUS_DMA_BUS3            0x040
#define BUS_DMA_BUS4            0x080
#define BUS_DMA_READ            0x100   /* mapping is device -> memory only */
#define BUS_DMA_WRITE           0x200   /* mapping is memory -> device only */
#define BUS_DMA_NOCACHE         0x400   /* hint: map non-cached memory */

/* Forwards needed by prototypes below. */
struct mbuf;
struct uio;

/*
 *      Operations performed by bus_dmamap_sync().
 */
#define BUS_DMASYNC_PREREAD     0x01
#define BUS_DMASYNC_POSTREAD    0x02
#define BUS_DMASYNC_PREWRITE    0x04
#define BUS_DMASYNC_POSTWRITE   0x08

typedef struct _bus_dma_tag *bus_dma_tag_t;
typedef struct _bus_dmamap *bus_dmamap_t;

#define BUS_DMA_TAG_VALID(t)    ((t) != (bus_dma_tag_t)0)

/*
 *      bus_dma_segment_t
 *
 *      Describes a single contiguous DMA transaction.  Values
 *      are suitable for programming into DMA registers.
 */
struct _bus_dma_segment {
        bus_addr_t      ds_addr;        /* DMA address */
        bus_size_t      ds_len;         /* length of transfer */

        /* private section */
        bus_addr_t      _ds_vaddr;      /* virtual address */
};
typedef struct _bus_dma_segment bus_dma_segment_t;

/*
 *      bus_dma_tag_t
 *
 *      A machine-dependent opaque type describing the implementation of
 *      DMA for a given bus.
 */

struct _bus_dma_tag {
        void    *_cookie;               /* cookie used in the guts */

        /*
         * DMA mapping methods.
         */
        int     (*_dmamap_create)(bus_dma_tag_t, bus_size_t, int,
                    bus_size_t, bus_size_t, int, bus_dmamap_t *);
        void    (*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t);
        int     (*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *,
                    bus_size_t, struct proc *, int);
        int     (*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t,
                    struct mbuf *, int);
        int     (*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t,
                    struct uio *, int);
        int     (*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t,
                    bus_dma_segment_t *, int, bus_size_t, int);
        void    (*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t);
        void    (*_dmamap_sync)(bus_dma_tag_t, bus_dmamap_t,
                    bus_addr_t, bus_size_t, int);

        /*
         * DMA memory utility functions.
         */
        int     (*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
                    bus_size_t, bus_dma_segment_t *, int, int *, int);
        void    (*_dmamem_free)(bus_dma_tag_t,
                    bus_dma_segment_t *, int);
        int     (*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
                    int, size_t, void **, int);
        void    (*_dmamem_unmap)(bus_dma_tag_t, void *, size_t);
        paddr_t (*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
                    int, off_t, int, int);
};

/*
 *      bus_dmamap_t
 *
 *      Describes a DMA mapping.
 */
struct _bus_dmamap {
        /*
         * PRIVATE MEMBERS: not for use my machine-independent code.
         */
        bus_size_t      _dm_size;       /* largest DMA transfer mappable */
        int             _dm_segcnt;     /* number of segs this map can map */
        bus_size_t      _dm_maxsegsz;   /* largest possible segment */
        bus_size_t      _dm_boundary;   /* don't cross this */
        int             _dm_flags;      /* misc. flags */

        void            *_dm_cookie;    /* cookie for bus-specific functions */

        /*
         * PUBLIC MEMBERS: these are used by machine-independent code.
         */
        bus_size_t      dm_mapsize;     /* size of the mapping */
        int             dm_nsegs;       /* # valid segments in mapping */
        bus_dma_segment_t dm_segs[1];   /* segments; variable length */
};

#endif  /* _EVBSH3_BUS_DEFS_H_ */