cpsw_macport.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *
 *  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.
 */
 
#ifndef CPSW_MACPORT_H_
#define CPSW_MACPORT_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <include/core/enet_mod_macport.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define CPSW_MACPORT_PUBLIC_IOCTL(x)          (ENET_IOCTL_TYPE_PUBLIC |  \
                                               ENET_IOCTL_MACPORT_BASE | \
                                               ENET_IOCTL_PER_CPSW |     \
                                               ENET_IOCTL_MIN(x))
 
#define CPSW_MACPORT_EST_TIME_INTERVAL_MIN    (0x010U)
 
#define CPSW_MACPORT_EST_TIME_INTERVAL_MAX    (0x3FFFU)
 
#define CPSW_MACPORT_EST_TIME_STEP_1G         (8U)
 
#define CPSW_MACPORT_EST_TIME_STEP_100M       (40U)
 
#define CPSW_MACPORT_EST_TIME_STEP_10M        (400U)
 
#define CPSW_MACPORT_EST_TIME_MIN(speed)      (CPSW_MACPORT_EST_TIME_STEP_##speed * CPSW_MACPORT_EST_TIME_INTERVAL_MIN)
 
#define CPSW_MACPORT_EST_TIME_MAX(speed)      (CPSW_MACPORT_EST_TIME_STEP_##speed * CPSW_MACPORT_EST_TIME_INTERVAL_MAX)
 
#define CPSW_MACPORT_EST_ALLOWCNT_FACTOR_1G   (1U)
 
#define CPSW_MACPORT_EST_ALLOWCNT_FACTOR_100M (2U)
 
#define CPSW_MACPORT_EST_ALLOWCNT_FACTOR_10M  (2U)
 
#define CPSW_MACPORT_EST_GUARD_BAND(maxPktSize, speed)  (((((maxPktSize) + 4U) * \
                                                           CPSW_MACPORT_EST_ALLOWCNT_FACTOR_##speed) + 292U) * \
                                                         CPSW_MACPORT_EST_TIME_STEP_##speed)
 
#define CPSW_MACPORT_GIGABIT_IET_VERIFY_TIMEOUT_NS      (10*1000*1000)
 
#define CPSW_MACPORT_RX_MAX_BLKS_IET    (7U)
 
#define CPSW_MACPORT_TX_MAX_BLKS_IET    (13U)
 
#define CPSW_MACPORT_RX_MAX_BLKS_DEFAULT    (4U)
 
#define CPSW_MACPORT_TX_MAX_BLKS_DEFAULT    (16U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum CpswMacPort_Ioctl_s
{
    CPSW_MACPORT_IOCTL_GET_FIFO_STATS = CPSW_MACPORT_PUBLIC_IOCTL(0U),
 
    CPSW_MACPORT_IOCTL_ENABLE_CPTS_EVENT = CPSW_MACPORT_PUBLIC_IOCTL(1U),
 
    CPSW_MACPORT_IOCTL_DISABLE_CPTS_EVENT = CPSW_MACPORT_PUBLIC_IOCTL(2U),
 
    CPSW_MACPORT_IOCTL_EST_ENABLE_TIMESTAMP = CPSW_MACPORT_PUBLIC_IOCTL(3U),
 
    CPSW_MACPORT_IOCTL_EST_DISABLE_TIMESTAMP = CPSW_MACPORT_PUBLIC_IOCTL(4U),
} CpswMacPort_Ioctl;
 
typedef struct CpswMacPort_TxShortIpgCfg_s
{
    bool txShortGapEn;
 
    bool txShortGapLimitEn;
} CpswMacPort_TxShortIpgCfg;
 
typedef struct CpswMacPort_PortTxShortIpgCfg_s
{
    Enet_MacPort macPort;
 
    CpswMacPort_TxShortIpgCfg shortIpgCfg;
} CpswMacPort_PortTxShortIpgCfg;
 
