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