doca_eth_txq.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_H_
#define DOCA_ETH_TXQ_H_
 
#include <stdint.h>
 
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**********************************************************************************************************************
 * DOCA core opaque types
 *********************************************************************************************************************/
 
struct doca_ctx;
struct doca_dev;
struct doca_devinfo;
 
/*********************************************************************************************************************
 * DOCA ETH TXQ Context
 *********************************************************************************************************************/
 
struct doca_eth_txq;
struct doca_gpu_eth_txq;
 
enum doca_eth_txq_type {
    DOCA_ETH_TXQ_TYPE_REGULAR = 0,
};
 
enum doca_eth_txq_data_path_type {
    DOCA_ETH_TXQ_DATA_PATH_TYPE_CPU = 0, 
    DOCA_ETH_TXQ_DATA_PATH_TYPE_GPU,     
};
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_create(struct doca_dev *dev, uint32_t max_burst_size, struct doca_eth_txq **eth_txq);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_destroy(struct doca_eth_txq *eth_txq);
 
DOCA_EXPERIMENTAL
struct doca_ctx *doca_eth_txq_as_doca_ctx(struct doca_eth_txq *eth_txq);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_max_burst_size(struct doca_eth_txq *eth_txq, uint32_t max_burst_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_max_send_buf_list_len(struct doca_eth_txq *eth_txq, uint32_t max_send_buf_list_len);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_metadata_num(struct doca_eth_txq *eth_txq, uint8_t metadata_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_mss(struct doca_eth_txq *eth_txq, uint16_t mss);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_max_lso_header_size(struct doca_eth_txq *eth_txq, uint16_t max_lso_header_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_type(struct doca_eth_txq *eth_txq, enum doca_eth_txq_type type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_l3_chksum_offload(struct doca_eth_txq *eth_txq, uint8_t enable_l3_chksum);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_l4_chksum_offload(struct doca_eth_txq *eth_txq, uint8_t enable_l4_chksum);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_set_wait_on_time_offload(struct doca_eth_txq *eth_txq);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_get_gpu_handle(const struct doca_eth_txq *eth_txq, struct doca_gpu_eth_txq **eth_txq_ext);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_get_max_burst_size(const struct doca_devinfo *devinfo,
                         uint32_t max_send_buf_list_len,
                         uint16_t max_lso_header_size,
                         uint32_t *max_burst_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_get_max_send_buf_list_len(const struct doca_devinfo *devinfo,
                            uint32_t *max_send_buf_list_len);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_get_max_metadata_num(const struct doca_devinfo *devinfo, uint8_t *max_metadata_num);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_get_max_lso_header_size(const struct doca_devinfo *devinfo,
                              uint16_t *max_lso_header_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_is_type_supported(const struct doca_devinfo *devinfo,
                        enum doca_eth_txq_type type,
                        enum doca_eth_txq_data_path_type data_path_type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_is_l3_chksum_offload_supported(const struct doca_devinfo *devinfo);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_is_l4_chksum_offload_supported(const struct doca_devinfo *devinfo);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_get_max_lso_msg_size(const struct doca_devinfo *devinfo, uint32_t *max_lso_msg_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_cap_get_wait_on_time_offload_supported(const struct doca_devinfo *devinfo,
                                 enum doca_eth_wait_on_time_type *wait_on_time_mode);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_calculate_timestamp(struct doca_eth_txq *eth_txq,
                          uint64_t timestamp_ns,
                          uint64_t *wait_on_time_value);
 
DOCA_EXPERIMENTAL
doca_error_t doca_eth_txq_get_flow_queue_id(struct doca_eth_txq *eth_txq, uint16_t *flow_queue_id);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* DOCA_ETH_TXQ_H_ */