icssg_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 ICSSG_PRIV_H_
#define ICSSG_PRIV_H_

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

#include <stdint.h>
#include <ti/drv/pruss/pruicss.h>
#include <ti/drv/enet/priv/core/enet_base_priv.h>
#include <ti/drv/enet/priv/mod/mdio_priv.h>
#include <ti/drv/enet/priv/mod/icssg_timesync_priv.h>
#include <ti/drv/enet/priv/mod/icssg_stats_priv.h>
#include <ti/drv/enet/priv/mod/icssg_tas_priv.h>
#include <ti/drv/enet/enet.h>
#include <ti/drv/enet/include/core/enet_per.h>
#include <ti/drv/enet/include/core/enet_types.h>
#include <ti/drv/enet/include/mod/mdio.h>
#include <ti/drv/enet/include/phy/enetphy.h>
#include <ti/drv/enet/include/core/enet_mod_phy.h>
#include <ti/drv/enet/priv/core/enet_rm_priv.h>

#ifdef __cplusplus
extern "C" {
#endif

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

#define ICSSG_PRUSS_ID_0                          (0U)

#define ICSSG_PRUSS_ID_1                          (1U)

#define ICSSG_PRUSS_ID_2                          (2U)

#define ICSSG_CACHELINE_ALIGNMENT                 (64U)

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
typedef struct Icssg_evtCbInfo_s
{
    Enet_EventCallback evtCb;

    void *evtCbArgs;
} Icssg_evtCbInfo;

typedef struct Icssg_Pruss_s
{
    PRUICSS_Handle hPruss;

    uint32_t instance;

    bool initialized;

    bool iep0InUse;

    void *lock;
} Icssg_Pruss;

typedef struct Icssg_Fw_s
{
    const uint32_t *pru;

    uint32_t pruSize;

    const uint32_t *rtu;

    uint32_t rtuSize;

    const uint32_t *txpru;

    uint32_t txpruSize;
} Icssg_Fw;

typedef struct Icssg_FwPoolMem_s
{
    uint8_t *portBufferPoolMem;

    uint32_t portBufferPoolSize;

    uint32_t portBufferPoolNum;

    uint8_t *hostBufferPoolMem;

    uint32_t hostBufferPoolSize;

    uint32_t hostBufferPoolNum;

    uint8_t *hostEgressQueueMem;

    uint8_t *hostEgressPreQueueMem;

    uint32_t hostEgressQueueSize;

    uint32_t hostEgressPreQueueSize;

    uint32_t hostEgressQueueNum;

    uint8_t *scratchBufferMem;

    uint32_t scratchBufferSize;
} Icssg_FwPoolMem;

typedef struct Icssg_IoctlCmd_s
{
    uint8_t param;

    uint8_t seqNum;

    uint8_t type;

    uint8_t header;

    uint32_t spare[3];
} __attribute__((packed)) Icssg_IoctlCmd;

typedef struct Icssg_IoctlCmdResp_s
{
    uint8_t status;

    uint8_t seqNum;

    uint32_t paramsLen;

    uint32_t params[3U];
} Icssg_IoctlCmdResp;

typedef struct Icssg_Obj_s
{
    EnetPer_Obj enetPer;

    Icssg_Pruss *pruss;

    Icssg_Fw fw[ICSSG_MAC_PORT_MAX];

    Icssg_FwPoolMem fwPoolMem[ICSSG_MAC_PORT_MAX];

    uint8_t asyncIoctlSeqNum;

    uint32_t asyncIoctlType;

    Icssg_evtCbInfo asyncCmdRespCbEvtInfo;

    Icssg_evtCbInfo txTsCbEvtInfo;

    EnetRm_Obj rmObj;

    EnetMod_Handle hRm;

    uint32_t selfCoreId;

    EnetDma_Handle hDma;

    uint32_t numRxCh;

    EnetDma_RxChHandle hRxRsvdFlow[ICSSG_MAC_PORT_MAX];

    Enet_dmaResInfo dmaResInfo[ICSSG_MAC_PORT_MAX];

    uint32_t rsvdFlowId[ICSSG_MAC_PORT_MAX];

    Mdio_Obj mdioObj;

    EnetMod_Handle hMdio;

    EnetPhy_Handle hPhy[ICSSG_MAC_PORT_MAX];

    IcssgTimeSync_Obj timeSyncObj;

    EnetMod_Handle hTimeSync;

    IcssgStats_Obj statsObj;

    EnetMod_Handle hStats;

    IcssgTas_Obj tasObj[ICSSG_MAC_PORT_MAX];

    EnetMod_Handle hTas[ICSSG_MAC_PORT_MAX];

    Icssg_IoctlCmd cmd __attribute__ ((aligned(ICSSG_CACHELINE_ALIGNMENT)));

    uint32_t cycleTimeNs;
} Icssg_Obj;

typedef Icssg_Obj *Icssg_Handle;

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

/* None */

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

void Icssg_initCfg(EnetPer_Handle hPer,
                   Enet_Type enetType,
                   void *cfg,
                   uint32_t cfgSize);

int32_t Icssg_open(EnetPer_Handle hPer,
                   Enet_Type enetType,
                   uint32_t instId,
                   const void *cfg,
                   uint32_t cfgSize);

int32_t Icssg_rejoin(EnetPer_Handle hPer,
                     Enet_Type enetType,
                     uint32_t instId);

int32_t Icssg_ioctl(EnetPer_Handle hPer,
                    uint32_t cmd,
                    Enet_IoctlPrms *prms);

void Icssg_poll(EnetPer_Handle hPer,
                Enet_Event evt,
                const void *arg,
                uint32_t argSize);

uint64_t Icssg_convertTs(EnetPer_Handle hPer,
                         uint64_t ts);

void Icssg_periodicTick(EnetPer_Handle hPer);

void Icssg_registerEventCb(EnetPer_Handle hPer,
                           Enet_Event evt,
                           uint32_t evtNum,
                           Enet_EventCallback evtCb,
                           void *evtCbArgs);

void Icssg_unregisterEventCb(EnetPer_Handle hPer,
                             Enet_Event evt,
                             uint32_t evtNum);

void Icssg_close(EnetPer_Handle hPer);

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

/* None */

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

/* None */

#ifdef __cplusplus
}
#endif

#endif /* ICSSG_PRIV_H_ */