rte_pci.h(3)

✨ rte_pci.h ✨ (Library Functions Manual)

okay bestie, gather round 🫶 you just pulled up the manual page for rte_pci.h, and it's giving PCI library core, and honestly? iconic. this is the DPDK header that handles all the PCI address stuff — naming devices, comparing them, parsing them. let's get into it 💅

---

🌸 NAME 🌸

rte_pci.h — no cap, that's the whole name, that's the vibe

---

✨ SYNOPSIS ✨

first things first, you gotta pull in these headers or nothing works, fr fr:

#include <stdio.h>
#include <inttypes.h>
#include <sys/types.h>

🎀 Data Structures

• struct rte_pci_id
• struct rte_pci_addr

🦋 Macros

• #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_RESOURCE_FMT_NVAL 3
• #define PCI_MAX_RESOURCE 6
• #define RTE_PCI_ANY_ID (0xffff)
• #define PCI_ANY_ID RTE_DEPRECATED(PCI_ANY_ID) RTE_PCI_ANY_ID

💜 Functions

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 💖 that's it, that's the summary, and honestly it ate.

Definition in file rte_pci.h.

---

🔥 Macro Definition Documentation 🔥

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

the formatting string for a PCI device identifier. like, e.g. 0000:00:01.0 ✨

Definition at line 151 of file rte_pci.h.

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

the short formatting string, and bestie it drops the domain entirely, so a PCI device looks like 00:01.0 🎀

Definition at line 155 of file rte_pci.h.

#define PCI_FMT_NVAL 4

how many values live in the PCI device identifier format string. four of them. periodt. 4️⃣

Definition at line 158 of file rte_pci.h.

#define PCI_RESOURCE_FMT_NVAL 3

how many values live in the PCI resource format. three. that's the number. 🍓

Definition at line 161 of file rte_pci.h.

#define PCI_MAX_RESOURCE 6

the maximum number of PCI resources, and the max is 6 👑

Definition at line 164 of file rte_pci.h.

#define RTE_PCI_ANY_ID (0xffff)

any PCI device identifier — vendor, device, whatever, it's the wildcard, it matches anything 🦋

Definition at line 189 of file rte_pci.h.

#define PCI_ANY_ID RTE_DEPRECATED(PCI_ANY_ID) RTE_PCI_ANY_ID

🚨 Deprecated 🚨 this one got replaced, no cap. It's been swapped out for RTE_PCI_ANY_ID. use the new one bestie, please, the old one is giving retired.

Definition at line 191 of file rte_pci.h.

---

💅 Function Documentation 💅

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

a lil utility function that writes out a pci device name — and the glow-up here is that you can later take that device name and get the matching rte_pci_addr back by calling rte_pci_addr_parse(). round trip, slay ✨

Parameters

• addr — the PCI Bus-Device-Function address 🚌
• output — the output buffer string 📝
• size — the output buffer size 📏

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

a utility function to compare two PCI device addresses against each other. vibe check, but for addresses 💖

Parameters

• addr — the PCI Bus-Device-Function address to compare
• addr2 — the PCI Bus-Device-Function address to compare

Returns

• 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)

a utility function that parses a string into a PCI location. it's giving text goes in, address comes out 🔮

Parameters

• str — the string to parse
• addr — the reference to the structure where the location is stored

Returns

• 0 on success ✅
• <0 otherwise 🙈

---

🧚 Author 🧚

generated automatically by Doxygen for DPDK from the source code. it literally wrote itself, main character energy fr fr ⭐

---

and that's the whole page bestie!! stay hydrated, go read your PCI addresses, and remember — this gem was brought to you by DPDK, Version 25.11.3 💖 ok love you bye 🫶✨