NetBSD-5.0.2/sys/arch/mipsco/include/bus.h
/* $NetBSD: bus.h,v 1.19 2008/04/28 20:23:28 martin Exp $ */
/*-
* Copyright (c) 1996, 1997, 1998, 2001 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) 1997 Per Fogelstrom. All rights reserved.
* Copyright (c) 1996 Niklas Hallqvist. 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 _MIPSCO_BUS_H_
#define _MIPSCO_BUS_H_
#ifdef _KERNEL
#include <mips/locore.h>
#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 MIPS 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 %d bytes %s:%d\n", \
d, (u_long)(p), 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 */
/*
* Utility macro; do not use outside this file.
*/
#ifdef __STDC__
#define __CONCAT3(a,b,c) a##b##c
#else
#define __CONCAT3(a,b,c) a/**/b/**/c
#endif
/*
* Bus address and size types
*/
typedef u_long bus_addr_t;
typedef u_long bus_size_t;
/*
* Access methods for bus resources and address space.
*/
typedef u_int32_t bus_space_handle_t;
typedef struct mipsco_bus_space *bus_space_tag_t;
struct mipsco_bus_space {
const char *bs_name;
struct extent *bs_extent;
bus_addr_t bs_start;
bus_size_t bs_size;
paddr_t bs_pbase;
vaddr_t bs_vbase;
u_int8_t bs_stride; /* log2(stride) */
u_int8_t bs_bswap; /* byte swap in stream methods */
u_int8_t bs_offset_1;
u_int8_t bs_offset_2;
u_int8_t bs_offset_4;
u_int8_t bs_offset_8;
/* compose a bus_space handle from tag/handle/addr/size/flags (MD) */
int (*bs_compose_handle) __P((bus_space_tag_t, bus_addr_t,
bus_size_t, int, bus_space_handle_t *));
/* dispose a bus_space handle (MD) */
int (*bs_dispose_handle) __P((bus_space_tag_t, bus_space_handle_t,
bus_size_t));
/* convert bus_space tag/handle to physical address (MD) */
int (*bs_paddr) __P((bus_space_tag_t, bus_space_handle_t,
paddr_t *));
/* mapping/unmapping */
int (*bs_map) __P((bus_space_tag_t, bus_addr_t, bus_size_t, int,
bus_space_handle_t *));
void (*bs_unmap) __P((bus_space_tag_t, bus_space_handle_t,
bus_size_t));
int (*bs_subregion) __P((bus_space_tag_t, bus_space_handle_t,
bus_size_t, bus_size_t, bus_space_handle_t *));
paddr_t (*bs_mmap) __P((bus_space_tag_t, bus_addr_t, off_t, int, int));
/* allocation/deallocation */
int (*bs_alloc) __P((bus_space_tag_t, 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) __P((bus_space_tag_t, bus_space_handle_t,
bus_size_t));
/* interrupt attach */
void (*bs_intr_establish) __P((
bus_space_tag_t,
int, /*bus-specific intr*/
int, /*priority/class*/
int, /*flags*/
int (*) __P((void *)), /*handler*/
void *)); /*handler arg*/
void *bs_aux;
};
/* vaddr_t argument of mipsco_bus_space_init() */
#define MIPSCO_BUS_SPACE_UNMAPPED ((vaddr_t)0)
/* machine dependent utility function for bus_space users */
void mipsco_bus_space_malloc_set_safe __P((void));
void mipsco_bus_space_init __P((bus_space_tag_t, const char *,
paddr_t, vaddr_t, bus_addr_t, bus_size_t));
void mipsco_bus_space_init_extent __P((bus_space_tag_t, void *, size_t));
void mipsco_bus_space_set_aligned_stride __P((bus_space_tag_t, unsigned int));
void mipsco_sparse_bus_space_init __P((bus_space_tag_t, const char *,
paddr_t, bus_addr_t, bus_size_t));
void mipsco_large_bus_space_init __P((bus_space_tag_t, const char *,
paddr_t, bus_addr_t, bus_size_t));
/* machine dependent utility function for bus_space implementations */
int mipsco_bus_space_extent_malloc_flag __P((void));
/* these are provided for subclasses which override base bus_space. */
int mipsco_bus_space_compose_handle __P((bus_space_tag_t,
bus_addr_t, bus_size_t, int, bus_space_handle_t *));
int mipsco_bus_space_dispose_handle __P((bus_space_tag_t,
bus_space_handle_t, bus_size_t));
int mipsco_bus_space_paddr __P((bus_space_tag_t,
bus_space_handle_t, paddr_t *));
int mipsco_sparse_bus_space_compose_handle __P((bus_space_tag_t,
bus_addr_t, bus_size_t, int, bus_space_handle_t *));
int mipsco_sparse_bus_space_dispose_handle __P((bus_space_tag_t,
bus_space_handle_t, bus_size_t));
int mipsco_sparse_bus_space_paddr __P((bus_space_tag_t,
bus_space_handle_t, paddr_t *));
int mipsco_bus_space_map __P((bus_space_tag_t, bus_addr_t, bus_size_t, int,
bus_space_handle_t *));
void mipsco_bus_space_unmap __P((bus_space_tag_t, bus_space_handle_t,
bus_size_t));
int mipsco_bus_space_subregion __P((bus_space_tag_t, bus_space_handle_t,
bus_size_t, bus_size_t, bus_space_handle_t *));
paddr_t mipsco_bus_space_mmap __P((bus_space_tag_t, bus_addr_t, off_t,
int, int));
int mipsco_bus_space_alloc __P((bus_space_tag_t, bus_addr_t, bus_addr_t,
bus_size_t, bus_size_t, bus_size_t, int, bus_addr_t *,
bus_space_handle_t *));
#define mipsco_bus_space_free mipsco_bus_space_unmap
/*
* int bus_space_compose_handle __P((bus_space_tag_t t, bus_addr_t addr,
* bus_size_t size, int flags, bus_space_handle_t *bshp));
*
* MACHINE DEPENDENT, NOT PORTABLE INTERFACE:
* Compose a bus_space handle from tag/handle/addr/size/flags.
* A helper function for bus_space_map()/bus_space_alloc() implementation.
*/
#define bus_space_compose_handle(bst, addr, size, flags, bshp) \
(*(bst)->bs_compose_handle)(bst, addr, size, flags, bshp)
/*
* int bus_space_dispose_handle __P((bus_space_tag_t t, bus_addr_t addr,
* bus_space_handle_t bsh, bus_size_t size));
*
* MACHINE DEPENDENT, NOT PORTABLE INTERFACE:
* Dispose a bus_space handle.
* A helper function for bus_space_unmap()/bus_space_free() implementation.
*/
#define bus_space_dispose_handle(bst, bsh, size) \
(*(bst)->bs_dispose_handle)(bst, bsh, size)
/*
* int bus_space_paddr __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, paddr_t *pap));
*
* MACHINE DEPENDENT, NOT PORTABLE INTERFACE:
* (cannot be implemented on e.g. I/O space on i386, non-linear space on alpha)
* Return physical address of a region.
* A helper function for device mmap entry.
*/
#define bus_space_paddr(bst, bsh, pap) \
(*(bst)->bs_paddr)(bst, bsh, pap)
/*
* void *bus_space_vaddr __P((bus_space_tag_t, bus_space_handle_t));
*
* Get the kernel virtual address for the mapped bus space.
* Only allowed for regions mapped with BUS_SPACE_MAP_LINEAR.
* (XXX not enforced)
*/
#define bus_space_vaddr(bst, bsh) \
((void *)(bsh))
/*
* paddr_t bus_space_mmap __P((bus_space_tag_t, bus_addr_t, off_t,
* int, int));
*
* Mmap bus space on behalf of the user.
*/
#define bus_space_mmap(bst, addr, off, prot, flags) \
(*(bst)->bs_mmap)((bst), (addr), (off), (prot), (flags))
/*
* int bus_space_map __P((bus_space_tag_t t, bus_addr_t addr,
* bus_size_t size, int flags, bus_space_handle_t *bshp));
*
* Map a region of bus space.
*/
#define BUS_SPACE_MAP_CACHEABLE 0x01
#define BUS_SPACE_MAP_LINEAR 0x02
#define BUS_SPACE_MAP_PREFETCHABLE 0x04
#define bus_space_map(t, a, s, f, hp) \
(*(t)->bs_map)((t), (a), (s), (f), (hp))
/*
* void bus_space_unmap __P((bus_space_tag_t t,
* bus_space_handle_t bsh, bus_size_t size));
*
* Unmap a region of bus space.
*/
#define bus_space_unmap(t, h, s) \
(*(t)->bs_unmap)((t), (h), (s))
/*
* int bus_space_subregion __P((bus_space_tag_t t,
* bus_space_handle_t bsh, bus_size_t offset, bus_size_t size,
* bus_space_handle_t *nbshp));
*
* Get a new handle for a subregion of an already-mapped area of bus space.
*/
#define bus_space_subregion(t, h, o, s, hp) \
(*(t)->bs_subregion)((t), (h), (o), (s), (hp))
/*
* int bus_space_alloc __P((bus_space_tag_t t, bus_addr_t, rstart,
* bus_addr_t rend, bus_size_t size, bus_size_t align,
* bus_size_t boundary, int flags, bus_addr_t *addrp,
* bus_space_handle_t *bshp));
*
* Allocate a region of bus space.
*/
#define bus_space_alloc(t, rs, re, s, a, b, f, ap, hp) \
(*(t)->bs_alloc)((t), (rs), (re), (s), (a), (b), (f), (ap), (hp))
/*
* int bus_space_free __P((bus_space_tag_t t,
* bus_space_handle_t bsh, bus_size_t size));
*
* Free a region of bus space.
*/
#define bus_space_free(t, h, s) \
(*(t)->bs_free)((t), (h), (s))
/*
* void bus_intr_establish __P((bus_space_tag_t bst,
* int level, int pri, int flags, int (*func) __P((void *))
* void *arg));
*
* Attach interrupt handler and softc argument
*/
#define bus_intr_establish(t, i, c, f, ihf, iha) \
(*(t)->bs_intr_establish)((t), (i), (c), (f), (ihf), (iha))
/*
* Utility macros; do not use outside this file.
*/
#define __BS_TYPENAME(BITS) __CONCAT3(u_int,BITS,_t)
#define __BS_OFFSET(t, o, BYTES) ((o) << (t)->bs_stride)
#define __BS_FUNCTION(func,BYTES) __CONCAT3(func,_,BYTES)
/*
* Calculate the target address using the bus_space parameters
*/
#define __BS_ADDR(t, h, offset, BITS, BYTES) \
((volatile __CONCAT3(u_int,BITS,_t) *) \
((h) + __BS_OFFSET(t, offset, BYTES) + \
(t)->__CONCAT(bs_offset_,BYTES)))
/*
* u_intN_t bus_space_read_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset));
*
* Read a 1, 2, 4, or 8 byte quantity from bus space
* described by tag/handle/offset.
*/
#define __bus_space_read(BYTES,BITS) \
static __inline __CONCAT3(u_int,BITS,_t) \
__CONCAT(bus_space_read_,BYTES)(bus_space_tag_t bst, \
bus_space_handle_t bsh, bus_size_t offset) \
{ \
return (*__BS_ADDR(bst, bsh, offset, BITS, BYTES)); \
}
__bus_space_read(1,8)
__bus_space_read(2,16)
__bus_space_read(4,32)
__bus_space_read(8,64)
/*
* void bus_space_read_multi_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset,
* u_intN_t *addr, size_t count));
*
* Read `count' 1, 2, 4, or 8 byte quantities from bus space
* described by tag/handle/offset and copy into buffer provided.
*/
#define __bus_space_read_multi(BYTES,BITS) \
static __inline void __BS_FUNCTION(bus_space_read_multi,BYTES) \
__P((bus_space_tag_t, bus_space_handle_t, bus_size_t, \
__BS_TYPENAME(BITS) *, size_t)); \
\
static __inline void \
__BS_FUNCTION(bus_space_read_multi,BYTES)(t, h, o, a, c) \
bus_space_tag_t t; \
bus_space_handle_t h; \
bus_size_t o; \
__BS_TYPENAME(BITS) *a; \
size_t c; \
{ \
\
while (c--) \
*a++ = __BS_FUNCTION(bus_space_read,BYTES)(t, h, o); \
}
__bus_space_read_multi(1,8)
__bus_space_read_multi(2,16)
__bus_space_read_multi(4,32)
__bus_space_read_multi(8,64)
/*
* void bus_space_read_region_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset,
* u_intN_t *addr, size_t count));
*
* Read `count' 1, 2, 4, or 8 byte quantities from bus space
* described by tag/handle and starting at `offset' and copy into
* buffer provided.
*/
#define __bus_space_read_region(BYTES,BITS) \
static __inline void __BS_FUNCTION(bus_space_read_region,BYTES) \
__P((bus_space_tag_t, bus_space_handle_t, bus_size_t, \
__BS_TYPENAME(BITS) *, size_t)); \
\
static __inline void \
__BS_FUNCTION(bus_space_read_region,BYTES)(t, h, o, a, c) \
bus_space_tag_t t; \
bus_space_handle_t h; \
bus_size_t o; \
__BS_TYPENAME(BITS) *a; \
size_t c; \
{ \
\
while (c--) { \
*a++ = __BS_FUNCTION(bus_space_read,BYTES)(t, h, o); \
o += BYTES; \
} \
}
__bus_space_read_region(1,8)
__bus_space_read_region(2,16)
__bus_space_read_region(4,32)
__bus_space_read_region(8,64)
/*
* void bus_space_write_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset,
* u_intN_t value));
*
* Write the 1, 2, 4, or 8 byte value `value' to bus space
* described by tag/handle/offset.
*/
#define __bus_space_write(BYTES,BITS) \
static __inline void \
__CONCAT(bus_space_write_,BYTES)(bus_space_tag_t bst, \
bus_space_handle_t bsh, \
bus_size_t offset, __CONCAT3(u_int,BITS,_t) data) \
{ \
*__BS_ADDR(bst, bsh, offset, BITS, BYTES) = data; \
wbflush(); \
}
__bus_space_write(1,8)
__bus_space_write(2,16)
__bus_space_write(4,32)
__bus_space_write(8,64)
/*
* void bus_space_write_multi_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset,
* const u_intN_t *addr, size_t count));
*
* Write `count' 1, 2, 4, or 8 byte quantities from the buffer
* provided to bus space described by tag/handle/offset.
*/
#define __bus_space_write_multi(BYTES,BITS) \
static __inline void __BS_FUNCTION(bus_space_write_multi,BYTES) \
__P((bus_space_tag_t, bus_space_handle_t, bus_size_t, \
__BS_TYPENAME(BITS) *, size_t)); \
\
static __inline void \
__BS_FUNCTION(bus_space_write_multi,BYTES)(t, h, o, a, c) \
bus_space_tag_t t; \
bus_space_handle_t h; \
bus_size_t o; \
__BS_TYPENAME(BITS) *a; \
size_t c; \
{ \
\
while (c--) \
__BS_FUNCTION(bus_space_write,BYTES)(t, h, o, *a++); \
}
__bus_space_write_multi(1,8)
__bus_space_write_multi(2,16)
__bus_space_write_multi(4,32)
__bus_space_write_multi(8,64)
/*
* void bus_space_write_region_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset,
* const u_intN_t *addr, size_t count));
*
* Write `count' 1, 2, 4, or 8 byte quantities from the buffer provided
* to bus space described by tag/handle starting at `offset'.
*/
#define __bus_space_write_region(BYTES,BITS) \
static __inline void __BS_FUNCTION(bus_space_write_region,BYTES) \
__P((bus_space_tag_t, bus_space_handle_t, bus_size_t, \
const __BS_TYPENAME(BITS) *, size_t)); \
\
static __inline void \
__BS_FUNCTION(bus_space_write_region,BYTES)(t, h, o, a, c) \
bus_space_tag_t t; \
bus_space_handle_t h; \
bus_size_t o; \
const __BS_TYPENAME(BITS) *a; \
size_t c; \
{ \
\
while (c--) { \
__BS_FUNCTION(bus_space_write,BYTES)(t, h, o, *a++); \
o += BYTES; \
} \
}
__bus_space_write_region(1,8)
__bus_space_write_region(2,16)
__bus_space_write_region(4,32)
__bus_space_write_region(8,64)
/*
* void bus_space_set_multi_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
* size_t count));
*
* Write the 1, 2, 4, or 8 byte value `val' to bus space described
* by tag/handle/offset `count' times.
*/
#define __bus_space_set_multi(BYTES,BITS) \
static __inline void __BS_FUNCTION(bus_space_set_multi,BYTES) \
__P((bus_space_tag_t, bus_space_handle_t, bus_size_t, \
__BS_TYPENAME(BITS), size_t)); \
\
static __inline void \
__BS_FUNCTION(bus_space_set_multi,BYTES)(t, h, o, v, c) \
bus_space_tag_t t; \
bus_space_handle_t h; \
bus_size_t o; \
__BS_TYPENAME(BITS) v; \
size_t c; \
{ \
\
while (c--) \
__BS_FUNCTION(bus_space_write,BYTES)(t, h, o, v); \
}
__bus_space_set_multi(1,8)
__bus_space_set_multi(2,16)
__bus_space_set_multi(4,32)
__bus_space_set_multi(8,64)
/*
* void bus_space_set_region_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
* size_t count));
*
* Write `count' 1, 2, 4, or 8 byte value `val' to bus space described
* by tag/handle starting at `offset'.
*/
#define __bus_space_set_region(BYTES,BITS) \
static __inline void __BS_FUNCTION(bus_space_set_region,BYTES) \
__P((bus_space_tag_t, bus_space_handle_t, bus_size_t, \
__BS_TYPENAME(BITS), size_t)); \
\
static __inline void \
__BS_FUNCTION(bus_space_set_region,BYTES)(t, h, o, v, c) \
bus_space_tag_t t; \
bus_space_handle_t h; \
bus_size_t o; \
__BS_TYPENAME(BITS) v; \
size_t c; \
{ \
\
while (c--) { \
__BS_FUNCTION(bus_space_write,BYTES)(t, h, o, v); \
o += BYTES; \
} \
}
__bus_space_set_region(1,8)
__bus_space_set_region(2,16)
__bus_space_set_region(4,32)
__bus_space_set_region(8,64)
/*
* void bus_space_copy_region_N __P((bus_space_tag_t tag,
* bus_space_handle_t bsh1, bus_size_t off1,
* bus_space_handle_t bsh2, bus_size_t off2,
* bus_size_t count));
*
* Copy `count' 1, 2, 4, or 8 byte values from bus space starting
* at tag/bsh1/off1 to bus space starting at tag/bsh2/off2.
*/
#define __bus_space_copy_region(BYTES) \
static __inline void __BS_FUNCTION(bus_space_copy_region,BYTES) \
__P((bus_space_tag_t, \
bus_space_handle_t bsh1, bus_size_t off1, \
bus_space_handle_t bsh2, bus_size_t off2, \
bus_size_t count)); \
\
static __inline void \
__BS_FUNCTION(bus_space_copy_region,BYTES)(t, h1, o1, h2, o2, c) \
bus_space_tag_t t; \
bus_space_handle_t h1, h2; \
bus_size_t o1, o2, c; \
{ \
bus_size_t o; \
\
if ((h1 + o1) >= (h2 + o2)) { \
/* src after dest: copy forward */ \
for (o = 0; c != 0; c--, o += BYTES) \
__BS_FUNCTION(bus_space_write,BYTES)(t, h2, o2 + o, \
__BS_FUNCTION(bus_space_read,BYTES)(t, h1, o1 + o)); \
} else { \
/* dest after src: copy backwards */ \
for (o = (c - 1) * BYTES; c != 0; c--, o -= BYTES) \
__BS_FUNCTION(bus_space_write,BYTES)(t, h2, o2 + o, \
__BS_FUNCTION(bus_space_read,BYTES)(t, h1, o1 + o)); \
} \
}
__bus_space_copy_region(1)
__bus_space_copy_region(2)
__bus_space_copy_region(4)
__bus_space_copy_region(8)
/*
* Operations which handle byte stream data on word access.
*
* These functions are defined to resolve endian mismatch, by either
* - When normal (i.e. stream-less) operations perform byte swap
* to resolve endian mismatch, these functions bypass the byte swap.
* or
* - When bus bridge performs automatic byte swap, these functions
* perform byte swap once more, to cancel the bridge's behavior.
*
* Mips Computer Systems platforms perform harware byte swapping -
* therefore the streaming methods can byte swap as determined from
* the bus space tag settings
*
*/
#define __BUS_SPACE_HAS_STREAM_METHODS
/* Force creation of stream methods using the standard template macros */
#undef __BS_FUNCTION
#define __BS_FUNCTION(func,BYTES) __CONCAT3(func,_stream_,BYTES)
#define __BS_BSWAP(bst, val, BITS) \
((bst->bs_bswap) ? __CONCAT(bswap,BITS)(val) : (val))
#define __bus_space_read_stream(BYTES,BITS) \
static __inline __BS_TYPENAME(BITS) \
__CONCAT(bus_space_read_stream_,BYTES)(bus_space_tag_t bst, \
bus_space_handle_t bsh, bus_size_t offset) \
{ \
register __BS_TYPENAME(BITS) val = \
__CONCAT(bus_space_read_,BYTES)(bst, bsh, offset); \
\
return __BS_BSWAP(bst, val, BITS); \
}
__bus_space_read_stream(2, 16) /* bus_space_read_stream_2 */
__bus_space_read_stream(4, 32) /* bus_space_read_stream_4 */
__bus_space_read_stream(8, 64) /* bus_space_read_stream_8 */
#define __bus_space_write_stream(BYTES,BITS) \
static __inline void \
__CONCAT(bus_space_write_stream_,BYTES)(bus_space_tag_t bst, \
bus_space_handle_t bsh, \
bus_size_t offset, __CONCAT3(u_int,BITS,_t) data) \
{ \
*__BS_ADDR(bst, bsh, offset, BITS, BYTES) = \
__BS_BSWAP(bst, data, BITS); \
wbflush(); \
}
__bus_space_write_stream(2,16) /* bus_space_write_stream_2 */
__bus_space_write_stream(4,32) /* bus_space_write_stream_4 */
__bus_space_write_stream(8,64) /* bus_space_write_stream_8 */
__bus_space_read_multi(2,16) /* bus_space_read_multi_stream_2 */
__bus_space_read_multi(4,32) /* bus_space_read_multi_stream_4 */
__bus_space_read_multi(8,64) /* bus_space_read_multi_stream_8 */
__bus_space_read_region(2,16) /* bus_space_read_region_stream_2 */
__bus_space_read_region(4,32) /* bus_space_read_region_stream_4 */
__bus_space_read_region(8,64) /* bus_space_read_region_stream_8 */
__bus_space_write_multi(2,16) /* bus_space_write_multi_stream_2 */
__bus_space_write_multi(4,32) /* bus_space_write_multi_stream_4 */
__bus_space_write_multi(8,64) /* bus_space_write_multi_stream_8 */
__bus_space_write_region(2,16) /* bus_space_write_region_stream_2 */
__bus_space_write_region(4,32) /* bus_space_write_region_stream_4 */
__bus_space_write_region(8,64) /* bus_space_write_region_stream_8 */
__bus_space_set_multi(2,16) /* bus_space_set_multi_stream_2 */
__bus_space_set_multi(4,32) /* bus_space_set_multi_stream_4 */
__bus_space_set_multi(8,64) /* bus_space_set_multi_stream_8 */
__bus_space_set_region(2,16) /* bus_space_set_region_stream_2 */
__bus_space_set_region(4,32) /* bus_space_set_region_stream_4 */
__bus_space_set_region(8, 64) /* bus_space_set_region_stream_8 */
#undef __bus_space_read
#undef __bus_space_write
#undef __bus_space_read_stream
#undef __bus_space_write_stream
#undef __bus_space_read_multi
#undef __bus_space_read_region
#undef __bus_space_write_multi
#undef __bus_space_write_region
#undef __bus_space_set_multi
#undef __bus_space_set_region
#undef __bus_space_copy_region
#undef __BS_TYPENAME
#undef __BS_OFFSET
#undef __BS_FUNCTION
#undef __BS_ADDR
/*
* Bus read/write barrier methods.
*
* void bus_space_barrier __P((bus_space_tag_t tag,
* bus_space_handle_t bsh, bus_size_t offset,
* bus_size_t len, int flags));
*
* On the MIPS, we just flush the write buffer.
*/
#define bus_space_barrier(t, h, o, l, f) \
((void)((void)(t), (void)(h), (void)(o), (void)(l), (void)(f), \
wbflush()))
#define BUS_SPACE_BARRIER_READ 0x01
#define BUS_SPACE_BARRIER_WRITE 0x02
/*
* 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 /* hint: map memory DMA coherent */
#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 */
#define MIPSCO_DMAMAP_COHERENT 0x10000 /* no cache flush necessary on sync */
/* Forwards needed by prototypes below. */
struct mbuf;
struct uio;
/*
* Operations performed by bus_dmamap_sync().
*/
#define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */
#define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */
#define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */
#define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */
typedef struct mipsco_bus_dma_tag *bus_dma_tag_t;
typedef struct mipsco_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 mipsco_bus_dma_segment {
/*
* PUBLIC MEMBERS: these are used by device drivers.
*/
bus_addr_t ds_addr; /* DMA address */
bus_size_t ds_len; /* length of transfer */
/*
* PRIVATE MEMBERS for the DMA back-end.: not for use by drivers.
*/
vaddr_t _ds_paddr; /* CPU physical address */
vaddr_t _ds_vaddr; /* virtual address, 0 if invalid */
};
typedef struct mipsco_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 mipsco_bus_dma_tag {
bus_addr_t dma_offset;
/*
* DMA mapping methods.
*/
int (*_dmamap_create) __P((bus_dma_tag_t, bus_size_t, int,
bus_size_t, bus_size_t, int, bus_dmamap_t *));
void (*_dmamap_destroy) __P((bus_dma_tag_t, bus_dmamap_t));
int (*_dmamap_load) __P((bus_dma_tag_t, bus_dmamap_t, void *,
bus_size_t, struct proc *, int));
int (*_dmamap_load_mbuf) __P((bus_dma_tag_t, bus_dmamap_t,
struct mbuf *, int));
int (*_dmamap_load_uio) __P((bus_dma_tag_t, bus_dmamap_t,
struct uio *, int));
int (*_dmamap_load_raw) __P((bus_dma_tag_t, bus_dmamap_t,
bus_dma_segment_t *, int, bus_size_t, int));
void (*_dmamap_unload) __P((bus_dma_tag_t, bus_dmamap_t));
void (*_dmamap_sync) __P((bus_dma_tag_t, bus_dmamap_t,
bus_addr_t, bus_size_t, int));
/*
* DMA memory utility functions.
*/
int (*_dmamem_alloc) __P((bus_dma_tag_t, bus_size_t, bus_size_t,
bus_size_t, bus_dma_segment_t *, int, int *, int));
void (*_dmamem_free) __P((bus_dma_tag_t,
bus_dma_segment_t *, int));
int (*_dmamem_map) __P((bus_dma_tag_t, bus_dma_segment_t *,
int, size_t, void **, int));
void (*_dmamem_unmap) __P((bus_dma_tag_t, void *, size_t));
paddr_t (*_dmamem_mmap) __P((bus_dma_tag_t, bus_dma_segment_t *,
int, off_t, int, int));
};
#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, p, o, l, ops) \
(*(t)->_dmamap_sync)((t), (p), (o), (l), (ops))
#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)
/*
* bus_dmamap_t
*
* Describes a DMA mapping.
*/
struct mipsco_bus_dmamap {
/*
* PRIVATE MEMBERS: not for use by 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_maxmaxsegsz; /* fixed largest possible segment */
bus_size_t _dm_boundary; /* don't cross this */
int _dm_flags; /* misc. flags */
/*
* Private cookie to be used by the DMA back-end.
*/
void *_dm_cookie;
/*
* PUBLIC MEMBERS: these are used by machine-independent code.
*/
bus_size_t dm_maxsegsz; /* largest possible segment */
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 */
};
#ifdef _MIPSCO_BUS_DMA_PRIVATE
int _bus_dmamap_create __P((bus_dma_tag_t, bus_size_t, int, bus_size_t,
bus_size_t, int, bus_dmamap_t *));
void _bus_dmamap_destroy __P((bus_dma_tag_t, bus_dmamap_t));
int _bus_dmamap_load __P((bus_dma_tag_t, bus_dmamap_t, void *,
bus_size_t, struct proc *, int));
int _bus_dmamap_load_mbuf __P((bus_dma_tag_t, bus_dmamap_t,
struct mbuf *, int));
int _bus_dmamap_load_uio __P((bus_dma_tag_t, bus_dmamap_t,
struct uio *, int));
int _bus_dmamap_load_raw __P((bus_dma_tag_t, bus_dmamap_t,
bus_dma_segment_t *, int, bus_size_t, int));
void _bus_dmamap_unload __P((bus_dma_tag_t, bus_dmamap_t));
void _bus_dmamap_sync __P((bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
bus_size_t, int));
int _bus_dmamem_alloc __P((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));
int _bus_dmamem_alloc_range __P((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,
paddr_t low, paddr_t high));
void _bus_dmamem_free __P((bus_dma_tag_t tag, bus_dma_segment_t *segs,
int nsegs));
int _bus_dmamem_map __P((bus_dma_tag_t tag, bus_dma_segment_t *segs,
int nsegs, size_t size, void **kvap, int flags));
void _bus_dmamem_unmap __P((bus_dma_tag_t tag, void *kva,
size_t size));
paddr_t _bus_dmamem_mmap __P((bus_dma_tag_t tag, bus_dma_segment_t *segs,
int nsegs, off_t off, int prot, int flags));
int _bus_dmamem_alloc_range __P((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,
paddr_t low, paddr_t high));
#endif /* _MIPSCO_BUS_DMA_PRIVATE */
void _bus_dma_tag_init __P((bus_dma_tag_t tag));
#endif /* _KERNEL */
#endif /* _MIPSCO_BUS_H_ */