numam-dpdk/drivers/event/dlb2/rte_pmd_dlb2.h
Timothy McDaniel c667583d82 event/dlb2: add token pop API
The PMD uses a public interface to allow applications to
control the token pop mode. Supported token pop modes are
as follows, and they impact core scheduling affinity for
ldb ports.

AUTO_POP: Pop the CQ tokens immediately after dequeueing.
DELAYED_POP: Pop CQ tokens after (dequeue_depth - 1) events
             are released. Supported on load-balanced ports
             only.
DEFERRED_POP: Pop the CQ tokens during next dequeue operation.

Signed-off-by: Timothy McDaniel <timothy.mcdaniel@intel.com>
Reviewed-by: Gage Eads <gage.eads@intel.com>
2020-11-02 09:40:22 +01:00

73 lines
1.6 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2020 Intel Corporation
*/
/*!
* @file rte_pmd_dlb2.h
*
* @brief DLB PMD-specific functions
*/
#ifndef _RTE_PMD_DLB2_H_
#define _RTE_PMD_DLB2_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Selects the token pop mode for a DLB2 port.
*/
enum dlb2_token_pop_mode {
/* Pop the CQ tokens immediately after dequeueing. */
AUTO_POP,
/* Pop CQ tokens after (dequeue_depth - 1) events are released.
* Supported on load-balanced ports only.
*/
DELAYED_POP,
/* Pop the CQ tokens during next dequeue operation. */
DEFERRED_POP,
/* NUM_TOKEN_POP_MODES must be last */
NUM_TOKEN_POP_MODES
};
/*!
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Configure the token pop mode for a DLB2 port. By default, all ports use
* AUTO_POP. This function must be called before calling rte_event_port_setup()
* for the port, but after calling rte_event_dev_configure().
*
* @param dev_id
* The identifier of the event device.
* @param port_id
* The identifier of the event port.
* @param mode
* The token pop mode.
*
* @return
* - 0: Success
* - EINVAL: Invalid dev_id, port_id, or mode
* - EINVAL: The DLB2 is not configured, is already running, or the port is
* already setup
*/
__rte_experimental
int
rte_pmd_dlb2_set_token_pop_mode(uint8_t dev_id,
uint8_t port_id,
enum dlb2_token_pop_mode mode);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_PMD_DLB2_H_ */