lib/node/rte_node_eth_api.h - main - phprus/github_dpdk

lib/node/rte_node_eth_api.h
82 строки2 KB
Luca Boccassi
doc: fix grammar after the verb allow
01 июн 2026, 16:02
01 июн 2026, 16:02a14bda0
/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(C) 2020 Marvell International Ltd.
 */

#ifndef __INCLUDE_RTE_NODE_ETH_API_H__
#define __INCLUDE_RTE_NODE_ETH_API_H__

/**
 * @file rte_node_eth_api.h
 *
 * @warning
 * @b EXPERIMENTAL:
 * All functions in this file may be changed or removed without prior notice.
 *
 * This API allows setting up ethdev_rx and ethdev_tx nodes
 * and its queue associations.
 */

#include <rte_compat.h>
#include <rte_common.h>
#include <rte_graph.h>
#include <rte_mempool.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Port config for ethdev_rx and ethdev_tx node.
 */
struct rte_node_ethdev_config {
	uint16_t port_id;
	/**< Port identifier */
	uint16_t num_rx_queues;
	/**< Number of Rx queues. */
	uint16_t num_tx_queues;
	/**< Number of Tx queues. */
	struct rte_mempool **mp;
	/**< Array of mempools associated to Rx queue. */
	uint16_t mp_count;
	/**< Size of mp array. */
};

/**
 * Initializes ethdev nodes.
 *
 * @param cfg
 *   Array of ethdev config that identifies which port's
 *   ethdev_rx and ethdev_tx nodes need to be created
 *   and queue association.
 * @param cnt
 *   Size of cfg array.
 * @param nb_graphs
 *   Number of graphs that will be used.
 *
 * @return
 *   0 on successful initialization, negative otherwise.
 */
int rte_node_eth_config(struct rte_node_ethdev_config *cfg,
			uint16_t cnt, uint16_t nb_graphs);

/**
 * Update ethdev rx next node.
 *
 * @param id
 *   Node id whose edge is to be updated.
 * @param edge_name
 *   Name of the next node.
 *
 * @return
 *   - EINVAL: Either of input parameters are invalid
 *   - ENOMEM: If memory allocation failed
 *   - 0 on successful initialization.
 */
__rte_experimental
int rte_node_ethdev_rx_next_update(rte_node_t id, const char *edge_name);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_NODE_ETH_API_H__ */