1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
/*
* Copyright (C) 2013 Realtek Semiconductor Corp.
* All Rights Reserved.
*
* Unless you and Realtek execute a separate written software license
* agreement governing use of this software, this software is licensed
* to you under the terms of the GNU General Public License version 2,
* available at https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
*
* Purpose : RTL8367/RTL8367C switch high-level API
*
* Feature : The file includes Storm module high-layer API defination
*
*/
#ifndef __RTK_API_STORM_H__
#define __RTK_API_STORM_H__
#define STORM_UNUC_INDEX 28
#define STORM_UNMC_INDEX 29
#define STORM_MC_INDEX 30
#define STORM_BC_INDEX 31
typedef enum rtk_rate_storm_group_e
{
STORM_GROUP_UNKNOWN_UNICAST = 0,
STORM_GROUP_UNKNOWN_MULTICAST,
STORM_GROUP_MULTICAST,
STORM_GROUP_BROADCAST,
STORM_GROUP_END
} rtk_rate_storm_group_t;
typedef enum rtk_storm_bypass_e
{
BYPASS_BRG_GROUP = 0,
BYPASS_FD_PAUSE,
BYPASS_SP_MCAST,
BYPASS_1X_PAE,
BYPASS_UNDEF_BRG_04,
BYPASS_UNDEF_BRG_05,
BYPASS_UNDEF_BRG_06,
BYPASS_UNDEF_BRG_07,
BYPASS_PROVIDER_BRIDGE_GROUP_ADDRESS,
BYPASS_UNDEF_BRG_09,
BYPASS_UNDEF_BRG_0A,
BYPASS_UNDEF_BRG_0B,
BYPASS_UNDEF_BRG_0C,
BYPASS_PROVIDER_BRIDGE_GVRP_ADDRESS,
BYPASS_8021AB,
BYPASS_UNDEF_BRG_0F,
BYPASS_BRG_MNGEMENT,
BYPASS_UNDEFINED_11,
BYPASS_UNDEFINED_12,
BYPASS_UNDEFINED_13,
BYPASS_UNDEFINED_14,
BYPASS_UNDEFINED_15,
BYPASS_UNDEFINED_16,
BYPASS_UNDEFINED_17,
BYPASS_UNDEFINED_18,
BYPASS_UNDEFINED_19,
BYPASS_UNDEFINED_1A,
BYPASS_UNDEFINED_1B,
BYPASS_UNDEFINED_1C,
BYPASS_UNDEFINED_1D,
BYPASS_UNDEFINED_1E,
BYPASS_UNDEFINED_1F,
BYPASS_GMRP,
BYPASS_GVRP,
BYPASS_UNDEF_GARP_22,
BYPASS_UNDEF_GARP_23,
BYPASS_UNDEF_GARP_24,
BYPASS_UNDEF_GARP_25,
BYPASS_UNDEF_GARP_26,
BYPASS_UNDEF_GARP_27,
BYPASS_UNDEF_GARP_28,
BYPASS_UNDEF_GARP_29,
BYPASS_UNDEF_GARP_2A,
BYPASS_UNDEF_GARP_2B,
BYPASS_UNDEF_GARP_2C,
BYPASS_UNDEF_GARP_2D,
BYPASS_UNDEF_GARP_2E,
BYPASS_UNDEF_GARP_2F,
BYPASS_IGMP,
BYPASS_CDP,
BYPASS_CSSTP,
BYPASS_LLDP,
BYPASS_END,
}rtk_storm_bypass_t;
/* Function Name:
* rtk_rate_stormControlMeterIdx_set
* Description:
* Set the storm control meter index.
* Input:
* port - port id
* storm_type - storm group type
* index - storm control meter index.
* Output:
* None.
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_PORT_ID - Invalid port id
* RT_ERR_FILTER_METER_ID - Invalid meter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlMeterIdx_set(rtk_port_t port, rtk_rate_storm_group_t stormType, rtk_uint32 index);
/* Function Name:
* rtk_rate_stormControlMeterIdx_get
* Description:
* Get the storm control meter index.
* Input:
* port - port id
* storm_type - storm group type
* Output:
* pIndex - storm control meter index.
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_PORT_ID - Invalid port id
* RT_ERR_FILTER_METER_ID - Invalid meter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlMeterIdx_get(rtk_port_t port, rtk_rate_storm_group_t stormType, rtk_uint32 *pIndex);
/* Function Name:
* rtk_rate_stormControlPortEnable_set
* Description:
* Set enable status of storm control on specified port.
* Input:
* port - port id
* stormType - storm group type
* enable - enable status of storm control
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlPortEnable_set(rtk_port_t port, rtk_rate_storm_group_t stormType, rtk_enable_t enable);
/* Function Name:
* rtk_rate_stormControlPortEnable_set
* Description:
* Set enable status of storm control on specified port.
* Input:
* port - port id
* stormType - storm group type
* Output:
* pEnable - enable status of storm control
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlPortEnable_get(rtk_port_t port, rtk_rate_storm_group_t stormType, rtk_enable_t *pEnable);
/* Function Name:
* rtk_storm_bypass_set
* Description:
* Set bypass storm filter control configuration.
* Input:
* type - Bypass storm filter control type.
* enable - Bypass status.
* Output:
* None
* Return:
* RT_ERR_OK - OK
* RT_ERR_FAILED - Failed
* RT_ERR_SMI - SMI access error
* RT_ERR_INPUT - Invalid input parameters.
* RT_ERR_ENABLE - Invalid IFG parameter
* Note:
*
* This API can set per-port bypass stomr filter control frame type including RMA and igmp.
* The bypass frame type is as following:
* - BYPASS_BRG_GROUP,
* - BYPASS_FD_PAUSE,
* - BYPASS_SP_MCAST,
* - BYPASS_1X_PAE,
* - BYPASS_UNDEF_BRG_04,
* - BYPASS_UNDEF_BRG_05,
* - BYPASS_UNDEF_BRG_06,
* - BYPASS_UNDEF_BRG_07,
* - BYPASS_PROVIDER_BRIDGE_GROUP_ADDRESS,
* - BYPASS_UNDEF_BRG_09,
* - BYPASS_UNDEF_BRG_0A,
* - BYPASS_UNDEF_BRG_0B,
* - BYPASS_UNDEF_BRG_0C,
* - BYPASS_PROVIDER_BRIDGE_GVRP_ADDRESS,
* - BYPASS_8021AB,
* - BYPASS_UNDEF_BRG_0F,
* - BYPASS_BRG_MNGEMENT,
* - BYPASS_UNDEFINED_11,
* - BYPASS_UNDEFINED_12,
* - BYPASS_UNDEFINED_13,
* - BYPASS_UNDEFINED_14,
* - BYPASS_UNDEFINED_15,
* - BYPASS_UNDEFINED_16,
* - BYPASS_UNDEFINED_17,
* - BYPASS_UNDEFINED_18,
* - BYPASS_UNDEFINED_19,
* - BYPASS_UNDEFINED_1A,
* - BYPASS_UNDEFINED_1B,
* - BYPASS_UNDEFINED_1C,
* - BYPASS_UNDEFINED_1D,
* - BYPASS_UNDEFINED_1E,
* - BYPASS_UNDEFINED_1F,
* - BYPASS_GMRP,
* - BYPASS_GVRP,
* - BYPASS_UNDEF_GARP_22,
* - BYPASS_UNDEF_GARP_23,
* - BYPASS_UNDEF_GARP_24,
* - BYPASS_UNDEF_GARP_25,
* - BYPASS_UNDEF_GARP_26,
* - BYPASS_UNDEF_GARP_27,
* - BYPASS_UNDEF_GARP_28,
* - BYPASS_UNDEF_GARP_29,
* - BYPASS_UNDEF_GARP_2A,
* - BYPASS_UNDEF_GARP_2B,
* - BYPASS_UNDEF_GARP_2C,
* - BYPASS_UNDEF_GARP_2D,
* - BYPASS_UNDEF_GARP_2E,
* - BYPASS_UNDEF_GARP_2F,
* - BYPASS_IGMP.
*/
extern rtk_api_ret_t rtk_storm_bypass_set(rtk_storm_bypass_t type, rtk_enable_t enable);
/* Function Name:
* rtk_storm_bypass_get
* Description:
* Get bypass storm filter control configuration.
* Input:
* type - Bypass storm filter control type.
* Output:
* pEnable - Bypass status.
* Return:
* RT_ERR_OK - OK
* RT_ERR_FAILED - Failed
* RT_ERR_SMI - SMI access error
* RT_ERR_INPUT - Invalid input parameters.
* Note:
* This API can get per-port bypass stomr filter control frame type including RMA and igmp.
* The bypass frame type is as following:
* - BYPASS_BRG_GROUP,
* - BYPASS_FD_PAUSE,
* - BYPASS_SP_MCAST,
* - BYPASS_1X_PAE,
* - BYPASS_UNDEF_BRG_04,
* - BYPASS_UNDEF_BRG_05,
* - BYPASS_UNDEF_BRG_06,
* - BYPASS_UNDEF_BRG_07,
* - BYPASS_PROVIDER_BRIDGE_GROUP_ADDRESS,
* - BYPASS_UNDEF_BRG_09,
* - BYPASS_UNDEF_BRG_0A,
* - BYPASS_UNDEF_BRG_0B,
* - BYPASS_UNDEF_BRG_0C,
* - BYPASS_PROVIDER_BRIDGE_GVRP_ADDRESS,
* - BYPASS_8021AB,
* - BYPASS_UNDEF_BRG_0F,
* - BYPASS_BRG_MNGEMENT,
* - BYPASS_UNDEFINED_11,
* - BYPASS_UNDEFINED_12,
* - BYPASS_UNDEFINED_13,
* - BYPASS_UNDEFINED_14,
* - BYPASS_UNDEFINED_15,
* - BYPASS_UNDEFINED_16,
* - BYPASS_UNDEFINED_17,
* - BYPASS_UNDEFINED_18,
* - BYPASS_UNDEFINED_19,
* - BYPASS_UNDEFINED_1A,
* - BYPASS_UNDEFINED_1B,
* - BYPASS_UNDEFINED_1C,
* - BYPASS_UNDEFINED_1D,
* - BYPASS_UNDEFINED_1E,
* - BYPASS_UNDEFINED_1F,
* - BYPASS_GMRP,
* - BYPASS_GVRP,
* - BYPASS_UNDEF_GARP_22,
* - BYPASS_UNDEF_GARP_23,
* - BYPASS_UNDEF_GARP_24,
* - BYPASS_UNDEF_GARP_25,
* - BYPASS_UNDEF_GARP_26,
* - BYPASS_UNDEF_GARP_27,
* - BYPASS_UNDEF_GARP_28,
* - BYPASS_UNDEF_GARP_29,
* - BYPASS_UNDEF_GARP_2A,
* - BYPASS_UNDEF_GARP_2B,
* - BYPASS_UNDEF_GARP_2C,
* - BYPASS_UNDEF_GARP_2D,
* - BYPASS_UNDEF_GARP_2E,
* - BYPASS_UNDEF_GARP_2F,
* - BYPASS_IGMP.
*/
extern rtk_api_ret_t rtk_storm_bypass_get(rtk_storm_bypass_t type, rtk_enable_t *pEnable);
/* Function Name:
* rtk_rate_stormControlExtPortmask_set
* Description:
* Set externsion storm control port mask
* Input:
* pPortmask - port mask
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlExtPortmask_set(rtk_portmask_t *pPortmask);
/* Function Name:
* rtk_rate_stormControlExtPortmask_get
* Description:
* Set externsion storm control port mask
* Input:
* None
* Output:
* pPortmask - port mask
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlExtPortmask_get(rtk_portmask_t *pPortmask);
/* Function Name:
* rtk_rate_stormControlExtEnable_set
* Description:
* Set externsion storm control state
* Input:
* stormType - storm group type
* enable - externsion storm control state
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlExtEnable_set(rtk_rate_storm_group_t stormType, rtk_enable_t enable);
/* Function Name:
* rtk_rate_stormControlExtEnable_get
* Description:
* Get externsion storm control state
* Input:
* stormType - storm group type
* Output:
* pEnable - externsion storm control state
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlExtEnable_get(rtk_rate_storm_group_t stormType, rtk_enable_t *pEnable);
/* Function Name:
* rtk_rate_stormControlExtMeterIdx_set
* Description:
* Set externsion storm control meter index
* Input:
* stormType - storm group type
* index - externsion storm control state
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlExtMeterIdx_set(rtk_rate_storm_group_t stormType, rtk_uint32 index);
/* Function Name:
* rtk_rate_stormControlExtMeterIdx_get
* Description:
* Get externsion storm control meter index
* Input:
* stormType - storm group type
* pIndex - externsion storm control state
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* Note:
*
*/
extern rtk_api_ret_t rtk_rate_stormControlExtMeterIdx_get(rtk_rate_storm_group_t stormType, rtk_uint32 *pIndex);
#endif /* __RTK_API_STORM_H__ */
|