typedef enum CpswMacPort_InterVlanRouteId_e
{
    CPSW_MACPORT_INTERVLAN_ROUTEID_FIRST,
 
    CPSW_MACPORT_INTERVLAN_ROUTEID_1    = CPSW_MACPORT_INTERVLAN_ROUTEID_FIRST,
 
    CPSW_MACPORT_INTERVLAN_ROUTEID_2,
 
    CPSW_MACPORT_INTERVLAN_ROUTEID_3,
 
    CPSW_MACPORT_INTERVLAN_ROUTEID_4,
 
    CPSW_MACPORT_INTERVLAN_ROUTEID_LAST = CPSW_MACPORT_INTERVLAN_ROUTEID_4
} CpswMacPort_InterVlanRouteId;
 
typedef struct CpswMacPort_InterVlanRoutingCfg_s
{
    uint8_t dstAddr[ENET_MAC_ADDR_LEN];
 
    uint8_t srcAddr[ENET_MAC_ADDR_LEN];
 
    uint32_t vlanId;
 
    bool replaceDASA;
 
    bool forceUntaggedEgress;
 
    bool decrementTTL;
} CpswMacPort_InterVlanRoutingCfg;
 
typedef struct CpswMacPort_FifoStats_s
{
    uint32_t rxThroughputRate;
 
    uint32_t txStartWords;
 
    uint32_t txMaxBlocks;
 
    uint32_t rxMaxBlocks;
 
    uint32_t txBlockCount;
 
    uint32_t rxExpressBlockCount;
 
    uint32_t rxPreemptBlockCount;
 
    bool txActiveFifo[ENET_PRI_NUM];
} CpswMacPort_FifoStats;
 
typedef struct CpswMacPort_IpTsCfg_s
{
    bool ttlNonzeroEn;
 
    bool unicastEn;
 
    bool tsIp129En;
 
    bool tsIp130En;
 
    bool tsIp131En;
 
    bool tsIp132En;
 
    bool tsIp107En;
 
    bool tsPort319En;
 
    bool tsPort320En;
} CpswMacPort_IpTsCfg;
 
typedef struct CpswMacPort_TsEventCfg_s
{
    bool txAnnexDEn;
 
    bool rxAnnexDEn;
 
    bool txAnnexEEn;
 
    bool rxAnnexEEn;
 
    bool txAnnexFEn;
 
    bool rxAnnexFEn;
 
    bool txHostTsEn;
 
    EnetMacPort_VlanType txVlanType;
 
    EnetMacPort_VlanType rxVlanType;
 
    uint32_t vlanLType1;
 
    uint32_t vlanLType2;
 
    CpswMacPort_IpTsCfg commonPortIpCfg;
 
    uint32_t mcastType;
 
    uint32_t messageType;
 
    bool ltype2En;
 
    uint32_t seqIdOffset;
 
    uint32_t domainOffset;
} CpswMacPort_TsEventCfg;
 
typedef struct CpswMacPort_EnableTsEventInArgs_s
{
    Enet_MacPort macPort;
 
    CpswMacPort_TsEventCfg tsEventCfg;
} CpswMacPort_EnableTsEventInArgs;
 
typedef enum CpswMacPort_EstTimestampMode_e
{
    CPSW_MACPORT_EST_TIMESTAMP_ALL,
 
    CPSW_MACPORT_EST_TIMESTAMP_ONEPRI,
 
    CPSW_MACPORT_EST_TIMESTAMP_FIRST,
 
    CPSW_MACPORT_EST_TIMESTAMP_FIRST_ONEPRI,
 
} CpswMacPort_EstTimestampMode;
 
typedef struct CpswMacPort_EstTimestampCfg_s
{
    Enet_MacPort macPort;
 
    CpswMacPort_EstTimestampMode mode;
 
    uint8_t priority;
 
    uint8_t domain;
} CpswMacPort_EstTimestampCfg;
 
typedef struct CpswMacPort_Cfg_s
{
    bool loopbackEn;
 
    Enet_CrcType crcType;
 
    uint32_t rxMtu;
 
    bool passPriorityTaggedUnchanged;
 
    EnetPort_VlanCfg vlanCfg;
 
    EnetPort_EgressPriorityType txPriorityType;
 
    EnetMac_SgmiiMode sgmiiMode;
} CpswMacPort_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void CpswMacPort_initCfg(CpswMacPort_Cfg *macPortCfg);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* CPSW_MACPORT_H_ */