cpsw_macport_priv.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_PRIV_H_
#define CPSW_MACPORT_PRIV_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#if ENET_CFG_IS_ON(CPSW_MACPORT_EST)
#include <ti/drv/enet/include/core/enet_mod_tas.h>
#endif
#include <ti/drv/enet/include/core/enet_mod_macport.h>
#include <ti/drv/enet/include/mod/cpsw_macport.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */

#define CPSW_MACPORT_PRIVATE_IOCTL(x)         (ENET_IOCTL_TYPE_PRIVATE | \
                                               ENET_IOCTL_MACPORT_BASE | \
                                               ENET_IOCTL_PER_CPSW |     \
                                               ENET_IOCTL_MIN(x))

#define CPSW_MACPORT_FEATURE_SGMII            (ENET_BIT(0U))

#define CPSW_MACPORT_FEATURE_INTERVLAN        (ENET_BIT(1U))

#define CPSW_MACPORT_FEATURE_EST              (ENET_BIT(2U))

#define CPSW_MACPORT_ERRATA_SOFTRESET         (ENET_BIT(0U))

#define CPSW_MACPORT_INTERVLAN_ROUTEID_BASE   (1U)

#define CPSW_MACPORT_INTERVLAN_ROUTE_MAX      (CPSW_MACPORT_INTERVLAN_ROUTEID_LAST - \
                                               CPSW_MACPORT_INTERVLAN_ROUTEID_FIRST + 1U)

#define CPSW_MACPORT_INTERVLAN_ROUTE2PTR(routeId) (CPSW_MACPORT_INTERVLAN_ROUTEID_BASE + \
                                                   (routeId) - CPSW_MACPORT_INTERVLAN_ROUTEID_FIRST)

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

typedef enum CpswMacPort_PrivIoctls_e
{
    CPSW_MACPORT_IOCTL_ENABLE = CPSW_MACPORT_PRIVATE_IOCTL(0U),

    CPSW_MACPORT_IOCTL_DISABLE = CPSW_MACPORT_PRIVATE_IOCTL(1U),

    CPSW_MACPORT_IOCTL_SET_INTERVLAN_ROUTE = CPSW_MACPORT_PRIVATE_IOCTL(2U),

    CPSW_MACPORT_IOCTL_SET_SPECIFIC_INTERVLAN_ROUTE = CPSW_MACPORT_PRIVATE_IOCTL(3U),

    CPSW_MACPORT_IOCTL_GET_INTERVLAN_ROUTE = CPSW_MACPORT_PRIVATE_IOCTL(4U),

    CPSW_MACPORT_IOCTL_DELETE_INTERVLAN_ROUTE = CPSW_MACPORT_PRIVATE_IOCTL(5U),

    CPSW_MACPORT_IOCTL_GET_INTERVLAN_FREEROUTES = CPSW_MACPORT_PRIVATE_IOCTL(6U),

    CPSW_MACPORT_IOCTL_FIND_INTERVLAN_ROUTE = CPSW_MACPORT_PRIVATE_IOCTL(7U),

    CPSW_MACPORT_IOCTL_IS_INTERVLAN_ROUTE_FREE = CPSW_MACPORT_PRIVATE_IOCTL(8U),

    CPSW_MACPORT_IOCTL_SET_SHORT_IPG = CPSW_MACPORT_PRIVATE_IOCTL(9U),

    CPSW_MACPORT_IOCTL_GET_SHORT_IPG = CPSW_MACPORT_PRIVATE_IOCTL(10U),

    CPSW_MACPORT_IOCTL_GET_SGMII_AUTONEG_LINK_STATUS = CPSW_MACPORT_PRIVATE_IOCTL(11U),

    CPSW_MACPORT_IOCTL_GET_SGMII_LINK_STATUS = CPSW_MACPORT_PRIVATE_IOCTL(12U),
} CpswMacPort_PrivIoctls;

typedef struct CpswMacPort_SetSpecificInterVlanRouteInArgs_s
{
    CpswMacPort_InterVlanRouteId routeId;

    CpswMacPort_InterVlanRoutingCfg routeCfg;
} CpswMacPort_SetSpecificInterVlanRouteInArgs;

typedef struct CpswMacPort_InterVlanFreeRouteInfo_s
{
    uint32_t numFreeRoutes;

    CpswMacPort_InterVlanRouteId freeRouteId[CPSW_MACPORT_INTERVLAN_ROUTE_MAX];
} CpswMacPort_InterVlanFreeRouteInfo;

typedef struct CpswMacPort_ModCfg_s
{
    CpswMacPort_Cfg macCfg;

    EnetMacPort_Interface mii;

    EnetMacPort_LinkCfg linkCfg;
} CpswMacPort_ModCfg;

typedef struct CpswMacPort_Obj_s
{
    EnetMod_Obj enetMod;

    Enet_MacPort macPort;

    Enet_Type enetType;

    uint32_t instId;

    bool enabled;

    EnetMacPort_LinkCfg linkCfg;

#if ENET_CFG_IS_ON(CPSW_MACPORT_EST)

    EnetTas_TasState state;

    EnetTas_ControlList adminList;

    EnetTas_ControlList operList;

    bool estBufUpper;

    EnetTas_ConfigStatus configStatus;
#endif
} CpswMacPort_Obj;

typedef CpswMacPort_Obj *CpswMacPort_Handle;

/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

int32_t CpswMacPort_open(EnetMod_Handle hMod,
                         Enet_Type enetType,
                         uint32_t instId,
                         const void *cfg,
                         uint32_t cfgSize);

int32_t CpswMacPort_rejoin(EnetMod_Handle hMod,
                           Enet_Type enetType,
                           uint32_t instId);

int32_t CpswMacPort_ioctl(EnetMod_Handle hMod,
                          uint32_t cmd,
                          Enet_IoctlPrms *prms);

void CpswMacPort_close(EnetMod_Handle hMod);

/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* CPSW_MACPORT_PRIV_H_ */