doca_dev.h File Reference
Include dependency graph for doca_dev.h:
Go to the source code of this file.
Macros | |
| #define | DOCA_DEVINFO_VUID_SIZE 128 |
| Buffer size to hold VUID. Including a null terminator. More... | |
| #define | DOCA_DEVINFO_IPV4_ADDR_SIZE 4 |
| Length of IPv4 address. More... | |
| #define | DOCA_DEVINFO_IPV6_ADDR_SIZE 16 |
| Length of IPv6 address. More... | |
| #define | DOCA_DEVINFO_MAC_ADDR_SIZE 6 |
| Length of MAC address. More... | |
| #define | DOCA_DEVINFO_IFACE_NAME_SIZE 256 |
| Buffer size to hold network interface name. Including a null terminator. More... | |
| #define | DOCA_DEVINFO_IBDEV_NAME_SIZE 64 |
| Buffer size to hold Infiniband/RoCE device name. Including a null terminator. More... | |
| #define | DOCA_DEVINFO_PCI_ADDR_SIZE 13 |
| Buffer size to hold PCI BDF format: "XXXX:XX:XX.X". Including a null terminator. More... | |
| #define | DOCA_DEVINFO_PCI_BDF_SIZE 8 |
| Buffer size to hold PCI BDF format: "XX:XX.X". Including a null terminator. More... | |
| #define | DOCA_DEVINFO_REP_VUID_SIZE 128 |
| Buffer size to hold VUID. Including a null terminator. More... | |
| #define | DOCA_DEVINFO_REP_PCI_ADDR_SIZE 13 |
| Buffer size to hold PCI BDF format: "XXXX:XX:XX.X". Including a null terminator. More... | |
| #define | DOCA_DEVINFO_REP_PCI_BDF_SIZE 8 |
| Buffer size to hold PCI BDF format: "XX:XX.X". Including a null terminator. More... | |
Enumerations | |
| enum | doca_devinfo_rep_filter { DOCA_DEVINFO_REP_FILTER_ALL = 0 , DOCA_DEVINFO_REP_FILTER_NET = 1 << 1 , DOCA_DEVINFO_REP_FILTER_EMULATED = 1 << 2 } |
Functions | |
| DOCA_STABLE doca_error_t | doca_devinfo_create_list (struct doca_devinfo ***dev_list, uint32_t *nb_devs) |
| Creates list of all available local devices. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_destroy_list (struct doca_devinfo **dev_list) |
| Destroy list of local device info structures. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_create_list (struct doca_dev *dev, int filter, struct doca_devinfo_rep ***dev_list_rep, uint32_t *nb_devs_rep) |
| Create list of available representor devices accessible by dev. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_destroy_list (struct doca_devinfo_rep **dev_list_rep) |
| Destroy list of representor device info structures. More... | |
| DOCA_STABLE doca_error_t | doca_dev_open (struct doca_devinfo *devinfo, struct doca_dev **dev) |
| Initialize local device for use. More... | |
| DOCA_STABLE doca_error_t | doca_dev_close (struct doca_dev *dev) |
| Destroy allocated local device instance. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_dev_accelerate_resource_reclaim (struct doca_dev *dev) |
| Accelerates the reclaim process for a local device instance. More... | |
| DOCA_STABLE doca_error_t | doca_dev_rep_open (struct doca_devinfo_rep *devinfo, struct doca_dev_rep **dev_rep) |
| Initialize representor device for use. More... | |
| DOCA_STABLE doca_error_t | doca_dev_rep_close (struct doca_dev_rep *dev) |
| Destroy allocated representor device instance. More... | |
| DOCA_STABLE struct doca_devinfo * | doca_dev_as_devinfo (const struct doca_dev *dev) |
| Get local device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list. More... | |
| DOCA_STABLE struct doca_devinfo_rep * | doca_dev_rep_as_devinfo (struct doca_dev_rep *dev_rep) |
| Get representor device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_pci_addr_str (const struct doca_devinfo *devinfo, char *pci_addr_str) |
| Get the PCI address of a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_is_equal_pci_addr (const struct doca_devinfo *devinfo, const char *pci_addr_str, uint8_t *is_equal) |
| Check if a PCI address belongs to a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_ipv4_addr (const struct doca_devinfo *devinfo, uint8_t *ipv4_addr, uint32_t size) |
| Get the IPv4 address of a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_ipv6_addr (const struct doca_devinfo *devinfo, uint8_t *ipv6_addr, uint32_t size) |
| Get the IPv6 address of a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_mac_addr (const struct doca_devinfo *devinfo, uint8_t *mac_addr, uint32_t size) |
| Get the MAC address of a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_iface_name (const struct doca_devinfo *devinfo, char *iface_name, uint32_t size) |
| Get the name of the ethernet interface of a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_ibdev_name (const struct doca_devinfo *devinfo, char *ibdev_name, uint32_t size) |
| Get the name of the IB device represented by a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_get_lid (const struct doca_devinfo *devinfo, uint16_t *lid) |
| Get the port LID of a DOCA devinfo. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_devinfo_get_active_rate (const struct doca_devinfo *devinfo, uint64_t *active_rate) |
| Get the active rate of a DOCA devinfo. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_devinfo_get_vhca_id (const struct doca_devinfo *devinfo, uint16_t *vhca_id) |
| Get vhca id of a device. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_cap_is_hotplug_manager_supported (const struct doca_devinfo *devinfo, uint8_t *is_hotplug_manager) |
| Get the hotplug manager capability of a DOCA devinfo. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_devinfo_cap_is_notification_moderation_supported (const struct doca_devinfo *devinfo, uint8_t *is_notification_moderation_supported) |
| Check if notification moderation is supported for a device. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_cap_is_filter_all_supported (const struct doca_devinfo *devinfo, uint8_t *filter_all_supported) |
| Get the representor devices discovery capability of the device. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_cap_is_filter_net_supported (const struct doca_devinfo *devinfo, uint8_t *filter_net_supported) |
| Get the remote net discovery capability of the device. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_cap_is_filter_emulated_supported (const struct doca_devinfo *devinfo, uint8_t *filter_emulated_supported) |
| Get the remote emulated device discovery capability of the device. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_devinfo_cap_is_accelerate_resource_reclaim_supported (const struct doca_devinfo *devinfo, uint8_t *is_accelerate_resource_reclaim) |
| Get the accelerate resource reclaim capability of a DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_get_vuid (const struct doca_devinfo_rep *devinfo_rep, char *rep_vuid, uint32_t size) |
| Get the Vendor Unique ID of a representor DOCA devinfo. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_get_pci_addr_str (const struct doca_devinfo_rep *devinfo_rep, char *pci_addr_str) |
| Get the PCI address of a DOCA devinfo_rep. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_get_pci_func_type (const struct doca_devinfo_rep *devinfo_rep, enum doca_pci_func_type *pci_func_type) |
| Get the PCI function type of a DOCA devinfo_rep. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_get_is_hotplug (const struct doca_devinfo_rep *devinfo_rep, uint8_t *is_hotplug) |
| Query whether the representor device is a hotplugged device. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_devinfo_rep_get_iface_name (const struct doca_devinfo_rep *devinfo_rep, char *iface_name, uint32_t size) |
| Get the name of the ethernet interface of a DOCA devinfo_rep. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_devinfo_rep_get_vhca_id (const struct doca_devinfo_rep *devinfo_rep, uint16_t *vhca_id) |
| Get vhca id of a DOCA devinfo_rep. More... | |
| DOCA_STABLE doca_error_t | doca_devinfo_rep_is_equal_pci_addr (const struct doca_devinfo_rep *devinfo_rep, const char *pci_addr_str, uint8_t *is_equal) |
| Check if a PCI address belongs to a DOCA devinfo_rep. More... | |
