NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_dma.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
22 #ifndef DOCA_DMA_H_
23 #define DOCA_DMA_H_
24 
25 #include <inttypes.h>
26 
27 #include <doca_compat.h>
28 #include <doca_error.h>
29 #include <doca_types.h>
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /**********************************************************************************************************************
36  * DOCA core opaque types
37  *********************************************************************************************************************/
38 
39 struct doca_buf;
40 struct doca_ctx;
41 struct doca_dev;
42 struct doca_devinfo;
43 struct doca_gpu_dma;
44 
51 struct doca_dma_task_memcpy;
52 
77 typedef void (*doca_dma_task_memcpy_completion_cb_t)(struct doca_dma_task_memcpy *task,
78  union doca_data task_user_data,
79  union doca_data ctx_user_data);
80 
81 /*********************************************************************************************************************
82  * DOCA DMA Context
83  *********************************************************************************************************************/
84 
88 struct doca_dma;
89 
105 DOCA_STABLE
106 doca_error_t doca_dma_create(struct doca_dev *dev, struct doca_dma **dma);
107 
118 DOCA_STABLE
119 doca_error_t doca_dma_destroy(struct doca_dma *dma);
120 
134 DOCA_STABLE
135 doca_error_t doca_dma_cap_task_memcpy_is_supported(const struct doca_devinfo *devinfo);
136 
146 DOCA_STABLE
147 struct doca_ctx *doca_dma_as_ctx(struct doca_dma *dma);
148 
164 DOCA_STABLE
165 doca_error_t doca_dma_cap_get_max_num_tasks(struct doca_dma *dma, uint32_t *max_num_tasks);
166 
182 DOCA_STABLE
183 doca_error_t doca_dma_cap_task_memcpy_get_max_buf_list_len(const struct doca_devinfo *devinfo,
184  uint32_t *max_buf_list_len);
185 
200 DOCA_STABLE
201 doca_error_t doca_dma_cap_task_memcpy_get_max_buf_size(const struct doca_devinfo *devinfo, uint64_t *buf_size);
202 
221 DOCA_STABLE
222 doca_error_t doca_dma_task_memcpy_set_conf(struct doca_dma *dma,
223  doca_dma_task_memcpy_completion_cb_t task_completion_cb,
224  doca_dma_task_memcpy_completion_cb_t task_error_cb,
225  uint32_t num_memcpy_tasks);
226 
246 DOCA_STABLE
247 doca_error_t doca_dma_task_memcpy_alloc_init(struct doca_dma *dma,
248  const struct doca_buf *src,
249  struct doca_buf *dst,
250  union doca_data user_data,
251  struct doca_dma_task_memcpy **task);
252 
261 DOCA_STABLE
262 struct doca_task *doca_dma_task_memcpy_as_task(struct doca_dma_task_memcpy *task);
263 
272 DOCA_STABLE
273 void doca_dma_task_memcpy_set_src(struct doca_dma_task_memcpy *task, const struct doca_buf *src);
274 
283 DOCA_STABLE
284 const struct doca_buf *doca_dma_task_memcpy_get_src(const struct doca_dma_task_memcpy *task);
285 
294 DOCA_STABLE
295 void doca_dma_task_memcpy_set_dst(struct doca_dma_task_memcpy *task, struct doca_buf *dst);
296 
305 DOCA_STABLE
306 struct doca_buf *doca_dma_task_memcpy_get_dst(const struct doca_dma_task_memcpy *task);
307 
322 DOCA_EXPERIMENTAL
323 doca_error_t doca_dma_get_gpu_handle(struct doca_dma *dma, struct doca_gpu_dma **gpu_dma);
324 
325 #ifdef __cplusplus
326 } /* extern "C" */
327 #endif
328 
329 #endif /* DOCA_DMA_H_ */
330 
task_error_cb
static void task_error_cb(struct doca_task *se_task, union doca_data task_user_data, union doca_data ctx_user_data)
Definition: common_common.c:65
task_completion_cb
static void task_completion_cb(struct doca_task *se_task, union doca_data task_user_data, union doca_data ctx_user_data)
Definition: common_common.c:48
doca_compat.h
doca_error.h
doca_types.h
src
static uint64_t *restrict src
Definition: dpaintrin.h:230
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
DOCA_STABLE
#define DOCA_STABLE
To set a Symbol (or specifically a function) as stable API, i.e. it won't be changed.
Definition: doca_compat.h:96
doca_dma_get_gpu_handle
DOCA_EXPERIMENTAL doca_error_t doca_dma_get_gpu_handle(struct doca_dma *dma, struct doca_gpu_dma **gpu_dma)
Retrieve the handle in the GPU memory space of a doca_dma.
doca_dma_task_memcpy_get_src
DOCA_STABLE const struct doca_buf * doca_dma_task_memcpy_get_src(const struct doca_dma_task_memcpy *task)
This method gets source buffer from memcpy task.
doca_dma_task_memcpy_as_task
DOCA_STABLE struct doca_task * doca_dma_task_memcpy_as_task(struct doca_dma_task_memcpy *task)
This method converts a memcpy task to doca_task.
doca_dma_task_memcpy_set_dst
DOCA_STABLE void doca_dma_task_memcpy_set_dst(struct doca_dma_task_memcpy *task, struct doca_buf *dst)
This method sets destination buffer to memcpy task.
doca_dma_task_memcpy_alloc_init
DOCA_STABLE doca_error_t doca_dma_task_memcpy_alloc_init(struct doca_dma *dma, const struct doca_buf *src, struct doca_buf *dst, union doca_data user_data, struct doca_dma_task_memcpy **task)
This method allocates and initializes a DMA memcpy task.
doca_dma_cap_task_memcpy_get_max_buf_list_len
DOCA_STABLE doca_error_t doca_dma_cap_task_memcpy_get_max_buf_list_len(const struct doca_devinfo *devinfo, uint32_t *max_buf_list_len)
doca_dma_as_ctx
DOCA_STABLE struct doca_ctx * doca_dma_as_ctx(struct doca_dma *dma)
doca_dma_task_memcpy_set_src
DOCA_STABLE void doca_dma_task_memcpy_set_src(struct doca_dma_task_memcpy *task, const struct doca_buf *src)
This method sets source buffer to memcpy task.
doca_dma_task_memcpy_get_dst
DOCA_STABLE struct doca_buf * doca_dma_task_memcpy_get_dst(const struct doca_dma_task_memcpy *task)
This method gets destination buffer from memcpy task.
doca_dma_cap_get_max_num_tasks
DOCA_STABLE doca_error_t doca_dma_cap_get_max_num_tasks(struct doca_dma *dma, uint32_t *max_num_tasks)
doca_dma_task_memcpy_set_conf
DOCA_STABLE doca_error_t doca_dma_task_memcpy_set_conf(struct doca_dma *dma, doca_dma_task_memcpy_completion_cb_t task_completion_cb, doca_dma_task_memcpy_completion_cb_t task_error_cb, uint32_t num_memcpy_tasks)
This method sets the DMA memcpy tasks configuration.
doca_dma_task_memcpy_completion_cb_t
void(* doca_dma_task_memcpy_completion_cb_t)(struct doca_dma_task_memcpy *task, union doca_data task_user_data, union doca_data ctx_user_data)
Function to execute on DMA memcpy task completion.
Definition: doca_dma.h:77
doca_dma_cap_task_memcpy_is_supported
DOCA_STABLE doca_error_t doca_dma_cap_task_memcpy_is_supported(const struct doca_devinfo *devinfo)
doca_dma_cap_task_memcpy_get_max_buf_size
DOCA_STABLE doca_error_t doca_dma_cap_task_memcpy_get_max_buf_size(const struct doca_devinfo *devinfo, uint64_t *buf_size)
doca_dma_create
DOCA_STABLE doca_error_t doca_dma_create(struct doca_dev *dev, struct doca_dma **dma)
doca_dma_destroy
DOCA_STABLE doca_error_t doca_dma_destroy(struct doca_dma *dma)
doca_error_t
enum doca_error doca_error_t
DOCA API return codes.
doca_data
Convenience type for representing opaque data.
Definition: doca_types.h:56