rte_dev.h(3)

📦

version 24.11.8 · 5 versions

💖 NAME 💖

rte_dev.h — bestie, this is the RTE PMD Registration Interface header, living its best life in the DPDK library functions manual (3). It's the file that manages the list of device drivers. Say it with me: device driver list management, iconic behavior only. 👑

✨ SYNOPSIS ✨

Ok so to even talk to this header you gotta pull in the whole squad first:

#include <stdio.h>
#include <rte_config.h>
#include <rte_common.h>
#include <rte_log.h>

🧸 Data Structures

Two lil structs getting their moment:

struct rte_mem_resource
struct rte_dev_iterator

🎀 Macros

#define RTE_PMD_REGISTER_KMOD_DEP(name, str)

🦋 Typedefs

typedef int(* rte_dev_cmp_t) (const struct rte_device *dev, const void *data)
typedef void *(* rte_dev_iterate_t) (const void *start, const char *devstr, const struct rte_dev_iterator *it)

🌈 Enumerations

enum rte_dev_event_type { RTE_DEV_EVENT_ADD, RTE_DEV_EVENT_REMOVE, RTE_DEV_EVENT_MAX }
enum rte_dev_policy

💅 Functions

The whole roster, no cap — every single one:

const char * rte_driver_name (const struct rte_driver *driver)
const struct rte_bus * rte_dev_bus (const struct rte_device *dev)
const char * rte_dev_bus_info (const struct rte_device *dev)
const struct rte_devargs * rte_dev_devargs (const struct rte_device *dev)
const struct rte_driver * rte_dev_driver (const struct rte_device *dev)
const char * rte_dev_name (const struct rte_device *dev)
int rte_dev_numa_node (const struct rte_device *dev)
int rte_dev_is_probed (const struct rte_device *dev)
int rte_eal_hotplug_add (const char *busname, const char *devname, const char *drvargs)
int rte_dev_probe (const char *devargs)
int rte_eal_hotplug_remove (const char *busname, const char *devname)
int rte_dev_remove (struct rte_device *dev)
int rte_dev_iterator_init (struct rte_dev_iterator *it, const char *str)
struct rte_device * rte_dev_iterator_next (struct rte_dev_iterator *it)
int rte_dev_event_callback_register (const char *device_name, rte_dev_event_cb_fn cb_fn, void *cb_arg)
int rte_dev_event_callback_unregister (const char *device_name, rte_dev_event_cb_fn cb_fn, void *cb_arg)
void rte_dev_event_callback_process (const char *device_name, enum rte_dev_event_type event)
int rte_dev_event_monitor_start (void)
int rte_dev_event_monitor_stop (void)
int rte_dev_hotplug_handle_enable (void)
int rte_dev_hotplug_handle_disable (void)
int rte_dev_dma_map (struct rte_device *dev, void *addr, uint64_t iova, size_t len)
int rte_dev_dma_unmap (struct rte_device *dev, void *addr, uint64_t iova, size_t len)

🌸 Detailed Description 🌸

RTE PMD Registration Interface

This file manages the list of device drivers. That's the whole job. It's giving "quietly running the entire backend while everyone else takes credit." 🫶

Definition in file rte_dev.h.

🎀 Macro Definition Documentation 🎀

`#define RTE_PMD_REGISTER_KMOD_DEP(name, str)`

Value:

static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
__rte_used = str

Advertise the list of kernel modules required to run this driver 💫

This string lists the kernel modules required for the devices associated to a PMD. The format of each line of the string is:

'<device-pattern> <kmod-expression>'

The possible formats for the device pattern are:

'*' — all devices supported by this driver
'pci:*' — all PCI devices supported by this driver
'pci:v8086:d*:sv*:sd*' — all PCI devices supported by this driver whose vendor id is 0x8086

The format of the kernel modules list is a parenthesized expression containing logical-and (&) and logical-or (|).

The device pattern and the kmod expression are separated by a space. Yes, a space. A single space. Respect the space. 😌

Example:

