doca_pcc_dev.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_PCC_DEV_H_
#define DOCA_PCC_DEV_H_
 
#define DOCA_DPA_DEVICE
 
#include <doca_pcc_dev_common.h>
#include <doca_pcc_dev_utils.h>
#include <doca_pcc_dev_services.h>
#include <doca_pcc_dev_data_structures.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    DOCA_PCC_DEV_EVNT_NULL = 0,          
    DOCA_PCC_DEV_EVNT_FW = 1,            
    DOCA_PCC_DEV_EVNT_ROCE_CNP = 2,          
    DOCA_PCC_DEV_EVNT_ROCE_TX = 3,           
    DOCA_PCC_DEV_EVNT_ROCE_ACK = 4,          
    DOCA_PCC_DEV_EVNT_ROCE_NACK = 5,         
    DOCA_PCC_DEV_EVNT_RTT = 6,           
    DOCA_PCC_DEV_EVNT_ROCE_TX_FOR_ACK_NACK = 31, 
} doca_pcc_dev_event_type_enum;
 
typedef enum {
    DOCA_PCC_DEV_NACK_EVNT_NULL = 0,     
    DOCA_PCC_DEV_NACK_EVNT_RNR = 1,      
    DOCA_PCC_DEV_NACK_EVNT_OOS = 2,      
    DOCA_PCC_DEV_NACK_EVNT_DUP_READ = 3, 
} doca_pcc_dev_nack_event_sub_type_enum;
 
typedef struct doca_pcc_dev_results {
    uint32_t rate; 
    union {
        uint32_t rtt_req;   
        uint32_t probe_req; 
    };
    uint32_t probe_type_slot; 
    uint32_t credits;     
    uint32_t reload_credits;  
} doca_pcc_dev_results_t;
 
#if __NV_DPA >= __NV_DPA_CX8
#define DOCA_PCC_DEV_ACK_NACK_TX_EVENT_DISABLED_SUPPORTED (1) 
#else
#define DOCA_PCC_DEV_ACK_NACK_TX_EVENT_DISABLED_SUPPORTED (0)
#endif
 
#define DOCA_PCC_DEV_TX_FLAG_ACK_EXPECTED (1 << 0)
 
#define DOCA_PCC_DEV_TX_FLAG_OVERLOADED (1 << 1)
 
#define DOCA_PCC_DEV_TX_FLAG_RTT_REQ_SENT (1 << 2)
 
#define DOCA_PCC_DEV_LOG_MAX_RATE (20) /* rate format in fixed point 20 */
 
#define DOCA_PCC_DEV_MAX_RATE (1U << DOCA_PCC_DEV_LOG_MAX_RATE)
 
#define DOCA_PCC_DEV_DEFAULT_RATE ((DOCA_PCC_DEV_MAX_RATE >> 8) > (1) ? (DOCA_PCC_DEV_MAX_RATE >> 8) : (1))
 
#define DOCA_PCC_DEV_MAX_NUM_USER_SLOTS (8)
 
#define DOCA_PCC_DEV_MAX_NUM_ALGOS (8)
 
#define DOCA_PCC_DEV_MAX_NUM_PARAMS_PER_ALGO (0x26)
 
#define DOCA_PCC_DEV_MAX_NUM_COUNTERS_PER_ALGO (0x3F)
 
#define DOCA_PCC_DEV_ALGO_SLOT_INTERNAL (0xF)
 
#define DOCA_PCC_DEV_ALGO_INDEX_INTERNAL (0xF)
 
DOCA_STABLE
void doca_pcc_dev_default_internal_algo(doca_pcc_dev_algo_ctxt_t *algo_ctxt,
                    doca_pcc_dev_event_t *event,
                    const doca_pcc_dev_attr_t *attr,
                    doca_pcc_dev_results_t *results);
 
DOCA_STABLE
void doca_pcc_dev_user_algo(doca_pcc_dev_algo_ctxt_t *algo_ctxt,
                doca_pcc_dev_event_t *event,
                const doca_pcc_dev_attr_t *attr,
                doca_pcc_dev_results_t *results);
 
DOCA_STABLE
void doca_pcc_dev_user_init(uint32_t *disable_event_bitmask);
 
DOCA_STABLE
doca_pcc_dev_error_t doca_pcc_dev_user_set_algo_params(uint32_t port_num,
                               uint32_t algo_slot,
                               uint32_t param_id_base,
                               uint32_t param_num,
                               const uint32_t *new_param_values,
                               uint32_t *params);
 
DOCA_EXPERIMENTAL
doca_pcc_dev_error_t doca_pcc_dev_custom_header_set(doca_pcc_dev_algo_ctxt_t *algo_ctxt,
                            doca_pcc_dev_event_t *event,
                            uint32_t *header,
                            uint32_t header_size,
                            uint32_t wait_completed);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_PCC_DEV_H_ */