numam-dpdk/lib/librte_node/rte_node_eth_api.h
David Marchand 74f4d6424d lib: remind experimental status in headers
The following libraries are experimental, all of their functions can
be changed or removed:

- librte_bbdev
- librte_bpf
- librte_compressdev
- librte_fib
- librte_flow_classify
- librte_graph
- librte_ipsec
- librte_node
- librte_rcu
- librte_rib
- librte_stack
- librte_telemetry

Their status is properly announced in MAINTAINERS.
Remind this status in their headers in a common fashion (aligned to ABI
docs).

Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2020-07-07 12:49:10 +02:00

66 lines
1.4 KiB
C

/* 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 to setup ethdev_rx and ethdev_tx nodes
* and its queue associations.
*
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <rte_common.h>
#include <rte_mempool.h>
/**
* 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.
*/
__rte_experimental
int rte_node_eth_config(struct rte_node_ethdev_config *cfg,
uint16_t cnt, uint16_t nb_graphs);
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_RTE_NODE_ETH_API_H__ */