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  */
  71
  72 #ifndef _SYS_BUS_DMA_H_
  73 #define _SYS_BUS_DMA_H_
  74
  75 /*
  76  * Include machine-specific bus stuff
  77  */
  78 #include <machine/bus_dma.h>    /* bus_addr_t */
  79
  80 /*
  81  * Flags used in various bus DMA methods.
  82  */
  83 #define BUS_DMA_WAITOK          0x0000  /* safe to sleep (pseudo-flag) */
  84 #define BUS_DMA_NOWAIT          0x0001  /* not safe to sleep */
  85 #define BUS_DMA_ALLOCNOW        0x0002  /* perform resource allocation now */
  86 #define BUS_DMA_COHERENT        0x0004  /* map memory to not require sync */
  87 #define BUS_DMA_ZERO            0x0008  /* allocate zero'ed memory */
  88 #define BUS_DMA_BUS1            0x0010  /* placeholders for bus functions... */
  89 #define BUS_DMA_BUS2            0x0020
  90 #define BUS_DMA_BUS3            0x0040
  91 #define BUS_DMA_BUS4            0x0080
  92 #define BUS_DMA_ONEBPAGE        0x0100  /* allocate one bpage per map at most */
  93 #define BUS_DMA_ALIGNED         0x0200  /* no bpage should be allocated due to
  94                                          * alignment requirement; all to-be-
  95                                          * loaded memory is properly aligned */
  96 #define BUS_DMA_PRIVBZONE       0x0400  /* need private bounce zone */
  97 #define BUS_DMA_ALLOCALL        0x0800  /* allocate all needed resources */
  98 #define BUS_DMA_PROTECTED       0x1000  /* all busdma functions are already
  99                                          * protected */
 100 #define BUS_DMA_KEEP_PG_OFFSET  0x2000  /* DMA tag hint that the page offset of the
 101                                          * loaded kernel virtual address must be
 102                                          * preserved in the first physical segment
 103                                          * address, when the KVA is loaded into DMA. */
 104 #define BUS_DMA_NOCACHE         0x4000  /* map memory uncached */
 105
 106 /* Forwards needed by prototypes below. */
 107 struct mbuf;
 108 struct uio;
 109
 110 /*
 111  *      bus_dmasync_op_t
 112  *
 113  *      Operations performed by bus_dmamap_sync().
 114  */
 115 typedef int bus_dmasync_op_t;
 116
 117 #define BUS_DMASYNC_PREREAD     0x01
 118 #define BUS_DMASYNC_POSTREAD    0x02
 119 #define BUS_DMASYNC_PREWRITE    0x04
 120 #define BUS_DMASYNC_POSTWRITE   0x08
 121
 122 /*
 123  *      bus_dma_tag_t
 124  *
 125  *      A machine-dependent opaque type describing the characteristics
 126  *      of how to perform DMA mappings.  This structure encapsultes
 127  *      information concerning address and alignment restrictions, number
 128  *      of S/G  segments, amount of data per S/G segment, etc.
 129  */
 130 typedef struct bus_dma_tag      *bus_dma_tag_t;
 131
 132 /*
 133  *      bus_dmamap_t
 134  *
 135  *      DMA mapping instance information.
 136  */
 137 typedef struct bus_dmamap       *bus_dmamap_t;
 138
 139 /*
 140  *      bus_dma_segment_t
 141  *
 142  *      Describes a single contiguous DMA transaction.  Values
 143  *      are suitable for programming into DMA registers.
 144  */
 145 typedef struct bus_dma_segment {
 146         bus_addr_t      ds_addr;        /* DMA address */
 147         bus_size_t      ds_len;         /* length of transfer */
 148 } bus_dma_segment_t;
 149
 150 typedef struct bus_dmamem {
 151         bus_dma_tag_t   dmem_tag;
 152         bus_dmamap_t    dmem_map;
 153         void            *dmem_addr;
 154         bus_addr_t      dmem_busaddr;
 155 } bus_dmamem_t;
 156
 157 /*
 158  * A function that returns 1 if the address cannot be accessed by
 159  * a device and 0 if it can be.
 160  */
 161 typedef int bus_dma_filter_t(void *, bus_addr_t);
 162
 163 /*
 164  * Allocate a device specific dma_tag encapsulating the constraints of
 165  * the parent tag in addition to other restrictions specified:
 166  *
 167  *      alignment:      alignment for segments.
 168  *      boundary:       Boundary that segments cannot cross.
 169  *      lowaddr:        Low restricted address that cannot appear in a mapping.
 170  *      highaddr:       High restricted address that cannot appear in a mapping.
 171  *      filtfunc:       An optional function to further test if an address
 172  *                      within the range of lowaddr and highaddr cannot appear
 173  *                      in a mapping.
 174  *      filtfuncarg:    An argument that will be passed to filtfunc in addition
 175  *                      to the address to test.
 176  *      maxsize:        Maximum mapping size supported by this tag.
 177  *      nsegments:      Number of discontinuities allowed in maps.
 178  *      maxsegsz:       Maximum size of a segment in the map.
 179  *      flags:          Bus DMA flags.
 180  *      dmat:           A pointer to set to a valid dma tag should the return
 181  *                      value of this function indicate success.
 182  */
 183 /* XXX Should probably allow specification of alignment */
 184 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
 185                        bus_size_t boundary, bus_addr_t lowaddr,
 186                        bus_addr_t highaddr, bus_dma_filter_t *filtfunc,
 187                        void *filtfuncarg, bus_size_t maxsize, int nsegments,
 188                        bus_size_t maxsegsz, int flags, bus_dma_tag_t *dmat);
 189
 190 int bus_dma_tag_destroy(bus_dma_tag_t dmat);
 191 bus_size_t bus_dma_tag_getmaxsize(bus_dma_tag_t tag);
 192
 193 /*
 194  * Allocate a handle for mapping from kva/uva/physical
 195  * address space into bus device space.
 196  */
 197 int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
 198
 199 /*
 200  * Destroy  a handle for mapping from kva/uva/physical
 201  * address space into bus device space.
 202  */
 203 int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map);
 204
 205 /*
 206  * Allocate a piece of memory that can be efficiently mapped into
 207  * bus device space based on the constraints lited in the dma tag.
 208  * A dmamap to for use with dmamap_load is also allocated.
 209  */
 210 int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
 211                      bus_dmamap_t *mapp);
 212
 213 /*
 214  * Free a piece of memory and it's allociated dmamap, that was allocated
 215  * via bus_dmamem_alloc.
 216  */
 217 void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
 218
 219 /*
 220  * A function that processes a successfully loaded dma map or an error
 221  * from a delayed load map.
 222  */
 223 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
 224
 225 /*
 226  * Map the buffer buf into bus space using the dmamap map.
 227  */
 228 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
 229                     bus_size_t buflen, bus_dmamap_callback_t *callback,
 230                     void *callback_arg, int flags);
 231
 232 /*
 233  * Like bus_dmamap_callback but includes map size in bytes.  This is
 234  * defined as a separate interface to maintain compatiiblity for users
 235  * of bus_dmamap_callback_t--at some point these interfaces should be merged.
 236  */
 237 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int);
 238 /*
 239  * Like bus_dmamap_load but for mbufs.  Note the use of the
 240  * bus_dmamap_callback2_t interface.
 241  */
 242 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
 243                          struct mbuf *mbuf,
 244                          bus_dmamap_callback2_t *callback, void *callback_arg,
 245                          int flags);
 246 /*
 247  * Like bus_dmamap_load but for uios.  Note the use of the
 248  * bus_dmamap_callback2_t interface.
 249  */
 250 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
 251                         struct uio *ui,
 252                         bus_dmamap_callback2_t *callback, void *callback_arg,
 253                         int flags);
 254
 255 /*
 256  * Like bus_dmamap_load_mbuf without callback.
 257  * Segmentation information are saved in 'segs' and 'nsegs' if
 258  * the loading is successful.  'maxsegs' must be set by caller
 259  * and must be at least 1 but less than 'dmat' nsegment.  It
 260  * indicates the number of elements in 'segs'.  'flags' must
 261  * have BUS_DMA_NOWAIT turned on.
 262  */
 263 int
 264 bus_dmamap_load_mbuf_segment(bus_dma_tag_t dmat, bus_dmamap_t map,
 265                              struct mbuf *mbuf,
 266                              bus_dma_segment_t *segs, int maxsegs,
 267                              int *nsegs, int flags);
 268
 269 /*
 270  * Like bus_dmamap_load_mbuf_segment, but it will call m_defrag()
 271  * and try reloading if low level code indicates too many fragments
 272  * in the '*mbuf'; 'mbuf' will be updated under this situation.
 273  */
 274 int
 275 bus_dmamap_load_mbuf_defrag(bus_dma_tag_t dmat, bus_dmamap_t map,
 276                             struct mbuf **mbuf,
 277                             bus_dma_segment_t *segs, int maxsegs,
 278                             int *nsegs, int flags);
 279
 280 /*
 281  * Convenient function to create coherent busdma memory
 282  */
 283 int
 284 bus_dmamem_coherent(bus_dma_tag_t parent,
 285                     bus_size_t alignment, bus_size_t boundary,
 286                     bus_addr_t lowaddr, bus_addr_t highaddr,
 287                     bus_size_t maxsize, int flags,
 288                     bus_dmamem_t *dmem);
 289
 290 /*
 291  * Simplified version of bus_dmamem_coherent() with:
 292  * boundary == 0
 293  * lowaddr  == BUS_SPACE_MAXADDR
 294  * highaddr == BUS_SPACE_MAXADDR
 295  *
 296  * 'parent' usually should not be NULL, so we could inherit
 297  * boundary, lowaddr and highaddr from it.
 298  */
 299 void *
 300 bus_dmamem_coherent_any(bus_dma_tag_t parent, bus_size_t alignment,
 301                         bus_size_t maxsize, int flags,
 302                         bus_dma_tag_t *dtag, bus_dmamap_t *dmap,
 303                         bus_addr_t *busaddr);
 304
 305 /*
 306  * Perform a syncronization operation on the given map.
 307  */
 308 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_dmasync_op_t);
 309 #define bus_dmamap_sync(dmat, dmamap, op)               \
 310         if ((dmamap) != NULL)                           \
 311                 _bus_dmamap_sync(dmat, dmamap, op)
 312
 313 /*
 314  * Release the mapping held by map.
 315  */
 316 void _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map);
 317 #define bus_dmamap_unload(dmat, dmamap)                 \
 318         if ((dmamap) != NULL)                           \
 319                 _bus_dmamap_unload(dmat, dmamap)
 320
 321 #endif /* _SYS_BUS_DMA_H_ */