sys/sys/bus_dma.h

   1 /*      $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $    */
   2
   3 /*-
   4  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
   9  * NASA Ames Research Center.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the NetBSD
  22  *      Foundation, Inc. and its contributors.
  23  * 4. Neither the name of The NetBSD Foundation nor the names of its
  24  *    contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  */
  39
  40 /*
  41  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
  42  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
  43  *
  44  * Redistribution and use in source and binary forms, with or without
  45  * modification, are permitted provided that the following conditions
  46  * are met:
  47  * 1. Redistributions of source code must retain the above copyright
  48  *    notice, this list of conditions and the following disclaimer.
  49  * 2. Redistributions in binary form must reproduce the above copyright
  50  *    notice, this list of conditions and the following disclaimer in the
  51  *    documentation and/or other materials provided with the distribution.
  52  * 3. All advertising materials mentioning features or use of this software
  53  *    must display the following acknowledgement:
  54  *      This product includes software developed by Christopher G. Demetriou
  55  *      for the NetBSD Project.
  56  * 4. The name of the author may not be used to endorse or promote products
  57  *    derived from this software without specific prior written permission
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  60  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  61  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  62  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  63  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  64  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  65  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  66  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  67  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  68  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  69  */
  70 /* $FreeBSD$ */
  71
  72 #ifndef _I386_BUS_DMA_H_
  73 #define _I386_BUS_DMA_H_
  74
  75 /*
  76  * Flags used in various bus DMA methods.
  77  */
  78 #define BUS_DMA_WAITOK          0x00    /* safe to sleep (pseudo-flag) */
  79 #define BUS_DMA_NOWAIT          0x01    /* not safe to sleep */
  80 #define BUS_DMA_ALLOCNOW        0x02    /* perform resource allocation now */
  81 #define BUS_DMA_COHERENT        0x04    /* hint: map memory in a coherent way */
  82 #define BUS_DMA_ZERO            0x08    /* allocate zero'ed memory */
  83 #define BUS_DMA_BUS1            0x10    /* placeholders for bus functions... */
  84 #define BUS_DMA_BUS2            0x20
  85 #define BUS_DMA_BUS3            0x40
  86 #define BUS_DMA_BUS4            0x80
  87
  88 /* Forwards needed by prototypes below. */
  89 struct mbuf;
  90 struct uio;
  91
  92 /*
  93  * Operations performed by bus_dmamap_sync().
  94  */
  95 typedef int bus_dmasync_op_t;
  96 #define BUS_DMASYNC_PREREAD     1
  97 #define BUS_DMASYNC_POSTREAD    2
  98 #define BUS_DMASYNC_PREWRITE    4
  99 #define BUS_DMASYNC_POSTWRITE   8
 100
 101 /*
 102  *      bus_dma_tag_t
 103  *
 104  *      A machine-dependent opaque type describing the characteristics
 105  *      of how to perform DMA mappings.  This structure encapsultes
 106  *      information concerning address and alignment restrictions, number
 107  *      of S/G segments, amount of data per S/G segment, etc.
 108  */
 109 typedef struct bus_dma_tag      *bus_dma_tag_t;
 110
 111 /*
 112  *      bus_dmamap_t
 113  *
 114  *      DMA mapping instance information.
 115  */
 116 typedef struct bus_dmamap       *bus_dmamap_t;
 117
 118 /*
 119  *      bus_dma_segment_t
 120  *
 121  *      Describes a single contiguous DMA transaction.  Values
 122  *      are suitable for programming into DMA registers.
 123  */
 124 typedef struct bus_dma_segment {
 125         bus_addr_t      ds_addr;        /* DMA address */
 126         bus_size_t      ds_len;         /* length of transfer */
 127 } bus_dma_segment_t;
 128
 129 /*
 130  * A function that returns 1 if the address cannot be accessed by
 131  * a device and 0 if it can be.
 132  */
 133 typedef int bus_dma_filter_t(void *, bus_addr_t);
 134
 135 /*
 136  * A function that performs driver-specific synchronization on behalf of
 137  * busdma.
 138  */
 139 typedef enum {
 140         BUS_DMA_LOCK    = 0x01,
 141         BUS_DMA_UNLOCK  = 0x02,
 142 } bus_dma_lock_op_t;
 143
 144 typedef void bus_dma_lock_t(void *, bus_dma_lock_op_t);
 145
 146 /*
 147  * Allocate a device specific dma_tag encapsulating the constraints of
 148  * the parent tag in addition to other restrictions specified:
 149  *
 150  *      alignment:      Alignment for segments.
 151  *      boundary:       Boundary that segments cannot cross.
 152  *      lowaddr:        Low restricted address that cannot appear in a mapping.
 153  *      highaddr:       High restricted address that cannot appear in a mapping.
 154  *      filtfunc:       An optional function to further test if an address
 155  *                      within the range of lowaddr and highaddr cannot appear
 156  *                      in a mapping.
 157  *      filtfuncarg:    An argument that will be passed to filtfunc in addition
 158  *                      to the address to test.
 159  *      maxsize:        Maximum mapping size supported by this tag.
 160  *      nsegments:      Number of discontinuities allowed in maps.
 161  *      maxsegsz:       Maximum size of a segment in the map.
 162  *      flags:          Bus DMA flags.
 163  *      lockfunc:       An optional function to handle driver-defined lock
 164  *                      operations.
 165  *      lockfuncarg:    An argument that will be passed to lockfunc in addition
 166  *                      to the lock operation.
 167  *      dmat:           A pointer to set to a valid dma tag should the return
 168  *                      value of this function indicate success.
 169  */
 170 /* XXX Should probably allow specification of alignment */
 171 int bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
 172                        bus_size_t boundary, bus_addr_t lowaddr,
 173                        bus_addr_t highaddr, bus_dma_filter_t *filtfunc,
 174                        void *filtfuncarg, bus_size_t maxsize, int nsegments,
 175                        bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
 176                        void *lockfuncarg, bus_dma_tag_t *dmat);
 177
 178 int bus_dma_tag_destroy(bus_dma_tag_t dmat);
 179
 180 /*
 181  * Allocate a handle for mapping from kva/uva/physical
 182  * address space into bus device space.
 183  */
 184 int bus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
 185
 186 /*
 187  * Destroy a handle for mapping from kva/uva/physical
 188  * address space into bus device space.
 189  */
 190 int bus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map);
 191
 192 /*
 193  * Allocate a piece of memory that can be efficiently mapped into
 194  * bus device space based on the constraints listed in the dma tag.
 195  * A dmamap to for use with dmamap_load is also allocated.
 196  */
 197 int bus_dmamem_alloc(bus_dma_tag_t dmat, void** vaddr, int flags,
 198                      bus_dmamap_t *mapp);
 199
 200 /*
 201  * Free a piece of memory and its allocated dmamap, that was allocated
 202  * via bus_dmamem_alloc.
 203  */
 204 void bus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
 205
 206 /*
 207  * A function that processes a successfully loaded dma map or an error
 208  * from a delayed load map.
 209  */
 210 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
 211
 212 /*
 213  * Map the buffer buf into bus space using the dmamap map.
 214  */
 215 int bus_dmamap_load(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
 216                     bus_size_t buflen, bus_dmamap_callback_t *callback,
 217                     void *callback_arg, int flags);
 218
 219 /*
 220  * Like bus_dmamap_callback but includes map size in bytes.  This is
 221  * defined as a separate interface to maintain compatibility for users
 222  * of bus_dmamap_callback_t--at some point these interfaces should be merged.
 223  */
 224 typedef void bus_dmamap_callback2_t(void *, bus_dma_segment_t *, int, bus_size_t, int);
 225 /*
 226  * Like bus_dmamap_load but for mbufs.  Note the use of the
 227  * bus_dmamap_callback2_t interface.
 228  */
 229 int bus_dmamap_load_mbuf(bus_dma_tag_t dmat, bus_dmamap_t map,
 230                          struct mbuf *mbuf,
 231                          bus_dmamap_callback2_t *callback, void *callback_arg,
 232                          int flags);
 233 /*
 234  * Like bus_dmamap_load but for uios.  Note the use of the
 235  * bus_dmamap_callback2_t interface.
 236  */
 237 int bus_dmamap_load_uio(bus_dma_tag_t dmat, bus_dmamap_t map,
 238                         struct uio *ui,
 239                         bus_dmamap_callback2_t *callback, void *callback_arg,
 240                         int flags);
 241
 242 /*
 243  * Perform a synchronization operation on the given map.
 244  */
 245 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_dmasync_op_t);
 246 #define bus_dmamap_sync(dmat, dmamap, op)               \
 247         if ((dmamap) != NULL)                           \
 248                 _bus_dmamap_sync(dmat, dmamap, op)
 249
 250 /*
 251  * Release the mapping held by map.
 252  */
 253 void _bus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map);
 254 #define bus_dmamap_unload(dmat, dmamap)                 \
 255         if ((dmamap) != NULL)                           \
 256                 _bus_dmamap_unload(dmat, dmamap)
 257
 258 /*
 259  * Generic helper function for manipulating mutexes.
 260  */
 261 void busdma_lock_mutex(void *arg, bus_dma_lock_op_t op);
 262 #endif /* _I386_BUS_DMA_H_ */