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

ODP DMA. More...

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

Go to the source code of this file.

Functions

int odp_dma_capability (odp_dma_capability_t *capa)
 Query DMA capabilities. More...
 
void odp_dma_param_init (odp_dma_param_t *param)
 Initialize DMA session parameters. More...
 
odp_dma_t odp_dma_create (const char *name, const odp_dma_param_t *param)
 Create DMA session. More...
 
int odp_dma_destroy (odp_dma_t dma)
 Destroy DMA session. More...
 
odp_dma_t odp_dma_lookup (const char *name)
 Find DMA session by name. More...
 
void odp_dma_transfer_param_init (odp_dma_transfer_param_t *trs_param)
 Initialize DMA transfer parameters. More...
 
void odp_dma_compl_param_init (odp_dma_compl_param_t *compl_param)
 Initialize DMA transfer completion parameters. More...
 
int odp_dma_transfer (odp_dma_t dma, const odp_dma_transfer_param_t *trs_param, odp_dma_result_t *result)
 Perform DMA transfer. More...
 
int odp_dma_transfer_multi (odp_dma_t dma, const odp_dma_transfer_param_t *trs_param[], odp_dma_result_t *result[], int num)
 Perform multiple DMA transfers. More...
 
int odp_dma_transfer_start (odp_dma_t dma, const odp_dma_transfer_param_t *trs_param, const odp_dma_compl_param_t *compl_param)
 Start DMA transfer. More...
 
int odp_dma_transfer_start_multi (odp_dma_t dma, const odp_dma_transfer_param_t *trs_param[], const odp_dma_compl_param_t *compl_param[], int num)
 Start multiple DMA transfers. More...
 
int odp_dma_transfer_done (odp_dma_t dma, odp_dma_transfer_id_t transfer_id, odp_dma_result_t *result)
 Check if DMA transfer has completed. More...
 
odp_dma_transfer_id_t odp_dma_transfer_id_alloc (odp_dma_t dma)
 Allocate DMA transfer identifier. More...
 
void odp_dma_transfer_id_free (odp_dma_t dma, odp_dma_transfer_id_t transfer_id)
 Free DMA transfer identifier. More...
 
uint64_t odp_dma_to_u64 (odp_dma_t dma)
 Get printable value for DMA session handle. More...
 
void odp_dma_print (odp_dma_t dma)
 Print debug info about DMA session. More...
 
int odp_dma_compl_result (odp_dma_compl_t dma_compl, odp_dma_result_t *result)
 Check DMA completion event. More...
 
odp_dma_compl_t odp_dma_compl_from_event (odp_event_t ev)
 Convert event to DMA completion event. More...
 
odp_event_t odp_dma_compl_to_event (odp_dma_compl_t dma_compl)
 Convert DMA completion event to event. More...
 
uint64_t odp_dma_compl_to_u64 (odp_dma_compl_t dma_compl)
 Get printable value for DMA completion event handle. More...
 
void * odp_dma_compl_user_area (odp_dma_compl_t dma_compl)
 DMA completion event user area. More...
 
odp_dma_compl_t odp_dma_compl_alloc (odp_pool_t pool)
 Allocate DMA completion event. More...
 
void odp_dma_compl_free (odp_dma_compl_t dma_compl)
 Free DMA completion event. More...
 
void odp_dma_compl_print (odp_dma_compl_t dma_compl)
 Print DMA completion event debug information. More...
 
void odp_dma_pool_param_init (odp_dma_pool_param_t *pool_param)
 Initialize DMA completion event pool parameters. More...
 
odp_pool_t odp_dma_pool_create (const char *name, const odp_dma_pool_param_t *pool_param)
 Create DMA completion event pool. More...
 

Detailed Description

ODP DMA.

Definition in file api/spec/dma.h.