rte_dma_info(3)

πŸ’– rte_dma_info β€” the whole vibe, explained πŸ’–

okay bestie, so this is rte_dma_info(3), a page from the DPDK Library Functions Manual, and it's literally just the blueprint for one lil' struct that tells you everything about a DMA device. no cap. let's get into it πŸ¦‹


✨ NAME ✨

rte_dma_info β€” the struct you use to peek at a DMA device's whole personality πŸ’…


🌸 SYNOPSIS 🌸

#include <rte_dmadev.h>

πŸŽ€ Data Fields πŸŽ€

  • const char * dev_name
  • uint64_t dev_capa
  • uint16_t max_vchans
  • uint16_t max_desc
  • uint16_t min_desc
  • uint16_t max_sges
  • int16_t numa_node
  • uint16_t nb_vchans
  • uint16_t nb_priorities

πŸ‘‘ Detailed Description πŸ‘‘

A structure used to retrieve the information of a DMA device. that's it, that's the whole job. it's giving "tell me everything about this DMA device and don't leave out the details" πŸ’–

See also

rte_dma_info_get β€” the function that actually fills this bad boy in 🫢

Definition at line 313 of file rte_dmadev.h.


🧚 Field Documentation 🧚

const char* dev_name

Unique device name. one-of-a-kind, main character energy only πŸ‘‘

Definition at line 314 of file rte_dmadev.h.

uint64_t dev_capa

Device capabilities (RTE_DMA_CAPA_*). all the flags describing what this device can actually do ✨

Definition at line 316 of file rte_dmadev.h.

uint16_t max_vchans

Maximum number of virtual DMA channels supported. that's the ceiling, bestie πŸ”₯

Definition at line 318 of file rte_dmadev.h.

uint16_t max_desc

Maximum allowed number of virtual DMA channel descriptors. the upper limit, periodt πŸ’…

Definition at line 320 of file rte_dmadev.h.

uint16_t min_desc

Minimum allowed number of virtual DMA channel descriptors. and the lower limit too, we don't do zero 🌸

Definition at line 322 of file rte_dmadev.h.

uint16_t max_sges

Maximum number of source or destination scatter-gather entry supported. okay so pay attention here, because there are two whole cases:

  • If the device does not support the COPY_SG capability, this value can be zero.
  • If the device does support the COPY_SG capability, then rte_dma_copy_sg() parameter nb_src/nb_dst should not exceed this value. so don't be out here overshooting, the vibe check will catch you 😭

Definition at line 330 of file rte_dmadev.h.

int16_t numa_node

NUMA node connection, -1 if unknown. if it's -1 it's lowkey a mystery πŸ”

Definition at line 332 of file rte_dmadev.h.

uint16_t nb_vchans

Number of virtual DMA channel configured. not the max β€” the actual count you've set up πŸŽ€

Definition at line 334 of file rte_dmadev.h.

uint16_t nb_priorities

Number of priority levels (must be > 1) if priority scheduling is supported, 0 otherwise. so either you got priorities or you got a big fat zero, no in-between 😌

Definition at line 338 of file rte_dmadev.h.


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for DPDK from the source code. not a human writing this by hand, it's a machine and honestly? it ate πŸ€–βœ¨


and that's the whole page, bestie!! this one came straight outta DPDK Version 25.11.3, dated with the rte_dma_info(3) footer energy β€” go get that DMA info, you're gonna slay πŸ«ΆπŸ’–πŸŒˆ

πŸ“¦ where this page comes from