cpsw_hostport.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_HOSTPORT_H_
#define CPSW_HOSTPORT_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <include/core/enet_mod_hostport.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define CPSW_HOSTPORT_PUBLIC_IOCTL(x)         (ENET_IOCTL_TYPE_PUBLIC |   \
                                               ENET_IOCTL_HOSTPORT_BASE | \
                                               ENET_IOCTL_PER_CPSW |      \
                                               ENET_IOCTL_MIN(x))
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum CpswHostPort_Ioctl_s
{
    CPSW_HOSTPORT_IOCTL_GET_FIFO_STATS = CPSW_HOSTPORT_PUBLIC_IOCTL(0U),
 
    CPSW_HOSTPORT_GET_FLOW_ID_OFFSET = CPSW_HOSTPORT_PUBLIC_IOCTL(1U),
} CpswHostPort_Ioctl;
 
 
typedef struct CpswHostPort_FifoStats_s
{
    uint32_t rxThroughputRate;
 
    uint32_t txBlockCount;
 
    uint32_t rxBlockCountExpress;
 
    uint32_t rxBlockCountPreempt;
 
    bool txActiveFifo[ENET_PRI_NUM];
} CpswHostPort_FifoStats;
 
typedef struct CpswHostPort_Cfg_s
{
    Enet_CrcType crcType;
 
    bool removeCrc;
 
    bool padShortPacket;
 
    bool passCrcErrors;
 
    uint32_t rxMtu;
 
    bool passPriorityTaggedUnchanged;
 
    bool csumOffloadEn;
 
    bool rxVlanRemapEn;
 
    bool rxDscpIPv4RemapEn;
 
    bool rxDscpIPv6RemapEn;
 
    EnetPort_VlanCfg vlanCfg;
 
    EnetHostPort_IngressPriorityType rxPriorityType;
 
    EnetPort_EgressPriorityType txPriorityType;
} CpswHostPort_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void CpswHostPort_initCfg(CpswHostPort_Cfg *hostPortCfg);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* CPSW_HOSTPORT_H_ */