2 * Copyright (C) 2013 Realtek Semiconductor Corp.
5 * Unless you and Realtek execute a separate written software license
6 * agreement governing use of this software, this software is licensed
7 * to you under the terms of the GNU General Public License version 2,
8 * available at https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
10 * Purpose : RTL8367/RTL8367C switch high-level API
12 * Feature : The file includes Trap module high-layer API defination
16 #ifndef __RTK_API_TRAP_H__
17 #define __RTK_API_TRAP_H__
20 typedef enum rtk_trap_type_e
30 TRAP_PROVIDER_BRIDGE_GROUP_ADDRESS
,
35 TRAP_PROVIDER_BRIDGE_GVRP_ADDRESS
,
77 typedef enum rtk_mcast_type_e
85 typedef enum rtk_trap_mcast_action_e
87 MCAST_ACTION_FORWARD
= 0,
89 MCAST_ACTION_TRAP2CPU
,
90 MCAST_ACTION_ROUTER_PORT
,
91 MCAST_ACTION_DROP_EX_RMA
,
93 } rtk_trap_mcast_action_t
;
95 typedef enum rtk_trap_rma_action_e
97 RMA_ACTION_FORWARD
= 0,
100 RMA_ACTION_FORWARD_EXCLUDE_CPU
,
102 } rtk_trap_rma_action_t
;
104 typedef enum rtk_trap_ucast_action_e
106 UCAST_ACTION_FORWARD_PMASK
= 0,
108 UCAST_ACTION_TRAP2CPU
,
109 UCAST_ACTION_FLOODING
,
111 } rtk_trap_ucast_action_t
;
113 typedef enum rtk_trap_ucast_type_e
119 } rtk_trap_ucast_type_t
;
121 typedef enum rtk_trap_reason_type_e
125 TRAP_REASON_1XUNAUTH
,
126 TRAP_REASON_VLANSTACK
,
127 TRAP_REASON_UNKNOWNMC
,
129 } rtk_trap_reason_type_t
;
133 * rtk_trap_unknownUnicastPktAction_set
135 * Set unknown unicast packet action configuration.
137 * port - ingress port ID for unknown unicast packet
138 * ucast_action - Unknown unicast action.
143 * RT_ERR_FAILED - Failed
144 * RT_ERR_SMI - SMI access error
145 * RT_ERR_NOT_ALLOWED - Invalid action.
146 * RT_ERR_INPUT - Invalid input parameters.
148 * This API can set unknown unicast packet action configuration.
149 * The unknown unicast action is as following:
150 * - UCAST_ACTION_FORWARD_PMASK
151 * - UCAST_ACTION_DROP
152 * - UCAST_ACTION_TRAP2CPU
153 * - UCAST_ACTION_FLOODING
155 rtk_api_ret_t
rtk_trap_unknownUnicastPktAction_set(rtk_port_t port
, rtk_trap_ucast_action_t ucast_action
);
158 * rtk_trap_unknownUnicastPktAction_get
160 * Get unknown unicast packet action configuration.
162 * port - ingress port ID for unknown unicast packet
164 * pUcast_action - Unknown unicast action.
167 * RT_ERR_FAILED - Failed
168 * RT_ERR_SMI - SMI access error
169 * RT_ERR_NOT_ALLOWED - Invalid action.
170 * RT_ERR_INPUT - Invalid input parameters.
171 * RT_ERR_NULL_POINTER - Null pointer
173 * This API can get unknown unicast packet action configuration.
174 * The unknown unicast action is as following:
175 * - UCAST_ACTION_FORWARD_PMASK
176 * - UCAST_ACTION_DROP
177 * - UCAST_ACTION_TRAP2CPU
178 * - UCAST_ACTION_FLOODING
180 rtk_api_ret_t
rtk_trap_unknownUnicastPktAction_get(rtk_port_t port
, rtk_trap_ucast_action_t
*pUcast_action
);
183 * rtk_trap_unknownMacPktAction_set
185 * Set unknown source MAC packet action configuration.
187 * ucast_action - Unknown source MAC action.
192 * RT_ERR_FAILED - Failed
193 * RT_ERR_SMI - SMI access error
194 * RT_ERR_NOT_ALLOWED - Invalid action.
195 * RT_ERR_INPUT - Invalid input parameters.
197 * This API can set unknown unicast packet action configuration.
198 * The unknown unicast action is as following:
199 * - UCAST_ACTION_FORWARD_PMASK
200 * - UCAST_ACTION_DROP
201 * - UCAST_ACTION_TRAP2CPU
203 extern rtk_api_ret_t
rtk_trap_unknownMacPktAction_set(rtk_trap_ucast_action_t ucast_action
);
206 * rtk_trap_unknownMacPktAction_get
208 * Get unknown source MAC packet action configuration.
212 * pUcast_action - Unknown source MAC action.
215 * RT_ERR_FAILED - Failed
216 * RT_ERR_SMI - SMI access error
217 * RT_ERR_NULL_POINTER - Null Pointer.
218 * RT_ERR_INPUT - Invalid input parameters.
222 extern rtk_api_ret_t
rtk_trap_unknownMacPktAction_get(rtk_trap_ucast_action_t
*pUcast_action
);
225 * rtk_trap_unmatchMacPktAction_set
227 * Set unmatch source MAC packet action configuration.
229 * ucast_action - Unknown source MAC action.
234 * RT_ERR_FAILED - Failed
235 * RT_ERR_SMI - SMI access error
236 * RT_ERR_NOT_ALLOWED - Invalid action.
237 * RT_ERR_INPUT - Invalid input parameters.
239 * This API can set unknown unicast packet action configuration.
240 * The unknown unicast action is as following:
241 * - UCAST_ACTION_FORWARD_PMASK
242 * - UCAST_ACTION_DROP
243 * - UCAST_ACTION_TRAP2CPU
245 extern rtk_api_ret_t
rtk_trap_unmatchMacPktAction_set(rtk_trap_ucast_action_t ucast_action
);
248 * rtk_trap_unmatchMacPktAction_get
250 * Get unmatch source MAC packet action configuration.
254 * pUcast_action - Unknown source MAC action.
257 * RT_ERR_FAILED - Failed
258 * RT_ERR_SMI - SMI access error
259 * RT_ERR_NOT_ALLOWED - Invalid action.
260 * RT_ERR_INPUT - Invalid input parameters.
262 * This API can set unknown unicast packet action configuration.
263 * The unknown unicast action is as following:
264 * - UCAST_ACTION_FORWARD_PMASK
265 * - UCAST_ACTION_DROP
266 * - UCAST_ACTION_TRAP2CPU
268 extern rtk_api_ret_t
rtk_trap_unmatchMacPktAction_get(rtk_trap_ucast_action_t
*pUcast_action
);
271 * rtk_trap_unmatchMacMoving_set
273 * Set unmatch source MAC packet moving state.
276 * enable - ENABLED: allow SA moving, DISABLE: don't allow SA moving.
281 * RT_ERR_FAILED - Failed
282 * RT_ERR_SMI - SMI access error
283 * RT_ERR_NOT_ALLOWED - Invalid action.
284 * RT_ERR_INPUT - Invalid input parameters.
287 extern rtk_api_ret_t
rtk_trap_unmatchMacMoving_set(rtk_port_t port
, rtk_enable_t enable
);
290 * rtk_trap_unmatchMacMoving_get
292 * Set unmatch source MAC packet moving state.
296 * pEnable - ENABLED: allow SA moving, DISABLE: don't allow SA moving.
299 * RT_ERR_FAILED - Failed
300 * RT_ERR_SMI - SMI access error
301 * RT_ERR_NOT_ALLOWED - Invalid action.
302 * RT_ERR_INPUT - Invalid input parameters.
305 extern rtk_api_ret_t
rtk_trap_unmatchMacMoving_get(rtk_port_t port
, rtk_enable_t
*pEnable
);
308 * rtk_trap_unknownMcastPktAction_set
310 * Set behavior of unknown multicast
313 * type - unknown multicast packet type.
314 * mcast_action - unknown multicast action.
319 * RT_ERR_FAILED - Failed
320 * RT_ERR_SMI - SMI access error
321 * RT_ERR_PORT_ID - Invalid port number.
322 * RT_ERR_NOT_ALLOWED - Invalid action.
323 * RT_ERR_INPUT - Invalid input parameters.
325 * When receives an unknown multicast packet, switch may trap, drop or flood this packet
326 * (1) The unknown multicast packet type is as following:
330 * (2) The unknown multicast action is as following:
331 * - MCAST_ACTION_FORWARD
332 * - MCAST_ACTION_DROP
333 * - MCAST_ACTION_TRAP2CPU
335 extern rtk_api_ret_t
rtk_trap_unknownMcastPktAction_set(rtk_port_t port
, rtk_mcast_type_t type
, rtk_trap_mcast_action_t mcast_action
);
338 * rtk_trap_unknownMcastPktAction_get
340 * Get behavior of unknown multicast
342 * type - unknown multicast packet type.
344 * pMcast_action - unknown multicast action.
347 * RT_ERR_FAILED - Failed
348 * RT_ERR_SMI - SMI access error
349 * RT_ERR_PORT_ID - Invalid port number.
350 * RT_ERR_NOT_ALLOWED - Invalid operation.
351 * RT_ERR_INPUT - Invalid input parameters.
353 * When receives an unknown multicast packet, switch may trap, drop or flood this packet
354 * (1) The unknown multicast packet type is as following:
358 * (2) The unknown multicast action is as following:
359 * - MCAST_ACTION_FORWARD
360 * - MCAST_ACTION_DROP
361 * - MCAST_ACTION_TRAP2CPU
363 extern rtk_api_ret_t
rtk_trap_unknownMcastPktAction_get(rtk_port_t port
, rtk_mcast_type_t type
, rtk_trap_mcast_action_t
*pMcast_action
);
366 * rtk_trap_lldpEnable_set
370 * enabled - LLDP enable, 0: follow RMA, 1: use LLDP action.
375 * RT_ERR_FAILED - Failed
376 * RT_ERR_SMI - SMI access error
377 * RT_ERR_NOT_ALLOWED - Invalid action.
378 * RT_ERR_INPUT - Invalid input parameters.
381 * - 01:80:c2:00:00:0e ethertype = 0x88CC LLDP
382 * - 01:80:c2:00:00:03 ethertype = 0x88CC
383 * - 01:80:c2:00:00:00 ethertype = 0x88CC
386 extern rtk_api_ret_t
rtk_trap_lldpEnable_set(rtk_enable_t enabled
);
389 * rtk_trap_lldpEnable_get
395 * pEnabled - LLDP enable, 0: follow RMA, 1: use LLDP action.
398 * RT_ERR_FAILED - Failed
399 * RT_ERR_SMI - SMI access error
400 * RT_ERR_INPUT - Invalid input parameters.
402 * LLDP is as following definition.
404 * - 01:80:c2:00:00:0e ethertype = 0x88CC LLDP
405 * - 01:80:c2:00:00:03 ethertype = 0x88CC
406 * - 01:80:c2:00:00:00 ethertype = 0x88CC
408 extern rtk_api_ret_t
rtk_trap_lldpEnable_get(rtk_enable_t
*pEnabled
);
411 * rtk_trap_reasonTrapToCpuPriority_set
413 * Set priority value of a packet that trapped to CPU port according to specific reason.
415 * type - reason that trap to CPU port.
416 * priority - internal priority that is going to be set for specific trap reason.
422 * RT_ERR_NOT_INIT - The module is not initial
423 * RT_ERR_INPUT - Invalid input parameter
425 * Currently the trap reason that supported are listed as follows:
428 * - TRAP_REASON_1XUNAUTH
429 * - TRAP_REASON_VLANSTACK
430 * - TRAP_REASON_UNKNOWNMC
432 extern rtk_api_ret_t
rtk_trap_reasonTrapToCpuPriority_set(rtk_trap_reason_type_t type
, rtk_pri_t priority
);
435 * rtk_trap_reasonTrapToCpuPriority_get
437 * Get priority value of a packet that trapped to CPU port according to specific reason.
439 * type - reason that trap to CPU port.
441 * pPriority - configured internal priority for such reason.
445 * RT_ERR_NOT_INIT - The module is not initial
446 * RT_ERR_INPUT - Invalid input parameter
447 * RT_ERR_NULL_POINTER - NULL pointer
449 * Currently the trap reason that supported are listed as follows:
452 * - TRAP_REASON_1XUNAUTH
453 * - TRAP_REASON_VLANSTACK
454 * - TRAP_REASON_UNKNOWNMC
456 extern rtk_api_ret_t
rtk_trap_reasonTrapToCpuPriority_get(rtk_trap_reason_type_t type
, rtk_pri_t
*pPriority
);
459 * rtk_trap_rmaAction_set
461 * Set Reserved multicast address action configuration.
464 * rma_action - RMA action.
469 * RT_ERR_FAILED - Failed
470 * RT_ERR_SMI - SMI access error
471 * RT_ERR_INPUT - Invalid input parameters.
472 * RT_ERR_ENABLE - Invalid IFG parameter
475 * There are 48 types of Reserved Multicast Address frame for application usage.
476 * (1)They are as following definition.
481 * - TRAP_UNDEF_BRG_04,
482 * - TRAP_UNDEF_BRG_05,
483 * - TRAP_UNDEF_BRG_06,
484 * - TRAP_UNDEF_BRG_07,
485 * - TRAP_PROVIDER_BRIDGE_GROUP_ADDRESS,
486 * - TRAP_UNDEF_BRG_09,
487 * - TRAP_UNDEF_BRG_0A,
488 * - TRAP_UNDEF_BRG_0B,
489 * - TRAP_UNDEF_BRG_0C,
490 * - TRAP_PROVIDER_BRIDGE_GVRP_ADDRESS,
492 * - TRAP_UNDEF_BRG_0F,
493 * - TRAP_BRG_MNGEMENT,
494 * - TRAP_UNDEFINED_11,
495 * - TRAP_UNDEFINED_12,
496 * - TRAP_UNDEFINED_13,
497 * - TRAP_UNDEFINED_14,
498 * - TRAP_UNDEFINED_15,
499 * - TRAP_UNDEFINED_16,
500 * - TRAP_UNDEFINED_17,
501 * - TRAP_UNDEFINED_18,
502 * - TRAP_UNDEFINED_19,
503 * - TRAP_UNDEFINED_1A,
504 * - TRAP_UNDEFINED_1B,
505 * - TRAP_UNDEFINED_1C,
506 * - TRAP_UNDEFINED_1D,
507 * - TRAP_UNDEFINED_1E,
508 * - TRAP_UNDEFINED_1F,
511 * - TRAP_UNDEF_GARP_22,
512 * - TRAP_UNDEF_GARP_23,
513 * - TRAP_UNDEF_GARP_24,
514 * - TRAP_UNDEF_GARP_25,
515 * - TRAP_UNDEF_GARP_26,
516 * - TRAP_UNDEF_GARP_27,
517 * - TRAP_UNDEF_GARP_28,
518 * - TRAP_UNDEF_GARP_29,
519 * - TRAP_UNDEF_GARP_2A,
520 * - TRAP_UNDEF_GARP_2B,
521 * - TRAP_UNDEF_GARP_2C,
522 * - TRAP_UNDEF_GARP_2D,
523 * - TRAP_UNDEF_GARP_2E,
524 * - TRAP_UNDEF_GARP_2F,
528 * (2) The RMA action is as following:
529 * - RMA_ACTION_FORWARD
530 * - RMA_ACTION_TRAP2CPU
532 * - RMA_ACTION_FORWARD_EXCLUDE_CPU
534 extern rtk_api_ret_t
rtk_trap_rmaAction_set(rtk_trap_type_t type
, rtk_trap_rma_action_t rma_action
);
537 * rtk_trap_rmaAction_get
539 * Get Reserved multicast address action configuration.
543 * pRma_action - RMA action.
546 * RT_ERR_FAILED - Failed
547 * RT_ERR_SMI - SMI access error
548 * RT_ERR_INPUT - Invalid input parameters.
550 * There are 48 types of Reserved Multicast Address frame for application usage.
551 * (1)They are as following definition.
556 * - TRAP_UNDEF_BRG_04,
557 * - TRAP_UNDEF_BRG_05,
558 * - TRAP_UNDEF_BRG_06,
559 * - TRAP_UNDEF_BRG_07,
560 * - TRAP_PROVIDER_BRIDGE_GROUP_ADDRESS,
561 * - TRAP_UNDEF_BRG_09,
562 * - TRAP_UNDEF_BRG_0A,
563 * - TRAP_UNDEF_BRG_0B,
564 * - TRAP_UNDEF_BRG_0C,
565 * - TRAP_PROVIDER_BRIDGE_GVRP_ADDRESS,
567 * - TRAP_UNDEF_BRG_0F,
568 * - TRAP_BRG_MNGEMENT,
569 * - TRAP_UNDEFINED_11,
570 * - TRAP_UNDEFINED_12,
571 * - TRAP_UNDEFINED_13,
572 * - TRAP_UNDEFINED_14,
573 * - TRAP_UNDEFINED_15,
574 * - TRAP_UNDEFINED_16,
575 * - TRAP_UNDEFINED_17,
576 * - TRAP_UNDEFINED_18,
577 * - TRAP_UNDEFINED_19,
578 * - TRAP_UNDEFINED_1A,
579 * - TRAP_UNDEFINED_1B,
580 * - TRAP_UNDEFINED_1C,
581 * - TRAP_UNDEFINED_1D,
582 * - TRAP_UNDEFINED_1E,
583 * - TRAP_UNDEFINED_1F,
586 * - TRAP_UNDEF_GARP_22,
587 * - TRAP_UNDEF_GARP_23,
588 * - TRAP_UNDEF_GARP_24,
589 * - TRAP_UNDEF_GARP_25,
590 * - TRAP_UNDEF_GARP_26,
591 * - TRAP_UNDEF_GARP_27,
592 * - TRAP_UNDEF_GARP_28,
593 * - TRAP_UNDEF_GARP_29,
594 * - TRAP_UNDEF_GARP_2A,
595 * - TRAP_UNDEF_GARP_2B,
596 * - TRAP_UNDEF_GARP_2C,
597 * - TRAP_UNDEF_GARP_2D,
598 * - TRAP_UNDEF_GARP_2E,
599 * - TRAP_UNDEF_GARP_2F,
603 * (2) The RMA action is as following:
604 * - RMA_ACTION_FORWARD
605 * - RMA_ACTION_TRAP2CPU
607 * - RMA_ACTION_FORWARD_EXCLUDE_CPU
609 extern rtk_api_ret_t
rtk_trap_rmaAction_get(rtk_trap_type_t type
, rtk_trap_rma_action_t
*pRma_action
);
612 * rtk_trap_rmaKeepFormat_set
614 * Set Reserved multicast address keep format configuration.
617 * enable - enable keep format.
622 * RT_ERR_FAILED - Failed
623 * RT_ERR_SMI - SMI access error
624 * RT_ERR_INPUT - Invalid input parameters.
625 * RT_ERR_ENABLE - Invalid IFG parameter
628 * There are 48 types of Reserved Multicast Address frame for application usage.
629 * They are as following definition.
634 * - TRAP_UNDEF_BRG_04,
635 * - TRAP_UNDEF_BRG_05,
636 * - TRAP_UNDEF_BRG_06,
637 * - TRAP_UNDEF_BRG_07,
638 * - TRAP_PROVIDER_BRIDGE_GROUP_ADDRESS,
639 * - TRAP_UNDEF_BRG_09,
640 * - TRAP_UNDEF_BRG_0A,
641 * - TRAP_UNDEF_BRG_0B,
642 * - TRAP_UNDEF_BRG_0C,
643 * - TRAP_PROVIDER_BRIDGE_GVRP_ADDRESS,
645 * - TRAP_UNDEF_BRG_0F,
646 * - TRAP_BRG_MNGEMENT,
647 * - TRAP_UNDEFINED_11,
648 * - TRAP_UNDEFINED_12,
649 * - TRAP_UNDEFINED_13,
650 * - TRAP_UNDEFINED_14,
651 * - TRAP_UNDEFINED_15,
652 * - TRAP_UNDEFINED_16,
653 * - TRAP_UNDEFINED_17,
654 * - TRAP_UNDEFINED_18,
655 * - TRAP_UNDEFINED_19,
656 * - TRAP_UNDEFINED_1A,
657 * - TRAP_UNDEFINED_1B,
658 * - TRAP_UNDEFINED_1C,
659 * - TRAP_UNDEFINED_1D,
660 * - TRAP_UNDEFINED_1E,
661 * - TRAP_UNDEFINED_1F,
664 * - TRAP_UNDEF_GARP_22,
665 * - TRAP_UNDEF_GARP_23,
666 * - TRAP_UNDEF_GARP_24,
667 * - TRAP_UNDEF_GARP_25,
668 * - TRAP_UNDEF_GARP_26,
669 * - TRAP_UNDEF_GARP_27,
670 * - TRAP_UNDEF_GARP_28,
671 * - TRAP_UNDEF_GARP_29,
672 * - TRAP_UNDEF_GARP_2A,
673 * - TRAP_UNDEF_GARP_2B,
674 * - TRAP_UNDEF_GARP_2C,
675 * - TRAP_UNDEF_GARP_2D,
676 * - TRAP_UNDEF_GARP_2E,
677 * - TRAP_UNDEF_GARP_2F,
682 extern rtk_api_ret_t
rtk_trap_rmaKeepFormat_set(rtk_trap_type_t type
, rtk_enable_t enable
);
685 * rtk_trap_rmaKeepFormat_get
687 * Get Reserved multicast address action configuration.
691 * pEnable - keep format status.
694 * RT_ERR_FAILED - Failed
695 * RT_ERR_SMI - SMI access error
696 * RT_ERR_INPUT - Invalid input parameters.
698 * There are 48 types of Reserved Multicast Address frame for application usage.
699 * They are as following definition.
704 * - TRAP_UNDEF_BRG_04,
705 * - TRAP_UNDEF_BRG_05,
706 * - TRAP_UNDEF_BRG_06,
707 * - TRAP_UNDEF_BRG_07,
708 * - TRAP_PROVIDER_BRIDGE_GROUP_ADDRESS,
709 * - TRAP_UNDEF_BRG_09,
710 * - TRAP_UNDEF_BRG_0A,
711 * - TRAP_UNDEF_BRG_0B,
712 * - TRAP_UNDEF_BRG_0C,
713 * - TRAP_PROVIDER_BRIDGE_GVRP_ADDRESS,
715 * - TRAP_UNDEF_BRG_0F,
716 * - TRAP_BRG_MNGEMENT,
717 * - TRAP_UNDEFINED_11,
718 * - TRAP_UNDEFINED_12,
719 * - TRAP_UNDEFINED_13,
720 * - TRAP_UNDEFINED_14,
721 * - TRAP_UNDEFINED_15,
722 * - TRAP_UNDEFINED_16,
723 * - TRAP_UNDEFINED_17,
724 * - TRAP_UNDEFINED_18,
725 * - TRAP_UNDEFINED_19,
726 * - TRAP_UNDEFINED_1A,
727 * - TRAP_UNDEFINED_1B,
728 * - TRAP_UNDEFINED_1C,
729 * - TRAP_UNDEFINED_1D,
730 * - TRAP_UNDEFINED_1E,
731 * - TRAP_UNDEFINED_1F,
734 * - TRAP_UNDEF_GARP_22,
735 * - TRAP_UNDEF_GARP_23,
736 * - TRAP_UNDEF_GARP_24,
737 * - TRAP_UNDEF_GARP_25,
738 * - TRAP_UNDEF_GARP_26,
739 * - TRAP_UNDEF_GARP_27,
740 * - TRAP_UNDEF_GARP_28,
741 * - TRAP_UNDEF_GARP_29,
742 * - TRAP_UNDEF_GARP_2A,
743 * - TRAP_UNDEF_GARP_2B,
744 * - TRAP_UNDEF_GARP_2C,
745 * - TRAP_UNDEF_GARP_2D,
746 * - TRAP_UNDEF_GARP_2E,
747 * - TRAP_UNDEF_GARP_2F,
752 extern rtk_api_ret_t
rtk_trap_rmaKeepFormat_get(rtk_trap_type_t type
, rtk_enable_t
*pEnable
);
755 #endif /* __RTK_API_TRAP_H__ */