bst.h (2494B)
1 /* 2 * DO NOT EDIT THIS FILE! 3 * This file is auto-generated. 4 * Edits to this file will be lost when it is regenerated. 5 * 6 * This license is set out in https://raw.githubusercontent.com/Broadcom-Network-Switching-Software/OpenBCM/master/Legal/LICENSE file. 7 * 8 * Copyright 2007-2020 Broadcom Inc. All rights reserved. 9 */ 10 11 #ifndef BCMI_LTSW_BST_H 12 #define BCMI_LTSW_BST_H 13 14 /*! 15 * \brief Initialize the bst module. 16 * 17 * \param [in] unit Unit Number. 18 * 19 * \retval SHR_E_NONE No errors. 20 * \retval !SHR_E_NONE Failure. 21 */ 22 extern int 23 bcmi_ltsw_cosq_bst_init(int unit); 24 25 /*! 26 * \brief Detach the bst module. 27 * 28 * \param [in] unit Unit Number. 29 * 30 * \retval SHR_E_NONE No errors. 31 * \retval !SHR_E_NONE Failure. 32 */ 33 extern int 34 bcmi_ltsw_cosq_bst_detach(int unit); 35 36 /*! 37 * \brief Enable BST tracking. 38 * 39 * \param [in] unit Unit Number. 40 * \param [in] arg BST enable value. 41 * 42 * \retval SHR_E_NONE No errors. 43 * \retval !SHR_E_NONE Failure. 44 */ 45 extern int 46 bcmi_ltsw_cosq_bst_enable_set( 47 int unit, 48 int arg); 49 50 /*! 51 * \brief Get BST enable value. 52 * 53 * \param [in] unit Unit Number. 54 * \param [out] arg BST enable value. 55 * 56 * \retval SHR_E_NONE No errors. 57 * \retval !SHR_E_NONE Failure. 58 */ 59 extern int 60 bcmi_ltsw_cosq_bst_enable_get( 61 int unit, 62 int *arg); 63 64 /*! 65 * \brief Set BST resource usage tracking mode. 66 * 67 * \param [in] unit Unit Number. 68 * \param [in] arg BST resource usage tracking mode value. 69 * 70 * \retval SHR_E_NONE No errors. 71 * \retval !SHR_E_NONE Failure. 72 */ 73 extern int 74 bcmi_ltsw_cosq_bst_tracking_mode_set( 75 int unit, 76 int arg); 77 78 /*! 79 * \brief Get BST resource usage tracking mode. 80 * 81 * \param [in] unit Unit Number. 82 * \param [out] arg BST resource usage tracking mode value. 83 * 84 * \retval SHR_E_NONE No errors. 85 * \retval !SHR_E_NONE Failure. 86 */ 87 extern int 88 bcmi_ltsw_cosq_bst_tracking_mode_get( 89 int unit, 90 int *arg); 91 92 /*! 93 * \brief Set BST resource usage SnapShot mode. 94 * 95 * \param [in] unit Unit Number. 96 * \param [in] arg BST resource usage SnapShot mode value. 97 * 98 * \retval SHR_E_NONE No errors. 99 * \retval !SHR_E_NONE Failure. 100 */ 101 extern int 102 bcmi_ltsw_cosq_bst_snapshot_enable_set( 103 int unit, 104 int arg); 105 106 /*! 107 * \brief Get BST resource usage SnapShot mode. 108 * 109 * \param [in] unit Unit Number. 110 * \param [out] arg BST resource usage SnapShot mode value. 111 * 112 * \retval SHR_E_NONE No errors. 113 * \retval !SHR_E_NONE Failure. 114 */ 115 extern int 116 bcmi_ltsw_cosq_bst_snapshot_enable_get( 117 int unit, 118 int *arg); 119 120 #endif /* BCMI_LTSW_BST_H */