SDL API Guide for J7200
sdl_mtog.h File Reference

Introduction

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



(C) Copyright 2021, Texas Instruments, Inc.

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

Data Structures

struct  SDL_MTOG_staticRegs
 Master TOG Static Registers. More...
 
struct  SDL_MTOG_config
 

Macros

#define SDL_MTOG_FORCE_KEY   ((uint32_t) 0x95U)
 

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

Macro Definition Documentation

◆ SDL_MTOG_FORCE_KEY

#define SDL_MTOG_FORCE_KEY   ((uint32_t) 0x95U)