2003-07-22 Hiten Pandya <hmp@nxad.com>
[dragonfly.git] / sys / i386 / include / bus_dma.h
1 /*      $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $    */
2
3 /*-
4  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed by the NetBSD
22  *      Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39
40 /*
41  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
42  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *      This product includes software developed by Christopher G. Demetriou
55  *      for the NetBSD Project.
56  * 4. The name of the author may not be used to endorse or promote products
57  *    derived from this software without specific prior written permission
58  *
59  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
60  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
61  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
62  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
63  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
64  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
65  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
66  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
67  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
68  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
69  */
70 /* $FreeBSD: src/sys/i386/include/bus_dma.h,v 1.15.2.2 2002/11/21 23:36:01 sam Exp $ */
71 /* $DragonFly: src/sys/i386/include/Attic/bus_dma.h,v 1.3 2003/07/23 07:14:15 dillon Exp $ */
72
73 #ifndef _I386_BUS_DMA_H_
74 #define _I386_BUS_DMA_H_
75
76 /*
77  * Flags used in various bus DMA methods.
78  */
79 #define BUS_DMA_WAITOK          0x00    /* safe to sleep (pseudo-flag) */
80 #define BUS_DMA_NOWAIT          0x01    /* not safe to sleep */
81 #define BUS_DMA_ALLOCNOW        0x02    /* perform resource allocation now */
82 #define BUS_DMA_COHERENT        0x04    /* map memory to not require sync */
83 #define BUS_DMA_BUS1            0x10    /* placeholders for bus functions... */
84 #define BUS_DMA_BUS2            0x20
85 #define BUS_DMA_BUS3            0x40
86 #define BUS_DMA_BUS4            0x80
87
88 /* Forwards needed by prototypes below. */
89 struct mbuf;
90 struct uio;
91
92 /*
93  *      bus_dmasync_op_t
94  *
95  *      Operations performed by bus_dmamap_sync().
96  */
97 typedef enum {
98         BUS_DMASYNC_PREREAD,
99         BUS_DMASYNC_POSTREAD,
100         BUS_DMASYNC_PREWRITE,
101         BUS_DMASYNC_POSTWRITE
102 } bus_dmasync_op_t;
103
104 /*
105  *      bus_dma_tag_t
106  *
107  *      A machine-dependent opaque type describing the characteristics
108  *      of how to perform DMA mappings.  This structure encapsultes
109  *      information concerning address and alignment restrictions, number
110  *      of S/G  segments, amount of data per S/G segment, etc.
111  */
112 typedef struct bus_dma_tag      *bus_dma_tag_t;
113
114 /*
115  *      bus_dmamap_t
116  *
117  *      DMA mapping instance information.
118  */
119 typedef struct bus_dmamap       *bus_dmamap_t;
120
121 /*
122  *      bus_dma_segment_t
123  *
124  *      Describes a single contiguous DMA transaction.  Values
125  *      are suitable for programming into DMA registers.
126  */
127 typedef struct bus_dma_segment {
128         bus_addr_t      ds_addr;        /* DMA address */
129         bus_size_t      ds_len;         /* length of transfer */
130 } bus_dma_segment_t;
131
132 /*
133  * A function that returns 1 if the address cannot be accessed by
134  * a device and 0 if it can be.
135  */
136 typedef int bus_dma_filter_t(void *, bus_addr_t);
137
138 /*
139  * Allocate a device specific dma_tag encapsulating the constraints of
140  * the parent tag in addition to other restrictions specified:
141  *
142  *      alignment:      alignment for segments.
143  *      boundary:       Boundary that segments cannot cross.
144  *      lowaddr:        Low restricted address that cannot appear in a mapping.
145  *      highaddr:       High restricted address that cannot appear in a mapping.
146  *      filtfunc:       An optional function to further test if an address
147  *                      within the range of lowaddr and highaddr cannot appear
148  *                      in a mapping.
149  *      filtfuncarg:    An argument that will be passed to filtfunc in addition
150  *                      to the address to test.
151  *      maxsize:        Maximum mapping size supported by this tag.
152  *      nsegments:      Number of discontinuities allowed in maps.
153  *      maxsegsz:       Maximum size of a segment in the map.
154  *      flags:          Bus DMA flags.
155  *      dmat:           A pointer to set to a valid dma tag should the return
156  *                      value of this function indicate success.
157  */
158 /* XXX Should probably allow specification of alignment */
159 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
160                        bus_size_t boundary, bus_addr_t lowaddr,
161                        bus_addr_t highaddr, bus_dma_filter_t *filtfunc,
162                        void *filtfuncarg, bus_size_t maxsize, int nsegments,
163                        bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat);
164
165 int bus_dma_tag_destroy(bus_dma_tag_t dmat);
166
167 /*
168  * Allocate a handle for mapping from kva/uva/physical
169  * address space into bus device space.
170  */
171 int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
172
173 /*
174  * Destroy  a handle for mapping from kva/uva/physical
175  * address space into bus device space.
176  */
177 int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map);
178
179 /*
180  * Allocate a piece of memory that can be efficiently mapped into
181  * bus device space based on the constraints lited in the dma tag.
182  * A dmamap to for use with dmamap_load is also allocated.
183  */
184 int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
185                      bus_dmamap_t *mapp);
186
187 /*
188  * Free a piece of memory and it's allociated dmamap, that was allocated
189  * via bus_dmamem_alloc.
190  */
191 void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
192
193 /*
194  * A function that processes a successfully loaded dma map or an error
195  * from a delayed load map.
196  */
197 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
198
199 /*
200  * Map the buffer buf into bus space using the dmamap map.
201  */
202 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
203                     bus_size_t buflen, bus_dmamap_callback_t *callback,
204                     void *callback_arg, int flags);
205
206 /*
207  * Like bus_dmamap_callback but includes map size in bytes.  This is
208  * defined as a separate interface to maintain compatiiblity for users
209  * of bus_dmamap_callback_t--at some point these interfaces should be merged.
210  */
211 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int);
212 /*
213  * Like bus_dmamap_load but for mbufs.  Note the use of the
214  * bus_dmamap_callback2_t interface.
215  */
216 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
217                          struct mbuf *mbuf,
218                          bus_dmamap_callback2_t *callback, void *callback_arg,
219                          int flags);
220 /*
221  * Like bus_dmamap_load but for uios.  Note the use of the
222  * bus_dmamap_callback2_t interface.
223  */
224 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
225                         struct uio *ui,
226                         bus_dmamap_callback2_t *callback, void *callback_arg,
227                         int flags);
228
229 /*
230  * Perform a syncronization operation on the given map.
231  */
232 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_dmasync_op_t);
233 #define bus_dmamap_sync(dmat, dmamap, op)               \
234         if ((dmamap) != NULL)                           \
235                 _bus_dmamap_sync(dmat, dmamap, op)
236
237 /*
238  * Release the mapping held by map.
239  */
240 void _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map);
241 #define bus_dmamap_unload(dmat, dmamap)                 \
242         if ((dmamap) != NULL)                           \
243                 _bus_dmamap_unload(dmat, dmamap)
244
245 #endif /* _I386_BUS_DMA_H_ */