NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
nvmf_doca_io_create_attr Struct Reference

#include </opt/mellanox/doca/applications/nvme_emulation/host/nvmf_doca_io.h>

Collaboration diagram for nvmf_doca_io_create_attr:

Data Fields

struct doca_pe * pe
 
struct doca_dev * dev
 
struct doca_devemu_pci_dev * nvme_dev
 
struct doca_dpa * dpa
 
uint32_t cq_id
 
uint16_t cq_depth
 
struct doca_mmap * host_cq_mmap
 
uintptr_t host_cq_address
 
bool enable_msix
 
uint32_t msix_idx
 
uint32_t max_num_sq
 
nvmf_doca_cq_post_cqe_cb post_cqe_cb
 
nvmf_doca_sq_fetch_sqe_cb fetch_sqe_cb
 
nvmf_doca_sq_copy_data_cb copy_data_cb
 
nvmf_doca_sq_stop_cb stop_sq_cb
 
nvmf_doca_io_stop_cb stop_io_cb
 

Detailed Description

Definition at line 199 of file nvmf_doca_io.h.

Field Documentation

◆ copy_data_cb

nvmf_doca_sq_copy_data_cb nvmf_doca_io_create_attr::copy_data_cb

Callback invoked once data copy operation completes

Definition at line 213 of file nvmf_doca_io.h.

◆ cq_depth

uint16_t nvmf_doca_io_create_attr::cq_depth

The size of the completeion queue

Definition at line 205 of file nvmf_doca_io.h.

◆ cq_id

uint32_t nvmf_doca_io_create_attr::cq_id

The NVMe CQ ID that is associated with this IO

Definition at line 204 of file nvmf_doca_io.h.

◆ dev

struct doca_dev* nvmf_doca_io_create_attr::dev

A doca device representing the emulation manager

Definition at line 201 of file nvmf_doca_io.h.

◆ dpa

struct doca_dpa* nvmf_doca_io_create_attr::dpa

DOCA DPA for accessing DPA resources

Definition at line 203 of file nvmf_doca_io.h.

◆ enable_msix

bool nvmf_doca_io_create_attr::enable_msix

Whether CQ should raise MSI-X towards the Host after posting a CQE

Definition at line 208 of file nvmf_doca_io.h.

◆ fetch_sqe_cb

nvmf_doca_sq_fetch_sqe_cb nvmf_doca_io_create_attr::fetch_sqe_cb

Callback invoked once a SQE is fetched from host

Definition at line 212 of file nvmf_doca_io.h.

◆ host_cq_address

uintptr_t nvmf_doca_io_create_attr::host_cq_address

I/O address of the CQ on the Host

Definition at line 207 of file nvmf_doca_io.h.

◆ host_cq_mmap

struct doca_mmap* nvmf_doca_io_create_attr::host_cq_mmap

mmap granting access to the Host CQ memory

Definition at line 206 of file nvmf_doca_io.h.

◆ max_num_sq

uint32_t nvmf_doca_io_create_attr::max_num_sq

The maximum number of SQs that can be associated with the CQ

Definition at line 210 of file nvmf_doca_io.h.

◆ msix_idx

uint32_t nvmf_doca_io_create_attr::msix_idx

The MSI-X vector index to raise. Relevant only in case enable_msix=true

Definition at line 209 of file nvmf_doca_io.h.

◆ nvme_dev

struct doca_devemu_pci_dev* nvmf_doca_io_create_attr::nvme_dev

The emulated NVMe device

Definition at line 202 of file nvmf_doca_io.h.

◆ pe

struct doca_pe* nvmf_doca_io_create_attr::pe

Progress engine to be used for any created contexts

Definition at line 200 of file nvmf_doca_io.h.

◆ post_cqe_cb

nvmf_doca_cq_post_cqe_cb nvmf_doca_io_create_attr::post_cqe_cb

Callback invoked once a CQE is posted to Host

Definition at line 211 of file nvmf_doca_io.h.

◆ stop_io_cb

nvmf_doca_io_stop_cb nvmf_doca_io_create_attr::stop_io_cb

Callback invoked once an IO has been stopped

Definition at line 215 of file nvmf_doca_io.h.

◆ stop_sq_cb

nvmf_doca_sq_stop_cb nvmf_doca_io_create_attr::stop_sq_cb

Callback invoked once an SQ has been stopped

Definition at line 214 of file nvmf_doca_io.h.


The documentation for this struct was generated from the following file: