enet_mod_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 ENET_MOD_MACPORT_H_
#define ENET_MOD_MACPORT_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_mod.h>
#include <include/core/enet_mod_port.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_MACPORT_PUBLIC_IOCTL(x)          (ENET_IOCTL_TYPE_PUBLIC |  \
                                               ENET_IOCTL_MACPORT_BASE | \
                                               ENET_IOCTL_MIN(x))
 
#define ENET_MACPORT_PRIVATE_IOCTL(x)         (ENET_IOCTL_TYPE_PRIVATE | \
                                              ENET_IOCTL_MACPORT_BASE |    \
                                              ENET_IOCTL_MIN(x))
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum EnetMacPort_Ioctl_e
{
    ENET_MACPORT_IOCTL_GET_VERSION = ENET_MACPORT_PUBLIC_IOCTL(0U),
 
    ENET_MACPORT_IOCTL_PRINT_REGS = ENET_MACPORT_PUBLIC_IOCTL(1U),
 
    ENET_MACPORT_IOCTL_SET_INGRESS_DSCP_PRI_MAP = ENET_MACPORT_PUBLIC_IOCTL(2U),
 
    ENET_MACPORT_IOCTL_GET_INGRESS_DSCP_PRI_MAP = ENET_MACPORT_PUBLIC_IOCTL(3U),
 
    ENET_MACPORT_IOCTL_SET_PRI_REGEN_MAP = ENET_MACPORT_PUBLIC_IOCTL(4U),
 
    ENET_MACPORT_IOCTL_GET_PRI_REGEN_MAP = ENET_MACPORT_PUBLIC_IOCTL(5U),
 
    ENET_MACPORT_IOCTL_SET_EGRESS_QOS_PRI_MAP = ENET_MACPORT_PUBLIC_IOCTL(6U),
 
    ENET_MACPORT_IOCTL_GET_EGRESS_QOS_PRI_MAP = ENET_MACPORT_PUBLIC_IOCTL(7U),
 
    ENET_MACPORT_IOCTL_ENABLE_EGRESS_TRAFFIC_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(8U),
 
    ENET_MACPORT_IOCTL_DISABLE_EGRESS_TRAFFIC_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(9U),
 
    ENET_MACPORT_IOCTL_GET_EGRESS_TRAFFIC_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(10U),
 
    ENET_MACPORT_IOCTL_GET_MAXLEN = ENET_MACPORT_PUBLIC_IOCTL(11U),
 
    ENET_MACPORT_IOCTL_GET_LINK_CFG = ENET_MACPORT_PUBLIC_IOCTL(12U),
 
    ENET_MACPORT_IOCTL_SET_CREDIT_BASED_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(13U),
 
    ENET_MACPORT_IOCTL_GET_CREDIT_BASED_SHAPING = ENET_MACPORT_PUBLIC_IOCTL(14U),
 
    ENET_MACPORT_IOCTL_IET_RELEASE_PREEMPT_TRAFFIC = ENET_MACPORT_PUBLIC_IOCTL(15U),
 
    ENET_MACPORT_IOCTL_IET_HOLD_PREEMPT_TRAFFIC = ENET_MACPORT_PUBLIC_IOCTL(16U),
 
    ENET_MACPORT_IOCTL_GET_QUEUE_PREEMPT_STATUS = ENET_MACPORT_PUBLIC_IOCTL(17U),
 
    ENET_MACPORT_IOCTL_SET_PREEMPT_QUEUE = ENET_MACPORT_PUBLIC_IOCTL(18U),
 
    ENET_MACPORT_IOCTL_GET_PREEMPT_MIN_FRAG_SIZE = ENET_MACPORT_PUBLIC_IOCTL(19U),
 
    ENET_MACPORT_IOCTL_SET_PREEMPT_MIN_FRAG_SIZE = ENET_MACPORT_PUBLIC_IOCTL(20U),
 
    ENET_MACPORT_IOCTL_GET_PREEMPT_VERIFY_STATUS = ENET_MACPORT_PUBLIC_IOCTL(21U),
 
    ENET_MACPORT_IOCTL_DISABLE_PREEMPT_VERIFICATION = ENET_MACPORT_PUBLIC_IOCTL(22U),
 
    ENET_MACPORT_IOCTL_ENABLE_PREEMPT_VERIFICATION = ENET_MACPORT_PUBLIC_IOCTL(23U),
 
    ENET_MACPORT_IOCTL_GET_PREEMPTION_ACTIVE_STATUS = ENET_MACPORT_PUBLIC_IOCTL(24U),
 
    ENET_MACPORT_IOCTL_GET_PREEMPTION_ENABLE_STATUS = ENET_MACPORT_PUBLIC_IOCTL(25U),
 
    ENET_MACPORT_IOCTL_DISABLE_PREEMPTION = ENET_MACPORT_PUBLIC_IOCTL(26U),
 
    ENET_MACPORT_IOCTL_ENABLE_PREEMPTION = ENET_MACPORT_PUBLIC_IOCTL(27U),
 
#if ENET_CFG_IS_ON(CPSW_CUTTHRU)
 
    ENET_MACPORT_IOCTL_SET_CUT_THRU_PARAMS = ENET_MACPORT_PUBLIC_IOCTL(28U),
 
    ENET_MACPORT_IOCTL_GET_CUT_THRU_PARAMS = ENET_MACPORT_PUBLIC_IOCTL(29U),
#endif
} EnetMacPort_Ioctl;
 