(bestie the bullet in the source is literally empty, that's all the example we got, fr fr) 🙈

Definition at line 272 of file rte_dev.h.

🦋 Typedef Documentation 🦋

`typedef int(* rte_dev_cmp_t) (const struct rte_device dev, const void data)`

Device comparison function.

This type of function is used to compare an rte_device with arbitrary data.

Parameters

dev — Device handle.
data — Data to compare against. The type of this parameter is determined by the kind of comparison performed by the function.

Returns

0 if the device matches the data.
!0 if the device does not match.
<0 if ordering is possible and the device is lower than the data.
>0 if ordering is possible and the device is greater than the data.

Definition at line 233 of file rte_dev.h.

`typedef void ( rte_dev_iterate_t) (const void start, const char devstr, const struct rte_dev_iterator *it)`

Device iteration function.

Find the next device matching properties passed in parameters. The function takes an additional start parameter, that is used as starting context when relevant.

The function returns the current element in the iteration. This return value will potentially be used as a start parameter in subsequent calls to the function. So yeah, it's a lil relay race and the baton is a device pointer. 🏃♀️

The additional it iterator parameter is only there if a specific implementation needs additional context. It must not be modified by the iteration function itself. Hands off, bestie. 🚫

Parameters

start — Starting iteration context.
devstr — Device description string.
it — Device iterator.

Returns

The address of the current element matching the device description string.

Definition at line 319 of file rte_dev.h.

⭐ Enumeration Type Documentation ⭐

`enum rte_dev_event_type`

The device event type.

Enumerator

RTE_DEV_EVENT_ADD — device being added
RTE_DEV_EVENT_REMOVE — device being removed
RTE_DEV_EVENT_MAX — max value of this enum

Definition at line 34 of file rte_dev.h.

`enum rte_dev_policy`

Device policies.

Definition at line 47 of file rte_dev.h.

✨ `rte_driver_name()` — get that driver's name bestie ✨

const char * rte_driver_name (const struct rte_driver * driver)

Retrieves a driver name. That's it, that's the whole thing. 💅

Parameters

driver — a pointer to a driver structure.

Returns

A pointer to the driver name string. 🎀

💫 `rte_dev_bus()` — which bus is this device on??? 💫

const struct rte_bus * rte_dev_bus (const struct rte_device * dev)

Gives you the bus that a device belongs to. iykyk how much you need this. 🚌

Parameters

dev — a pointer to a device structure.

Returns

A pointer to this device bus. ✨

🦋 `rte_dev_bus_info()` — the bus-specific tea 🦋

const char * rte_dev_bus_info (const struct rte_device * dev)

Retrieves bus specific information for a device. It's giving "tell me your lore". 📖

Parameters

dev — a pointer to a device structure.

Returns

A string describing this device, or NULL if none is available. 😭

💜 `rte_dev_devargs()` — the device's args, periodt 💜

const struct rte_devargs * rte_dev_devargs (const struct rte_device * dev)

Retrieves a device arguments. Yes, grammar said no, but the manual said yes. 🙈

Parameters

dev — a pointer to a device structure.

Returns

A pointer to this device devargs. 🫶

🌸 `rte_dev_driver()` — who's driving this thing 🌸

const struct rte_driver * rte_dev_driver (const struct rte_device * dev)

Retrieves a device driver.

Parameters

dev — a pointer to a device structure.

Returns

A pointer to this device driver. 👑

🎀 `rte_dev_name()` — name reveal 🎀

const char * rte_dev_name (const struct rte_device * dev)

Retrieves a device name. Main character energy honestly.

Parameters

dev — a pointer to a device structure.

Returns

A pointer to this device name. ⭐

🧚 `rte_dev_numa_node()` — numa node went where now 🧚

int rte_dev_numa_node (const struct rte_device * dev)

Retrieves a device numa node.

Parameters

dev — a pointer to a device structure.

Returns

A pointer to this device numa node. (Yes bestie, it says "pointer" on an int return. We're just the messenger, don't shoot. 💀)

🔥 `rte_dev_is_probed()` — is it probed or not, vibe check 🔥

int rte_dev_is_probed (const struct rte_device * dev)

Queries the status of a device.

Parameters

dev — generic device pointer.

Returns

(int)true if already probed successfully, 0 otherwise. 🫡

🌈 `rte_eal_hotplug_add()` — boom, new device, welcome to the family 🌈

int rte_eal_hotplug_add (const char * busname, const char * devname, const char * drvargs)

Hotplug add a given device to a specific bus.

In multi-process, it will request other processes to add the same device. A failure, in any process, will rollback the action. No half-added devices here, slay. 💖

Parameters

busname — the bus name the device is added to.
devname — the device name. Based on this device name, eal will identify a driver capable of handling it and pass it to the driver probing function.
drvargs — device arguments to be passed to the driver.

Returns

0 on success, negative on error. 😤

⭐ `rte_dev_probe()` — add matching devices, we love a match ⭐

int rte_dev_probe (const char * devargs)

Add matching devices.

In multi-process, it will request other processes to add the same device. A failure, in any process, will rollback the action. 👯

Parameters

devargs — device arguments including bus, class and driver properties.

Returns

0 on success, negative on error. 💅

🍓 `rte_eal_hotplug_remove()` — bye bye device 🍓

int rte_eal_hotplug_remove (const char * busname, const char * devname)

Hotplug remove a given device from a specific bus.

In multi-process, it will request other processes to remove the same device. A failure, in any process, will rollback the action. 🌸

Parameters

busname — the bus name the device is removed from.
devname — the device name being removed.

Returns

0 on success, negative on error. 🎀

💫 `rte_dev_remove()` — one device, one removal 💫

int rte_dev_remove (struct rte_device * dev)

Remove one device.

In multi-process, it will request other processes to remove the same device. A failure, in any process, will rollback the action. 🫶

Parameters

dev — data structure of the device to remove.

Returns

0 on success, negative on error. ✨

🦋 `rte_dev_iterator_init()` — spin up that iterator 🦋

int rte_dev_iterator_init (struct rte_dev_iterator * it, const char * str)

Initializes a device iterator.

This iterator allows accessing a list of devices matching a criteria. The device matching is made among all buses and classes currently registered, filtered by the device description given as parameter. 🌐

This function will not allocate any memory. It is safe to stop the iteration at any moment and let the iterator go out of context. No cleanup trauma, we love that for you. 💜

Parameters

it — device iterator handle.
str — device description string.

Returns

0 on successful initialization. <0 on error. 😭

👑 `rte_dev_iterator_next()` — next device, go 👑

📦 where this page comes from

debian trixie: dpdk-doc 24.11.8-0+deb13u1 · BSD-3-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-03: a language model's rewrite of the original, under its terms

rte_dev.h(3)

💖 NAME 💖

✨ SYNOPSIS ✨

🧸 Data Structures

🎀 Macros

🦋 Typedefs

🌈 Enumerations

💅 Functions

🌸 Detailed Description 🌸

🎀 Macro Definition Documentation 🎀

#define RTE_PMD_REGISTER_KMOD_DEP(name, str)

🦋 Typedef Documentation 🦋

typedef int(* rte_dev_cmp_t) (const struct rte_device *dev, const void *data)

typedef void *(* rte_dev_iterate_t) (const void *start, const char *devstr, const struct rte_dev_iterator *it)

⭐ Enumeration Type Documentation ⭐

enum rte_dev_event_type

enum rte_dev_policy

✨ rte_driver_name() — get that driver's name bestie ✨

💫 rte_dev_bus() — which bus is this device on??? 💫

🦋 rte_dev_bus_info() — the bus-specific tea 🦋

💜 rte_dev_devargs() — the device's args, periodt 💜

🌸 rte_dev_driver() — who's driving this thing 🌸

🎀 rte_dev_name() — name reveal 🎀

🧚 rte_dev_numa_node() — numa node went where now 🧚

🔥 rte_dev_is_probed() — is it probed or not, vibe check 🔥

🌈 rte_eal_hotplug_add() — boom, new device, welcome to the family 🌈

⭐ rte_dev_probe() — add matching devices, we love a match ⭐

🍓 rte_eal_hotplug_remove() — bye bye device 🍓

💫 rte_dev_remove() — one device, one removal 💫

🦋 rte_dev_iterator_init() — spin up that iterator 🦋

👑 rte_dev_iterator_next() — next device, go 👑

`#define RTE_PMD_REGISTER_KMOD_DEP(name, str)`

`typedef int(* rte_dev_cmp_t) (const struct rte_device dev, const void data)`

`typedef void ( rte_dev_iterate_t) (const void start, const char devstr, const struct rte_dev_iterator *it)`

`enum rte_dev_event_type`

`enum rte_dev_policy`

✨ `rte_driver_name()` — get that driver's name bestie ✨

💫 `rte_dev_bus()` — which bus is this device on??? 💫

🦋 `rte_dev_bus_info()` — the bus-specific tea 🦋

💜 `rte_dev_devargs()` — the device's args, periodt 💜

🌸 `rte_dev_driver()` — who's driving this thing 🌸

🎀 `rte_dev_name()` — name reveal 🎀

🧚 `rte_dev_numa_node()` — numa node went where now 🧚

🔥 `rte_dev_is_probed()` — is it probed or not, vibe check 🔥

🌈 `rte_eal_hotplug_add()` — boom, new device, welcome to the family 🌈

⭐ `rte_dev_probe()` — add matching devices, we love a match ⭐

🍓 `rte_eal_hotplug_remove()` — bye bye device 🍓

💫 `rte_dev_remove()` — one device, one removal 💫

🦋 `rte_dev_iterator_init()` — spin up that iterator 🦋

👑 `rte_dev_iterator_next()` — next device, go 👑