bus_dma.h revision 1.5.2.4 1 1.5.2.4 bouyer /* $NetBSD: bus_dma.h,v 1.5.2.4 2001/03/12 13:29:06 bouyer Exp $ */
2 1.5.2.2 bouyer
3 1.5.2.2 bouyer /*
4 1.5.2.2 bouyer * This file was extracted from from next68k/include/bus.h
5 1.5.2.2 bouyer * and should probably be resynced when needed.
6 1.5.2.2 bouyer * original cvs id: NetBSD: bus_dma.h,v 1.3 1999/08/05 01:50:59 dbj Exp
7 1.5.2.2 bouyer */
8 1.5.2.2 bouyer
9 1.5.2.2 bouyer /*-
10 1.5.2.4 bouyer * Copyright (c) 1997, 1998, 2001 The NetBSD Foundation, Inc.
11 1.5.2.2 bouyer * All rights reserved.
12 1.5.2.2 bouyer *
13 1.5.2.2 bouyer * This code is derived from software contributed to The NetBSD Foundation
14 1.5.2.2 bouyer * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
15 1.5.2.2 bouyer * NASA Ames Research Center.
16 1.5.2.2 bouyer *
17 1.5.2.2 bouyer * Redistribution and use in source and binary forms, with or without
18 1.5.2.2 bouyer * modification, are permitted provided that the following conditions
19 1.5.2.2 bouyer * are met:
20 1.5.2.2 bouyer * 1. Redistributions of source code must retain the above copyright
21 1.5.2.2 bouyer * notice, this list of conditions and the following disclaimer.
22 1.5.2.2 bouyer * 2. Redistributions in binary form must reproduce the above copyright
23 1.5.2.2 bouyer * notice, this list of conditions and the following disclaimer in the
24 1.5.2.2 bouyer * documentation and/or other materials provided with the distribution.
25 1.5.2.2 bouyer * 3. All advertising materials mentioning features or use of this software
26 1.5.2.2 bouyer * must display the following acknowledgement:
27 1.5.2.2 bouyer * This product includes software developed by the NetBSD
28 1.5.2.2 bouyer * Foundation, Inc. and its contributors.
29 1.5.2.2 bouyer * 4. Neither the name of The NetBSD Foundation nor the names of its
30 1.5.2.2 bouyer * contributors may be used to endorse or promote products derived
31 1.5.2.2 bouyer * from this software without specific prior written permission.
32 1.5.2.2 bouyer *
33 1.5.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
34 1.5.2.2 bouyer * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
35 1.5.2.2 bouyer * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
36 1.5.2.2 bouyer * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
37 1.5.2.2 bouyer * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
38 1.5.2.2 bouyer * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
39 1.5.2.2 bouyer * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
40 1.5.2.2 bouyer * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
41 1.5.2.2 bouyer * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42 1.5.2.2 bouyer * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43 1.5.2.2 bouyer * POSSIBILITY OF SUCH DAMAGE.
44 1.5.2.2 bouyer */
45 1.5.2.2 bouyer
46 1.5.2.2 bouyer /*
47 1.5.2.2 bouyer * Copyright (c) 1996 Carnegie-Mellon University.
48 1.5.2.2 bouyer * All rights reserved.
49 1.5.2.2 bouyer *
50 1.5.2.2 bouyer * Author: Chris G. Demetriou
51 1.5.2.2 bouyer *
52 1.5.2.2 bouyer * Permission to use, copy, modify and distribute this software and
53 1.5.2.2 bouyer * its documentation is hereby granted, provided that both the copyright
54 1.5.2.2 bouyer * notice and this permission notice appear in all copies of the
55 1.5.2.2 bouyer * software, derivative works or modified versions, and any portions
56 1.5.2.2 bouyer * thereof, and that both notices appear in supporting documentation.
57 1.5.2.2 bouyer *
58 1.5.2.2 bouyer * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
59 1.5.2.2 bouyer * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
60 1.5.2.2 bouyer * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
61 1.5.2.2 bouyer *
62 1.5.2.2 bouyer * Carnegie Mellon requests users of this software to return to
63 1.5.2.2 bouyer *
64 1.5.2.2 bouyer * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
65 1.5.2.2 bouyer * School of Computer Science
66 1.5.2.2 bouyer * Carnegie Mellon University
67 1.5.2.2 bouyer * Pittsburgh PA 15213-3890
68 1.5.2.2 bouyer *
69 1.5.2.2 bouyer * any improvements or extensions that they make and grant Carnegie the
70 1.5.2.2 bouyer * rights to redistribute these changes.
71 1.5.2.2 bouyer */
72 1.5.2.2 bouyer
73 1.5.2.2 bouyer #ifndef _MVME68K_BUS_DMA_H_
74 1.5.2.2 bouyer #define _MVME68K_BUS_DMA_H_
75 1.5.2.2 bouyer
76 1.5.2.2 bouyer /*
77 1.5.2.2 bouyer * Bus DMA methods.
78 1.5.2.2 bouyer */
79 1.5.2.2 bouyer
80 1.5.2.2 bouyer /*
81 1.5.2.2 bouyer * Flags used in various bus DMA methods.
82 1.5.2.2 bouyer */
83 1.5.2.2 bouyer #define BUS_DMA_WAITOK 0x00 /* safe to sleep (pseudo-flag) */
84 1.5.2.2 bouyer #define BUS_DMA_NOWAIT 0x01 /* not safe to sleep */
85 1.5.2.2 bouyer #define BUS_DMA_ALLOCNOW 0x02 /* perform resource allocation now */
86 1.5.2.2 bouyer #define BUS_DMA_COHERENT 0x04 /* hint: map memory DMA coherent */
87 1.5.2.4 bouyer #define BUS_DMA_STREAMING 0x08 /* hint: sequential, unidirectional */
88 1.5.2.2 bouyer #define BUS_DMA_BUS1 0x10 /* placeholders for bus functions... */
89 1.5.2.2 bouyer #define BUS_DMA_BUS2 0x20
90 1.5.2.2 bouyer #define BUS_DMA_BUS3 0x40
91 1.5.2.2 bouyer #define BUS_DMA_BUS4 0x80
92 1.5.2.2 bouyer
93 1.5.2.2 bouyer /*
94 1.5.2.2 bouyer * Flags to constrain the physical memory allocated for DMA
95 1.5.2.2 bouyer */
96 1.5.2.2 bouyer #define BUS_DMA_ONBOARD_RAM BUS_DMA_BUS1
97 1.5.2.2 bouyer #define BUS_DMA_24BIT BUS_DMA_BUS2
98 1.5.2.2 bouyer
99 1.5.2.2 bouyer /* Forwards needed by prototypes below. */
100 1.5.2.2 bouyer struct mbuf;
101 1.5.2.2 bouyer struct uio;
102 1.5.2.2 bouyer
103 1.5.2.2 bouyer /*
104 1.5.2.2 bouyer * Operations performed by bus_dmamap_sync().
105 1.5.2.2 bouyer */
106 1.5.2.2 bouyer #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */
107 1.5.2.2 bouyer #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */
108 1.5.2.2 bouyer #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */
109 1.5.2.2 bouyer #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */
110 1.5.2.2 bouyer
111 1.5.2.2 bouyer typedef struct mvme68k_bus_dma_tag *bus_dma_tag_t;
112 1.5.2.2 bouyer typedef struct mvme68k_bus_dmamap *bus_dmamap_t;
113 1.5.2.2 bouyer
114 1.5.2.2 bouyer /*
115 1.5.2.2 bouyer * bus_dma_segment_t
116 1.5.2.2 bouyer *
117 1.5.2.2 bouyer * Describes a single contiguous DMA transaction. Values
118 1.5.2.2 bouyer * are suitable for programming into DMA registers.
119 1.5.2.2 bouyer */
120 1.5.2.2 bouyer struct mvme68k_bus_dma_segment {
121 1.5.2.2 bouyer bus_addr_t ds_addr; /* DMA address */
122 1.5.2.2 bouyer bus_size_t ds_len; /* length of transfer */
123 1.5.2.2 bouyer
124 1.5.2.2 bouyer /* PRIVATE */
125 1.5.2.2 bouyer bus_addr_t _ds_cpuaddr; /* CPU-relative phys addr of segment */
126 1.5.2.2 bouyer int _ds_padding;
127 1.5.2.2 bouyer };
128 1.5.2.2 bouyer typedef struct mvme68k_bus_dma_segment bus_dma_segment_t;
129 1.5.2.2 bouyer
130 1.5.2.2 bouyer /*
131 1.5.2.2 bouyer * bus_dma_tag_t
132 1.5.2.2 bouyer *
133 1.5.2.2 bouyer * A machine-dependent opaque type describing the implementation of
134 1.5.2.2 bouyer * DMA for a given bus.
135 1.5.2.2 bouyer */
136 1.5.2.2 bouyer struct mvme68k_bus_dma_tag {
137 1.5.2.2 bouyer void *_cookie; /* cookie used in the guts */
138 1.5.2.2 bouyer
139 1.5.2.2 bouyer /*
140 1.5.2.2 bouyer * DMA mapping methods.
141 1.5.2.2 bouyer */
142 1.5.2.2 bouyer int (*_dmamap_create) __P((bus_dma_tag_t, bus_size_t, int,
143 1.5.2.2 bouyer bus_size_t, bus_size_t, int, bus_dmamap_t *));
144 1.5.2.2 bouyer void (*_dmamap_destroy) __P((bus_dma_tag_t, bus_dmamap_t));
145 1.5.2.2 bouyer int (*_dmamap_load) __P((bus_dma_tag_t, bus_dmamap_t, void *,
146 1.5.2.2 bouyer bus_size_t, struct proc *, int));
147 1.5.2.2 bouyer int (*_dmamap_load_mbuf) __P((bus_dma_tag_t, bus_dmamap_t,
148 1.5.2.2 bouyer struct mbuf *, int));
149 1.5.2.2 bouyer int (*_dmamap_load_uio) __P((bus_dma_tag_t, bus_dmamap_t,
150 1.5.2.2 bouyer struct uio *, int));
151 1.5.2.2 bouyer int (*_dmamap_load_raw) __P((bus_dma_tag_t, bus_dmamap_t,
152 1.5.2.2 bouyer bus_dma_segment_t *, int, bus_size_t, int));
153 1.5.2.2 bouyer void (*_dmamap_unload) __P((bus_dma_tag_t, bus_dmamap_t));
154 1.5.2.2 bouyer void (*_dmamap_sync) __P((bus_dma_tag_t, bus_dmamap_t,
155 1.5.2.2 bouyer bus_addr_t, bus_size_t, int));
156 1.5.2.2 bouyer
157 1.5.2.2 bouyer /*
158 1.5.2.2 bouyer * DMA memory utility functions.
159 1.5.2.2 bouyer */
160 1.5.2.2 bouyer int (*_dmamem_alloc) __P((bus_dma_tag_t, bus_size_t, bus_size_t,
161 1.5.2.2 bouyer bus_size_t, bus_dma_segment_t *, int, int *, int));
162 1.5.2.2 bouyer void (*_dmamem_free) __P((bus_dma_tag_t,
163 1.5.2.2 bouyer bus_dma_segment_t *, int));
164 1.5.2.2 bouyer int (*_dmamem_map) __P((bus_dma_tag_t, bus_dma_segment_t *,
165 1.5.2.2 bouyer int, size_t, caddr_t *, int));
166 1.5.2.2 bouyer void (*_dmamem_unmap) __P((bus_dma_tag_t, caddr_t, size_t));
167 1.5.2.2 bouyer paddr_t (*_dmamem_mmap) __P((bus_dma_tag_t, bus_dma_segment_t *,
168 1.5.2.2 bouyer int, off_t, int, int));
169 1.5.2.2 bouyer };
170 1.5.2.2 bouyer
171 1.5.2.2 bouyer #define bus_dmamap_create(t, s, n, m, b, f, p) \
172 1.5.2.2 bouyer (*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p))
173 1.5.2.2 bouyer #define bus_dmamap_destroy(t, p) \
174 1.5.2.2 bouyer (*(t)->_dmamap_destroy)((t), (p))
175 1.5.2.2 bouyer #define bus_dmamap_load(t, m, b, s, p, f) \
176 1.5.2.2 bouyer (*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f))
177 1.5.2.2 bouyer #define bus_dmamap_load_mbuf(t, m, b, f) \
178 1.5.2.2 bouyer (*(t)->_dmamap_load_mbuf)((t), (m), (b), (f))
179 1.5.2.2 bouyer #define bus_dmamap_load_uio(t, m, u, f) \
180 1.5.2.2 bouyer (*(t)->_dmamap_load_uio)((t), (m), (u), (f))
181 1.5.2.2 bouyer #define bus_dmamap_load_raw(t, m, sg, n, s, f) \
182 1.5.2.2 bouyer (*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f))
183 1.5.2.2 bouyer #define bus_dmamap_unload(t, p) \
184 1.5.2.2 bouyer (*(t)->_dmamap_unload)((t), (p))
185 1.5.2.2 bouyer #define bus_dmamap_sync(t, p, o, l, ops) \
186 1.5.2.2 bouyer (*(t)->_dmamap_sync)((t), (p), (o), (l), (ops))
187 1.5.2.2 bouyer #define bus_dmamem_alloc(t, s, a, b, sg, n, r, f) \
188 1.5.2.2 bouyer (*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f))
189 1.5.2.2 bouyer #define bus_dmamem_free(t, sg, n) \
190 1.5.2.2 bouyer (*(t)->_dmamem_free)((t), (sg), (n))
191 1.5.2.2 bouyer #define bus_dmamem_map(t, sg, n, s, k, f) \
192 1.5.2.2 bouyer (*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f))
193 1.5.2.2 bouyer #define bus_dmamem_unmap(t, k, s) \
194 1.5.2.2 bouyer (*(t)->_dmamem_unmap)((t), (k), (s))
195 1.5.2.2 bouyer #define bus_dmamem_mmap(t, sg, n, o, p, f) \
196 1.5.2.2 bouyer (*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f))
197 1.5.2.2 bouyer
198 1.5.2.2 bouyer /*
199 1.5.2.2 bouyer * bus_dmamap_t
200 1.5.2.2 bouyer *
201 1.5.2.2 bouyer * Describes a DMA mapping.
202 1.5.2.2 bouyer */
203 1.5.2.2 bouyer struct mvme68k_bus_dmamap {
204 1.5.2.2 bouyer /*
205 1.5.2.2 bouyer * PRIVATE MEMBERS: not for use by machine-independent code.
206 1.5.2.2 bouyer */
207 1.5.2.2 bouyer bus_size_t _dm_size; /* largest DMA transfer mappable */
208 1.5.2.2 bouyer int _dm_segcnt; /* number of segs this map can map */
209 1.5.2.2 bouyer bus_size_t _dm_maxsegsz; /* largest possible segment */
210 1.5.2.2 bouyer bus_size_t _dm_boundary; /* don't cross this */
211 1.5.2.2 bouyer int _dm_flags; /* misc. flags */
212 1.5.2.2 bouyer void *_dm_cookie; /* Bus-specific cookie */
213 1.5.2.2 bouyer
214 1.5.2.2 bouyer /*
215 1.5.2.2 bouyer * PUBLIC MEMBERS: these are used by machine-independent code.
216 1.5.2.2 bouyer */
217 1.5.2.2 bouyer bus_size_t dm_mapsize; /* size of the mapping */
218 1.5.2.2 bouyer int dm_nsegs; /* # valid segments in mapping */
219 1.5.2.2 bouyer bus_dma_segment_t dm_segs[1]; /* segments; variable length */
220 1.5.2.2 bouyer };
221 1.5.2.2 bouyer
222 1.5.2.2 bouyer #ifdef _MVME68K_BUS_DMA_PRIVATE
223 1.5.2.2 bouyer int _bus_dmamap_create __P((bus_dma_tag_t, bus_size_t, int, bus_size_t,
224 1.5.2.2 bouyer bus_size_t, int, bus_dmamap_t *));
225 1.5.2.2 bouyer void _bus_dmamap_destroy __P((bus_dma_tag_t, bus_dmamap_t));
226 1.5.2.2 bouyer
227 1.5.2.2 bouyer int _bus_dmamap_load_direct __P((bus_dma_tag_t, bus_dmamap_t,
228 1.5.2.2 bouyer void *, bus_size_t, struct proc *, int));
229 1.5.2.2 bouyer int _bus_dmamap_load_mbuf_direct __P((bus_dma_tag_t,
230 1.5.2.2 bouyer bus_dmamap_t, struct mbuf *, int));
231 1.5.2.2 bouyer int _bus_dmamap_load_uio_direct __P((bus_dma_tag_t,
232 1.5.2.2 bouyer bus_dmamap_t, struct uio *, int));
233 1.5.2.2 bouyer int _bus_dmamap_load_raw_direct __P((bus_dma_tag_t,
234 1.5.2.2 bouyer bus_dmamap_t, bus_dma_segment_t *, int, bus_size_t, int));
235 1.5.2.2 bouyer void _bus_dmamap_unload __P((bus_dma_tag_t, bus_dmamap_t));
236 1.5.2.2 bouyer void _bus_dmamap_sync_030 __P((bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
237 1.5.2.2 bouyer bus_size_t, int));
238 1.5.2.2 bouyer void _bus_dmamap_sync_0460 __P((bus_dma_tag_t, bus_dmamap_t, bus_addr_t,
239 1.5.2.2 bouyer bus_size_t, int));
240 1.5.2.2 bouyer
241 1.5.2.2 bouyer int _bus_dmamem_alloc_common __P((bus_dma_tag_t,
242 1.5.2.2 bouyer bus_addr_t, bus_addr_t, bus_size_t, bus_size_t, bus_size_t,
243 1.5.2.2 bouyer bus_dma_segment_t *, int, int *, int));
244 1.5.2.2 bouyer
245 1.5.2.2 bouyer int _bus_dmamem_alloc __P((bus_dma_tag_t tag, bus_size_t size,
246 1.5.2.2 bouyer bus_size_t alignment, bus_size_t boundary,
247 1.5.2.2 bouyer bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags));
248 1.5.2.2 bouyer void _bus_dmamem_free __P((bus_dma_tag_t tag, bus_dma_segment_t *segs,
249 1.5.2.2 bouyer int nsegs));
250 1.5.2.2 bouyer int _bus_dmamem_map __P((bus_dma_tag_t tag, bus_dma_segment_t *segs,
251 1.5.2.2 bouyer int nsegs, size_t size, caddr_t *kvap, int flags));
252 1.5.2.2 bouyer void _bus_dmamem_unmap __P((bus_dma_tag_t tag, caddr_t kva,
253 1.5.2.2 bouyer size_t size));
254 1.5.2.2 bouyer paddr_t _bus_dmamem_mmap __P((bus_dma_tag_t tag, bus_dma_segment_t *segs,
255 1.5.2.2 bouyer int nsegs, off_t off, int prot, int flags));
256 1.5.2.2 bouyer #endif /* _MVME68K_BUS_DMA_PRIVATE */
257 1.5.2.2 bouyer
258 1.5.2.2 bouyer #endif /* _MVME68K_BUS_DMA_H_ */
259