enet_mod_port.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_PORT_H_
#define ENET_MOD_PORT_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_ioctl.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct EnetPort_VlanCfg_s
{
    uint32_t portPri;
 
    uint32_t portCfi;
 
    uint32_t portVID;
} EnetPort_VlanCfg;
 
typedef enum EnetPort_EgressPriorityType_e
{
    ENET_EGRESS_PRI_TYPE_FIXED = 0U,
 
    ENET_EGRESS_PRI_TYPE_ESCALATE,
} EnetPort_EgressPriorityType;
 
typedef struct EnetPort_TrafficShapingRates_s
{
    uint64_t committedRateBitsPerSec;
 
    uint64_t excessRateBitsPerSec;
} EnetPort_TrafficShapingRates;
 
typedef struct EnetPort_CreditBasedShapingCfg_s
{
    uint32_t queueNum;
 
    uint64_t idleSlope;
} EnetPort_CreditBasedShapingCfg;
 
typedef struct EnetPort_TrafficShapingCfg_s
{
    EnetPort_TrafficShapingRates rates[ENET_PRI_NUM];
} EnetPort_TrafficShapingCfg;
 
typedef struct EnetPort_PriorityMap_s
{
    uint32_t priorityMap[ENET_PRI_NUM];
} EnetPort_PriorityMap;
 
typedef struct EnetPort_DscpPriorityMap_s
{
    uint32_t tosMap[ENET_TOS_PRI_NUM];
 
    bool dscpIPv4En;
 
    bool dscpIPv6En;
} EnetPort_DscpPriorityMap;
 
typedef struct EnetPort_MaxLen_s
{
    uint32_t mtu[ENET_PRI_NUM];
 
    uint32_t mru;
} EnetPort_MaxLen;
 
#if ENET_CFG_IS_ON(CPSW_CUTTHRU)
typedef struct EnetPort_CutThruParams_s
{
    bool portSpeedAutoEn;
 
    uint32_t rxPriCutThruEn;
 
    uint32_t txPriCutThruEn;
} EnetPort_CutThruParams;
#endif
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_MOD_PORT_H_ */