Introduction

Header file containing various enumerations, structure definitions and function declarations for the VBUSM Slave Timeout Gasket IP.

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 Incorpo_toged 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.

Go to the source code of this file.

TOG configuration flags
This is the SDL-FL API documentation for the VBUSM Slave Timeout Gasket module. The following procedure describes how to properly use this SDL-FL API: Call SDL_TOG_init with setting Timeout Value to configure the desired timeout counter value if you wish a shorter timeout than the default maximum timeout. Enable/disable interrupt sources as needed by calling SDL_TOG_setIntrEnable. Note that all interrupt sources are enabled by default. Call SDL_TOG_start to start the timer counting If an interrupt is signaled from the gasket, then... a) Call SDL_TOG_getIntrPending to determine the pending interrupt sources b) Clear interrupt source(s) by calling SDL_TOG_clrIntrPending c) Service the cause of the interrupt as needed. If the system determines that it needs to flush all outstanding transactions (for instance, because the main SoC is in an error condition and is going to be reset), software may do this by calling SDL_TOG_setFlushMode with true. Once all transactions are flushed, software should exit Flush mode by calling SDL_TOG_setFlushMode with false. If the destination side is in reset, this should trigger hardware flush, keeping the gasket returning any transactions that arrive. d) The SDL_TOG_getErrInfo function can be called to get detailed information about the error if needed. e) Ack the interrupt by calling SDL_TOG_getIntrCount and SDL_TOG_ackIntr
#define	SDL_TOG_CFG_TIMEOUT 0x01U

#define	SDL_TOG_CFG_INTR_PENDING 0x02U

typedef uint8_t	SDL_TOG_cfgCtrl
	This enumerator defines the possible configuration flags. More...

Data Structures
struct	SDL_TOG_errInfo
	This structure contains timeout error information. More...

struct	SDL_TOG_config
	This structure contains TOG configuration information. More...

struct	SDL_TOG_staticRegs
	Slave TOG Static Registers. More...

Functions
int32_t	SDL_TOG_init (SDL_TOG_Inst instance, const SDL_TOG_config *pConfig)
	Initialize TOG module with respect of instance. More...

int32_t	SDL_TOG_verifyConfig (SDL_TOG_Inst instance, const SDL_TOG_config *pConfig)
	Verifying written configuration with TOG module. More...

int32_t	SDL_TOG_setIntrEnable (SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrcs, bool enable)
	Enable/disable interrupt source(s) More...

int32_t	SDL_TOG_clrIntrPending (SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrc)
	Clear pending interrupt source(s) More...

int32_t	SDL_TOG_getIntrPending (SDL_TOG_Inst instance, SDL_TOG_IntrSrc *pPendInts)
	Get masked (enabled) pending interrupt sources. More...

int32_t	SDL_TOG_ackIntr (SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrc, uint32_t ackCnt)
	Ack interrupt source. More...

int32_t	SDL_TOG_start (SDL_TOG_Inst instance)
	Start the timer counter. More...

int32_t	SDL_TOG_stop (SDL_TOG_Inst instance)
	Stop the timer counter. More...

int32_t	SDL_TOG_reset (SDL_TOG_Inst instance)
	Reset the timeout functionality. More...

int32_t	SDL_TOG_getErrInfo (SDL_TOG_Inst instance, SDL_TOG_errInfo *pErrInfo)
	Get timeout error information. More...

int32_t	SDL_TOG_getStaticRegisters (SDL_TOG_Inst instance, SDL_TOG_staticRegs *pStaticRegs)
	Readback Static configuration registers. More...

int32_t	SDL_TOG_setFlushMode (SDL_TOG_Inst instance, bool enable)
	Enable/disable flush mode. More...

int32_t	SDL_TOG_getIntrCount (SDL_TOG_Inst instance, SDL_TOG_IntrSrc intrSrc, uint32_t *pIntrCnt)
	Get interrupt count. More...

Introduction

TOG configuration flags

Data Structures

Functions