API Reference Manual  1.45.0
api/spec/dma_types.h File Reference

ODP DMA. More...

#include <odp/visibility_begin.h>
#include <odp/api/event_types.h>
#include <odp/api/packet_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
#include <odp/visibility_end.h>
Include dependency graph for api/spec/dma_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  odp_dma_pool_capability_t
 DMA completion event pool capabilities. More...
 
struct  odp_dma_pool_param_t
 DMA completion event pool parameters. More...
 
struct  odp_dma_capability_t
 DMA capabilities. More...
 
struct  odp_dma_param_t
 DMA session parameters. More...
 
struct  odp_dma_seg_t
 DMA segment. More...
 
struct  odp_dma_transfer_param_t
 DMA transfer parameters. More...
 
struct  odp_dma_compl_param_t
 DMA transfer completion parameters. More...
 
struct  odp_dma_result_t
 DMA transfer results. More...
 

Macros

#define ODP_DMA_MAIN_TO_MAIN   0x1u
 DMA transfer within the main memory.
 
#define ODP_DMA_TYPE_COPY   0x1u
 Copy data. More...
 
#define ODP_DMA_COMPL_NONE   0x1u
 No completion indication. More...
 
#define ODP_DMA_COMPL_SYNC   0x2u
 Synchronous transfer. More...
 
#define ODP_DMA_COMPL_EVENT   0x4u
 Asynchronous transfer with completion event. More...
 
#define ODP_DMA_COMPL_POLL   0x8u
 Asynchronous transfer with completion polling. More...
 

Typedefs

typedef struct odp_dma_pool_capability_t odp_dma_pool_capability_t
 DMA completion event pool capabilities. More...
 
typedef struct odp_dma_pool_param_t odp_dma_pool_param_t
 DMA completion event pool parameters.
 
typedef uint32_t odp_dma_direction_t
 DMA transfer direction. More...
 
typedef uint32_t odp_dma_transfer_type_t
 DMA transfer type. More...
 
typedef uint32_t odp_dma_compl_mode_t
 DMA transfer completion mode. More...
 
typedef struct odp_dma_capability_t odp_dma_capability_t
 DMA capabilities.
 
typedef struct odp_dma_param_t odp_dma_param_t
 DMA session parameters.
 
typedef struct odp_dma_seg_t odp_dma_seg_t
 DMA segment.
 
typedef struct odp_dma_transfer_param_t odp_dma_transfer_param_t
 DMA transfer parameters. More...
 
typedef struct odp_dma_compl_param_t odp_dma_compl_param_t
 DMA transfer completion parameters.
 
typedef struct odp_dma_result_t odp_dma_result_t
 DMA transfer results.
 

Enumerations

enum  odp_dma_data_format_t { ODP_DMA_FORMAT_ADDR = 0 , ODP_DMA_FORMAT_PACKET }
 DMA transfer data format. More...
 
enum  odp_dma_transfer_order_t { ODP_DMA_ORDER_NONE = 0 , ODP_DMA_ORDER_COMPL , ODP_DMA_ORDER_ALL }
 DMA transfer ordering. More...
 
enum  odp_dma_mt_mode_t { ODP_DMA_MT_SAFE = 0 , ODP_DMA_MT_SERIAL }
 DMA transfer multi-thread safeness. More...
 

Detailed Description

ODP DMA.

Definition in file api/spec/dma_types.h.