doca_devemu_pci_type.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_DEVEMU_PCI_TYPE_H_
#define DOCA_DEVEMU_PCI_TYPE_H_
 
#include <stdint.h>
#include <sys/uio.h>
 
#include <doca_error.h>
#include <doca_dev.h>
#include <doca_ctx.h>
#include <doca_pe.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************************************************************************************************************
 * DOCA devemu PCI type
 *********************************************************************************************************************/
 
struct doca_devemu_pci_type;
 
#define DOCA_DEVEMU_PCI_TYPE_NAME_LEN 32
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_get_max_types(const struct doca_devinfo *devinfo, uint16_t *max_pci_types);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_log_min_bar_size(const struct doca_devinfo *devinfo, uint8_t *log_bar_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_log_max_bar_size(const struct doca_devinfo *devinfo, uint8_t *log_bar_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_num_msix(const struct doca_devinfo *devinfo, uint16_t *num_msix);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_num_db(const struct doca_devinfo *devinfo, uint16_t *num_db);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_log_min_db_size(const struct doca_devinfo *devinfo, uint8_t *log_db_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_log_max_db_size(const struct doca_devinfo *devinfo, uint8_t *log_db_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_log_min_db_stride_size(const struct doca_devinfo *devinfo,
                                 uint8_t *log_stride_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_log_max_db_stride_size(const struct doca_devinfo *devinfo,
                                 uint8_t *log_stride_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_bars(const struct doca_devinfo *devinfo, uint8_t *max_bars);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_get_max_bar_regions(const struct doca_devinfo *devinfo, uint32_t *max_bar_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_bar_regions(const struct doca_devinfo *devinfo,
                              uint32_t *max_bar_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_db_region_is_identify_by_offset_supported(const struct doca_devinfo *devinfo,
                                           uint8_t *supported);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_db_region_is_identify_by_data_supported(const struct doca_devinfo *devinfo,
                                         uint8_t *supported);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_db_region_get_region_block_size(const struct doca_devinfo *devinfo,
                                     uint32_t *block_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_db_region_get_max_num_region_blocks(const struct doca_devinfo *devinfo,
                                     uint32_t *max_blocks);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_bar_db_regions(const struct doca_devinfo *devinfo, uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_get_max_bar_db_regions(const struct doca_devinfo *devinfo, uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_db_region_get_start_addr_alignment(const struct doca_devinfo *devinfo,
                                    uint32_t *alignment);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_stateful_region_get_region_block_size(const struct doca_devinfo *devinfo,
                                       uint32_t *block_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_stateful_region_get_max_num_region_blocks(const struct doca_devinfo *devinfo,
                                           uint32_t *max_blocks);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_bar_stateful_regions(const struct doca_devinfo *devinfo,
                                   uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_get_max_bar_stateful_regions(const struct doca_devinfo *devinfo,
                                  uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_stateful_region_get_start_addr_alignment(const struct doca_devinfo *devinfo,
                                          uint32_t *alignment);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_msix_table_region_get_region_block_size(const struct doca_devinfo *devinfo,
                                         uint32_t *block_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_msix_table_region_get_max_num_region_blocks(const struct doca_devinfo *devinfo,
                                         uint32_t *max_blocks);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_bar_msix_table_regions(const struct doca_devinfo *devinfo,
                                     uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_get_max_bar_msix_table_regions(const struct doca_devinfo *devinfo,
                                    uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_msix_table_region_get_start_addr_alignment(const struct doca_devinfo *devinfo,
                                        uint32_t *alignment);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_msix_pba_region_get_region_block_size(const struct doca_devinfo *devinfo,
                                       uint32_t *block_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_msix_pba_region_get_max_num_region_blocks(const struct doca_devinfo *devinfo,
                                           uint32_t *max_blocks);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_get_max_bar_msix_pba_regions(const struct doca_devinfo *devinfo,
                                   uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_get_max_bar_msix_pba_regions(const struct doca_devinfo *devinfo,
                                  uint32_t *max_regions);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_bar_msix_pba_region_get_start_addr_alignment(const struct doca_devinfo *devinfo,
                                          uint32_t *alignment);
 
enum doca_devemu_pci_bar_mem_type {
    DOCA_DEVEMU_PCI_BAR_MEM_TYPE_32_BIT = 0,
    DOCA_DEVEMU_PCI_BAR_MEM_TYPE_1_MB,
    DOCA_DEVEMU_PCI_BAR_MEM_TYPE_64_BIT,
};
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_is_bar_mem_type_supported(const struct doca_devinfo *devinfo,
                                enum doca_devemu_pci_bar_mem_type memory_type,
                                uint8_t *supported);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_create(const char *name, struct doca_devemu_pci_type **pci_type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_destroy(struct doca_devemu_pci_type *pci_type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_start(struct doca_devemu_pci_type *pci_type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_stop(struct doca_devemu_pci_type *pci_type);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_is_started(const struct doca_devemu_pci_type *pci_type, uint8_t *started);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_create_rep_list(struct doca_devemu_pci_type *pci_type,
                          struct doca_devinfo_rep ***dev_list_rep,
                          uint32_t *nb_devs_rep);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_dev(const struct doca_devemu_pci_type *pci_type, struct doca_dev **dev);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_dev(struct doca_devemu_pci_type *pci_type, struct doca_dev *dev);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_is_hotplug_supported(const struct doca_devinfo *devinfo,
                               const struct doca_devemu_pci_type *pci_type,
                               uint8_t *supported);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_cap_type_is_mgmt_supported(const struct doca_devinfo *devinfo,
                            const struct doca_devemu_pci_type *pci_type,
                            uint8_t *supported);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_dev_create_rep(const struct doca_devemu_pci_type *pci_type, struct doca_dev_rep **dev_rep);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_dev_destroy_rep(struct doca_dev_rep *rep_dev);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_name(const struct doca_devemu_pci_type *pci_type,
                       char (*name)[DOCA_DEVEMU_PCI_TYPE_NAME_LEN]);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_device_id(const struct doca_devemu_pci_type *pci_type, uint16_t *device_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_device_id(struct doca_devemu_pci_type *pci_type, uint16_t device_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_vendor_id(const struct doca_devemu_pci_type *pci_type, uint16_t *vendor_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_vendor_id(struct doca_devemu_pci_type *pci_type, uint16_t vendor_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_subsystem_id(const struct doca_devemu_pci_type *pci_type, uint16_t *subsystem_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_subsystem_id(struct doca_devemu_pci_type *pci_type, uint16_t subsystem_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_subsystem_vendor_id(const struct doca_devemu_pci_type *pci_type,
                              uint16_t *subsystem_vid);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_subsystem_vendor_id(struct doca_devemu_pci_type *pci_type,
                              uint16_t subsystem_vid);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_revision_id(const struct doca_devemu_pci_type *pci_type, uint8_t *revision_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_revision_id(struct doca_devemu_pci_type *pci_type, uint8_t revision_id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_class_code(const struct doca_devemu_pci_type *pci_type, uint32_t *class_code);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_class_code(struct doca_devemu_pci_type *pci_type, uint32_t class_code);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_num_msix(const struct doca_devemu_pci_type *pci_type, uint16_t *num_msix);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_num_msix(struct doca_devemu_pci_type *pci_type, uint16_t num_msix);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_get_num_db(const struct doca_devemu_pci_type *pci_type, uint16_t *num_db);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_num_db(struct doca_devemu_pci_type *pci_type, uint16_t num_db);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_memory_bar_conf(struct doca_devemu_pci_type *pci_type,
                              uint8_t id,
                              uint8_t log_sz,
                              enum doca_devemu_pci_bar_mem_type memory_type,
                              uint8_t prefetchable);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_io_bar_conf(struct doca_devemu_pci_type *pci_type, uint8_t id, uint8_t log_sz);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_bar_db_region_by_offset_conf(struct doca_devemu_pci_type *pci_type,
                                   uint8_t id,
                                   uint64_t start_addr,
                                   uint64_t size,
                                   uint8_t log_db_size,
                                   uint8_t log_stride_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_bar_db_region_by_data_conf(struct doca_devemu_pci_type *pci_type,
                                 uint8_t id,
                                 uint64_t start_addr,
                                 uint64_t size,
                                 uint8_t log_db_size,
                                 uint16_t db_id_msbyte,
                                 uint16_t db_id_lsbyte);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_bar_msix_table_region_conf(struct doca_devemu_pci_type *pci_type,
                                 uint8_t id,
                                 uint64_t start_addr,
                                 uint64_t size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_bar_msix_pba_region_conf(struct doca_devemu_pci_type *pci_type,
                                   uint8_t id,
                                   uint64_t start_addr,
                                   uint64_t size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_set_bar_stateful_region_conf(struct doca_devemu_pci_type *pci_type,
                                   uint8_t id,
                                   uint64_t start_addr,
                                   uint64_t size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_pci_type_modify_bar_stateful_region_default_values(struct doca_devemu_pci_type *pci_type,
                                        uint8_t id,
                                        uint64_t start_addr,
                                        void *default_values,
                                        uint64_t size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_DEVEMU_PCI_TYPE_H_ */