cpsw_ale_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_ALE_PRIV_H_
#define CPSW_ALE_PRIV_H_

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

#include <ti/csl/csl_cpswitch.h>
#include <ti/drv/enet/include/core/enet_mod_fdb.h>
#include <ti/drv/enet/include/mod/cpsw_ale.h>

#ifdef __cplusplus
extern "C" {
#endif

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

#define CPSW_ALE_FEATURE_FLOW_PRIORITY        (ENET_BIT(0U))

#define CPSW_ALE_FEATURE_IP_HDR_WHITELIST     (ENET_BIT(1U))

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

typedef enum CpswAle_AddrType_e
{
    CPSW_ALE_ADDR_TYPE_SRC,

    CPSW_ALE_ADDR_TYPE_DST
} CpswAle_AddrType;

typedef struct CpswAle_Obj_s
{
    EnetMod_Obj enetMod;

    uint32_t numPorts;

    CSL_CPSW_ALETABLE_TYPE tableType;

    Enet_Type enetType;

    uint32_t instId;

    bool pvidEn;

    CpswAle_RxFilter rxFilter;

    bool softTimerActive;

    uint32_t softTickCnt;

    uint32_t tickTimeoutCnt;

    uint32_t aleFreqHz;

    CpswAle_PortVlanCfg pvid[CPSW_ALE_NUM_PORTS];
} CpswAle_Obj;

typedef CpswAle_Obj *CpswAle_Handle;

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

/* None */

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

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

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

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

void CpswAle_close(EnetMod_Handle hMod);

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

/* None */

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

/* None */

#ifdef __cplusplus
}
#endif

#endif /* CPSW_ALE_PRIV_H_ */