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