// SPDX-License-Identifier: GPL-2.0
/* Copyright (C) Intel Corporation
 * Author: Shao Guohua <guohua.shao@intel.com>
 */

#ifndef _DATAPATH_API_TX_H
#define _DATAPATH_API_TX_H

/*! @{ */
/*!
 * @file datapath_api_tx.h
 *
 * @brief Datapath TX path API
 */
/*! @} */

enum DP_TX_FN_RET {
	DP_TX_FN_CONSUMED,
	DP_TX_FN_CONTINUE,
	DP_TX_FN_DROPPED,
};

/**
 * enum DP_TX_PRIORITY - define TX chain priority from high to low
 */
/*! @brief define TX chain priority from high to low */
enum DP_TX_PRIORITY {
	DP_TX_PP, /*!< packet processor */
	DP_TX_TSO, /*!< traffic offload engine */
	DP_TX_VPNA, /*!< VPN adapter */
	DP_TX_CQM, /*!< CQM CPU port */
	DP_TX_CNT,
};

/**
 * enum DP_TX_FLAGS - define TX path common flags
 */
/*! @brief define TX path common flags */
enum DP_TX_FLAGS {
	DP_TX_FLAG_INSERT_PMAC = BIT(0), /*!< insert PMAC header*/
	DP_TX_FLAG_STREAM_PORT = BIT(1), /*!< is stream port*/
};

/**
 * struct dp_tx_common - datapath TX callback parameters
 * @flags: bitmap of DP_TX_FLAGS
 * @private: private value from dp_register_txpath()
 */
/*! @brief datapath TX callback parameters */
struct dp_tx_common {
	u8 *pmac; /*!< PMAC */
	u32 flags; /*!< bitmap of enum DP_TX_FLAGS */
	u8 len; /*!< length of PMAC */
	u8 dpid; /*!< datapath port ID */
	u8 vap; /*!< datapath port subif vap */
	u8 gpid; /*!< GPID */
	struct dev_mib *mib; /*!< per vap MIB */
};

/**
 * tx_fn() - callback prototype for TX path
 * @param[in,out] skb: skb to process
 * @param[in,out] cmn: common data which is persist across the call chain
 * @param[in,out] p: private parameter passed in from dp_register_tx()
 *
 * @Return DP_TX_FN_CONSUMED - skb consumed, stop further process;
 *         DP_TX_FN_CONTINUE skb - not consumed, continue for further process;
 *         others - skb not consumed with error code, stop further process
 */
typedef int (*tx_fn)(struct sk_buff *skb, struct dp_tx_common *cmn, void *p);

/**
 * dp_register_tx() - register datapath tx path function
 * @priority: TX priority
 * @tx_fn: callback function
 * @p: parameters
 */
int dp_register_tx(enum DP_TX_PRIORITY priority, tx_fn fn, void *p);

#endif /* end of include guard: _DATAPATH_API_TX_H */