typedef enum EnetMac_LayerType_e
{
    ENET_MAC_LAYER_MII   = 1U,
 
    ENET_MAC_LAYER_GMII  = 0U,
 
    ENET_MAC_LAYER_XGMII = 2U,
} EnetMac_LayerType;
 
typedef enum EnetMac_SublayerType_e
{
    ENET_MAC_SUBLAYER_STANDARD = 0U,
 
    ENET_MAC_SUBLAYER_REDUCED,
 
    ENET_MAC_SUBLAYER_SERIAL,
 
    ENET_MAC_SUBLAYER_QUAD_SERIAL_MAIN,
 
    ENET_MAC_SUBLAYER_QUAD_SERIAL_SUB,
} EnetMac_SublayerType;
 
typedef enum EnetMac_VariantType_e
{
    ENET_MAC_VARIANT_NONE = 0U,
 
    ENET_MAC_VARIANT_FORCED,
} EnetMac_VariantType;
 
typedef enum EnetMac_SgmiiMode_e
{
    ENET_MAC_SGMIIMODE_INVALID = 0U,
 
    ENET_MAC_SGMIIMODE_FIBER_WITH_PHY,
 
    ENET_MAC_SGMIIMODE_SGMII_WITH_PHY,
 
    ENET_MAC_SGMIIMODE_SGMII_AUTONEG_MASTER,
 
    ENET_MAC_SGMIIMODE_SGMII_AUTONEG_SLAVE,
 
    ENET_MAC_SGMIIMODE_SGMII_FORCEDLINK,
} EnetMac_SgmiiMode;
 
typedef struct EnetMacPort_Interface_s
{
    EnetMac_LayerType layerType;
 
    EnetMac_SublayerType sublayerType;
 
    EnetMac_VariantType variantType;
} EnetMacPort_Interface;
 
typedef struct EnetMacPort_LinkCfg_s
{
    Enet_Speed speed;
 
    Enet_Duplexity duplexity;
} EnetMacPort_LinkCfg;
 
typedef enum EnetMacPort_VlanType_e
{
    ENET_MACPORT_VLAN_TYPE_NONE = 0x00U,
 
    ENET_MACPORT_VLAN_TYPE_SINGLE_TAG = 0x01U,
 
    ENET_MACPORT_VLAN_TYPE_STACKED_TAGS = 0x02U,
} EnetMacPort_VlanType;
 
typedef struct EnetMacPort_GenericInArgs_s
{
    Enet_MacPort macPort;
} EnetMacPort_GenericInArgs;
 
typedef struct EnetMacPort_SetIngressDscpPriorityMapInArgs_s
{
    Enet_MacPort macPort;
 
    EnetPort_DscpPriorityMap dscpPriorityMap;
} EnetMacPort_SetIngressDscpPriorityMapInArgs;
 
typedef struct EnetMacPort_SetPriorityRegenMapInArgs_s
{
    Enet_MacPort macPort;
 
    EnetPort_PriorityMap priorityRegenMap;
} EnetMacPort_SetPriorityRegenMapInArgs;
 
typedef struct EnetMacPort_SetEgressPriorityMapInArgs_s
{
    Enet_MacPort macPort;
 
    EnetPort_PriorityMap priorityMap;
} EnetMacPort_SetEgressPriorityMapInArgs;
 
typedef struct EnetMacPort_EnableEgressTrafficShapingInArgs_s
{
    Enet_MacPort macPort;
 
    EnetPort_TrafficShapingCfg trafficShapingCfg;
} EnetMacPort_EnableEgressTrafficShapingInArgs;
 
