doca_eth_txq_cpu_data_path.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 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_ETH_TXQ_CPU_DATA_PATH_H_
#define DOCA_ETH_TXQ_CPU_DATA_PATH_H_
 
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_pe.h>
#include <doca_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**********************************************************************************************************************
 * DOCA core opaque types
 *********************************************************************************************************************/
 
struct doca_buf;
struct doca_task_batch;
 
struct doca_eth_txq;
 
struct doca_eth_txq_task_send;     
struct doca_eth_txq_task_lso_send; 
enum doca_eth_txq_ol_flags {
    DOCA_ETH_TXQ_OL_FLAGS_L3_CSUM = (1 << 0), 
    DOCA_ETH_TXQ_OL_FLAGS_L4_CSUM = (1 << 1), 
};
 
typedef void (*doca_eth_txq_task_send_completion_cb_t)(struct doca_eth_txq_task_send *task_send,
                               union doca_data task_user_data,
                               union doca_data ctx_user_data);
 
typedef void (*doca_eth_txq_task_lso_send_completion_cb_t)(struct doca_eth_txq_task_lso_send *task_lso_send,
                               union doca_data task_user_data,
                               union doca_data ctx_user_data);
 
typedef void (*doca_eth_txq_task_batch_send_completion_cb_t)(struct doca_task_batch *task_batch,
                                 uint16_t tasks_num,
                                 union doca_data ctx_user_data,
                                 union doca_data task_batch_user_data,
                                 union doca_data *task_user_data_array,
                                 struct doca_buf **pkt_array,
                                 doca_error_t *status_array);
 
