xref: /openbsd-src/sys/arch/powerpc64/include/bus.h (revision 48f49e59af81b0f5bda9746fee3b5ef8c65752bc)
1*48f49e59Skettenis /* $OpenBSD: bus.h,v 1.5 2020/11/15 23:13:00 kettenis Exp $ */
2352f7f3bSkettenis /*
3352f7f3bSkettenis  * Copyright (c) 2003-2004 Opsycon AB Sweden.  All rights reserved.
4352f7f3bSkettenis  *
5352f7f3bSkettenis  * Redistribution and use in source and binary forms, with or without
6352f7f3bSkettenis  * modification, are permitted provided that the following conditions
7352f7f3bSkettenis  * are met:
8352f7f3bSkettenis  * 1. Redistributions of source code must retain the above copyright
9352f7f3bSkettenis  *    notice, this list of conditions and the following disclaimer.
10352f7f3bSkettenis  * 2. Redistributions in binary form must reproduce the above copyright
11352f7f3bSkettenis  *    notice, this list of conditions and the following disclaimer in the
12352f7f3bSkettenis  *    documentation and/or other materials provided with the distribution.
13352f7f3bSkettenis  *
14352f7f3bSkettenis  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15352f7f3bSkettenis  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16352f7f3bSkettenis  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17352f7f3bSkettenis  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18352f7f3bSkettenis  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19352f7f3bSkettenis  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20352f7f3bSkettenis  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21352f7f3bSkettenis  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22352f7f3bSkettenis  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23352f7f3bSkettenis  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24352f7f3bSkettenis  */
25352f7f3bSkettenis 
2613861200Skettenis #ifndef _MACHINE_BUS_H_
2713861200Skettenis #define _MACHINE_BUS_H_
2813861200Skettenis 
29352f7f3bSkettenis #define CAT(a,b)	a##b
30352f7f3bSkettenis #define CAT3(a,b,c)	a##b##c
31352f7f3bSkettenis 
32352f7f3bSkettenis /*
33352f7f3bSkettenis  * Bus access types.
34352f7f3bSkettenis  */
3513861200Skettenis struct bus_space;
3613861200Skettenis typedef u_long bus_addr_t;
3713861200Skettenis typedef u_long bus_size_t;
3813861200Skettenis typedef u_long bus_space_handle_t;
3913861200Skettenis typedef struct bus_space *bus_space_tag_t;
40352f7f3bSkettenis typedef struct bus_space bus_space_t;
4113861200Skettenis 
42352f7f3bSkettenis struct bus_space {
43352f7f3bSkettenis 	bus_addr_t	bus_base;
44352f7f3bSkettenis 	void		*bus_private;
45352f7f3bSkettenis 	uint8_t		(*_space_read_1)(bus_space_tag_t , bus_space_handle_t,
46352f7f3bSkettenis 			  bus_size_t);
47352f7f3bSkettenis 	void		(*_space_write_1)(bus_space_tag_t , bus_space_handle_t,
48352f7f3bSkettenis 			  bus_size_t, uint8_t);
49352f7f3bSkettenis 	uint16_t	(*_space_read_2)(bus_space_tag_t , bus_space_handle_t,
50352f7f3bSkettenis 			  bus_size_t);
51352f7f3bSkettenis 	void		(*_space_write_2)(bus_space_tag_t , bus_space_handle_t,
52352f7f3bSkettenis 			  bus_size_t, uint16_t);
53352f7f3bSkettenis 	uint32_t	(*_space_read_4)(bus_space_tag_t , bus_space_handle_t,
54352f7f3bSkettenis 			  bus_size_t);
55352f7f3bSkettenis 	void		(*_space_write_4)(bus_space_tag_t , bus_space_handle_t,
56352f7f3bSkettenis 			  bus_size_t, uint32_t);
57352f7f3bSkettenis 	uint64_t	(*_space_read_8)(bus_space_tag_t , bus_space_handle_t,
58352f7f3bSkettenis 			  bus_size_t);
59352f7f3bSkettenis 	void		(*_space_write_8)(bus_space_tag_t , bus_space_handle_t,
60352f7f3bSkettenis 			  bus_size_t, uint64_t);
61352f7f3bSkettenis 	void		(*_space_read_raw_2)(bus_space_tag_t, bus_space_handle_t,
62352f7f3bSkettenis 			  bus_addr_t, uint8_t *, bus_size_t);
63352f7f3bSkettenis 	void		(*_space_write_raw_2)(bus_space_tag_t, bus_space_handle_t,
64352f7f3bSkettenis 			  bus_addr_t, const uint8_t *, bus_size_t);
65352f7f3bSkettenis 	void		(*_space_read_raw_4)(bus_space_tag_t, bus_space_handle_t,
66352f7f3bSkettenis 			  bus_addr_t, uint8_t *, bus_size_t);
67352f7f3bSkettenis 	void		(*_space_write_raw_4)(bus_space_tag_t, bus_space_handle_t,
68352f7f3bSkettenis 			  bus_addr_t, const uint8_t *, bus_size_t);
69352f7f3bSkettenis 	void		(*_space_read_raw_8)(bus_space_tag_t, bus_space_handle_t,
70352f7f3bSkettenis 			  bus_addr_t, uint8_t *, bus_size_t);
71352f7f3bSkettenis 	void		(*_space_write_raw_8)(bus_space_tag_t, bus_space_handle_t,
72352f7f3bSkettenis 			  bus_addr_t, const uint8_t *, bus_size_t);
73352f7f3bSkettenis 	int		(*_space_map)(bus_space_tag_t , bus_addr_t,
74352f7f3bSkettenis 			  bus_size_t, int, bus_space_handle_t *);
75352f7f3bSkettenis 	void		(*_space_unmap)(bus_space_tag_t, bus_space_handle_t,
76352f7f3bSkettenis 			  bus_size_t);
77352f7f3bSkettenis 	int		(*_space_subregion)(bus_space_tag_t, bus_space_handle_t,
78352f7f3bSkettenis 			  bus_size_t, bus_size_t, bus_space_handle_t *);
79352f7f3bSkettenis 	void *		(*_space_vaddr)(bus_space_tag_t, bus_space_handle_t);
80352f7f3bSkettenis 	paddr_t		(*_space_mmap)(bus_space_tag_t, bus_addr_t, off_t,
81352f7f3bSkettenis 			  int, int);
82352f7f3bSkettenis };
83ce837c9bSkettenis 
84352f7f3bSkettenis #define	bus_space_read_1(t, h, o) (*(t)->_space_read_1)((t), (h), (o))
85352f7f3bSkettenis #define	bus_space_read_2(t, h, o) (*(t)->_space_read_2)((t), (h), (o))
86352f7f3bSkettenis #define	bus_space_read_4(t, h, o) (*(t)->_space_read_4)((t), (h), (o))
87352f7f3bSkettenis #define	bus_space_read_8(t, h, o) (*(t)->_space_read_8)((t), (h), (o))
8813861200Skettenis 
89352f7f3bSkettenis #define	bus_space_write_1(t, h, o, v) (*(t)->_space_write_1)((t), (h), (o), (v))
90352f7f3bSkettenis #define	bus_space_write_2(t, h, o, v) (*(t)->_space_write_2)((t), (h), (o), (v))
91352f7f3bSkettenis #define	bus_space_write_4(t, h, o, v) (*(t)->_space_write_4)((t), (h), (o), (v))
92352f7f3bSkettenis #define	bus_space_write_8(t, h, o, v) (*(t)->_space_write_8)((t), (h), (o), (v))
93352f7f3bSkettenis 
94352f7f3bSkettenis #define	bus_space_read_raw_2(t, h, o) \
95*48f49e59Skettenis 	generic_space_read_2((t), (h), (o))
96352f7f3bSkettenis #define	bus_space_read_raw_4(t, h, o) \
97*48f49e59Skettenis 	generic_space_read_4((t), (h), (o))
98352f7f3bSkettenis #define	bus_space_read_raw_8(t, h, o) \
99*48f49e59Skettenis 	generic_space_read_8((t), (h), (o))
100352f7f3bSkettenis 
101352f7f3bSkettenis #define	bus_space_write_raw_2(t, h, o, v) \
102*48f49e59Skettenis 	generic_space_write_2((t), (h), (o), (v))
103352f7f3bSkettenis #define	bus_space_write_raw_4(t, h, o, v) \
104*48f49e59Skettenis 	generic_space_write_4((t), (h), (o), (v))
105352f7f3bSkettenis #define	bus_space_write_raw_8(t, h, o, v) \
106*48f49e59Skettenis 	generic_space_write_8((t), (h), (o), (v))
107352f7f3bSkettenis 
108352f7f3bSkettenis #define	bus_space_read_raw_multi_2(t, h, a, b, l) \
109352f7f3bSkettenis 	(*(t)->_space_read_raw_2)((t), (h), (a), (b), (l))
110352f7f3bSkettenis #define	bus_space_read_raw_multi_4(t, h, a, b, l) \
111352f7f3bSkettenis 	(*(t)->_space_read_raw_4)((t), (h), (a), (b), (l))
112352f7f3bSkettenis #define	bus_space_read_raw_multi_8(t, h, a, b, l) \
113352f7f3bSkettenis 	(*(t)->_space_read_raw_8)((t), (h), (a), (b), (l))
114352f7f3bSkettenis 
115352f7f3bSkettenis #define	bus_space_write_raw_multi_2(t, h, a, b, l) \
116352f7f3bSkettenis 	(*(t)->_space_write_raw_2)((t), (h), (a), (b), (l))
117352f7f3bSkettenis #define	bus_space_write_raw_multi_4(t, h, a, b, l) \
118352f7f3bSkettenis 	(*(t)->_space_write_raw_4)((t), (h), (a), (b), (l))
119352f7f3bSkettenis #define	bus_space_write_raw_multi_8(t, h, a, b, l) \
120352f7f3bSkettenis 	(*(t)->_space_write_raw_8)((t), (h), (a), (b), (l))
121352f7f3bSkettenis 
122352f7f3bSkettenis #define	bus_space_map(t, o, s, c, p) (*(t)->_space_map)((t), (o), (s), (c), (p))
123352f7f3bSkettenis #define	bus_space_unmap(t, h, s) (*(t)->_space_unmap)((t), (h), (s))
124352f7f3bSkettenis #define	bus_space_subregion(t, h, o, s, p) \
125352f7f3bSkettenis     (*(t)->_space_subregion)((t), (h), (o), (s), (p))
126352f7f3bSkettenis 
127352f7f3bSkettenis #define	BUS_SPACE_MAP_CACHEABLE		0x01
128352f7f3bSkettenis #define BUS_SPACE_MAP_KSEG0		0x02
129352f7f3bSkettenis #define	BUS_SPACE_MAP_LINEAR		0x04
130352f7f3bSkettenis #define	BUS_SPACE_MAP_PREFETCHABLE	0x08
131352f7f3bSkettenis 
132352f7f3bSkettenis #define	bus_space_vaddr(t, h)	(*(t)->_space_vaddr)((t), (h))
133352f7f3bSkettenis #define	bus_space_mmap(t, a, o, p, f) \
134352f7f3bSkettenis     (*(t)->_space_mmap)((t), (a), (o), (p), (f))
135352f7f3bSkettenis 
136352f7f3bSkettenis /*----------------------------------------------------------------------------*/
137352f7f3bSkettenis #define bus_space_read_multi(n,m)					      \
138352f7f3bSkettenis static __inline void							      \
139352f7f3bSkettenis CAT(bus_space_read_multi_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,     \
140352f7f3bSkettenis      bus_size_t o, CAT3(uint,m,_t) *x, size_t cnt)			      \
141352f7f3bSkettenis {									      \
142352f7f3bSkettenis 	while (cnt--)							      \
143352f7f3bSkettenis 		*x++ = CAT(bus_space_read_,n)(bst, bsh, o);		      \
144352f7f3bSkettenis }
145352f7f3bSkettenis 
146352f7f3bSkettenis bus_space_read_multi(1,8)
147352f7f3bSkettenis bus_space_read_multi(2,16)
148352f7f3bSkettenis bus_space_read_multi(4,32)
149352f7f3bSkettenis bus_space_read_multi(8,64)
150352f7f3bSkettenis 
151352f7f3bSkettenis /*----------------------------------------------------------------------------*/
152352f7f3bSkettenis #define bus_space_read_region(n,m)					      \
153352f7f3bSkettenis static __inline void							      \
154352f7f3bSkettenis CAT(bus_space_read_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,    \
155352f7f3bSkettenis      bus_addr_t ba, CAT3(uint,m,_t) *x, size_t cnt)			      \
156352f7f3bSkettenis {									      \
157352f7f3bSkettenis 	while (cnt--) {							      \
158352f7f3bSkettenis 		*x++ = CAT(bus_space_read_,n)(bst, bsh, ba);		      \
159352f7f3bSkettenis 		ba += (n);						      \
160352f7f3bSkettenis 	}								      \
161352f7f3bSkettenis }
162352f7f3bSkettenis 
163352f7f3bSkettenis bus_space_read_region(1,8)
164352f7f3bSkettenis bus_space_read_region(2,16)
165352f7f3bSkettenis bus_space_read_region(4,32)
166352f7f3bSkettenis bus_space_read_region(8,64)
167352f7f3bSkettenis 
168352f7f3bSkettenis /*----------------------------------------------------------------------------*/
169352f7f3bSkettenis #define bus_space_read_raw_region(n,m)					      \
170352f7f3bSkettenis static __inline void							      \
171352f7f3bSkettenis CAT(bus_space_read_raw_region_,n)(bus_space_tag_t bst,			      \
172352f7f3bSkettenis      bus_space_handle_t bsh,						      \
173352f7f3bSkettenis      bus_addr_t ba, uint8_t *x, size_t cnt)				      \
174352f7f3bSkettenis {									      \
175352f7f3bSkettenis 	cnt >>= ((n) >> 1);						      \
176352f7f3bSkettenis 	while (cnt--) {							      \
177352f7f3bSkettenis 		CAT(bus_space_read_raw_multi_,n)(bst, bsh, ba, x, (n));	      \
178352f7f3bSkettenis 		ba += (n);						      \
179352f7f3bSkettenis 		x += (n);						      \
180352f7f3bSkettenis 	}								      \
181352f7f3bSkettenis }
182352f7f3bSkettenis 
183352f7f3bSkettenis bus_space_read_raw_region(2,16)
184352f7f3bSkettenis bus_space_read_raw_region(4,32)
185352f7f3bSkettenis bus_space_read_raw_region(8,64)
186352f7f3bSkettenis 
187352f7f3bSkettenis /*----------------------------------------------------------------------------*/
188352f7f3bSkettenis #define bus_space_write_multi(n,m)					      \
189352f7f3bSkettenis static __inline void							      \
190352f7f3bSkettenis CAT(bus_space_write_multi_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,    \
191352f7f3bSkettenis      bus_size_t o, const CAT3(uint,m,_t) *x, size_t cnt)		      \
192352f7f3bSkettenis {									      \
193352f7f3bSkettenis 	while (cnt--)							      \
194352f7f3bSkettenis 		CAT(bus_space_write_,n)(bst, bsh, o, *x++);		      \
195352f7f3bSkettenis }
196352f7f3bSkettenis 
197352f7f3bSkettenis bus_space_write_multi(1,8)
198352f7f3bSkettenis bus_space_write_multi(2,16)
199352f7f3bSkettenis bus_space_write_multi(4,32)
200352f7f3bSkettenis bus_space_write_multi(8,64)
201352f7f3bSkettenis 
202352f7f3bSkettenis /*----------------------------------------------------------------------------*/
203352f7f3bSkettenis #define bus_space_write_region(n,m)					      \
204352f7f3bSkettenis static __inline void							      \
205352f7f3bSkettenis CAT(bus_space_write_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,   \
206352f7f3bSkettenis      bus_addr_t ba, const CAT3(uint,m,_t) *x, size_t cnt)		      \
207352f7f3bSkettenis {									      \
208352f7f3bSkettenis 	while (cnt--) {							      \
209352f7f3bSkettenis 		CAT(bus_space_write_,n)(bst, bsh, ba, *x++);		      \
210352f7f3bSkettenis 		ba += (n);						      \
211352f7f3bSkettenis 	}								      \
212352f7f3bSkettenis }
213352f7f3bSkettenis 
214352f7f3bSkettenis bus_space_write_region(1,8)
215352f7f3bSkettenis bus_space_write_region(2,16)
216352f7f3bSkettenis bus_space_write_region(4,32)
217352f7f3bSkettenis bus_space_write_region(8,64)
218352f7f3bSkettenis 
219352f7f3bSkettenis /*----------------------------------------------------------------------------*/
220352f7f3bSkettenis #define bus_space_write_raw_region(n,m)					      \
221352f7f3bSkettenis static __inline void							      \
222352f7f3bSkettenis CAT(bus_space_write_raw_region_,n)(bus_space_tag_t bst,			      \
223352f7f3bSkettenis      bus_space_handle_t bsh,						      \
224352f7f3bSkettenis      bus_addr_t ba, const uint8_t *x, size_t cnt)		              \
225352f7f3bSkettenis {									      \
226352f7f3bSkettenis 	cnt >>= ((n) >> 1);						      \
227352f7f3bSkettenis 	while (cnt--) {							      \
228352f7f3bSkettenis 		CAT(bus_space_write_raw_multi_,n)(bst, bsh, ba, x, (n));      \
229352f7f3bSkettenis 		ba += (n);						      \
230352f7f3bSkettenis 		x += (n);						      \
231352f7f3bSkettenis 	}								      \
232352f7f3bSkettenis }
233352f7f3bSkettenis 
234352f7f3bSkettenis bus_space_write_raw_region(2,16)
235352f7f3bSkettenis bus_space_write_raw_region(4,32)
236352f7f3bSkettenis bus_space_write_raw_region(8,64)
237352f7f3bSkettenis 
238352f7f3bSkettenis /*----------------------------------------------------------------------------*/
239352f7f3bSkettenis #define bus_space_set_region(n,m)					      \
240352f7f3bSkettenis static __inline void							      \
241352f7f3bSkettenis CAT(bus_space_set_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh,     \
242352f7f3bSkettenis      bus_addr_t ba, CAT3(uint,m,_t) x, size_t cnt)			      \
243352f7f3bSkettenis {									      \
244352f7f3bSkettenis 	while (cnt--) {							      \
245352f7f3bSkettenis 		CAT(bus_space_write_,n)(bst, bsh, ba, x);		      \
246352f7f3bSkettenis 		ba += (n);						      \
247352f7f3bSkettenis 	}								      \
248352f7f3bSkettenis }
249352f7f3bSkettenis 
250352f7f3bSkettenis bus_space_set_region(1,8)
251352f7f3bSkettenis bus_space_set_region(2,16)
252352f7f3bSkettenis bus_space_set_region(4,32)
253352f7f3bSkettenis bus_space_set_region(8,64)
254352f7f3bSkettenis 
255352f7f3bSkettenis /*----------------------------------------------------------------------------*/
256352f7f3bSkettenis 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)257352f7f3bSkettenis bus_space_copy_1(void *v, bus_space_handle_t h1, bus_size_t o1,
258352f7f3bSkettenis 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
259352f7f3bSkettenis {
260352f7f3bSkettenis 	char *s = (char *)(h1 + o1);
261352f7f3bSkettenis 	char *d = (char *)(h2 + o2);
262352f7f3bSkettenis 
263352f7f3bSkettenis 	while (c--)
264352f7f3bSkettenis 		*d++ = *s++;
265352f7f3bSkettenis }
266352f7f3bSkettenis 
267352f7f3bSkettenis 
268352f7f3bSkettenis 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)269352f7f3bSkettenis bus_space_copy_2(void *v, bus_space_handle_t h1, bus_size_t o1,
270352f7f3bSkettenis 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
271352f7f3bSkettenis {
272352f7f3bSkettenis 	short *s = (short *)(h1 + o1);
273352f7f3bSkettenis 	short *d = (short *)(h2 + o2);
274352f7f3bSkettenis 
275352f7f3bSkettenis 	while (c--)
276352f7f3bSkettenis 		*d++ = *s++;
277352f7f3bSkettenis }
278352f7f3bSkettenis 
279352f7f3bSkettenis 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)280352f7f3bSkettenis bus_space_copy_4(void *v, bus_space_handle_t h1, bus_size_t o1,
281352f7f3bSkettenis 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
282352f7f3bSkettenis {
283352f7f3bSkettenis 	int *s = (int *)(h1 + o1);
284352f7f3bSkettenis 	int *d = (int *)(h2 + o2);
285352f7f3bSkettenis 
286352f7f3bSkettenis 	while (c--)
287352f7f3bSkettenis 		*d++ = *s++;
288352f7f3bSkettenis }
289352f7f3bSkettenis 
290352f7f3bSkettenis 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)291352f7f3bSkettenis bus_space_copy_8(void *v, bus_space_handle_t h1, bus_size_t o1,
292352f7f3bSkettenis 	bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
293352f7f3bSkettenis {
294352f7f3bSkettenis 	int64_t *s = (int64_t *)(h1 + o1);
295352f7f3bSkettenis 	int64_t *d = (int64_t *)(h2 + o2);
296352f7f3bSkettenis 
297352f7f3bSkettenis 	while (c--)
298352f7f3bSkettenis 		*d++ = *s++;
299352f7f3bSkettenis }
300352f7f3bSkettenis 
301352f7f3bSkettenis /*----------------------------------------------------------------------------*/
302352f7f3bSkettenis /*
303352f7f3bSkettenis  * Bus read/write barrier methods.
304352f7f3bSkettenis  *
305352f7f3bSkettenis  *	void bus_space_barrier(bus_space_tag_t tag,
306352f7f3bSkettenis  *	    bus_space_handle_t bsh, bus_size_t offset,
307352f7f3bSkettenis  *	    bus_size_t len, int flags);
308352f7f3bSkettenis  *
309352f7f3bSkettenis  */
310352f7f3bSkettenis 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)311352f7f3bSkettenis bus_space_barrier(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset,
312352f7f3bSkettenis     bus_size_t length, int flags)
313352f7f3bSkettenis {
314352f7f3bSkettenis 	__asm__ volatile ("eieio" ::: "memory");
315352f7f3bSkettenis }
316352f7f3bSkettenis #define BUS_SPACE_BARRIER_READ  0x01		/* force read barrier */
317352f7f3bSkettenis #define BUS_SPACE_BARRIER_WRITE 0x02		/* force write barrier */
318352f7f3bSkettenis 
319352f7f3bSkettenis #define	BUS_DMA_WAITOK		0x0000
320352f7f3bSkettenis #define	BUS_DMA_NOWAIT		0x0001
321352f7f3bSkettenis #define	BUS_DMA_ALLOCNOW	0x0002
322352f7f3bSkettenis #define	BUS_DMA_COHERENT	0x0008
323352f7f3bSkettenis #define	BUS_DMA_BUS1		0x0010	/* placeholders for bus functions... */
324352f7f3bSkettenis #define	BUS_DMA_BUS2		0x0020
325352f7f3bSkettenis #define	BUS_DMA_BUS3		0x0040
326352f7f3bSkettenis #define	BUS_DMA_BUS4		0x0080
327352f7f3bSkettenis #define	BUS_DMA_READ		0x0100	/* mapping is device -> memory only */
328352f7f3bSkettenis #define	BUS_DMA_WRITE		0x0200	/* mapping is memory -> device only */
329352f7f3bSkettenis #define	BUS_DMA_STREAMING	0x0400	/* hint: sequential, unidirectional */
330352f7f3bSkettenis #define	BUS_DMA_ZERO		0x0800	/* zero memory in dmamem_alloc */
331352f7f3bSkettenis #define	BUS_DMA_NOCACHE		0x1000
332352f7f3bSkettenis #define	BUS_DMA_64BIT		0x2000	/* device handles 64bit dva */
333352f7f3bSkettenis 
334352f7f3bSkettenis /* Forwards needed by prototypes below. */
335352f7f3bSkettenis struct mbuf;
336352f7f3bSkettenis struct proc;
337352f7f3bSkettenis struct uio;
338352f7f3bSkettenis 
339352f7f3bSkettenis #define	BUS_DMASYNC_POSTREAD	0x0001
340352f7f3bSkettenis #define BUS_DMASYNC_POSTWRITE	0x0002
341352f7f3bSkettenis #define BUS_DMASYNC_PREREAD	0x0004
342352f7f3bSkettenis #define BUS_DMASYNC_PREWRITE	0x0008
343352f7f3bSkettenis 
344352f7f3bSkettenis typedef struct machine_bus_dma_tag	*bus_dma_tag_t;
345352f7f3bSkettenis typedef struct machine_bus_dmamap	*bus_dmamap_t;
346352f7f3bSkettenis 
347352f7f3bSkettenis /*
348352f7f3bSkettenis  *	bus_dma_segment_t
349352f7f3bSkettenis  *
350352f7f3bSkettenis  *	Describes a single contiguous DMA transaction.  Values
351352f7f3bSkettenis  *	are suitable for programming into DMA registers.
352352f7f3bSkettenis  */
353352f7f3bSkettenis struct machine_bus_dma_segment {
354352f7f3bSkettenis 	bus_addr_t	ds_addr;	/* DMA address */
355352f7f3bSkettenis 	bus_size_t	ds_len;		/* length of transfer */
356352f7f3bSkettenis 
357352f7f3bSkettenis 	paddr_t		_ds_paddr;	/* CPU address */
358352f7f3bSkettenis 	vaddr_t		_ds_vaddr;	/* CPU address */
359352f7f3bSkettenis };
360352f7f3bSkettenis typedef struct machine_bus_dma_segment	bus_dma_segment_t;
361352f7f3bSkettenis 
362352f7f3bSkettenis /*
363352f7f3bSkettenis  *	bus_dma_tag_t
364352f7f3bSkettenis  *
365352f7f3bSkettenis  *	A machine-dependent opaque type describing the implementation of
366352f7f3bSkettenis  *	DMA for a given bus.
367352f7f3bSkettenis  */
368352f7f3bSkettenis 
369352f7f3bSkettenis struct machine_bus_dma_tag {
370352f7f3bSkettenis 	void	*_cookie;		/* cookie used in the guts */
371352f7f3bSkettenis 	int	_flags;			/* misc. flags */
372352f7f3bSkettenis 
373352f7f3bSkettenis 	/*
374352f7f3bSkettenis 	 * DMA mapping methods.
375352f7f3bSkettenis 	 */
376352f7f3bSkettenis 	int	(*_dmamap_create)(bus_dma_tag_t , bus_size_t, int,
377352f7f3bSkettenis 		    bus_size_t, bus_size_t, int, bus_dmamap_t *);
378352f7f3bSkettenis 	void	(*_dmamap_destroy)(bus_dma_tag_t , bus_dmamap_t);
379352f7f3bSkettenis 	int	(*_dmamap_load)(bus_dma_tag_t , bus_dmamap_t, void *,
380352f7f3bSkettenis 		    bus_size_t, struct proc *, int);
381352f7f3bSkettenis 	int	(*_dmamap_load_mbuf)(bus_dma_tag_t , bus_dmamap_t,
382352f7f3bSkettenis 		    struct mbuf *, int);
383352f7f3bSkettenis 	int	(*_dmamap_load_uio)(bus_dma_tag_t , bus_dmamap_t,
384352f7f3bSkettenis 		    struct uio *, int);
385352f7f3bSkettenis 	int	(*_dmamap_load_raw)(bus_dma_tag_t , bus_dmamap_t,
386352f7f3bSkettenis 		    bus_dma_segment_t *, int, bus_size_t, int);
387352f7f3bSkettenis 	int	(*_dmamap_load_buffer)(bus_dma_tag_t, bus_dmamap_t, void *,
388352f7f3bSkettenis 		    bus_size_t, struct proc *, int, paddr_t *, int *, int);
389352f7f3bSkettenis 	void	(*_dmamap_unload)(bus_dma_tag_t , bus_dmamap_t);
390352f7f3bSkettenis 	void	(*_dmamap_sync)(bus_dma_tag_t , bus_dmamap_t,
391352f7f3bSkettenis 		    bus_addr_t, bus_size_t, int);
392352f7f3bSkettenis 
393352f7f3bSkettenis 	/*
394352f7f3bSkettenis 	 * DMA memory utility functions.
395352f7f3bSkettenis 	 */
396352f7f3bSkettenis 	int	(*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
397352f7f3bSkettenis 		    bus_size_t, bus_dma_segment_t *, int, int *, int);
398352f7f3bSkettenis 	void	(*_dmamem_free)(bus_dma_tag_t, bus_dma_segment_t *, int);
399352f7f3bSkettenis 	int	(*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
400352f7f3bSkettenis 		    int, size_t, caddr_t *, int);
401352f7f3bSkettenis 	void	(*_dmamem_unmap)(bus_dma_tag_t, caddr_t, size_t);
402352f7f3bSkettenis 	paddr_t	(*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
403352f7f3bSkettenis 		    int, off_t, int, int);
404352f7f3bSkettenis 
405352f7f3bSkettenis 	/*
406352f7f3bSkettenis 	 * internal memory address translation information.
407352f7f3bSkettenis 	 */
408352f7f3bSkettenis 	bus_addr_t _dma_mask;
409352f7f3bSkettenis };
410352f7f3bSkettenis 
411352f7f3bSkettenis #define	bus_dmamap_create(t, s, n, m, b, f, p)			\
412352f7f3bSkettenis 	(*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p))
413352f7f3bSkettenis #define	bus_dmamap_destroy(t, p)				\
414352f7f3bSkettenis 	(*(t)->_dmamap_destroy)((t), (p))
415352f7f3bSkettenis #define	bus_dmamap_load(t, m, b, s, p, f)			\
416352f7f3bSkettenis 	(*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f))
417352f7f3bSkettenis #define	bus_dmamap_load_mbuf(t, m, b, f)			\
418352f7f3bSkettenis 	(*(t)->_dmamap_load_mbuf)((t), (m), (b), (f))
419352f7f3bSkettenis #define	bus_dmamap_load_uio(t, m, u, f)				\
420352f7f3bSkettenis 	(*(t)->_dmamap_load_uio)((t), (m), (u), (f))
421352f7f3bSkettenis #define	bus_dmamap_load_raw(t, m, sg, n, s, f)			\
422352f7f3bSkettenis 	(*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f))
423352f7f3bSkettenis #define	bus_dmamap_unload(t, p)					\
424352f7f3bSkettenis 	(*(t)->_dmamap_unload)((t), (p))
425352f7f3bSkettenis #define	bus_dmamap_sync(t, p, a, l, o)				\
426352f7f3bSkettenis 	(void)((t)->_dmamap_sync ?				\
427352f7f3bSkettenis 	    (*(t)->_dmamap_sync)((t), (p), (a), (l), (o)) : (void)0)
428352f7f3bSkettenis 
429352f7f3bSkettenis #define	bus_dmamem_alloc(t, s, a, b, sg, n, r, f)		\
430352f7f3bSkettenis 	(*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f))
431352f7f3bSkettenis #define	bus_dmamem_free(t, sg, n)				\
432352f7f3bSkettenis 	(*(t)->_dmamem_free)((t), (sg), (n))
433352f7f3bSkettenis #define	bus_dmamem_map(t, sg, n, s, k, f)			\
434352f7f3bSkettenis 	(*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f))
435352f7f3bSkettenis #define	bus_dmamem_unmap(t, k, s)				\
436352f7f3bSkettenis 	(*(t)->_dmamem_unmap)((t), (k), (s))
437352f7f3bSkettenis #define	bus_dmamem_mmap(t, sg, n, o, p, f)			\
438352f7f3bSkettenis 	(*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f))
439352f7f3bSkettenis 
440352f7f3bSkettenis int	_dmamap_create(bus_dma_tag_t, bus_size_t, int,
441352f7f3bSkettenis 	    bus_size_t, bus_size_t, int, bus_dmamap_t *);
442352f7f3bSkettenis void	_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t);
443352f7f3bSkettenis int	_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *,
444352f7f3bSkettenis 	    bus_size_t, struct proc *, int);
445352f7f3bSkettenis int	_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t, struct mbuf *, int);
446352f7f3bSkettenis int	_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t, struct uio *, int);
447352f7f3bSkettenis int	_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t,
448352f7f3bSkettenis 	    bus_dma_segment_t *, int, bus_size_t, int);
449352f7f3bSkettenis int	_dmamap_load_buffer(bus_dma_tag_t, bus_dmamap_t, void *,
450352f7f3bSkettenis 	    bus_size_t, struct proc *, int, paddr_t *, int *, int);
451352f7f3bSkettenis void	_dmamap_unload(bus_dma_tag_t, bus_dmamap_t);
452352f7f3bSkettenis void	_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
453352f7f3bSkettenis 	    bus_size_t, int);
454352f7f3bSkettenis 
455352f7f3bSkettenis int	_dmamem_alloc(bus_dma_tag_t, bus_size_t, bus_size_t,
456352f7f3bSkettenis 	    bus_size_t, bus_dma_segment_t *, int, int *, int);
457352f7f3bSkettenis void	_dmamem_free(bus_dma_tag_t, bus_dma_segment_t *, int);
458352f7f3bSkettenis int	_dmamem_map(bus_dma_tag_t, bus_dma_segment_t *,
459352f7f3bSkettenis 	    int, size_t, caddr_t *, int);
460352f7f3bSkettenis void	_dmamem_unmap(bus_dma_tag_t, caddr_t, size_t);
461352f7f3bSkettenis paddr_t	_dmamem_mmap(bus_dma_tag_t, bus_dma_segment_t *, int, off_t, int, int);
462352f7f3bSkettenis int	_dmamem_alloc_range(bus_dma_tag_t, bus_size_t, bus_size_t, bus_size_t,
463352f7f3bSkettenis 	    bus_dma_segment_t *, int, int *, int, paddr_t, paddr_t);
464352f7f3bSkettenis 
465352f7f3bSkettenis /*
466352f7f3bSkettenis  *	bus_dmamap_t
467352f7f3bSkettenis  *
468352f7f3bSkettenis  *	Describes a DMA mapping.
469352f7f3bSkettenis  */
470352f7f3bSkettenis struct machine_bus_dmamap {
471352f7f3bSkettenis 	/*
472352f7f3bSkettenis 	 * PRIVATE MEMBERS: not for use by machine-independent code.
473352f7f3bSkettenis 	 */
474352f7f3bSkettenis 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
475352f7f3bSkettenis 	int		_dm_segcnt;	/* number of segs this map can map */
476352f7f3bSkettenis 	bus_size_t	_dm_maxsegsz;	/* largest possible segment */
477352f7f3bSkettenis 	bus_size_t	_dm_boundary;	/* don't cross this */
478352f7f3bSkettenis 	int		_dm_flags;	/* misc. flags */
479352f7f3bSkettenis 
480352f7f3bSkettenis 	void		*_dm_cookie;	/* cookie for bus-specific functions */
481352f7f3bSkettenis 
482352f7f3bSkettenis 	/*
483352f7f3bSkettenis 	 * PUBLIC MEMBERS: these are used by machine-independent code.
484352f7f3bSkettenis 	 */
485352f7f3bSkettenis 	bus_size_t	dm_mapsize;	/* size of the mapping */
486352f7f3bSkettenis 	int		dm_nsegs;	/* # valid segments in mapping */
487352f7f3bSkettenis 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
488352f7f3bSkettenis };
489352f7f3bSkettenis 
490352f7f3bSkettenis int	generic_space_map(bus_space_tag_t, bus_addr_t, bus_size_t, int,
491352f7f3bSkettenis 	    bus_space_handle_t *);
492352f7f3bSkettenis void	generic_space_unmap(bus_space_tag_t, bus_space_handle_t, bus_size_t);
493352f7f3bSkettenis int	generic_space_region(bus_space_tag_t, bus_space_handle_t, bus_size_t,
494352f7f3bSkettenis 	    bus_size_t, bus_space_handle_t *);
495352f7f3bSkettenis void	*generic_space_vaddr(bus_space_tag_t, bus_space_handle_t);
496352f7f3bSkettenis paddr_t	generic_space_mmap(bus_space_tag_t, bus_addr_t, off_t, int, int);
497352f7f3bSkettenis uint8_t generic_space_read_1(bus_space_tag_t, bus_space_handle_t, bus_size_t);
498352f7f3bSkettenis uint16_t generic_space_read_2(bus_space_tag_t, bus_space_handle_t, bus_size_t);
499352f7f3bSkettenis uint32_t generic_space_read_4(bus_space_tag_t, bus_space_handle_t, bus_size_t);
500352f7f3bSkettenis uint64_t generic_space_read_8(bus_space_tag_t, bus_space_handle_t, bus_size_t);
501352f7f3bSkettenis void	generic_space_write_1(bus_space_tag_t, bus_space_handle_t, bus_size_t,
502352f7f3bSkettenis 	    uint8_t);
503352f7f3bSkettenis void	generic_space_write_2(bus_space_tag_t, bus_space_handle_t, bus_size_t,
504352f7f3bSkettenis 	    uint16_t);
505352f7f3bSkettenis void	generic_space_write_4(bus_space_tag_t, bus_space_handle_t, bus_size_t,
506352f7f3bSkettenis 	    uint32_t);
507352f7f3bSkettenis void	generic_space_write_8(bus_space_tag_t, bus_space_handle_t, bus_size_t,
508352f7f3bSkettenis 	    uint64_t);
509352f7f3bSkettenis void	generic_space_read_raw_2(bus_space_tag_t, bus_space_handle_t,
510352f7f3bSkettenis 	    bus_addr_t, uint8_t *, bus_size_t);
511352f7f3bSkettenis void	generic_space_write_raw_2(bus_space_tag_t, bus_space_handle_t,
512352f7f3bSkettenis 	    bus_addr_t, const uint8_t *, bus_size_t);
513352f7f3bSkettenis void	generic_space_read_raw_4(bus_space_tag_t, bus_space_handle_t,
514352f7f3bSkettenis 	    bus_addr_t, uint8_t *, bus_size_t);
515352f7f3bSkettenis void	generic_space_write_raw_4(bus_space_tag_t, bus_space_handle_t,
516352f7f3bSkettenis 	    bus_addr_t, const uint8_t *, bus_size_t);
517352f7f3bSkettenis void	generic_space_read_raw_8(bus_space_tag_t, bus_space_handle_t,
518352f7f3bSkettenis 	    bus_addr_t, uint8_t *, bus_size_t);
519352f7f3bSkettenis void	generic_space_write_raw_8(bus_space_tag_t, bus_space_handle_t,
520352f7f3bSkettenis 	    bus_addr_t, const uint8_t *, bus_size_t);
521352f7f3bSkettenis 
522352f7f3bSkettenis uint16_t little_space_read_2(bus_space_tag_t, bus_space_handle_t, bus_size_t);
523352f7f3bSkettenis uint32_t little_space_read_4(bus_space_tag_t, bus_space_handle_t, bus_size_t);
524352f7f3bSkettenis uint64_t little_space_read_8(bus_space_tag_t, bus_space_handle_t, bus_size_t);
525352f7f3bSkettenis void	little_space_write_2(bus_space_tag_t, bus_space_handle_t, bus_size_t,
526352f7f3bSkettenis 	    uint16_t);
527352f7f3bSkettenis void	little_space_write_4(bus_space_tag_t, bus_space_handle_t, bus_size_t,
528352f7f3bSkettenis 	    uint32_t);
529352f7f3bSkettenis void	little_space_write_8(bus_space_tag_t, bus_space_handle_t, bus_size_t,
530352f7f3bSkettenis 	    uint64_t);
5318c07258aSkettenis 
53213861200Skettenis #endif /* _MACHINE_BUS_H_ */
533