DPDK  24.07.0-rc3
Data Structures | Macros | Functions
rte_pci.h File Reference
#include <stdio.h>
#include <inttypes.h>
#include <sys/types.h>

Go to the source code of this file.

Data Structures

struct  rte_pci_id
struct  rte_pci_addr


#define PCI_PRI_FMT   "%.4" PRIx32 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
#define PCI_SHORT_PRI_FMT   "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
#define PCI_FMT_NVAL   4
#define PCI_MAX_RESOURCE   6
#define RTE_PCI_ANY_ID   (0xffff)


void rte_pci_device_name (const struct rte_pci_addr *addr, char *output, size_t size)
int rte_pci_addr_cmp (const struct rte_pci_addr *addr, const struct rte_pci_addr *addr2)
int rte_pci_addr_parse (const char *str, struct rte_pci_addr *addr)

Detailed Description

RTE PCI Library

Definition in file rte_pci.h.

Macro Definition Documentation


#define PCI_PRI_FMT   "%.4" PRIx32 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8

Formatting string for PCI device identifier: Ex: 0000:00:01.0

Definition at line 141 of file rte_pci.h.


#define PCI_SHORT_PRI_FMT   "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8

Short formatting string, without domain, for PCI device: Ex: 00:01.0

Definition at line 145 of file rte_pci.h.


#define PCI_FMT_NVAL   4

Nb. of values in PCI device identifier format string.

Definition at line 148 of file rte_pci.h.



Nb. of values in PCI resource format.

Definition at line 151 of file rte_pci.h.


#define PCI_MAX_RESOURCE   6

Maximum number of PCI resources.

Definition at line 154 of file rte_pci.h.


#define RTE_PCI_ANY_ID   (0xffff)

Any PCI device identifier (vendor, device, ...)

Definition at line 179 of file rte_pci.h.


Replaced with RTE_PCI_ANY_ID

Definition at line 181 of file rte_pci.h.

Function Documentation

◆ rte_pci_device_name()

void rte_pci_device_name ( const struct rte_pci_addr addr,
char *  output,
size_t  size 

Utility function to write a pci device name, this device name can later be used to retrieve the corresponding rte_pci_addr using rte_pci_addr_parse().

addrThe PCI Bus-Device-Function address
outputThe output buffer string
sizeThe output buffer size

◆ rte_pci_addr_cmp()

int rte_pci_addr_cmp ( const struct rte_pci_addr addr,
const struct rte_pci_addr addr2 

Utility function to compare two PCI device addresses.

addrThe PCI Bus-Device-Function address to compare
addr2The PCI Bus-Device-Function address to compare
0 on equal PCI address. Positive on addr is greater than addr2. Negative on addr is less than addr2, or error.

◆ rte_pci_addr_parse()

int rte_pci_addr_parse ( const char *  str,
struct rte_pci_addr addr 

Utility function to parse a string into a PCI location.

strThe string to parse
addrThe reference to the structure where the location is stored.
0 on success <0 otherwise