sdl_tog.h

Go to the documentation of this file.

 
#ifndef SDL_TOG_H_
#define SDL_TOG_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stdbool.h>
#include "sdlr_tog.h"
#include <sdl/stog/v0/soc/sdl_tog_soc.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef uint8_t SDL_TOG_cfgCtrl;
#define SDL_TOG_CFG_TIMEOUT         0x01U
 
#define SDL_TOG_CFG_INTR_PENDING    0x02U
 
/* ========================================================================== */
/*                         Structures                                         */
/* ========================================================================== */
 
typedef struct
{
    uint32_t    routeId;
    uint32_t    orderId;
    uint32_t    dir;
    uint32_t    type;
    uint32_t    tag;
    uint32_t    commandId;
    uint32_t    orgByteCnt;
    uint32_t    currByteCnt;
    uint64_t    address;
} SDL_TOG_errInfo;
 
typedef struct {
    SDL_TOG_cfgCtrl cfgCtrl;
    uint32_t        timeoutVal;
    SDL_TOG_IntrSrc intrSrcs;
}SDL_TOG_config;
 
typedef struct {
    uint32_t PID;                       
    uint32_t CFG;                       
    uint32_t ENABLE;                    
    uint32_t FLUSH;                     
    uint32_t TIMEOUT;                   
    uint32_t ERR;                       
} SDL_TOG_staticRegs;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
 
int32_t SDL_TOG_init(SDL_TOG_Inst instance, const SDL_TOG_config    *pConfig);
 
int32_t SDL_TOG_verifyConfig(SDL_TOG_Inst instance, const SDL_TOG_config    *pConfig);
 
int32_t SDL_TOG_setIntrEnable( SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrcs, bool enable );
 
 int32_t SDL_TOG_clrIntrPending(SDL_TOG_Inst instance, SDL_TOG_IntrSrc  intrSrc);
 
 int32_t SDL_TOG_getIntrPending(SDL_TOG_Inst instance, SDL_TOG_IntrSrc  *pPendInts);
 
 int32_t SDL_TOG_ackIntr(SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrc, uint32_t ackCnt);
 
 int32_t SDL_TOG_start(SDL_TOG_Inst instance);
 
 int32_t SDL_TOG_stop(SDL_TOG_Inst instance);
 
int32_t SDL_TOG_reset(SDL_TOG_Inst instance);
 
 int32_t SDL_TOG_getErrInfo(SDL_TOG_Inst instance, SDL_TOG_errInfo  *pErrInfo);
 
int32_t SDL_TOG_getStaticRegisters(SDL_TOG_Inst instance, SDL_TOG_staticRegs    *pStaticRegs);
 
int32_t SDL_TOG_setFlushMode(SDL_TOG_Inst instance, bool enable);
 
int32_t SDL_TOG_getIntrCount(SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrc, uint32_t *pIntrCnt );
 
#ifdef __cplusplus
}
#endif
 
#endif  /* SDL_TOG_H_ */
 
/* nothing past this point */