doca_pcc_dev_algo_access.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_ALGO_ACCESS_H_
#define DOCA_PCC_DEV_ALGO_ACCESS_H_
 
#include <doca_pcc_dev.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DOCA_PCC_DEV_TARGET_APP_RP (0)
 
#define DOCA_PCC_DEV_TARGET_APP_NP (1)
 
#define DOCA_PCC_DEV_ALGO_SLOT(target_app, ppcc_algo_slot) ((target_app << 16) | (ppcc_algo_slot & 0xffff))
 
struct doca_pcc_dev_algo_meta_data {
    uint32_t algo_id;        
    uint32_t algo_major_version; 
    uint32_t algo_minor_version; 
    uint32_t algo_desc_size;     
    uint64_t algo_desc_addr;     
};
 
DOCA_STABLE
doca_pcc_dev_error_t doca_pcc_dev_algo_init_metadata(uint32_t algo_idx,
                             const struct doca_pcc_dev_algo_meta_data *user_def,
                             uint32_t param_num,
                             uint32_t counter_num);
 
DOCA_STABLE
doca_pcc_dev_error_t doca_pcc_dev_algo_init_param(uint32_t algo_idx,
                          uint32_t param_id,
                          uint32_t default_value,
                          uint32_t max_value,
                          uint32_t min_value,
                          uint32_t permissions,
                          uint32_t param_desc_size,
                          uint64_t param_desc_addr);
 
DOCA_STABLE
doca_pcc_dev_error_t doca_pcc_dev_algo_init_counter(uint32_t algo_idx,
                            uint32_t counter_id,
                            uint32_t max_value,
                            uint32_t permissions,
                            uint32_t counter_desc_size,
                            uint64_t counter_desc_addr);
 
DOCA_STABLE
doca_pcc_dev_error_t doca_pcc_dev_init_algo_slot(uint32_t portid,
                         uint32_t algo_slot,
                         uint32_t algo_idx,
                         uint32_t algo_en);
 
DOCA_STABLE
uint32_t doca_pcc_dev_get_counters_num(uint32_t port_num, uint32_t algo_slot);
 
DOCA_STABLE
uint32_t *doca_pcc_dev_get_counters(uint32_t port_num, uint32_t algo_slot);
 
DOCA_STABLE
uint32_t doca_pcc_dev_get_algo_params_num(uint32_t port_num, uint32_t algo_slot);
 
DOCA_STABLE
uint32_t *doca_pcc_dev_get_algo_params(uint32_t port_num, uint32_t algo_slot);
 
DOCA_STABLE
uint32_t doca_pcc_dev_get_algo_index(uint32_t port_num, uint32_t algo_slot);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_PCC_DEV_ALGO_ACCESS_H_ */