sdl_mtog.h

Go to the documentation of this file.

/*
 *   Copyright (c) Texas Instruments Incorporated 2022-2023
 *
 *  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.
 *
 */
#ifndef SDL_MTOG_H_
#define SDL_MTOG_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
 
#include <sdl/mtog/v0/sdl_ip_mtog.h>
#include <sdl/mtog/soc/sdl_soc_mtog.h>
 
/* Magic value used to force a timeout */
#define SDL_MTOG_FORCE_KEY       ((uint32_t) 0x95U)
 
typedef struct {
    uint32_t  mtogCtrlRegister;
} SDL_MTOG_staticRegs;
 
/* This structure contains Master TOG configuration value */
typedef struct {
    SDL_MTOGVal timeOut;
} SDL_MTOG_config;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t SDL_MTOG_init(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);
 
int32_t SDL_MTOG_verifyConfig(SDL_MTOG_Inst instance, const SDL_MTOG_config *pConfig);
 
int32_t SDL_MTOG_start( SDL_MTOG_Inst instance );
 
int32_t SDL_MTOG_stop( SDL_MTOG_Inst instance );
 
int32_t SDL_MTOG_forceTimeout( SDL_MTOG_Inst instance );
 
int32_t SDL_MTOG_reset( SDL_MTOG_Inst instance );
 
int32_t SDL_MTOG_getStaticRegisters( SDL_MTOG_Inst instance,
                                          SDL_MTOG_staticRegs *pStaticRegs);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* SDL_MTOG_H_ */
 
/* nothing past this point */