DPDK  20.08.0
Data Structures | Macros | Functions
rte_pci.h File Reference
#include <stdio.h>
#include <limits.h>
#include <sys/queue.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
struct  pci_map
struct  mapped_pci_resource


#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 PCI_ANY_ID   (0xffff)


 TAILQ_HEAD (mapped_pci_res_list, mapped_pci_resource)
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)
void * pci_map_resource (void *requested_addr, int fd, off_t offset, size_t size, int additional_flags)
void pci_unmap_resource (void *requested_addr, size_t size)

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 26 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 30 of file rte_pci.h.

#define PCI_FMT_NVAL   4

Nb. of values in PCI device identifier format string.

Definition at line 33 of file rte_pci.h.


Nb. of values in PCI resource format.

Definition at line 36 of file rte_pci.h.

#define PCI_MAX_RESOURCE   6

Maximum number of PCI resources.

Definition at line 39 of file rte_pci.h.

#define PCI_ANY_ID   (0xffff)

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

Definition at line 64 of file rte_pci.h.

Function Documentation

TAILQ_HEAD ( mapped_pci_res_list  ,

mapped pci device list

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 eal_parse_pci_* BDF helpers.

addrThe PCI Bus-Device-Function address
outputThe output buffer string
sizeThe output buffer size
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.
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
void* pci_map_resource ( void *  requested_addr,
int  fd,
off_t  offset,
size_t  size,
int  additional_flags 

Map a particular resource from a file.

requested_addrThe starting address for the new mapping range.
fdThe file descriptor.
offsetThe offset for the mapping range.
sizeThe size for the mapping range.
additional_flagsThe additional flags for the mapping range.
  • On success, the function returns a pointer to the mapped area.
  • On error, MAP_FAILED is returned.
void pci_unmap_resource ( void *  requested_addr,
size_t  size 

Unmap a particular resource.

requested_addrThe address for the unmapping range.
sizeThe size for the unmapping range.