Home | History | Annotate | Line # | Download | only in include
bus.h revision 1.6
      1  1.6   simonb /*	$NetBSD: bus.h,v 1.6 2002/03/17 21:45:08 simonb Exp $	*/
      2  1.1     onoe 
      3  1.1     onoe /*
      4  1.3  thorpej  * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
      5  1.1     onoe  * All rights reserved.
      6  1.1     onoe  *
      7  1.1     onoe  * This code is derived from software contributed to The NetBSD Foundation
      8  1.1     onoe  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
      9  1.1     onoe  * NASA Ames Research Center.
     10  1.1     onoe  *
     11  1.1     onoe  * Redistribution and use in source and binary forms, with or without
     12  1.1     onoe  * modification, are permitted provided that the following conditions
     13  1.1     onoe  * are met:
     14  1.1     onoe  * 1. Redistributions of source code must retain the above copyright
     15  1.1     onoe  *    notice, this list of conditions and the following disclaimer.
     16  1.1     onoe  * 2. Redistributions in binary form must reproduce the above copyright
     17  1.1     onoe  *    notice, this list of conditions and the following disclaimer in the
     18  1.1     onoe  *    documentation and/or other materials provided with the distribution.
     19  1.1     onoe  * 3. All advertising materials mentioning features or use of this software
     20  1.1     onoe  *    must display the following acknowledgement:
     21  1.1     onoe  *	This product includes software developed by the NetBSD
     22  1.1     onoe  *	Foundation, Inc. and its contributors.
     23  1.1     onoe  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24  1.1     onoe  *    contributors may be used to endorse or promote products derived
     25  1.1     onoe  *    from this software without specific prior written permission.
     26  1.1     onoe  *
     27  1.1     onoe  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28  1.1     onoe  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29  1.1     onoe  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30  1.1     onoe  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31  1.1     onoe  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32  1.1     onoe  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33  1.1     onoe  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34  1.1     onoe  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35  1.1     onoe  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36  1.1     onoe  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37  1.1     onoe  * POSSIBILITY OF SUCH DAMAGE.
     38  1.1     onoe  */
     39  1.1     onoe 
     40  1.1     onoe #ifndef _NEWSMIPS_BUS_H_
     41  1.1     onoe #define _NEWSMIPS_BUS_H_
     42  1.1     onoe 
     43  1.1     onoe #include <mips/locore.h>
     44  1.1     onoe 
     45  1.1     onoe /*
     46  1.1     onoe  * Utility macros; do not use outside this file.
     47  1.1     onoe  */
     48  1.1     onoe #define	__PB_TYPENAME_PREFIX(BITS)	___CONCAT(u_int,BITS)
     49  1.1     onoe #define	__PB_TYPENAME(BITS)		___CONCAT(__PB_TYPENAME_PREFIX(BITS),_t)
     50  1.1     onoe 
     51  1.1     onoe /*
     52  1.1     onoe  * Bus address and size types
     53  1.1     onoe  */
     54  1.1     onoe typedef u_long bus_addr_t;
     55  1.1     onoe typedef u_long bus_size_t;
     56  1.1     onoe 
     57  1.1     onoe /*
     58  1.1     onoe  * Access methods for bus resources and address space.
     59  1.1     onoe  */
     60  1.1     onoe typedef int	bus_space_tag_t;
     61  1.1     onoe typedef u_long	bus_space_handle_t;
     62  1.1     onoe 
     63  1.1     onoe /*
     64  1.1     onoe  *	int bus_space_map(bus_space_tag_t t, bus_addr_t addr,
     65  1.1     onoe  *	    bus_size_t size, int flags, bus_space_handle_t *bshp);
     66  1.1     onoe  *
     67  1.1     onoe  * Map a region of bus space.
     68  1.1     onoe  */
     69  1.1     onoe 
     70  1.1     onoe #define	BUS_SPACE_MAP_CACHEABLE		0x01
     71  1.1     onoe #define	BUS_SPACE_MAP_LINEAR		0x02
     72  1.1     onoe #define BUS_SPACE_MAP_PREFETCHABLE	0x04
     73  1.1     onoe 
     74  1.1     onoe int	bus_space_map(bus_space_tag_t, bus_addr_t, bus_size_t,
     75  1.1     onoe 	    int, bus_space_handle_t *);
     76  1.1     onoe 
     77  1.1     onoe /*
     78  1.1     onoe  *	void bus_space_unmap(bus_space_tag_t t,
     79  1.1     onoe  *	     bus_space_handle_t bsh, bus_size_t size);
     80  1.1     onoe  *
     81  1.1     onoe  * Unmap a region of bus space.
     82  1.1     onoe  */
     83  1.1     onoe 
     84  1.1     onoe void	bus_space_unmap (bus_space_tag_t, bus_space_handle_t, bus_size_t);
     85  1.1     onoe 
     86  1.1     onoe /*
     87  1.1     onoe  *	int bus_space_subregion(bus_space_tag_t t,
     88  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset, bus_size_t size,
     89  1.1     onoe  *	    bus_space_handle_t *nbshp);
     90  1.1     onoe  *
     91  1.1     onoe  * Get a new handle for a subregion of an already-mapped area of bus space.
     92  1.1     onoe  */
     93  1.1     onoe 
     94  1.1     onoe int	bus_space_subregion(bus_space_tag_t t, bus_space_handle_t bsh,
     95  1.1     onoe 	    bus_size_t offset, bus_size_t size, bus_space_handle_t *nbshp);
     96  1.1     onoe 
     97  1.1     onoe /*
     98  1.1     onoe  *	int bus_space_alloc(bus_space_tag_t t, bus_addr_t, rstart,
     99  1.1     onoe  *	    bus_addr_t rend, bus_size_t size, bus_size_t align,
    100  1.1     onoe  *	    bus_size_t boundary, int flags, bus_addr_t *addrp,
    101  1.1     onoe  *	    bus_space_handle_t *bshp);
    102  1.1     onoe  *
    103  1.1     onoe  * Allocate a region of bus space.
    104  1.1     onoe  */
    105  1.1     onoe 
    106  1.1     onoe int	bus_space_alloc (bus_space_tag_t t, bus_addr_t rstart,
    107  1.1     onoe 	    bus_addr_t rend, bus_size_t size, bus_size_t align,
    108  1.1     onoe 	    bus_size_t boundary, int cacheable, bus_addr_t *addrp,
    109  1.1     onoe 	    bus_space_handle_t *bshp);
    110  1.1     onoe 
    111  1.1     onoe /*
    112  1.1     onoe  *	int bus_space_free (bus_space_tag_t t,
    113  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t size);
    114  1.1     onoe  *
    115  1.1     onoe  * Free a region of bus space.
    116  1.1     onoe  */
    117  1.1     onoe 
    118  1.1     onoe void	bus_space_free(bus_space_tag_t t, bus_space_handle_t bsh,
    119  1.1     onoe 	    bus_size_t size);
    120  1.1     onoe 
    121  1.1     onoe /*
    122  1.1     onoe  *	u_intN_t bus_space_read_N(bus_space_tag_t tag,
    123  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset);
    124  1.1     onoe  *
    125  1.1     onoe  * Read a 1, 2, 4, or 8 byte quantity from bus space
    126  1.1     onoe  * described by tag/handle/offset.
    127  1.1     onoe  */
    128  1.1     onoe 
    129  1.1     onoe #define	bus_space_read_1(t, h, o)					\
    130  1.1     onoe      ((void) t, (*(volatile u_int8_t *)((h) + (o))))
    131  1.1     onoe 
    132  1.1     onoe #define	bus_space_read_2(t, h, o)					\
    133  1.1     onoe      ((void) t, (*(volatile u_int16_t *)((h) + (o))))
    134  1.1     onoe 
    135  1.1     onoe #define	bus_space_read_4(t, h, o)					\
    136  1.1     onoe      ((void) t, (*(volatile u_int32_t *)((h) + (o))))
    137  1.1     onoe 
    138  1.1     onoe #if 0	/* Cause a link error for bus_space_read_8 */
    139  1.1     onoe #define	bus_space_read_8(t, h, o)	!!! bus_space_read_8 unimplemented !!!
    140  1.1     onoe #endif
    141  1.1     onoe 
    142  1.1     onoe /*
    143  1.1     onoe  *	void bus_space_read_multi_N(bus_space_tag_t tag,
    144  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset,
    145  1.1     onoe  *	    u_intN_t *addr, size_t count);
    146  1.1     onoe  *
    147  1.1     onoe  * Read `count' 1, 2, 4, or 8 byte quantities from bus space
    148  1.1     onoe  * described by tag/handle/offset and copy into buffer provided.
    149  1.1     onoe  */
    150  1.1     onoe 
    151  1.1     onoe #define __NEWSMIPS_bus_space_read_multi(BYTES,BITS)			\
    152  1.1     onoe static __inline void __CONCAT(bus_space_read_multi_,BYTES)		\
    153  1.1     onoe 	(bus_space_tag_t, bus_space_handle_t, bus_size_t,		\
    154  1.1     onoe 	__PB_TYPENAME(BITS) *, size_t);					\
    155  1.1     onoe 									\
    156  1.1     onoe static __inline void							\
    157  1.1     onoe __CONCAT(bus_space_read_multi_,BYTES)(t, h, o, a, c)			\
    158  1.1     onoe 	bus_space_tag_t t;						\
    159  1.1     onoe 	bus_space_handle_t h;						\
    160  1.1     onoe 	bus_size_t o;							\
    161  1.1     onoe 	__PB_TYPENAME(BITS) *a;						\
    162  1.1     onoe 	size_t c;							\
    163  1.1     onoe {									\
    164  1.1     onoe 									\
    165  1.1     onoe 	while (c--)							\
    166  1.1     onoe 		*a++ = __CONCAT(bus_space_read_,BYTES)(t, h, o);	\
    167  1.1     onoe }
    168  1.1     onoe 
    169  1.1     onoe __NEWSMIPS_bus_space_read_multi(1,8)
    170  1.1     onoe __NEWSMIPS_bus_space_read_multi(2,16)
    171  1.1     onoe __NEWSMIPS_bus_space_read_multi(4,32)
    172  1.1     onoe 
    173  1.1     onoe #if 0	/* Cause a link error for bus_space_read_multi_8 */
    174  1.1     onoe #define	bus_space_read_multi_8	!!! bus_space_read_multi_8 unimplemented !!!
    175  1.1     onoe #endif
    176  1.1     onoe 
    177  1.1     onoe #undef __NEWSMIPS_bus_space_read_multi
    178  1.1     onoe 
    179  1.1     onoe /*
    180  1.1     onoe  *	void bus_space_read_region_N(bus_space_tag_t tag,
    181  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset,
    182  1.1     onoe  *	    u_intN_t *addr, size_t count);
    183  1.1     onoe  *
    184  1.1     onoe  * Read `count' 1, 2, 4, or 8 byte quantities from bus space
    185  1.1     onoe  * described by tag/handle and starting at `offset' and copy into
    186  1.1     onoe  * buffer provided.
    187  1.1     onoe  */
    188  1.1     onoe 
    189  1.1     onoe #define __NEWSMIPS_bus_space_read_region(BYTES,BITS)			\
    190  1.1     onoe static __inline void __CONCAT(bus_space_read_region_,BYTES)		\
    191  1.1     onoe 	(bus_space_tag_t, bus_space_handle_t, bus_size_t,		\
    192  1.1     onoe 	__PB_TYPENAME(BITS) *, size_t);					\
    193  1.1     onoe 									\
    194  1.1     onoe static __inline void							\
    195  1.1     onoe __CONCAT(bus_space_read_region_,BYTES)(t, h, o, a, c)			\
    196  1.1     onoe 	bus_space_tag_t t;						\
    197  1.1     onoe 	bus_space_handle_t h;						\
    198  1.1     onoe 	bus_size_t o;							\
    199  1.1     onoe 	__PB_TYPENAME(BITS) *a;						\
    200  1.1     onoe 	size_t c;							\
    201  1.1     onoe {									\
    202  1.1     onoe 									\
    203  1.1     onoe 	while (c--) {							\
    204  1.1     onoe 		*a++ = __CONCAT(bus_space_read_,BYTES)(t, h, o);	\
    205  1.1     onoe 		o += BYTES;						\
    206  1.1     onoe 	}								\
    207  1.1     onoe }
    208  1.1     onoe 
    209  1.1     onoe __NEWSMIPS_bus_space_read_region(1,8)
    210  1.1     onoe __NEWSMIPS_bus_space_read_region(2,16)
    211  1.1     onoe __NEWSMIPS_bus_space_read_region(4,32)
    212  1.1     onoe 
    213  1.1     onoe #if 0	/* Cause a link error for bus_space_read_region_8 */
    214  1.1     onoe #define	bus_space_read_region_8	!!! bus_space_read_region_8 unimplemented !!!
    215  1.1     onoe #endif
    216  1.1     onoe 
    217  1.1     onoe #undef __NEWSMIPS_bus_space_read_region
    218  1.1     onoe 
    219  1.1     onoe /*
    220  1.1     onoe  *	void bus_space_write_N(bus_space_tag_t tag,
    221  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset,
    222  1.1     onoe  *	    u_intN_t value);
    223  1.1     onoe  *
    224  1.1     onoe  * Write the 1, 2, 4, or 8 byte value `value' to bus space
    225  1.1     onoe  * described by tag/handle/offset.
    226  1.1     onoe  */
    227  1.1     onoe 
    228  1.1     onoe #define	bus_space_write_1(t, h, o, v)					\
    229  1.1     onoe do {									\
    230  1.1     onoe 	(void) t;							\
    231  1.1     onoe 	*(volatile u_int8_t *)((h) + (o)) = (v);			\
    232  1.1     onoe } while (0)
    233  1.1     onoe 
    234  1.1     onoe #define	bus_space_write_2(t, h, o, v)					\
    235  1.1     onoe do {									\
    236  1.1     onoe 	(void) t;							\
    237  1.1     onoe 	*(volatile u_int16_t *)((h) + (o)) = (v);			\
    238  1.1     onoe } while (0)
    239  1.1     onoe 
    240  1.1     onoe #define	bus_space_write_4(t, h, o, v)					\
    241  1.1     onoe do {									\
    242  1.1     onoe 	(void) t;							\
    243  1.1     onoe 	*(volatile u_int32_t *)((h) + (o)) = (v);			\
    244  1.1     onoe } while (0)
    245  1.1     onoe 
    246  1.1     onoe #if 0	/* Cause a link error for bus_space_write_8 */
    247  1.1     onoe #define	bus_space_write_8	!!! bus_space_write_8 not implemented !!!
    248  1.1     onoe #endif
    249  1.1     onoe 
    250  1.1     onoe /*
    251  1.1     onoe  *	void bus_space_write_multi_N(bus_space_tag_t tag,
    252  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset,
    253  1.1     onoe  *	    const u_intN_t *addr, size_t count);
    254  1.1     onoe  *
    255  1.1     onoe  * Write `count' 1, 2, 4, or 8 byte quantities from the buffer
    256  1.1     onoe  * provided to bus space described by tag/handle/offset.
    257  1.1     onoe  */
    258  1.1     onoe 
    259  1.1     onoe #define __NEWSMIPS_bus_space_write_multi(BYTES,BITS)			\
    260  1.1     onoe static __inline void __CONCAT(bus_space_write_multi_,BYTES)		\
    261  1.1     onoe 	(bus_space_tag_t, bus_space_handle_t, bus_size_t,		\
    262  1.1     onoe 	const __PB_TYPENAME(BITS) *, size_t);				\
    263  1.1     onoe 									\
    264  1.1     onoe static __inline void							\
    265  1.1     onoe __CONCAT(bus_space_write_multi_,BYTES)(t, h, o, a, c)			\
    266  1.1     onoe 	bus_space_tag_t t;						\
    267  1.1     onoe 	bus_space_handle_t h;						\
    268  1.1     onoe 	bus_size_t o;							\
    269  1.1     onoe 	const __PB_TYPENAME(BITS) *a;					\
    270  1.1     onoe 	size_t c;							\
    271  1.1     onoe {									\
    272  1.1     onoe 									\
    273  1.1     onoe 	while (c--)							\
    274  1.1     onoe 		__CONCAT(bus_space_write_,BYTES)(t, h, o, *a++);	\
    275  1.1     onoe }
    276  1.1     onoe 
    277  1.1     onoe __NEWSMIPS_bus_space_write_multi(1,8)
    278  1.1     onoe __NEWSMIPS_bus_space_write_multi(2,16)
    279  1.1     onoe __NEWSMIPS_bus_space_write_multi(4,32)
    280  1.1     onoe 
    281  1.1     onoe #if 0	/* Cause a link error for bus_space_write_8 */
    282  1.1     onoe #define	bus_space_write_multi_8(t, h, o, a, c)				\
    283  1.1     onoe 			!!! bus_space_write_multi_8 unimplimented !!!
    284  1.1     onoe #endif
    285  1.1     onoe 
    286  1.1     onoe #undef __NEWSMIPS_bus_space_write_multi
    287  1.1     onoe 
    288  1.1     onoe /*
    289  1.1     onoe  *	void bus_space_write_region_N(bus_space_tag_t tag,
    290  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset,
    291  1.1     onoe  *	    const u_intN_t *addr, size_t count);
    292  1.1     onoe  *
    293  1.1     onoe  * Write `count' 1, 2, 4, or 8 byte quantities from the buffer provided
    294  1.1     onoe  * to bus space described by tag/handle starting at `offset'.
    295  1.1     onoe  */
    296  1.1     onoe 
    297  1.1     onoe #define __NEWSMIPS_bus_space_write_region(BYTES,BITS)			\
    298  1.1     onoe static __inline void __CONCAT(bus_space_write_region_,BYTES)		\
    299  1.1     onoe 	(bus_space_tag_t, bus_space_handle_t, bus_size_t,		\
    300  1.1     onoe 	const __PB_TYPENAME(BITS) *, size_t);				\
    301  1.1     onoe 									\
    302  1.1     onoe static __inline void							\
    303  1.1     onoe __CONCAT(bus_space_write_region_,BYTES)(t, h, o, a, c)			\
    304  1.1     onoe 	bus_space_tag_t t;						\
    305  1.1     onoe 	bus_space_handle_t h;						\
    306  1.1     onoe 	bus_size_t o;							\
    307  1.1     onoe 	const __PB_TYPENAME(BITS) *a;					\
    308  1.1     onoe 	size_t c;							\
    309  1.1     onoe {									\
    310  1.1     onoe 									\
    311  1.1     onoe 	while (c--) {							\
    312  1.1     onoe 		__CONCAT(bus_space_write_,BYTES)(t, h, o, *a++);	\
    313  1.1     onoe 		o += BYTES;						\
    314  1.1     onoe 	}								\
    315  1.1     onoe }
    316  1.1     onoe 
    317  1.1     onoe __NEWSMIPS_bus_space_write_region(1,8)
    318  1.1     onoe __NEWSMIPS_bus_space_write_region(2,16)
    319  1.1     onoe __NEWSMIPS_bus_space_write_region(4,32)
    320  1.1     onoe 
    321  1.1     onoe #if 0	/* Cause a link error for bus_space_write_region_8 */
    322  1.1     onoe #define	bus_space_write_region_8					\
    323  1.1     onoe 			!!! bus_space_write_region_8 unimplemented !!!
    324  1.1     onoe #endif
    325  1.1     onoe 
    326  1.1     onoe #undef __NEWSMIPS_bus_space_write_region
    327  1.1     onoe 
    328  1.1     onoe /*
    329  1.1     onoe  *	void bus_space_set_multi_N(bus_space_tag_t tag,
    330  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
    331  1.1     onoe  *	    size_t count);
    332  1.1     onoe  *
    333  1.1     onoe  * Write the 1, 2, 4, or 8 byte value `val' to bus space described
    334  1.1     onoe  * by tag/handle/offset `count' times.
    335  1.1     onoe  */
    336  1.1     onoe 
    337  1.1     onoe #define __NEWSMIPS_bus_space_set_multi(BYTES,BITS)			\
    338  1.1     onoe static __inline void __CONCAT(bus_space_set_multi_,BYTES)		\
    339  1.1     onoe 	(bus_space_tag_t, bus_space_handle_t, bus_size_t,		\
    340  1.1     onoe 	__PB_TYPENAME(BITS), size_t);					\
    341  1.1     onoe 									\
    342  1.1     onoe static __inline void							\
    343  1.1     onoe __CONCAT(bus_space_set_multi_,BYTES)(t, h, o, v, c)			\
    344  1.1     onoe 	bus_space_tag_t t;						\
    345  1.1     onoe 	bus_space_handle_t h;						\
    346  1.1     onoe 	bus_size_t o;							\
    347  1.1     onoe 	__PB_TYPENAME(BITS) v;						\
    348  1.1     onoe 	size_t c;							\
    349  1.1     onoe {									\
    350  1.1     onoe 									\
    351  1.1     onoe 	while (c--)							\
    352  1.1     onoe 		__CONCAT(bus_space_write_,BYTES)(t, h, o, v);		\
    353  1.1     onoe }
    354  1.1     onoe 
    355  1.1     onoe __NEWSMIPS_bus_space_set_multi(1,8)
    356  1.1     onoe __NEWSMIPS_bus_space_set_multi(2,16)
    357  1.1     onoe __NEWSMIPS_bus_space_set_multi(4,32)
    358  1.1     onoe 
    359  1.1     onoe #if 0	/* Cause a link error for bus_space_set_multi_8 */
    360  1.1     onoe #define	bus_space_set_multi_8						\
    361  1.1     onoe 			!!! bus_space_set_multi_8 unimplemented !!!
    362  1.1     onoe #endif
    363  1.1     onoe 
    364  1.1     onoe #undef __NEWSMIPS_bus_space_set_multi
    365  1.1     onoe 
    366  1.1     onoe /*
    367  1.1     onoe  *	void bus_space_set_region_N(bus_space_tag_t tag,
    368  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
    369  1.1     onoe  *	    size_t count);
    370  1.1     onoe  *
    371  1.1     onoe  * Write `count' 1, 2, 4, or 8 byte value `val' to bus space described
    372  1.1     onoe  * by tag/handle starting at `offset'.
    373  1.1     onoe  */
    374  1.1     onoe 
    375  1.1     onoe #define __NEWSMIPS_bus_space_set_region(BYTES,BITS)			\
    376  1.1     onoe static __inline void __CONCAT(bus_space_set_region_,BYTES)		\
    377  1.1     onoe 	(bus_space_tag_t, bus_space_handle_t, bus_size_t,		\
    378  1.1     onoe 	__PB_TYPENAME(BITS), size_t);					\
    379  1.1     onoe 									\
    380  1.1     onoe static __inline void							\
    381  1.1     onoe __CONCAT(bus_space_set_region_,BYTES)(t, h, o, v, c)			\
    382  1.1     onoe 	bus_space_tag_t t;						\
    383  1.1     onoe 	bus_space_handle_t h;						\
    384  1.1     onoe 	bus_size_t o;							\
    385  1.1     onoe 	__PB_TYPENAME(BITS) v;						\
    386  1.1     onoe 	size_t c;							\
    387  1.1     onoe {									\
    388  1.1     onoe 									\
    389  1.1     onoe 	while (c--) {							\
    390  1.1     onoe 		__CONCAT(bus_space_write_,BYTES)(t, h, o, v);		\
    391  1.1     onoe 		o += BYTES;						\
    392  1.1     onoe 	}								\
    393  1.1     onoe }
    394  1.1     onoe 
    395  1.1     onoe __NEWSMIPS_bus_space_set_region(1,8)
    396  1.1     onoe __NEWSMIPS_bus_space_set_region(2,16)
    397  1.1     onoe __NEWSMIPS_bus_space_set_region(4,32)
    398  1.1     onoe 
    399  1.1     onoe #if 0	/* Cause a link error for bus_space_set_region_8 */
    400  1.1     onoe #define	bus_space_set_region_8						\
    401  1.1     onoe 			!!! bus_space_set_region_8 unimplemented !!!
    402  1.1     onoe #endif
    403  1.1     onoe 
    404  1.1     onoe #undef __NEWSMIPS_bus_space_set_region
    405  1.1     onoe 
    406  1.1     onoe /*
    407  1.1     onoe  *	void bus_space_copy_region_N(bus_space_tag_t tag,
    408  1.1     onoe  *	    bus_space_handle_t bsh1, bus_size_t off1,
    409  1.1     onoe  *	    bus_space_handle_t bsh2, bus_size_t off2,
    410  1.1     onoe  *	    bus_size_t count);
    411  1.1     onoe  *
    412  1.1     onoe  * Copy `count' 1, 2, 4, or 8 byte values from bus space starting
    413  1.1     onoe  * at tag/bsh1/off1 to bus space starting at tag/bsh2/off2.
    414  1.1     onoe  */
    415  1.1     onoe 
    416  1.1     onoe #define	__NEWSMIPS_copy_region(BYTES)					\
    417  1.1     onoe static __inline void __CONCAT(bus_space_copy_region_,BYTES)		\
    418  1.1     onoe 	(bus_space_tag_t,						\
    419  1.1     onoe 	    bus_space_handle_t bsh1, bus_size_t off1,			\
    420  1.1     onoe 	    bus_space_handle_t bsh2, bus_size_t off2,			\
    421  1.1     onoe 	    bus_size_t count);						\
    422  1.1     onoe 									\
    423  1.1     onoe static __inline void							\
    424  1.1     onoe __CONCAT(bus_space_copy_region_,BYTES)(t, h1, o1, h2, o2, c)		\
    425  1.1     onoe 	bus_space_tag_t t;						\
    426  1.1     onoe 	bus_space_handle_t h1, h2;					\
    427  1.1     onoe 	bus_size_t o1, o2, c;						\
    428  1.1     onoe {									\
    429  1.1     onoe 	bus_size_t o;							\
    430  1.1     onoe 									\
    431  1.1     onoe 	if ((h1 + o1) >= (h2 + o2)) {					\
    432  1.1     onoe 		/* src after dest: copy forward */			\
    433  1.1     onoe 		for (o = 0; c != 0; c--, o += BYTES)			\
    434  1.1     onoe 			__CONCAT(bus_space_write_,BYTES)(t, h2, o2 + o,	\
    435  1.1     onoe 			    __CONCAT(bus_space_read_,BYTES)(t, h1, o1 + o)); \
    436  1.1     onoe 	} else {							\
    437  1.1     onoe 		/* dest after src: copy backwards */			\
    438  1.1     onoe 		for (o = (c - 1) * BYTES; c != 0; c--, o -= BYTES)	\
    439  1.1     onoe 			__CONCAT(bus_space_write_,BYTES)(t, h2, o2 + o,	\
    440  1.1     onoe 			    __CONCAT(bus_space_read_,BYTES)(t, h1, o1 + o)); \
    441  1.1     onoe 	}								\
    442  1.1     onoe }
    443  1.1     onoe 
    444  1.1     onoe __NEWSMIPS_copy_region(1)
    445  1.1     onoe __NEWSMIPS_copy_region(2)
    446  1.1     onoe __NEWSMIPS_copy_region(4)
    447  1.1     onoe 
    448  1.1     onoe #if 0	/* Cause a link error for bus_space_copy_region_8 */
    449  1.1     onoe #define	bus_space_copy_region_8						\
    450  1.1     onoe 			!!! bus_space_copy_region_8 unimplemented !!!
    451  1.1     onoe #endif
    452  1.1     onoe 
    453  1.1     onoe #undef __NEWSMIPS_copy_region
    454  1.1     onoe 
    455  1.1     onoe /*
    456  1.1     onoe  * Bus read/write barrier methods.
    457  1.1     onoe  *
    458  1.1     onoe  *	void bus_space_barrier(bus_space_tag_t tag,
    459  1.1     onoe  *	    bus_space_handle_t bsh, bus_size_t offset,
    460  1.1     onoe  *	    bus_size_t len, int flags);
    461  1.1     onoe  *
    462  1.1     onoe  * On the MIPS, we just flush the write buffer.
    463  1.1     onoe  */
    464  1.1     onoe #define	bus_space_barrier(t, h, o, l, f)	\
    465  1.1     onoe 	((void)((void)(t), (void)(h), (void)(o), (void)(l), (void)(f)),	\
    466  1.1     onoe 	 wbflush())
    467  1.1     onoe #define	BUS_SPACE_BARRIER_READ	0x01		/* force read barrier */
    468  1.1     onoe #define	BUS_SPACE_BARRIER_WRITE	0x02		/* force write barrier */
    469  1.1     onoe 
    470  1.1     onoe #undef __PB_TYPENAME_PREFIX
    471  1.1     onoe #undef __PB_TYPENAME
    472  1.1     onoe 
    473  1.1     onoe #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
    474  1.1     onoe 
    475  1.1     onoe /*
    476  1.1     onoe  * Flags used in various bus DMA methods.
    477  1.1     onoe  */
    478  1.4  thorpej #define	BUS_DMA_WAITOK		0x000	/* safe to sleep (pseudo-flag) */
    479  1.4  thorpej #define	BUS_DMA_NOWAIT		0x001	/* not safe to sleep */
    480  1.4  thorpej #define	BUS_DMA_ALLOCNOW	0x002	/* perform resource allocation now */
    481  1.4  thorpej #define	BUS_DMA_COHERENT	0x004	/* hint: map memory DMA coherent */
    482  1.4  thorpej #define	BUS_DMA_STREAMING	0x008	/* hint: sequential, unidirectional */
    483  1.4  thorpej #define	BUS_DMA_BUS1		0x010	/* placeholders for bus functions... */
    484  1.4  thorpej #define	BUS_DMA_BUS2		0x020
    485  1.4  thorpej #define	BUS_DMA_BUS3		0x040
    486  1.4  thorpej #define	BUS_DMA_BUS4		0x080
    487  1.4  thorpej #define	BUS_DMA_READ		0x100	/* mapping is device -> memory only */
    488  1.4  thorpej #define	BUS_DMA_WRITE		0x200	/* mapping is memory -> device only */
    489  1.1     onoe 
    490  1.6   simonb #define	NEWSMIPS_DMAMAP_COHERENT 0x10000 /* no cache flush necessary on sync */
    491  1.6   simonb #define	NEWSMIPS_DMAMAP_MAPTBL	0x20000	/* use DMA maping table */
    492  1.1     onoe 
    493  1.1     onoe /* Forwards needed by prototypes below. */
    494  1.1     onoe struct mbuf;
    495  1.1     onoe struct uio;
    496  1.1     onoe 
    497  1.1     onoe /*
    498  1.1     onoe  * Operations performed by bus_dmamap_sync().
    499  1.1     onoe  */
    500  1.1     onoe #define	BUS_DMASYNC_PREREAD	0x01	/* pre-read synchronization */
    501  1.1     onoe #define	BUS_DMASYNC_POSTREAD	0x02	/* post-read synchronization */
    502  1.1     onoe #define	BUS_DMASYNC_PREWRITE	0x04	/* pre-write synchronization */
    503  1.1     onoe #define	BUS_DMASYNC_POSTWRITE	0x08	/* post-write synchronization */
    504  1.1     onoe 
    505  1.1     onoe typedef struct newsmips_bus_dma_tag		*bus_dma_tag_t;
    506  1.1     onoe typedef struct newsmips_bus_dmamap		*bus_dmamap_t;
    507  1.1     onoe 
    508  1.1     onoe /*
    509  1.1     onoe  *	bus_dma_segment_t
    510  1.1     onoe  *
    511  1.1     onoe  *	Describes a single contiguous DMA transaction.  Values
    512  1.1     onoe  *	are suitable for programming into DMA registers.
    513  1.1     onoe  */
    514  1.1     onoe struct newsmips_bus_dma_segment {
    515  1.1     onoe 	bus_addr_t	ds_addr;	/* DMA address */
    516  1.1     onoe 	bus_size_t	ds_len;		/* length of transfer */
    517  1.1     onoe 	bus_addr_t	_ds_vaddr;	/* virtual address, 0 if invalid */
    518  1.1     onoe };
    519  1.1     onoe typedef struct newsmips_bus_dma_segment	bus_dma_segment_t;
    520  1.1     onoe 
    521  1.1     onoe /*
    522  1.1     onoe  *	bus_dma_tag_t
    523  1.1     onoe  *
    524  1.1     onoe  *	A machine-dependent opaque type describing the implementation of
    525  1.1     onoe  *	DMA for a given bus.
    526  1.1     onoe  */
    527  1.1     onoe 
    528  1.1     onoe struct newsmips_bus_dma_tag {
    529  1.1     onoe 	/*
    530  1.1     onoe 	 * DMA mapping methods.
    531  1.1     onoe 	 */
    532  1.1     onoe 	int	(*_dmamap_create)(bus_dma_tag_t, bus_size_t, int,
    533  1.1     onoe 		    bus_size_t, bus_size_t, int, bus_dmamap_t *);
    534  1.1     onoe 	void	(*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t);
    535  1.1     onoe 	int	(*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *,
    536  1.1     onoe 		    bus_size_t, struct proc *, int);
    537  1.1     onoe 	int	(*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t,
    538  1.1     onoe 		    struct mbuf *, int);
    539  1.1     onoe 	int	(*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t,
    540  1.1     onoe 		    struct uio *, int);
    541  1.1     onoe 	int	(*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t,
    542  1.1     onoe 		    bus_dma_segment_t *, int, bus_size_t, int);
    543  1.1     onoe 	void	(*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t);
    544  1.1     onoe 	void	(*_dmamap_sync)(bus_dma_tag_t, bus_dmamap_t,
    545  1.1     onoe 		    bus_addr_t, bus_size_t, int);
    546  1.1     onoe 
    547  1.1     onoe 	/*
    548  1.1     onoe 	 * DMA memory utility functions.
    549  1.1     onoe 	 */
    550  1.1     onoe 	int	(*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
    551  1.1     onoe 		    bus_size_t, bus_dma_segment_t *, int, int *, int);
    552  1.1     onoe 	void	(*_dmamem_free)(bus_dma_tag_t,
    553  1.1     onoe 		    bus_dma_segment_t *, int);
    554  1.1     onoe 	int	(*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
    555  1.1     onoe 		    int, size_t, caddr_t *, int);
    556  1.1     onoe 	void	(*_dmamem_unmap)(bus_dma_tag_t, caddr_t, size_t);
    557  1.1     onoe 	paddr_t	(*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
    558  1.1     onoe 		    int, off_t, int, int);
    559  1.1     onoe 
    560  1.1     onoe 	/*
    561  1.1     onoe 	 * NEWSMIPS quirks.
    562  1.1     onoe 	 * This is NOT a constant.  Slot dependent information is
    563  1.1     onoe 	 * required to flush DMA cache correctly.
    564  1.1     onoe 	 */
    565  1.1     onoe 	int	_slotno;
    566  1.1     onoe 	bus_space_tag_t	_slotbaset;
    567  1.1     onoe 	bus_space_handle_t _slotbaseh;
    568  1.1     onoe };
    569  1.1     onoe 
    570  1.1     onoe #define	bus_dmamap_create(t, s, n, m, b, f, p)			\
    571  1.1     onoe 	(*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p))
    572  1.1     onoe #define	bus_dmamap_destroy(t, p)				\
    573  1.1     onoe 	(*(t)->_dmamap_destroy)((t), (p))
    574  1.1     onoe #define	bus_dmamap_load(t, m, b, s, p, f)			\
    575  1.1     onoe 	(*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f))
    576  1.1     onoe #define	bus_dmamap_load_mbuf(t, m, b, f)			\
    577  1.1     onoe 	(*(t)->_dmamap_load_mbuf)((t), (m), (b), (f))
    578  1.1     onoe #define	bus_dmamap_load_uio(t, m, u, f)				\
    579  1.1     onoe 	(*(t)->_dmamap_load_uio)((t), (m), (u), (f))
    580  1.1     onoe #define	bus_dmamap_load_raw(t, m, sg, n, s, f)			\
    581  1.1     onoe 	(*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f))
    582  1.1     onoe #define	bus_dmamap_unload(t, p)					\
    583  1.1     onoe 	(*(t)->_dmamap_unload)((t), (p))
    584  1.1     onoe #define	bus_dmamap_sync(t, p, o, l, ops)			\
    585  1.1     onoe 	(*(t)->_dmamap_sync)((t), (p), (o), (l), (ops))
    586  1.1     onoe 
    587  1.1     onoe #define	bus_dmamem_alloc(t, s, a, b, sg, n, r, f)		\
    588  1.1     onoe 	(*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f))
    589  1.1     onoe #define	bus_dmamem_free(t, sg, n)				\
    590  1.1     onoe 	(*(t)->_dmamem_free)((t), (sg), (n))
    591  1.1     onoe #define	bus_dmamem_map(t, sg, n, s, k, f)			\
    592  1.1     onoe 	(*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f))
    593  1.1     onoe #define	bus_dmamem_unmap(t, k, s)				\
    594  1.1     onoe 	(*(t)->_dmamem_unmap)((t), (k), (s))
    595  1.1     onoe #define	bus_dmamem_mmap(t, sg, n, o, p, f)			\
    596  1.1     onoe 	(*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f))
    597  1.1     onoe 
    598  1.1     onoe /*
    599  1.1     onoe  *	bus_dmamap_t
    600  1.1     onoe  *
    601  1.1     onoe  *	Describes a DMA mapping.
    602  1.1     onoe  */
    603  1.1     onoe struct newsmips_bus_dmamap {
    604  1.1     onoe 	/*
    605  1.1     onoe 	 * PRIVATE MEMBERS: not for use my machine-independent code.
    606  1.1     onoe 	 */
    607  1.1     onoe 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
    608  1.1     onoe 	int		_dm_segcnt;	/* number of segs this map can map */
    609  1.1     onoe 	bus_size_t	_dm_maxsegsz;	/* largest possible segment */
    610  1.1     onoe 	bus_size_t	_dm_boundary;	/* don't cross this */
    611  1.1     onoe 	int		_dm_flags;	/* misc. flags */
    612  1.2     onoe 	int		_dm_maptbl;	/* DMA mapping table index */
    613  1.2     onoe 	int		_dm_maptblcnt;	/* number of DMA mapping table */
    614  1.5  thorpej 	struct proc	*_dm_proc;	/* proc that owns the mapping */
    615  1.1     onoe 
    616  1.1     onoe 	/*
    617  1.1     onoe 	 * PUBLIC MEMBERS: these are used by machine-independent code.
    618  1.1     onoe 	 */
    619  1.1     onoe 	bus_size_t	dm_mapsize;	/* size of the mapping */
    620  1.1     onoe 	int		dm_nsegs;	/* # valid segments in mapping */
    621  1.1     onoe 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
    622  1.1     onoe };
    623  1.1     onoe 
    624  1.1     onoe #ifdef _NEWSMIPS_BUS_DMA_PRIVATE
    625  1.5  thorpej void	newsmips_bus_dma_init(void);
    626  1.5  thorpej 
    627  1.1     onoe int	_bus_dmamap_create(bus_dma_tag_t, bus_size_t, int, bus_size_t,
    628  1.1     onoe 	    bus_size_t, int, bus_dmamap_t *);
    629  1.1     onoe void	_bus_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
    630  1.1     onoe int	_bus_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *,
    631  1.1     onoe 	    bus_size_t, struct proc *, int);
    632  1.1     onoe int	_bus_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t,
    633  1.1     onoe 	    struct mbuf *, int);
    634  1.1     onoe int	_bus_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t,
    635  1.1     onoe 	    struct uio *, int);
    636  1.1     onoe int	_bus_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t,
    637  1.1     onoe 	    bus_dma_segment_t *, int, bus_size_t, int);
    638  1.1     onoe void	_bus_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
    639  1.5  thorpej void	_bus_dmamap_sync_r3k(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
    640  1.5  thorpej 	    bus_size_t, int);
    641  1.5  thorpej void	_bus_dmamap_sync_r4k(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
    642  1.1     onoe 	    bus_size_t, int);
    643  1.1     onoe 
    644  1.1     onoe int	_bus_dmamem_alloc(bus_dma_tag_t tag, bus_size_t size,
    645  1.1     onoe 	    bus_size_t alignment, bus_size_t boundary,
    646  1.1     onoe 	    bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags);
    647  1.1     onoe void	_bus_dmamem_free(bus_dma_tag_t tag, bus_dma_segment_t *segs,
    648  1.1     onoe 	    int nsegs);
    649  1.1     onoe int	_bus_dmamem_map(bus_dma_tag_t tag, bus_dma_segment_t *segs,
    650  1.1     onoe 	    int nsegs, size_t size, caddr_t *kvap, int flags);
    651  1.1     onoe void	_bus_dmamem_unmap(bus_dma_tag_t tag, caddr_t kva,
    652  1.1     onoe 	    size_t size);
    653  1.1     onoe paddr_t	_bus_dmamem_mmap(bus_dma_tag_t tag, bus_dma_segment_t *segs,
    654  1.1     onoe 	    int nsegs, off_t off, int prot, int flags);
    655  1.1     onoe 
    656  1.1     onoe int	_bus_dmamem_alloc_range(bus_dma_tag_t tag, bus_size_t size,
    657  1.1     onoe 	    bus_size_t alignment, bus_size_t boundary,
    658  1.1     onoe 	    bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags,
    659  1.1     onoe 	    vaddr_t low, vaddr_t high);
    660  1.1     onoe 
    661  1.1     onoe extern struct newsmips_bus_dma_tag newsmips_default_bus_dma_tag;
    662  1.1     onoe #endif /* _NEWSMIPS_BUS_DMA_PRIVATE */
    663  1.1     onoe 
    664  1.1     onoe #endif /* _NEWSMIPS_BUS_H_ */
    665