sys/sys/bus_dma.h

   1 /*-
   2  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The NetBSD Foundation
   6  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
   7  * NASA Ames Research Center.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the NetBSD
  20  *      Foundation, Inc. and its contributors.
  21  * 4. Neither the name of The NetBSD Foundation nor the names of its
  22  *    contributors may be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37 /*
  38  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
  39  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
  40  *
  41  * Redistribution and use in source and binary forms, with or without
  42  * modification, are permitted provided that the following conditions
  43  * are met:
  44  * 1. Redistributions of source code must retain the above copyright
  45  *    notice, this list of conditions and the following disclaimer.
  46  * 2. Redistributions in binary form must reproduce the above copyright
  47  *    notice, this list of conditions and the following disclaimer in the
  48  *    documentation and/or other materials provided with the distribution.
  49  * 3. All advertising materials mentioning features or use of this software
  50  *    must display the following acknowledgement:
  51  *      This product includes software developed by Christopher G. Demetriou
  52  *      for the NetBSD Project.
  53  * 4. The name of the author may not be used to endorse or promote products
  54  *    derived from this software without specific prior written permission
  55  *
  56  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  57  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  58  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  59  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  60  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  61  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  62  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  63  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  64  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  65  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  66  */
  67 /*
  68  * $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $
  69  * $FreeBSD: src/sys/i386/include/bus_dma.h,v 1.15.2.2 2002/11/21 23:36:01 sam Exp $
  70  * $DragonFly: src/sys/sys/bus_dma.h,v 1.1 2006/10/25 20:56:03 dillon Exp $
  71  */
  72
  73 #ifndef _SYS_BUS_DMA_H_
  74 #define _SYS_BUS_DMA_H_
  75
  76 /*
  77  * Include machine-specific bus stuff
  78  */
  79 #ifndef _MACHINE_BUS_DMA_H_
  80 #include <machine/bus_dma.h>    /* bus_addr_t */
  81 #endif
  82
  83 /*
  84  * Flags used in various bus DMA methods.
  85  */
  86 #define BUS_DMA_WAITOK          0x0000  /* safe to sleep (pseudo-flag) */
  87 #define BUS_DMA_NOWAIT          0x0001  /* not safe to sleep */
  88 #define BUS_DMA_ALLOCNOW        0x0002  /* perform resource allocation now */
  89 #define BUS_DMA_COHERENT        0x0004  /* map memory to not require sync */
  90 #define BUS_DMA_ZERO            0x0008  /* allocate zero'ed memory */
  91 #define BUS_DMA_BUS1            0x0010  /* placeholders for bus functions... */
  92 #define BUS_DMA_BUS2            0x0020
  93 #define BUS_DMA_BUS3            0x0040
  94 #define BUS_DMA_BUS4            0x0080
  95 #define BUS_DMA_ONEBPAGE        0x0100  /* allocate one bpage per map at most */
  96 #define BUS_DMA_ALIGNED         0x0200  /* no bpage should be allocated due to
  97                                          * alignment requirement; all to-be-
  98                                          * loaded memory is properly aligned */
  99
 100 /* Forwards needed by prototypes below. */
 101 struct mbuf;
 102 struct uio;
 103
 104 /*
 105  *      bus_dmasync_op_t
 106  *
 107  *      Operations performed by bus_dmamap_sync().
 108  */
 109 typedef enum {
 110         BUS_DMASYNC_PREREAD,
 111         BUS_DMASYNC_POSTREAD,
 112         BUS_DMASYNC_PREWRITE,
 113         BUS_DMASYNC_POSTWRITE
 114 } bus_dmasync_op_t;
 115
 116 /*
 117  *      bus_dma_tag_t
 118  *
 119  *      A machine-dependent opaque type describing the characteristics
 120  *      of how to perform DMA mappings.  This structure encapsultes
 121  *      information concerning address and alignment restrictions, number
 122  *      of S/G  segments, amount of data per S/G segment, etc.
 123  */
 124 typedef struct bus_dma_tag      *bus_dma_tag_t;
 125
 126 /*
 127  *      bus_dmamap_t
 128  *
 129  *      DMA mapping instance information.
 130  */
 131 typedef struct bus_dmamap       *bus_dmamap_t;
 132
 133 /*
 134  *      bus_dma_segment_t
 135  *
 136  *      Describes a single contiguous DMA transaction.  Values
 137  *      are suitable for programming into DMA registers.
 138  */
 139 typedef struct bus_dma_segment {
 140         bus_addr_t      ds_addr;        /* DMA address */
 141         bus_size_t      ds_len;         /* length of transfer */
 142 } bus_dma_segment_t;
 143
 144 typedef struct bus_dmamem {
 145         bus_dma_tag_t   dmem_tag;
 146         bus_dmamap_t    dmem_map;
 147         void            *dmem_addr;
 148         bus_addr_t      dmem_busaddr;
 149 } bus_dmamem_t;
 150
 151 /*
 152  * A function that returns 1 if the address cannot be accessed by
 153  * a device and 0 if it can be.
 154  */
 155 typedef int bus_dma_filter_t(void *, bus_addr_t);
 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  *      dmat:           A pointer to set to a valid dma tag should the return
 175  *                      value of this function indicate success.
 176  */
 177 /* XXX Should probably allow specification of alignment */
 178 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
 179                        bus_size_t boundary, bus_addr_t lowaddr,
 180                        bus_addr_t highaddr, bus_dma_filter_t *filtfunc,
 181                        void *filtfuncarg, bus_size_t maxsize, int nsegments,
 182                        bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat);
 183
 184 int bus_dma_tag_destroy(bus_dma_tag_t dmat);
 185 bus_size_t bus_dma_tag_getmaxsize(bus_dma_tag_t tag);
 186
 187 /*
 188  * Allocate a handle for mapping from kva/uva/physical
 189  * address space into bus device space.
 190  */
 191 int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
 192
 193 /*
 194  * Destroy  a handle for mapping from kva/uva/physical
 195  * address space into bus device space.
 196  */
 197 int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map);
 198
 199 /*
 200  * Allocate a piece of memory that can be efficiently mapped into
 201  * bus device space based on the constraints lited in the dma tag.
 202  * A dmamap to for use with dmamap_load is also allocated.
 203  */
 204 int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
 205                      bus_dmamap_t *mapp);
 206
 207 /*
 208  * Free a piece of memory and it's allociated dmamap, that was allocated
 209  * via bus_dmamem_alloc.
 210  */
 211 void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
 212
 213 /*
 214  * A function that processes a successfully loaded dma map or an error
 215  * from a delayed load map.
 216  */
 217 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
 218
 219 /*
 220  * Map the buffer buf into bus space using the dmamap map.
 221  */
 222 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
 223                     bus_size_t buflen, bus_dmamap_callback_t *callback,
 224                     void *callback_arg, int flags);
 225
 226 /*
 227  * Like bus_dmamap_callback but includes map size in bytes.  This is
 228  * defined as a separate interface to maintain compatiiblity for users
 229  * of bus_dmamap_callback_t--at some point these interfaces should be merged.
 230  */
 231 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int);
 232 /*
 233  * Like bus_dmamap_load but for mbufs.  Note the use of the
 234  * bus_dmamap_callback2_t interface.
 235  */
 236 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
 237                          struct mbuf *mbuf,
 238                          bus_dmamap_callback2_t *callback, void *callback_arg,
 239                          int flags);
 240 /*
 241  * Like bus_dmamap_load but for uios.  Note the use of the
 242  * bus_dmamap_callback2_t interface.
 243  */
 244 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
 245                         struct uio *ui,
 246                         bus_dmamap_callback2_t *callback, void *callback_arg,
 247                         int flags);
 248
 249 /*
 250  * Like bus_dmamap_load_mbuf without callback.
 251  * Segmentation information are saved in 'segs' and 'nsegs' if
 252  * the loading is successful.  'maxsegs' must be set by caller
 253  * and must be at least 1 but less than 'dmat' nsegment.  It
 254  * indicates the number of elements in 'segs'.  'flags' must
 255  * have BUS_DMA_NOWAIT turned on.
 256  */
 257 int
 258 bus_dmamap_load_mbuf_segment(bus_dma_tag_t dmat, bus_dmamap_t map,
 259                              struct mbuf *mbuf,
 260                              bus_dma_segment_t *segs, int maxsegs,
 261                              int *nsegs, int flags);
 262
 263 /*
 264  * Like bus_dmamap_load_mbuf_segment, but it will call m_defrag()
 265  * and try reloading if low level code indicates too many fragments
 266  * in the '*mbuf'; 'mbuf' will be updated under this situation.
 267  */
 268 int
 269 bus_dmamap_load_mbuf_defrag(bus_dma_tag_t dmat, bus_dmamap_t map,
 270                             struct mbuf **mbuf,
 271                             bus_dma_segment_t *segs, int maxsegs,
 272                             int *nsegs, int flags);
 273
 274 /*
 275  * Convenient function to create coherent busdma memory
 276  */
 277 int
 278 bus_dmamem_coherent(bus_dma_tag_t parent,
 279                     bus_size_t alignment, bus_size_t boundary,
 280                     bus_addr_t lowaddr, bus_addr_t highaddr,
 281                     bus_size_t maxsize, int flags,
 282                     bus_dmamem_t *dmem);
 283
 284 /*
 285  * Simplified version of bus_dmamem_coherent() with:
 286  * boundary == 0
 287  * lowaddr  == BUS_SPACE_MAXADDR
 288  * highaddr == BUS_SPACE_MAXADDR
 289  *
 290  * 'parent' usually should not be NULL, so we could inherit
 291  * boundary, lowaddr and highaddr from it.
 292  */
 293 void *
 294 bus_dmamem_coherent_any(bus_dma_tag_t parent, bus_size_t alignment,
 295                         bus_size_t maxsize, int flags,
 296                         bus_dma_tag_t *dtag, bus_dmamap_t *dmap,
 297                         bus_addr_t *busaddr);
 298
 299 /*
 300  * Perform a syncronization operation on the given map.
 301  */
 302 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_dmasync_op_t);
 303 #define bus_dmamap_sync(dmat, dmamap, op)               \
 304         if ((dmamap) != NULL)                           \
 305                 _bus_dmamap_sync(dmat, dmamap, op)
 306
 307 /*
 308  * Release the mapping held by map.
 309  */
 310 void _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map);
 311 #define bus_dmamap_unload(dmat, dmamap)                 \
 312         if ((dmamap) != NULL)                           \
 313                 _bus_dmamap_unload(dmat, dmamap)
 314
 315 #endif /* _SYS_BUS_DMA_H_ */