typedef struct EnetMacPort_CreditBasedShaperInArgs_s
{
    Enet_MacPort macPort;
 
    EnetPort_CreditBasedShapingCfg cbsCfg;
} EnetMacPort_CreditBasedShaperInArgs;
 
typedef enum EnetMacPort_PreemptVerifyStatus_e
{
    ENET_MAC_VERIFYSTATUS_UNKNOWN = 0U,
 
    ENET_MAC_VERIFYSTATE_INITIAL,
 
    ENET_MAC_VERIFYSTATE_VERIFYING,
 
    ENET_MAC_VERIFYSTATUS_SUCCEEDED,
 
    ENET_MAC_VERIFYSTATUS_FAILED,
 
    ENET_MAC_VERIFYSTATUS_DISABLED,
 
    ENET_MAC_VERIFYSTATUS_RXRESPOND_ERROR,
 
    ENET_MAC_VERIFYSTATUS_RXVERIFY_ERROR,
} EnetMacPort_PreemptVerifyStatus;
 
typedef struct EnetMacPort_SetPreemptMinFragSizeInArgs_s
{
    Enet_MacPort macPort;
 
    uint8_t preemptMinFragSize;
} EnetMacPort_SetPreemptMinFragSizeInArgs;
 
typedef enum EnetMacPort_QueuePreemptMode_e
{
    ENET_MAC_QUEUE_PREEMPT_MODE_EXPRESS,
 
    ENET_MAC_QUEUE_PREEMPT_MODE_PREEMPT,
} EnetMacPort_QueuePreemptMode;
 
typedef struct EnetMacPort_QueuePreemptCfg_s
{
    EnetMacPort_QueuePreemptMode preemptMode[ENET_PRI_NUM];
} EnetMacPort_QueuePreemptCfg;
 
typedef struct EnetMacPort_SetPreemptQueueInArgs_s
{
    Enet_MacPort macPort;
 
    EnetMacPort_QueuePreemptCfg queuePreemptCfg;
} EnetMacPort_SetPreemptQueueInArgs;
 
#if ENET_CFG_IS_ON(CPSW_CUTTHRU)
 
typedef struct EnetMacPort_CutThruParams_s
{
    Enet_MacPort macPort;
 
    EnetPort_CutThruParams cutThruCfg;
} EnetMacPort_CutThruParams;
#endif
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
static inline bool EnetMacPort_isMii(const EnetMacPort_Interface *mii);
 
static inline bool EnetMacPort_isRmii(const EnetMacPort_Interface *mii);
 
static inline bool EnetMacPort_isGmii(const EnetMacPort_Interface *mii);
 
static inline bool EnetMacPort_isRgmii(const EnetMacPort_Interface *mii);
 
static inline bool EnetMacPort_isSgmii(const EnetMacPort_Interface *mii);
 
static inline bool EnetMacPort_isQsgmii(const EnetMacPort_Interface *mii);
 
static inline bool EnetMacPort_isXfi(const EnetMacPort_Interface *mii);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline bool EnetMacPort_isMii(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_MII) &&
           (mii->sublayerType == ENET_MAC_SUBLAYER_STANDARD);
}
 
static inline bool EnetMacPort_isRmii(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_MII) &&
           (mii->sublayerType == ENET_MAC_SUBLAYER_REDUCED);
}
 
static inline bool EnetMacPort_isGmii(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_GMII) &&
           (mii->sublayerType == ENET_MAC_SUBLAYER_STANDARD);
}
 
static inline bool EnetMacPort_isRgmii(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_GMII) &&
           (mii->sublayerType == ENET_MAC_SUBLAYER_REDUCED);
}
 
static inline bool EnetMacPort_isSgmii(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_GMII) &&
           (mii->sublayerType == ENET_MAC_SUBLAYER_SERIAL);
}
 
static inline bool EnetMacPort_isQsgmii(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_GMII) &&
           ((mii->sublayerType == ENET_MAC_SUBLAYER_QUAD_SERIAL_MAIN) ||
            (mii->sublayerType == ENET_MAC_SUBLAYER_QUAD_SERIAL_SUB));
}
 
static inline bool EnetMacPort_isXfi(const EnetMacPort_Interface *mii)
{
    return (mii->layerType == ENET_MAC_LAYER_XGMII) &&
           (mii->sublayerType == ENET_MAC_SUBLAYER_STANDARD);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_MOD_MACPORT_H_ */