NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_devemu_vfs_type.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023 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 
25 #ifndef DOCA_DEVEMU_VFS_TYPE_H_
26 #define DOCA_DEVEMU_VFS_TYPE_H_
27 
28 #include <stdint.h>
29 
30 #include <doca_error.h>
31 #include <doca_dev.h>
32 #include <doca_devemu_pci.h>
33 #include <doca_devemu_virtio.h>
35 #include <doca_devemu_vfs.h>
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
46 #define DOCA_DEVEMU_VIRTIOFS_NOTIFICATION_QUEUE_BIT_IN_DEVICE_FEATURES (1ULL << 0)
47 
48 /*********************************************************************************************************************
49  * DOCA devemu Virtio FS type API
50  *********************************************************************************************************************/
51 
71  uint8_t *supported);
72 
91  struct doca_devemu_vfs_type **vfs_type);
92 
103 struct doca_devemu_virtio_type *doca_devemu_vfs_type_as_virtio_type(struct doca_devemu_vfs_type *vfs_type);
104 
115 struct doca_devemu_pci_type *doca_devemu_vfs_type_as_pci_type(struct doca_devemu_vfs_type *vfs_type);
116 
132 doca_error_t doca_devemu_vfs_type_get_num_request_queues(const struct doca_devemu_vfs_type *vfs_type,
133  uint32_t *num_request_queues);
134 
135 
136 #ifdef __cplusplus
137 }
138 #endif
139 
142 #endif /* DOCA_DEVEMU_VFS_TYPE_H_ */
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
DOCA_EXPERIMENTAL struct doca_devemu_virtio_type * doca_devemu_vfs_type_as_virtio_type(struct doca_devemu_vfs_type *vfs_type)
Convert DOCA Virtio FS type instance into DOCA Virtio type.
DOCA_EXPERIMENTAL doca_error_t doca_devemu_vfs_is_default_vfs_type_supported(const struct doca_devinfo *devinfo, uint8_t *supported)
Check if the default DOCA Virtio FS type is supported by the device.
DOCA_EXPERIMENTAL doca_error_t doca_devemu_vfs_type_get_num_request_queues(const struct doca_devemu_vfs_type *vfs_type, uint32_t *num_request_queues)
Get the value of the num_request_queues register.
DOCA_EXPERIMENTAL struct doca_devemu_pci_type * doca_devemu_vfs_type_as_pci_type(struct doca_devemu_vfs_type *vfs_type)
Convert DOCA Virtio FS type instance into DOCA PCI type.
DOCA_EXPERIMENTAL doca_error_t doca_devemu_vfs_find_default_vfs_type_by_dev(struct doca_dev *dev, struct doca_devemu_vfs_type **vfs_type)
Find the default DOCA Virtio FS type associated with the device.
enum doca_error doca_error_t
DOCA API return codes.