SDL API Guide for J721E
TOG API

Introduction

Overview

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:

  1. Call SDL_TOG_setTimeoutVal 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 SDL_TOG_setIntrEnable. Note that all interrupt sources are enabled by default.
  3. Call SDL_TOG_start to start the timer counting
  4. 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

Sub Modules

 TOG Data Structures
 
 TOG Enumerated Data Types
 
 TOG Functions