NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_dpa_dev_devemu_pci.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
23 #ifndef DOCA_DPA_DEV_DEVEMU_PCI_H_
24 #define DOCA_DPA_DEV_DEVEMU_PCI_H_
25 
26 #include <doca_dpa_dev.h>
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
35 __dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_db_completion_t;
36 
40 __dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_db_completion_element_t;
41 
45 __dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_db_t;
46 
50 __dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_msix_t;
51 
85 DOCA_EXPERIMENTAL
86 int doca_dpa_dev_devemu_pci_get_db_completion(doca_dpa_dev_devemu_pci_db_completion_t comp,
87  doca_dpa_dev_devemu_pci_db_completion_element_t *comp_element);
88 
98 DOCA_EXPERIMENTAL
99 void doca_dpa_dev_devemu_pci_db_completion_ack(doca_dpa_dev_devemu_pci_db_completion_t comp, uint64_t num_comp);
100 
108 DOCA_EXPERIMENTAL
109 void doca_dpa_dev_devemu_pci_db_completion_request_notification(doca_dpa_dev_devemu_pci_db_completion_t comp);
110 
125 DOCA_EXPERIMENTAL
126 int doca_dpa_dev_devemu_pci_db_completion_bind_db(doca_dpa_dev_devemu_pci_db_completion_t comp,
127  doca_dpa_dev_devemu_pci_db_t db);
128 
144 DOCA_EXPERIMENTAL
145 int doca_dpa_dev_devemu_pci_db_completion_unbind_db(doca_dpa_dev_devemu_pci_db_completion_t comp,
146  doca_dpa_dev_devemu_pci_db_t db);
147 
156 DOCA_EXPERIMENTAL
157 void doca_dpa_dev_devemu_pci_db_completion_element_get_db_properties(
158  doca_dpa_dev_devemu_pci_db_completion_t comp,
159  doca_dpa_dev_devemu_pci_db_completion_element_t comp_element,
160  doca_dpa_dev_devemu_pci_db_t *db,
161  doca_dpa_dev_uintptr_t *db_user_data);
162 
172 DOCA_EXPERIMENTAL
173 void doca_dpa_dev_devemu_pci_db_request_notification(doca_dpa_dev_devemu_pci_db_t db);
174 
189 DOCA_EXPERIMENTAL
190 uint32_t doca_dpa_dev_devemu_pci_db_get_value(doca_dpa_dev_devemu_pci_db_t db);
191 
197 DOCA_EXPERIMENTAL
198 void doca_dpa_dev_devemu_pci_msix_raise(doca_dpa_dev_devemu_pci_msix_t msix);
199 
208 DOCA_EXPERIMENTAL
209 doca_dpa_dev_uintptr_t doca_dpa_dev_devemu_pci_msix_get_user_data(doca_dpa_dev_devemu_pci_msix_t msix);
210 
211 #ifdef __cplusplus
212 }
213 #endif
214 
217 #endif /* DOCA_DPA_DEV_DEVEMU_PCI_H_ */
doca_dpa_dev.h
db
uint64_t db
Definition: doca_transport_common.h:3
db_user_data
uint64_t db_user_data
Definition: doca_transport_common.h:17
__dpa_global__
struct dpa_thread_arg __dpa_global__
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
doca_dpa_dev_devemu_pci_db_completion_t
uint64_t doca_dpa_dev_devemu_pci_db_completion_t
DPA handle for emulated PCI device doorbell completion context.
Definition: doca_devemu_pci.h:64
doca_dpa_dev_devemu_pci_db_t
uint64_t doca_dpa_dev_devemu_pci_db_t
DPA handle for emulated PCI device doorbell.
Definition: doca_devemu_pci.h:53
doca_dpa_dev_devemu_pci_msix_t
uint64_t doca_dpa_dev_devemu_pci_msix_t
DPA handle for emulated PCI device MSI-X.
Definition: doca_devemu_pci.h:75
doca_dpa_dev_devemu_pci_db_completion_t
__dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_db_completion_t
DPA Devemu PCI Device DB Completion handle type definition.
Definition: doca_dpa_dev_devemu_pci.h:35
doca_dpa_dev_devemu_pci_db_completion_element_t
__dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_db_completion_element_t
DPA Devemu PCI Device DB Completion Element handle type definition.
Definition: doca_dpa_dev_devemu_pci.h:40
doca_dpa_dev_devemu_pci_db_completion_request_notification
DOCA_EXPERIMENTAL void doca_dpa_dev_devemu_pci_db_completion_request_notification(doca_dpa_dev_devemu_pci_db_completion_t comp)
Request notification on the Devemu PCI Device DB completion context.
doca_dpa_dev_devemu_pci_db_get_value
DOCA_EXPERIMENTAL uint32_t doca_dpa_dev_devemu_pci_db_get_value(doca_dpa_dev_devemu_pci_db_t db)
Get value written to the doorbell.
doca_dpa_dev_devemu_pci_db_completion_bind_db
DOCA_EXPERIMENTAL int doca_dpa_dev_devemu_pci_db_completion_bind_db(doca_dpa_dev_devemu_pci_db_completion_t comp, doca_dpa_dev_devemu_pci_db_t db)
Bind Devemu PCI Device DB handle to the Devemu PCI Device DB completion context.
doca_dpa_dev_devemu_pci_db_completion_ack
DOCA_EXPERIMENTAL void doca_dpa_dev_devemu_pci_db_completion_ack(doca_dpa_dev_devemu_pci_db_completion_t comp, uint64_t num_comp)
Acknowledge that the completions have been read on the Devemu PCI Device DB completion context.
doca_dpa_dev_devemu_pci_db_completion_element_get_db_properties
DOCA_EXPERIMENTAL void doca_dpa_dev_devemu_pci_db_completion_element_get_db_properties(doca_dpa_dev_devemu_pci_db_completion_t comp, doca_dpa_dev_devemu_pci_db_completion_element_t comp_element, doca_dpa_dev_devemu_pci_db_t *db, doca_dpa_dev_uintptr_t *db_user_data)
Get Devemu PCI Device DB properties from DB completion element.
doca_dpa_dev_devemu_pci_db_request_notification
DOCA_EXPERIMENTAL void doca_dpa_dev_devemu_pci_db_request_notification(doca_dpa_dev_devemu_pci_db_t db)
Request notification on the Devemu PCI Device DB context.
doca_dpa_dev_devemu_pci_msix_get_user_data
DOCA_EXPERIMENTAL doca_dpa_dev_uintptr_t doca_dpa_dev_devemu_pci_msix_get_user_data(doca_dpa_dev_devemu_pci_msix_t msix)
Get MSIX handle user data.
doca_dpa_dev_devemu_pci_db_completion_unbind_db
DOCA_EXPERIMENTAL int doca_dpa_dev_devemu_pci_db_completion_unbind_db(doca_dpa_dev_devemu_pci_db_completion_t comp, doca_dpa_dev_devemu_pci_db_t db)
Unbind Devemu PCI Device DB handle from the Devemu PCI Device DB completion context.
doca_dpa_dev_devemu_pci_msix_raise
DOCA_EXPERIMENTAL void doca_dpa_dev_devemu_pci_msix_raise(doca_dpa_dev_devemu_pci_msix_t msix)
Raise MSIX notification towards the driver.
doca_dpa_dev_devemu_pci_db_t
__dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_db_t
DPA Devemu PCI Device DB handle type definition.
Definition: doca_dpa_dev_devemu_pci.h:45
doca_dpa_dev_devemu_pci_msix_t
__dpa_global__ typedef uint64_t doca_dpa_dev_devemu_pci_msix_t
DPA Devemu PCI Device MSI-X handle type definition.
Definition: doca_dpa_dev_devemu_pci.h:50
doca_dpa_dev_devemu_pci_get_db_completion
DOCA_EXPERIMENTAL int doca_dpa_dev_devemu_pci_get_db_completion(doca_dpa_dev_devemu_pci_db_completion_t comp, doca_dpa_dev_devemu_pci_db_completion_element_t *comp_element)
Get Devemu PCI Device DB completion element.
doca_dpa_dev_uintptr_t
uint64_t doca_dpa_dev_uintptr_t
DPA pointer type definition.
Definition: doca_dpa.h:78