libmetal
dma.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of Xilinx nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without
16  * specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * @file dma.h
33  * @brief DMA primitives for libmetal.
34  */
35 
36 #ifndef __METAL_DMA__H__
37 #define __METAL_DMA__H__
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
46 #include <stdint.h>
47 #include "metal/sys.h"
48 
49 #define METAL_DMA_DEV_R 1
50 #define METAL_DMA_DEV_W 2
51 #define METAL_DMA_DEV_WR 3
56 struct metal_sg {
57  void *virt;
58  struct metal_io_region *io;
59  int len;
60 };
61 
62 struct metal_device;
63 
76 int metal_dma_map(struct metal_device *dev,
77  uint32_t dir,
78  struct metal_sg *sg_in,
79  int nents_in,
80  struct metal_sg *sg_out);
81 
92 void metal_dma_unmap(struct metal_device *dev,
93  uint32_t dir,
94  struct metal_sg *sg,
95  int nents);
96 
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif /* __METAL_DMA__H__ */
int metal_dma_map(struct metal_device *dev, uint32_t dir, struct metal_sg *sg_in, int nents_in, struct metal_sg *sg_out)
Map memory for DMA transaction. After the memory is DMA mapped, the memory should be accessed by the ...
Definition: dma.c:38
Definition: device.h:95
struct metal_io_region * io
Definition: dma.h:58
void metal_dma_unmap(struct metal_device *dev, uint32_t dir, struct metal_sg *sg, int nents)
Unmap DMA memory After the memory is DMA unmapped, the memory should be accessed by the CPU but not t...
Definition: dma.c:64
int len
Definition: dma.h:59
void * virt
Definition: dma.h:57
Definition: io.h:86
scatter/gather list element structure
Definition: dma.h:56