doca_sta_io_non_offload.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_STA_IO_NON_OFFLOAD_H_
#define DOCA_STA_IO_NON_OFFLOAD_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include <doca_error.h>
#include <doca_types.h>
 
#include <doca_sta_handle.h>
#include <doca_sta_task.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DOCA_STA_NVMEF_COMPLETION_SIZE (16)
 
typedef uint8_t doca_sta_nvmef_completion_t[DOCA_STA_NVMEF_COMPLETION_SIZE];
 
struct doca_sta_io;
 
typedef void (*doca_sta_io_non_offload_cb_t)(struct doca_sta_qp_handle *qp_handle,
                         union doca_data user_data,
                         const uint8_t *nvme_cmd,
                         uint8_t *payload,
                         uint32_t payload_len,
                         bool payload_valid,
                         union doca_data non_offload_user_data);
 
DOCA_EXPERIMENTAL
doca_error_t doca_sta_io_non_offload_register_cb(struct doca_sta_io *sta_io,
                         doca_sta_io_non_offload_cb_t non_offload_cb,
                         union doca_data user_data);
 
DOCA_EXPERIMENTAL
doca_error_t doca_sta_io_task_non_offload_set_rdma_write_send_conf(struct doca_sta_io *sta_io,
                                   doca_sta_task_completion_cb_t task_completion_cb,
                                   doca_sta_task_completion_cb_t task_error_cb);
DOCA_EXPERIMENTAL
doca_error_t doca_sta_io_task_non_offload_set_rdma_read_conf(struct doca_sta_io *sta_io,
                                 doca_sta_task_completion_cb_t task_completion_cb,
                                 doca_sta_task_completion_cb_t task_error_cb);
 
DOCA_EXPERIMENTAL
doca_error_t doca_sta_io_task_non_offload_rdma_write_send_alloc_init(struct doca_sta_io *sta_io,
                                     union doca_data user_data,
                                     struct doca_sta_qp_handle *qp_handle,
                                     doca_sta_nvmef_completion_t completion,
                                     union doca_data non_offload_user_data,
                                     struct doca_sta_producer_task_send **task);
 
DOCA_EXPERIMENTAL
doca_error_t doca_sta_io_task_non_offload_rdma_send_alloc_init(struct doca_sta_io *sta_io,
                                   union doca_data user_data,
                                   struct doca_sta_qp_handle *qp_handle,
                                   doca_sta_nvmef_completion_t completion,
                                   union doca_data non_offload_user_data,
                                   struct doca_sta_producer_task_send **task);
 
DOCA_EXPERIMENTAL
doca_error_t doca_sta_io_task_non_offload_rdma_read_alloc_init(struct doca_sta_io *sta_io,
                                   union doca_data user_data,
                                   struct doca_sta_qp_handle *qp_handle,
                                   union doca_data non_offload_user_data,
                                   struct doca_sta_producer_task_send **task);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_STA_IO_NON_OFFLOAD_H_ */