1 /* $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $ */ 2 3 /*- 4 * SPDX-License-Identifier: (BSD-2-Clause AND BSD-4-Clause) 5 * 6 * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 11 * NASA Ames Research Center. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 /*- 36 * Copyright (c) 1996 Charles M. Hannum. All rights reserved. 37 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved. 38 * 39 * Redistribution and use in source and binary forms, with or without 40 * modification, are permitted provided that the following conditions 41 * are met: 42 * 1. Redistributions of source code must retain the above copyright 43 * notice, this list of conditions and the following disclaimer. 44 * 2. Redistributions in binary form must reproduce the above copyright 45 * notice, this list of conditions and the following disclaimer in the 46 * documentation and/or other materials provided with the distribution. 47 * 3. All advertising materials mentioning features or use of this software 48 * must display the following acknowledgement: 49 * This product includes software developed by Christopher G. Demetriou 50 * for the NetBSD Project. 51 * 4. The name of the author may not be used to endorse or promote products 52 * derived from this software without specific prior written permission 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 55 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 56 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 57 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 58 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 59 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 60 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 61 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 62 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 63 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 64 */ 65 /* $FreeBSD$ */ 66 67 #ifndef _BUS_DMA_H_ 68 #define _BUS_DMA_H_ 69 70 #ifdef _KERNEL 71 #include <sys/_bus_dma.h> 72 #endif 73 74 /* 75 * Machine independent interface for mapping physical addresses to peripheral 76 * bus 'physical' addresses, and assisting with DMA operations. 77 * 78 * XXX This file is always included from <machine/bus_dma.h> and should not 79 * (yet) be included directly. 80 */ 81 82 /* 83 * Flags used in various bus DMA methods. 84 */ 85 #define BUS_DMA_WAITOK 0x00 /* safe to sleep (pseudo-flag) */ 86 #define BUS_DMA_NOWAIT 0x01 /* not safe to sleep */ 87 #define BUS_DMA_ALLOCNOW 0x02 /* perform resource allocation now */ 88 #define BUS_DMA_COHERENT 0x04 /* hint: map memory in a coherent way */ 89 #define BUS_DMA_ZERO 0x08 /* allocate zero'ed memory */ 90 #define BUS_DMA_BUS1 0x10 /* placeholders for bus functions... */ 91 #define BUS_DMA_BUS2 0x20 92 #define BUS_DMA_BUS3 0x40 93 #define BUS_DMA_BUS4 0x80 94 95 /* 96 * The following two flags are non-standard or specific to only certain 97 * architectures 98 */ 99 #define BUS_DMA_NOWRITE 0x100 100 #define BUS_DMA_NOCACHE 0x200 101 102 /* 103 * The following flag is a DMA tag hint that the page offset of the 104 * loaded kernel virtual address must be preserved in the first 105 * physical segment address, when the KVA is loaded into DMA. 106 */ 107 #define BUS_DMA_KEEP_PG_OFFSET 0x400 108 109 #define BUS_DMA_LOAD_MBUF 0x800 110 111 /* Forwards needed by prototypes below. */ 112 union ccb; 113 struct bio; 114 struct crypto_buffer; 115 struct cryptop; 116 struct mbuf; 117 struct memdesc; 118 struct pmap; 119 struct uio; 120 121 /* 122 * Operations performed by bus_dmamap_sync(). 123 */ 124 #define BUS_DMASYNC_PREREAD 1 125 #define BUS_DMASYNC_POSTREAD 2 126 #define BUS_DMASYNC_PREWRITE 4 127 #define BUS_DMASYNC_POSTWRITE 8 128 129 /* 130 * bus_dma_segment_t 131 * 132 * Describes a single contiguous DMA transaction. Values 133 * are suitable for programming into DMA registers. 134 */ 135 typedef struct bus_dma_segment { 136 bus_addr_t ds_addr; /* DMA address */ 137 bus_size_t ds_len; /* length of transfer */ 138 } bus_dma_segment_t; 139 140 #ifdef _KERNEL 141 /* 142 * A function that returns 1 if the address cannot be accessed by 143 * a device and 0 if it can be. 144 */ 145 typedef int bus_dma_filter_t(void *, bus_addr_t); 146 147 /* 148 * Generic helper function for manipulating mutexes. 149 */ 150 void busdma_lock_mutex(void *arg, bus_dma_lock_op_t op); 151 152 /* 153 * Internal helper function used by tags that do not defer loads. 154 */ 155 void _busdma_dflt_lock(void *arg, bus_dma_lock_op_t op); 156 157 /* 158 * Allocate a device specific dma_tag encapsulating the constraints of 159 * the parent tag in addition to other restrictions specified: 160 * 161 * alignment: Alignment for segments. 162 * boundary: Boundary that segments cannot cross. 163 * lowaddr: Low restricted address that cannot appear in a mapping. 164 * highaddr: High restricted address that cannot appear in a mapping. 165 * filtfunc: An optional function to further test if an address 166 * within the range of lowaddr and highaddr cannot appear 167 * in a mapping. 168 * filtfuncarg: An argument that will be passed to filtfunc in addition 169 * to the address to test. 170 * maxsize: Maximum mapping size supported by this tag. 171 * nsegments: Number of discontinuities allowed in maps. 172 * maxsegsz: Maximum size of a segment in the map. 173 * flags: Bus DMA flags. 174 * lockfunc: An optional function to handle driver-defined lock 175 * operations. 176 * lockfuncarg: An argument that will be passed to lockfunc in addition 177 * to the lock operation. 178 * dmat: A pointer to set to a valid dma tag should the return 179 * value of this function indicate success. 180 */ 181 /* XXX Should probably allow specification of alignment */ 182 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment, 183 bus_addr_t boundary, bus_addr_t lowaddr, 184 bus_addr_t highaddr, bus_dma_filter_t *filtfunc, 185 void *filtfuncarg, bus_size_t maxsize, int nsegments, 186 bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc, 187 void *lockfuncarg, bus_dma_tag_t *dmat); 188 189 /* 190 * Functions for creating and cloning tags via a template, 191 * 192 * bus_dma_template_t is made avaialble publicly so it can be allocated 193 * from the caller stack. Its contents should be considered private, and 194 * should only be accessed via the documented APIs and macros 195 */ 196 typedef struct { 197 bus_dma_tag_t parent; 198 bus_size_t alignment; 199 bus_addr_t boundary; 200 bus_addr_t lowaddr; 201 bus_addr_t highaddr; 202 bus_size_t maxsize; 203 int nsegments; 204 bus_size_t maxsegsize; 205 int flags; 206 bus_dma_lock_t *lockfunc; 207 void *lockfuncarg; 208 const char *name; 209 } bus_dma_template_t; 210 211 /* 212 * These enum values should not be re-ordered. BD_PARAM_INVALID is an 213 * invalid key and will trigger a panic. 214 */ 215 typedef enum { 216 BD_PARAM_INVALID = 0, 217 BD_PARAM_PARENT = 1, 218 BD_PARAM_ALIGNMENT = 2, 219 BD_PARAM_BOUNDARY = 3, 220 BD_PARAM_LOWADDR = 4, 221 BD_PARAM_HIGHADDR = 5, 222 BD_PARAM_MAXSIZE = 6, 223 BD_PARAM_NSEGMENTS = 7, 224 BD_PARAM_MAXSEGSIZE = 8, 225 BD_PARAM_FLAGS = 9, 226 BD_PARAM_LOCKFUNC = 10, 227 BD_PARAM_LOCKFUNCARG = 11, 228 BD_PARAM_NAME = 12 229 } bus_dma_param_key_t; 230 231 /* These contents should also be considered private */ 232 typedef struct { 233 bus_dma_param_key_t key; 234 union { 235 void *ptr; 236 vm_paddr_t pa; 237 uintmax_t num; 238 }; 239 } bus_dma_param_t; 240 241 #define BD_PARENT(val) { BD_PARAM_PARENT, .ptr = val } 242 #define BD_ALIGNMENT(val) { BD_PARAM_ALIGNMENT, .num = val } 243 #define BD_BOUNDARY(val) { BD_PARAM_BOUNDARY, .num = val } 244 #define BD_LOWADDR(val) { BD_PARAM_LOWADDR, .pa = val } 245 #define BD_HIGHADDR(val) { BD_PARAM_HIGHADDR, .pa = val } 246 #define BD_MAXSIZE(val) { BD_PARAM_MAXSIZE, .num = val } 247 #define BD_NSEGMENTS(val) { BD_PARAM_NSEGMENTS, .num = val } 248 #define BD_MAXSEGSIZE(val) { BD_PARAM_MAXSEGSIZE, .num = val } 249 #define BD_FLAGS(val) { BD_PARAM_FLAGS, .num = val } 250 #define BD_LOCKFUNC(val) { BD_PARAM_LOCKFUNC, .ptr = val } 251 #define BD_LOCKFUNCARG(val) { BD_PARAM_LOCKFUNCARG, .ptr = val } 252 #define BD_NAME(val) { BD_PARAM_NAME, .ptr = val } 253 254 #define BUS_DMA_TEMPLATE_FILL(t, kv...) \ 255 do { \ 256 bus_dma_param_t pm[] = { kv }; \ 257 bus_dma_template_fill(t, pm, howmany(sizeof(pm), sizeof(pm[0]))); \ 258 } while (0) 259 260 void bus_dma_template_init(bus_dma_template_t *t, bus_dma_tag_t parent); 261 int bus_dma_template_tag(bus_dma_template_t *t, bus_dma_tag_t *dmat); 262 void bus_dma_template_clone(bus_dma_template_t *t, bus_dma_tag_t dmat); 263 void bus_dma_template_fill(bus_dma_template_t *t, bus_dma_param_t *kv, 264 u_int count); 265 266 /* 267 * Set the memory domain to be used for allocations. 268 * 269 * Automatic for PCI devices. Must be set prior to creating maps or 270 * allocating memory. 271 */ 272 int bus_dma_tag_set_domain(bus_dma_tag_t dmat, int domain); 273 274 int bus_dma_tag_destroy(bus_dma_tag_t dmat); 275 276 /* 277 * A function that processes a successfully loaded dma map or an error 278 * from a delayed load map. 279 */ 280 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int); 281 282 /* 283 * Like bus_dmamap_callback but includes map size in bytes. This is 284 * defined as a separate interface to maintain compatibility for users 285 * of bus_dmamap_callback_t--at some point these interfaces should be merged. 286 */ 287 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int); 288 289 /* 290 * Map the buffer buf into bus space using the dmamap map. 291 */ 292 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf, 293 bus_size_t buflen, bus_dmamap_callback_t *callback, 294 void *callback_arg, int flags); 295 296 /* 297 * Like bus_dmamap_load but for mbufs. Note the use of the 298 * bus_dmamap_callback2_t interface. 299 */ 300 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, 301 struct mbuf *mbuf, 302 bus_dmamap_callback2_t *callback, void *callback_arg, 303 int flags); 304 305 int bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, 306 struct mbuf *mbuf, bus_dma_segment_t *segs, 307 int *nsegs, int flags); 308 309 /* 310 * Like bus_dmamap_load but for uios. Note the use of the 311 * bus_dmamap_callback2_t interface. 312 */ 313 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, 314 struct uio *ui, 315 bus_dmamap_callback2_t *callback, void *callback_arg, 316 int flags); 317 318 /* 319 * Like bus_dmamap_load but for cam control blocks. 320 */ 321 int bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb, 322 bus_dmamap_callback_t *callback, void *callback_arg, 323 int flags); 324 325 /* 326 * Like bus_dmamap_load but for bios. 327 */ 328 int bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio, 329 bus_dmamap_callback_t *callback, void *callback_arg, 330 int flags); 331 332 /* 333 * Like bus_dmamap_load but for crypto ops. 334 */ 335 int bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, 336 struct cryptop *crp, bus_dmamap_callback_t *callback, 337 void *callback_arg, int flags); 338 int bus_dmamap_load_crp_buffer(bus_dma_tag_t dmat, bus_dmamap_t map, 339 struct crypto_buffer *cb, 340 bus_dmamap_callback_t *callback, 341 void *callback_arg, int flags); 342 343 /* 344 * Loads any memory descriptor. 345 */ 346 int bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map, 347 struct memdesc *mem, bus_dmamap_callback_t *callback, 348 void *callback_arg, int flags); 349 350 /* 351 * Placeholder for use by busdma implementations which do not benefit 352 * from optimized procedure to load an array of vm_page_t. Falls back 353 * to do _bus_dmamap_load_phys() in loop. 354 */ 355 int bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map, 356 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags, 357 bus_dma_segment_t *segs, int *segp); 358 359 #ifdef WANT_INLINE_DMAMAP 360 #define BUS_DMAMAP_OP static inline 361 #else 362 #define BUS_DMAMAP_OP 363 #endif 364 365 /* 366 * Allocate a handle for mapping from kva/uva/physical 367 * address space into bus device space. 368 */ 369 BUS_DMAMAP_OP int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp); 370 371 /* 372 * Destroy a handle for mapping from kva/uva/physical 373 * address space into bus device space. 374 */ 375 BUS_DMAMAP_OP int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map); 376 377 /* 378 * Allocate a piece of memory that can be efficiently mapped into 379 * bus device space based on the constraints listed in the dma tag. 380 * A dmamap to for use with dmamap_load is also allocated. 381 */ 382 BUS_DMAMAP_OP int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags, 383 bus_dmamap_t *mapp); 384 385 /* 386 * Free a piece of memory and its allocated dmamap, that was allocated 387 * via bus_dmamem_alloc. 388 */ 389 BUS_DMAMAP_OP void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map); 390 391 /* 392 * Perform a synchronization operation on the given map. If the map 393 * is NULL we have a fully IO-coherent system. 394 */ 395 BUS_DMAMAP_OP void bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t dmamap, bus_dmasync_op_t op); 396 397 /* 398 * Release the mapping held by map. 399 */ 400 BUS_DMAMAP_OP void bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t dmamap); 401 402 #undef BUS_DMAMAP_OP 403 #endif /* _KERNEL */ 404 405 #endif /* _BUS_DMA_H_ */ 406