Mellanox SwitchX SDK API Guide  4.3.2104
sx_api_policer.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014-2019. Mellanox Technologies, Ltd. ALL RIGHTS RESERVED.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may
5  * not use this file except in compliance with the License. You may obtain
6  * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
7  *
8  * THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR
9  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
10  * LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS
11  * FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
12  *
13  * See the Apache Version 2.0 License for specific language governing
14  * permissions and limitations under the License.
15  *
16  */
17 
18 #ifndef __SX_API_POLICER_H__
19 #define __SX_API_POLICER_H__
20 
21 #include <sx/sdk/sx_api.h>
22 #include <sx/sdk/sx_strings.h>
23 
24 
25 /************************************************
26  * API functions
27  ***********************************************/
28 
42 sx_status_t sx_api_policer_log_verbosity_level_set(const sx_api_handle_t handle,
43  const sx_log_verbosity_target_t verbosity_target,
44  const sx_verbosity_level_t module_verbosity_level,
45  const sx_verbosity_level_t api_verbosity_level);
46 
60 sx_status_t sx_api_policer_log_verbosity_level_get(const sx_api_handle_t handle,
61  const sx_log_verbosity_target_t verbosity_target,
62  sx_verbosity_level_t *module_verbosity_level_p,
63  sx_verbosity_level_t *api_verbosity_level_p);
64 
85 sx_status_t sx_api_policer_set(const sx_api_handle_t handle,
86  const sx_access_cmd_t cmd,
87  const sx_policer_attributes_t *policer_attr_p,
88  sx_policer_id_t *policer_id_p);
89 
102 sx_status_t sx_api_policer_get(const sx_api_handle_t handle,
103  const sx_policer_id_t policer_id,
104  sx_policer_attributes_t *policer_attr_p);
105 
159 sx_status_t sx_api_policer_iter_get(const sx_api_handle_t handle,
160  const sx_access_cmd_t cmd,
161  const sx_policer_id_t policer_id_key,
162  sx_policer_id_filter_t *policer_id_filter_p,
163  sx_policer_id_t *policer_id_list_p,
164  uint32_t *policer_id_cnt_p);
165 
166 
178 sx_status_t sx_api_policer_counters_clear_set(const sx_api_handle_t handle,
179  const sx_policer_id_t policer_id,
180  const sx_policer_counters_clear_t *clear_counters_p);
181 
194 sx_status_t sx_api_policer_counters_get(const sx_api_handle_t handle,
195  const sx_policer_id_t policer_id,
196  sx_policer_counters_t *policer_counters_p);
197 
198 #endif /* __SX_API_POLICER_H__ */
sx_api_policer_set
sx_status_t sx_api_policer_set(const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_policer_attributes_t *policer_attr_p, sx_policer_id_t *policer_id_p)
sx_api_policer_get
sx_status_t sx_api_policer_get(const sx_api_handle_t handle, const sx_policer_id_t policer_id, sx_policer_attributes_t *policer_attr_p)
sx_api_policer_iter_get
sx_status_t sx_api_policer_iter_get(const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_policer_id_t policer_id_key, sx_policer_id_filter_t *policer_id_filter_p, sx_policer_id_t *policer_id_list_p, uint32_t *policer_id_cnt_p)
sx_api_policer_log_verbosity_level_set
sx_status_t sx_api_policer_log_verbosity_level_set(const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, const sx_verbosity_level_t module_verbosity_level, const sx_verbosity_level_t api_verbosity_level)
sx_api_policer_counters_clear_set
sx_status_t sx_api_policer_counters_clear_set(const sx_api_handle_t handle, const sx_policer_id_t policer_id, const sx_policer_counters_clear_t *clear_counters_p)
sx_api_policer_counters_get
sx_status_t sx_api_policer_counters_get(const sx_api_handle_t handle, const sx_policer_id_t policer_id, sx_policer_counters_t *policer_counters_p)
sx_api_policer_log_verbosity_level_get
sx_status_t sx_api_policer_log_verbosity_level_get(const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, sx_verbosity_level_t *module_verbosity_level_p, sx_verbosity_level_t *api_verbosity_level_p)