sdl_mtog.h

Go to the documentation of this file.

#ifndef SDL_MTOG_H_
#define SDL_MTOG_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>

#if defined (SOC_J7200)
    #include <src/ip/sdl_ip_mtog.h>
    #include <src/ip/sdlr_mtog.h>
    #include <src/sdl/tog/soc/j7200/sdl_soc_mtog.h>
#endif 

#if defined (SOC_J721S2)
    #include <src/ip/sdl_ip_mtog.h>
    #include <src/ip/sdlr_mtog.h>
    #include <src/sdl/tog/soc/j721s2/sdl_soc_mtog.h>
#endif 

#if defined (SOC_J784S4)
    #include <src/ip/sdl_ip_mtog.h>
    #include <src/ip/sdlr_mtog.h>
    #include <src/sdl/tog/soc/j784s4/sdl_soc_mtog.h>
#endif 

/* Magic value used to force a timeout */
#define SDL_MTOG_FORCE_KEY       ((uint32_t) 0x95U)

typedef struct {
    uint32_t  mtogCtrlRegister;
} SDL_MTOG_staticRegs;

/* This structure contains Master TOG configuration value */
typedef struct {
    SDL_MTOGVal timeOut;
} SDL_MTOG_config;

int32_t SDL_MTOG_init(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);

int32_t SDL_MTOG_verifyConfig(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);

int32_t SDL_MTOG_start( SDL_MTOG_Inst instance );

int32_t SDL_MTOG_stop( SDL_MTOG_Inst instance );

int32_t SDL_MTOG_forceTimeout( SDL_MTOG_Inst instance );

int32_t SDL_MTOG_reset( SDL_MTOG_Inst instance );

int32_t SDL_MTOG_getStaticRegisters( SDL_MTOG_Inst instance,
                                          SDL_MTOG_staticRegs *pStaticRegs);
#ifdef __cplusplus
}
#endif

#endif  /* SDL_MTOG_H_ */

/* nothing past this point */