QEP DPDK PMD Exported APIs¶
Xilinx QEP DPDK Interface Definitions
Header file rte_pmd_qep.h defines data structures and functions exported by QEP DPDK PMD.
These APIs are subject to change.
-
enum
rte_pmd_qep_desc_type¶ Indicates the type of queue descriptor ring to dump
Constants
RTE_PMD_QEP_DESC_C2H- Dump C2H queue’s descriptor
RTE_PMD_QEP_DESC_H2C- Dump H2C queue’s descriptor
RTE_PMD_QEP_DESC_CMPT- Dump completion queue’s descriptor
RTE_PMD_QEP_DESC_MAX- Unsupported value
-
int
rte_pmd_qep_get_bar_details(int portid, int32_t * config_bar_idx, int32_t * user_bar_idx, int32_t * bypass_bar_idx)¶ Returns the BAR indices of the QDMA BARs
Parameters
int portid- Port ID
int32_t * config_bar_idx- Config BAR index
int32_t * user_bar_idx- User BAR index
int32_t * bypass_bar_idx- Bypass BAR index
Return
‘0’ on success, ‘< 0’ on failure
-
int
rte_pmd_qep_get_queue_base(int portid, uint32_t * queue_base)¶ Returns queue base for given port
Parameters
int portid- Port ID
uint32_t * queue_base- queue base
Return
‘0’ on success, ‘< 0’ on failure
Note
Application can call this API only after successful
call to rte_eth_dev_configure() API.
-
int
rte_pmd_qep_dbg_regdump(uint8_t portid)¶ Dumps the QDMA configuration registers for the given port
Parameters
uint8_t portid- Port ID
Return
‘0’ on success, ‘< 0’ on failure
-
int
rte_pmd_qep_dbg_qinfo(uint8_t portid, uint16_t queue)¶ Dumps the queue contexts and queue specific SW structures for the given queue ID on the port
Parameters
uint8_t portid- Port ID
uint16_t queue- Queue ID relative to the Port
Return
‘0’ on success, ‘< 0’ on failure
-
int
rte_pmd_qep_dbg_qdesc(uint8_t portid, uint16_t queue, int start, int end, enum rte_pmd_qep_desc_type type)¶ Dumps the Queue descriptors
Parameters
uint8_t portid- Port ID
uint16_t queue- Queue ID relative to the Port
int start- start index of the descriptor to dump
int end- end index of the descriptor to dump
enum rte_pmd_qep_desc_type type- Descriptor type
Return
‘0’ on success, ‘< 0’ on failure
-
int
rte_pmd_qep_dbg_stmninfo(uint8_t portid)¶ Dumps the STM-N status and statistics
Parameters
uint8_t portid- Port ID
Return
‘0’ on success, ‘< 0’ on failure
-
int
rte_pmd_qep_addr_read(int portid, uint32_t bar, uint32_t addr, uint32_t * val)¶ Returns the value at the given BAR offset
Parameters
int portid- Port ID
uint32_t bar- PCIe BAR number
uint32_t addr- BAR offset to read
uint32_t * val- Pointer holding the read value
Return
‘0’ on success, ‘< 0’ on failure
-
int
rte_pmd_qep_addr_write(int portid, uint32_t bar, uint32_t addr, uint32_t val)¶ Writes the value at the given BAR offset
Parameters
int portid- Port ID
uint32_t bar- PCIe BAR number
uint32_t addr- BAR offset to write
uint32_t val- Value to be written
Return
‘0’ on success, ‘< 0’ on failure