# csl_cpsw_3gfAux.h File Reference

API Auxilary header file for Ethernet switch module CSL. More...

`#include <ti/csl/csl_cpsw_3gf.h>`

## Functions
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getCpswVersionInfo (CSL_CPSW_3GF_VERSION *pVersionInfo)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isFIFOLoopbackEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableFIFOLoopback (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableFIFOLoopback (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isVlanAwareEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableVlanAware (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableVlanAware (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isPort0Enabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enablePort0 (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disablePort0 (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isPort0PassPriTagEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enablePort0PassPriTag (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disablePort0PassPriTag (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isPort1PassPriTagEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enablePort1PassPriTag (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disablePort1PassPriTag (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isPort2PassPriTagEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enablePort2PassPriTag (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disablePort2PassPriTag (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getCpswControlReg (CSL_CPSW_3GF_CONTROL *pControlRegInfo)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setCpswControlReg (CSL_CPSW_3GF_CONTROL *pControlRegInfo)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getEmulationControlReg (Uint32 *pFree, Uint32 *pSoft)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setEmulationControlReg (Uint32 free, Uint32 soft)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortStatsEnableReg (CSL_CPSW_3GF_PORTSTAT *pPortStatsCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortStatsEnableReg (CSL_CPSW_3GF_PORTSTAT *pPortStatsCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPrioTypeReg (CSL_CPSW_3GF_PTYPE *pTypeCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPrioTypeReg (CSL_CPSW_3GF_PTYPE *pTypeCfg)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_getShortGapThreshold (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setShortGapThreshold (Uint32 gapThreshVal)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_getTxStartWordsReg (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setTxStartWordsReg (Uint32 startWordsVal)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getFlowControlReg (CSL_CPSW_3GF_FLOWCNTL *pFlowControlCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setFlowControlReg (CSL_CPSW_3GF_FLOWCNTL *pFlowControlCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getCppiSourceIdReg (Uint32 *pTxASrcId, Uint32 *pTxBSrcId)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setCppiSourceIdReg (Uint32 txASrcId, Uint32 txBSrcId)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPort0VlanReg (Uint32 *pPortVID, Uint32 *pPortCFI, Uint32 *pPortPRI)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPort0VlanReg (Uint32 portVID, Uint32 portCFI, Uint32 portPRI)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPort0RxPriMapReg (Uint32 *pPortRxPriMap)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPort0RxPriMapReg (Uint32 *pPortRxPriMap)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_getPort0RxMaxLen (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPort0RxMaxLen (Uint32 rxMaxLen)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortMaxBlocksReg (Uint32 portNum, Uint32 *pRxMaxBlks, Uint32 *pTxMaxBlks)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortMaxBlocksReg (Uint32 portNum, Uint32 rxMaxBlks, Uint32 txMaxBlks)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortBlockCountReg (Uint32 portNum, Uint32 *pRxBlkCnt, Uint32 *pTxBlkCnt)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortVlanReg (Uint32 portNum, Uint32 *pPortVID, Uint32 *pPortCFI, Uint32 *pPortPRI)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortVlanReg (Uint32 portNum, Uint32 portVID, Uint32 portCFI, Uint32 portPRI)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortTxPriMapReg (Uint32 portNum, Uint32 *pPortTxPriMap)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortTxPriMapReg (Uint32 portNum, Uint32 *pPortTxPriMap)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortMACAddress (Uint32 portNum, Uint8 *pMacAddress)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortMACAddress (Uint32 portNum, Uint8 *pMacAddress)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortTimeSyncCntlReg (Uint32 portNum, CSL_CPSW_3GF_TSCNTL *pTimeSyncCntlCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortTimeSyncCntlReg (Uint32 portNum, CSL_CPSW_3GF_TSCNTL *pTimeSyncCntlCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortTimeSyncSeqIdReg (Uint32 portNum, Uint32 *pTsLtype, Uint32 *pTsSeqIdOffset)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortTimeSyncSeqIdReg (Uint32 portNum, Uint32 tsLtype, Uint32 tsSeqIdOffset)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getPortTimeSyncVlanLTypeReg (Uint32 portNum, Uint32 *pTsVlanLtype1, Uint32 *pTsVlanLtype2)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setPortTimeSyncVlanLTypeReg (Uint32 portNum, Uint32 tsVlanLtype1, Uint32 tsVlanLtype2)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getStats (CSL_CPSW_3GF_STATS *pCpswStats)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleVersionInfo (CSL_CPSW_3GF_ALE_VERSION *pVersionInfo)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleRateLimitEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleRateLimit (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleRateLimit (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleMacAuthModeEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleMacAuthMode (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleMacAuthMode (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleVlanAwareEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleVlanAware (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleVlanAware (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleTxRateLimitEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleTxRateLimit (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleTxRateLimit (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleBypassEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleBypass (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleBypass (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleOUIDenyModeEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleOUIDenyMode (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleOUIDenyMode (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleVID0ModeEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleVID0Mode (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleVID0Mode (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleLearnNoVIDEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAleLearnNoVID (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAleLearnNoVID (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_startAleAgeOutNow (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleAgeOutDone (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_clearAleTable (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_isAleEnabled (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_enableAle (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_disableAle (void)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_getAleControlReg (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleControlReg (Uint32 aleCtrlVal)
CSL_IDEF_INLINE Uint32 | CSL_CPSW_3GF_getAlePrescaleReg (void)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAlePrescaleReg (Uint32 alePrescaleVal)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleUnkownVlanReg (Uint32 *pUnVlanMemList, Uint32 *pUnMcastFloodMask, Uint32 *pUnRegMcastFloodMask, Uint32 *pUnForceUntagEgress)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleUnkownVlanReg (Uint32 unVlanMemList, Uint32 unMcastFloodMask, Uint32 unRegMcastFloodMask, Uint32 unForceUntagEgress)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleTableEntry (Uint32 index, Uint32 *pAleInfoWd0, Uint32 *pAleInfoWd1, Uint32 *pAleInfoWd2)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleTableEntry (Uint32 index, Uint32 aleInfoWd0, Uint32 aleInfoWd1, Uint32 aleInfoWd2)
CSL_IDEF_INLINE CSL_CPSW_3GF_ALE_ENTRYTYPE | CSL_CPSW_3GF_getALEEntryType (Uint32 index)
CSL_IDEF_INLINE CSL_CPSW_3GF_ALE_ADDRTYPE | CSL_CPSW_3GF_getALEAddressType (Uint32 index)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleMcastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_MCASTADDR_ENTRY *pMcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleMcastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_MCASTADDR_ENTRY *pMcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleVlanMcastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_VLANMCASTADDR_ENTRY *pVlanMcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleVlanMcastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_VLANMCASTADDR_ENTRY *pVlanMcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleUnicastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_UNICASTADDR_ENTRY *pUcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleUnicastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_UNICASTADDR_ENTRY *pUcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleOUIAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_OUIADDR_ENTRY *pOUIAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleOUIAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_OUIADDR_ENTRY *pOUIAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleVlanUnicastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_VLANUNICASTADDR_ENTRY *pVlanUcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleVlanUnicastAddrEntry (Uint32 index, CSL_CPSW_3GF_ALE_VLANUNICASTADDR_ENTRY *pVlanUcastAddrCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAleVlanEntry (Uint32 index, CSL_CPSW_3GF_ALE_VLAN_ENTRY *pVlanCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAleVlanEntry (Uint32 index, CSL_CPSW_3GF_ALE_VLAN_ENTRY *pVlanCfg)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_clearAleEntry (Uint32 index)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_getAlePortControlReg (Uint32 portNo, CSL_CPSW_3GF_ALE_PORTCONTROL *pPortControlInfo)
CSL_IDEF_INLINE void | CSL_CPSW_3GF_setAlePortControlReg (Uint32 portNo, CSL_CPSW_3GF_ALE_PORTCONTROL *pPortControlInfo)

## Detailed Description

API Auxilary header file for Ethernet switch module CSL.

Contains the different control command and status query functions definations

  ============================================================================
  (C) Copyright 2009, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright 2012, Texas Instruments Incorporated