SLV_TOG API

Introduction

===========================================================================

This is the CSL-FL API documentation for the VBUSM Slave Timeout Gasket module.

The following procedure describes how to properly use this CSL-FL API:

1. Call CSL_slvTogSetTimeoutVal to configure the desired timeout counter value if you wish a shorter timeout than the default maximum timeout.
2. Enable/disable interrupt sources as needed by calling CSL_slvTogSetIntrEnable. Note that all interrupt sources are enabled by default.
3. Call CSL_slvTogStart to start the timer counting
4. If an interrupt is signaled from the gasket, then... a) Call CSL_slvTogGetIntrPending to determine the pending interrupt sources b) Clear interrupt source(s) by calling CSL_slvTogClrIntrPending 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 CSL_slvTogSetFlushModeEnable with true. Once all transactions are flushed, software should exit Flush mode by calling CSL_slvTogSetFlushModeEnable with false. If the destination side is in reset, this should trigger hardware flush, keeping the gasket returning any transactions that arrive. d) The CSL_slvTogGetErrInfo function can be called to get detailed information about the error if needed. e) Ack the interrupt by calling CSL_slvTogGetIntrCount and

   CSL_slvTogAckIntr

Sub Modules
	SLV_TOG Data Structures
	SLV_TOG Enumerated Data Types
	SLV_TOG Functions