6acedd5e420a9d978d25023f5dedf3d41342db4f
[dragonfly.git] / sys / sys / bus_dma.h
1 /*-
2  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to The NetBSD Foundation
6  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
7  * NASA Ames Research Center.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by the NetBSD
20  *      Foundation, Inc. and its contributors.
21  * 4. Neither the name of The NetBSD Foundation nor the names of its
22  *    contributors may be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 /*
38  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
39  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  * 3. All advertising materials mentioning features or use of this software
50  *    must display the following acknowledgement:
51  *      This product includes software developed by Christopher G. Demetriou
52  *      for the NetBSD Project.
53  * 4. The name of the author may not be used to endorse or promote products
54  *    derived from this software without specific prior written permission
55  *
56  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
57  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
58  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
59  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
60  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
61  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
62  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
63  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
64  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
65  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66  */
67 /*
68  * $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $
69  * $FreeBSD: src/sys/i386/include/bus_dma.h,v 1.15.2.2 2002/11/21 23:36:01 sam Exp $
70  * $DragonFly: src/sys/sys/bus_dma.h,v 1.1 2006/10/25 20:56:03 dillon Exp $
71  */
72
73 #ifndef _SYS_BUS_DMA_H_
74 #define _SYS_BUS_DMA_H_
75
76 /*
77  * Include machine-specific bus stuff
78  */
79 #ifndef _MACHINE_BUS_DMA_H_
80 #include <machine/bus_dma.h>    /* bus_addr_t */
81 #endif
82
83 /*
84  * Flags used in various bus DMA methods.
85  */
86 #define BUS_DMA_WAITOK          0x0000  /* safe to sleep (pseudo-flag) */
87 #define BUS_DMA_NOWAIT          0x0001  /* not safe to sleep */
88 #define BUS_DMA_ALLOCNOW        0x0002  /* perform resource allocation now */
89 #define BUS_DMA_COHERENT        0x0004  /* map memory to not require sync */
90 #define BUS_DMA_ZERO            0x0008  /* allocate zero'ed memory */
91 #define BUS_DMA_BUS1            0x0010  /* placeholders for bus functions... */
92 #define BUS_DMA_BUS2            0x0020
93 #define BUS_DMA_BUS3            0x0040
94 #define BUS_DMA_BUS4            0x0080
95 #define BUS_DMA_ONEBPAGE        0x0100  /* allocate one bpage per map at most */
96 #define BUS_DMA_ALIGNED         0x0200  /* no bpage should be allocated due to
97                                          * alignment requirement; all to-be-
98                                          * loaded memory is properly aligned */
99 #define BUS_DMA_PRIVBZONE       0x0400  /* need private bounce zone */
100 #define BUS_DMA_ALLOCALL        0x0800  /* allocate all needed resources */
101
102 /* Forwards needed by prototypes below. */
103 struct mbuf;
104 struct uio;
105
106 /*
107  *      bus_dmasync_op_t
108  *
109  *      Operations performed by bus_dmamap_sync().
110  */
111 typedef enum {
112         BUS_DMASYNC_PREREAD,
113         BUS_DMASYNC_POSTREAD,
114         BUS_DMASYNC_PREWRITE,
115         BUS_DMASYNC_POSTWRITE
116 } bus_dmasync_op_t;
117
118 /*
119  *      bus_dma_tag_t
120  *
121  *      A machine-dependent opaque type describing the characteristics
122  *      of how to perform DMA mappings.  This structure encapsultes
123  *      information concerning address and alignment restrictions, number
124  *      of S/G  segments, amount of data per S/G segment, etc.
125  */
126 typedef struct bus_dma_tag      *bus_dma_tag_t;
127
128 /*
129  *      bus_dmamap_t
130  *
131  *      DMA mapping instance information.
132  */
133 typedef struct bus_dmamap       *bus_dmamap_t;
134
135 /*
136  *      bus_dma_segment_t
137  *
138  *      Describes a single contiguous DMA transaction.  Values
139  *      are suitable for programming into DMA registers.
140  */
141 typedef struct bus_dma_segment {
142         bus_addr_t      ds_addr;        /* DMA address */
143         bus_size_t      ds_len;         /* length of transfer */
144 } bus_dma_segment_t;
145
146 typedef struct bus_dmamem {
147         bus_dma_tag_t   dmem_tag;
148         bus_dmamap_t    dmem_map;
149         void            *dmem_addr;
150         bus_addr_t      dmem_busaddr;
151 } bus_dmamem_t;
152
153 /*
154  * A function that returns 1 if the address cannot be accessed by
155  * a device and 0 if it can be.
156  */
157 typedef int bus_dma_filter_t(void *, bus_addr_t);
158
159 /*
160  * Allocate a device specific dma_tag encapsulating the constraints of
161  * the parent tag in addition to other restrictions specified:
162  *
163  *      alignment:      alignment for segments.
164  *      boundary:       Boundary that segments cannot cross.
165  *      lowaddr:        Low restricted address that cannot appear in a mapping.
166  *      highaddr:       High restricted address that cannot appear in a mapping.
167  *      filtfunc:       An optional function to further test if an address
168  *                      within the range of lowaddr and highaddr cannot appear
169  *                      in a mapping.
170  *      filtfuncarg:    An argument that will be passed to filtfunc in addition
171  *                      to the address to test.
172  *      maxsize:        Maximum mapping size supported by this tag.
173  *      nsegments:      Number of discontinuities allowed in maps.
174  *      maxsegsz:       Maximum size of a segment in the map.
175  *      flags:          Bus DMA flags.
176  *      dmat:           A pointer to set to a valid dma tag should the return
177  *                      value of this function indicate success.
178  */
179 /* XXX Should probably allow specification of alignment */
180 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
181                        bus_size_t boundary, bus_addr_t lowaddr,
182                        bus_addr_t highaddr, bus_dma_filter_t *filtfunc,
183                        void *filtfuncarg, bus_size_t maxsize, int nsegments,
184                        bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat);
185
186 int bus_dma_tag_destroy(bus_dma_tag_t dmat);
187 bus_size_t bus_dma_tag_getmaxsize(bus_dma_tag_t tag);
188
189 /*
190  * Allocate a handle for mapping from kva/uva/physical
191  * address space into bus device space.
192  */
193 int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
194
195 /*
196  * Destroy  a handle for mapping from kva/uva/physical
197  * address space into bus device space.
198  */
199 int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map);
200
201 /*
202  * Allocate a piece of memory that can be efficiently mapped into
203  * bus device space based on the constraints lited in the dma tag.
204  * A dmamap to for use with dmamap_load is also allocated.
205  */
206 int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
207                      bus_dmamap_t *mapp);
208
209 /*
210  * Free a piece of memory and it's allociated dmamap, that was allocated
211  * via bus_dmamem_alloc.
212  */
213 void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
214
215 /*
216  * A function that processes a successfully loaded dma map or an error
217  * from a delayed load map.
218  */
219 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
220
221 /*
222  * Map the buffer buf into bus space using the dmamap map.
223  */
224 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
225                     bus_size_t buflen, bus_dmamap_callback_t *callback,
226                     void *callback_arg, int flags);
227
228 /*
229  * Like bus_dmamap_callback but includes map size in bytes.  This is
230  * defined as a separate interface to maintain compatiiblity for users
231  * of bus_dmamap_callback_t--at some point these interfaces should be merged.
232  */
233 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int);
234 /*
235  * Like bus_dmamap_load but for mbufs.  Note the use of the
236  * bus_dmamap_callback2_t interface.
237  */
238 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
239                          struct mbuf *mbuf,
240                          bus_dmamap_callback2_t *callback, void *callback_arg,
241                          int flags);
242 /*
243  * Like bus_dmamap_load but for uios.  Note the use of the
244  * bus_dmamap_callback2_t interface.
245  */
246 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
247                         struct uio *ui,
248                         bus_dmamap_callback2_t *callback, void *callback_arg,
249                         int flags);
250
251 /*
252  * Like bus_dmamap_load_mbuf without callback.
253  * Segmentation information are saved in 'segs' and 'nsegs' if
254  * the loading is successful.  'maxsegs' must be set by caller
255  * and must be at least 1 but less than 'dmat' nsegment.  It
256  * indicates the number of elements in 'segs'.  'flags' must
257  * have BUS_DMA_NOWAIT turned on.
258  */
259 int
260 bus_dmamap_load_mbuf_segment(bus_dma_tag_t dmat, bus_dmamap_t map,
261                              struct mbuf *mbuf,
262                              bus_dma_segment_t *segs, int maxsegs,
263                              int *nsegs, int flags);
264
265 /*
266  * Like bus_dmamap_load_mbuf_segment, but it will call m_defrag()
267  * and try reloading if low level code indicates too many fragments
268  * in the '*mbuf'; 'mbuf' will be updated under this situation.
269  */
270 int
271 bus_dmamap_load_mbuf_defrag(bus_dma_tag_t dmat, bus_dmamap_t map,
272                             struct mbuf **mbuf,
273                             bus_dma_segment_t *segs, int maxsegs,
274                             int *nsegs, int flags);
275
276 /*
277  * Convenient function to create coherent busdma memory
278  */
279 int
280 bus_dmamem_coherent(bus_dma_tag_t parent,
281                     bus_size_t alignment, bus_size_t boundary,
282                     bus_addr_t lowaddr, bus_addr_t highaddr,
283                     bus_size_t maxsize, int flags,
284                     bus_dmamem_t *dmem);
285
286 /*
287  * Simplified version of bus_dmamem_coherent() with:
288  * boundary == 0
289  * lowaddr  == BUS_SPACE_MAXADDR
290  * highaddr == BUS_SPACE_MAXADDR
291  *
292  * 'parent' usually should not be NULL, so we could inherit
293  * boundary, lowaddr and highaddr from it.
294  */
295 void *
296 bus_dmamem_coherent_any(bus_dma_tag_t parent, bus_size_t alignment,
297                         bus_size_t maxsize, int flags,
298                         bus_dma_tag_t *dtag, bus_dmamap_t *dmap,
299                         bus_addr_t *busaddr);
300
301 /*
302  * Perform a syncronization operation on the given map.
303  */
304 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_dmasync_op_t);
305 #define bus_dmamap_sync(dmat, dmamap, op)               \
306         if ((dmamap) != NULL)                           \
307                 _bus_dmamap_sync(dmat, dmamap, op)
308
309 /*
310  * Release the mapping held by map.
311  */
312 void _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map);
313 #define bus_dmamap_unload(dmat, dmamap)                 \
314         if ((dmamap) != NULL)                           \
315                 _bus_dmamap_unload(dmat, dmamap)
316
317 #endif /* _SYS_BUS_DMA_H_ */