sonic-buildimage/platform/broadcom/saibcm-modules/sdklt/linux/knet/ngknet_callback.h
vmittal-msft 04b9ce8e32
[BCMSAI] Update BCMSAI debian to 6.0.0.10 with 6.5.23 SDK, and opennsl module to 6.5.23 (#9046)
Manual verification on switch (TH3 device)
admin@str2-xxxxx-01:~$ bcmcmd bsv
bsv
BRCM SAI ver: [6.0.0.10], OCP SAI ver: [1.9.1], SDK ver: [sdk-6.5.23]
drivshell>

admin@str2-xxxxx-01:~$ bcmcmd version
version
Broadcom Command Monitor: Copyright (c) 1998-2021 Broadcom
Release: sdk-6.5.23 built 20211020 (Wed Oct 20 06:52:58 2021)
From root@fedbbfdbee81:/__w/2/s/output/x86-xgsall-deb/hsdk
Platform: X86
OS: Unix (Posix)
Chips:
BCM56640_A0,
BCM56850_A0,
BCM56340_A0,
BCM56960_A0, BCM56860_A0,

   BCM56970_A0, BCM56870_A0,
   BCM56980_A0, BCM56980_B0,
  
   BCM56370_A0, BCM56275_A0, BCM56770_A0,
Chips:
BCM56780_A0, BCM56782_A0, BCM56784_A0, BCM56785_A0,
BCM56786_A0, BCM56787_A0, BCM56788_A0, BCM56789_A0,
BCM56880_A0, BCM56880_B0, BCM56881_A0, BCM56881_B0,
BCM56883_A0, BCM56883_B0, BCM56990_A0, BCM56990_B0,
BCM56991_B0, BCM56992_B0, BCM56996_A0, BCM56996_B0,
BCM56997_A0, BCM56997_B0

Variant drivers:
BCM56780_A0_CNA_1_2_10, BCM56780_A0_DNA_2_7_6_0, BCM56880_A0_CNA_1_2_9, BCM56880_A0_DNA_4_9_5_0
PHYs: BCM5400, BCM54182, BCM54185, BCM54180,
BCM54140, BCM54192, BCM54195, BCM54190,
BCM54194, BCM54210, BCM54220, BCM54280,
BCM54282, BCM54240, BCM54285, BCM5428X,
BCM54290, BCM54292, BCM54294, BCM54295,
BCM54296, BCM56160-GPHY, BCM53540-GPHY, BCM56275-GPHY,
BCM8750, BCM8752, BCM8754, BCM84740,
BCM84164, BCM84758, BCM84780, BCM84784,
BCM84318, BCM84328, Sesto, BCM82780,
copper sfp

drivshell>
2021-10-28 00:12:32 -07:00

426 lines
10 KiB
C

/*! \file ngknet_callback.h
*
* Data structure definitions for NGKNET callbacks.
*
*/
/*
* $Copyright: Copyright 2018-2021 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;
};
#define NGKNET_SKB_CB(_skb) ((struct ngknet_callback_desc *)_skb->cb)
/*! TX/RX callback init */
typedef void
(*ngknet_dev_init_cb_f)(const struct ngknet_dev *dev);
/*! 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);
/*! Handle Filter callback */
typedef struct sk_buff *
(*ngknet_filter_cb_f)(struct sk_buff *skb, ngknet_filter_t **filt);
/*! 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 TX/RX callback initialization. */
ngknet_dev_init_cb_f dev_init_cb;
/*! Handle Rx packet */
ngknet_rx_cb_f rx_cb;
/*! Handle Tx packet */
ngknet_tx_cb_f tx_cb;
/*! Handle filter callback */
ngknet_filter_cb_f filter_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 TX/RX callback device initialization callback function.
*
* The device initialization callback allows an external module to
* perform device-specific initialization in preparation for Tx and Rx
* packet processing.
*
* \param [in] dev_init_cb TX/RX callback device initialization callback
* function.
*
* \retval SHR_E_NONE No errors.
*/
extern int
ngknet_dev_init_cb_register(ngknet_dev_init_cb_f dev_init_cb);
/*!
* \brief Unegister TX/RX callback device initialization callback function.
*
* The device initialization callback allows an external module to
* perform device-specific initialization in preparation for Tx and Rx
* packet processing.
*
* \param [in] dev_init_cb TX/RX callback device initialization callback
* function.
*
* \retval SHR_E_NONE No errors.
*/
extern int
ngknet_dev_init_cb_unregister(ngknet_dev_init_cb_f dev_init_cb);
/*!
* \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 filter callback.
*
* \param [in] filter_cb Filter callback function.
*
* \retval SHR_E_NONE No errors.
*/
extern int
ngknet_filter_cb_register(ngknet_filter_cb_f filter_cb);
/*!
* \brief Unregister filter callback.
*
* \param [in] filter_cb Filter callback function.
*
* \retval SHR_E_NONE No errors.
*/
extern int
ngknet_filter_cb_unregister(ngknet_filter_cb_f filter_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 */