sys/sys/_bus_dma.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright 2006 John-Mark Gurney.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  *
  30  */
  31
  32 #ifndef _SYS__BUS_DMA_H_
  33 #define _SYS__BUS_DMA_H_
  34
  35 typedef int bus_dmasync_op_t;
  36
  37 /*
  38  *      bus_dma_tag_t
  39  *
  40  *      A machine-dependent opaque type describing the characteristics
  41  *      of how to perform DMA mappings.  This structure encapsultes
  42  *      information concerning address and alignment restrictions, number
  43  *      of S/G segments, amount of data per S/G segment, etc.
  44  */
  45 typedef struct bus_dma_tag      *bus_dma_tag_t;
  46
  47 /*
  48  *      bus_dmamap_t
  49  *
  50  *      DMA mapping instance information.
  51  */
  52 typedef struct bus_dmamap       *bus_dmamap_t;
  53
  54 /*
  55  * A function that performs driver-specific synchronization on behalf of
  56  * busdma.
  57  */
  58 typedef enum {
  59         BUS_DMA_LOCK    = 0x01,
  60         BUS_DMA_UNLOCK  = 0x02,
  61 } bus_dma_lock_op_t;
  62
  63 typedef void bus_dma_lock_t(void *, bus_dma_lock_op_t);
  64
  65 #endif /* !_SYS__BUS_DMA_H_ */