/*      $NetBSD: bus_funcs.h,v 1.1 2011/07/19 15:44:53 dyoung 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_FUNCS_H_
#define _EVBSH3_BUS_FUNCS_H_

#ifdef _KERNEL

/*
* Utility macros; INTERNAL USE ONLY.
*/
#define __bs_c(a,b)             __CONCAT(a,b)
#define __bs_opname(op,size)    __bs_c(__bs_c(__bs_c(bs_,op),_),size)

#define __bs_rs(sz, tn, t, h, o)                                        \
       (__BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr"),         \
        (*(t)->__bs_opname(r,sz))((t)->bs_cookie, h, o))
#define __bs_rss(sz, tn, t, h, o)                                       \
       (__BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr"),         \
        (*(t)->__bs_opname(rs,sz))((t)->bs_cookie, h, o))

#define __bs_ws(sz, tn, t, h, o, v)                                     \
do {                                                                    \
       __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr");          \
       (*(t)->__bs_opname(w,sz))((t)->bs_cookie, h, o, v);             \
} while (0)
#define __bs_wss(sz, tn, t, h, o, v)                                    \
do {                                                                    \
       __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr");          \
       (*(t)->__bs_opname(ws,sz))((t)->bs_cookie, h, o, v);            \
} while (0)

#define __bs_nonsingle(type, sz, tn, t, h, o, a, c)                     \
do {                                                                    \
       __BUS_SPACE_ADDRESS_SANITY((a), tn, "buffer");                  \
       __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr");          \
       (*(t)->__bs_opname(type,sz))((t)->bs_cookie, h, o, a, c);       \
} while (0)

#define __bs_set(type, sz, tn, t, h, o, v, c)                           \
do {                                                                    \
       __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr");          \
       (*(t)->__bs_opname(type,sz))((t)->bs_cookie, h, o, v, c);       \
} while (0)

#define __bs_copy(sz, tn, t, h1, o1, h2, o2, cnt)                       \
do {                                                                    \
       __BUS_SPACE_ADDRESS_SANITY((h1) + (o1), tn, "bus addr 1");      \
       __BUS_SPACE_ADDRESS_SANITY((h2) + (o2), tn, "bus addr 2");      \
       (*(t)->__bs_opname(c,sz))((t)->bs_cookie, h1, o1, h2, o2, cnt); \
} while (0)


/*
* Mapping and unmapping operations.
*/
#define bus_space_map(t, a, s, f, hp)                                   \
       (*(t)->bs_map)((t)->bs_cookie, (a), (s), (f), (hp))
#define bus_space_unmap(t, h, s)                                        \
       (*(t)->bs_unmap)((t)->bs_cookie, (h), (s))
#define bus_space_subregion(t, h, o, s, hp)                             \
       (*(t)->bs_subregion)((t)->bs_cookie, (h), (o), (s), (hp))

#endif /* _KERNEL */

#ifdef _KERNEL
/*
* Allocation and deallocation operations.
*/
#define bus_space_alloc(t, rs, re, s, a, b, f, ap, hp)                  \
       (*(t)->bs_alloc)((t)->bs_cookie, (rs), (re), (s), (a), (b),     \
           (f), (ap), (hp))
#define bus_space_free(t, h, s)                                         \
       (*(t)->bs_free)((t)->bs_cookie, (h), (s))

/*
* Get kernel virtual address for ranges mapped BUS_SPACE_MAP_LINEAR.
*/
#define bus_space_vaddr(t, h) \
       (*(t)->bs_vaddr)((t)->bs_cookie, (h))

/*
* Bus barrier operations.  The SH3 does not currently require
* barriers, but we must provide the flags to MI code.
*/
#define bus_space_barrier(t, h, o, l, f)                                \
       ((void)((void)(t), (void)(h), (void)(o), (void)(l), (void)(f)))

/*
* Bus read (single) operations.
*/
#define bus_space_read_1(t, h, o)        __bs_rs(1,uint8_t,(t),(h),(o))
#define bus_space_read_2(t, h, o)        __bs_rs(2,uint16_t,(t),(h),(o))
#define bus_space_read_4(t, h, o)        __bs_rs(4,uint32_t,(t),(h),(o))
#define bus_space_read_8(t, h, o)        __bs_rs(8,uint64_t,(t),(h),(o))
#define bus_space_read_stream_1(t, h, o) __bs_rss(1,uint8_t,(t),(h),(o))
#define bus_space_read_stream_2(t, h, o) __bs_rss(2,uint16_t,(t),(h),(o))
#define bus_space_read_stream_4(t, h, o) __bs_rss(4,uint32_t,(t),(h),(o))
#define bus_space_read_stream_8(t, h, o) __bs_rss(8,uint64_t,(t),(h),(o))


/*
* Bus read multiple operations.
*/
#define bus_space_read_multi_1(t, h, o, a, c)                           \
       __bs_nonsingle(rm,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_2(t, h, o, a, c)                           \
       __bs_nonsingle(rm,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_4(t, h, o, a, c)                           \
       __bs_nonsingle(rm,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_8(t, h, o, a, c)                           \
       __bs_nonsingle(rm,8,uint64_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_stream_1(t, h, o, a, c)                    \
       __bs_nonsingle(rms,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_stream_2(t, h, o, a, c)                    \
       __bs_nonsingle(rms,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_stream_4(t, h, o, a, c)                    \
       __bs_nonsingle(rms,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_read_multi_stream_8(t, h, o, a, c)                    \
       __bs_nonsingle(rms,8,uint64_t,(t),(h),(o),(a),(c))


/*
* Bus read region operations.
*/
#define bus_space_read_region_1(t, h, o, a, c)                          \
       __bs_nonsingle(rr,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_2(t, h, o, a, c)                          \
       __bs_nonsingle(rr,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_4(t, h, o, a, c)                          \
       __bs_nonsingle(rr,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_8(t, h, o, a, c)                          \
       __bs_nonsingle(rr,8,uint64_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_stream_1(t, h, o, a, c)                   \
       __bs_nonsingle(rrs,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_stream_2(t, h, o, a, c)                   \
       __bs_nonsingle(rrs,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_stream_4(t, h, o, a, c)                   \
       __bs_nonsingle(rrs,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_read_region_stream_8(t, h, o, a, c)                   \
       __bs_nonsingle(rrs,8,uint64_t,(t),(h),(o),(a),(c))


/*
* Bus write (single) operations.
*/
#define bus_space_write_1(t, h, o, v)   __bs_ws(1,uint8_t,(t),(h),(o),(v))
#define bus_space_write_2(t, h, o, v)   __bs_ws(2,uint16_t,(t),(h),(o),(v))
#define bus_space_write_4(t, h, o, v)   __bs_ws(4,uint32_t,(t),(h),(o),(v))
#define bus_space_write_8(t, h, o, v)   __bs_ws(8,uint64_t,(t),(h),(o),(v))
#define bus_space_write_stream_1(t, h, o, v)                            \
       __bs_wss(1,uint8_t,(t),(h),(o),(v))
#define bus_space_write_stream_2(t, h, o, v)                            \
       __bs_wss(2,uint16_t,(t),(h),(o),(v))
#define bus_space_write_stream_4(t, h, o, v)                            \
       __bs_wss(4,uint32_t,(t),(h),(o),(v))
#define bus_space_write_stream_8(t, h, o, v)                            \
       __bs_wss(8,uint64_t,(t),(h),(o),(v))


/*
* Bus write multiple operations.
*/
#define bus_space_write_multi_1(t, h, o, a, c)                          \
       __bs_nonsingle(wm,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_2(t, h, o, a, c)                          \
       __bs_nonsingle(wm,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_4(t, h, o, a, c)                          \
       __bs_nonsingle(wm,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_8(t, h, o, a, c)                          \
       __bs_nonsingle(wm,8,uint64_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_stream_1(t, h, o, a, c)                   \
       __bs_nonsingle(wms,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_stream_2(t, h, o, a, c)                   \
       __bs_nonsingle(wms,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_stream_4(t, h, o, a, c)                   \
       __bs_nonsingle(wms,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_write_multi_stream_8(t, h, o, a, c)                   \
       __bs_nonsingle(wms,8,uint64_t,(t),(h),(o),(a),(c))


/*
* Bus write region operations.
*/
#define bus_space_write_region_1(t, h, o, a, c)                         \
       __bs_nonsingle(wr,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_2(t, h, o, a, c)                         \
       __bs_nonsingle(wr,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_4(t, h, o, a, c)                         \
       __bs_nonsingle(wr,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_8(t, h, o, a, c)                         \
       __bs_nonsingle(wr,8,uint64_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_stream_1(t, h, o, a, c)                  \
       __bs_nonsingle(wrs,1,uint8_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_stream_2(t, h, o, a, c)                  \
       __bs_nonsingle(wrs,2,uint16_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_stream_4(t, h, o, a, c)                  \
       __bs_nonsingle(wrs,4,uint32_t,(t),(h),(o),(a),(c))
#define bus_space_write_region_stream_8(t, h, o, a, c)                  \
       __bs_nonsingle(wrs,8,uint64_t,(t),(h),(o),(a),(c))


/*
* Set multiple operations.
*/
#define bus_space_set_multi_1(t, h, o, v, c)                            \
       __bs_set(sm,1,uint8_t,(t),(h),(o),(v),(c))
#define bus_space_set_multi_2(t, h, o, v, c)                            \
       __bs_set(sm,2,uint16_t,(t),(h),(o),(v),(c))
#define bus_space_set_multi_4(t, h, o, v, c)                            \
       __bs_set(sm,4,uint32_t,(t),(h),(o),(v),(c))
#define bus_space_set_multi_8(t, h, o, v, c)                            \
       __bs_set(sm,8,uint64_t,(t),(h),(o),(v),(c))


/*
* Set region operations.
*/
#define bus_space_set_region_1(t, h, o, v, c)                           \
       __bs_set(sr,1,uint8_t,(t),(h),(o),(v),(c))
#define bus_space_set_region_2(t, h, o, v, c)                           \
       __bs_set(sr,2,uint16_t,(t),(h),(o),(v),(c))
#define bus_space_set_region_4(t, h, o, v, c)                           \
       __bs_set(sr,4,uint32_t,(t),(h),(o),(v),(c))
#define bus_space_set_region_8(t, h, o, v, c)                           \
       __bs_set(sr,8,uint64_t,(t),(h),(o),(v),(c))


/*
* Copy region operations.
*/
#define bus_space_copy_region_1(t, h1, o1, h2, o2, c)                   \
       __bs_copy(1, uint8_t, (t), (h1), (o1), (h2), (o2), (c))
#define bus_space_copy_region_2(t, h1, o1, h2, o2, c)                   \
       __bs_copy(2, uint16_t, (t), (h1), (o1), (h2), (o2), (c))
#define bus_space_copy_region_4(t, h1, o1, h2, o2, c)                   \
       __bs_copy(4, uint32_t, (t), (h1), (o1), (h2), (o2), (c))
#define bus_space_copy_region_8(t, h1, o1, h2, o2, c)                   \
       __bs_copy(8, uint64_t, (t), (h1), (o1), (h2), (o2), (c))

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

#endif /* _KERNEL */

#define bus_dmamap_create(t, s, n, m, b, f, p)                  \
       (*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p))
#define bus_dmamap_destroy(t, p)                                \
       (*(t)->_dmamap_destroy)((t), (p))
#define bus_dmamap_load(t, m, b, s, p, f)                       \
       (*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f))
#define bus_dmamap_load_mbuf(t, m, b, f)                        \
       (*(t)->_dmamap_load_mbuf)((t), (m), (b), (f))
#define bus_dmamap_load_uio(t, m, u, f)                         \
       (*(t)->_dmamap_load_uio)((t), (m), (u), (f))
#define bus_dmamap_load_raw(t, m, sg, n, s, f)                  \
       (*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f))
#define bus_dmamap_unload(t, p)                                 \
       (*(t)->_dmamap_unload)((t), (p))
#define bus_dmamap_sync(t, m, o, l, op)                         \
       (void)((t)->_dmamap_sync ?                              \
           (*(t)->_dmamap_sync)((t), (m), (o), (l), (op)) : (void)0)

#define bus_dmamem_alloc(t, s, a, b, sg, n, r, f)               \
       (*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f))
#define bus_dmamem_free(t, sg, n)                               \
       (*(t)->_dmamem_free)((t), (sg), (n))
#define bus_dmamem_map(t, sg, n, s, k, f)                       \
       (*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f))
#define bus_dmamem_unmap(t, k, s)                               \
       (*(t)->_dmamem_unmap)((t), (k), (s))
#define bus_dmamem_mmap(t, sg, n, o, p, f)                      \
       (*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f))

#define bus_dmatag_subregion(t, mna, mxa, nt, f) EOPNOTSUPP
#define bus_dmatag_destroy(t)

#if defined(_EVBSH3_BUS_DMA_PRIVATE)
int     _bus_dmamap_create(bus_dma_tag_t, bus_size_t, int, bus_size_t,
           bus_size_t, int, bus_dmamap_t *);
void    _bus_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
int     _bus_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *, bus_size_t,
           struct proc *, int);
int     _bus_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t, struct mbuf *,int);
int     _bus_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t, struct uio *, int);
int     _bus_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t, bus_dma_segment_t *,
           int, bus_size_t, int);
void    _bus_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
void    _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
           bus_size_t, int);

int     _bus_dmamem_alloc(bus_dma_tag_t tag, bus_size_t size,
           bus_size_t alignment, bus_size_t boundary, bus_dma_segment_t *segs,
           int nsegs, int *rsegs, int flags);
void    _bus_dmamem_free(bus_dma_tag_t tag, bus_dma_segment_t *segs,
           int nsegs);
int     _bus_dmamem_map(bus_dma_tag_t tag, bus_dma_segment_t *segs, int nsegs,
           size_t size, void **kvap, int flags);
void    _bus_dmamem_unmap(bus_dma_tag_t tag, void *kva, size_t size);
paddr_t _bus_dmamem_mmap(bus_dma_tag_t tag, bus_dma_segment_t *segs,
           int nsegs, off_t off, int prot, int flags);
#endif  /* _EVBSH3_BUS_DMA_PRIVATE */

#endif  /* _EVBSH3_BUS_FUNCS_H_ */