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