sdl_vtm.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 Texas Instruments Incorporated
 *
 * 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_IP_VTM_TOP_H_
#define SDL_IP_VTM_TOP_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <sdl/vtm/v1/soc/sdl_soc_vtm.h>
#include <sdl/vtm/v1/sdl_ip_vtm.h>
 
 typedef struct
 {
    uint8_t cfgTs0Tshut;
    uint8_t cfgTs0Alert;
    int32_t                 ts0_ts_hot_temp_in_milli_degree_celsius;
    int32_t                 ts0_ts_cold_temp_in_milli_degree_celsius;
    int32_t                 ts0_alert_hot_temp_in_milli_degree_celsius;
    int32_t                 ts0_alert_cold_temp_in_milli_degree_celsius;
    uint8_t cfgTs1Tshut;
    uint8_t cfgTs1Alert;
    int32_t                 ts1_ts_hot_temp_in_milli_degree_celsius;
    int32_t                 ts1_ts_cold_temp_in_milli_degree_celsius;
    int32_t                 ts1_alert_hot_temp_in_milli_degree_celsius;
    int32_t                 ts1_alert_cold_temp_in_milli_degree_celsius;
 
} SDL_VTM_configTs;
 
typedef struct
{
    uint32_t                    vtm_ts_th2;
    uint32_t                    vtm_ts_cfg;
    uint32_t                    vtm_ts0_tshut;
    uint32_t                    vtm_ts0_alert;
    uint32_t                    vtm_ts0_ctrl;
    uint32_t                    vtm_ts1_tshut;
    uint32_t                    vtm_ts1_alert;
    uint32_t                    vtm_ts1_ctrl;
} SDL_VTM_staticRegsTs;
 
int32_t SDL_VTM_initTs(const SDL_VTM_configTs *pConfig);
 
int32_t SDL_VTM_getTemp(SDL_VTM_InstTs instance, uint32_t *pTempVal);
 
int32_t SDL_VTM_setAlertTemp(SDL_VTM_InstTs instance, int32_t alert_th_hot,
                             int32_t alert_th_cold);
 
int32_t SDL_VTM_setTShutTemp(SDL_VTM_InstTs instance, int32_t tshut_th_hot, \
                             int32_t tshut_th_cold);
 
int32_t SDL_VTM_setClearInterrupts(SDL_VTM_InstTs instance, uint8_t  hotintr, \
                                 uint8_t  coldintr, uint8_t  lowthresholdintr);
 
int32_t SDL_VTM_getSensorStatus(SDL_VTM_Stat_val *pStat_val);
 
void SDL_VTM_enableTs(uint32_t sensorSelect, uint8_t delay);
 
void SDL_VTM_enableTc(void);
 
void SDL_VTM_disableTc(void);
 
int32_t SDL_VTM_getStaticRegistersTs(SDL_VTM_staticRegsTs *pStaticRegs);
 
int32_t SDL_VTM_enableESMWarmReset(SDL_VTM_InstTs instance);
 
#ifdef __cplusplus
}
#endif  /* extern "C" */
 
#endif /* SDL_IP_VTM_TOP_H_ */