target/linux/mediatek/files-5.10/drivers/net/phy/rtk/rtl8367c/include/trap.h

   1 /*
   2  * Copyright (C) 2013 Realtek Semiconductor Corp.
   3  * All Rights Reserved.
   4  *
   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
   9  *
  10  * Purpose : RTL8367/RTL8367C switch high-level API
  11  *
  12  * Feature : The file includes Trap module high-layer API defination
  13  *
  14  */
  15
  16 #ifndef __RTK_API_TRAP_H__
  17 #define __RTK_API_TRAP_H__
  18
  19
  20 typedef enum rtk_trap_type_e
  21 {
  22     TRAP_BRG_GROUP = 0,
  23     TRAP_FD_PAUSE,
  24     TRAP_SP_MCAST,
  25     TRAP_1X_PAE,
  26     TRAP_UNDEF_BRG_04,
  27     TRAP_UNDEF_BRG_05,
  28     TRAP_UNDEF_BRG_06,
  29     TRAP_UNDEF_BRG_07,
  30     TRAP_PROVIDER_BRIDGE_GROUP_ADDRESS,
  31     TRAP_UNDEF_BRG_09,
  32     TRAP_UNDEF_BRG_0A,
  33     TRAP_UNDEF_BRG_0B,
  34     TRAP_UNDEF_BRG_0C,
  35     TRAP_PROVIDER_BRIDGE_GVRP_ADDRESS,
  36     TRAP_8021AB,
  37     TRAP_UNDEF_BRG_0F,
  38     TRAP_BRG_MNGEMENT,
  39     TRAP_UNDEFINED_11,
  40     TRAP_UNDEFINED_12,
  41     TRAP_UNDEFINED_13,
  42     TRAP_UNDEFINED_14,
  43     TRAP_UNDEFINED_15,
  44     TRAP_UNDEFINED_16,
  45     TRAP_UNDEFINED_17,
  46     TRAP_UNDEFINED_18,
  47     TRAP_UNDEFINED_19,
  48     TRAP_UNDEFINED_1A,
  49     TRAP_UNDEFINED_1B,
  50     TRAP_UNDEFINED_1C,
  51     TRAP_UNDEFINED_1D,
  52     TRAP_UNDEFINED_1E,
  53     TRAP_UNDEFINED_1F,
  54     TRAP_GMRP,
  55     TRAP_GVRP,
  56     TRAP_UNDEF_GARP_22,
  57     TRAP_UNDEF_GARP_23,
  58     TRAP_UNDEF_GARP_24,
  59     TRAP_UNDEF_GARP_25,
  60     TRAP_UNDEF_GARP_26,
  61     TRAP_UNDEF_GARP_27,
  62     TRAP_UNDEF_GARP_28,
  63     TRAP_UNDEF_GARP_29,
  64     TRAP_UNDEF_GARP_2A,
  65     TRAP_UNDEF_GARP_2B,
  66     TRAP_UNDEF_GARP_2C,
  67     TRAP_UNDEF_GARP_2D,
  68     TRAP_UNDEF_GARP_2E,
  69     TRAP_UNDEF_GARP_2F,
  70     TRAP_CDP,
  71     TRAP_CSSTP,
  72     TRAP_LLDP,
  73     TRAP_END,
  74 }rtk_trap_type_t;
  75
  76
  77 typedef enum rtk_mcast_type_e
  78 {
  79     MCAST_L2 = 0,
  80     MCAST_IPV4,
  81     MCAST_IPV6,
  82     MCAST_END
  83 } rtk_mcast_type_t;
  84
  85 typedef enum rtk_trap_mcast_action_e
  86 {
  87     MCAST_ACTION_FORWARD = 0,
  88     MCAST_ACTION_DROP,
  89     MCAST_ACTION_TRAP2CPU,
  90     MCAST_ACTION_ROUTER_PORT,
  91     MCAST_ACTION_DROP_EX_RMA,
  92     MCAST_ACTION_END
  93 } rtk_trap_mcast_action_t;
  94
  95 typedef enum rtk_trap_rma_action_e
  96 {
  97     RMA_ACTION_FORWARD = 0,
  98     RMA_ACTION_TRAP2CPU,
  99     RMA_ACTION_DROP,
 100     RMA_ACTION_FORWARD_EXCLUDE_CPU,
 101     RMA_ACTION_END
 102 } rtk_trap_rma_action_t;
 103
 104 typedef enum rtk_trap_ucast_action_e
 105 {
 106     UCAST_ACTION_FORWARD_PMASK = 0,
 107     UCAST_ACTION_DROP,
 108     UCAST_ACTION_TRAP2CPU,
 109     UCAST_ACTION_FLOODING,
 110     UCAST_ACTION_END
 111 } rtk_trap_ucast_action_t;
 112
 113 typedef enum rtk_trap_ucast_type_e
 114 {
 115     UCAST_UNKNOWNDA = 0,
 116     UCAST_UNKNOWNSA,
 117     UCAST_UNMATCHSA,
 118     UCAST_END
 119 } rtk_trap_ucast_type_t;
 120
 121 typedef enum rtk_trap_reason_type_e
 122 {
 123     TRAP_REASON_RMA = 0,
 124     TRAP_REASON_OAM,
 125     TRAP_REASON_1XUNAUTH,
 126     TRAP_REASON_VLANSTACK,
 127     TRAP_REASON_UNKNOWNMC,
 128     TRAP_REASON_END,
 129 } rtk_trap_reason_type_t;
 130
 131
 132 /* Function Name:
 133  *      rtk_trap_unknownUnicastPktAction_set
 134  * Description:
 135  *      Set unknown unicast packet action configuration.
 136  * Input:
 137  *      port            - ingress port ID for unknown unicast packet
 138  *      ucast_action    - Unknown unicast action.
 139  * Output:
 140  *      None
 141  * Return:
 142  *      RT_ERR_OK                  - OK
 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.
 147  * Note:
 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
 154  */
 155 rtk_api_ret_t rtk_trap_unknownUnicastPktAction_set(rtk_port_t port, rtk_trap_ucast_action_t ucast_action);
 156
 157 /* Function Name:
 158  *      rtk_trap_unknownUnicastPktAction_get
 159  * Description:
 160  *      Get unknown unicast packet action configuration.
 161  * Input:
 162  *      port            - ingress port ID for unknown unicast packet
 163  * Output:
 164  *      pUcast_action   - Unknown unicast action.
 165  * Return:
 166  *      RT_ERR_OK                  - OK
 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
 172  * Note:
 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
 179  */
 180 rtk_api_ret_t rtk_trap_unknownUnicastPktAction_get(rtk_port_t port, rtk_trap_ucast_action_t *pUcast_action);
 181
 182 /* Function Name:
 183  *      rtk_trap_unknownMacPktAction_set
 184  * Description:
 185  *      Set unknown source MAC packet action configuration.
 186  * Input:
 187  *      ucast_action    - Unknown source MAC action.
 188  * Output:
 189  *      None
 190  * Return:
 191  *      RT_ERR_OK                  - OK
 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.
 196  * Note:
 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
 202  */
 203 extern rtk_api_ret_t rtk_trap_unknownMacPktAction_set(rtk_trap_ucast_action_t ucast_action);
 204
 205 /* Function Name:
 206  *      rtk_trap_unknownMacPktAction_get
 207  * Description:
 208  *      Get unknown source MAC packet action configuration.
 209  * Input:
 210  *      None.
 211  * Output:
 212  *      pUcast_action   - Unknown source MAC action.
 213  * Return:
 214  *      RT_ERR_OK                  - OK
 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.
 219  * Note:
 220  *
 221  */
 222 extern rtk_api_ret_t rtk_trap_unknownMacPktAction_get(rtk_trap_ucast_action_t *pUcast_action);
 223
 224 /* Function Name:
 225  *      rtk_trap_unmatchMacPktAction_set
 226  * Description:
 227  *      Set unmatch source MAC packet action configuration.
 228  * Input:
 229  *      ucast_action    - Unknown source MAC action.
 230  * Output:
 231  *      None
 232  * Return:
 233  *      RT_ERR_OK                  - OK
 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.
 238  * Note:
 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
 244  */
 245 extern rtk_api_ret_t rtk_trap_unmatchMacPktAction_set(rtk_trap_ucast_action_t ucast_action);
 246
 247 /* Function Name:
 248  *      rtk_trap_unmatchMacPktAction_get
 249  * Description:
 250  *      Get unmatch source MAC packet action configuration.
 251  * Input:
 252  *      None.
 253  * Output:
 254  *      pUcast_action   - Unknown source MAC action.
 255  * Return:
 256  *      RT_ERR_OK                  - OK
 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.
 261  * Note:
 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
 267  */
 268 extern rtk_api_ret_t rtk_trap_unmatchMacPktAction_get(rtk_trap_ucast_action_t *pUcast_action);
 269
 270 /* Function Name:
 271  *      rtk_trap_unmatchMacMoving_set
 272  * Description:
 273  *      Set unmatch source MAC packet moving state.
 274  * Input:
 275  *      port        - Port ID.
 276  *      enable      - ENABLED: allow SA moving, DISABLE: don't allow SA moving.
 277  * Output:
 278  *      None
 279  * Return:
 280  *      RT_ERR_OK                  - OK
 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.
 285  * Note:
 286  */
 287 extern rtk_api_ret_t rtk_trap_unmatchMacMoving_set(rtk_port_t port, rtk_enable_t enable);
 288
 289 /* Function Name:
 290  *      rtk_trap_unmatchMacMoving_get
 291  * Description:
 292  *      Set unmatch source MAC packet moving state.
 293  * Input:
 294  *      port        - Port ID.
 295  * Output:
 296  *      pEnable     - ENABLED: allow SA moving, DISABLE: don't allow SA moving.
 297  * Return:
 298  *      RT_ERR_OK                  - OK
 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.
 303  * Note:
 304  */
 305 extern rtk_api_ret_t rtk_trap_unmatchMacMoving_get(rtk_port_t port, rtk_enable_t *pEnable);
 306
 307 /* Function Name:
 308  *      rtk_trap_unknownMcastPktAction_set
 309  * Description:
 310  *      Set behavior of unknown multicast
 311  * Input:
 312  *      port            - Port id.
 313  *      type            - unknown multicast packet type.
 314  *      mcast_action    - unknown multicast action.
 315  * Output:
 316  *      None
 317  * Return:
 318  *      RT_ERR_OK           - OK
 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.
 324  * Note:
 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:
 327  *          - MCAST_L2
 328  *          - MCAST_IPV4
 329  *          - MCAST_IPV6
 330  *      (2) The unknown multicast action is as following:
 331  *          - MCAST_ACTION_FORWARD
 332  *          - MCAST_ACTION_DROP
 333  *          - MCAST_ACTION_TRAP2CPU
 334  */
 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);
 336
 337 /* Function Name:
 338  *      rtk_trap_unknownMcastPktAction_get
 339  * Description:
 340  *      Get behavior of unknown multicast
 341  * Input:
 342  *      type - unknown multicast packet type.
 343  * Output:
 344  *      pMcast_action - unknown multicast action.
 345  * Return:
 346  *      RT_ERR_OK               - OK
 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.
 352  * Note:
 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:
 355  *          - MCAST_L2
 356  *          - MCAST_IPV4
 357  *          - MCAST_IPV6
 358  *      (2) The unknown multicast action is as following:
 359  *          - MCAST_ACTION_FORWARD
 360  *          - MCAST_ACTION_DROP
 361  *          - MCAST_ACTION_TRAP2CPU
 362  */
 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);
 364
 365 /* Function Name:
 366  *      rtk_trap_lldpEnable_set
 367  * Description:
 368  *      Set LLDP enable.
 369  * Input:
 370  *      enabled - LLDP enable, 0: follow RMA, 1: use LLDP action.
 371  * Output:
 372  *      None
 373  * Return:
 374  *      RT_ERR_OK               - OK
 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.
 379  * Note:
 380  *      - DMAC                                                 Assignment
 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
 384
 385  */
 386 extern rtk_api_ret_t rtk_trap_lldpEnable_set(rtk_enable_t enabled);
 387
 388 /* Function Name:
 389  *      rtk_trap_lldpEnable_get
 390  * Description:
 391  *      Get LLDP status.
 392  * Input:
 393  *      None
 394  * Output:
 395  *      pEnabled - LLDP enable, 0: follow RMA, 1: use LLDP action.
 396  * Return:
 397  *      RT_ERR_OK           - OK
 398  *      RT_ERR_FAILED       - Failed
 399  *      RT_ERR_SMI          - SMI access error
 400  *      RT_ERR_INPUT        - Invalid input parameters.
 401  * Note:
 402  *      LLDP is as following definition.
 403  *      - DMAC                                                 Assignment
 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
 407  */
 408 extern rtk_api_ret_t rtk_trap_lldpEnable_get(rtk_enable_t *pEnabled);
 409
 410 /* Function Name:
 411  *      rtk_trap_reasonTrapToCpuPriority_set
 412  * Description:
 413  *      Set priority value of a packet that trapped to CPU port according to specific reason.
 414  * Input:
 415  *      type     - reason that trap to CPU port.
 416  *      priority - internal priority that is going to be set for specific trap reason.
 417  * Output:
 418  *      None.
 419  * Return:
 420  *      RT_ERR_OK
 421  *      RT_ERR_FAILED
 422  *      RT_ERR_NOT_INIT - The module is not initial
 423  *      RT_ERR_INPUT    - Invalid input parameter
 424  * Note:
 425  *      Currently the trap reason that supported are listed as follows:
 426  *      - TRAP_REASON_RMA
 427  *      - TRAP_REASON_OAM
 428  *      - TRAP_REASON_1XUNAUTH
 429  *      - TRAP_REASON_VLANSTACK
 430  *      - TRAP_REASON_UNKNOWNMC
 431  */
 432 extern rtk_api_ret_t rtk_trap_reasonTrapToCpuPriority_set(rtk_trap_reason_type_t type, rtk_pri_t priority);
 433
 434 /* Function Name:
 435  *      rtk_trap_reasonTrapToCpuPriority_get
 436  * Description:
 437  *      Get priority value of a packet that trapped to CPU port according to specific reason.
 438  * Input:
 439  *      type      - reason that trap to CPU port.
 440  * Output:
 441  *      pPriority - configured internal priority for such reason.
 442  * Return:
 443  *      RT_ERR_OK
 444  *      RT_ERR_FAILED
 445  *      RT_ERR_NOT_INIT     - The module is not initial
 446  *      RT_ERR_INPUT        - Invalid input parameter
 447  *      RT_ERR_NULL_POINTER - NULL pointer
 448  * Note:
 449  *      Currently the trap reason that supported are listed as follows:
 450  *      - TRAP_REASON_RMA
 451  *      - TRAP_REASON_OAM
 452  *      - TRAP_REASON_1XUNAUTH
 453  *      - TRAP_REASON_VLANSTACK
 454  *      - TRAP_REASON_UNKNOWNMC
 455  */
 456 extern rtk_api_ret_t rtk_trap_reasonTrapToCpuPriority_get(rtk_trap_reason_type_t type, rtk_pri_t *pPriority);
 457
 458 /* Function Name:
 459  *      rtk_trap_rmaAction_set
 460  * Description:
 461  *      Set Reserved multicast address action configuration.
 462  * Input:
 463  *      type    - rma type.
 464  *      rma_action - RMA action.
 465  * Output:
 466  *      None
 467  * Return:
 468  *      RT_ERR_OK           - OK
 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
 473  * Note:
 474  *
 475  *      There are 48 types of Reserved Multicast Address frame for application usage.
 476  *      (1)They are as following definition.
 477  *      - TRAP_BRG_GROUP,
 478  *      - TRAP_FD_PAUSE,
 479  *      - TRAP_SP_MCAST,
 480  *      - TRAP_1X_PAE,
 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,
 491  *      - TRAP_8021AB,
 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,
 509  *      - TRAP_GMRP,
 510  *      - TRAP_GVRP,
 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,
 525  *      - TRAP_CDP.
 526  *      - TRAP_CSSTP.
 527  *      - TRAP_LLDP.
 528  *      (2) The RMA action is as following:
 529  *      - RMA_ACTION_FORWARD
 530  *      - RMA_ACTION_TRAP2CPU
 531  *      - RMA_ACTION_DROP
 532  *      - RMA_ACTION_FORWARD_EXCLUDE_CPU
 533  */
 534 extern rtk_api_ret_t rtk_trap_rmaAction_set(rtk_trap_type_t type, rtk_trap_rma_action_t rma_action);
 535
 536 /* Function Name:
 537  *      rtk_trap_rmaAction_get
 538  * Description:
 539  *      Get Reserved multicast address action configuration.
 540  * Input:
 541  *      type - rma type.
 542  * Output:
 543  *      pRma_action - RMA action.
 544  * Return:
 545  *      RT_ERR_OK           - OK
 546  *      RT_ERR_FAILED       - Failed
 547  *      RT_ERR_SMI          - SMI access error
 548  *      RT_ERR_INPUT        - Invalid input parameters.
 549  * Note:
 550  *      There are 48 types of Reserved Multicast Address frame for application usage.
 551  *      (1)They are as following definition.
 552  *      - TRAP_BRG_GROUP,
 553  *      - TRAP_FD_PAUSE,
 554  *      - TRAP_SP_MCAST,
 555  *      - TRAP_1X_PAE,
 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,
 566  *      - TRAP_8021AB,
 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,
 584  *      - TRAP_GMRP,
 585  *      - TRAP_GVRP,
 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,
 600  *      - TRAP_CDP.
 601  *      - TRAP_CSSTP.
 602  *      - TRAP_LLDP.
 603  *      (2) The RMA action is as following:
 604  *      - RMA_ACTION_FORWARD
 605  *      - RMA_ACTION_TRAP2CPU
 606  *      - RMA_ACTION_DROP
 607  *      - RMA_ACTION_FORWARD_EXCLUDE_CPU
 608  */
 609 extern rtk_api_ret_t rtk_trap_rmaAction_get(rtk_trap_type_t type, rtk_trap_rma_action_t *pRma_action);
 610
 611 /* Function Name:
 612  *      rtk_trap_rmaKeepFormat_set
 613  * Description:
 614  *      Set Reserved multicast address keep format configuration.
 615  * Input:
 616  *      type    - rma type.
 617  *      enable - enable keep format.
 618  * Output:
 619  *      None
 620  * Return:
 621  *      RT_ERR_OK           - OK
 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
 626  * Note:
 627  *
 628  *      There are 48 types of Reserved Multicast Address frame for application usage.
 629  *      They are as following definition.
 630  *      - TRAP_BRG_GROUP,
 631  *      - TRAP_FD_PAUSE,
 632  *      - TRAP_SP_MCAST,
 633  *      - TRAP_1X_PAE,
 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,
 644  *      - TRAP_8021AB,
 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,
 662  *      - TRAP_GMRP,
 663  *      - TRAP_GVRP,
 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,
 678  *      - TRAP_CDP.
 679  *      - TRAP_CSSTP.
 680  *      - TRAP_LLDP.
 681  */
 682 extern rtk_api_ret_t rtk_trap_rmaKeepFormat_set(rtk_trap_type_t type, rtk_enable_t enable);
 683
 684 /* Function Name:
 685  *      rtk_trap_rmaKeepFormat_get
 686  * Description:
 687  *      Get Reserved multicast address action configuration.
 688  * Input:
 689  *      type - rma type.
 690  * Output:
 691  *      pEnable - keep format status.
 692  * Return:
 693  *      RT_ERR_OK           - OK
 694  *      RT_ERR_FAILED       - Failed
 695  *      RT_ERR_SMI          - SMI access error
 696  *      RT_ERR_INPUT        - Invalid input parameters.
 697  * Note:
 698  *      There are 48 types of Reserved Multicast Address frame for application usage.
 699  *      They are as following definition.
 700  *      - TRAP_BRG_GROUP,
 701  *      - TRAP_FD_PAUSE,
 702  *      - TRAP_SP_MCAST,
 703  *      - TRAP_1X_PAE,
 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,
 714  *      - TRAP_8021AB,
 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,
 732  *      - TRAP_GMRP,
 733  *      - TRAP_GVRP,
 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,
 748  *      - TRAP_CDP.
 749  *      - TRAP_CSSTP.
 750  *      - TRAP_LLDP.
 751  */
 752 extern rtk_api_ret_t rtk_trap_rmaKeepFormat_get(rtk_trap_type_t type, rtk_enable_t *pEnable);
 753
 754
 755 #endif /* __RTK_API_TRAP_H__ */
 756
 757