xref: /openbsd-src/sys/arch/loongson/include/bus.h (revision 30c4e479f31e146a25569b6eda3b7bfaba926995)
1*30c4e479Skettenis /*	$OpenBSD: bus.h,v 1.8 2020/04/14 17:35:28 kettenis Exp $	*/
204a21b5dSmiod 
304a21b5dSmiod /*
404a21b5dSmiod  * Copyright (c) 2003-2004 Opsycon AB Sweden.  All rights reserved.
504a21b5dSmiod  *
604a21b5dSmiod  * Redistribution and use in source and binary forms, with or without
704a21b5dSmiod  * modification, are permitted provided that the following conditions
804a21b5dSmiod  * are met:
904a21b5dSmiod  * 1. Redistributions of source code must retain the above copyright
1004a21b5dSmiod  *    notice, this list of conditions and the following disclaimer.
1104a21b5dSmiod  * 2. Redistributions in binary form must reproduce the above copyright
1204a21b5dSmiod  *    notice, this list of conditions and the following disclaimer in the
1304a21b5dSmiod  *    documentation and/or other materials provided with the distribution.
1404a21b5dSmiod  *
1504a21b5dSmiod  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1604a21b5dSmiod  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1704a21b5dSmiod  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1804a21b5dSmiod  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1904a21b5dSmiod  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2004a21b5dSmiod  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2104a21b5dSmiod  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2204a21b5dSmiod  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2304a21b5dSmiod  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2404a21b5dSmiod  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2504a21b5dSmiod  */
2604a21b5dSmiod 
2704a21b5dSmiod #ifndef _MACHINE_BUS_H_
2804a21b5dSmiod #define _MACHINE_BUS_H_
2904a21b5dSmiod 
3004a21b5dSmiod #ifdef __STDC__
3104a21b5dSmiod #define CAT(a,b)	a##b
3204a21b5dSmiod #define CAT3(a,b,c)	a##b##c
3304a21b5dSmiod #else
3404a21b5dSmiod #define CAT(a,b)	a/**/b
3504a21b5dSmiod #define CAT3(a,b,c)	a/**/b/**/c
3604a21b5dSmiod #endif
3704a21b5dSmiod 
3804a21b5dSmiod /*
3904a21b5dSmiod  * Bus access types.
4004a21b5dSmiod  */
4104a21b5dSmiod struct mips_bus_space;
4204a21b5dSmiod typedef u_long bus_addr_t;
4304a21b5dSmiod typedef u_long bus_size_t;
4404a21b5dSmiod typedef u_long bus_space_handle_t;
4504a21b5dSmiod typedef struct mips_bus_space *bus_space_tag_t;
4604a21b5dSmiod 
4704a21b5dSmiod struct mips_bus_space {
4804a21b5dSmiod 	bus_addr_t	bus_base;
4904a21b5dSmiod 	void		*bus_private;
5004a21b5dSmiod 	u_int8_t	(*_space_read_1)(bus_space_tag_t , bus_space_handle_t,
5104a21b5dSmiod 			  bus_size_t);
5204a21b5dSmiod 	void		(*_space_write_1)(bus_space_tag_t , bus_space_handle_t,
5304a21b5dSmiod 			  bus_size_t, u_int8_t);
5404a21b5dSmiod 	u_int16_t	(*_space_read_2)(bus_space_tag_t , bus_space_handle_t,
5504a21b5dSmiod 			  bus_size_t);
5604a21b5dSmiod 	void		(*_space_write_2)(bus_space_tag_t , bus_space_handle_t,
5704a21b5dSmiod 			  bus_size_t, u_int16_t);
5804a21b5dSmiod 	u_int32_t	(*_space_read_4)(bus_space_tag_t , bus_space_handle_t,
5904a21b5dSmiod 			  bus_size_t);
6004a21b5dSmiod 	void		(*_space_write_4)(bus_space_tag_t , bus_space_handle_t,
6104a21b5dSmiod 			  bus_size_t, u_int32_t);
6204a21b5dSmiod 	u_int64_t	(*_space_read_8)(bus_space_tag_t , bus_space_handle_t,
6304a21b5dSmiod 			  bus_size_t);
6404a21b5dSmiod 	void		(*_space_write_8)(bus_space_tag_t , bus_space_handle_t,
6504a21b5dSmiod 			  bus_size_t, u_int64_t);
6604a21b5dSmiod 	void		(*_space_read_raw_2)(bus_space_tag_t, bus_space_handle_t,
6704a21b5dSmiod 			  bus_addr_t, u_int8_t *, bus_size_t);
6804a21b5dSmiod 	void		(*_space_write_raw_2)(bus_space_tag_t, bus_space_handle_t,
6904a21b5dSmiod 			  bus_addr_t, const u_int8_t *, bus_size_t);
7004a21b5dSmiod 	void		(*_space_read_raw_4)(bus_space_tag_t, bus_space_handle_t,
7104a21b5dSmiod 			  bus_addr_t, u_int8_t *, bus_size_t);
7204a21b5dSmiod 	void		(*_space_write_raw_4)(bus_space_tag_t, bus_space_handle_t,
7304a21b5dSmiod 			  bus_addr_t, const u_int8_t *, bus_size_t);
7404a21b5dSmiod 	void		(*_space_read_raw_8)(bus_space_tag_t, bus_space_handle_t,
7504a21b5dSmiod 			  bus_addr_t, u_int8_t *, bus_size_t);
7604a21b5dSmiod 	void		(*_space_write_raw_8)(bus_space_tag_t, bus_space_handle_t,
7704a21b5dSmiod 			  bus_addr_t, const u_int8_t *, bus_size_t);
7804a21b5dSmiod 	int		(*_space_map)(bus_space_tag_t , bus_addr_t,
7904a21b5dSmiod 			  bus_size_t, int, bus_space_handle_t *);
8004a21b5dSmiod 	void		(*_space_unmap)(bus_space_tag_t, bus_space_handle_t,
8104a21b5dSmiod 			  bus_size_t);
8204a21b5dSmiod 	int		(*_space_subregion)(bus_space_tag_t, bus_space_handle_t,
8304a21b5dSmiod 			  bus_size_t, bus_size_t, bus_space_handle_t *);
8404a21b5dSmiod 	void *		(*_space_vaddr)(bus_space_tag_t, bus_space_handle_t);
8502ce23a6Smiod 	paddr_t		(*_space_mmap)(bus_space_tag_t, bus_addr_t, off_t,
8602ce23a6Smiod 			    int, int);
8704a21b5dSmiod };
8804a21b5dSmiod 
8904a21b5dSmiod #define	bus_space_read_1(t, h, o) (*(t)->_space_read_1)((t), (h), (o))
9004a21b5dSmiod #define	bus_space_read_2(t, h, o) (*(t)->_space_read_2)((t), (h), (o))
9104a21b5dSmiod #define	bus_space_read_4(t, h, o) (*(t)->_space_read_4)((t), (h), (o))
9204a21b5dSmiod #define	bus_space_read_8(t, h, o) (*(t)->_space_read_8)((t), (h), (o))
9304a21b5dSmiod 
9404a21b5dSmiod #define	bus_space_write_1(t, h, o, v) (*(t)->_space_write_1)((t), (h), (o), (v))
9504a21b5dSmiod #define	bus_space_write_2(t, h, o, v) (*(t)->_space_write_2)((t), (h), (o), (v))
9604a21b5dSmiod #define	bus_space_write_4(t, h, o, v) (*(t)->_space_write_4)((t), (h), (o), (v))
9704a21b5dSmiod #define	bus_space_write_8(t, h, o, v) (*(t)->_space_write_8)((t), (h), (o), (v))
9804a21b5dSmiod 
9904a21b5dSmiod #define	bus_space_read_raw_multi_2(t, h, a, b, l) \
10004a21b5dSmiod 	(*(t)->_space_read_raw_2)((t), (h), (a), (b), (l))
10104a21b5dSmiod #define	bus_space_read_raw_multi_4(t, h, a, b, l) \
10204a21b5dSmiod 	(*(t)->_space_read_raw_4)((t), (h), (a), (b), (l))
10304a21b5dSmiod #define	bus_space_read_raw_multi_8(t, h, a, b, l) \
10404a21b5dSmiod 	(*(t)->_space_read_raw_8)((t), (h), (a), (b), (l))
10504a21b5dSmiod 
10604a21b5dSmiod #define	bus_space_write_raw_multi_2(t, h, a, b, l) \
10704a21b5dSmiod 	(*(t)->_space_write_raw_2)((t), (h), (a), (b), (l))
10804a21b5dSmiod #define	bus_space_write_raw_multi_4(t, h, a, b, l) \
10904a21b5dSmiod 	(*(t)->_space_write_raw_4)((t), (h), (a), (b), (l))
11004a21b5dSmiod #define	bus_space_write_raw_multi_8(t, h, a, b, l) \
11104a21b5dSmiod 	(*(t)->_space_write_raw_8)((t), (h), (a), (b), (l))
11204a21b5dSmiod 
11304a21b5dSmiod #define	bus_space_map(t, o, s, c, p) (*(t)->_space_map)((t), (o), (s), (c), (p))
11404a21b5dSmiod #define	bus_space_unmap(t, h, s) (*(t)->_space_unmap)((t), (h), (s))
11504a21b5dSmiod #define	bus_space_subregion(t, h, o, s, p) \
11604a21b5dSmiod     (*(t)->_space_subregion)((t), (h), (o), (s), (p))
11704a21b5dSmiod 
11804a21b5dSmiod #define	BUS_SPACE_MAP_CACHEABLE		0x01
11904a21b5dSmiod #define	BUS_SPACE_MAP_LINEAR		0x02
12004a21b5dSmiod #define	BUS_SPACE_MAP_PREFETCHABLE	0x04
12104a21b5dSmiod 
12204a21b5dSmiod #define	bus_space_vaddr(t, h)	(*(t)->_space_vaddr)((t), (h))
12302ce23a6Smiod #define	bus_space_mmap(t, a, o, p, f) \
12402ce23a6Smiod 	(*(t)->_space_mmap)((t), (a), (o), (p), (f))
12504a21b5dSmiod 
12604a21b5dSmiod /*----------------------------------------------------------------------------*/
12704a21b5dSmiod #define bus_space_read_multi(n,m)					      \
12804a21b5dSmiod static __inline void							      \
12904a21b5dSmiod CAT(bus_space_read_multi_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,     \
13004a21b5dSmiod      bus_size_t o, CAT3(u_int,m,_t) *x, size_t cnt)			      \
13104a21b5dSmiod {									      \
13204a21b5dSmiod 	while (cnt--)							      \
13304a21b5dSmiod 		*x++ = CAT(bus_space_read_,n)(bst, bsh, o);		      \
13404a21b5dSmiod }
13504a21b5dSmiod 
13604a21b5dSmiod bus_space_read_multi(1,8)
13704a21b5dSmiod bus_space_read_multi(2,16)
13804a21b5dSmiod bus_space_read_multi(4,32)
13904a21b5dSmiod bus_space_read_multi(8,64)
14004a21b5dSmiod 
14104a21b5dSmiod /*----------------------------------------------------------------------------*/
14204a21b5dSmiod #define bus_space_read_region(n,m)					      \
14304a21b5dSmiod static __inline void							      \
14404a21b5dSmiod CAT(bus_space_read_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,    \
14504a21b5dSmiod      bus_addr_t ba, CAT3(u_int,m,_t) *x, size_t cnt)			      \
14604a21b5dSmiod {									      \
147*30c4e479Skettenis 	while (cnt--) {							      \
148*30c4e479Skettenis 		*x++ = CAT(bus_space_read_,n)(bst, bsh, ba);		      \
149*30c4e479Skettenis 		ba += (n);						      \
150*30c4e479Skettenis 	}								      \
15104a21b5dSmiod }
15204a21b5dSmiod 
15304a21b5dSmiod bus_space_read_region(1,8)
15404a21b5dSmiod bus_space_read_region(2,16)
15504a21b5dSmiod bus_space_read_region(4,32)
15604a21b5dSmiod bus_space_read_region(8,64)
15704a21b5dSmiod 
15804a21b5dSmiod /*----------------------------------------------------------------------------*/
15904a21b5dSmiod #define bus_space_read_raw_region(n,m)					      \
16004a21b5dSmiod static __inline void							      \
16104a21b5dSmiod CAT(bus_space_read_raw_region_,n)(bus_space_tag_t bst,			      \
16204a21b5dSmiod      bus_space_handle_t bsh,						      \
16304a21b5dSmiod      bus_addr_t ba, u_int8_t *x, size_t cnt)				      \
16404a21b5dSmiod {									      \
16504a21b5dSmiod 	cnt >>= ((n) >> 1);						      \
16604a21b5dSmiod 	while (cnt--) {							      \
167ef063de9Smiod 		CAT(bus_space_read_raw_multi_,n)(bst, bsh, ba, x, (n));	      \
16804a21b5dSmiod 		ba += (n);						      \
16904a21b5dSmiod 		x += (n);						      \
17004a21b5dSmiod 	}								      \
17104a21b5dSmiod }
17204a21b5dSmiod 
17304a21b5dSmiod bus_space_read_raw_region(2,16)
17404a21b5dSmiod bus_space_read_raw_region(4,32)
17504a21b5dSmiod bus_space_read_raw_region(8,64)
17604a21b5dSmiod 
17704a21b5dSmiod /*----------------------------------------------------------------------------*/
17804a21b5dSmiod #define bus_space_write_multi(n,m)					      \
17904a21b5dSmiod static __inline void							      \
18004a21b5dSmiod CAT(bus_space_write_multi_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,    \
18104a21b5dSmiod      bus_size_t o, const CAT3(u_int,m,_t) *x, size_t cnt)		      \
18204a21b5dSmiod {									      \
183*30c4e479Skettenis 	while (cnt--)							      \
18404a21b5dSmiod 		CAT(bus_space_write_,n)(bst, bsh, o, *x++);		      \
18504a21b5dSmiod }
18604a21b5dSmiod 
18704a21b5dSmiod bus_space_write_multi(1,8)
18804a21b5dSmiod bus_space_write_multi(2,16)
18904a21b5dSmiod bus_space_write_multi(4,32)
19004a21b5dSmiod bus_space_write_multi(8,64)
19104a21b5dSmiod 
19204a21b5dSmiod /*----------------------------------------------------------------------------*/
19304a21b5dSmiod #define bus_space_write_region(n,m)					      \
19404a21b5dSmiod static __inline void							      \
19504a21b5dSmiod CAT(bus_space_write_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,   \
19604a21b5dSmiod      bus_addr_t ba, const CAT3(u_int,m,_t) *x, size_t cnt)		      \
19704a21b5dSmiod {									      \
19804a21b5dSmiod 	while (cnt--) {							      \
19904a21b5dSmiod 		CAT(bus_space_write_,n)(bst, bsh, ba, *x++);		      \
200*30c4e479Skettenis 		ba += (n);						      \
20104a21b5dSmiod 	}								      \
20204a21b5dSmiod }
20304a21b5dSmiod 
20404a21b5dSmiod bus_space_write_region(1,8)
20504a21b5dSmiod bus_space_write_region(2,16)
20604a21b5dSmiod bus_space_write_region(4,32)
20704a21b5dSmiod bus_space_write_region(8,64)
20804a21b5dSmiod 
20904a21b5dSmiod /*----------------------------------------------------------------------------*/
21004a21b5dSmiod #define bus_space_write_raw_region(n,m)					      \
21104a21b5dSmiod static __inline void							      \
21204a21b5dSmiod CAT(bus_space_write_raw_region_,n)(bus_space_tag_t bst,			      \
21304a21b5dSmiod      bus_space_handle_t bsh,						      \
21404a21b5dSmiod      bus_addr_t ba, const u_int8_t *x, size_t cnt)		              \
21504a21b5dSmiod {									      \
21604a21b5dSmiod 	cnt >>= ((n) >> 1);						      \
21704a21b5dSmiod 	while (cnt--) {							      \
218ef063de9Smiod 		CAT(bus_space_write_raw_multi_,n)(bst, bsh, ba, x, (n));      \
21904a21b5dSmiod 		ba += (n);						      \
22004a21b5dSmiod 		x += (n);						      \
22104a21b5dSmiod 	}								      \
22204a21b5dSmiod }
22304a21b5dSmiod 
22404a21b5dSmiod bus_space_write_raw_region(2,16)
22504a21b5dSmiod bus_space_write_raw_region(4,32)
22604a21b5dSmiod bus_space_write_raw_region(8,64)
22704a21b5dSmiod 
22804a21b5dSmiod /*----------------------------------------------------------------------------*/
22904a21b5dSmiod #define bus_space_set_region(n,m)					      \
23004a21b5dSmiod static __inline void							      \
23104a21b5dSmiod CAT(bus_space_set_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,     \
23204a21b5dSmiod      bus_addr_t ba, CAT3(u_int,m,_t) x, size_t cnt)			      \
23304a21b5dSmiod {									      \
23404a21b5dSmiod 	while (cnt--) {							      \
23504a21b5dSmiod 		CAT(bus_space_write_,n)(bst, bsh, ba, x);		      \
236*30c4e479Skettenis 		ba += (n);						      \
23704a21b5dSmiod 	}								      \
23804a21b5dSmiod }
23904a21b5dSmiod 
24004a21b5dSmiod bus_space_set_region(1,8)
24104a21b5dSmiod bus_space_set_region(2,16)
24204a21b5dSmiod bus_space_set_region(4,32)
24304a21b5dSmiod bus_space_set_region(8,64)
24404a21b5dSmiod 
24504a21b5dSmiod /*----------------------------------------------------------------------------*/
24604a21b5dSmiod static __inline void
bus_space_copy_1(void * v,bus_space_handle_t h1,bus_size_t o1,bus_space_handle_t h2,bus_size_t o2,bus_size_t c)24704a21b5dSmiod bus_space_copy_1(void *v, bus_space_handle_t h1, bus_size_t o1,
24804a21b5dSmiod 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
24904a21b5dSmiod {
25004a21b5dSmiod 	char *s = (char *)(h1 + o1);
25104a21b5dSmiod 	char *d = (char *)(h2 + o2);
25204a21b5dSmiod 
25304a21b5dSmiod 	while (c--)
25404a21b5dSmiod 		*d++ = *s++;
25504a21b5dSmiod }
25604a21b5dSmiod 
25704a21b5dSmiod 
25804a21b5dSmiod static __inline void
bus_space_copy_2(void * v,bus_space_handle_t h1,bus_size_t o1,bus_space_handle_t h2,bus_size_t o2,bus_size_t c)25904a21b5dSmiod bus_space_copy_2(void *v, bus_space_handle_t h1, bus_size_t o1,
26004a21b5dSmiod 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
26104a21b5dSmiod {
26204a21b5dSmiod 	short *s = (short *)(h1 + o1);
26304a21b5dSmiod 	short *d = (short *)(h2 + o2);
26404a21b5dSmiod 
26504a21b5dSmiod 	while (c--)
26604a21b5dSmiod 		*d++ = *s++;
26704a21b5dSmiod }
26804a21b5dSmiod 
26904a21b5dSmiod static __inline void
bus_space_copy_4(void * v,bus_space_handle_t h1,bus_size_t o1,bus_space_handle_t h2,bus_size_t o2,bus_size_t c)27004a21b5dSmiod bus_space_copy_4(void *v, bus_space_handle_t h1, bus_size_t o1,
27104a21b5dSmiod 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
27204a21b5dSmiod {
27304a21b5dSmiod 	int *s = (int *)(h1 + o1);
27404a21b5dSmiod 	int *d = (int *)(h2 + o2);
27504a21b5dSmiod 
27604a21b5dSmiod 	while (c--)
27704a21b5dSmiod 		*d++ = *s++;
27804a21b5dSmiod }
27904a21b5dSmiod 
28004a21b5dSmiod static __inline void
bus_space_copy_8(void * v,bus_space_handle_t h1,bus_size_t o1,bus_space_handle_t h2,bus_size_t o2,bus_size_t c)28104a21b5dSmiod bus_space_copy_8(void *v, bus_space_handle_t h1, bus_size_t o1,
28204a21b5dSmiod 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
28304a21b5dSmiod {
28404a21b5dSmiod 	int64_t *s = (int64_t *)(h1 + o1);
28504a21b5dSmiod 	int64_t *d = (int64_t *)(h2 + o2);
28604a21b5dSmiod 
28704a21b5dSmiod 	while (c--)
28804a21b5dSmiod 		*d++ = *s++;
28904a21b5dSmiod }
29004a21b5dSmiod 
29104a21b5dSmiod int	generic_space_map(bus_space_tag_t, bus_addr_t, bus_size_t, int,
29204a21b5dSmiod 	    bus_space_handle_t *);
29304a21b5dSmiod void	generic_space_unmap(bus_space_tag_t, bus_space_handle_t, bus_size_t);
29404a21b5dSmiod int	generic_space_region(bus_space_tag_t, bus_space_handle_t, bus_size_t,
29504a21b5dSmiod 	    bus_size_t, bus_space_handle_t *);
29604a21b5dSmiod void	*generic_space_vaddr(bus_space_tag_t, bus_space_handle_t);
29704a21b5dSmiod uint8_t generic_space_read_1(bus_space_tag_t, bus_space_handle_t, bus_size_t);
29804a21b5dSmiod uint16_t generic_space_read_2(bus_space_tag_t, bus_space_handle_t, bus_size_t);
29904a21b5dSmiod uint32_t generic_space_read_4(bus_space_tag_t, bus_space_handle_t, bus_size_t);
30004a21b5dSmiod uint64_t generic_space_read_8(bus_space_tag_t, bus_space_handle_t, bus_size_t);
30104a21b5dSmiod void	generic_space_read_raw_2(bus_space_tag_t, bus_space_handle_t,
30204a21b5dSmiod 	    bus_addr_t, uint8_t *, bus_size_t);
30304a21b5dSmiod void	generic_space_write_1(bus_space_tag_t, bus_space_handle_t, bus_size_t,
30404a21b5dSmiod 	    uint8_t);
30504a21b5dSmiod void	generic_space_write_2(bus_space_tag_t, bus_space_handle_t, bus_size_t,
30604a21b5dSmiod 	    uint16_t);
30704a21b5dSmiod void	generic_space_write_4(bus_space_tag_t, bus_space_handle_t, bus_size_t,
30804a21b5dSmiod 	    uint32_t);
30904a21b5dSmiod void	generic_space_write_8(bus_space_tag_t, bus_space_handle_t, bus_size_t,
31004a21b5dSmiod 	    uint64_t);
31104a21b5dSmiod void	generic_space_write_raw_2(bus_space_tag_t, bus_space_handle_t,
31204a21b5dSmiod 	    bus_addr_t, const uint8_t *, bus_size_t);
31304a21b5dSmiod void	generic_space_read_raw_4(bus_space_tag_t, bus_space_handle_t,
31404a21b5dSmiod 	    bus_addr_t, uint8_t *, bus_size_t);
31504a21b5dSmiod void	generic_space_write_raw_4(bus_space_tag_t, bus_space_handle_t,
31604a21b5dSmiod 	    bus_addr_t, const uint8_t *, bus_size_t);
31704a21b5dSmiod void	generic_space_read_raw_8(bus_space_tag_t, bus_space_handle_t,
31804a21b5dSmiod 	    bus_addr_t, uint8_t *, bus_size_t);
31904a21b5dSmiod void	generic_space_write_raw_8(bus_space_tag_t, bus_space_handle_t,
32004a21b5dSmiod 	    bus_addr_t, const uint8_t *, bus_size_t);
32102ce23a6Smiod paddr_t	generic_space_mmap(bus_space_tag_t, bus_addr_t, off_t, int, int);
32204a21b5dSmiod 
32304a21b5dSmiod /*----------------------------------------------------------------------------*/
32404a21b5dSmiod /*
32504a21b5dSmiod  * Bus read/write barrier methods.
32604a21b5dSmiod  *
32704a21b5dSmiod  *	void bus_space_barrier(bus_space_tag_t tag,
32804a21b5dSmiod  *	    bus_space_handle_t bsh, bus_size_t offset,
32904a21b5dSmiod  *	    bus_size_t len, int flags);
33004a21b5dSmiod  *
33104a21b5dSmiod  */
33204a21b5dSmiod static inline void
bus_space_barrier(bus_space_tag_t t,bus_space_handle_t h,bus_size_t offset,bus_size_t length,int flags)33304a21b5dSmiod bus_space_barrier(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset,
33404a21b5dSmiod     bus_size_t length, int flags)
33504a21b5dSmiod {
3362df76cc2Sguenther 	__asm__ volatile ("sync" ::: "memory");
33704a21b5dSmiod }
33804a21b5dSmiod #define BUS_SPACE_BARRIER_READ  0x01		/* force read barrier */
33904a21b5dSmiod #define BUS_SPACE_BARRIER_WRITE 0x02		/* force write barrier */
34004a21b5dSmiod 
341acc42d18Smiod #define	BUS_DMA_WAITOK		0x0000
342acc42d18Smiod #define	BUS_DMA_NOWAIT		0x0001
343acc42d18Smiod #define	BUS_DMA_ALLOCNOW	0x0002
344acc42d18Smiod #define	BUS_DMA_COHERENT	0x0008
345acc42d18Smiod #define	BUS_DMA_BUS1		0x0010	/* placeholders for bus functions... */
346acc42d18Smiod #define	BUS_DMA_BUS2		0x0020
347acc42d18Smiod #define	BUS_DMA_BUS3		0x0040
348acc42d18Smiod #define	BUS_DMA_BUS4		0x0080
349acc42d18Smiod #define	BUS_DMA_READ		0x0100	/* mapping is device -> memory only */
350acc42d18Smiod #define	BUS_DMA_WRITE		0x0200	/* mapping is memory -> device only */
351acc42d18Smiod #define	BUS_DMA_STREAMING	0x0400	/* hint: sequential, unidirectional */
352acc42d18Smiod #define	BUS_DMA_ZERO		0x0800	/* zero memory in dmamem_alloc */
353acc42d18Smiod #define	BUS_DMA_NOCACHE		0x1000
354b0002153Sdlg #define	BUS_DMA_64BIT		0x2000	/* device handles 64bit dva */
35504a21b5dSmiod 
35604a21b5dSmiod /* Forwards needed by prototypes below. */
35704a21b5dSmiod struct mbuf;
35804a21b5dSmiod struct proc;
35904a21b5dSmiod struct uio;
36004a21b5dSmiod 
36104a21b5dSmiod #define	BUS_DMASYNC_POSTREAD	0x0001
36204a21b5dSmiod #define BUS_DMASYNC_POSTWRITE	0x0002
36304a21b5dSmiod #define BUS_DMASYNC_PREREAD	0x0004
36404a21b5dSmiod #define BUS_DMASYNC_PREWRITE	0x0008
36504a21b5dSmiod 
36604a21b5dSmiod typedef struct machine_bus_dma_tag	*bus_dma_tag_t;
36704a21b5dSmiod typedef struct machine_bus_dmamap	*bus_dmamap_t;
36804a21b5dSmiod 
36904a21b5dSmiod /*
37004a21b5dSmiod  *	bus_dma_segment_t
37104a21b5dSmiod  *
37204a21b5dSmiod  *	Describes a single contiguous DMA transaction.  Values
37304a21b5dSmiod  *	are suitable for programming into DMA registers.
37404a21b5dSmiod  */
37504a21b5dSmiod struct machine_bus_dma_segment {
37604a21b5dSmiod 	bus_addr_t	ds_addr;	/* DMA address */
37704a21b5dSmiod 	bus_size_t	ds_len;		/* length of transfer */
37804a21b5dSmiod 
37904a21b5dSmiod 	paddr_t		_ds_paddr;	/* CPU address */
38004a21b5dSmiod 	vaddr_t		_ds_vaddr;	/* CPU address */
38104a21b5dSmiod };
38204a21b5dSmiod typedef struct machine_bus_dma_segment	bus_dma_segment_t;
38304a21b5dSmiod 
38404a21b5dSmiod /*
38504a21b5dSmiod  *	bus_dma_tag_t
38604a21b5dSmiod  *
38704a21b5dSmiod  *	A machine-dependent opaque type describing the implementation of
38804a21b5dSmiod  *	DMA for a given bus.
38904a21b5dSmiod  */
39004a21b5dSmiod 
39104a21b5dSmiod struct machine_bus_dma_tag {
39204a21b5dSmiod 	void	*_cookie;		/* cookie used in the guts */
39304a21b5dSmiod 
39404a21b5dSmiod 	/*
39504a21b5dSmiod 	 * DMA mapping methods.
39604a21b5dSmiod 	 */
39704a21b5dSmiod 	int	(*_dmamap_create)(bus_dma_tag_t , bus_size_t, int,
39804a21b5dSmiod 		    bus_size_t, bus_size_t, int, bus_dmamap_t *);
39904a21b5dSmiod 	void	(*_dmamap_destroy)(bus_dma_tag_t , bus_dmamap_t);
40004a21b5dSmiod 	int	(*_dmamap_load)(bus_dma_tag_t , bus_dmamap_t, void *,
40104a21b5dSmiod 		    bus_size_t, struct proc *, int);
40204a21b5dSmiod 	int	(*_dmamap_load_mbuf)(bus_dma_tag_t , bus_dmamap_t,
40304a21b5dSmiod 		    struct mbuf *, int);
40404a21b5dSmiod 	int	(*_dmamap_load_uio)(bus_dma_tag_t , bus_dmamap_t,
40504a21b5dSmiod 		    struct uio *, int);
40604a21b5dSmiod 	int	(*_dmamap_load_raw)(bus_dma_tag_t , bus_dmamap_t,
40704a21b5dSmiod 		    bus_dma_segment_t *, int, bus_size_t, int);
40804a21b5dSmiod 	int	(*_dmamap_load_buffer)(bus_dma_tag_t, bus_dmamap_t, void *,
40904a21b5dSmiod 		    bus_size_t, struct proc *, int, paddr_t *, int *, int);
41004a21b5dSmiod 	void	(*_dmamap_unload)(bus_dma_tag_t , bus_dmamap_t);
41104a21b5dSmiod 	void	(*_dmamap_sync)(bus_dma_tag_t , bus_dmamap_t,
41204a21b5dSmiod 		    bus_addr_t, bus_size_t, int);
41304a21b5dSmiod 
41404a21b5dSmiod 	/*
41504a21b5dSmiod 	 * DMA memory utility functions.
41604a21b5dSmiod 	 */
41704a21b5dSmiod 	int	(*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
41804a21b5dSmiod 		    bus_size_t, bus_dma_segment_t *, int, int *, int);
41904a21b5dSmiod 	void	(*_dmamem_free)(bus_dma_tag_t, bus_dma_segment_t *, int);
42004a21b5dSmiod 	int	(*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
42104a21b5dSmiod 		    int, size_t, caddr_t *, int);
42204a21b5dSmiod 	void	(*_dmamem_unmap)(bus_dma_tag_t, caddr_t, size_t);
42304a21b5dSmiod 	paddr_t	(*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
42404a21b5dSmiod 		    int, off_t, int, int);
42504a21b5dSmiod 
42604a21b5dSmiod 	/*
42704a21b5dSmiod 	 * internal memory address translation information.
42804a21b5dSmiod 	 */
42904a21b5dSmiod 	bus_addr_t (*_pa_to_device)(paddr_t);
43004a21b5dSmiod 	paddr_t	(*_device_to_pa)(bus_addr_t);
43104a21b5dSmiod 	bus_addr_t _dma_mask;
43204a21b5dSmiod };
43304a21b5dSmiod 
43404a21b5dSmiod #define	bus_dmamap_create(t, s, n, m, b, f, p)			\
43504a21b5dSmiod 	(*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p))
43604a21b5dSmiod #define	bus_dmamap_destroy(t, p)				\
43704a21b5dSmiod 	(*(t)->_dmamap_destroy)((t), (p))
43804a21b5dSmiod #define	bus_dmamap_load(t, m, b, s, p, f)			\
43904a21b5dSmiod 	(*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f))
44004a21b5dSmiod #define	bus_dmamap_load_mbuf(t, m, b, f)			\
44104a21b5dSmiod 	(*(t)->_dmamap_load_mbuf)((t), (m), (b), (f))
44204a21b5dSmiod #define	bus_dmamap_load_uio(t, m, u, f)				\
44304a21b5dSmiod 	(*(t)->_dmamap_load_uio)((t), (m), (u), (f))
44404a21b5dSmiod #define	bus_dmamap_load_raw(t, m, sg, n, s, f)			\
44504a21b5dSmiod 	(*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f))
44604a21b5dSmiod #define	bus_dmamap_unload(t, p)					\
44704a21b5dSmiod 	(*(t)->_dmamap_unload)((t), (p))
44804a21b5dSmiod #define	bus_dmamap_sync(t, p, a, l, o)				\
44904a21b5dSmiod 	(void)((t)->_dmamap_sync ?				\
45004a21b5dSmiod 	    (*(t)->_dmamap_sync)((t), (p), (a), (l), (o)) : (void)0)
45104a21b5dSmiod 
45204a21b5dSmiod #define	bus_dmamem_alloc(t, s, a, b, sg, n, r, f)		\
45304a21b5dSmiod 	(*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f))
45404a21b5dSmiod #define	bus_dmamem_free(t, sg, n)				\
45504a21b5dSmiod 	(*(t)->_dmamem_free)((t), (sg), (n))
45604a21b5dSmiod #define	bus_dmamem_map(t, sg, n, s, k, f)			\
45704a21b5dSmiod 	(*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f))
45804a21b5dSmiod #define	bus_dmamem_unmap(t, k, s)				\
45904a21b5dSmiod 	(*(t)->_dmamem_unmap)((t), (k), (s))
46004a21b5dSmiod #define	bus_dmamem_mmap(t, sg, n, o, p, f)			\
46104a21b5dSmiod 	(*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f))
46204a21b5dSmiod 
46304a21b5dSmiod int	_dmamap_create(bus_dma_tag_t, bus_size_t, int,
46404a21b5dSmiod 	    bus_size_t, bus_size_t, int, bus_dmamap_t *);
46504a21b5dSmiod void	_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
46604a21b5dSmiod int	_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *,
46704a21b5dSmiod 	    bus_size_t, struct proc *, int);
46804a21b5dSmiod int	_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t, struct mbuf *, int);
46904a21b5dSmiod int	_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t, struct uio *, int);
47004a21b5dSmiod int	_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t,
47104a21b5dSmiod 	    bus_dma_segment_t *, int, bus_size_t, int);
47204a21b5dSmiod int	_dmamap_load_buffer(bus_dma_tag_t, bus_dmamap_t, void *,
47304a21b5dSmiod 	    bus_size_t, struct proc *, int, paddr_t *, int *, int);
47404a21b5dSmiod void	_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
47504a21b5dSmiod void	_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
47604a21b5dSmiod 	    bus_size_t, int);
47704a21b5dSmiod 
47804a21b5dSmiod int	_dmamem_alloc(bus_dma_tag_t, bus_size_t, bus_size_t,
47904a21b5dSmiod 	    bus_size_t, bus_dma_segment_t *, int, int *, int);
48004a21b5dSmiod void	_dmamem_free(bus_dma_tag_t, bus_dma_segment_t *, int);
48104a21b5dSmiod int	_dmamem_map(bus_dma_tag_t, bus_dma_segment_t *,
48204a21b5dSmiod 	    int, size_t, caddr_t *, int);
48304a21b5dSmiod void	_dmamem_unmap(bus_dma_tag_t, caddr_t, size_t);
48404a21b5dSmiod paddr_t	_dmamem_mmap(bus_dma_tag_t, bus_dma_segment_t *, int, off_t, int, int);
48504a21b5dSmiod int	_dmamem_alloc_range(bus_dma_tag_t, bus_size_t, bus_size_t, bus_size_t,
486acc42d18Smiod 	    bus_dma_segment_t *, int, int *, int, paddr_t, paddr_t);
48704a21b5dSmiod 
48804a21b5dSmiod /*
48904a21b5dSmiod  *	bus_dmamap_t
49004a21b5dSmiod  *
49104a21b5dSmiod  *	Describes a DMA mapping.
49204a21b5dSmiod  */
49304a21b5dSmiod struct machine_bus_dmamap {
49404a21b5dSmiod 	/*
49504a21b5dSmiod 	 * PRIVATE MEMBERS: not for use by machine-independent code.
49604a21b5dSmiod 	 */
49704a21b5dSmiod 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
49804a21b5dSmiod 	int		_dm_segcnt;	/* number of segs this map can map */
49904a21b5dSmiod 	bus_size_t	_dm_maxsegsz;	/* largest possible segment */
50004a21b5dSmiod 	bus_size_t	_dm_boundary;	/* don't cross this */
50104a21b5dSmiod 	int		_dm_flags;	/* misc. flags */
50204a21b5dSmiod 
50304a21b5dSmiod 	void		*_dm_cookie;	/* cookie for bus-specific functions */
50404a21b5dSmiod 
50504a21b5dSmiod 	/*
50604a21b5dSmiod 	 * PUBLIC MEMBERS: these are used by machine-independent code.
50704a21b5dSmiod 	 */
50804a21b5dSmiod 	bus_size_t	dm_mapsize;	/* size of the mapping */
50904a21b5dSmiod 	int		dm_nsegs;	/* # valid segments in mapping */
51004a21b5dSmiod 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
51104a21b5dSmiod };
51204a21b5dSmiod 
51304a21b5dSmiod #endif /* _MACHINE_BUS_H_ */
514