Introduction

Functions

Functions
int32_t	SDL_MTOG_init (SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig)
	Initialize Master TOG module with respect of instance. More...

int32_t	SDL_MTOG_verifyConfig (SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig)
	Verifying written configuration with Master TOG module. More...

int32_t	SDL_MTOG_start (SDL_MTOG_Inst instance)
	Start the timeout function. More...

int32_t	SDL_MTOG_stop (SDL_MTOG_Inst instance)
	Stop the timeout function. More...

int32_t	SDL_MTOG_forceTimeout (SDL_MTOG_Inst instance)
	Force a timeout. More...

int32_t	SDL_MTOG_reset (SDL_MTOG_Inst instance)
	Reset the timeout functionality. More...

int32_t	SDL_MTOG_getStaticRegisters (SDL_MTOG_Inst instance, SDL_MTOG_staticRegs *pStaticRegs)
	Readback Static configuration register. More...

Function Documentation

◆ SDL_MTOG_init()

int32_t SDL_MTOG_init	(	SDL_MTOG_Inst	instance,
		const SDL_MTOG_config *	pConfig
	)

Initialize Master TOG module with respect of instance.

This function allows software to initialize MTOG module

The pConfig contains the timeout value

Parameters

instance	[IN] MTOG instance
pConfig	[IN] Pointer to store the configuration

Returns: SDL_PASS The function completed successfully SDL_EBADARGS instance is invalid or pConfig is NULL

◆ SDL_MTOG_verifyConfig()

int32_t SDL_MTOG_verifyConfig	(	SDL_MTOG_Inst	instance,
		const SDL_MTOG_config *	pConfig
	)

Verifying written configuration with Master TOG module.

This function allows software to verifying MTOG module

The pConfig contains the timeout value

Parameters

instance	[IN] MTOG instance
pConfig	[IN] Pointer to store the configuration

Returns: SDL_PASS The function completed successfully SDL_EBADARGS instance is invalid or pConfig is NULL

◆ SDL_MTOG_start()

int32_t SDL_MTOG_start ( SDL_MTOG_Inst instance )

Start the timeout function.

This function starts the timeout counter functionality.

Parameters

instance [IN] MTOG instance

Returns: SDL_PASS Function completed successfully SDL_EBADARGS pRegs is NULL

◆ SDL_MTOG_stop()

int32_t SDL_MTOG_stop ( SDL_MTOG_Inst instance )

Stop the timeout function.

This function stops the timeout counter functionality.

Parameters

instance [IN] MTOG instance

Returns: SDL_PASS Function completed successfully SDL_EBADARGS pRegs is NULL

◆ SDL_MTOG_forceTimeout()

int32_t SDL_MTOG_forceTimeout ( SDL_MTOG_Inst instance )

Force a timeout.

This function enables software to force a timeout and flush of the interface transactions.

Parameters

instance [IN] MTOG instance

Returns: SDL_PASS Function completed successfully SDL_EFAIL Timeout function is disabled. Call SDL_MTOG_start first. SDL_EBADARGS pRegs is NULL

◆ SDL_MTOG_reset()

int32_t SDL_MTOG_reset ( SDL_MTOG_Inst instance )

Reset the timeout functionality.

This function resets the timeout functionality by clearing the timeout interrupt and timeout counter. It should be called after servicing a timeout interrupt and before re-enabling the timeout counter via the SDL_MTOG_start function.

Note that the timeout value set via the SDL_MTOG_setTimeoutVal function is unaffected.

Parameters

instance [IN] MTOG instance

Returns: SDL_PASS Function completed successfully SDL_EBADARGS pRegs is NULL

◆ SDL_MTOG_getStaticRegisters()

int32_t SDL_MTOG_getStaticRegisters	(	SDL_MTOG_Inst	instance,
		SDL_MTOG_staticRegs *	pStaticRegs
	)

Readback Static configuration register.

This function reads back configuration registers that are static. Note that this is just one register master TOG

Parameters

instance	[IN] MTOG instance
pStaticRegs	[OUT] Pointer to store the read static registers

Returns: SDL_PASS Function completed successfully SDL_EBADARGS pRegs is NULL