Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_fdb.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ***********************************************************************
26 *
27 * @filename openapi_fdb.h
28 *
29 * @purpose FDB Configuration
30 *
31 * @component OPEN
32 *
33 * @create 06/02/2015
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_FDB_H_INCLUDED
39 #define OPENAPI_FDB_H_INCLUDED
40 
41 #include <stdbool.h>
42 #include "openapi_common.h"
43 
45 typedef enum
46 {
47  OPEN_IVL_TYPE = 1,
48  OPEN_SVL_TYPE = 2,
49 } OPEN_VL_TYPE_t;
50 
51 typedef enum
52 {
53  OPEN_FDB_ADDR_FLAG_STATIC = 0,
54  OPEN_FDB_ADDR_FLAG_LEARNED = 1,
55  OPEN_FDB_ADDR_FLAG_MANAGEMENT = 2,
56  OPEN_FDB_ADDR_FLAG_GMRP_LEARNED = 3,
57  OPEN_FDB_ADDR_FLAG_SELF = 4,
58  OPEN_FDB_ADDR_FLAG_DOT1X_STATIC = 5,
59  OPEN_FDB_ADDR_FLAG_DOT1AG_STATIC = 6,
60  OPEN_FDB_ADDR_FLAG_L3_MANAGEMENT = 7,
61  OPEN_FDB_ADDR_FLAG_LEARNED_UNCONFIRMED = 8,
64  OPEN_FDB_ADDR_FLAG_FIP_SNOOP_LEARNED = 9,
65  OPEN_FDB_ADDR_FLAG_CAPTIVE_PORTAL_STATIC = 10,
66  OPEN_FDB_ADDR_FLAG_ETH_CFM_STATIC = 11,
67  OPEN_FDB_ADDR_FLAG_Y1731_STATIC = 12
68 } OPEN_FDB_ADDR_FLAG_t;
69 
70 /*****************************************************************/
88 open_error_t openapiFdbEntryNextGet(openapiClientHandle_t *client_handle,
89  open_buffdesc *mac, uint32_t *vlanId,
90  uint32_t *fdbIfNum,
91  OPEN_FDB_ADDR_FLAG_t *entryType);
92 
93 /*****************************************************************/
107 open_error_t openapiFdbIdGet(openapiClientHandle_t *client_handle,
108  uint32_t fdbId);
109 
110 /*****************************************************************/
125 open_error_t openapiFdbAddrAgingTimeoutGet(openapiClientHandle_t *client_handle,
126  uint32_t fdbId, uint32_t *timeOut);
127 
128 /*****************************************************************/
145 open_error_t openapiFdbAddrAgingTimeoutSet(openapiClientHandle_t *client_handle,
146  uint32_t fdbId, uint32_t timeOut);
147 
148 /*****************************************************************/
163 open_error_t openapiFdbMaxTableEntriesGet(openapiClientHandle_t *client_handle,
164  uint32_t *maxEntries);
165 
166 /*****************************************************************/
180 open_error_t openapiActiveAddrEntriesGet(openapiClientHandle_t *client_handle,
181  uint32_t *entriesNum);
182 
183 /*****************************************************************/
197 open_error_t openapiFdbMaxCountGet(openapiClientHandle_t *client_handle,
198  uint32_t *entriesNum);
199 
200 /*****************************************************************/
213 open_error_t openapiMaxCountReset(openapiClientHandle_t *client_handle);
214 
215 /*****************************************************************/
229 open_error_t openapiFdbDynamicEntriesGet(openapiClientHandle_t *client_handle,
230  uint32_t *entries);
231 
232 /*****************************************************************/
246 open_error_t openapiFdbInternalEntriesGet(openapiClientHandle_t *client_handle,
247  uint32_t *entries);
248 
249 /*****************************************************************/
264 open_error_t openapiIsRestrFilterMacGet(openapiClientHandle_t *client_handle,
265  open_buffdesc *macaddr);
266 
267 /*****************************************************************/
285 open_error_t openapiFdbEntryDelete(openapiClientHandle_t *client_handle,
286  open_buffdesc *mac, uint32_t vlanId,
287  uint32_t intIfNum);
288 
289 /*****************************************************************/
303 open_error_t openapiFdbTypeOfVLGet(openapiClientHandle_t *client_handle,
304  OPEN_VL_TYPE_t *type);
305 
306 /*****************************************************************/
321 open_error_t openapiFdbIdNextGet(openapiClientHandle_t *client_handle,
322  uint32_t startFrom, uint32_t *fdbId);
323 
324 /*****************************************************************/
340 open_error_t openapiFdbBadAddsGet(openapiClientHandle_t *client_handle,
341  uint32_t *badAdds);
342 
343 /*****************************************************************/
357 open_error_t openapiFdbMacMaxHwLimitGet(openapiClientHandle_t *client_handle,
358  uint32_t *maxMacHwLimit);
359 
360 /*****************************************************************/
376 open_error_t openapiFdbIntfDynamicEntriesGet(openapiClientHandle_t *client_handle,
377  uint32_t intIfNum, uint32_t *entries);
378 
379 /*****************************************************************/
395 open_error_t openapiFdbVlanDynamicEntriesGet(openapiClientHandle_t *client_handle,
396  uint16_t vlanId, uint32_t *entries);
397 
398 /*****************************************************************/
414 open_error_t openapiFdbIntfInternalEntriesGet(openapiClientHandle_t *client_handle,
415  uint32_t intIfNum, uint32_t *entries);
416 
417 /*****************************************************************/
433 open_error_t openapiFdbVlanInternalEntriesGet(openapiClientHandle_t *client_handle,
434  uint16_t vlanId, uint32_t *entries);
435 
436 /*****************************************************************/
450 open_error_t openapiFdbFlushByPort(openapiClientHandle_t *client_handle,
451  uint32_t intIfNum);
452 
453 /*****************************************************************/
467 open_error_t openapiFdbFlushByVlan(openapiClientHandle_t *client_handle,
468  uint32_t vlanId);
469 
470 /*****************************************************************/
484 open_error_t openapiFdbFlushByMac(openapiClientHandle_t *client_handle,
485  open_buffdesc *mac);
486 
487 /*****************************************************************/
500 open_error_t openapiFdbFlush(openapiClientHandle_t *client_handle);
501 
502 
503 #endif /* OPENAPI_FDB_H_INCLUDED */
504