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