mirror/realtek-doc
1
0
Fork 0
mirror of https://github.com/plappermaul/realtek-doc.git synced 2025-12-10 07:44:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
realtek-doc/sources/rtk-dms1250/include/dal/cypress/dal_cypress_vlan.h
Markus Stockhausen 9efeb307bd rename folders
2025-04-27 16:04:49 -04:00

2053 lines
61 KiB
C
Raw Blame History

/*
* Copyright (C) 2009-2016 Realtek Semiconductor Corp.
* All Rights Reserved.
*
* This program is the proprietary software of Realtek Semiconductor
* Corporation and/or its licensors, and only be used, duplicated,
* modified or distributed under the authorized license from Realtek.
*
* ANY USE OF THE SOFTWARE OTHER THAN AS AUTHORIZED UNDER
* THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
*
* $Revision$
* $Date$
*
* Purpose : Definition those public vlan APIs and its data type in the SDK.
*
* Feature : The file have include the following module and sub-modules
* 1) vlan
*
*/
#ifndef __DAL_CYPRESS_VLAN_H__
#define __DAL_CYPRESS_VLAN_H__
/*
* Include Files
*/
#include <common/rt_type.h>
#include <common/rt_error.h>
#include <rtk/vlan.h>
#include <dal/dal_mapper.h>
/*
* Symbol Definition
*/
/*
* Data Declaration
*/
/*
* Macro Definition
*/
/*
* Function Declaration
*/
/* Module Name : vlan */
/* Function Name:
* dal_cypress_vlanMapper_init
* Description:
* Hook vlan module of the specified device.
* Input:
* unit - unit id
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* Note:
* Must Hook vlan module before calling any vlan APIs.
*/
extern int32
dal_cypress_vlanMapper_init(dal_mapper_t *pMapper);
/* Function Name:
* dal_cypress_vlan_init
* Description:
* Initialize vlan module of the specified device.
* Input:
* unit - unit id
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* Note:
* Must initialize vlan module before calling any vlan APIs.
*/
extern int32
dal_cypress_vlan_init(uint32 unit);
/* Function Name:
* dal_cypress_vlan_create
* Description:
* Create the vlan in the specified device.
* Input:
* unit - unit id
* vid - vlan id to be created
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_EXIST - vlan is exist
* Note:
* 1. Default FID/STG is assigned to CIST after vlan creation and
* FID/STG can be re-assigned later by dal_cypress_vlan_stg_set
* 2. Default lookup mode for L2 unicast and L2/IP multicast is assigned
* to be based on VID
*/
extern int32
dal_cypress_vlan_create(uint32 unit, rtk_vlan_t vid);
/* Function Name:
* dal_cypress_vlan_destroy
* Description:
* Destroy the vlan in the specified device.
* Input:
* unit - unit id
* vid - vlan id to be destroyed
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* Note:
* None
*/
extern int32
dal_cypress_vlan_destroy(uint32 unit, rtk_vlan_t vid);
/* Function Name:
* dal_cypress_vlan_destroyAll
* Description:
* Destroy all vlans except default vlan in the specified device.
* If restore_default_vlan is enable, default vlan will be restored.
* Input:
* unit - unit id
* restore_default_vlan - keep or restore default vlan setting
* 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:
* The restore argument is permit following value:
* - 0: remove default vlan
* - 1: restore default vlan
*/
extern int32
dal_cypress_vlan_destroyAll(uint32 unit, uint32 keep_and_restore_default_vlan);
/* Function Name:
* dal_cypress_vlan_port_add
* Description:
* Add one vlan member to the specified device.
* Input:
* unit - unit id
* vid - vlan id
* port - port id for add
* is_untag - untagged or tagged member
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_VLAN_PORT_MBR_EXIST - member port exist in the specified vlan
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_OUT_OF_RANGE - input parameter out of range
* Note:
* 1. The valid value of is_untag are {0: tagged, 1: untagged}
*/
extern int32
dal_cypress_vlan_port_add(uint32 unit, rtk_vlan_t vid, rtk_port_t port, uint32 is_untag);
/* Function Name:
* dal_cypress_vlan_port_del
* Description:
* Delete one vlan member from the specified device.
* Input:
* unit - unit id
* vid - vlan id
* port - port id for delete
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* Note:
* None
*/
extern int32
dal_cypress_vlan_port_del(uint32 unit, rtk_vlan_t vid, rtk_port_t port);
/* Function Name:
* dal_cypress_vlan_port_get
* Description:
* Get the vlan members from the specified device.
* Input:
* unit - unit id
* vid - vlan id
* Output:
* pMember_portmask - pointer buffer of member ports
* pUntag_portmask - pointer buffer of untagged member ports
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_port_get(
uint32 unit,
rtk_vlan_t vid,
rtk_portmask_t *pMember_portmask,
rtk_portmask_t *pUntag_portmask);
/* Function Name:
* dal_cypress_vlan_port_set
* Description:
* Replace the vlan members in the specified device.
* Input:
* unit - unit id
* vid - vlan id
* pMember_portmask - member ports
* pUntag_portmask - untagged member ports
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* RT_ERR_PORT_MASK - invalid portmask
* Note:
* Replace with new specified VLAN member regardless of original setting
*/
extern int32
dal_cypress_vlan_port_set(
uint32 unit,
rtk_vlan_t vid,
rtk_portmask_t *pMember_portmask,
rtk_portmask_t *pUntag_portmask);
/* Function Name:
* dal_cypress_vlan_stg_get
* Description:
* Get spanning tree group instance of the vlan from the specified device.
* Input:
* unit - unit id
* vid - vlan id
* Output:
* pStg - pointer buffer of spanning tree group instance
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* STG instance also represents FID in RTL8390
*/
extern int32
dal_cypress_vlan_stg_get(uint32 unit, rtk_vlan_t vid, rtk_stg_t *pStg);
/* Function Name:
* dal_cypress_vlan_stg_set
* Description:
* Set spanning tree group instance of the vlan to the specified device.
* Input:
* unit - unit id
* vid - vlan id
* stg - spanning tree group instance
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_MSTI - invalid msti
* Note:
* STG instance also represents FID in RTL8390
*/
extern int32
dal_cypress_vlan_stg_set(uint32 unit, rtk_vlan_t vid, rtk_stg_t stg);
/* Function Name:
* dal_cypress_vlan_l2LookupMode_get
* Description:
* Get L2 lookup mode for L2 traffic.
* Input:
* unit - unit id
* vid - vlan id
* type - dmac type
* Output:
* pMode - lookup mode
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Each VLAN can have its own lookup mode for L2 traffic
*/
extern int32
dal_cypress_vlan_l2LookupMode_get(uint32 unit, rtk_vlan_t vid, rtk_vlan_l2mactype_t type, rtk_vlan_l2LookupMode_t *pMode);
/* Function Name:
* dal_cypress_vlan_l2LookupMode_set
* Description:
* Set L2 lookup mode for L2 traffic.
* Input:
* unit - unit id
* vid - vlan id
* type - dmac type
* mode - lookup mode
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_INPUT - Invalid input parameter
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* Note:
* Each VLAN can have its own lookup mode for L2 unicast traffic
*/
extern int32
dal_cypress_vlan_l2LookupMode_set(uint32 unit, rtk_vlan_t vid, rtk_vlan_l2mactype_t type, rtk_vlan_l2LookupMode_t mode);
/* Function Name:
* dal_cypress_vlan_profileIdx_get
* Description:
* Get VLAN profile index of specified VLAN.
* Input:
* unit - unit id
* vid - vlan id
* Output:
* pIdx - VLAN profile index
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Each VLAN can map to a VLAN profile (0~7)
*/
extern int32
dal_cypress_vlan_profileIdx_get(uint32 unit, rtk_vlan_t vid, uint32 *pIdx);
/* Function Name:
* dal_cypress_vlan_profileIdx_set
* Description:
* Set VLAN profile index of specified VLAN.
* Input:
* unit - unit id
* vid - vlan id
* idx - VLAN profile index
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_OUT_OF_RANGE - input value is out of range
* RT_ERR_VLAN_ENTRY_NOT_FOUND - specified vlan entry not found
* Note:
* Each VLAN can map to a VLAN profile (0~7)
*/
extern int32
dal_cypress_vlan_profileIdx_set(uint32 unit, rtk_vlan_t vid, uint32 idx);
/* Function Name:
* dal_cypress_vlan_profile_get
* Description:
* Get specific VLAN profile.
* Input:
* unit - unit id
* idx - VLAN profile index
* Output:
* pProfile - VLAN profile configuration
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - profile index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Totally 8 profile (0~7) are supported
*/
extern int32
dal_cypress_vlan_profile_get(uint32 unit, uint32 idx, rtk_vlan_profile_t *pProfile);
/* Function Name:
* dal_cypress_vlan_profile_set
* Description:
* Set specific VLAN profile.
* Input:
* unit - unit id
* idx - VLAN profile index
* pProfile - VLAN profile configuration
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - profile index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Totally 8 profile (0~7) are supported
*/
extern int32
dal_cypress_vlan_profile_set(uint32 unit, uint32 idx, rtk_vlan_profile_t *pProfile);
/* Function Name:
* dal_cypress_vlan_portFwdVlan_get
* Description:
* Get forwarding vlan(inner/outer vlan) on specified port.
* Input:
* unit - unit id
* port - port id
* tagType - packet tag type
* Output:
* pVlanType - pointer to inner/outer vlan
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_UNIT_ID - invalid unit id
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
*
*/
extern int32
dal_cypress_vlan_portFwdVlan_get(
uint32 unit,
rtk_port_t port,
rtk_vlan_pktTagMode_t tagMode,
rtk_vlanType_t *pVlanType);
/* Function Name:
* dal_cypress_vlan_portFwdVlan_set
* Description:
* Set forwarding vlan(inner/outer vlan) on specified port.
* Input:
* unit - unit id
* port - port id
* tagType - packet tag type
* vlanType - inner/outer vlan
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_UNIT_ID - invalid unit id
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_PORT_ID - invalid port id
* Note:
*
*/
extern int32
dal_cypress_vlan_portFwdVlan_set(
uint32 unit,
rtk_port_t port,
rtk_vlan_pktTagMode_t tagMode,
rtk_vlanType_t vlanType);
/* Module Name : vlan */
/* Sub-module Name : vlan attribute */
/* Module Name : vlan */
/* Sub-module Name : vlan port attribute */
/* Function Name:
* dal_cypress_vlan_portAcceptFrameType_get
* Description:
* Get vlan accept frame type of the port from the specified device.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pAccept_frame_type - pointer buffer of accept frame type
* 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
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* (1) The accept frame type as following:
* - ACCEPT_FRAME_TYPE_ALL
* - ACCEPT_FRAME_TYPE_TAG_ONLY
* - ACCEPT_FRAME_TYPE_UNTAG_ONLY
* (2) The API is used get accept frame type for 802.1Q or 802.1ad VLAN
*/
extern int32
dal_cypress_vlan_portAcceptFrameType_get(
uint32 unit,
rtk_port_t port,
rtk_vlanType_t type,
rtk_vlan_acceptFrameType_t *pAccept_frame_type);
/* Function Name:
* rtk_vlan_portAcceptFrameType_set
* Description:
* Set vlan accept frame type of the port to the specified device.
* Input:
* unit - unit id
* port - port id
* accept_frame_type - accept frame type
* 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
* RT_ERR_VLAN_ACCEPT_FRAME_TYPE - invalid accept frame type
* Note:
* (1) The accept frame type as following:
* - ACCEPT_FRAME_TYPE_ALL
* - ACCEPT_FRAME_TYPE_TAG_ONLY
* - ACCEPT_FRAME_TYPE_UNTAG_ONLY
* (2) The API is used to set accept frame type for 802.1Q or 802.1ad VLAN
*/
extern int32
dal_cypress_vlan_portAcceptFrameType_set(
uint32 unit,
rtk_port_t port,
rtk_vlanType_t type,
rtk_vlan_acceptFrameType_t accept_frame_type);
/* Function Name:
* dal_cypress_vlan_portIgrFilter_get
* Description:
* Get vlan ingress filter configuration of the port from the specified device.
* Input:
* unit - unit id
* port - port id
* Output:
* pIgr_filter - pointer buffer of ingress filter configuration
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portIgrFilter_get(uint32 unit, rtk_port_t port, rtk_vlan_ifilter_t *pIgr_filter);
/* Function Name:
* dal_cypress_vlan_portIgrFilter_set
* Description:
* Set vlan ingress filter configuration of the port from the specified device.
* Input:
* unit - unit id
* port - port id
* igr_filter - ingress filter configuration
* 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:
* None
*/
extern int32
dal_cypress_vlan_portIgrFilter_set(uint32 unit, rtk_port_t port, rtk_vlan_ifilter_t igr_filter);
/* Function Name:
* dal_cypress_vlan_portEgrFilterEnable_get
* Description:
* Get enable status of egress filtering on specified port.
* Input:
* unit - unit id
* port - port id
* Output:
* pEnable - pointer to enable status of egress filtering
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portEgrFilterEnable_get(uint32 unit, rtk_port_t port, rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_portEgrFilterEnable_set
* Description:
* Set enable status of egress filtering on specified port.
* Input:
* unit - unit id
* port - port id
* enable - enable status of egress filtering
* 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:
* None
*/
extern int32
dal_cypress_vlan_portEgrFilterEnable_set(uint32 unit, rtk_port_t port, rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_mcastLeakyEnable_get
* Description:
* Get vlan egress leaky status of the system from the specified device.
* Input:
* unit - unit id
* Output:
* pLeaky - pointer buffer of vlan leaky of egress
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Enable leaky function to allow L2/IP multicast traffic to across VLAN.
* That is, egress VLAN filtering is bypassed by L2/IP multicast traffic.
*/
extern int32
dal_cypress_vlan_mcastLeakyEnable_get(uint32 unit, rtk_enable_t *pLeaky);
/* Function Name:
* dal_cypress_vlan_mcastLeakyEnable_set
* Description:
* Set vlan egress leaky configure of the system to the specified device.
* Input:
* unit - unit id
* leaky - vlan leaky of egress
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_OUT_OF_RANGE - input value is out of range
* Note:
* Enable leaky function to allow L2/IP multicast traffic to across VLAN.
* That is, egress VLAN filtering is bypassed by L2/IP multicast traffic.
*/
extern int32
dal_cypress_vlan_mcastLeakyEnable_set(uint32 unit, rtk_enable_t leaky);
/* Function Name:
* dal_cypress_vlan_portPvidMode_get
* Description:
* Get the configuration of port-based VLAN mode.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pMode - pointer to port-based VLAN mode configuration
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* Port-based VLAN can apply on different tag format, refer to rtk_vlan_pbVlan_mode_t
*/
extern int32
dal_cypress_vlan_portPvidMode_get(uint32 unit, rtk_port_t port,rtk_vlanType_t type, rtk_vlan_pbVlan_mode_t *pMode);
/* Function Name:
* dal_cypress_vlan_portPvidMode_set
* Description:
* Set the configuration of port-based VLAN mode.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* mode - inner port-based VLAN mode configuration
* 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:
* Port-based VLAN can apply on different tag format, refer to rtk_vlan_pbVlan_mode_t
*/
extern int32
dal_cypress_vlan_portPvidMode_set(uint32 unit, rtk_port_t port, rtk_vlanType_t type, rtk_vlan_pbVlan_mode_t mode);
/* Function Name:
* dal_cypress_vlan_portPvid_get
* Description:
* Get port default vlan id from the specified device.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pPvid - pointer buffer of port default inner vlan id
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portPvid_get(uint32 unit, rtk_port_t port,rtk_vlanType_t type, uint32 *pPvid);
/* Function Name:
* dal_cypress_vlan_portPvid_set
* Description:
* Set port default vlan id to the specified device.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* pvid - port default inner vlan id
* 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_VLAN_VID - invalid vid
* Note:
* None
*/
extern int32
dal_cypress_vlan_portPvid_set(uint32 unit, rtk_port_t port, rtk_vlanType_t type, uint32 pvid);
/* Function Name:
* dal_cypress_vlan_macBasedVlan_get
* Description:
* Get MAC-based vlan.
* Input:
* unit - unit id
* index - entry index
* Output:
* valid - validate or invalidate the entry
* smac - source mac address
* vid - MAC-based VLAN ID
* priority - assign internal priority for untag packet
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_macBasedVlan_get(uint32 unit, uint32 index, uint32 *valid,
rtk_mac_t *smac, rtk_vlan_t *vid, rtk_pri_t *priority);
/* Function Name:
* dal_cypress_vlan_macBasedVlan_set
* Description:
* Set MAC-based vlan.
* Input:
* unit - unit id
* index - entry index
* valid - validate or invalidate the entry
* smac - source mac address
* vid - MAC-based VLAN ID
* priority - assign internal priority for untag packet
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_MAC - invalid mac address
* RT_ERR_VLAN_VID - invalid vlan id
* RT_ERR_PRIORITY - invalid priority value
* Note:
* None
*/
extern int32
dal_cypress_vlan_macBasedVlan_set(uint32 unit, uint32 index, uint32 valid, rtk_mac_t *smac, rtk_vlan_t vid, rtk_pri_t priority);
/* Function Name:
* dal_cypress_vlan_macBasedVlanWithMsk_get
* Description:
* Get MAC-based vlan with source MAC address mask.
* Input:
* unit - unit id
* index - entry index
* Output:
* valid - validate or invalidate the entry
* smac - source mac address
* smsk - source mac address mask
* vid - MAC-based VLAN ID
* priority - assign internal priority for untag packet
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_macBasedVlanWithMsk_get(uint32 unit, uint32 index, uint32 *valid,
rtk_mac_t *smac, rtk_mac_t *smsk, rtk_vlan_t *vid, rtk_pri_t *priority);
/* Function Name:
* dal_cypress_vlan_macBasedVlanWithMsk_set
* Description:
* Set MAC-based vlan with source MAC address mask.
* Input:
* unit - unit id
* index - entry index
* valid - validate or invalidate the entry
* smac - source mac address
* smsk - source mac address mask
* vid - MAC-based VLAN ID
* priority - assign internal priority for untag packet
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_MAC - invalid mac address
* RT_ERR_VLAN_VID - invalid vlan id
* RT_ERR_PRIORITY - invalid priority value
* Note:
* None
*/
extern int32
dal_cypress_vlan_macBasedVlanWithMsk_set(uint32 unit, uint32 index, uint32 valid,
rtk_mac_t *smac, rtk_mac_t *smsk, rtk_vlan_t vid, rtk_pri_t priority);
/* Function Name:
* dal_cypress_vlan_macBasedVlanWithPort_get
* Description:
* Get MAC-based vlan with source port ID mask.
* Input:
* unit - unit id
* index - entry index
* Output:
* valid - validate or invalidate the entry
* smac - source mac address
* smsk - source mac address mask
* port - source port ID
* pmsk - source port ID mask
* vid - MAC-based VLAN ID
* priority - assign internal priority for untag packet
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_macBasedVlanWithPort_get(uint32 unit, uint32 index, uint32 *valid,
rtk_mac_t *smac, rtk_mac_t *smsk,
rtk_port_t *port, rtk_port_t *pmsk, rtk_vlan_t *vid, rtk_pri_t *priority);
/* Function Name:
* dal_cypress_vlan_macBasedVlanWithPort_set
* Description:
* Set MAC-based vlan with source port ID mask.
* Input:
* unit - unit id
* index - entry index
* valid - validate or invalidate the entry
* smac - source mac address
* smsk - source mac address mask
* port - source port ID
* pmsk - source port ID mask
* vid - MAC-based VLAN ID
* priority - assign internal priority for untag packet
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index or port ID bit-mask is out of range
* RT_ERR_MAC - invalid mac address
* RT_ERR_VLAN_VID - invalid vlan id
* RT_ERR_PRIORITY - invalid priority value
* Note:
* None
*/
extern int32
dal_cypress_vlan_macBasedVlanWithPort_set(uint32 unit, uint32 index, uint32 valid,
rtk_mac_t *smac, rtk_mac_t *smsk,
rtk_port_t port, rtk_port_t pmsk, rtk_vlan_t vid, rtk_pri_t priority);
/* Function Name:
* dal_cypress_vlan_ipSubnetBasedVlan_get
* Description:
* Get IP-Subnet-based vlan.
* Input:
* unit - unit id
* index - entry index
* Output:
* valid - validate or invalidate the entry
* sip - source IP address
* sip_mask - source IP address mask
* vid - VLAN ID
* priority - assign internal priority for untag packet
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_ipSubnetBasedVlan_get(uint32 unit, uint32 index, uint32 *valid,
ipaddr_t *sip, ipaddr_t *sip_mask, rtk_vlan_t *vid, rtk_pri_t *priority);
/* Function Name:
* dal_cypress_vlan_ipSubnetBasedVlan_set
* Description:
* Set IP-Subnet-based vlan.
* Input:
* unit - unit id
* index - entry index
* valid - validate or invalidate the entry
* sip - source IP address
* sip_mask - source IP address mask
* vid - VLAN ID
* priority - assign internal priority for untag packet
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_MAC - invalid mac address
* RT_ERR_VLAN_VID - invalid vlan id
* RT_ERR_PRIORITY - invalid priority value
* Note:
* None
*/
extern int32
dal_cypress_vlan_ipSubnetBasedVlan_set(uint32 unit, uint32 index, uint32 valid,
ipaddr_t sip, ipaddr_t sip_mask, rtk_vlan_t vid, rtk_pri_t priority);
/* Function Name:
* dal_cypress_vlan_ipSubnetBasedVlanWithPort_get
* Description:
* Get IP-Subnet-based vlan with source port ID mask.
* Input:
* unit - unit id
* index - entry index
* Output:
* valid - validate or invalidate the entry
* sip - source IP address
* sip_mask - source IP address mask
* port - source port ID
* port_mask - source port ID mask
* vid - VLAN ID
* priority - assign internal priority for untag packet
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_ipSubnetBasedVlanWithPort_get(uint32 unit, uint32 index, uint32 *valid,
ipaddr_t *sip, ipaddr_t *sip_mask, rtk_port_t *port, rtk_port_t *port_mask, rtk_vlan_t *vid, rtk_pri_t *priority);
/* Function Name:
* dal_cypress_vlan_ipSubnetBasedVlanWithPort_set
* Description:
* Set IP-Subnet-based vlan with source port ID mask.
* Input:
* unit - unit id
* index - entry index
* valid - validate or invalidate the entry
* sip - source IP address
* sip_mask - source IP address mask
* port - source port ID
* port_mask - source port ID mask
* vid - VLAN ID
* priority - assign internal priority for untag packet
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_OUT_OF_RANGE - index or port ID mask is out of range
* RT_ERR_MAC - invalid mac address
* RT_ERR_VLAN_VID - invalid vlan id
* RT_ERR_PRIORITY - invalid priority value
* Note:
* None
*/
extern int32
dal_cypress_vlan_ipSubnetBasedVlanWithPort_set(uint32 unit, uint32 index, uint32 valid,
ipaddr_t sip, ipaddr_t sip_mask, rtk_port_t port, rtk_port_t port_mask, rtk_vlan_t vid, rtk_pri_t priority);
/* Function Name:
* dal_cypress_vlan_protoGroup_get
* Description:
* Get protocol group for protocol based vlan.
* Input:
* unit - unit id
* protoGroup_idx - protocol group index
* Output:
* pProtoGroup - pointer to protocol group
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - protocol group index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_protoGroup_get(
uint32 unit,
uint32 protoGroup_idx,
rtk_vlan_protoGroup_t *pProtoGroup);
/* Function Name:
* dal_cypress_vlan_protoGroup_set
* Description:
* Set protocol group for protocol based vlan.
* Input:
* unit - unit id
* protoGroup_idx - protocol group index
* protoGroup - protocol group
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - protocol group index is out of range
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_protoGroup_set(
uint32 unit,
uint32 protoGroup_idx,
rtk_vlan_protoGroup_t *pProtoGroup);
/* Function Name:
* dal_cypress_vlan_portProtoVlan_get
* Description:
* Get vlan of specificed protocol group on specified port.
* Input:
* unit - unit id
* port - port id
* protoGroup_idx - protocol group index
* Output:
* pVlan_cfg - pointer to vlan configuration of protocol group
* 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_OUT_OF_RANGE - protocol group index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portProtoVlan_get(
uint32 unit,
rtk_port_t port,
uint32 protoGroup_idx,
rtk_vlan_protoVlanCfg_t *pVlan_cfg);
/* Function Name:
* dal_cypress_vlan_portProtoVlan_set
* Description:
* Set vlan of specificed protocol group on specified port.
* Input:
* unit - unit id
* port - port id
* protoGroup_idx - protocol group index
* pVlan_cfg - vlan configuration of protocol group
* 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_OUT_OF_RANGE - protocol group index is out of range
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portProtoVlan_set(
uint32 unit,
rtk_port_t port,
uint32 protoGroup_idx,
rtk_vlan_protoVlanCfg_t *pVlan_cfg);
/* Function Name:
* dal_cypress_vlan_portIgrVlanTransparentEnable_get
* Description:
* Get enable status of keep tag format at ingress.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pEnable - enable status of keep tag format
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_UNIT_ID - invalid unit id
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_NULL_POINTER - input parameter may be null pointers
* Note:
* Packet will be transmitted with original tag format when following condition are true.
* - Enable keep tag format at ingress
* - Enable keep tag format at egress
*/
extern int32
dal_cypress_vlan_portIgrVlanTransparentEnable_get(
uint32 unit,
rtk_port_t port,
rtk_vlanType_t type,
rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_portIgrVlanTransparentEnable_set
* Description:
* Set enable status of keep tag format at ingress.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* enable - enable
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_UNIT_ID - invalid unit id
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_INPUT - invalid input parameter
* Note:
* Packet will be transmitted with original tag format when following condition are true.
* - Enable keep tag format at ingress
* - Enable keep tag format at egress
*/
extern int32
dal_cypress_vlan_portIgrVlanTransparentEnable_set(
uint32 unit,
rtk_port_t port,
rtk_vlanType_t type,
rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_portEgrVlanTransparentEnable_get
* Description:
* Get enable status of keep tag format at egress.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pEnable - enable status of keep tag format
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_UNIT_ID - invalid unit id
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_NULL_POINTER - input parameter may be null pointers
* Note:
* Packet will be transmitted with original tag format when following condition are true.
* - Enable keep tag format at ingress
* - Enable keep tag format at egress
*/
extern int32
dal_cypress_vlan_portEgrVlanTransparentEnable_get(
uint32 unit,
rtk_port_t port,
rtk_vlanType_t type,
rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_portEgrVlanTransparentEnable_set
* Description:
* Set enable status of keep tag format at egress.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* enable - enable
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_UNIT_ID - invalid unit id
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_INPUT - invalid input parameter
* Note:
* Packet will be transmitted with original tag format when following condition are true.
* - Enable keep tag format at ingress
* - Enable keep tag format at egress
*/
int32
dal_cypress_vlan_portEgrVlanTransparentEnable_set(
uint32 unit,
rtk_port_t port,
rtk_vlanType_t type,
rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_igrVlanCnvtBlkMode_get
* Description:
* Get the operation mode of ingress VLAN conversion table block.
* Input:
* unit - unit id
* blk_idx - block index
* Output:
* pMode - operation mode of ingress VLAN conversion block
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - block index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* 1. Valid block index ranges from 0 to 3.
* 2. Ingress VLAN conversion table block can be used for doing ingress VLAN conversion
* or MAC-basd VLAN or IP-Subnet-based VLAN.
*/
extern int32
dal_cypress_vlan_igrVlanCnvtBlkMode_get(uint32 unit, uint32 blk_idx, rtk_vlan_igrVlanCnvtBlk_mode_t *pMode);
/* Function Name:
* dal_cypress_vlan_igrVlanCnvtBlkMode_set
* Description:
* Get the operation mode of ingress VLAN conversion table block.
* Input:
* unit - unit id
* blk_idx - block index
* mode - operation mode
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - block index is out of range
* RT_ERR_INPUT - invalid input parameter
* Note:
* 1. Valid block index ranges from 0 to 3.
* 2. Ingress VLAN conversion table block can be used for doing ingress VLAN conversion
* or MAC-basd VLAN or IP-Subnet-based VLAN.
*/
extern int32
dal_cypress_vlan_igrVlanCnvtBlkMode_set(uint32 unit, uint32 blk_idx, rtk_vlan_igrVlanCnvtBlk_mode_t mode);
/* Function Name:
* dal_cypress_vlan_igrVlanCnvtEntry_get
* Description:
* Get ingress VLAN conversion (C2SC) entry.
* Input:
* unit - unit id
* index - entry index
* Output:
* pData - configuration of ingress VLAN conversion (C2SC) entry
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - entry index is out of range
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_igrVlanCnvtEntry_get(uint32 unit, uint32 index, rtk_vlan_igrVlanCnvtEntry_t *pData);
/* Function Name:
* dal_cypress_vlan_igrVlanCnvtEntry_set
* Description:
* Set ingress VLAN conversion (C2SC) entry.
* Input:
* unit - unit id
* index - entry index
* Output:
* pData - configuration of ingress VLAN conversion (C2SC) entry
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - entry index is out of range
* RT_ERR_VLAN_C2SC_BLOCK_MODE - try to set/get a entry to an incompatiable block
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_QOS_1P_PRIORITY - Invalid 802.1p priority
* RT_ERR_VLAN_TPID_INDEX - Invalid TPID index
* RT_ERR_INPUT - invalid input parameter
* Note:
* None
*/
extern int32
dal_cypress_vlan_igrVlanCnvtEntry_set(uint32 unit, uint32 index, rtk_vlan_igrVlanCnvtEntry_t *pData);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtDblTagEnable_get
* Description:
* Enable egress VLAN conversion for double(outer+inner) tagged packet.
* Input:
* unit - unit id
* Output:
* pEnable - pointer to enable status
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtDblTagEnable_get(uint32 unit, rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtDblTagEnable_set
* Description:
* Enable egress VLAN conversion for double(outer+inner) tagged packet.
* Input:
* unit - unit id
* enable - enable status
* 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:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtDblTagEnable_set(uint32 unit, rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtVidSource_get
* Description:
* Specify the VID source for doing egress VLAN conversion.
* Input:
* unit - unit id
* Output:
* pSrc - pointer to VID source
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtVidSource_get(uint32 unit, rtk_l2_vlanMode_t *pSrc);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtVidSource_set
* Description:
* Specify the VID source for doing egress VLAN conversion.
* Input:
* unit - unit id
* src - VID source
* 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:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtVidSource_set(uint32 unit, rtk_l2_vlanMode_t src);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtEntry_get
* Description:
* Get egress VLAN conversion (SC2C) entry.
* Input:
* unit - unit id
* index - entry index
* Output:
* pData - configuration of egress VLAN conversion (SC2C) entry
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - entry index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtEntry_get(uint32 unit, uint32 index, rtk_vlan_egrVlanCnvtEntry_t *pData);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtEntry_set
* Description:
* Set egress VLAN conversion (SC2C) entry.
* Input:
* unit - unit id
* index - entry index
* Output:
* pData - configuration of egress VLAN conversion (SC2C) entry
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - entry index is out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* RT_ERR_VLAN_VID - invalid vid
* RT_ERR_PORT_ID - invalid port id
* RT_ERR_QOS_1P_PRIORITY - Invalid 802.1p priority
* RT_ERR_VLAN_TPID_INDEX - Invalid TPID index
* RT_ERR_INPUT - invalid input parameter
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtEntry_set(uint32 unit, uint32 index, rtk_vlan_egrVlanCnvtEntry_t *pData);
/* Function Name:
* dal_cypress_vlan_tpidEntry_get
* Description:
* Get TPID value from global TPID pool.
* Input:
* unit - unit id
* type - vlan tag type
* tpid_idx - index of TPID entry
* Output:
* pTpid - pointer to TPID
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - input parameter out of range
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Global four inner TPID can be specified.
* Global four outer TPID can be specified
* Global one extra TPID can be specified
*/
extern int32
dal_cypress_vlan_tpidEntry_get(uint32 unit, rtk_vlan_tagType_t type, uint32 tpid_idx, uint32 *pTpid);
/* Function Name:
* dal_cypress_vlan_tpidEntry_set
* Description:
* Set TPID value to global TPID pool.
* Input:
* unit - unit id
* type - vlan tag type
* tpid_idx - index of TPID entry
* tpid - TPID
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - input parameter out of range
* Note:
* Global four inner TPID can be specified.
* Global four outer TPID can be specified
* Global one extra TPID can be specified
*/
extern int32
dal_cypress_vlan_tpidEntry_set(uint32 unit, rtk_vlan_tagType_t type, uint32 tpid_idx, uint32 tpid);
/* Function Name:
* dal_cypress_vlan_portIgrTpid_get
* Description:
* Get inner/outer TPIDs comparsion configration on specified port.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pTpid_idx_mask - pointer to mask for index of tpid entry
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* Specify which TPID to compare from TPID pool for parsing a inner/outer-tagged packet.
* The valid mask bits of tpid_idx is bit[3:0].
*/
extern int32
dal_cypress_vlan_portIgrTpid_get(uint32 unit, rtk_port_t port, rtk_vlanType_t type, uint32 *pTpid_idx_mask);
/* Function Name:
* dal_cypress_vlan_portIgrTpid_set
* Description:
* Set inner/outer TPIDs comparsion configration on specified port
* Input:
* unit - unit id
* port - port id
* type - vlan type
* tpid_idx_mask - mask for index of tpid entry
* 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:
* Specify which TPID to compare from TPID pool for parsing a inner/outer-tagged packet.
* The valid mask bits of tpid_idx is bit[3:0].
*/
extern int32
dal_cypress_vlan_portIgrTpid_set(uint32 unit, rtk_port_t port, rtk_vlanType_t type, uint32 tpid_idx_mask);
/* Function Name:
* dal_cypress_vlan_portEgrTpid_get
* Description:
* Get inner/outer TPID for inner/outer tag encapsulation when transmiiting a inner/outer-tagged pacekt.
* Input:
* unit - unit id
* port - port id
* Output:
* pTpid_idx - pointer to index of inner TPID
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portEgrTpid_get(uint32 unit, rtk_port_t port,rtk_vlanType_t type, uint32 *pTpid_idx);
/* Function Name:
* dal_cypress_vlan_portEgrTpid_set
* Description:
* Set inner/outer TPID for inner/outer tag encapsulation when transmiiting a inner/outer-tagged pacekt.
* Input:
* unit - unit id
* port - port id
* tpid_idx - index of inner TPID
* 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_OUT_OF_RANGE - input parameter out of range
* Note:
* None
*/
extern int32
dal_cypress_vlan_portEgrTpid_set(uint32 unit, rtk_port_t port,rtk_vlanType_t type, uint32 tpid_idx);
/* Function Name:
* dal_cypress_vlan_portIgrExtraTagEnable_get
* Description:
* Get enable state of extra tag comparsion.
* Input:
* unit - unit id
* port - port id
* Output:
* rtk_enable_t - pointer to the extra tag comparsion state
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portIgrExtraTagEnable_get(uint32 unit, rtk_port_t port, rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_portIgrExtraTagEnable_set
* Description:
* Enable extra tag comparsion.
* Input:
* unit - unit id
* port - port id
* enable - extra tag comparsion state
* 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:
* None
*/
extern int32
dal_cypress_vlan_portIgrExtraTagEnable_set(uint32 unit, rtk_port_t port, rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_portVlanAggrEnable_get
* Description:
* Enable N:1 VLAN aggregation support on egress port.
* Input:
* unit - unit id
* port - port id
* Output:
* pEnable - pointer to enable status
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portVlanAggrEnable_get(uint32 unit, rtk_port_t port, rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_portVlanAggrEnable_set
* Description:
* Enable N:1 VLAN aggregation support on egress port.
* Input:
* unit - unit id
* port - port id
* enable - enable status
* 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:
* None
*/
extern int32
dal_cypress_vlan_portVlanAggrEnable_set(uint32 unit, rtk_port_t port, rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_portEgrTagSts_get
* Description:
* Get tag status of egress port.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* Output:
* pSts - tag status
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_portEgrTagSts_get(uint32 unit, rtk_port_t port, rtk_vlanType_t type, rtk_vlan_tagSts_t *pSts);
/* Function Name:
* dal_cypress_vlan_portEgrTagSts_set
* Description:
* Set tag status of egress port.
* Input:
* unit - unit id
* port - port id
* type - vlan type
* sts - tag status
* 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:
* None
*/
extern int32
dal_cypress_vlan_portEgrTagSts_set(uint32 unit, rtk_port_t port, rtk_vlanType_t type,rtk_vlan_tagSts_t sts);
/* Function Name:
* dal_cypress_vlan_leakyStpFilter_get
* Description:
* Get leaky STP filter status for multicast leaky is enabled.
* Input:
* unit - unit id
* Output:
* pEnable - pointer to status of leaky STP filter
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_leakyStpFilter_get(uint32 unit, rtk_enable_t *pEnable);
/* Function Name:
* dal_cypress_vlan_leakyStpFilter_set
* Description:
* Set leaky STP filter status for multicast leaky is enabled.
* Input:
* unit - unit id
* enable - status of leaky STP filter
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_OUT_OF_RANGE - input parameter out of range
* Note:
* None
*/
extern int32
dal_cypress_vlan_leakyStpFilter_set(uint32 unit, rtk_enable_t enable);
/* Function Name:
* dal_cypress_vlan_except_get
* Description:
* Get VLAN except action.
* Input:
* unit - unit id
* Output:
* pAction - pointer to action of VLAN except
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* Forwarding action is as following
* - ACTION_DROP
* - ACTION_FORWARD
* - ACTION_TRAP2CPU
*/
extern int32
dal_cypress_vlan_except_get(uint32 unit, rtk_action_t *pAction);
/* Function Name:
* dal_cypress_vlan_except_set
* Description:
* Set VLAN except action.
* Input:
* unit - unit id
* action - action of VLAN except
* 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:
* Forwarding action is as following
* - ACTION_DROP
* - ACTION_FORWARD
* - ACTION_TRAP2CPU
*/
extern int32
dal_cypress_vlan_except_set(uint32 unit, rtk_action_t action);
/* Function Name:
* dal_cypress_vlan_portIgrCnvtDfltAct_get
* Description:
* Set action for packet without hit ingress ACL and C2SC.
* Input:
* unit - unit id
* port - port id for configure
* Output:
* pAction - pointer to VLAN conversion default action
* 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_NULL_POINTER - input parameter may be null pointer
* Note:
* Forwarding action is as following
* - ACTION_DROP
* - ACTION_FORWARD
*/
extern int32
dal_cypress_vlan_portIgrCnvtDfltAct_get(uint32 unit, rtk_port_t port,
rtk_action_t *pAction);
/* Function Name:
* dal_cypress_vlan_portIgrCnvtDfltAct_set
* Description:
* Set action for packet without hit ingress ACL and C2SC.
* Input:
* unit - unit id
* port - port id for configure
* action - VLAN conversion default action
* 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:
* Forwarding action is as following
* - ACTION_DROP
* - ACTION_FORWARD
*/
extern int32
dal_cypress_vlan_portIgrCnvtDfltAct_set(uint32 unit, rtk_port_t port,
rtk_action_t action);
/* Function Name:
* dal_cypress_vlan_igrVlanCnvtEntry_delAll
* Description:
* Delete all ingress VLAN conversion entry.
* Input:
* unit - unit id
* index - entry index
* Output:
* pData - configuration of egress VLAN conversion entry
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* Note:
* None
*/
extern int32
dal_cypress_vlan_igrVlanCnvtEntry_delAll(uint32 unit);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtEntry_delAll
* Description:
* Delete all egress VLAN conversion entry.
* Input:
* unit - unit id
* index - entry index
* Output:
* pData - configuration of egress VLAN conversion entry
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtEntry_delAll(uint32 unit);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtRangeCheckEntry_get
* Description:
* Get the configuration of VID range check for ingress VLAN conversion.
* Input:
* unit - unit id
* setIdx - vlan range check set index
* index - entry index
* Output:
* pData - configuration of VID Range
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_ENTRY_INDEX - invalid entry index
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtRangeCheckEntry_get(
uint32 unit,
uint32 setIdx,
uint32 index,
rtk_vlan_vlanCnvtRangeCheck_vid_t *pData);
/* Function Name:
* dal_cypress_vlan_egrVlanCnvtRangeCheckEntry_set
* Description:
* Set the configuration of VID range check for egress VLAN conversion.
* Input:
* unit - unit id
* setIdx - vlan range check set index
* index - entry index
* pData - configuration of Vid range
* Output:
* None
* Return:
* RT_ERR_OK
* RT_ERR_FAILED
* RT_ERR_NOT_INIT - The module is not initial
* RT_ERR_ENTRY_INDEX - invalid entry index
* RT_ERR_NULL_POINTER - input parameter may be null pointer
* RT_ERR_INPUT - invalid input parameter
* RT_ERR_VLAN_VID - invalid vid
* Note:
* None
*/
extern int32
dal_cypress_vlan_egrVlanCnvtRangeCheckEntry_set(
uint32 unit,
uint32 setIdx,
uint32 index,
rtk_vlan_vlanCnvtRangeCheck_vid_t *pData);
#endif /* __DAL_CYPRESS_VLAN_H__ */
Reference in a new issue View git blame Copy permalink