SDL API Guide for J7200
sdl_mtog.h
Go to the documentation of this file.
1 
39 #ifndef SDL_MTOG_H_
40 #define SDL_MTOG_H_
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 #include <stdint.h>
47 #include <stdbool.h>
48 
49 #if defined (SOC_J7200)
50  #include <src/ip/sdl_ip_mtog.h>
51  #include <src/ip/sdlr_mtog.h>
53 #endif
54 
55 /* Magic value used to force a timeout */
56 #define SDL_MTOG_FORCE_KEY ((uint32_t) 0x95U)
57 
113 typedef struct {
117 
119 /* This structure contains Master TOG configuration value */
120 typedef struct {
124 
143 int32_t SDL_MTOG_init(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);
144 
158 int32_t SDL_MTOG_verifyConfig(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);
159 
170 int32_t SDL_MTOG_start( SDL_MTOG_Inst instance );
171 
182 int32_t SDL_MTOG_stop( SDL_MTOG_Inst instance );
183 
197 int32_t SDL_MTOG_forceTimeout( SDL_MTOG_Inst instance );
198 
215 int32_t SDL_MTOG_reset( SDL_MTOG_Inst instance );
216 
231  SDL_MTOG_staticRegs *pStaticRegs);
234 #ifdef __cplusplus
235 }
236 #endif
237 
238 #endif /* SDL_MTOG_H_ */
239 
240 /* nothing past this point */
uint8_t SDL_MTOG_Inst
Definition: sdl_soc_mtog.h:59
Definition: sdl_mtog.h:120
Master TOG Static Registers.
Definition: sdl_mtog.h:113
int32_t SDL_MTOG_getStaticRegisters(SDL_MTOG_Inst instance, SDL_MTOG_staticRegs *pStaticRegs)
Readback Static configuration register.
uint32_t SDL_MTOGVal
Definition: sdl_ip_mtog.h:83
int32_t SDL_MTOG_verifyConfig(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig)
Verifying written configuration with Master TOG module.
int32_t SDL_MTOG_init(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig)
Initialize Master TOG module with respect of instance.
int32_t SDL_MTOG_forceTimeout(SDL_MTOG_Inst instance)
Force a timeout.
int32_t SDL_MTOG_stop(SDL_MTOG_Inst instance)
Stop the timeout function.
int32_t SDL_MTOG_start(SDL_MTOG_Inst instance)
Start the timeout function.
SDL_MTOGVal timeOut
Definition: sdl_mtog.h:122
int32_t SDL_MTOG_reset(SDL_MTOG_Inst instance)
Reset the timeout functionality.
uint32_t mtogCtrlRegister
Definition: sdl_mtog.h:115