# csl_cpsw_3gf.h File Reference

Header file containing various enumerations, structure definitions and function declarations for the Ethernet switch submodule (CPSW_3GF) of EMAC. More...

`#include <ti/csl/soc.h>`
`#include <ti/csl/csl.h>`
`#include <ti/csl/cslr_cpsw_3gf.h>`

## Data Structures
struct | CSL_CPSW_3GF_VERSION
| Holds the Time sync submodule's version info. More...
struct | CSL_CPSW_3GF_CONTROL
| Holds CPSW control register contents. More...
struct | CSL_CPSW_3GF_PORTSTAT
| Holds Port Statistics Enable register contents. More...
struct | CSL_CPSW_3GF_PTYPE
| Holds Priority type register contents. More...
struct | CSL_CPSW_3GF_FLOWCNTL
| Holds flow control register contents. More...
struct | CSL_CPSW_3GF_TSCNTL
| Holds Port Time Sync Control register contents. More...
struct | CSL_CPSW_3GF_STATS
| Holds the EMAC statistics. More...
struct | CSL_CPSW_3GF_ALE_VERSION
| Holds the ALE submodule's version info. More...
struct | CSL_CPSW_3GF_ALE_PORTCONTROL
| Holds the ALE Port control register info. More...
struct | CSL_CPSW_3GF_ALE_MCASTADDR_ENTRY
| Holds the ALE Multicast Address Table entry configuration. More...
struct | CSL_CPSW_3GF_ALE_VLANMCASTADDR_ENTRY
| Holds the ALE VLAN/Multicast Address Table entry configuration. More...
struct | CSL_CPSW_3GF_ALE_UNICASTADDR_ENTRY
| Holds the ALE Unicast Address Table entry configuration. More...
struct | CSL_CPSW_3GF_ALE_OUIADDR_ENTRY
| Holds the ALE OUI Unicast Address Table entry configuration. More...
struct | CSL_CPSW_3GF_ALE_VLANUNICASTADDR_ENTRY
| Holds the ALE VLAN Unicast Address Table entry configuration. More...
struct | CSL_CPSW_3GF_ALE_VLAN_ENTRY
| Holds the ALE VLAN Table entry configuration. More...
## Defines
#define | hCpsw3gfRegs ((CSL_Cpsw_3gfRegs *) (CSL_PA_SS_CFG_REGS + 0x00090800))
| Pointer to the Ethernet Switch overlay registers.
#define | CSL_CPSW_3GF_NUMSTATBLOCKS 2
| Number of statistic blocks.
#define | CSL_CPSW_3GF_NUMSTATS 36
| Number of hardware statistics registers.
#define | CSL_CPSW_3GF_NUMALE_ENTRIES 1024
| Maximum number of ALE entries that can be programmed.
#define | CSL_CPSW_3GF_ALECONTROL_RATELIMIT_EN (1 << 0u)
| ALE control register configuration definitions.
#define | CSL_CPSW_3GF_ALECONTROL_AUTHMODE_EN (1 << 1u)
#define | CSL_CPSW_3GF_ALECONTROL_VLANAWARE_EN (1 << 2u)
#define | CSL_CPSW_3GF_ALECONTROL_RATELIMIT_TX_EN (1 << 3u)
#define | CSL_CPSW_3GF_ALECONTROL_OUIDENY_EN (1 << 5u)
#define | CSL_CPSW_3GF_ALECONTROL_VID0MODE_EN (1 << 6u)
#define | CSL_CPSW_3GF_ALECONTROL_LEARN_NO_VID_EN (1 << 7u)
#define | CSL_CPSW_3GF_ALECONTROL_AGEOUT_NOW_EN (1 << 29u)
#define | CSL_CPSW_3GF_ALECONTROL_CLRTABLE_EN (1 << 30u)
#define | CSL_CPSW_3GF_ALECONTROL_ALE_EN (1 << 31u)
#define | CSL_CPSW_3GF_PORTMASK_PORT0_EN (1 << 0u)
| Port Mask definitions.
#define | CSL_CPSW_3GF_PORTMASK_PORT1_EN (1 << 1u)
#define | CSL_CPSW_3GF_PORTMASK_PORT2_EN (1 << 2u)
## Enumerations
enum | CSL_CPSW_3GF_ALE_PORTSTATE
| Defines ALE port states.
enum | CSL_CPSW_3GF_ALE_ENTRYTYPE
| Defines ALE Table Entry types.
enum | CSL_CPSW_3GF_ALE_UCASTTYPE
| Defines ALE Unicast types.
enum | CSL_CPSW_3GF_ALE_ADDRTYPE
| Defines ALE Address types.

## Detailed Description

Header file containing various enumerations, structure definitions and function declarations for the Ethernet switch submodule (CPSW_3GF) of EMAC.

  ============================================================================
  (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