![]() |
![]() |
Functions | |
CSL_IDEF_INLINE void | CSL_CPSW_getCpswVersionInfo (CSL_CPSW_VERSION *pVersionInfo) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isFIFOLoopbackEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableFIFOLoopback (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableFIFOLoopback (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isVlanAwareEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableVlanAware (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableVlanAware (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort0Enabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort0 (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort0 (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort0PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort0PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort0PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort1PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort1PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort1PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort2PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort2PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort2PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_getCpswControlReg (CSL_CPSW_CONTROL *pControlRegInfo) |
CSL_IDEF_INLINE void | CSL_CPSW_setCpswControlReg (CSL_CPSW_CONTROL *pControlRegInfo) |
CSL_IDEF_INLINE void | CSL_CPSW_getEmulationControlReg (Uint32 *pFree, Uint32 *pSoft) |
CSL_IDEF_INLINE void | CSL_CPSW_setEmulationControlReg (Uint32 free, Uint32 soft) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortStatsEnableReg (CSL_CPSW_PORTSTAT *pPortStatsCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortStatsEnableReg (CSL_CPSW_PORTSTAT *pPortStatsCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getPrioTypeReg (CSL_CPSW_PTYPE *pTypeCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setPrioTypeReg (CSL_CPSW_PTYPE *pTypeCfg) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_getShortGapThreshold (void) |
CSL_IDEF_INLINE void | CSL_CPSW_setShortGapThreshold (Uint32 gapThreshVal) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_getTxStartWordsReg (void) |
CSL_IDEF_INLINE void | CSL_CPSW_setTxStartWordsReg (Uint32 startWordsVal) |
CSL_IDEF_INLINE void | CSL_CPSW_getFlowControlReg (CSL_CPSW_FLOWCNTL *pFlowControlCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setFlowControlReg (CSL_CPSW_FLOWCNTL *pFlowControlCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getCppiSourceIdReg (Uint32 *pTxASrcId, Uint32 *pTxBSrcId) |
CSL_IDEF_INLINE void | CSL_CPSW_setCppiSourceIdReg (Uint32 txASrcId, Uint32 txBSrcId) |
CSL_IDEF_INLINE void | CSL_CPSW_getPort0VlanReg (Uint32 *pPortVID, Uint32 *pPortCFI, Uint32 *pPortPRI) |
CSL_IDEF_INLINE void | CSL_CPSW_setPort0VlanReg (Uint32 portVID, Uint32 portCFI, Uint32 portPRI) |
CSL_IDEF_INLINE void | CSL_CPSW_getPort0RxPriMapReg (Uint32 *pPortRxPriMap) |
CSL_IDEF_INLINE void | CSL_CPSW_setPort0RxPriMapReg (Uint32 *pPortRxPriMap) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_getPort0RxMaxLen (void) |
CSL_IDEF_INLINE void | CSL_CPSW_setPort0RxMaxLen (Uint32 rxMaxLen) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortMaxBlocksReg (Uint32 portNum, Uint32 *pRxMaxBlks, Uint32 *pTxMaxBlks) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortMaxBlocksReg (Uint32 portNum, Uint32 rxMaxBlks, Uint32 txMaxBlks) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortBlockCountReg (Uint32 portNum, Uint32 *pRxBlkCnt, Uint32 *pTxBlkCnt) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortVlanReg (Uint32 portNum, Uint32 *pPortVID, Uint32 *pPortCFI, Uint32 *pPortPRI) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortVlanReg (Uint32 portNum, Uint32 portVID, Uint32 portCFI, Uint32 portPRI) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortTxPriMapReg (Uint32 portNum, Uint32 *pPortTxPriMap) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortTxPriMapReg (Uint32 portNum, Uint32 *pPortTxPriMap) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortMACAddress (Uint32 portNum, Uint8 *pMacAddress) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortMACAddress (Uint32 portNum, Uint8 *pMacAddress) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortTimeSyncCntlReg (Uint32 portNum, CSL_CPSW_TSCNTL *pTimeSyncCntlCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortTimeSyncCntlReg (Uint32 portNum, CSL_CPSW_TSCNTL *pTimeSyncCntlCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortTimeSyncSeqIdReg (Uint32 portNum, Uint32 *pTsLtype, Uint32 *pTsSeqIdOffset) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortTimeSyncSeqIdReg (Uint32 portNum, Uint32 tsLtype, Uint32 tsSeqIdOffset) |
CSL_IDEF_INLINE void | CSL_CPSW_getPortTimeSyncVlanLTypeReg (Uint32 portNum, Uint32 *pTsVlanLtype1, Uint32 *pTsVlanLtype2) |
CSL_IDEF_INLINE void | CSL_CPSW_setPortTimeSyncVlanLTypeReg (Uint32 portNum, Uint32 tsVlanLtype1, Uint32 tsVlanLtype2) |
CSL_IDEF_INLINE void | CSL_CPSW_getStats (CSL_CPSW_STATS *pCpswStats) |
CSL_IDEF_INLINE void | CSL_CPSW_getRawStats (CSL_CPSW_STATS *pCpswStats) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleVersionInfo (CSL_CPSW_ALE_VERSION *pVersionInfo) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleRateLimitEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleRateLimit (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleRateLimit (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleMacAuthModeEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleMacAuthMode (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleMacAuthMode (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleVlanAwareEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleVlanAware (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleVlanAware (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleTxRateLimitEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleTxRateLimit (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleTxRateLimit (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleBypassEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleBypass (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleBypass (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleOUIDenyModeEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleOUIDenyMode (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleOUIDenyMode (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleVID0ModeEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleVID0Mode (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleVID0Mode (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleLearnNoVIDEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAleLearnNoVID (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAleLearnNoVID (void) |
CSL_IDEF_INLINE void | CSL_CPSW_startAleAgeOutNow (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleAgeOutDone (void) |
CSL_IDEF_INLINE void | CSL_CPSW_clearAleTable (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isAleEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enableAle (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disableAle (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_getAleControlReg (void) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleControlReg (Uint32 aleCtrlVal) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_getAlePrescaleReg (void) |
CSL_IDEF_INLINE void | CSL_CPSW_setAlePrescaleReg (Uint32 alePrescaleVal) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleUnkownVlanReg (Uint32 *pUnVlanMemList, Uint32 *pUnMcastFloodMask, Uint32 *pUnRegMcastFloodMask, Uint32 *pUnForceUntagEgress) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleUnkownVlanReg (Uint32 unVlanMemList, Uint32 unMcastFloodMask, Uint32 unRegMcastFloodMask, Uint32 unForceUntagEgress) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleTableEntry (Uint32 index, Uint32 *pAleInfoWd0, Uint32 *pAleInfoWd1, Uint32 *pAleInfoWd2) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleTableEntry (Uint32 index, Uint32 aleInfoWd0, Uint32 aleInfoWd1, Uint32 aleInfoWd2) |
CSL_IDEF_INLINE CSL_CPSW_ALE_ENTRYTYPE | CSL_CPSW_getALEEntryType (Uint32 index) |
CSL_IDEF_INLINE CSL_CPSW_ALE_ADDRTYPE | CSL_CPSW_getALEAddressType (Uint32 index) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleMcastAddrEntry (Uint32 index, CSL_CPSW_ALE_MCASTADDR_ENTRY *pMcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleMcastAddrEntry (Uint32 index, CSL_CPSW_ALE_MCASTADDR_ENTRY *pMcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleVlanMcastAddrEntry (Uint32 index, CSL_CPSW_ALE_VLANMCASTADDR_ENTRY *pVlanMcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleVlanMcastAddrEntry (Uint32 index, CSL_CPSW_ALE_VLANMCASTADDR_ENTRY *pVlanMcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleUnicastAddrEntry (Uint32 index, CSL_CPSW_ALE_UNICASTADDR_ENTRY *pUcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleUnicastAddrEntry (Uint32 index, CSL_CPSW_ALE_UNICASTADDR_ENTRY *pUcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleOUIAddrEntry (Uint32 index, CSL_CPSW_ALE_OUIADDR_ENTRY *pOUIAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleOUIAddrEntry (Uint32 index, CSL_CPSW_ALE_OUIADDR_ENTRY *pOUIAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleVlanUnicastAddrEntry (Uint32 index, CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY *pVlanUcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleVlanUnicastAddrEntry (Uint32 index, CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY *pVlanUcastAddrCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_getAleVlanEntry (Uint32 index, CSL_CPSW_ALE_VLAN_ENTRY *pVlanCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_setAleVlanEntry (Uint32 index, CSL_CPSW_ALE_VLAN_ENTRY *pVlanCfg) |
CSL_IDEF_INLINE void | CSL_CPSW_clearAleEntry (Uint32 index) |
CSL_IDEF_INLINE void | CSL_CPSW_getAlePortControlReg (Uint32 portNo, CSL_CPSW_ALE_PORTCONTROL *pPortControlInfo) |
CSL_IDEF_INLINE void | CSL_CPSW_setAlePortControlReg (Uint32 portNo, CSL_CPSW_ALE_PORTCONTROL *pPortControlInfo) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort3PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort3PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort3PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort4PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort4PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort4PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort5PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort5PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort5PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort6PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort6PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort6PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort7PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort7PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort7PassPriTag (void) |
CSL_IDEF_INLINE Uint32 | CSL_CPSW_isPort8PassPriTagEnabled (void) |
CSL_IDEF_INLINE void | CSL_CPSW_enablePort8PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_disablePort8PassPriTag (void) |
CSL_IDEF_INLINE void | CSL_CPSW_getCppiSourceIdReg (Uint32 *pTxSrcId) |
CSL_IDEF_INLINE void | CSL_CPSW_setCppiSourceIdReg (Uint32 *pTxSrcId) |
CSL_IDEF_INLINE void CSL_CPSW_clearAleEntry | ( | Uint32 | index | ) |
============================================================================
CSL_CPSW_clearAleEntry
Description
This function clears the ALE entry corresponding to the index specified
Arguments
index ALE table index. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0=0, CPSW_5GF_ALE_TABLE_WORD1=0, CPSW_5GF_ALE_TABLE_WORD2=0
Example
Uint32 index; index = 0; CSL_CPSW_clearAleEntry (index);
=============================================================================
============================================================================
CSL_CPSW_clearAleEntry
Description
This function clears the ALE entry corresponding to the index specified
Arguments
index ALE table index. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0=0, ALE_TABLE_WORD1=0, ALE_TABLE_WORD2=0
Example
Uint32 index; index = 0; CSL_CPSW_clearAleEntry (index);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_clearAleTable | ( | void | ) |
============================================================================
CSL_CPSW_clearAleTable
Description
This function initiates a full ALE table cleanup. The ALE hardware clears all table entries.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_CLEAR_TABLE=1
Example
CSL_CPSW_clearAleTable ();
=============================================================================
============================================================================
CSL_CPSW_clearAleTable
Description
This function initiates a full ALE table cleanup. The ALE hardware clears all table entries.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_CLEAR_TABLE=1
Example
CSL_CPSW_clearAleTable ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAle | ( | void | ) |
============================================================================
CSL_CPSW_disableAle
Description
This function configures the ALE control register to disable ALE processing.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_ALE=0
Example
CSL_CPSW_disableAle ();
=============================================================================
============================================================================
CSL_CPSW_disableAle
Description
This function configures the ALE control register to disable ALE processing.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE=0
Example
CSL_CPSW_disableAle ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleBypass | ( | void | ) |
============================================================================
CSL_CPSW_disableAleBypass
Description
This function configures the ALE control register to disable Bypass mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ALE_BYPASS=0
Example
CSL_CPSW_disableAleBypass ();
=============================================================================
============================================================================
CSL_CPSW_disableAleBypass
Description
This function configures the ALE control register to disable Bypass mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_BYPASS=0
Example
CSL_CPSW_disableAleBypass ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleLearnNoVID | ( | void | ) |
============================================================================
CSL_CPSW_disableAleLearnNoVID
Description
This function configures the ALE control register to enable VLAN Id learning.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_LEARN_NO_VID=0
Example
CSL_CPSW_disableAleLearnNoVID ();
=============================================================================
============================================================================
CSL_CPSW_disableAleLearnNoVID
Description
This function configures the ALE control register to enable VLAN Id learning.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_LEARN_NO_VID=0
Example
CSL_CPSW_disableAleLearnNoVID ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleMacAuthMode | ( | void | ) |
============================================================================
CSL_CPSW_disableAleMacAuthMode
Description
This function configures the ALE control register to disable MAC authorization mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_AUTH_MODE=0
Example
CSL_CPSW_disableAleMacAuthMode ();
=============================================================================
============================================================================
CSL_CPSW_disableAleMacAuthMode
Description
This function configures the ALE control register to disable MAC authorization mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE_AUTH_MODE=0
Example
CSL_CPSW_disableAleMacAuthMode ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleOUIDenyMode | ( | void | ) |
============================================================================
CSL_CPSW_disableAleOUIDenyMode
Description
This function configures the ALE control register to disable OUI deny mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_OUI_DENY=0
Example
CSL_CPSW_disableAleOUIDenyMode ();
=============================================================================
============================================================================
CSL_CPSW_disableAleOUIDenyMode
Description
This function configures the ALE control register to disable OUI deny mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE_OUI_DENY=0
Example
CSL_CPSW_disableAleOUIDenyMode ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleRateLimit | ( | void | ) |
============================================================================
CSL_CPSW_disableAleRateLimit
Description
This function configures the ALE control register to disable multicast, broadcast rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_RATE_LIMIT=0
Example
CSL_CPSW_disableAleRateLimit ();
=============================================================================
============================================================================
CSL_CPSW_disableAleRateLimit
Description
This function configures the ALE control register to disable multicast, broadcast rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE_RATE_LIMIT=0
Example
CSL_CPSW_disableAleRateLimit ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleTxRateLimit | ( | void | ) |
============================================================================
CSL_CPSW_disableAleTxRateLimit
Description
This function configures the ALE control register to disable Tx rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_RATE_LIMIT_TX=0
Example
CSL_CPSW_disableAleTxRateLimit ();
=============================================================================
============================================================================
CSL_CPSW_disableAleTxRateLimit
Description
This function configures the ALE control register to disable Tx rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_RATE_LIMIT_TX=0
Example
CSL_CPSW_disableAleTxRateLimit ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleVID0Mode | ( | void | ) |
============================================================================
CSL_CPSW_disableAleVID0Mode
Description
This function configures the ALE control register to disable VID0 mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_EN_VID0_MODE=0
Example
CSL_CPSW_disableAleVID0Mode ();
=============================================================================
============================================================================
CSL_CPSW_disableAleVID0Mode
Description
This function configures the ALE control register to disable VID0 mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_EN_VID0_MODE=0
Example
CSL_CPSW_disableAleVID0Mode ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableAleVlanAware | ( | void | ) |
============================================================================
CSL_CPSW_disableAleVlanAware
Description
This function configures the ALE control register to disable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ALE_VLAN_AWARE=0
Example
CSL_CPSW_disableAleVlanAware ();
=============================================================================
============================================================================
CSL_CPSW_disableAleVlanAware
Description
This function configures the ALE control register to disable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_VLAN_AWARE=0
Example
CSL_CPSW_disableAleVlanAware ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableFIFOLoopback | ( | void | ) |
============================================================================
CSL_CPSW_disableFIFOLoopback
Description
This function configures the CPSW control register to disable FIFO loopback mode
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_FIFO_LOOPBACK=0
Example
CSL_CPSW_disableFIFOLoopback ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort0 | ( | void | ) |
============================================================================
CSL_CPSW_disablePort0
Description
This function configures the CPSW control register to disable the Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P0_ENABLE=0
Example
CSL_CPSW_disablePort0 ();
=============================================================================
============================================================================
CSL_CPSW_disablePort0
Description
This function configures the CPSW control register to disable the Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P0_ENABLE=0
Example
CSL_CPSW_disablePort0 ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort0PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort0PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort0PassPriTag ();
=============================================================================
============================================================================
CSL_CPSW_disablePort0PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort0PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort1PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort1PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 1.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort1PassPriTag ();
=============================================================================
============================================================================
CSL_CPSW_disablePort1PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 1.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort1PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort2PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort2PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 2.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort2PassPriTag ();
=============================================================================
============================================================================
CSL_CPSW_disablePort2PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 2.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort2PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort3PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort3PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 3.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P3_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort3PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort4PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort4PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 4.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P4_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort0PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort5PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort5PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 5.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P5_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort5PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort6PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort6PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 6.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P6_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort6PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort7PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort7PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 7.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P7_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort7PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disablePort8PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_disablePort8PassPriTag
Description
This function configures the CPSW control register to disable the Ingress priority tagging on Port 8.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P8_PASS_PRI_TAGGED=0
Example
CSL_CPSW_disablePort8PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_disableVlanAware | ( | void | ) |
============================================================================
CSL_CPSW_disableVlanAware
Description
This function configures the CPSW control register to disable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_VLAN_AWARE=0
Example
CSL_CPSW_disableVlanAware ();
=============================================================================
============================================================================
CSL_CPSW_disableVlanAware
Description
This function configures the CPSW control register to disable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_VLAN_AWARE=0
Example
CSL_CPSW_disableVlanAware ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAle | ( | void | ) |
============================================================================
CSL_CPSW_enableAle
Description
This function configures the ALE control register to enable ALE processing.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_ALE=1
Example
CSL_CPSW_enableAle ();
=============================================================================
============================================================================
CSL_CPSW_enableAle
Description
This function configures the ALE control register to enable ALE processing.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE=1
Example
CSL_CPSW_enableAle ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleBypass | ( | void | ) |
============================================================================
CSL_CPSW_enableAleBypass
Description
This function configures the ALE control register to enable Bypass mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ALE_BYPASS=1
Example
CSL_CPSW_enableAleBypass ();
=============================================================================
============================================================================
CSL_CPSW_enableAleBypass
Description
This function configures the ALE control register to enable Bypass mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_BYPASS=1
Example
CSL_CPSW_enableAleBypass ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleLearnNoVID | ( | void | ) |
============================================================================
CSL_CPSW_enableAleLearnNoVID
Description
This function configures the ALE control register to enable VLAN Id No Learn, i.e., disable VLAN Id learning.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_LEARN_NO_VID=1
Example
CSL_CPSW_enableAleLearnNoVID ();
=============================================================================
============================================================================
CSL_CPSW_enableAleLearnNoVID
Description
This function configures the ALE control register to enable VLAN Id No Learn, i.e., disable VLAN Id learning.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_LEARN_NO_VID=1
Example
CSL_CPSW_enableAleLearnNoVID ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleMacAuthMode | ( | void | ) |
============================================================================
CSL_CPSW_enableAleMacAuthMode
Description
This function configures the ALE control register to enable MAC authorization mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_AUTH_MODE=1
Example
CSL_CPSW_enableAleMacAuthMode ();
=============================================================================
============================================================================
CSL_CPSW_enableAleMacAuthMode
Description
This function configures the ALE control register to enable MAC authorization mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE_AUTH_MODE=1
Example
CSL_CPSW_enableAleMacAuthMode ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleOUIDenyMode | ( | void | ) |
============================================================================
CSL_CPSW_enableAleOUIDenyMode
Description
This function configures the ALE control register to enable OUI deny mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_OUI_DENY=1
Example
CSL_CPSW_enableAleOUIDenyMode ();
=============================================================================
============================================================================
CSL_CPSW_enableAleOUIDenyMode
Description
This function configures the ALE control register to enable OUI deny mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE_OUI_DENY=1
Example
CSL_CPSW_enableAleOUIDenyMode ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleRateLimit | ( | void | ) |
============================================================================
CSL_CPSW_enableAleRateLimit
Description
This function configures the ALE control register to enable multicast, broadcast rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ENABLE_RATE_LIMIT=1
Example
CSL_CPSW_enableAleRateLimit ();
=============================================================================
============================================================================
CSL_CPSW_enableAleRateLimit
Description
This function configures the ALE control register to enable multicast, broadcast rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_ENABLE_RATE_LIMIT=1
Example
CSL_CPSW_enableAleRateLimit ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleTxRateLimit | ( | void | ) |
============================================================================
CSL_CPSW_enableAleTxRateLimit
Description
This function configures the ALE control register to enable Tx rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_RATE_LIMIT_TX=1
Example
CSL_CPSW_enableAleTxRateLimit ();
=============================================================================
============================================================================
CSL_CPSW_enableAleTxRateLimit
Description
This function configures the ALE control register to enable Tx rate limiting.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_RATE_LIMIT_TX=1
Example
CSL_CPSW_enableAleTxRateLimit ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleVID0Mode | ( | void | ) |
============================================================================
CSL_CPSW_enableAleVID0Mode
Description
This function configures the ALE control register to enable VID0 mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_EN_VID0_MODE=1
Example
CSL_CPSW_enableAleVID0Mode ();
=============================================================================
============================================================================
CSL_CPSW_enableAleVID0Mode
Description
This function configures the ALE control register to enable VID0 mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_EN_VID0_MODE=1
Example
CSL_CPSW_enableAleVID0Mode ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableAleVlanAware | ( | void | ) |
============================================================================
CSL_CPSW_enableAleVlanAware
Description
This function configures the ALE control register to enable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_ALE_VLAN_AWARE=1
Example
CSL_CPSW_enableAleVlanAware ();
=============================================================================
============================================================================
CSL_CPSW_enableAleVlanAware
Description
This function configures the ALE control register to enable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_VLAN_AWARE=1
Example
CSL_CPSW_enableAleVlanAware ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableFIFOLoopback | ( | void | ) |
============================================================================
CSL_CPSW_enableFIFOLoopback
Description
This function configures the CPSW control register to enable FIFO loopback mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_FIFO_LOOPBACK=1
Example
CSL_CPSW_enableFIFOLoopback ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort0 | ( | void | ) |
============================================================================
CSL_CPSW_enablePort0
Description
This function configures the CPSW control register to enable the Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P0_ENABLE=1
Example
CSL_CPSW_enablePort0 ();
=============================================================================
============================================================================
CSL_CPSW_enablePort0
Description
This function configures the CPSW control register to enable the Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P0_ENABLE=1
Example
CSL_CPSW_enablePort0 ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort0PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort0PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort0PassPriTag ();
=============================================================================
============================================================================
CSL_CPSW_enablePort0PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 0.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort0PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort1PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort1PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 1.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort1PassPriTag ();
=============================================================================
============================================================================
CSL_CPSW_enablePort1PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 1.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort1PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort2PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort2PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 2.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort2PassPriTag ();
=============================================================================
============================================================================
CSL_CPSW_enablePort2PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 2.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort2PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort3PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort3PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 3.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P3_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort3PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort4PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort4PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 4.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P4_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort4PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort5PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort5PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 5.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P5_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort5PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort6PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort6PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 6.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P6_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort6PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort7PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort7PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 7.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P7_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort7PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enablePort8PassPriTag | ( | void | ) |
============================================================================
CSL_CPSW_enablePort8PassPriTag
Description
This function configures the CPSW control register to enable the Ingress priority tagging on Port 8.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_P8_PASS_PRI_TAGGED=1
Example
CSL_CPSW_enablePort8PassPriTag ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_enableVlanAware | ( | void | ) |
============================================================================
CSL_CPSW_enableVlanAware
Description
This function configures the CPSW control register to enable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_CPSW_CONTROL_REG_VLAN_AWARE=1
Example
CSL_CPSW_enableVlanAware ();
=============================================================================
============================================================================
CSL_CPSW_enableVlanAware
Description
This function configures the CPSW control register to enable VLAN aware mode.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_CONTROL_REG_VLAN_AWARE=1
Example
CSL_CPSW_enableVlanAware ();
=============================================================================
CSL_IDEF_INLINE CSL_CPSW_ALE_ADDRTYPE CSL_CPSW_getALEAddressType | ( | Uint32 | index | ) |
============================================================================
CSL_CPSW_getALEAddressType
Description
This function returns the address type of an ALE entry.
Arguments
index ALE table index to be read. *
Return Value CSL_CPSW_ALE_ADDRTYPE
ALE_ADDRTYPE_UCAST Address at this entry is unicast
ALE_ADDRTYPE_MCAST Address at this entry is multicast
ALE_ADDRTYPE_OUI Address at this entry is OUI address
Pre Condition
This function must be called only for an ALE address entry, i.e., if CSL_CPSW_getALEEntryType () returns ALE_ENTRYTYPE_ADDRESS or ALE_ENTRYTYPE_VLANADDRESS only.
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0_REG, CPSW_5GF_ALE_TABLE_WORD1_REG
Example
* Uint32 index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Unicast address } } else { // Do nothing } ...
=============================================================================
============================================================================
CSL_CPSW_getALEAddressType
Description
This function returns the address type of an ALE entry.
Arguments
index ALE table index to be read. *
Return Value CSL_CPSW_ALE_ADDRTYPE
ALE_ADDRTYPE_UCAST Address at this entry is unicast
ALE_ADDRTYPE_MCAST Address at this entry is multicast
ALE_ADDRTYPE_OUI Address at this entry is OUI address
Pre Condition
This function must be called only for an ALE address entry, i.e., if CSL_XGE_CPSW_getALEEntryType () returns ALE_ENTRYTYPE_ADDRESS or ALE_ENTRYTYPE_VLANADDRESS only.
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0_REG, ALE_TABLE_WORD1_REG
Example
* Uint32 index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Unicast address } } else { // Do nothing } ...
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_getAleControlReg | ( | void | ) |
============================================================================
CSL_CPSW_getAleControlReg
Description
This function retrieves the contents of the ALE control register.
Arguments
None
Return Value
>=0 ALE control register contents.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG
Example
Uint32 aleCtrlVal; aleCtrlVal = CSL_CPSW_getAleControlReg ();
=============================================================================
============================================================================
CSL_CPSW_getAleControlReg
Description
This function retrieves the contents of the ALE control register.
Arguments
None
Return Value
>=0 ALE control register contents.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG
Example
Uint32 aleCtrlVal; aleCtrlVal = CSL_CPSW_getAleControlReg ();
=============================================================================
CSL_IDEF_INLINE CSL_CPSW_ALE_ENTRYTYPE CSL_CPSW_getALEEntryType | ( | Uint32 | index | ) |
============================================================================
CSL_CPSW_getALEEntryType
Description
This function returns the ALE entry type for any given ALE table entry index.
Arguments
index ALE table index to be read. *
Return Value CSL_CPSW_ALE_ENTRYTYPE
ALE_ENTRYTYPE_FREE ALE entry is free.
ALE_ENTRYTYPE_ADDRESS ALE entry contains a unicast/multicast address.
ALE_ENTRYTYPE_VLAN VLAN ALE entry.
ALE_ENTRYTYPE_VLANADDRESS VLAN Address Entry.
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD1_REG
Example
* Uint32 index = 0; if (CSL_CPSW_getALEEntryType () == ALE_ENTRYTYPE_FREE) { // ALE entry free }
=============================================================================
============================================================================
CSL_CPSW_getALEEntryType
Description
This function returns the ALE entry type for any given ALE table entry index.
Arguments
index ALE table index to be read. *
Return Value CSL_CPSW_ALE_ENTRYTYPE
ALE_ENTRYTYPE_FREE ALE entry is free.
ALE_ENTRYTYPE_ADDRESS ALE entry contains a unicast/multicast address.
ALE_ENTRYTYPE_VLAN ALE entry contains a VLAN.
ALE_ENTRYTYPE_VLANADDRESS ALE entry contains a VLAN and a unicast/multicast address.
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD1_REG
Example
* Uint32 index = 0; if (CSL_CPSW_getALEEntryType () == ALE_ENTRYTYPE_FREE) { // ALE entry free }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleMcastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_MCASTADDR_ENTRY * | pMcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_getAleMcastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with Multicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pMcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_MCASTADDR_ENTRY mcastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_MCAST) { // Read Multicast address config from hardware CSL_CPSW_getAleMcastAddrEntry (index, &mcastAddrCfg); } }
=============================================================================
============================================================================
CSL_CPSW_getAleMcastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with Multicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pMcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_ALE_MCASTADDR_ENTRY mcastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_MCAST) { // Read Multicast address config from hardware CSL_CPSW_getAleMcastAddrEntry (index, &mcastAddrCfg); } }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleOUIAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_OUIADDR_ENTRY * | pOUIAddrCfg | ||
) |
============================================================================
CSL_CPSW_getAleOUIAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with OUI address configuration read from the hardware.
Arguments
index ALE table index to be read. pOUIAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_OUIADDR_ENTRY ouiAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Read Unicast address config from hardware CSL_CPSW_getAleOUIAddrEntry (index, &ouiAddrCfg); } }
=============================================================================
============================================================================
CSL_CPSW_getAleOUIAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with OUI address configuration read from the hardware.
Arguments
index ALE table index to be read. pOUIAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_OUIADDR_ENTRY ouiAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Read Unicast address config from hardware CSL_CPSW_getAleOUIAddrEntry (index, &ouiAddrCfg); } }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAlePortControlReg | ( | Uint32 | portNo, |
CSL_CPSW_ALE_PORTCONTROL * | pPortControlInfo | ||
) |
============================================================================
CSL_CPSW_getAlePortControlReg
Description
This function retrieves the contents of ALE Port control register corresponding to the port number specified.
Arguments
portNo Port number for which the ALE port control register must be read. pPortControlInfo CSL_CPSW_ALE_PORTCONTROL structure that needs to be filled with Port control register info read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_PORT_CONTROL_REG_PORT_STATE, CPSW_5GF_ALE_PORT_CONTROL_REG_DROP_UNTAGGED, CPSW_5GF_ALE_PORT_CONTROL_REG_VID_INGRESS_CHECK, CPSW_5GF_ALE_PORT_CONTROL_REG_NO_LEARN, CPSW_5GF_ALE_PORT_CONTROL_REG_MCAST_LIMIT, CPSW_5GF_ALE_PORT_CONTROL_REG_BCAST_LIMIT
Example
Uint32 index; CSL_CPSW_ALE_PORTCONTROL portControlInfo; index = 0; CSL_CPSW_getAlePortControlReg (index, &portControlInfo);
=============================================================================
============================================================================
CSL_CPSW_getAlePortControlReg
Description
This function retrieves the contents of ALE Port control register corresponding to the port number specified.
Arguments
portNo Port number for which the ALE port control register must be read. pPortControlInfo CSL_CPSW_ALE_PORTCONTROL structure that needs to be filled with Port control register info read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
ALE_PORT_CONTROL_REG_PORT_STATE, ALE_PORT_CONTROL_REG_DROP_UNTAGGED, ALE_PORT_CONTROL_REG_VID_INGRESS_CHECK, ALE_PORT_CONTROL_REG_NO_LEARN, ALE_PORT_CONTROL_REG_MCAST_LIMIT, ALE_PORT_CONTROL_REG_BCAST_LIMIT
Example
Uint32 index; CSL_CPSW_ALE_PORTCONTROL portControlInfo; index = 0; CSL_CPSW_getAlePortControlReg (index, &portControlInfo);
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_getAlePrescaleReg | ( | void | ) |
============================================================================
CSL_CPSW_getAlePrescaleReg
Description
This function retrieves the contents of the ALE Prescale register.
Arguments
None
Return Value
>=0 ALE prescale register contents.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_PRESCALE_REG_ALE_PRESCALE
Example
Uint32 alePrescaleVal; alePrescaleVal = CSL_CPSW_getAlePrescaleReg ();
=============================================================================
============================================================================
CSL_CPSW_getAlePrescaleReg
Description
This function retrieves the contents of the ALE Prescale register.
Arguments
None
Return Value
>=0 ALE prescale register contents.
Pre Condition
None
Post Condition
None
Reads
ALE_PRESCALE_REG_PRESCALE
Example
Uint32 alePrescaleVal; alePrescaleVal = CSL_CPSW_getAlePrescaleReg ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleTableEntry | ( | Uint32 | index, |
Uint32 * | pAleInfoWd0, | ||
Uint32 * | pAleInfoWd1, | ||
Uint32 * | pAleInfoWd2 | ||
) |
============================================================================
CSL_CPSW_getAleTableEntry
Description
This function retrieves an ALE table entry corresponding to the ALE entry index specified in 'index' input parameter. The ALE entry values corresponding to the ALE_TBLW0, ALE_TBLW1 and ALE_TBLW2 registers are returned in 'pAleInfoWd0', 'pAleInfoWd1', 'pAleInfoWd2' output parameters.
Arguments
index ALE table index to be read. pAleInfoWd0 Contents of ALE Table Word 0 Register (ALE_TBLW0). pAleInfoWd1 Contents of ALE Table Word 1 Register (ALE_TBLW1). pAleInfoWd2 Contents of ALE Table Word 2 Register (ALE_TBLW2). *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0_REG_ENTRY_31_0, CPSW_5GF_ALE_TABLE_WORD1_REG_ENTRY_63_32, CPSW_5GF_ALE_TABLE_WORD2_REG_ENTRY_71_64
Example
Uint32 index, info0, info1, info2; index = 0; CSL_CPSW_getAleUnkownVlanReg (index, &info0, &info1, &info2);
=============================================================================
============================================================================
CSL_CPSW_getAleTableEntry
Description
This function retrieves an ALE table entry corresponding to the ALE entry index specified in 'index' input parameter. The ALE entry values corresponding to the ALE_TBLW0, ALE_TBLW1 and ALE_TBLW2 registers are returned in 'pAleInfoWd0', 'pAleInfoWd1', 'pAleInfoWd2' output parameters.
Arguments
index ALE table index to be read. pAleInfoWd0 Contents of ALE Table Word 0 Register (ALE_TBLW0). pAleInfoWd1 Contents of ALE Table Word 1 Register (ALE_TBLW1). pAleInfoWd2 Contents of ALE Table Word 2 Register (ALE_TBLW2). *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0_REG_ENTRY_31_0, ALE_TABLE_WORD1_REG_ENTRY_63_32, ALE_TABLE_WORD2_REG_ENTRY_71_64
Example
Uint32 index, info0, info1, info2; index = 0; CSL_CPSW_getAleUnkownVlanReg (index, &info0, &info1, &info2);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleUnicastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_UNICASTADDR_ENTRY * | pUcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_getAleUnicastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with Unicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pUcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_UNICASTADDR_ENTRY ucastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Read Unicast address config from hardware CSL_CPSW_getAleUnicastAddrEntry (index, &ucastAddrCfg); } }
=============================================================================
============================================================================
CSL_CPSW_getAleUnicastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with Unicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pUcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_UNICASTADDR_ENTRY ucastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_ADDRESS) { // ALE entry has an address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Read Unicast address config from hardware CSL_CPSW_getAleUnicastAddrEntry (index, &ucastAddrCfg); } }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleUnkownVlanReg | ( | Uint32 * | pUnVlanMemList, |
Uint32 * | pUnMcastFloodMask, | ||
Uint32 * | pUnRegMcastFloodMask, | ||
Uint32 * | pUnForceUntagEgress | ||
) |
============================================================================
CSL_CPSW_getAleUnkownVlanReg
Description
This function retrieves the contents of the ALE Unknown VLAN register.
Arguments
pUnVlanMemList Unknown VLAN member list. pUnMcastFloodMask Unknown VLAN Multicast flood mask. pUnRegMcastFloodMask Unknown VLAN Registered Multicast Flood mask. pUnForceUntagEgress Unknown VLAN Force Untagged Egress. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_VLAN_MEMBER_LIST, CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_MCAST_FLOOD_MASK, CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_REG_MCAST_FLOOD_MASK, CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_FORCE_UNTAGGED_EGRESS
Example
Uint32 unVlanMemList, unMcastFloodMask, unRegMcastFloodMask, unForceUntagEgress; CSL_CPSW_getAleUnkownVlanReg (&unVlanMemList, &unMcastFloodMask, &unRegMcastFloodMask, &unForceUntagEgress);
=============================================================================
============================================================================
CSL_CPSW_getAleUnkownVlanReg
Description
This function retrieves the contents of the ALE Unknown VLAN and etc registers.
Arguments
pUnVlanMemList Unknown VLAN member list. pUnMcastFloodMask Unknown VLAN Multicast flood mask. pUnRegMcastFloodMask Unknown VLAN Registered Multicast Flood mask. pUnForceUntagEgress Unknown VLAN Force Untagged Egress. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
ALE_UNKNOWN_VLAN_REG_UNKNOWN_LIST, ALE_UNKNOWN_MCAST_FLOOD_REG_MASK, ALE_UNKNOWN_REG_MCAST_FLOOD_REG_MASK, ALE_FORCE_UNTAGGED_EGRESS_REG_MASK
Example
Uint32 unVlanMemList, unMcastFloodMask, unRegMcastFloodMask, unForceUntagEgress; CSL_CPSW_getAleUnkownVlanReg (&unVlanMemList, &unMcastFloodMask, &unRegMcastFloodMask, &unForceUntagEgress);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleVersionInfo | ( | CSL_CPSW_ALE_VERSION * | pVersionInfo | ) |
============================================================================
CSL_CPSW_getAleVersionInfo
Description
This function retrieves the ALE submodule identification and version information.
Arguments
pVersionInfo CSL_CPSW_ALE_VERSION structure that needs to be populated with the ALE version info read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_ID_REG_ALE_MINOR_VER, CPSW_5GF_ALE_ID_REG_ALE_MAJOR_VER, CPSW_5GF_ALE_ID_REG_ALE_IDENT
Example
CSL_CPSW_ALE_VERSION versionInfo; CSL_CPSW_getAleVersionInfo (&versionInfo);
=============================================================================
============================================================================
CSL_CPSW_getAleVersionInfo
Description
This function retrieves the ALE submodule identification and version information.
Arguments
pVersionInfo CSL_CPSW_ALE_VERSION structure that needs to be populated with the ALE version info read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
ALE_IDVER_REG_MINOR_VER, ALE_IDVER_REG_MAJOR_VER, ALE_IDVER_REG_RTL_VER, ALE_IDVER_REG_IDENT
Example
CSL_CPSW_ALE_VERSION versionInfo; CSL_CPSW_getAleVersionInfo (&versionInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleVlanEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_VLAN_ENTRY * | pVlanCfg | ||
) |
============================================================================
CSL_CPSW_getAleVlanEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with VLAN configuration read from the hardware.
Arguments
index ALE table index to be read. pVlanCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLAN_ENTRY vlanCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_VLAN) { // ALE entry has a VLAN configuration CSL_CPSW_getAleVlanEntry (index, &vlanCfg); }
=============================================================================
============================================================================
CSL_CPSW_getAleVlanEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with VLAN configuration read from the hardware.
Arguments
index ALE table index to be read. pVlanCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLAN_ENTRY vlanCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_VLAN) { // ALE entry has a VLAN configuration CSL_CPSW_getAleVlanEntry (index, &vlanCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleVlanMcastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_VLANMCASTADDR_ENTRY * | pVlanMcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_getAleVlanMcastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with VLAN Multicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pVlanMcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANMCASTADDR_ENTRY vlanMcastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_VLANADDRESS) { // ALE entry has a VLAN address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_MCAST) { // Read VLAN Multicast address config from hardware CSL_CPSW_getAleVlanMcastAddrEntry (index, &vlanMcastAddrCfg); } }
=============================================================================
============================================================================
CSL_CPSW_getAleVlanMcastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with VLAN Multicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pVlanMcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANMCASTADDR_ENTRY vlanMcastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_VLANADDRESS) { // ALE entry has a VLAN address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_MCAST) { // Read VLAN Multicast address config from hardware CSL_CPSW_getAleVlanMcastAddrEntry (index, &vlanMcastAddrCfg); } }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getAleVlanUnicastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY * | pVlanUcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_getAleVlanUnicastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with VLAN Unicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pVlanUcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY vlanUcastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_VLANADDRESS) { // ALE entry has a VLAN address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Read VLAN Unicast address config from hardware CSL_CPSW_getAleVlanUnicastAddrEntry (index, &ucvlanUcastAddrCfgastAddrCfg); } }
=============================================================================
============================================================================
CSL_CPSW_getAleVlanUnicastAddrEntry
Description
This function reads the ALE table entry for the index specified and fills the output parameter structure with VLAN Unicast address configuration read from the hardware.
Arguments
index ALE table index to be read. pVlanUcastAddrCfg ALE entry contents read. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=0
Reads
ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY vlanUcastAddrCfg; index = 0; if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_VLANADDRESS) { // ALE entry has a VLAN address if (CSL_CPSW_getALEAddressType (index) == ALE_ADDRTYPE_UCAST) { // Read VLAN Unicast address config from hardware CSL_CPSW_getAleVlanUnicastAddrEntry (index, &ucvlanUcastAddrCfgastAddrCfg); } }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getCppiSourceIdReg | ( | Uint32 * | pTxASrcId, |
Uint32 * | pTxBSrcId | ||
) |
============================================================================
CSL_CPSW_getCppiSourceIdReg
Description
This function retrieves the contents of the CPPI Source Identification register.
Arguments
pTxASrcId CPPI Info Word0 Source Id Value on TxA. pTxBSrcId CPPI Info Word0 Source Id Value on TxB. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P0_CPPI_SRC_ID_REG_TXA_SRC_ID, CPSW_5GF_P0_CPPI_SRC_ID_REG_TXB_SRC_ID
Example
* Uint32 txASrcId, txBSrcId; CSL_CPSW_getCppiSourceIdReg (&txASrcId, &txBSrcId);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getCppiSourceIdReg | ( | Uint32 * | pTxSrcId | ) |
============================================================================
CSL_CPSW_getCppiSourceIdReg
Description
This function retrieves the contents of the CPPI Source Identification register.
Arguments
pTxSrcId[8] CPPI Info Word0 Source Id Value on Tx Ports respectively. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_P0_SRC_ID_A_REG_PORT1 XGE_CPSW_P0_SRC_ID_A_REG_PORT2 XGE_CPSW_P0_SRC_ID_A_REG_PORT3 XGE_CPSW_P0_SRC_ID_A_REG_PORT4 XGE_CPSW_P0_SRC_ID_B_REG_PORT5 XGE_CPSW_P0_SRC_ID_B_REG_PORT6 XGE_CPSW_P0_SRC_ID_B_REG_PORT7 XGE_CPSW_P0_SRC_ID_B_REG_PORT8
Example
* Uint32 txSrcId[8]; CSL_CPSW_getCppiSourceIdReg (txSrcId);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getCpswControlReg | ( | CSL_CPSW_CONTROL * | pControlRegInfo | ) |
============================================================================
CSL_CPSW_getCpswControlReg
Description
This function retrieves the contents of the CPSW Control register.
Arguments
pControlRegInfo CSL_CPSW_CONTROL structure that needs to be populated with the control register contents. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_FIFO_LOOPBACK, CPSW_5GF_CPSW_CONTROL_REG_VLAN_AWARE, CPSW_5GF_CPSW_CONTROL_REG_P0_ENABLE, CPSW_5GF_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED, CPSW_5GF_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED, CPSW_5GF_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED
Example
CSL_CPSW_CONTROL controlRegInfo; CSL_CPSW_getCpswControlReg (&controlRegInfo);
=============================================================================
============================================================================
CSL_CPSW_getCpswControlReg
Description
This function retrieves the contents of the CPSW Control register.
Arguments
pControlRegInfo CSL_CPSW_CONTROL structure that needs to be populated with the control register contents. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_VLAN_AWARE, XGE_CPSW_CONTROL_REG_P0_ENABLE, XGE_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED, XGE_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED, XGE_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P3_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P4_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P5_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P6_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P7_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P8_PASS_PRI_TAGGED
Example
CSL_CPSW_CONTROL controlRegInfo; CSL_CPSW_getCpswControlReg (&controlRegInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getCpswVersionInfo | ( | CSL_CPSW_VERSION * | pVersionInfo | ) |
============================================================================
CSL_CPSW_getCpswVersionInfo
Description
This function retrieves the CPSW identification and version information.
Arguments
pVersionInfo CSL_CPSW_VERSION structure that needs to be populated with the version info read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_ID_VER_REG_CPSW_5GF_MINOR_VER, CPSW_5GF_CPSW_ID_VER_REG_CPSW_5GF_MAJ_VER, CPSW_5GF_CPSW_ID_VER_REG_CPSW_5GF_RTL_VER, CPSW_5GF_CPSW_ID_VER_REG_CPSW_5GF_IDENT
Example
CSL_CPSW_VERSION versionInfo; CSL_CPSW_getCpswVersionInfo (&versionInfo);
=============================================================================
============================================================================
CSL_CPSW_nGF_getCpswVersionInfo
Description
This function retrieves the CPSW identification and version information.
Arguments
pVersionInfo CSL_CPSW_VERSION structure that needs to be populated with the version info read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_ID_VER_REG_CPSW_5GF_MINOR_VER, XGE_CPSW_ID_VER_REG_CPSW_5GF_MAJ_VER, XGE_CPSW_ID_VER_REG_CPSW_5GF_RTL_VER, XGE_CPSW_ID_VER_REG_CPSW_5GF_IDENT
Example
CSL_CPSW_VERSION versionInfo; CSL_CPSW_getCpswVersionInfo (&versionInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getEmulationControlReg | ( | Uint32 * | pFree, |
Uint32 * | pSoft | ||
) |
============================================================================
CSL_CPSW_getEmulationControlReg
Description
This function retrieves the contents of the CPSW Emulation Control register.
Arguments
pFree Emulation free bit read from the hardware. pSoft Emulation soft bit read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_EM_CONTROL_REG_FREE, CPSW_5GF_EM_CONTROL_REG_SOFT
Example
Uint32 free, soft; CSL_CPSW_getEmulationControlReg (&free, &soft);
=============================================================================
============================================================================
CSL_CPSW_getEmulationControlReg
Description
This function retrieves the contents of the CPSW Emulation Control register.
Arguments
pFree Emulation free bit read from the hardware. pSoft Emulation soft bit read from the hardware. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_EM_CONTROL_REG_FREE, XGE_CPSW_EM_CONTROL_REG_SOFT
Example
Uint32 free, soft; CSL_CPSW_getEmulationControlReg (&free, &soft);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getFlowControlReg | ( | CSL_CPSW_FLOWCNTL * | pFlowControlCfg | ) |
============================================================================
CSL_CPSW_getFlowControlReg
Description
This function retrieves the contents of the Flow control register.
Arguments
pFlowControlCfg CSL_CPSW_FLOWCNTL structure that needs to be populated with contents of Flow control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_FLOW_CONTROL_REG_P0_FLOW_EN, CPSW_5GF_FLOW_CONTROL_REG_P1_FLOW_EN, CPSW_5GF_FLOW_CONTROL_REG_P2_FLOW_EN
Example
* CSL_CPSW_FLOWCNTL flowControlCfg; CSL_CPSW_getFlowControlReg (&flowControlCfg);
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_getPort0RxMaxLen | ( | void | ) |
============================================================================
CSL_CPSW_getPort0RxMaxLen
Description
This function retrieves the contents of the Port 0 Receive Maximum Length Register.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_RX_MAXLEN_REG_RX_MAXLEN
Example
* Uint32 rxMaxLen; rxMaxLen = CSL_CPSW_getPort0RxMaxLen ();
=============================================================================
============================================================================
CSL_CPSW_getPort0RxMaxLen
Description
This function retrieves the contents of the Port 0 Receive Maximum Length Register.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_P0_RX_MAXLEN_REG_RX_MAXLEN
Example
* Uint32 rxMaxLen; rxMaxLen = CSL_CPSW_getPort0RxMaxLen ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPort0RxPriMapReg | ( | Uint32 * | pPortRxPriMap | ) |
============================================================================
CSL_CPSW_getPort0RxPriMapReg
Description
This function retrieves the contents of the Port 0 Receive Packet Priority to Header Priority Mapping Register.
Arguments
pPortRxPriMap Array of Port 0 Rx priority map priority values read from the register. *
Return Value
None
Pre Condition
The input parameter 'pPortRxPriMap' must be large enough to hold all the 8 priority values read from the register.
Post Condition
None
Reads
CPSW_5GF_P0_RX_PRI_MAP_REG_PRI0, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI1, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI2, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI3, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI4, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI5, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI6, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI7
Example
* Uint32 port0RxPriMap [8]; CSL_CPSW_getPort0RxPriMapReg (port0RxPriMap);
=============================================================================
============================================================================
CSL_CPSW_getPort0RxPriMapReg
Description
This function retrieves the contents of the Port 0 Receive Packet Priority to Header Priority Mapping Register.
Arguments
pPortRxPriMap Array of Port 0 Rx priority map priority values read from the register. *
Return Value
None
Pre Condition
The input parameter 'pPortRxPriMap' must be large enough to hold all the 8 priority values read from the register.
Post Condition
None
Reads
XGE_CPSW_P0_RX_PRI_MAP_REG_PRI0, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI1, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI2, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI3, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI4, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI5, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI6, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI7
Example
* Uint32 port0RxPriMap [8]; CSL_CPSW_getPort0RxPriMapReg (port0RxPriMap);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPort0VlanReg | ( | Uint32 * | pPortVID, |
Uint32 * | pPortCFI, | ||
Uint32 * | pPortPRI | ||
) |
============================================================================
CSL_CPSW_getPort0VlanReg
Description
This function retrieves the contents of the Port 0 VLAN Register.
Arguments
pPortVID Port VLAN Id pPortCFI Port CFI bit pPortPRI Port VLAN priority (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P0_PORT_VLAN_REG_PORT_VID, CPSW_5GF_P0_PORT_VLAN_REG_PORT_CFI, CPSW_5GF_P0_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI; CSL_CPSW_getPort0VlanReg (&portVID, &portCFI, &portPRI);
=============================================================================
============================================================================
CSL_CPSW_getPort0VlanReg
Description
This function retrieves the contents of the Port 0 VLAN Register.
Arguments
pPortVID Port VLAN Id pPortCFI Port CFI bit pPortPRI Port VLAN priority (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_P0_PORT_VLAN_REG_PORT_VID, XGE_CPSW_P0_PORT_VLAN_REG_PORT_CFI, XGE_CPSW_P0_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI; CSL_CPSW_getPort0VlanReg (&portVID, &portCFI, &portPRI);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortBlockCountReg | ( | Uint32 | portNum, |
Uint32 * | pRxBlkCnt, | ||
Uint32 * | pTxBlkCnt | ||
) |
============================================================================
CSL_CPSW_getPortBlockCountReg
Description
This function retrieves the contents of the Port Block Count register corresponding to the MAC port specified.
Arguments
portNum MAC port number for which the block count must be retrieved. pRxBlkCnt Receive block count usage read for this port. pTxBlkCnt Transmit block count usage read for this port. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P_BLK_CNT_REG_RX_BLK_CNT, CPSW_5GF_P_BLK_CNT_REG_TX_BLK_CNT
Example
* Uint32 rxBlkCnt, txBlkCnt, portNum; portNum = 1; CSL_CPSW_getPortBlockCountReg (portNum, &rxBlkCnt, &txBlkCnt);
=============================================================================
============================================================================
CSL_CPSW_getPortBlockCountReg
Description
This function retrieves the contents of the Port Block Count register corresponding to the MAC port specified.
Arguments
portNum MAC port number for which the block count must be retrieved. pRxBlkCnt Receive block count usage read for this port. pTxBlkCnt Transmit block count usage read for this port. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_PN_BLK_CNT_REG_RX_BLK_CNT, XGE_CPSW_PN_BLK_CNT_REG_TX_BLK_CNT, XGE_CPSW_P0_BLK_CNT_REG_RX_BLK_CNT, XGE_CPSW_P0_BLK_CNT_REG_TX_BLK_CNT,
Example
* Uint32 rxBlkCnt, txBlkCnt, portNum; portNum = 1; CSL_CPSW_getPortBlockCountReg (portNum, &rxBlkCnt, &txBlkCnt);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortMACAddress | ( | Uint32 | portNum, |
Uint8 * | pMacAddress | ||
) |
============================================================================
CSL_CPSW_getPortMACAddress
Description
This function retreives the source MAC address corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the source MAC address must be read and returned. pMacAddress 6 byte Source MAC address read. *
Return Value
None
Pre Condition
The input parameter 'pMacAddres' must be large enough the 6 byte MAC address returned by this API.
Post Condition
None
Reads
CPSW_5GF_SL_SA_LO_REG_MACSRCADDR_7_0, CPSW_5GF_SL_SA_LO_REG_MACSRCADDR_15_8, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_23_16, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_31_24, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_39_32, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_47_40
Example
* Uint8 macAddress [6], portNum; portNum = 1; CSL_CPSW_getPortMACAddress (portNum, macAddress);
=============================================================================
============================================================================
CSL_CPSW_getPortMACAddress
Description
This function retreives the source MAC address of the Tx Pause Frame corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the source MAC address must be read and returned. (1-8) pMacAddress 6 byte Source MAC address read. *
Return Value
None
Pre Condition
The input parameter 'pMacAddres' must be large enough the 6 byte MAC address returned by this API.
Post Condition
None
Reads
XGE_CPSW_PN_SA_L_REG_MACSRCADDR_7_0, XGE_CPSW_PN_SA_L_REG_MACSRCADDR_15_8, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_23_16, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_31_24, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_39_32, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_47_40
Example
* Uint8 macAddress [6], portNum; portNum = 1; CSL_CPSW_getPortMACAddress (portNum, macAddress);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortMaxBlocksReg | ( | Uint32 | portNum, |
Uint32 * | pRxMaxBlks, | ||
Uint32 * | pTxMaxBlks | ||
) |
============================================================================
CSL_CPSW_getPortMaxBlocksReg
Description
This function retrieves the contents of the Port Max Blocks Register corresponding to the MAC port specified.
Arguments
portNum MAC port number for which the max block numbers must be retrieved. pRxMaxBlks Receive FIFO Maximum blocks read for this port. pTxMaxBlks Transmit FIFO Maximum blocks read for this port. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P_MAX_BLKS_REG_RX_MAX_BLKS, CPSW_5GF_P_MAX_BLKS_REG_TX_MAX_BLKS
Example
* Uint32 rxMaxBlks, txMaxBlks, portNum; portNum = 1; CSL_CPSW_getPortMaxBlocksReg (portNum, &rxMaxBlks, &txMaxBlks);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortStatsEnableReg | ( | CSL_CPSW_PORTSTAT * | pPortStatsCfg | ) |
============================================================================
CSL_CPSW_getPortStatsEnableReg
Description
This function retrieves the contents of the CPSW Port Statistics Enable register.
Arguments
pPortStatsCfg CSL_CPSW_PORTSTAT structure that needs to be populated with the port statistics enable register contents. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_STAT_PORT_EN_REG_P0A_STAT_EN, CPSW_5GF_STAT_PORT_EN_REG_P0B_STAT_EN, CPSW_5GF_STAT_PORT_EN_REG_P1_STAT_EN, CPSW_5GF_STAT_PORT_EN_REG_P2_STAT_EN
Example
CSL_CPSW_PORTSTAT portStatsCfg; CSL_CPSW_getPortStatsEnableReg (&portStatsCfg);
=============================================================================
============================================================================
CSL_CPSW_getPortStatsEnableReg
Description
This function retrieves the contents of the CPSW Port Statistics Enable register.
Arguments
pPortStatsCfg CSL_XGE_CPSW_PORTSTAT structure that needs to be populated with the port statistics enable register contents. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_STAT_PORT_EN_REG_P0_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P1_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P2_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P3_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P4_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P5_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P6_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P7_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P8_STAT_EN
Example
CSL_CPSW_PORTSTAT portStatsCfg; CSL_CPSW_getPortStatsEnableReg (&portStatsCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortTimeSyncCntlReg | ( | Uint32 | portNum, |
CSL_CPSW_TSCNTL * | pTimeSyncCntlCfg | ||
) |
============================================================================
CSL_CPSW_getPortTimeSyncCntlReg
Description
This function retreives the contents of Time sync control register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. pTimeSyncCntlCfg CSL_CPSW_TSCNTL that needs to be populated with contents of time sync control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P_TS_CTL_REG_TS_RX_EN, CPSW_5GF_P_TS_CTL_REG_TS_RX_VLAN_LTYPE1_EN, CPSW_5GF_P_TS_CTL_REG_TS_RX_VLAN_LTYPE2_EN, CPSW_5GF_P_TS_CTL_REG_TS_TX_EN, CPSW_5GF_P_TS_CTL_REG_TS_TX_VLAN_LTYPE1_EN, CPSW_5GF_P_TS_CTL_REG_TS_TX_VLAN_LTYPE2_EN, CPSW_5GF_P_TS_CTL_REG_TX_MSG_TYPE_EN_15_0
Example
* Uint32 portNum; CSL_CPSW_TSCNTL tsCtlCfg; portNum = 1; CSL_CPSW_getPortTimeSyncCntlReg (portNum, &tsCtlCfg);
=============================================================================
============================================================================
CSL_CPSW_getPortTimeSyncCntlReg
Description
This function retreives the contents of Time sync control register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. (1-8) pTimeSyncCntlCfg CSL_CPSW_TSCNTL that needs to be populated with contents of time sync control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_PN_TS_CTL_REG_TS_RX_ANNEX_F_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_VLAN_LTYPE1_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_VLAN_LTYPE2_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_ANNEX_D_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_ANNEX_F_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_VLAN_LTYPE1_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_VLAN_LTYPE2_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_ANNEX_D_EN, XGE_CPSW_PN_TS_CTL_REG_TS_LTYPE2_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_ANNEX_E_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_ANNEX_E_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_HOST_TS_EN, XGE_CPSW_PN_TS_CTL_REG_TS_MSG_TYPE_EN
Example
* Uint32 portNum; CSL_CPSW_TSCNTL tsCtlCfg; portNum = 1; CSL_CPSW_getPortTimeSyncCntlReg (portNum, &tsCtlCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortTimeSyncSeqIdReg | ( | Uint32 | portNum, |
Uint32 * | pTsLtype, | ||
Uint32 * | pTsSeqIdOffset | ||
) |
============================================================================
CSL_CPSW_getPortTimeSyncSeqIdReg
Description
This function retreives the contents of Time Sync Sequence Id and LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. pTsLtype Time sync LTYPE read. pTsSeqIdOffset Time sync sequence Id offset read. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P_TS_SEQ_LTYPE_REG_TS_LTYPE, CPSW_5GF_P_TS_SEQ_LTYPE_REG_TS_SEQ_ID_OFFSET
Example
* Uint32 portNum, tsLtype, tsSeqIdOffset; portNum = 1; CSL_CPSW_getPortTimeSyncSeqIdReg (portNum, &tsLtype, &tsSeqIdOffset);
=============================================================================
============================================================================
CSL_CPSW_getPortTimeSyncSeqIdReg
Description
This function retreives the contents of Time Sync Sequence Id and LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. (1-8) pTsLtype Time sync LTYPE read. pTsSeqIdOffset Time sync sequence Id offset read. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_PN_TS_SEQ_LTYPE_REG_TS_LTYPE1, XGE_CPSW_PN_TS_SEQ_LTYPE_REG_TS_SEQ_ID_OFFSET
Example
* Uint32 portNum, tsLtype, tsSeqIdOffset; portNum = 1; CSL_CPSW_getPortTimeSyncSeqIdReg (portNum, &tsLtype, &tsSeqIdOffset);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortTimeSyncVlanLTypeReg | ( | Uint32 | portNum, |
Uint32 * | pTsVlanLtype1, | ||
Uint32 * | pTsVlanLtype2 | ||
) |
============================================================================
CSL_CPSW_getPortTimeSyncVlanLTypeReg
Description
This function retreives the contents of Time Sync VLAN LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. pTsVlanLtype1 Time sync VLAN LTYPE1 value read. pTsVlanLtype2 Time sync VLAN LTYPE2 value read. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE1, CPSW_5GF_P_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE2
Example
* Uint32 portNum, tsLtype1, tsLtype2; portNum = 1; CSL_CPSW_getPortTimeSyncVlanLTypeReg (portNum, &tsLtype1, &tsLtype2);
=============================================================================
============================================================================
CSL_CPSW_getPortTimeSyncVlanLTypeReg
Description
This function retreives the contents of Time Sync VLAN LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. (1-8) pTsVlanLtype1 Time sync VLAN LTYPE1 value read. pTsVlanLtype2 Time sync VLAN LTYPE2 value read. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_PN_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE1, XGE_CPSW_PN_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE2
Example
* Uint32 portNum, tsLtype1, tsLtype2; portNum = 1; CSL_CPSW_getPortTimeSyncVlanLTypeReg (portNum, &tsLtype1, &tsLtype2);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortTxPriMapReg | ( | Uint32 | portNum, |
Uint32 * | pPortTxPriMap | ||
) |
============================================================================
CSL_CPSW_getPortTxPriMapReg
Description
This function retrieves the contents of the Transmit Header Priority to Switch Priority Mapping Register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register contents must be read and returned. pPortTxPriMap Array of Port Tx priority map priority values read from the register. *
Return Value
None
Pre Condition
The input parameter 'pPortTxPriMap' must be large enough to hold all the 8 priority values read from the register.
Post Condition
None
Reads
CPSW_5GF_P_TX_PRI_MAP_REG_PRI0, CPSW_5GF_P_TX_PRI_MAP_REG_PRI1, CPSW_5GF_P_TX_PRI_MAP_REG_PRI2, CPSW_5GF_P_TX_PRI_MAP_REG_PRI3, CPSW_5GF_P_TX_PRI_MAP_REG_PRI4, CPSW_5GF_P_TX_PRI_MAP_REG_PRI5, CPSW_5GF_P_TX_PRI_MAP_REG_PRI6, CPSW_5GF_P_TX_PRI_MAP_REG_PRI7
Example
* Uint32 portTxPriMap [8], portNum; portNum = 1; CSL_CPSW_getPortTxPriMapReg (portNum, portTxPriMap);
=============================================================================
============================================================================
CSL_CPSW_getPortTxPriMapReg
Description
This function retrieves the contents of the Transmit Header Priority to Switch Priority Mapping Register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register contents must be read and returned. pPortTxPriMap Array of Port Tx priority map priority values read from the register. *
Return Value
None
Pre Condition
The input parameter 'pPortTxPriMap' must be large enough to hold all the 8 priority values read from the register.
Post Condition
None
Reads
XGE_CPSW_PN_TX_PRI_MAP_REG_PRI0, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI1, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI2, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI3, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI4, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI5, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI6, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI7, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI0, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI1, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI2, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI3, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI4, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI5, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI6, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI7
Example
* Uint32 portTxPriMap [8], portNum; portNum = 1; CSL_CPSW_getPortTxPriMapReg (portNum, portTxPriMap);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPortVlanReg | ( | Uint32 | portNum, |
Uint32 * | pPortVID, | ||
Uint32 * | pPortCFI, | ||
Uint32 * | pPortPRI | ||
) |
============================================================================
CSL_CPSW_getPortVlanReg
Description
This function retrieves the contents of the VLAN Register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the VLAN register contents must be read pPortVID Port VLAN Id pPortCFI Port CFI bit pPortPRI Port VLAN priority (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_P_PORT_VLAN_REG_PORT_VID, CPSW_5GF_P_PORT_VLAN_REG_PORT_CFI, CPSW_5GF_P_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI, portNum; portNum = 2; CSL_CPSW_getPortVlanReg (portNum, &portVID, &portCFI, &portPRI);
=============================================================================
============================================================================
CSL_CPSW_getPortVlanReg
Description
This function retrieves the contents of the VLAN Register corresponding to the EMAC port number specified.
Arguments
portNum EMAC port number for which the VLAN register contents must be read (1-8) pPortVID Port VLAN Id pPortCFI Port CFI bit pPortPRI Port VLAN priority (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_PN_PORT_VLAN_REG_PORT_VID, XGE_CPSW_PN_PORT_VLAN_REG_PORT_CFI, XGE_CPSW_PN_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI, portNum; portNum = 2; CSL_CPSW_getPortVlanReg (portNum, &portVID, &portCFI, &portPRI);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getPrioTypeReg | ( | CSL_CPSW_PTYPE * | pTypeCfg | ) |
============================================================================
CSL_CPSW_getPrioTypeReg
Description
This function retrieves the contents of the CPSW Priority Type register.
Arguments
pTypeCfg CSL_CPSW_PTYPE structure that needs to be populated with the priority type register contents. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_PTYPE_REG_ESC_PRI_LD_VAL, CPSW_5GF_PTYPE_REG_P0_PTYPE_ESC, CPSW_5GF_PTYPE_REG_P1_PTYPE_ESC, CPSW_5GF_PTYPE_REG_P2_PTYPE_ESC
Example
CSL_CPSW_PTYPE pTypeCfg; CSL_CPSW_getPrioTypeReg (&pTypeCfg);
=============================================================================
============================================================================
CSL_CPSW_getPrioTypeReg
Description
This function retrieves the contents of the CPSW Priority Type register.
Arguments
pTypeCfg CSL_CPSW_PTYPE structure that needs to be populated with the priority type register contents. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_PTYPE_REG_ESC_PRI_LD_VAL, XGE_CPSW_PTYPE_REG_P0_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P1_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P2_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P3_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P4_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P5_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P6_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P7_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P8_PTYPE_ESC
Example
CSL_CPSW_PTYPE pTypeCfg; CSL_CPSW_getPrioTypeReg (&pTypeCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getRawStats | ( | CSL_CPSW_STATS * | pCpswStats | ) |
============================================================================
CSL_CPSW_getRawStats
Description
The CPSW stats are divided into 2 blocks, i.e., Stats for Host port (switch Port 0) and Stats for MAC ports (Port 1 and Port2). This function retreives snapshot of hardware statistics for both the stat blocks. In the case of Linux ARM master use case all CPSW stats is recommended to be accessed from Linux.
Since this function does not clear the stats, its possible to have non-exclusive ownership of the switch and use this function without corrupting other caller's view of the stats.
Additional Note: In order to avoid stats loss due to rollovers, application would need to poll the stats by determining the correct interval. The stat CPSW_NETOCTETS would be first one to roll over The software must poll and accumulate the stats faster than this rate. On a 1 gigabit network, it takes approximately (0x100000000/(1000000000/8)/2)=17 seconds to roll over (the /2 is because this stat contains both tx and rx, both of which run at gigabit). A good rule of thumb is to poll at twice this rate (8-9 seconds).
If it is really necessary for application to have multiple nonexclusive owners of the switch, it is possible for all callers to have a view of the accumulated statistics if they (including Linux) follows the differential accumulation of the stats defiened below: uint64_t accum_CPSW_NETOCTETS; uint32_t old_CPSW_NETOCTETS, new_CPSW_NETOCTETS, diff_CPSW_NETOCTETS;
diff_CPSW_NETOCTETS = new_CPSW_NETOCTETS - old_CPSW_NETOCTETS; // let rollover occur, no "if" required old_CPSW_NETOCTETS = new_CPSW_NETOCTETS; accum_CPSW_NETOCTETS += diff_CPSW_NETOCTETS
Arguments
pCpswStats Array of CSL_CPSW_STATS structure that needs to be filled with the stats read from the hardware. This function expects that the array passed to it is big enough to hold the stats for both stat blocks, i.e., size of array passed to this function must be 2. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_RXGOODFRAMES, CPSW_RXBROADCASTFRAMES, CPSW_RXMULTICASTFRAMES, CPSW_RXPAUSEFRAMES, CPSW_RXCRCERRORS, CPSW_RXALIGNCODEERRORS, CPSW_RXOVERSIZEDFRAMES, CPSW_RXJABBERFRAMES, CPSW_RXUNDERSIZEDFRAMES, CPSW_RXFRAGMENTS, CPSW_RXOCTETS, CPSW_TXGOODFRAMES, CPSW_TXBROADCASTFRAMES, CPSW_TXMULTICASTFRAMES, CPSW_TXPAUSEFRAMES, CPSW_TXDEFERREDFRAMES, CPSW_TXCOLLISIONFRAMES, CPSW_TXSINGLECOLLFRAMES, CPSW_TXMULTCOLLFRAMES, CPSW_TXEXCESSIVECOLLISIONS, CPSW_TXLATECOLLISIONS, CPSW_TXUNDERRUN, CPSW_TXCARRIERSENSEERRORS, CPSW_TXOCTETS, CPSW_OCTETFRAMES64, CPSW_OCTETFRAMES65T127, CPSW_OCTETFRAMES128T255, CPSW_OCTETFRAMES256T511, CPSW_OCTETFRAMES512T1023, CPSW_OCTETFRAMES1024TUP, CPSW_NETOCTETS, CPSW_OVERRUNTYPE1, CPSW_OVERRUNTYPE2, CPSW_OVERRUNTYPE3
Affects
CPSW_RXGOODFRAMES=0, CPSW_RXBROADCASTFRAMES=0, CPSW_RXMULTICASTFRAMES=0, CPSW_RXPAUSEFRAMES=0, CPSW_RXCRCERRORS=0, CPSW_RXALIGNCODEERRORS=0, CPSW_RXOVERSIZEDFRAMES=0, CPSW_RXJABBERFRAMES=0, CPSW_RXUNDERSIZEDFRAMES=0, CPSW_RXFRAGMENTS=0, CPSW_RXOCTETS=0, CPSW_TXGOODFRAMES=0, CPSW_TXBROADCASTFRAMES=0, CPSW_TXMULTICASTFRAMES=0, CPSW_TXPAUSEFRAMES=0, CPSW_TXDEFERREDFRAMES=0, CPSW_TXCOLLISIONFRAMES=0, CPSW_TXSINGLECOLLFRAMES=0, CPSW_TXMULTCOLLFRAMES=0, CPSW_TXEXCESSIVECOLLISIONS=0, CPSW_TXLATECOLLISIONS=0, CPSW_TXUNDERRUN=0, CPSW_TXCARRIERSENSEERRORS=0, CPSW_TXOCTETS=0, CPSW_OCTETFRAMES64=0, CPSW_OCTETFRAMES65T127=0, CPSW_OCTETFRAMES128T255=0, CPSW_OCTETFRAMES256T511=0, CPSW_OCTETFRAMES512T1023=0, CPSW_OCTETFRAMES1024TUP=0, CPSW_NETOCTETS=0, CPSW_OVERRUNTYPE1=0, CPSW_OVERRUNTYPE2=0, CPSW_OVERRUNTYPE3=0
Example
* CSL_CPSW_STATS stats [2]; CSL_CPSW_getStats (stats);
=============================================================================
============================================================================
CSL_CPSW_getRawStats
Description
The CPSW stats are divided into 9 blocks, i.e., Stats for Host port (switch Port 0) and Stats for MAC ports (Port 1-8). This function retreives snapshot of hardware statistics for all the stat blocks. In the case of Linux ARM master use case all CPSW stats is recommended to be accessed from Linux.
Since this function does not clear the stats, its possible to have non-exclusive ownership of the switch and use this function without corrupting other caller's view of the stats.
Additional Note: In order to avoid stats loss due to rollovers, application would need to poll the stats by determining the correct interval. The stat CPSW_NETOCTETS would be first one to roll over The software must poll and accumulate the stats faster than this rate. On a 1 gigabit network, it takes approximately (0x100000000/(1000000000/8)/2)=17 seconds to roll over (the /2 is because this stat contains both tx and rx, both of which run at gigabit). A good rule of thumb is to poll at twice this rate (8-9 seconds).
If it is really necessary for application to have multiple nonexclusive owners of the switch, it is possible for all callers to have a view of the accumulated statistics if they (including Linux) follows the differential accumulation of the stats defiened below: uint64_t accum_CPSW_NETOCTETS; uint32_t old_CPSW_NETOCTETS, new_CPSW_NETOCTETS, diff_CPSW_NETOCTETS;
diff_CPSW_NETOCTETS = new_CPSW_NETOCTETS - old_CPSW_NETOCTETS; // let rollover occur, no "if" required old_CPSW_NETOCTETS = new_CPSW_NETOCTETS; accum_CPSW_NETOCTETS += diff_CPSW_NETOCTETS
Arguments
pCpswStats Array of CSL_CPSW_STATS structure that needs to be filled with the stats read from the hardware. This function expects that the array passed to it is big enough to hold the stats for both stat blocks, i.e., size of array passed to this function must be 5 or 9 for 5-port/9-port switch respectively. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_RXGOODFRAMES, CPSW_RXBROADCASTFRAMES, CPSW_RXMULTICASTFRAMES, CPSW_RXPAUSEFRAMES, CPSW_RXCRCERRORS, CPSW_RXALIGNCODEERRORS, CPSW_RXOVERSIZEDFRAMES, CPSW_RXJABBERFRAMES, CPSW_RXUNDERSIZEDFRAMES, CPSW_RXFRAGMENTS, CPSW_ALE_DROP, CPSW_ALE_OVERRUN_DROP, CPSW_RXOCTETS, CPSW_TXGOODFRAMES, CPSW_TXBROADCASTFRAMES, CPSW_TXMULTICASTFRAMES, CPSW_TXPAUSEFRAMES, CPSW_TXDEFERREDFRAMES, CPSW_TXCOLLISIONFRAMES, CPSW_TXSINGLECOLLFRAMES, CPSW_TXMULTCOLLFRAMES, CPSW_TXEXCESSIVECOLLISIONS, CPSW_TXLATECOLLISIONS, CPSW_TXUNDERRUN, CPSW_TXCARRIERSENSEERRORS, CPSW_TXOCTETS, CPSW_OCTETFRAMES64, CPSW_OCTETFRAMES65T127, CPSW_OCTETFRAMES128T255, CPSW_OCTETFRAMES256T511, CPSW_OCTETFRAMES512T1023, CPSW_OCTETFRAMES1024TUP, CPSW_NETOCTETS, CPSW_RX_DROP, CPSW_PORTMASK_DROP, CPSW_TX_DROP, CPSW_ALE_ALE_RATE_LIMIT_DROP, CPSW_ALE_VID_INGRESS_DROP, CPSW_ALE_DA_EQ_SA_DROP, CPSW_ALE_BLOCK_DROP, CPSW_ALE_SECURE_DROP, CPSW_ALE_AUTH_DROP
Example
* CSL_CPSW_STATS stats [9]; CSL_CPSW_getRawStats (stats);
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_getShortGapThreshold | ( | void | ) |
============================================================================
CSL_CPSW_getShortGapThreshold
Description
This function retrieves the contents of the CPSW MAC Short Gap Threshold register.
Arguments
None
Return Value
>=0 MAC short gap threshold value read from the hardware.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_GAP_THRESH_CPGMAC_SL_REG_GAP_THRESH
Example
* Uint32 gapThreshVal; gapThreshVal = CSL_CPSW_getShortGapThreshold ();
=============================================================================
============================================================================
CSL_CPSW_getShortGapThreshold
Description
This function retrieves the contents of the CPSW MAC Short Gap Threshold register.
Arguments
None
Return Value
>=0 MAC short gap threshold value read from the hardware.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_GAP_THRESH_REG_GAP_THRESH
Example
* Uint32 gapThreshVal; gapThreshVal = CSL_CPSW_getShortGapThreshold ();
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_getStats | ( | CSL_CPSW_STATS * | pCpswStats | ) |
============================================================================
CSL_CPSW_getStats
Description
The CPSW stats are divided into 2 blocks, i.e., Stats for Host port (switch Port 0) and Stats for MAC ports (Port 1 and Port2). This function
Arguments
pCpswStats Array of CSL_CPSW_STATS structure that needs to be filled with the stats read from the hardware. This function expects that the array passed to it is big enough to hold the stats for both stat blocks, i.e., size of array passed to this function must be 2. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_RXGOODFRAMES, CPSW_RXBROADCASTFRAMES, CPSW_RXMULTICASTFRAMES, CPSW_RXPAUSEFRAMES, CPSW_RXCRCERRORS, CPSW_RXALIGNCODEERRORS, CPSW_RXOVERSIZEDFRAMES, CPSW_RXJABBERFRAMES, CPSW_RXUNDERSIZEDFRAMES, CPSW_RXFRAGMENTS, CPSW_RXOCTETS, CPSW_TXGOODFRAMES, CPSW_TXBROADCASTFRAMES, CPSW_TXMULTICASTFRAMES, CPSW_TXPAUSEFRAMES, CPSW_TXDEFERREDFRAMES, CPSW_TXCOLLISIONFRAMES, CPSW_TXSINGLECOLLFRAMES, CPSW_TXMULTCOLLFRAMES, CPSW_TXEXCESSIVECOLLISIONS, CPSW_TXLATECOLLISIONS, CPSW_TXUNDERRUN, CPSW_TXCARRIERSENSEERRORS, CPSW_TXOCTETS, CPSW_OCTETFRAMES64, CPSW_OCTETFRAMES65T127, CPSW_OCTETFRAMES128T255, CPSW_OCTETFRAMES256T511, CPSW_OCTETFRAMES512T1023, CPSW_OCTETFRAMES1024TUP, CPSW_NETOCTETS, CPSW_OVERRUNTYPE1, CPSW_OVERRUNTYPE2, CPSW_OVERRUNTYPE3
Affects
CPSW_RXGOODFRAMES=0, CPSW_RXBROADCASTFRAMES=0, CPSW_RXMULTICASTFRAMES=0, CPSW_RXPAUSEFRAMES=0, CPSW_RXCRCERRORS=0, CPSW_RXALIGNCODEERRORS=0, CPSW_RXOVERSIZEDFRAMES=0, CPSW_RXJABBERFRAMES=0, CPSW_RXUNDERSIZEDFRAMES=0, CPSW_RXFRAGMENTS=0, CPSW_RXOCTETS=0, CPSW_TXGOODFRAMES=0, CPSW_TXBROADCASTFRAMES=0, CPSW_TXMULTICASTFRAMES=0, CPSW_TXPAUSEFRAMES=0, CPSW_TXDEFERREDFRAMES=0, CPSW_TXCOLLISIONFRAMES=0, CPSW_TXSINGLECOLLFRAMES=0, CPSW_TXMULTCOLLFRAMES=0, CPSW_TXEXCESSIVECOLLISIONS=0, CPSW_TXLATECOLLISIONS=0, CPSW_TXUNDERRUN=0, CPSW_TXCARRIERSENSEERRORS=0, CPSW_TXOCTETS=0, CPSW_OCTETFRAMES64=0, CPSW_OCTETFRAMES65T127=0, CPSW_OCTETFRAMES128T255=0, CPSW_OCTETFRAMES256T511=0, CPSW_OCTETFRAMES512T1023=0, CPSW_OCTETFRAMES1024TUP=0, CPSW_NETOCTETS=0, CPSW_OVERRUNTYPE1=0, CPSW_OVERRUNTYPE2=0, CPSW_OVERRUNTYPE3=0
Example
* CSL_CPSW_STATS stats [2]; CSL_CPSW_getStats (stats);
=============================================================================
============================================================================
CSL_CPSW_getStats
Description
The CPSW stats are divided into 9 blocks, i.e., Stats for Host port (switch Port 0) and Stats for MAC ports (Port 1-8 ). This function
Arguments
pCpswStats Array of CSL_CPSW_STATS structure that needs to be filled with the stats read from the hardware. This function expects that the array passed to it is big enough to hold the stats for all stat blocks, i.e., size of array passed to this function must be 5 or 9 for 5/9 port switch respectively. *
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_RXGOODFRAMES, CPSW_RXBROADCASTFRAMES, CPSW_RXMULTICASTFRAMES, CPSW_RXPAUSEFRAMES, CPSW_RXCRCERRORS, CPSW_RXALIGNCODEERRORS, CPSW_RXOVERSIZEDFRAMES, CPSW_RXJABBERFRAMES, CPSW_RXUNDERSIZEDFRAMES, CPSW_RXFRAGMENTS, CPSW_ALE_DROP, CPSW_ALE_OVERRUN_DROP, CPSW_RXOCTETS, CPSW_TXGOODFRAMES, CPSW_TXBROADCASTFRAMES, CPSW_TXMULTICASTFRAMES, CPSW_TXPAUSEFRAMES, CPSW_TXDEFERREDFRAMES, CPSW_TXCOLLISIONFRAMES, CPSW_TXSINGLECOLLFRAMES, CPSW_TXMULTCOLLFRAMES, CPSW_TXEXCESSIVECOLLISIONS, CPSW_TXLATECOLLISIONS, CPSW_TXUNDERRUN, CPSW_TXCARRIERSENSEERRORS, CPSW_TXOCTETS, CPSW_OCTETFRAMES64, CPSW_OCTETFRAMES65T127, CPSW_OCTETFRAMES128T255, CPSW_OCTETFRAMES256T511, CPSW_OCTETFRAMES512T1023, CPSW_OCTETFRAMES1024TUP, CPSW_NETOCTETS, CPSW_RX_DROP, CPSW_PORTMASK_DROP, CPSW_TX_DROP, CPSW_ALE_ALE_RATE_LIMIT_DROP, CPSW_ALE_VID_INGRESS_DROP, CPSW_ALE_DA_EQ_SA_DROP, CPSW_ALE_BLOCK_DROP, CPSW_ALE_SECURE_DROP, CPSW_ALE_AUTH_DROP
Affects
CPSW_RXGOODFRAMES=0, CPSW_RXBROADCASTFRAMES=0, CPSW_RXMULTICASTFRAMES=0, CPSW_RXPAUSEFRAMES=0, CPSW_RXCRCERRORS=0, CPSW_RXALIGNCODEERRORS=0, CPSW_RXOVERSIZEDFRAMES=0, CPSW_RXJABBERFRAMES=0, CPSW_RXUNDERSIZEDFRAMES=0, CPSW_RXFRAGMENTS=0, CPSW_ALE_DROP=0, CPSW_ALE_OVERRUN_DROP=0, CPSW_RXOCTETS=0, CPSW_TXGOODFRAMES=0, CPSW_TXBROADCASTFRAMES=0, CPSW_TXMULTICASTFRAMES=0, CPSW_TXPAUSEFRAMES=0, CPSW_TXDEFERREDFRAMES=0, CPSW_TXCOLLISIONFRAMES=0, CPSW_TXSINGLECOLLFRAMES=0, CPSW_TXMULTCOLLFRAMES=0, CPSW_TXEXCESSIVECOLLISIONS=0, CPSW_TXLATECOLLISIONS=0, CPSW_TXUNDERRUN=0, CPSW_TXCARRIERSENSEERRORS=0, CPSW_TXOCTETS=0, CPSW_OCTETFRAMES64=0, CPSW_OCTETFRAMES65T127=0, CPSW_OCTETFRAMES128T255=0, CPSW_OCTETFRAMES256T511=0, CPSW_OCTETFRAMES512T1023=0, CPSW_OCTETFRAMES1024TUP=0, CPSW_NETOCTETS=0, CPSW_RX_DROP=0, CPSW_PORTMASK_DROP=0, CPSW_TX_DROP=0, CPSW_ALE_ALE_RATE_LIMIT_DROP=0, CPSW_ALE_VID_INGRESS_DROP=0, CPSW_ALE_DA_EQ_SA_DROP=0, CPSW_ALE_BLOCK_DROP=0, CPSW_ALE_SECURE_DROP=0, CPSW_ALE_AUTH_DROP=0
Example
* CSL_CPSW_STATS stats [9]; CSL_CPSW_getStats (stats);
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_getTxStartWordsReg | ( | void | ) |
============================================================================
CSL_CPSW_getTxStartWordsReg
Description
This function retrieves the contents of the Transmit FIFO start words register.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_TX_START_WDS_REG_TX_START_WDS
Example
* Uint32 startWordsVal; startWordsVal = CSL_CPSW_getTxStartWordsReg ();
=============================================================================
============================================================================
CSL_CPSW_getTxStartWordsReg
Description
This function retrieves the contents of the Transmit FIFO start words register.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_TX_START_WDS_REG_TX_START_WDS
Example
* Uint32 startWordsVal; startWordsVal = CSL_CPSW_getTxStartWordsReg ();
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleAgeOutDone | ( | void | ) |
============================================================================
CSL_CPSW_isAleAgeOutDone
Description
This function reads the ALE control register's AGE_OUT_NOW bit to check if the ALE ageable entry cleanup process is done.
Arguments
None
Return Value
TRUE ALE age out process done.
FALSE ALE age out process not yet completed.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_AGE_OUT_NOW
Example
if (CSL_CPSW_isAleAgeOutDone ();
=============================================================================
============================================================================
CSL_CPSW_isAleAgeOutDone
Description
This function reads the ALE control register's AGE_OUT_NOW bit to check if the ALE ageable entry cleanup process is done.
Arguments
None
Return Value
TRUE ALE age out process done.
FALSE ALE age out process not yet completed.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_AGE_OUT_NOW
Example
if (CSL_CPSW_isAleAgeOutDone ();
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleBypassEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleBypassEnabled
Description
This function indicates if ALE is programmed to be in Bypass mode.
Arguments
None
Return Value
TRUE ALE Bypass mode enabled.
FALSE ALE Bypass mode disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_ALE_BYPASS
Example
if (CSL_CPSW_isAleBypassEnabled () == TRUE) { // ALE Bypass mode on } else { // ALE Bypass mode off }
=============================================================================
============================================================================
CSL_CPSW_isAleBypassEnabled
Description
This function indicates if ALE is programmed to be in Bypass mode.
Arguments
None
Return Value
TRUE ALE Bypass mode enabled.
FALSE ALE Bypass mode disabled.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_BYPASS
Example
if (CSL_CPSW_isAleBypassEnabled () == TRUE) { // ALE Bypass mode on } else { // ALE Bypass mode off }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleEnabled
Description
This function indicates if ALE processing is enabled.
Arguments
None
Return Value
TRUE ALE enabled. ALE packet processing will be done.
FALSE ALE disabled. All packets are dropped by ALE.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_ENABLE_ALE
Example
if (CSL_CPSW_isAleEnabled () == TRUE) { // ALE enabled } else { // ALE disabled }
=============================================================================
============================================================================
CSL_CPSW_isAleEnabled
Description
This function indicates if ALE processing is enabled.
Arguments
None
Return Value
TRUE ALE enabled. ALE packet processing will be done.
FALSE ALE disabled. All packets are dropped by ALE.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_ENABLE
Example
if (CSL_CPSW_isAleEnabled () == TRUE) { // ALE enabled } else { // ALE disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleLearnNoVIDEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleLearnNoVIDEnabled
Description
This function indicates if ALE is programmed to not learn VLAN Ids.
Arguments
None
Return Value
TRUE ALE Learn no VID enabled. VLAN Id is not learned with source address (source address is not tied to VID)
FALSE ALE VID learning mode enabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_LEARN_NO_VID
Example
if (CSL_CPSW_isAleLearnNoVIDEnabled () == TRUE) { // ALE VID learning disabled } else { // ALE VID learning enabled }
=============================================================================
============================================================================
CSL_CPSW_isAleLearnNoVIDEnabled
Description
This function indicates if ALE is programmed to not learn VLAN Ids.
Arguments
None
Return Value
TRUE ALE Learn no VID enabled. VLAN Id is not learned with source address (source address is not tied to VID)
FALSE ALE VID learning mode enabled.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_LEARN_NO_VID
Example
if (CSL_CPSW_isAleLearnNoVIDEnabled () == TRUE) { // ALE VID learning disabled } else { // ALE VID learning enabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleMacAuthModeEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleMacAuthModeEnabled
Description
This function indicates if ALE MAC Authorization mode is enabled.
Arguments
None
Return Value
TRUE ALE is in MAC authorization mode.
FALSE ALE not in MAC authorization mode.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_ENABLE_AUTH_MODE
Example
if (CSL_CPSW_isAleMacAuthModeEnabled () == TRUE) { // ALE is in MAC authorization mode } else { // ALE not in MAC authorization mode }
=============================================================================
============================================================================
CSL_CPSW_isAleMacAuthModeEnabled
Description
This function indicates if ALE MAC Authorization mode is enabled.
Arguments
None
Return Value
TRUE ALE is in MAC authorization mode.
FALSE ALE not in MAC authorization mode.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_ENABLE_AUTH_MODE
Example
if (CSL_CPSW_isAleMacAuthModeEnabled () == TRUE) { // ALE is in MAC authorization mode } else { // ALE not in MAC authorization mode }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleOUIDenyModeEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleOUIDenyModeEnabled
Description
This function indicates if ALE is programmed to be in OUI deny mode.
Arguments
None
Return Value
TRUE ALE OUI deny mode enabled.
FALSE ALE OUI deny mode disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_ENABLE_OUI_DENY
Example
if (CSL_CPSW_isAleOUIDenyModeEnabled () == TRUE) { // ALE OUI deny mode on } else { // ALE OUI deny mode off }
=============================================================================
============================================================================
CSL_CPSW_isAleOUIDenyModeEnabled
Description
This function indicates if ALE is programmed to be in OUI deny mode.
Arguments
None
Return Value
TRUE ALE OUI deny mode enabled.
FALSE ALE OUI deny mode disabled.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_ENABLE_OUI_DENY
Example
if (CSL_CPSW_isAleOUIDenyModeEnabled () == TRUE) { // ALE OUI deny mode on } else { // ALE OUI deny mode off }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleRateLimitEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleRateLimitEnabled
Description
This function indicates if ALE Broadcast and Multicast Rate Limit is enabled.
Arguments
None
Return Value
TRUE ALE Broadcast and multicast rate limit enabled. Broadcast/multicast packet reception limited to port control register rate limit fields.
FALSE ALE Broadcast and multicast rate limit disabled. Broadcast/multicast rates not limited.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_ENABLE_RATE_LIMIT
Example
if (CSL_CPSW_isAleRateLimitEnabled () == TRUE) { // ALE Broadcast/Multicast rate limit enabled } else { // ALE Broadcast/Multicast rate limit disabled }
=============================================================================
============================================================================
CSL_CPSW_isAleRateLimitEnabled
Description
This function indicates if ALE Broadcast and Multicast Rate Limit is enabled.
Arguments
None
Return Value
TRUE ALE Broadcast and multicast rate limit enabled. Broadcast/multicast packet reception limited to port control register rate limit fields.
FALSE ALE Broadcast and multicast rate limit disabled. Broadcast/multicast rates not limited.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_ENABLE_RATE_LIMIT
Example
if (CSL_CPSW_isAleRateLimitEnabled () == TRUE) { // ALE Broadcast/Multicast rate limit enabled } else { // ALE Broadcast/Multicast rate limit disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleTxRateLimitEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleTxRateLimitEnabled
Description
This function indicates if ALE is programmed to be Tx rate limited.
Arguments
None
Return Value
TRUE ALE Tx rate limit enabled. Broadcast, multicast rate limit counters are transmit port based.
FALSE ALE Tx rate limit disabled. Broadcast, multicast rate limit counters are receive port based.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_RATE_LIMIT_TX
Example
if (CSL_CPSW_isAleTxRateLimitEnabled () == TRUE) { // ALE Tx rate limit on } else { // ALE Tx rate limit off }
=============================================================================
============================================================================
CSL_CPSW_isAleTxRateLimitEnabled
Description
This function indicates if ALE is programmed to be Tx rate limited.
Arguments
None
Return Value
TRUE ALE Tx rate limit enabled. Broadcast, multicast rate limit counters are transmit port based.
FALSE ALE Tx rate limit disabled. Broadcast, multicast rate limit counters are receive port based.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_RATE_LIMIT_TX
Example
if (CSL_CPSW_isAleTxRateLimitEnabled () == TRUE) { // ALE Tx rate limit on } else { // ALE Tx rate limit off }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleVID0ModeEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleVID0ModeEnabled
Description
This function indicates if ALE is programmed to be in VID0 (VLAN ID=0) mode.
Arguments
None
Return Value
TRUE ALE VID0 mode enabled. Process the packet with VLAN Id = 0
FALSE ALE VID0 mode disabled. Process the packet with VLAN Id =PORT_VLAN[11-0]
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_EN_VID0_MODE
Example
if (CSL_CPSW_isAleVID0ModeEnabled () == TRUE) { // ALE VID0 mode on } else { // ALE VID0 mode off }
=============================================================================
============================================================================
CSL_CPSW_isAleVID0ModeEnabled
Description
This function indicates if ALE is programmed to be in VID0 (VLAN ID=0) mode.
Arguments
None
Return Value
TRUE ALE VID0 mode enabled. Process the packet with VLAN Id = 0
FALSE ALE VID0 mode disabled. Process the packet with VLAN Id =PORT_VLAN[11-0]
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_EN_VID0_MODE
Example
if (CSL_CPSW_isAleVID0ModeEnabled () == TRUE) { // ALE VID0 mode on } else { // ALE VID0 mode off }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isAleVlanAwareEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isAleVlanAwareEnabled
Description
This function indicates if ALE is programmed to be VLAN aware.
Arguments
None
Return Value
TRUE ALE VLAN aware. ALE drops packets if VLAN not found.
FALSE ALE not VLAN aware. Floods if VLAN not found.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_ALE_CONTROL_REG_ALE_VLAN_AWARE
Example
if (CSL_CPSW_isAleVlanAwareEnabled () == TRUE) { // ALE VLAN aware } else { // ALE not VLAN aware }
=============================================================================
============================================================================
CSL_CPSW_isAleVlanAwareEnabled
Description
This function indicates if ALE is programmed to be VLAN aware.
Arguments
None
Return Value
TRUE ALE VLAN aware. ALE drops packets if VLAN not found.
FALSE ALE not VLAN aware. Floods if VLAN not found.
Pre Condition
None
Post Condition
None
Reads
ALE_CONTROL_REG_VLAN_AWARE
Example
if (CSL_CPSW_isAleVlanAwareEnabled () == TRUE) { // ALE VLAN aware } else { // ALE not VLAN aware }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isFIFOLoopbackEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isFIFOLoopbackEnabled
Description
This function indicates if FIFO loopback mode is enabled in the CPSW control register.
Arguments
None
Return Value
TRUE FIFO loopback mode enabled. Each packet received is turned around and sent out on the same port's transmit path.
FALSE FIFO loopback mode disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_FIFO_LOOPBACK
Example
if (CSL_CPSW_isFIFOLoopbackEnabled (portNum) == TRUE) { // FIFO loopback mode enabled } else { // FIFO loopback mode disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort0Enabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort0Enabled
Description
This function indicates if CPPI Port (Port 0) is enabled in the CPSW control register.
Arguments
None
Return Value
TRUE Port 0 enabled.
FALSE Port 0 disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_P0_ENABLE
Example
if (CSL_CPSW_isPort0Enabled (portNum) == TRUE) { // Port 0 enabled } else { // Port 0 disabled }
=============================================================================
============================================================================
CSL_CPSW_isPort0Enabled
Description
This function indicates if CPPI Port (Port 0) is enabled in the CPSW control register.
Arguments
None
Return Value
TRUE Port 0 enabled.
FALSE Port 0 disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P0_ENABLE
Example
if (CSL_CPSW_isPort0Enabled (portNum) == TRUE) { // Port 0 enabled } else { // Port 0 disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort0PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort0PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 0.
Arguments
None
Return Value
TRUE Port 0 ingress priority tagging enabled.
FALSE Port 0 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort0PassPriTagEnabled (portNum) == TRUE) { // Port 0 pass priority tagging enabled } else { // Port 0 pass priority tagging disabled }
=============================================================================
============================================================================
CSL_CPSW_isPort0PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 0.
Arguments
None
Return Value
TRUE Port 0 ingress priority tagging enabled.
FALSE Port 0 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort0PassPriTagEnabled () == TRUE) { // Port 0 pass priority tagging enabled } else { // Port 0 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort1PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort1PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 1.
Arguments
None
Return Value
TRUE Port 1 ingress priority tagging enabled.
FALSE Port 1 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort1PassPriTagEnabled (portNum) == TRUE) { // Port 1 pass priority tagging enabled } else { // Port 1 pass priority tagging disabled }
=============================================================================
============================================================================
CSL_CPSW_isPort1PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 1.
Arguments
None
Return Value
TRUE Port 1 ingress priority tagging enabled.
FALSE Port 1 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort1PassPriTagEnabled () == TRUE) { // Port 1 pass priority tagging enabled } else { // Port 1 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort2PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort2PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 2.
Arguments
None
Return Value
TRUE Port 2 ingress priority tagging enabled.
FALSE Port 2 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort2PassPriTagEnabled (portNum) == TRUE) { // Port 2 pass priority tagging enabled } else { // Port 2 pass priority tagging disabled }
=============================================================================
============================================================================
CSL_CPSW_isPort2PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 2.
Arguments
None
Return Value
TRUE Port 2 ingress priority tagging enabled.
FALSE Port 2 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort2PassPriTagEnabled () == TRUE) { // Port 2 pass priority tagging enabled } else { // Port 2 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort3PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort3PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 3.
Arguments
None
Return Value
TRUE Port 3 ingress priority tagging enabled.
FALSE Port 3 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P3_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort3PassPriTagEnabled () == TRUE) { // Port 3 pass priority tagging enabled } else { // Port 3 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort4PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort4PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 4.
Arguments
None
Return Value
TRUE Port 4 ingress priority tagging enabled.
FALSE Port 4 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P4_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort4PassPriTagEnabled () == TRUE) { // Port 0 pass priority tagging enabled } else { // Port 0 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort5PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort5PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 5.
Arguments
None
Return Value
TRUE Port 5 ingress priority tagging enabled.
FALSE Port 5 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P5_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort5PassPriTagEnabled () == TRUE) { // Port 5 pass priority tagging enabled } else { // Port 5 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort6PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort6PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 6.
Arguments
None
Return Value
TRUE Port 6 ingress priority tagging enabled.
FALSE Port 6 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P6_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort6PassPriTagEnabled () == TRUE) { // Port 6 pass priority tagging enabled } else { // Port 6 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort7PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort7PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 7.
Arguments
None
Return Value
TRUE Port 7 ingress priority tagging enabled.
FALSE Port 7 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P7_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort7PassPriTagEnabled () == TRUE) { // Port 7 pass priority tagging enabled } else { // Port 7 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isPort8PassPriTagEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isPort8PassPriTagEnabled
Description
This function indicates if priority tagging is enabled for Port 8.
Arguments
None
Return Value
TRUE Port 8 ingress priority tagging enabled.
FALSE Port 8 ingress priority tagging disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_P8_PASS_PRI_TAGGED
Example
if (CSL_CPSW_isPort8PassPriTagEnabled () == TRUE) { // Port 8 pass priority tagging enabled } else { // Port 8 pass priority tagging disabled }
=============================================================================
CSL_IDEF_INLINE Uint32 CSL_CPSW_isVlanAwareEnabled | ( | void | ) |
============================================================================
CSL_CPSW_isVlanAwareEnabled
Description
This function indicates if VLAN aware mode is enabled in the CPSW control register.
Arguments
None
Return Value
TRUE VLAN aware mode enabled.
FALSE VLAN aware mode disabled.
Pre Condition
None
Post Condition
None
Reads
CPSW_5GF_CPSW_CONTROL_REG_VLAN_AWARE
Example
if (CSL_CPSW_isVlanAwareEnabled (portNum) == TRUE) { // VLAN aware mode enabled } else { // VLAN aware mode disabled }
=============================================================================
============================================================================
CSL_CPSW_isVlanAwareEnabled
Description
This function indicates if VLAN aware mode is enabled in the CPSW control register.
Arguments
None
Return Value
TRUE VLAN aware mode enabled.
FALSE VLAN aware mode disabled.
Pre Condition
None
Post Condition
None
Reads
XGE_CPSW_CONTROL_REG_VLAN_AWARE
Example
if (CSL_CPSW_isVlanAwareEnabled (portNum) == TRUE) { // VLAN aware mode enabled } else { // VLAN aware mode disabled }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleControlReg | ( | Uint32 | aleCtrlVal | ) |
============================================================================
CSL_CPSW_setAleControlReg
Description
This function sets up the contents of the ALE control register.
Arguments
aleCtrlVal Value to be configured to the ALE control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG
Example
* Uint32 aleCtrlVal = 0; aleCtrlVal = CSL_CPSW_getAleControlReg (); aleCtrlVal |= CSL_CPSW_5GF_ALECONTROL_CLRTABLE_EN; CSL_CPSW_setAleControlReg (&aleCtrlRegInfo);
=============================================================================
============================================================================
CSL_CPSW_setAleControlReg
Description
This function sets up the contents of the ALE control register.
Arguments
aleCtrlVal Value to be configured to the ALE control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG
Example
* Uint32 aleCtrlVal = 0; aleCtrlVal = CSL_CPSW_getAleControlReg (); aleCtrlVal |= CSL_XGE_CPSW_ALECONTROL_CLRTABLE_EN; CSL_CPSW_setAleControlReg (&aleCtrlRegInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleMcastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_MCASTADDR_ENTRY * | pMcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_setAleMcastAddrEntry
Description
This function sets up the ALE table entry for the index specified with Multicast address configuration specified here.
Arguments
index ALE table index. pMcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_MCASTADDR_ENTRY mcastAddrCfg; index = 0; mcastAddrCfg.macAddress [0] = 0x00; mcastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add Multicast address entry CSL_CPSW_setAleMcastAddrEntry (index, &mcastAddrCfg); }
=============================================================================
============================================================================
CSL_CPSW_setAleMcastAddrEntry
Description
This function sets up the ALE table entry for the index specified with Multicast address configuration specified here.
Arguments
index ALE table index. pMcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_MCASTADDR_ENTRY mcastAddrCfg; index = 0; mcastAddrCfg.macAddress [0] = 0x00; mcastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add Multicast address entry CSL_CPSW_setAleMcastAddrEntry (index, &mcastAddrCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleOUIAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_OUIADDR_ENTRY * | pOUIAddrCfg | ||
) |
============================================================================
CSL_CPSW_setAleOUIAddrEntry
Description
This function sets up the ALE table entry for the index specified with OUI address configuration specified here.
Arguments
index ALE table index. pOUIAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_OUIADDR_ENTRY ouiAddrCfg; index = 0; ouiAddrCfg.ouiAddress [0] = 0x00; ouiAddrCfg.ouiAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add OUI address entry CSL_CPSW_setAleOUIAddrEntry (index, &ouiAddrCfg); }
=============================================================================
============================================================================
CSL_CPSW_setAleOUIAddrEntry
Description
This function sets up the ALE table entry for the index specified with OUI address configuration specified here.
Arguments
index ALE table index. pOUIAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_OUIADDR_ENTRY ouiAddrCfg; index = 0; ouiAddrCfg.ouiAddress [0] = 0x00; ouiAddrCfg.ouiAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add OUI address entry CSL_CPSW_setAleOUIAddrEntry (index, &ouiAddrCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAlePortControlReg | ( | Uint32 | portNo, |
CSL_CPSW_ALE_PORTCONTROL * | pPortControlInfo | ||
) |
============================================================================
CSL_CPSW_setAlePortControlReg
Description
This function sets up the contents of ALE Port control register corresponding to the port number specified.
Arguments
portNo Port number for which the ALE port control register must be configured. pPortControlInfo CSL_CPSW_ALE_PORTCONTROL structure that contains port control register settings to be written. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_PORT_CONTROL_REG_PORT_STATE, CPSW_5GF_ALE_PORT_CONTROL_REG_DROP_UNTAGGED, CPSW_5GF_ALE_PORT_CONTROL_REG_VID_INGRESS_CHECK, CPSW_5GF_ALE_PORT_CONTROL_REG_NO_LEARN, CPSW_5GF_ALE_PORT_CONTROL_REG_MCAST_LIMIT, CPSW_5GF_ALE_PORT_CONTROL_REG_BCAST_LIMIT
Example
Uint32 index; CSL_CPSW_ALE_PORTCONTROL portControlInfo; index = 0; portControlInfo.portState = ALE_PORTSTATE_FORWARD | ALE_PORTSTATE_LEARN; CSL_CPSW_setAlePortControlReg (index, &portControlInfo);
=============================================================================
============================================================================
CSL_CPSW_setAlePortControlReg
Description
This function sets up the contents of ALE Port control register corresponding to the port number specified.
Arguments
portNo Port number for which the ALE port control register must be configured. pPortControlInfo CSL_CPSW_ALE_PORTCONTROL structure that contains port control register settings to be written. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_PORT_CONTROL_REG_PORT_STATE, ALE_PORT_CONTROL_REG_DROP_UNTAGGED, ALE_PORT_CONTROL_REG_VID_INGRESS_CHECK, ALE_PORT_CONTROL_REG_NO_LEARN, ALE_PORT_CONTROL_REG_MCAST_LIMIT, ALE_PORT_CONTROL_REG_BCAST_LIMIT
Example
Uint32 index; CSL_CPSW_ALE_PORTCONTROL portControlInfo; index = 0; portControlInfo.portState = ALE_PORTSTATE_FORWARD | ALE_PORTSTATE_LEARN; CSL_CPSW_setAlePortControlReg (index, &portControlInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAlePrescaleReg | ( | Uint32 | alePrescaleVal | ) |
============================================================================
CSL_CPSW_setAlePrescaleReg
Description
This function sets up the contents of the ALE prescale register.
Arguments
alePrescaleVal Value to be configured to the ALE Prescale register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_PRESCALE_REG_ALE_PRESCALE
Example
* Uint32 alePrescaleVal = 0; alePrescaleVal = 10; CSL_CPSW_setAlePrescaleReg (&aleCtrlRegInfo);
=============================================================================
============================================================================
CSL_CPSW_setAlePrescaleReg
Description
This function sets up the contents of the ALE prescale register.
Arguments
alePrescaleVal Value to be configured to the ALE Prescale register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_PRESCALE_REG_PRESCALE
Example
* Uint32 alePrescaleVal = 0; alePrescaleVal = 10; CSL_CPSW_setAlePrescaleReg (&aleCtrlRegInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleTableEntry | ( | Uint32 | index, |
Uint32 | aleInfoWd0, | ||
Uint32 | aleInfoWd1, | ||
Uint32 | aleInfoWd2 | ||
) |
============================================================================
CSL_CPSW_setAleTableEntry
Description
This function sets up an ALE table entry corresponding to the ALE entry index specified in 'index' input parameter. The ALE entry values corresponding to the ALE_TBLW0, ALE_TBLW1 and ALE_TBLW2 registers msut be specified in 'aleInfoWd0', 'aleInfoWd1', 'aleInfoWd2' input parameters.
Arguments
index ALE table index to be written. aleInfoWd0 Value to write to ALE Table Word 0 Register (ALE_TBLW0). aleInfoWd1 Value to write to Table Word 1 Register (ALE_TBLW1). aleInfoWd2 Value to write to ALE Table Word 2 Register (ALE_TBLW2). *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_WORD0_REG_ENTRY_31_0, CPSW_5GF_ALE_TABLE_WORD1_REG_ENTRY_63_32, CPSW_5GF_ALE_TABLE_WORD2_REG_ENTRY_71_64, CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1
Example
Uint32 index, info0, info1, info2; index = 0; info0 = ...; info1 = ...; info2 = ...; CSL_CPSW_setAleTableEntry (index, info0, info1, info2);
=============================================================================
============================================================================
CSL_CPSW_setAleTableEntry
Description
This function sets up an ALE table entry corresponding to the ALE entry index specified in 'index' input parameter. The ALE entry values corresponding to the ALE_TBLW0, ALE_TBLW1 and ALE_TBLW2 registers msut be specified in 'aleInfoWd0', 'aleInfoWd1', 'aleInfoWd2' input parameters.
Arguments
index ALE table index to be written. aleInfoWd0 Value to write to ALE Table Word 0 Register (ALE_TBLW0). aleInfoWd1 Value to write to ALE Table Word 1 Register (ALE_TBLW1). aleInfoWd2 Value to write to ALE Table Word 2 Register (ALE_TBLW2). *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_WORD0_REG_ENTRY_31_0, ALE_TABLE_WORD1_REG_ENTRY_63_32, ALE_TABLE_WORD2_REG_ENTRY_71_64, ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1
Example
Uint32 index, info0, info1, info2; index = 0; info0 = ...; info1 = ...; info2 = ...; CSL_CPSW_setAleTableEntry (index, info0, info1, info2);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleUnicastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_UNICASTADDR_ENTRY * | pUcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_setAleUnicastAddrEntry
Description
This function sets up the ALE table entry for the index specified with unicast address configuration specified here.
Arguments
index ALE table index. pUcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_UNICASTADDR_ENTRY ucastAddrCfg; index = 0; ucastAddrCfg.macAddress [0] = 0x00; ucastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add Unicast address entry CSL_CPSW_setAleUnicastAddrEntry (index, &ucastAddrCfg); }
=============================================================================
============================================================================
CSL_CPSW_setAleUnicastAddrEntry
Description
This function sets up the ALE table entry for the index specified with unicast address configuration specified here.
Arguments
index ALE table index. pUcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_UNICASTADDR_ENTRY ucastAddrCfg; index = 0; ucastAddrCfg.macAddress [0] = 0x00; ucastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add Unicast address entry CSL_CPSW_setAleUnicastAddrEntry (index, &ucastAddrCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleUnkownVlanReg | ( | Uint32 | unVlanMemList, |
Uint32 | unMcastFloodMask, | ||
Uint32 | unRegMcastFloodMask, | ||
Uint32 | unForceUntagEgress | ||
) |
============================================================================
CSL_CPSW_setAleUnkownVlanReg
Description
This function sets up the contents of the ALE Unknown VLAN register.
Arguments
unVlanMemList Unknown VLAN member list. unMcastFloodMask Unknown VLAN Multicast flood mask. unRegMcastFloodMask Unknown VLAN Registered Multicast Flood mask. unForceUntagEgress Unknown VLAN Force Untagged Egress. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_VLAN_MEMBER_LIST, CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_MCAST_FLOOD_MASK, CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_REG_MCAST_FLOOD_MASK, CPSW_5GF_ALE_UNKNOWN_VLAN_REG_UNKNOWN_FORCE_UNTAGGED_EGRESS
Example
Uint32 unVlanMemList, unMcastFloodMask, unRegMcastFloodMask, unForceUntagEgress; unVlanMemList = 0; unMcastFloodMask = 3; unRegMcastFloodMask = 0; unForceUntagEgress = 0; CSL_CPSW_setAleUnkownVlanReg (unVlanMemList, unMcastFloodMask, unRegMcastFloodMask, unForceUntagEgress);
=============================================================================
============================================================================
CSL_CPSW_setAleUnkownVlanReg
Description
This function sets up the contents of the ALE Unknown VLAN and etc. register.
Arguments
unVlanMemList Unknown VLAN member list. unMcastFloodMask Unknown VLAN Multicast flood mask. unRegMcastFloodMask Unknown VLAN Registered Multicast Flood mask. unForceUntagEgress Unknown VLAN Force Untagged Egress. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_UNKNOWN_VLAN_REG_UNKNOWN_LIST, ALE_UNKNOWN_MCAST_FLOOD_REG_MASK, ALE_UNKNOWN_REG_MCAST_FLOOD_REG_MASK, ALE_FORCE_UNTAGGED_EGRESS_REG_MASK
Example
Uint32 unVlanMemList, unMcastFloodMask, unRegMcastFloodMask, unForceUntagEgress; unVlanMemList = 0; unMcastFloodMask = 3; unRegMcastFloodMask = 0; unForceUntagEgress = 0; CSL_CPSW_setAleUnkownVlanReg (unVlanMemList, unMcastFloodMask, unRegMcastFloodMask, unForceUntagEgress);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleVlanEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_VLAN_ENTRY * | pVlanCfg | ||
) |
============================================================================
CSL_CPSW_setAleVlanEntry
Description
This function sets up the ALE table entry for the index specified with VLAN configuration specified here.
Arguments
index ALE table index. pVlanCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLAN_ENTRY vlanCfg; index = 0; vlanCfg.vlanId = 0x10; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add VLAN entry CSL_CPSW_setAleVlanEntry (index, &vlanCfg); }
=============================================================================
============================================================================
CSL_CPSW_setAleVlanEntry
Description
This function sets up the ALE table entry for the index specified with VLAN configuration specified here.
Arguments
index ALE table index. pVlanCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLAN_ENTRY vlanCfg; index = 0; vlanCfg.vlanId = 0x10; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add VLAN entry CSL_CPSW_setAleVlanEntry (index, &vlanCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleVlanMcastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_VLANMCASTADDR_ENTRY * | pVlanMcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_setAleVlanMcastAddrEntry
Description
This function sets up the ALE table entry for the index specified with VLAN Multicast address configuration specified here.
Arguments
index ALE table index. pVlanMcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANMCASTADDR_ENTRY vlanMcastAddrCfg; index = 0; vlanMcastAddrCfg.macAddress [0] = 0x00; vlanMcastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add VLAN Multicast address entry CSL_CPSW_setAleVlanMcastAddrEntry (index, &vlanMcastAddrCfg); }
=============================================================================
============================================================================
CSL_CPSW_setAleVlanMcastAddrEntry
Description
This function sets up the ALE table entry for the index specified with VLAN Multicast address configuration specified here.
Arguments
index ALE table index. pVlanMcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANMCASTADDR_ENTRY vlanMcastAddrCfg; index = 0; vlanMcastAddrCfg.macAddress [0] = 0x00; vlanMcastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add VLAN Multicast address entry CSL_CPSW_setAleVlanMcastAddrEntry (index, &vlanMcastAddrCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setAleVlanUnicastAddrEntry | ( | Uint32 | index, |
CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY * | pVlanUcastAddrCfg | ||
) |
============================================================================
CSL_CPSW_setAleVlanUnicastAddrEntry
Description
This function sets up the ALE table entry for the index specified with VLAN unicast address configuration specified here.
Arguments
index ALE table index. pVlanUcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_TABLE_CONTROL_REG_ENTRY_POINTER, CPSW_5GF_ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 CPSW_5GF_ALE_TABLE_WORD0, CPSW_5GF_ALE_TABLE_WORD1, CPSW_5GF_ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY vlanUcastAddrCfg; index = 0; vlanUcastAddrCfg.macAddress [0] = 0x00; vlanUcastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add VLAN Unicast address entry CSL_CPSW_setAleVlanUnicastAddrEntry (index, &vlanUcastAddrCfg); }
=============================================================================
============================================================================
CSL_CPSW_setAleVlanUnicastAddrEntry
Description
This function sets up the ALE table entry for the index specified with VLAN unicast address configuration specified here.
Arguments
index ALE table index. pVlanUcastAddrCfg ALE entry contents to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_TABLE_CONTROL_REG_ENTRY_POINTER, ALE_TABLE_CONTROL_REG_WRITE_RDZ=1 ALE_TABLE_WORD0, ALE_TABLE_WORD1, ALE_TABLE_WORD2
Example
Uint32 index; CSL_CPSW_ALE_VLANUNICASTADDR_ENTRY vlanUcastAddrCfg; index = 0; vlanUcastAddrCfg.macAddress [0] = 0x00; vlanUcastAddrCfg.macAddress [1] = 0x01; ... if (CSL_CPSW_getALEEntryType (index) == ALE_ENTRYTYPE_FREE) { // ALE entry is free // Add VLAN Unicast address entry CSL_CPSW_setAleVlanUnicastAddrEntry (index, &vlanUcastAddrCfg); }
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setCppiSourceIdReg | ( | Uint32 | txASrcId, |
Uint32 | txBSrcId | ||
) |
============================================================================
CSL_CPSW_setCppiSourceIdReg
Description
This function sets up the contents of the CPPI Source Identification register.
Arguments
txASrcId CPPI Source Id to configure for TxA. txBSrcId CPPI Source Id to configure for TxB. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P0_CPPI_SRC_ID_REG_TXA_SRC_ID, CPSW_5GF_P0_CPPI_SRC_ID_REG_TXB_SRC_ID
Example
* Uint32 txASrcId, txBSrcId; txASrcId = 1; txBSrcId = 2; CSL_CPSW_setCppiSourceIdReg (txASrcId, txBSrcId);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setCppiSourceIdReg | ( | Uint32 * | pTxSrcId | ) |
============================================================================
CSL_CPSW_setCppiSourceIdReg
Description
This function sets up the contents of the CPPI Source Identification register.
Arguments
pTxSrcId[8] CPPI Info Word0 Source Id Value on Tx Ports respectively. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_P0_SRC_ID_A_REG_PORT1 XGE_CPSW_P0_SRC_ID_A_REG_PORT2 XGE_CPSW_P0_SRC_ID_A_REG_PORT3 XGE_CPSW_P0_SRC_ID_A_REG_PORT4 XGE_CPSW_P0_SRC_ID_B_REG_PORT5 XGE_CPSW_P0_SRC_ID_B_REG_PORT6 XGE_CPSW_P0_SRC_ID_B_REG_PORT7 XGE_CPSW_P0_SRC_ID_B_REG_PORT8
Example
* Uint32 txSrcId[8]; txSrcId[0] = 1; txSrcId[1] = 2; ... CSL_CPSW_setCppiSourceIdReg (txSrcId);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setCpswControlReg | ( | CSL_CPSW_CONTROL * | pControlRegInfo | ) |
============================================================================
CSL_CPSW_setCpswControlReg
Description
This function populates the contents of the CPSW Control register.
Arguments
pControlRegInfo CSL_CPSW_CONTROL structure that holds the values that need to be configured to the CPSW control register. *
Return Value
None
Pre Condition
None
Post Condition
CPSW control register modified with values provided.
Writes
CPSW_5GF_CPSW_CONTROL_REG_FIFO_LOOPBACK, CPSW_5GF_CPSW_CONTROL_REG_VLAN_AWARE, CPSW_5GF_CPSW_CONTROL_REG_P0_ENABLE, CPSW_5GF_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED, CPSW_5GF_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED, CPSW_5GF_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED
Example
CSL_CPSW_CONTROL controlRegInfo; controlRegInfo.fifoLb = 1; controlRegInfo.vlanAware = 0; ... CSL_CPSW_setCpswControlReg (&controlRegInfo);
=============================================================================
============================================================================
CSL_CPSW_setCpswControlReg
Description
This function populates the contents of the CPSW Control register.
Arguments
pControlRegInfo CSL_CPSW_CONTROL structure that holds the values that need to be configured to the CPSW control register. *
Return Value
None
Pre Condition
None
Post Condition
CPSW control register modified with values provided.
Writes
XGE_CPSW_CONTROL_REG_VLAN_AWARE, XGE_CPSW_CONTROL_REG_P0_ENABLE, XGE_CPSW_CONTROL_REG_P0_PASS_PRI_TAGGED, XGE_CPSW_CONTROL_REG_P1_PASS_PRI_TAGGED, XGE_CPSW_CONTROL_REG_P2_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P3_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P4_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P5_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P6_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P7_PASS_PRI_TAGGED XGE_CPSW_CONTROL_REG_P8_PASS_PRI_TAGGED
Example
CSL_CPSW_CONTROL controlRegInfo; controlRegInfo.vlanAware = 0; ... CSL_CPSW_setCpswControlReg (&controlRegInfo);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setEmulationControlReg | ( | Uint32 | free, |
Uint32 | soft | ||
) |
============================================================================
CSL_CPSW_setEmulationControlReg
Description
This function sets up the contents of the CPSW Emulation Control register.
Arguments
free Emulation free bit configuration soft Emulation soft bit configuration *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_EM_CONTROL_REG_FREE, CPSW_5GF_EM_CONTROL_REG_SOFT
Example
Uint32 free, soft; free = 0; soft = 1; CSL_CPSW_setEmulationControlReg (free, soft);
=============================================================================
============================================================================
CSL_CPSW_setEmulationControlReg
Description
This function sets up the contents of the CPSW Emulation Control register.
Arguments
free Emulation free bit configuration soft Emulation soft bit configuration *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_EM_CONTROL_REG_FREE, XGE_CPSW_EM_CONTROL_REG_SOFT
Example
Uint32 free, soft; free = 0; soft = 1; CSL_CPSW_setEmulationControlReg (free, soft);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setFlowControlReg | ( | CSL_CPSW_FLOWCNTL * | pFlowControlCfg | ) |
============================================================================
CSL_CPSW_setFlowControlReg
Description
This function sets up the contents of the Flow control register.
Arguments
pFlowControlCfg CSL_CPSW_FLOWCNTL structure that contains the values that need to be configured to Flow control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_FLOW_CONTROL_REG_P0_FLOW_EN, CPSW_5GF_FLOW_CONTROL_REG_P1_FLOW_EN, CPSW_5GF_FLOW_CONTROL_REG_P2_FLOW_EN
Example
* CSL_CPSW_FLOWCNTL flowControlCfg; flowControlCfg.p0FlowEnable = 1; flowControlCfg.p1FlowEnable = 1;: flowControlCfg.p2FlowEnable = 1; CSL_CPSW_setFlowControlReg (&flowControlCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPort0RxMaxLen | ( | Uint32 | rxMaxLen | ) |
============================================================================
CSL_CPSW_setPort0RxMaxLen
Description
This function sets up the Port0 Receive Maximum length register.
Arguments
rxMaxLen Maximum receive frame length to configure. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_RX_MAXLEN_REG_RX_MAXLEN
Example
* Uint32 rxMaxLen; rxMaxLen = 1518; CSL_CPSW_setPort0RxMaxLen (rxMaxLen);
=============================================================================
============================================================================
CSL_CPSW_setPort0RxMaxLen
Description
This function sets up the Port0 Receive Maximum length register.
Arguments
rxMaxLen Maximum receive frame length to configure. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_P0_RX_MAXLEN_REG_RX_MAXLEN
Example
* Uint32 rxMaxLen; rxMaxLen = 1518; CSL_CPSW_setPort0RxMaxLen (rxMaxLen);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPort0RxPriMapReg | ( | Uint32 * | pPortRxPriMap | ) |
============================================================================
CSL_CPSW_setPort0RxPriMapReg
Description
This function sets up the contents of the Port 0 Receive Packet Priority to Header Priority Mapping Register.
Arguments
pPortRxPriMap Array of Port 0 Rx priority map priority values that must be configured to the register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P0_RX_PRI_MAP_REG_PRI0, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI1, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI2, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI3, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI4, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI5, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI6, CPSW_5GF_P0_RX_PRI_MAP_REG_PRI7
Example
* Uint32 i, port0RxPriMap [8]; for (i = 0; i < 8; i ++) port0RxPriMap [i] = i; CSL_CPSW_setPort0RxPriMapReg (port0RxPriMap);
=============================================================================
============================================================================
CSL_CPSW_setPort0RxPriMapReg
Description
This function sets up the contents of the Port 0 Receive Packet Priority to Header Priority Mapping Register.
Arguments
pPortRxPriMap Array of Port 0 Rx priority map priority values that must be configured to the register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_P0_RX_PRI_MAP_REG_PRI0, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI1, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI2, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI3, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI4, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI5, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI6, XGE_CPSW_P0_RX_PRI_MAP_REG_PRI7
Example
* Uint32 i, port0RxPriMap [8]; for (i = 0; i < 8; i ++) port0RxPriMap [i] = i; CSL_CPSW_setPort0RxPriMapReg (port0RxPriMap);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPort0VlanReg | ( | Uint32 | portVID, |
Uint32 | portCFI, | ||
Uint32 | portPRI | ||
) |
============================================================================
CSL_CPSW_setPort0VlanReg
Description
This function sets up the contents of the Port 0 VLAN Register.
Arguments
portVID Port VLAN Id to be configured portCFI Port CFI bit to be configured portPRI Port VLAN priority to be configured (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P0_PORT_VLAN_REG_PORT_VID, CPSW_5GF_P0_PORT_VLAN_REG_PORT_CFI, CPSW_5GF_P0_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI; portVID = 1; portCFI = 0; portPRI = 7; CSL_CPSW_setPort0VlanReg (portVID, portCFI, portPRI);
=============================================================================
============================================================================
CSL_CPSW_setPort0VlanReg
Description
This function sets up the contents of the Port 0 VLAN Register.
Arguments
portVID Port VLAN Id to be configured portCFI Port CFI bit to be configured portPRI Port VLAN priority to be configured (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_P0_PORT_VLAN_REG_PORT_VID, XGE_CPSW_P0_PORT_VLAN_REG_PORT_CFI, XGE_CPSW_P0_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI; portVID = 1; portCFI = 0; portPRI = 7; CSL_CPSW_setPort0VlanReg (portVID, portCFI, portPRI);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortMACAddress | ( | Uint32 | portNum, |
Uint8 * | pMacAddress | ||
) |
============================================================================
CSL_CPSW_setPortMACAddress
Description
This function sets up the source MAC address corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the source MAC address must be setup. pMacAddress 6 byte Source MAC address to configure. *
Return Value
None
Pre Condition
The input parameter 'pMacAddres' is expected to be 6 bytes long.
Post Condition
None
Writes
CPSW_5GF_SL_SA_LO_REG_MACSRCADDR_7_0, CPSW_5GF_SL_SA_LO_REG_MACSRCADDR_15_8, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_23_16, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_31_24, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_39_32, CPSW_5GF_SL_SA_HI_REG_MACSRCADDR_47_40
Example
* Uint8 macAddress [6], portNum; portNum = 1; macAddress [0] = 0x01; macAddress [1] = 0x02; macAddress [2] = 0x03; macAddress [3] = 0x04; macAddress [4] = 0x05; macAddress [5] = 0x06; CSL_CPSW_setPortMACAddress (portNum, macAddress);
=============================================================================
============================================================================
CSL_CPSW_setPortMACAddress
Description
This function sets up the source MAC address the Tx Pause Frame corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the source MAC address must be setup. (1-8) pMacAddress 6 byte Source MAC address to configure. *
Return Value
None
Pre Condition
The input parameter 'pMacAddres' is expected to be 6 bytes long.
Post Condition
None
Writes
XGE_CPSW_PN_SA_L_REG_MACSRCADDR_7_0, XGE_CPSW_PN_SA_L_REG_MACSRCADDR_15_8, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_23_16, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_31_24, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_39_32, XGE_CPSW_PN_SA_H_REG_MACSRCADDR_47_40
Example
* Uint8 macAddress [6], portNum; portNum = 1; macAddress [0] = 0x01; macAddress [1] = 0x02; macAddress [2] = 0x03; macAddress [3] = 0x04; macAddress [4] = 0x05; macAddress [5] = 0x06; CSL_CPSW_setPortMACAddress (portNum, macAddress);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortMaxBlocksReg | ( | Uint32 | portNum, |
Uint32 | rxMaxBlks, | ||
Uint32 | txMaxBlks | ||
) |
============================================================================
CSL_CPSW_setPortMaxBlocksReg
Description
This function sets up the contents of the Port Max Blocks Register corresponding to the MAC port specified.
Arguments
portNum MAC port number for which the max block numbers must be configured. rxMaxBlks Maximum number of 4K memory blocks that must be allocated for the port's FIFO logical receive priority queues. txMaxBlks Maximum number of 4K memory blocks that must be allocated for the port's FIFO logical transmit priority queues. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P_MAX_BLKS_REG_RX_MAX_BLKS, CPSW_5GF_P_MAX_BLKS_REG_TX_MAX_BLKS
Example
* Uint32 rxMaxBlks, txMaxBlks, portNum; portNum = 1; rxMaxBlks = 3; txMaxBlks = 17; CSL_CPSW_getPortMaxBlocksReg (portNum, rxMaxBlks, txMaxBlks);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortStatsEnableReg | ( | CSL_CPSW_PORTSTAT * | pPortStatsCfg | ) |
============================================================================
CSL_CPSW_setPortStatsEnableReg
Description
This function sets up the contents of the CPSW Port Statistics Enable register.
Arguments
pPortStatsCfg CSL_CPSW_PORTSTAT structure that contains the values to be used to setup port statistics enable register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_STAT_PORT_EN_REG_P0A_STAT_EN, CPSW_5GF_STAT_PORT_EN_REG_P0B_STAT_EN, CPSW_5GF_STAT_PORT_EN_REG_P1_STAT_EN, CPSW_5GF_STAT_PORT_EN_REG_P2_STAT_EN
Example
CSL_CPSW_PORTSTAT portStatsCfg; portStatsCfg.p0AStatEnable = 1; portStatsCfg.p0BStatEnable = 1; portStatsCfg.p1StatEnable = 1; portStatsCfg.p2StatEnable = 1; CSL_CPSW_setPortStatsEnableReg (&portStatsCfg);
=============================================================================
============================================================================
CSL_CPSW_setPortStatsEnableReg
Description
This function sets up the contents of the CPSW Port Statistics Enable register.
Arguments
pPortStatsCfg CSL_CPSW_PORTSTAT structure that contains the values to be used to setup port statistics enable register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_STAT_PORT_EN_REG_P0_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P1_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P2_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P3_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P4_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P5_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P6_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P7_STAT_EN, XGE_CPSW_STAT_PORT_EN_REG_P8_STAT_EN
Example
CSL_CPSW_PORTSTAT portStatsCfg; portStatsCfg.p0StatEnable = 1; portStatsCfg.p1StatEnable = 1; portStatsCfg.p2StatEnable = 1; ... CSL_CPSW_setPortStatsEnableReg (&portStatsCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortTimeSyncCntlReg | ( | Uint32 | portNum, |
CSL_CPSW_TSCNTL * | pTimeSyncCntlCfg | ||
) |
============================================================================
CSL_CPSW_setPortTimeSyncCntlReg
Description
This function sets up the contents of Time sync control register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be configured. pTimeSyncCntlCfg CSL_CPSW_TSCNTL containing settings for time sync control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P_TS_CTL_REG_TS_RX_EN, CPSW_5GF_P_TS_CTL_REG_TS_RX_VLAN_LTYPE1_EN, CPSW_5GF_P_TS_CTL_REG_TS_RX_VLAN_LTYPE2_EN, CPSW_5GF_P_TS_CTL_REG_TS_TX_EN, CPSW_5GF_P_TS_CTL_REG_TS_TX_VLAN_LTYPE1_EN, CPSW_5GF_P_TS_CTL_REG_TS_TX_VLAN_LTYPE2_EN, CPSW_5GF_P_TS_CTL_REG_TX_MSG_TYPE_EN_15_0
Example
* Uint32 portNum; CSL_CPSW_TSCNTL tsCtlCfg; portNum = 1; tsCtlCfg.tsRxEnable = 1; tsCtlCfg.tsRxVlanLType1Enable = 0; tsCtlCfg.tsRxVlanLType2Enable = 0; ... CSL_CPSW_setPortTimeSyncCntlReg (portNum, &tsCtlCfg);
=============================================================================
============================================================================
CSL_CPSW_setPortTimeSyncCntlReg
Description
This function sets up the contents of Time sync control register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be configured. pTimeSyncCntlCfg CSL_CPSW_TSCNTL containing settings for time sync control register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_PN_TS_CTL_REG_TS_RX_ANNEX_F_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_VLAN_LTYPE1_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_VLAN_LTYPE2_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_ANNEX_D_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_ANNEX_F_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_VLAN_LTYPE1_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_VLAN_LTYPE2_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_ANNEX_D_EN, XGE_CPSW_PN_TS_CTL_REG_TS_LTYPE2_EN, XGE_CPSW_PN_TS_CTL_REG_TS_RX_ANNEX_E_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_ANNEX_E_EN, XGE_CPSW_PN_TS_CTL_REG_TS_TX_HOST_TS_EN, XGE_CPSW_PN_TS_CTL_REG_TS_MSG_TYPE_EN
Example
* Uint32 portNum; CSL_CPSW_TSCNTL tsCtlCfg; portNum = 1; tsCtlCfg.tsRxVlanLType1Enable = 0; tsCtlCfg.tsRxVlanLType2Enable = 0; ... CSL_CPSW_setPortTimeSyncCntlReg (portNum, &tsCtlCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortTimeSyncSeqIdReg | ( | Uint32 | portNum, |
Uint32 | tsLtype, | ||
Uint32 | tsSeqIdOffset | ||
) |
============================================================================
CSL_CPSW_setPortTimeSyncSeqIdReg
Description
This function sets up the contents of Time Sync Sequence Id and LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be configured. tsLtype Time sync LTYPE to be configured. tsSeqIdOffset Time sync sequence Id offset to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P_TS_SEQ_LTYPE_REG_TS_LTYPE, CPSW_5GF_P_TS_SEQ_LTYPE_REG_TS_SEQ_ID_OFFSET
Example
* Uint32 portNum, tsLtype, tsSeqIdOffset; portNum = 1; tsLtype = 0; tsSeqIdOffset = 30; CSL_CPSW_getPortTimeSyncSeqIdReg (portNum, tsLtype, tsSeqIdOffset);
=============================================================================
============================================================================
CSL_CPSW_setPortTimeSyncSeqIdReg
Description
This function sets up the contents of Time Sync Sequence Id and LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be configured. (1-8) tsLtype Time sync LTYPE to be configured. tsSeqIdOffset Time sync sequence Id offset to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_PN_TS_SEQ_LTYPE_REG_TS_LTYPE1, XGE_CPSW_PN_TS_SEQ_LTYPE_REG_TS_SEQ_ID_OFFSET
Example
* Uint32 portNum, tsLtype, tsSeqIdOffset; portNum = 1; tsLtype = 0; tsSeqIdOffset = 30; CSL_CPSW_getPortTimeSyncSeqIdReg (portNum, tsLtype, tsSeqIdOffset);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortTimeSyncVlanLTypeReg | ( | Uint32 | portNum, |
Uint32 | tsVlanLtype1, | ||
Uint32 | tsVlanLtype2 | ||
) |
============================================================================
CSL_CPSW_setPortTimeSyncVlanLTypeReg
Description
This function sets up the contents of Time Sync VLAN LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. tsVlanLtype1 Time sync VLAN LTYPE1 value to be configured. tsVlanLtype2 Time sync VLAN LTYPE2 value to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE1, CPSW_5GF_P_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE2
Example
* Uint32 portNum, tsLtype1, tsLtype2; portNum = 1; tsLtype1 = 0x8100; tsLtype2 = 0x8100; CSL_CPSW_setPortTimeSyncVlanLTypeReg (portNum, &tsLtype1, &tsLtype2);
=============================================================================
============================================================================
CSL_CPSW_setPortTimeSyncVlanLTypeReg
Description
This function sets up the contents of Time Sync VLAN LTYPE register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the register must be read. (1-8) tsVlanLtype1 Time sync VLAN LTYPE1 value to be configured. tsVlanLtype2 Time sync VLAN LTYPE2 value to be configured. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_PN_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE1, XGE_CPSW_PN_TS_VLAN_LTYPE_REG_TS_VLAN_LTYPE2
Example
* Uint32 portNum, tsLtype1, tsLtype2; portNum = 1; tsLtype1 = 0x8100; tsLtype2 = 0x8100; CSL_CPSW_setPortTimeSyncVlanLTypeReg (portNum, &tsLtype1, &tsLtype2);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortTxPriMapReg | ( | Uint32 | portNum, |
Uint32 * | pPortTxPriMap | ||
) |
============================================================================
CSL_CPSW_setPortTxPriMapReg
Description
This function sets up the contents of the Port Transmit Header Priority to Switch Priority Mapping Register.
Arguments
portNum MAC port number for which the register contents must be configured. pPortTxPriMap Array of Port Tx priority map priority values that must be configured to the register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P_TX_PRI_MAP_REG_PRI0, CPSW_5GF_P_TX_PRI_MAP_REG_PRI1, CPSW_5GF_P_TX_PRI_MAP_REG_PRI2, CPSW_5GF_P_TX_PRI_MAP_REG_PRI3, CPSW_5GF_P_TX_PRI_MAP_REG_PRI4, CPSW_5GF_P_TX_PRI_MAP_REG_PRI5, CPSW_5GF_P_TX_PRI_MAP_REG_PRI6, CPSW_5GF_P_TX_PRI_MAP_REG_PRI7
Example
* Uint32 i, portTxPriMap [8], portNum; for (i = 0; i < 8; i ++) portTxPriMap [i] = i; portNum = 1; CSL_CPSW_setPortTxPriMapReg (portNum, portTxPriMap);
=============================================================================
============================================================================
CSL_CPSW_setPortTxPriMapReg
Description
This function sets up the contents of the Port Transmit Header Priority to Switch Priority Mapping Register.
Arguments
portNum MAC port number for which the register contents must be configured. pPortTxPriMap Array of Port Tx priority map priority values that must be configured to the register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_PN_TX_PRI_MAP_REG_PRI0, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI1, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI2, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI3, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI4, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI5, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI6, XGE_CPSW_PN_TX_PRI_MAP_REG_PRI7, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI0, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI1, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI2, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI3, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI4, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI5, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI6, XGE_CPSW_P0_TX_PRI_MAP_REG_PRI7
Example
* Uint32 i, portTxPriMap [8], portNum; for (i = 0; i < 8; i ++) portTxPriMap [i] = i; portNum = 1; CSL_CPSW_setPortTxPriMapReg (portNum, portTxPriMap);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPortVlanReg | ( | Uint32 | portNum, |
Uint32 | portVID, | ||
Uint32 | portCFI, | ||
Uint32 | portPRI | ||
) |
============================================================================
CSL_CPSW_setPortVlanReg
Description
This function sets up the contents of the VLAN Register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the VLAN register must be configured. portVID Port VLAN Id to be configured portCFI Port CFI bit to be configured portPRI Port VLAN priority to be configured (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_P_PORT_VLAN_REG_PORT_VID, CPSW_5GF_P_PORT_VLAN_REG_PORT_CFI, CPSW_5GF_P_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI, portNum; portNum = 2; portVID = 1; portCFI = 0; portPRI = 7; CSL_CPSW_setPortVlanReg (portNum, portVID, portCFI, portPRI);
=============================================================================
============================================================================
CSL_CPSW_setPortVlanReg
Description
This function sets up the contents of the VLAN Register corresponding to the MAC port number specified.
Arguments
portNum MAC port number for which the VLAN register must be configured. (1-8) portVID Port VLAN Id to be configured portCFI Port CFI bit to be configured portPRI Port VLAN priority to be configured (0-7, 7 is highest priority) *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_PN_PORT_VLAN_REG_PORT_VID, XGE_CPSW_PN_PORT_VLAN_REG_PORT_CFI, XGE_CPSW_PN_PORT_VLAN_REG_PORT_PRI
Example
* Uint32 portVID, portCFI, portPRI, portNum; portNum = 2; portVID = 1; portCFI = 0; portPRI = 7; CSL_CPSW_setPortVlanReg (portNum, portVID, portCFI, portPRI);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setPrioTypeReg | ( | CSL_CPSW_PTYPE * | pTypeCfg | ) |
============================================================================
CSL_CPSW_setPrioTypeReg
Description
This function modifies the contents of the CPSW Priority Type register.
Arguments
pTypeCfg CSL_CPSW_PTYPE structure that contains the values that need to be populated to Priority type register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_PTYPE_REG_ESC_PRI_LD_VAL, CPSW_5GF_PTYPE_REG_P0_PTYPE_ESC, CPSW_5GF_PTYPE_REG_P1_PTYPE_ESC, CPSW_5GF_PTYPE_REG_P2_PTYPE_ESC
Example
CSL_CPSW_PTYPE pTypeCfg; pTypeCfg.escPriLdVal = 1; pTypeCfg.p0PtypeEsc = 1; ... CSL_CPSW_setPrioTypeReg (&pTypeCfg);
=============================================================================
============================================================================
CSL_CPSW_setPrioTypeReg
Description
This function modifies the contents of the CPSW Priority Type register.
Arguments
pTypeCfg CSL_CPSW_PTYPE structure that contains the values that need to be populated to Priority type register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_PTYPE_REG_ESC_PRI_LD_VAL, XGE_CPSW_PTYPE_REG_P0_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P1_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P2_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P3_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P4_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P5_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P6_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P7_PTYPE_ESC, XGE_CPSW_PTYPE_REG_P8_PTYPE_ESC
Example
CSL_CPSW_PTYPE pTypeCfg; pTypeCfg.escPriLdVal = 1; pTypeCfg.p0PtypeEsc = 1; ... CSL_CPSW_setPrioTypeReg (&pTypeCfg);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setShortGapThreshold | ( | Uint32 | gapThreshVal | ) |
============================================================================
CSL_CPSW_setShortGapThreshold
Description
This function sets up the contents of the CPSW MAC Short Gap Threshold register.
Arguments
gapThreshVal Gap threshold value to use to configure the MAC Short gap threshold value. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_GAP_THRESH_CPGMAC_SL_REG_GAP_THRESH
Example
* Uint32 gapThreshVal; * * gapThreshVal = 11; CSL_CPSW_setShortGapThreshold (gapThreshVal);
=============================================================================
============================================================================
CSL_CPSW_setShortGapThreshold
Description
This function sets up the contents of the CPSW MAC Short Gap Threshold register.
Arguments
gapThreshVal Gap threshold value to use to configure the MAC Short gap threshold value. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_GAP_THRESH_REG_GAP_THRESH
Example
* Uint32 gapThreshVal; * * gapThreshVal = 11; CSL_CPSW_setShortGapThreshold (gapThreshVal);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_setTxStartWordsReg | ( | Uint32 | startWordsVal | ) |
============================================================================
CSL_CPSW_setTxStartWordsReg
Description
This function sets up the contents of the Transmit FIFO start words register.
Arguments
pStartWordsVal Start words value to be set to the Transmit FIFO start words register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_TX_START_WDS_REG_TX_START_WDS
Example
* Uint32 startWordsVal; * * startWordsVal = 32; CSL_CPSW_setTxStartWordsReg (startWordsVal);
=============================================================================
============================================================================
CSL_CPSW_setTxStartWordsReg
Description
This function sets up the contents of the Transmit FIFO start words register.
Arguments
pStartWordsVal Start words value to be set to the Transmit FIFO start words register. *
Return Value
None
Pre Condition
None
Post Condition
None
Writes
XGE_CPSW_TX_START_WDS_REG_TX_START_WDS
Example
* Uint32 startWordsVal; * * startWordsVal = 32; CSL_CPSW_setTxStartWordsReg (startWordsVal);
=============================================================================
CSL_IDEF_INLINE void CSL_CPSW_startAleAgeOutNow | ( | void | ) |
============================================================================
CSL_CPSW_startAleAgeOutNow
Description
This function configures the ALE control register to initiate an ALE ageable entry cleanup. This enables the ALE hardware to remove any ageable table entry that does not have a set touch bit.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
CPSW_5GF_ALE_CONTROL_REG_AGE_OUT_NOW=1
Example
CSL_CPSW_startAleAgeOutNow ();
=============================================================================
============================================================================
CSL_CPSW_startAleAgeOutNow
Description
This function configures the ALE control register to initiate an ALE ageable entry cleanup. This enables the ALE hardware to remove any ageable table entry that does not have a set touch bit.
Arguments
None
Return Value
None
Pre Condition
None
Post Condition
None
Writes
ALE_CONTROL_REG_AGE_OUT_NOW=1
Example
CSL_CPSW_startAleAgeOutNow ();
=============================================================================