doca_uar.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 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_UAR_H_
#define DOCA_UAR_H_
 
#include <stddef.h>
#include <stdint.h>
 
#include <doca_compat.h>
#include <doca_error.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*******************************************************************************
 * DOCA UAR
 ******************************************************************************/
 
struct doca_dev;
struct doca_dpa;
 
struct doca_uar;
 
enum doca_uar_allocation_type {
    DOCA_UAR_ALLOCATION_TYPE_BLUEFLAME = 0,      /* Preferred for low latency */
    DOCA_UAR_ALLOCATION_TYPE_NONCACHE = 1,       /* Preferred for high throughput */
    DOCA_UAR_ALLOCATION_TYPE_NONCACHE_DEDICATED = 2, /* Type NONCACHE_DEDICATED requires libibverbs version
                                >= 1.14.47 */
};
 
DOCA_EXPERIMENTAL
doca_error_t doca_uar_create(const struct doca_dev *dev,
                 enum doca_uar_allocation_type allocation_type,
                 struct doca_uar **uar);
 
DOCA_EXPERIMENTAL
doca_error_t doca_uar_dpa_create(struct doca_dpa *dpa, struct doca_uar **uar);
 
DOCA_EXPERIMENTAL
doca_error_t doca_uar_destroy(struct doca_uar *uar);
 
DOCA_EXPERIMENTAL
doca_error_t doca_uar_id_get(const struct doca_uar *uar, uint32_t *id);
 
DOCA_EXPERIMENTAL
doca_error_t doca_uar_page_get(const struct doca_uar *uar, void **page);
 
DOCA_EXPERIMENTAL
doca_error_t doca_uar_reg_addr_get(const struct doca_uar *uar, void **reg);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_UAR_H_ */