api/spec/dma.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2021-2024 Nokia
 */
 
#ifndef ODP_API_SPEC_DMA_H_
#define ODP_API_SPEC_DMA_H_
#include <odp/visibility_begin.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <odp/api/dma_types.h>
#include <odp/api/pool_types.h>
 
int odp_dma_capability(odp_dma_capability_t *capa);
 
void odp_dma_param_init(odp_dma_param_t *param);
 
odp_dma_t odp_dma_create(const char *name, const odp_dma_param_t *param);
 
int odp_dma_destroy(odp_dma_t dma);
 
odp_dma_t odp_dma_lookup(const char *name);
 
void odp_dma_transfer_param_init(odp_dma_transfer_param_t *trs_param);
 
void odp_dma_compl_param_init(odp_dma_compl_param_t *compl_param);
 
int odp_dma_transfer(odp_dma_t dma, const odp_dma_transfer_param_t *trs_param,
             odp_dma_result_t *result);
 
int odp_dma_transfer_multi(odp_dma_t dma, const odp_dma_transfer_param_t *trs_param[],
               odp_dma_result_t *result[], int num);
 
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);
 
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);
 
int odp_dma_transfer_done(odp_dma_t dma, odp_dma_transfer_id_t transfer_id,
              odp_dma_result_t *result);
 
odp_dma_transfer_id_t odp_dma_transfer_id_alloc(odp_dma_t dma);
 
void odp_dma_transfer_id_free(odp_dma_t dma, odp_dma_transfer_id_t transfer_id);
 
uint64_t odp_dma_transfer_id_to_u64(odp_dma_transfer_id_t transfer_id);
 
uint64_t odp_dma_to_u64(odp_dma_t dma);
 
void odp_dma_print(odp_dma_t dma);
 
int odp_dma_compl_result(odp_dma_compl_t dma_compl, odp_dma_result_t *result);
 
odp_dma_compl_t odp_dma_compl_from_event(odp_event_t ev);
 
odp_event_t odp_dma_compl_to_event(odp_dma_compl_t dma_compl);
 
uint64_t odp_dma_compl_to_u64(odp_dma_compl_t dma_compl);
 
void *odp_dma_compl_user_area(odp_dma_compl_t dma_compl);
 
odp_dma_compl_t odp_dma_compl_alloc(odp_pool_t pool);
 
void odp_dma_compl_free(odp_dma_compl_t dma_compl);
 
void odp_dma_compl_print(odp_dma_compl_t dma_compl);
 
void odp_dma_pool_param_init(odp_dma_pool_param_t *pool_param);
 
odp_pool_t odp_dma_pool_create(const char *name, const odp_dma_pool_param_t *pool_param);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif