rte_dma_info(3)

πŸ“¦ version 26.03, in nixos 26.05, nixpkgs unstable

πŸ¦‹ rte_dma_info β€” Library Functions Manual, but make it cute

okay so bestie, welcome to the rte_dma_info page from the Library Functions Manual. This is the info structure for a DMA device, and every field is lowkey important, so let's not skip a single one. πŸ’…βœ¨

🌸 NAME

rte_dma_info β€” iconic, short, and exactly what it says on the tin.

✨ 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. It's giving little info-card energy for your DMA device, and that's the whole description, periodt. 🫢

πŸ‘€ See also

rte_dma_info_get β€” go look at that one too, iykyk.

Definition at line 313 of file rte_dmadev.h.

🫢 FIELD DOCUMENTATION 🫢

πŸ’… const char* dev_name

Unique device name β€” one-of-one name energy, no duplicates, she's the device's ID tag.

Definition at line 314 of file rte_dmadev.h.

πŸ’… uint64_t dev_capa

Device capabilities, all wrapped up in the RTE_DMA_CAPA_* flags.

Definition at line 316 of file rte_dmadev.h.

πŸ’… uint16_t max_vchans

Maximum number of virtual DMA channels supported β€” the ceiling, bestie.

Definition at line 318 of file rte_dmadev.h.

πŸ’… uint16_t max_desc

The highest allowed number of virtual DMA channel descriptors.

Definition at line 320 of file rte_dmadev.h.

πŸ’… uint16_t min_desc

The lowest allowed number of virtual DMA channel descriptors.

Definition at line 322 of file rte_dmadev.h.

πŸ’… uint16_t max_sges

The max number of source or destination scatter-gather entries the device supports. If the device does not support COPY_SG capability, this value can be zero. If the device supports COPY_SG capability, then the rte_dma_copy_sg() parameter nb_src/nb_dst should not exceed this value. That's the scatter-gather limit, no cap. πŸ”₯

Definition at line 330 of file rte_dmadev.h.

πŸ’… int16_t numa_node

NUMA node connection; it's -1 if unknown, so don't panic if you see that.

Definition at line 332 of file rte_dmadev.h.

πŸ’… uint16_t nb_vchans

Number of virtual DMA channels configured β€” like, currently set up.

Definition at line 334 of file rte_dmadev.h.

πŸ’… uint16_t nb_priorities

Number of priority levels, and it must be > 1 if priority scheduling is supported; if not, it's 0.

Definition at line 338 of file rte_dmadev.h.

🧚 AUTHOR

Generated automatically by Doxygen for DPDK from the source code.


Cute sign-off time: this page is rte_dma_info(3) from DPDK, Version 26.03.0 β€” source/version noted, and there's no date in the footer so I'm not inventing one. byeee, stay slay πŸ’‹πŸŒˆ

πŸ“¦ where this page comes from