typedef void (*doca_eth_txq_task_batch_lso_send_completion_cb_t)(struct doca_task_batch *task_batch,
                                 uint16_t tasks_num,
                                 union doca_data ctx_user_data,
                                 union doca_data task_batch_user_data,
                                 union doca_data *task_user_data_array,
                                 struct doca_buf **pkt_payload_array,
                                 struct doca_gather_list **headers_array,
                                 doca_error_t *status_array);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_send_set_conf(struct doca_eth_txq *eth_txq,
                         doca_eth_txq_task_send_completion_cb_t task_completion_cb,
                         doca_eth_txq_task_send_completion_cb_t task_error_cb,
                         uint32_t task_send_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_lso_send_set_conf(struct doca_eth_txq *eth_txq,
                         doca_eth_txq_task_lso_send_completion_cb_t task_completion_cb,
                         doca_eth_txq_task_lso_send_completion_cb_t task_error_cb,
                         uint32_t task_lso_send_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_send_set_conf(struct doca_eth_txq *eth_txq,
                           enum doca_task_batch_max_tasks_number max_tasks_number,
                           uint16_t num_task_batches,
                           doca_eth_txq_task_batch_send_completion_cb_t success_completion_cb,
                           doca_eth_txq_task_batch_send_completion_cb_t error_completion_cb);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_lso_send_set_conf(
    struct doca_eth_txq *eth_txq,
    enum doca_task_batch_max_tasks_number max_tasks_number,
    uint16_t num_task_batches,
    doca_eth_txq_task_batch_lso_send_completion_cb_t success_completion_cb,
    doca_eth_txq_task_batch_lso_send_completion_cb_t error_completion_cb);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_send_num_expand(struct doca_eth_txq *eth_txq, uint32_t task_send_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_lso_send_num_expand(struct doca_eth_txq *eth_txq, uint32_t task_lso_send_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_send_num_expand(struct doca_eth_txq *eth_txq, uint16_t task_batches_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_lso_send_num_expand(struct doca_eth_txq *eth_txq, uint16_t task_batches_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_send_allocate_init(struct doca_eth_txq *eth_txq,
                          struct doca_buf *pkt,
                          union doca_data user_data,
                          struct doca_eth_txq_task_send **task_send);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_lso_send_allocate_init(struct doca_eth_txq *eth_txq,
                              struct doca_buf *pkt_payload,
                              struct doca_gather_list *headers,
                              union doca_data user_data,
                              struct doca_eth_txq_task_lso_send **task_lso_send);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_send_allocate(struct doca_eth_txq *eth_txq,
                           uint16_t tasks_num,
                           union doca_data task_batch_user_data,
                           struct doca_buf ***pkt_array,
                           union doca_data **task_user_data_array,
                           struct doca_task_batch **task_batch);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_lso_send_allocate(struct doca_eth_txq *eth_txq,
                               uint16_t tasks_num,
                               union doca_data task_batch_user_data,
                               struct doca_buf ***pkt_payload_array,
                               struct doca_gather_list ***headers_array,
                               union doca_data **task_user_data_array,
                               struct doca_task_batch **task_batch);
 
DOCA_EXPERIMENTAL
void doca_eth_txq_task_send_set_pkt(struct doca_eth_txq_task_send *task_send, struct doca_buf *pkt);
 
DOCA_EXPERIMENTAL
void doca_eth_txq_task_lso_send_set_pkt_payload(struct doca_eth_txq_task_lso_send *task_lso_send,
                        struct doca_buf *pkt_payload);
 
DOCA_EXPERIMENTAL
void doca_eth_txq_task_lso_send_set_headers(struct doca_eth_txq_task_lso_send *task_lso_send,
                        struct doca_gather_list *headers);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_send_get_pkt(const struct doca_eth_txq_task_send *task_send, struct doca_buf **pkt);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_lso_send_get_pkt_payload(const struct doca_eth_txq_task_lso_send *task_lso_send,
                            struct doca_buf **pkt_payload);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_lso_send_get_headers(const struct doca_eth_txq_task_lso_send *task_lso_send,
                            struct doca_gather_list **headers);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_send_get_metadata_array(struct doca_eth_txq_task_send *task_send,
                               uint32_t **metadata_array);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_lso_send_get_metadata_array(struct doca_eth_txq_task_lso_send *task_lso_send,
                               uint32_t **metadata_array);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_send_get_metadata_array(struct doca_task_batch *task_batch_send,
                                 uint32_t **metadata_array);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_lso_send_get_metadata_array(struct doca_task_batch *task_batch_lso_send,
                                 uint32_t **metadata_array);
 
DOCA_EXPERIMENTAL
void doca_eth_txq_task_lso_send_set_mss(struct doca_eth_txq_task_lso_send *task_lso_send, uint16_t mss);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_lso_send_get_mss_array(struct doca_task_batch *task_batch_lso_send,
                                uint16_t **mss_array);
 
DOCA_EXPERIMENTAL
void doca_eth_txq_task_send_set_ol_flags(struct doca_eth_txq_task_send *task_send, uint16_t ol_flags);
 
DOCA_EXPERIMENTAL
void doca_eth_txq_task_lso_send_set_ol_flags(struct doca_eth_txq_task_lso_send *task_lso_send, uint16_t ol_flags);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_send_get_ol_flags_array(struct doca_task_batch *task_batch_send,
                                 uint16_t **ol_flags_array);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_task_batch_lso_send_get_ol_flags_array(struct doca_task_batch *task_batch_lso_send,
                                 uint16_t **ol_flags_array);
 
DOCA_EXPERIMENTAL
struct doca_task *doca_eth_txq_task_send_as_doca_task(struct doca_eth_txq_task_send *task_send);
 
DOCA_EXPERIMENTAL
struct doca_task *doca_eth_txq_task_lso_send_as_doca_task(struct doca_eth_txq_task_lso_send *task_lso_send);
 
#define doca_eth_txq_task_batch_metadata_array_get_metadata(metadata_array, metadata_num, packet_index, metadata_index) \
    metadata_array[packet_index * metadata_num + metadata_index]
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* DOCA_ETH_TXQ_CPU_DATA_PATH_H_ */