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 66 #ifndef _BUS_DMA_H_ 67 #define _BUS_DMA_H_ 68 69 #ifdef _KERNEL 70 #include <sys/_bus_dma.h> 71 #endif 72 73 /* 74 * Machine independent interface for mapping physical addresses to peripheral 75 * bus 'physical' addresses, and assisting with DMA operations. 76 * 77 * XXX This file is always included from <machine/bus_dma.h> and should not 78 * (yet) be included directly. 79 */ 80 81 /* 82 * Flags used in various bus DMA methods. 83 */ 84 #define BUS_DMA_WAITOK 0x00 /* safe to sleep (pseudo-flag) */ 85 #define BUS_DMA_NOWAIT 0x01 /* not safe to sleep */ 86 #define BUS_DMA_ALLOCNOW 0x02 /* perform resource allocation now */ 87 #define BUS_DMA_COHERENT 0x04 /* hint: map memory in a coherent way */ 88 #define BUS_DMA_ZERO 0x08 /* allocate zero'ed memory */ 89 #define BUS_DMA_BUS1 0x10 /* placeholders for bus functions... */ 90 #define BUS_DMA_BUS2 0x20 91 #define BUS_DMA_BUS3 0x40 92 #define BUS_DMA_BUS4 0x80 93 94 /* 95 * The following two flags are non-standard or specific to only certain 96 * architectures 97 */ 98 #define BUS_DMA_NOWRITE 0x100 99 #define BUS_DMA_NOCACHE 0x200 100 101 /* 102 * The following flag is a DMA tag hint that the page offset of the 103 * loaded kernel virtual address must be preserved in the first 104 * physical segment address, when the KVA is loaded into DMA. 105 */ 106 #define BUS_DMA_KEEP_PG_OFFSET 0x400 107 108 #define BUS_DMA_LOAD_MBUF 0x800 109 110 /* Forwards needed by prototypes below. */ 111 union ccb; 112 struct bio; 113 struct crypto_buffer; 114 struct cryptop; 115 struct mbuf; 116 struct memdesc; 117 struct pmap; 118 struct uio; 119 120 /* 121 * Operations performed by bus_dmamap_sync(). 122 */ 123 #define BUS_DMASYNC_PREREAD 1 124 #define BUS_DMASYNC_POSTREAD 2 125 #define BUS_DMASYNC_PREWRITE 4 126 #define BUS_DMASYNC_POSTWRITE 8 127 128 /* 129 * bus_dma_segment_t 130 * 131 * Describes a single contiguous DMA transaction. Values 132 * are suitable for programming into DMA registers. 133 */ 134 typedef struct bus_dma_segment { 135 bus_addr_t ds_addr; /* DMA address */ 136 bus_size_t ds_len; /* length of transfer */ 137 } bus_dma_segment_t; 138 139 #ifdef _KERNEL 140 /* 141 * A function that returns 1 if the address cannot be accessed by 142 * a device and 0 if it can be. 143 */ 144 typedef int bus_dma_filter_t(void *, bus_addr_t); 145 146 /* 147 * Generic helper function for manipulating mutexes. 148 */ 149 void busdma_lock_mutex(void *arg, bus_dma_lock_op_t op); 150 151 /* 152 * Allocate a device specific dma_tag encapsulating the constraints of 153 * the parent tag in addition to other restrictions specified: 154 * 155 * alignment: Alignment for segments. 156 * boundary: Boundary that segments cannot cross. 157 * lowaddr: Low restricted address that cannot appear in a mapping. 158 * highaddr: High restricted address that cannot appear in a mapping. 159 * filtfunc: An optional function to further test if an address 160 * within the range of lowaddr and highaddr cannot appear 161 * in a mapping. 162 * filtfuncarg: An argument that will be passed to filtfunc in addition 163 * to the address to test. 164 * maxsize: Maximum mapping size supported by this tag. 165 * nsegments: Number of discontinuities allowed in maps. 166 * maxsegsz: Maximum size of a segment in the map. 167 * flags: Bus DMA flags. 168 * lockfunc: An optional function to handle driver-defined lock 169 * operations. 170 * lockfuncarg: An argument that will be passed to lockfunc in addition 171 * to the lock operation. 172 * dmat: A pointer to set to a valid dma tag should the return 173 * value of this function indicate success. 174 */ 175 /* XXX Should probably allow specification of alignment */ 176 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment, 177 bus_addr_t boundary, bus_addr_t lowaddr, 178 bus_addr_t highaddr, bus_dma_filter_t *filtfunc, 179 void *filtfuncarg, bus_size_t maxsize, int nsegments, 180 bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc, 181 void *lockfuncarg, bus_dma_tag_t *dmat); 182 183 /* 184 * Functions for creating and cloning tags via a template, 185 * 186 * bus_dma_template_t is made avaialble publicly so it can be allocated 187 * from the caller stack. Its contents should be considered private, and 188 * should only be accessed via the documented APIs and macros 189 */ 190 typedef struct { 191 bus_dma_tag_t parent; 192 bus_size_t alignment; 193 bus_addr_t boundary; 194 bus_addr_t lowaddr; 195 bus_addr_t highaddr; 196 bus_size_t maxsize; 197 int nsegments; 198 bus_size_t maxsegsize; 199 int flags; 200 bus_dma_lock_t *lockfunc; 201 void *lockfuncarg; 202 const char *name; 203 } bus_dma_template_t; 204 205 /* 206 * These enum values should not be re-ordered. BD_PARAM_INVALID is an 207 * invalid key and will trigger a panic. 208 */ 209 typedef enum { 210 BD_PARAM_INVALID = 0, 211 BD_PARAM_PARENT = 1, 212 BD_PARAM_ALIGNMENT = 2, 213 BD_PARAM_BOUNDARY = 3, 214 BD_PARAM_LOWADDR = 4, 215 BD_PARAM_HIGHADDR = 5, 216 BD_PARAM_MAXSIZE = 6, 217 BD_PARAM_NSEGMENTS = 7, 218 BD_PARAM_MAXSEGSIZE = 8, 219 BD_PARAM_FLAGS = 9, 220 BD_PARAM_LOCKFUNC = 10, 221 BD_PARAM_LOCKFUNCARG = 11, 222 BD_PARAM_NAME = 12 223 } bus_dma_param_key_t; 224 225 /* These contents should also be considered private */ 226 typedef struct { 227 bus_dma_param_key_t key; 228 union { 229 void *ptr; 230 vm_paddr_t pa; 231 uintmax_t num; 232 }; 233 } bus_dma_param_t; 234 235 #define BD_PARENT(val) { BD_PARAM_PARENT, .ptr = val } 236 #define BD_ALIGNMENT(val) { BD_PARAM_ALIGNMENT, .num = val } 237 #define BD_BOUNDARY(val) { BD_PARAM_BOUNDARY, .num = val } 238 #define BD_LOWADDR(val) { BD_PARAM_LOWADDR, .pa = val } 239 #define BD_HIGHADDR(val) { BD_PARAM_HIGHADDR, .pa = val } 240 #define BD_MAXSIZE(val) { BD_PARAM_MAXSIZE, .num = val } 241 #define BD_NSEGMENTS(val) { BD_PARAM_NSEGMENTS, .num = val } 242 #define BD_MAXSEGSIZE(val) { BD_PARAM_MAXSEGSIZE, .num = val } 243 #define BD_FLAGS(val) { BD_PARAM_FLAGS, .num = val } 244 #define BD_LOCKFUNC(val) { BD_PARAM_LOCKFUNC, .ptr = val } 245 #define BD_LOCKFUNCARG(val) { BD_PARAM_LOCKFUNCARG, .ptr = val } 246 #define BD_NAME(val) { BD_PARAM_NAME, .ptr = val } 247 248 #define BUS_DMA_TEMPLATE_FILL(t, kv...) \ 249 do { \ 250 bus_dma_param_t pm[] = { kv }; \ 251 bus_dma_template_fill(t, pm, howmany(sizeof(pm), sizeof(pm[0]))); \ 252 } while (0) 253 254 void bus_dma_template_init(bus_dma_template_t *t, bus_dma_tag_t parent); 255 int bus_dma_template_tag(bus_dma_template_t *t, bus_dma_tag_t *dmat); 256 void bus_dma_template_clone(bus_dma_template_t *t, bus_dma_tag_t dmat); 257 void bus_dma_template_fill(bus_dma_template_t *t, bus_dma_param_t *kv, 258 u_int count); 259 260 /* 261 * Set the memory domain to be used for allocations. 262 * 263 * Automatic for PCI devices. Must be set prior to creating maps or 264 * allocating memory. 265 */ 266 int bus_dma_tag_set_domain(bus_dma_tag_t dmat, int domain); 267 268 int bus_dma_tag_destroy(bus_dma_tag_t dmat); 269 270 /* 271 * A function that processes a successfully loaded dma map or an error 272 * from a delayed load map. 273 */ 274 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int); 275 276 /* 277 * Like bus_dmamap_callback but includes map size in bytes. This is 278 * defined as a separate interface to maintain compatibility for users 279 * of bus_dmamap_callback_t--at some point these interfaces should be merged. 280 */ 281 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int); 282 283 /* 284 * Map the buffer buf into bus space using the dmamap map. 285 */ 286 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf, 287 bus_size_t buflen, bus_dmamap_callback_t *callback, 288 void *callback_arg, int flags); 289 290 /* 291 * Like bus_dmamap_load but for mbufs. Note the use of the 292 * bus_dmamap_callback2_t interface. 293 */ 294 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map, 295 struct mbuf *mbuf, 296 bus_dmamap_callback2_t *callback, void *callback_arg, 297 int flags); 298 299 int bus_dmamap_load_mbuf_sg(bus_dma_tag_t dmat, bus_dmamap_t map, 300 struct mbuf *mbuf, bus_dma_segment_t *segs, 301 int *nsegs, int flags); 302 303 /* 304 * Like bus_dmamap_load but for uios. Note the use of the 305 * bus_dmamap_callback2_t interface. 306 */ 307 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map, 308 struct uio *ui, 309 bus_dmamap_callback2_t *callback, void *callback_arg, 310 int flags); 311 312 /* 313 * Like bus_dmamap_load but for cam control blocks. 314 */ 315 int bus_dmamap_load_ccb(bus_dma_tag_t dmat, bus_dmamap_t map, union ccb *ccb, 316 bus_dmamap_callback_t *callback, void *callback_arg, 317 int flags); 318 319 /* 320 * Like bus_dmamap_load but for bios. 321 */ 322 int bus_dmamap_load_bio(bus_dma_tag_t dmat, bus_dmamap_t map, struct bio *bio, 323 bus_dmamap_callback_t *callback, void *callback_arg, 324 int flags); 325 326 /* 327 * Like bus_dmamap_load but for crypto ops. 328 */ 329 int bus_dmamap_load_crp(bus_dma_tag_t dmat, bus_dmamap_t map, 330 struct cryptop *crp, bus_dmamap_callback_t *callback, 331 void *callback_arg, int flags); 332 int bus_dmamap_load_crp_buffer(bus_dma_tag_t dmat, bus_dmamap_t map, 333 struct crypto_buffer *cb, 334 bus_dmamap_callback_t *callback, 335 void *callback_arg, int flags); 336 337 /* 338 * Loads any memory descriptor. 339 */ 340 int bus_dmamap_load_mem(bus_dma_tag_t dmat, bus_dmamap_t map, 341 struct memdesc *mem, bus_dmamap_callback_t *callback, 342 void *callback_arg, int flags); 343 344 /* 345 * Placeholder for use by busdma implementations which do not benefit 346 * from optimized procedure to load an array of vm_page_t. Falls back 347 * to do _bus_dmamap_load_phys() in loop. 348 */ 349 int bus_dmamap_load_ma_triv(bus_dma_tag_t dmat, bus_dmamap_t map, 350 struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags, 351 bus_dma_segment_t *segs, int *segp); 352 353 #ifdef WANT_INLINE_DMAMAP 354 #define BUS_DMAMAP_OP static inline 355 #else 356 #define BUS_DMAMAP_OP 357 #endif 358 359 /* 360 * Allocate a handle for mapping from kva/uva/physical 361 * address space into bus device space. 362 */ 363 BUS_DMAMAP_OP int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp); 364 365 /* 366 * Destroy a handle for mapping from kva/uva/physical 367 * address space into bus device space. 368 */ 369 BUS_DMAMAP_OP int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map); 370 371 /* 372 * Allocate a piece of memory that can be efficiently mapped into 373 * bus device space based on the constraints listed in the dma tag. 374 * A dmamap to for use with dmamap_load is also allocated. 375 */ 376 BUS_DMAMAP_OP int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags, 377 bus_dmamap_t *mapp); 378 379 /* 380 * Free a piece of memory and its allocated dmamap, that was allocated 381 * via bus_dmamem_alloc. 382 */ 383 BUS_DMAMAP_OP void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map); 384 385 /* 386 * Perform a synchronization operation on the given map. If the map 387 * is NULL we have a fully IO-coherent system. 388 */ 389 BUS_DMAMAP_OP void bus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t dmamap, bus_dmasync_op_t op); 390 391 /* 392 * Release the mapping held by map. 393 */ 394 BUS_DMAMAP_OP void bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t dmamap); 395 396 #undef BUS_DMAMAP_OP 397 #endif /* _KERNEL */ 398 399 #endif /* _BUS_DMA_H_ */ 400