bc2a13136a
BCMSAI 4.3.0.10, 6.5.21 SDK release with enhancements and fixes for vxlan, TD3 MMU, TD4-X9 EA support, etc.
365 lines
8.6 KiB
C
365 lines
8.6 KiB
C
/*! \file ngknet_callback.h
|
|
*
|
|
* Data structure definitions for NGKNET callbacks.
|
|
*
|
|
*/
|
|
/*
|
|
* $Copyright: Copyright 2018-2020 Broadcom. All rights reserved.
|
|
* The term 'Broadcom' refers to Broadcom Inc. and/or its subsidiaries.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* version 2 as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* A copy of the GNU General Public License version 2 (GPLv2) can
|
|
* be found in the LICENSES folder.$
|
|
*/
|
|
|
|
#ifndef NGKNET_CALLBACK_H
|
|
#define NGKNET_CALLBACK_H
|
|
|
|
#include <linux/skbuff.h>
|
|
#include "ngknet_main.h"
|
|
|
|
/*!
|
|
* \brief NGKNET callback description.
|
|
*/
|
|
struct ngknet_callback_desc {
|
|
/*! Device number */
|
|
int dev_no;
|
|
|
|
/*! Device ID */
|
|
uint32_t dev_id;
|
|
|
|
/*! Device type string */
|
|
const char *type_str;
|
|
|
|
/*! Network interface private data */
|
|
struct ngknet_private *priv;
|
|
|
|
/*! Matched filter */
|
|
struct ngknet_filter_s *filt;
|
|
|
|
/*! Packet meta data */
|
|
uint8_t *pmd;
|
|
|
|
/*! Packet meta data length */
|
|
int pmd_len;
|
|
|
|
/*! Packet data length */
|
|
int pkt_len;
|
|
|
|
/*! Matched callback filter */
|
|
struct ngknet_filter_s *filt_cb;
|
|
};
|
|
|
|
#define NGKNET_SKB_CB(_skb) ((struct ngknet_callback_desc *)_skb->cb)
|
|
|
|
/*! Handle Rx packet */
|
|
typedef struct sk_buff *
|
|
(*ngknet_rx_cb_f)(struct sk_buff *skb);
|
|
|
|
/*! Handle Tx packet */
|
|
typedef struct sk_buff *
|
|
(*ngknet_tx_cb_f)(struct sk_buff *skb);
|
|
|
|
/*! PTP Rx/Tx config set */
|
|
typedef int
|
|
(*ngknet_ptp_config_set_cb_f)(struct ngknet_private *priv, int *value);
|
|
|
|
/*! PTP Rx/Tx HW timestamp get */
|
|
typedef int
|
|
(*ngknet_ptp_hwts_get_cb_f)(struct sk_buff *skb, uint64_t *ts);
|
|
|
|
/*! PTP Tx meta set */
|
|
typedef int
|
|
(*ngknet_ptp_meta_set_cb_f)(struct sk_buff *skb);
|
|
|
|
/*! PTP PHC index get */
|
|
typedef int
|
|
(*ngknet_ptp_phc_index_get_cb_f)(struct ngknet_private *priv, int *index);
|
|
|
|
/*! PTP device control */
|
|
typedef int
|
|
(*ngknet_ptp_dev_ctrl_cb_f)(struct ngknet_dev *dev, int cmd, char *data, int len);
|
|
|
|
/*! Netif callback */
|
|
typedef int
|
|
(*ngknet_netif_cb_f)(struct net_device *dev);
|
|
|
|
/*!
|
|
* \brief NGKNET callback control.
|
|
*/
|
|
struct ngknet_callback_ctrl {
|
|
/*! Handle Rx packet */
|
|
ngknet_rx_cb_f rx_cb;
|
|
|
|
/*! Handle Tx packet */
|
|
ngknet_tx_cb_f tx_cb;
|
|
|
|
/*! PTP Rx config set */
|
|
ngknet_ptp_config_set_cb_f ptp_rx_config_set_cb;
|
|
|
|
/*! PTP Tx config set */
|
|
ngknet_ptp_config_set_cb_f ptp_tx_config_set_cb;
|
|
|
|
/*! PTP Rx HW timestamp get */
|
|
ngknet_ptp_hwts_get_cb_f ptp_rx_hwts_get_cb;
|
|
|
|
/*! PTP Tx HW timestamp get */
|
|
ngknet_ptp_hwts_get_cb_f ptp_tx_hwts_get_cb;
|
|
|
|
/*! PTP Tx meta set */
|
|
ngknet_ptp_meta_set_cb_f ptp_tx_meta_set_cb;
|
|
|
|
/*! PTP PHC index get */
|
|
ngknet_ptp_phc_index_get_cb_f ptp_phc_index_get_cb;
|
|
|
|
/*! PTP device control */
|
|
ngknet_ptp_dev_ctrl_cb_f ptp_dev_ctrl_cb;
|
|
|
|
/*! Handle Netif create */
|
|
ngknet_netif_cb_f netif_create_cb;
|
|
|
|
/*! Handle Netif destroy */
|
|
ngknet_netif_cb_f netif_destroy_cb;
|
|
};
|
|
|
|
/*!
|
|
* \brief Get callback control.
|
|
*
|
|
* \param [in] cbc Pointer to callback control.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_callback_control_get(struct ngknet_callback_ctrl **cbc);
|
|
|
|
/*!
|
|
* \brief Register Rx callback.
|
|
*
|
|
* \param [in] rx_cb Rx callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_rx_cb_register(ngknet_rx_cb_f rx_cb);
|
|
|
|
/*!
|
|
* \brief Unregister Rx callback.
|
|
*
|
|
* \param [in] rx_cb Rx callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_rx_cb_unregister(ngknet_rx_cb_f rx_cb);
|
|
|
|
/*!
|
|
* \brief Register Tx callback.
|
|
*
|
|
* \param [in] tx_cb Tx callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_tx_cb_register(ngknet_tx_cb_f tx_cb);
|
|
|
|
/*!
|
|
* \brief Unregister Tx callback.
|
|
*
|
|
* \param [in] tx_cb Tx callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_tx_cb_unregister(ngknet_tx_cb_f tx_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP Rx config set callback.
|
|
*
|
|
* \param [in] ptp_rx_config_set_cb Rx config set callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_rx_config_set_cb_register(ngknet_ptp_config_set_cb_f ptp_rx_config_set_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP Rx config set callback.
|
|
*
|
|
* \param [in] ptp_rx_config_set_cb Rx config set callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_rx_config_set_cb_unregister(ngknet_ptp_config_set_cb_f ptp_rx_config_set_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP Tx config set callback.
|
|
*
|
|
* \param [in] ptp_tx_config_set_cb Tx config set callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_tx_config_set_cb_register(ngknet_ptp_config_set_cb_f ptp_tx_config_set_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP Tx config set callback.
|
|
*
|
|
* \param [in] ptp_tx_config_set_cb Tx config set callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_tx_config_set_cb_unregister(ngknet_ptp_config_set_cb_f ptp_tx_config_set_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP Rx HW timestamp get callback.
|
|
*
|
|
* \param [in] ptp_rx_hwts_get_cb Rx HW timestamp get callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_rx_hwts_get_cb_register(ngknet_ptp_hwts_get_cb_f ptp_rx_hwts_get_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP Rx HW timestamp get callback.
|
|
*
|
|
* \param [in] ptp_rx_hwts_get_cb Rx HW timestamp get callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_rx_hwts_get_cb_unregister(ngknet_ptp_hwts_get_cb_f ptp_rx_hwts_get_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP Tx HW timestamp get callback.
|
|
*
|
|
* \param [in] ptp_tx_hwts_get_cb Tx HW timestamp get callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_tx_hwts_get_cb_register(ngknet_ptp_hwts_get_cb_f ptp_tx_hwts_get_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP Tx HW timestamp get callback.
|
|
*
|
|
* \param [in] ptp_tx_hwts_get_cb Tx HW timestamp get callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_tx_hwts_get_cb_unregister(ngknet_ptp_hwts_get_cb_f ptp_tx_hwts_get_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP Tx meta set callback.
|
|
*
|
|
* \param [in] ptp_tx_meta_set_cb Tx meta set callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_tx_meta_set_cb_register(ngknet_ptp_meta_set_cb_f ptp_tx_meta_set_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP Tx meta set callback.
|
|
*
|
|
* \param [in] ptp_tx_meta_set_cb Tx meta set callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_tx_meta_set_cb_unregister(ngknet_ptp_meta_set_cb_f ptp_tx_meta_set_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP PHC index get callback.
|
|
*
|
|
* \param [in] ptp_phc_index_get_cb PHC index get callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_phc_index_get_cb_register(ngknet_ptp_phc_index_get_cb_f ptp_phc_index_get_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP PHC index get callback.
|
|
*
|
|
* \param [in] ptp_phc_index_get_cb PHC index get callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_phc_index_get_cb_unregister(ngknet_ptp_phc_index_get_cb_f ptp_phc_index_get_cb);
|
|
|
|
/*!
|
|
* \brief Register PTP device control callback.
|
|
*
|
|
* \param [in] ptp_dev_ctrl_cb Device control callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_dev_ctrl_cb_register(ngknet_ptp_dev_ctrl_cb_f ptp_dev_ctrl_cb);
|
|
|
|
/*!
|
|
* \brief Unregister PTP device control callback.
|
|
*
|
|
* \param [in] ptp_dev_ctrl_cb Device control callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_ptp_dev_ctrl_cb_unregister(ngknet_ptp_dev_ctrl_cb_f ptp_dev_ctrl_cb);
|
|
|
|
/*!
|
|
* \brief Register Netif Create callback.
|
|
*
|
|
* \param [netif_cb] netif_cb create callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_netif_create_cb_register(ngknet_netif_cb_f netif_cb);
|
|
|
|
/*!
|
|
* \brief Unregister Netif Create callback.
|
|
*
|
|
* \param [netif_cb] netif_cb destroy callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_netif_create_cb_unregister(ngknet_netif_cb_f netif_cb);
|
|
|
|
/*!
|
|
* \brief Register Netif Destroy callback.
|
|
*
|
|
* \param [netif_cb] netif_cb destroy callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_netif_destroy_cb_register(ngknet_netif_cb_f netif_cb);
|
|
|
|
/*!
|
|
* \brief Unregister Netif Destroy callback.
|
|
*
|
|
* \param [netif_cb] netif_cb destroy callback function.
|
|
*
|
|
* \retval SHR_E_NONE No errors.
|
|
*/
|
|
extern int
|
|
ngknet_netif_destroy_cb_unregister(ngknet_netif_cb_f netif_cb);
|
|
|
|
#endif /* NGKNET_CALLBACK_H */
|
|
|