sdl_vtm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023 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_VTM_H
#define SDL_VTM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <sdl/include/soc_config.h>
#if defined (IP_VERSION_VTM_V0)
#include <sdl/vtm/v0/sdlr_vtm.h>
#include <sdl/vtm/v0/sdl_ip_vtm.h>
#endif
 
typedef struct {
    SDL_VTM_configVdCtrl    configVdCtrl;
    SDL_VTM_vid_opp         vid_opp;
    uint8_t                 vid_opp_val;
    SDL_VTM_vdEvtSel_set    vd_temp_evts;
    SDL_VTM_tsGlobal_cfg       tsGlobal_cfg;
} SDL_VTM_configVd;
 
 typedef struct {
    SDL_VTM_configTsCtrl    configTsCtrl;
    SDL_VTM_Ctrlcfg            tsCtrl_cfg;
    int32_t                 high_temp_in_milli_degree_celsius;
    int32_t                 low_temp_in_milli_degree_celsius;
    SDL_VTM_tsThrVal           thr_val;
} SDL_VTM_configTs;
 
typedef struct {
    uint32_t                    vtm_vd_evt_sel_ctrl;
    uint32_t                    vtm_vd_opp_vid;
    SDL_VTM_tsGlobal_cfg        vtm_global_cfg;
} SDL_VTM_staticRegsVd;
 
typedef struct {
    uint32_t                    vtm_ts_ctrl2;
    uint32_t                    vtm_ts_ctrl;
    uint32_t                    vtm_ts_th;
    uint32_t                    vtm_ts_th2;
} SDL_VTM_staticRegsTs;
 
int32_t SDL_VTM_initVd(SDL_VTM_InstVd instance, const SDL_VTM_configVd *pConfig);
 
int32_t SDL_VTM_initTs(SDL_VTM_InstTs instance, const SDL_VTM_configTs *pConfig);
 
int32_t SDL_VTM_getTemp(SDL_VTM_InstTs instance, uint32_t *pTempVal);
 
int32_t SDL_VTM_getSensorStatus(SDL_VTM_InstTs instance, const SDL_VTM_Stat_read_ctrl *pCtrl, \
                                SDL_VTM_Stat_val *pStat_val);
 
int32_t SDL_VTM_intrCntrl(SDL_VTM_InstVd instance, SDL_VTM_intrCtrl intrCtrl);
 
int32_t SDL_VTM_verifyConfigVd(SDL_VTM_InstVd instance, const SDL_VTM_configVd *pConfig);
 
int32_t SDL_VTM_verifyConfigTs(SDL_VTM_InstTs instance, const SDL_VTM_configTs *pConfig);
 
int32_t SDL_VTM_getStaticRegistersVd(SDL_VTM_InstVd instance, SDL_VTM_staticRegsVd *pStaticRegs);
 
int32_t SDL_VTM_getStaticRegistersTs(SDL_VTM_InstTs instance, SDL_VTM_staticRegsTs *pStaticRegs);
 
 
 
#ifdef __cplusplus
}
#endif  /* extern "C" */
 
#endif  /* end of SDL_VTM_H definition */