docs/api_guide_am243x/sdl__ip__vtm_8h_source.html

/*

 *  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_IP_VTM_H

#define SDL_IP_VTM_H


#ifdef __cplusplus

extern "C" {

#endif


#include <stdint.h>

#include <stdbool.h>

#include <sdl/vtm/v0/sdlr_vtm.h>

#if defined (SOC_AM64X)

#include <sdl/vtm/v0/soc/am64x/sdl_soc_vtm.h>

#endif

#if defined (SOC_AM243X)

#include <sdl/vtm/v0/soc/am243x/sdl_soc_vtm.h>

#endif


typedef uint8_t SDL_VTM_configVdCtrl;

#define SDL_VTM_VD_CONFIG_CTRL_VID_OPP                (1U)

#define SDL_VTM_VD_CONFIG_CTRL_EVT_SEL                (2U)

#define SDL_VTM_VD_CONFIG_CTRL_GLB_CFG                (4U)


typedef uint8_t SDL_VTM_configTsCtrl;

#define SDL_VTM_VD_CONFIG_CTRL_SET_CTL                (1U)

#define SDL_VTM_VD_CONFIG_CTRL_OUTRNG_ALRT            (2U)

#define SDL_VTM_VD_CONFIG_CTRL_SET_THR                (4U)


typedef  uint8_t SDL_VTM_vid_opp;

#define SDL_VTM_VID_OPP_MAX_NUM                   ((uint8_t) 4U)


#define SDL_VTM_VID_OPP_3_CODE                    ((uint8_t) 3U)


#define SDL_VTM_VID_OPP_2_CODE                    ((uint8_t) 2U)


#define SDL_VTM_VID_OPP_1_CODE                    ((uint8_t) 1U)


#define SDL_VTM_VID_OPP_0_CODE                    ((uint8_t) 0U)


typedef  uint8_t SDL_VTM_ts_stat_vd_map;

#define SDL_VTM_TS_STAT_VD_MAP_RTC                       ((uint32) 0U)


#define SDL_VTM_TS_STAT_VD_MAP_WKUP                      ((uint32) 1U)


#define SDL_VTM_TS_STAT_VD_MAP_MCU                       ((uint32) 2U)


#define SDL_VTM_TS_STAT_VD_MAP_CORE                      ((uint32) 3U)


#define SDL_VTM_TSTAT_VD_MAP_NOT_IMPLEMENTED             ((uint32) 15U)


typedef uint16_t SDL_VTM_intrCtrl;

#define SDL_VTM_VD_LT_THR0_INTR_RAW_SET                   (1u)

#define SDL_VTM_VD_GT_THR1_INTR_RAW_SET                   (2u)

#define SDL_VTM_VD_GT_THR2_INTR_RAW_SET                   (4u)

#define SDL_VTM_VD_LT_THR0_INTR_RAW_CLR                   (8u)

#define SDL_VTM_VD_GT_THR1_INTR_RAW_CLR                   (16u)

#define SDL_VTM_VD_GT_THR2_INTR_RAW_CLR                   (32u)

#define SDL_VTM_VD_LT_THR0_INTR_EN_SET                    (64u)

#define SDL_VTM_VD_GT_THR1_INTR_EN_SET                   (128u)

#define SDL_VTM_VD_GT_THR2_INTR_EN_SET                   (256u)

#define SDL_VTM_VD_LT_THR0_INTR_EN_CLR                   (512u)

#define SDL_VTM_VD_GT_THR1_INTR_EN_CLR                  (1024u)

#define SDL_VTM_VD_GT_THR2_INTR_EN_CLR                  (2048u)

#define SDL_VTM_VD_INTR_INVALID                         (SDL_VTM_VD_LT_THR0_INTR_RAW_SET |  \

                                                         SDL_VTM_VD_LT_THR0_INTR_RAW_CLR)


typedef uint16_t SDL_VTM_vdEvtSel_set;


#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_0            (1u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_1            (2u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_2            (4u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_3            (8u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_4            (16u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_5            (32u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_6            (64u)

#define SDL_VTM_VD_EVT_SELECT_TEMP_SENSOR_7            (128u)


typedef uint32_t SDL_VTM_tsGlobal_ctrl_valid_map;

#define SDL_VTM_TSGLOBAL_CLK_SEL_VALID                    (1u)

#define SDL_VTM_TSGLOBAL_CLK_DIV_VALID                    (2u)

#define SDL_VTM_TSGLOBAL_ANY_MAXT_OUTRG_ALERT_EN_VALID    (4u)

#define SDL_VTM_TSGLOBAL_MAXT_OUTRG_ALERT_THR0_VALID      (8u)

#define SDL_VTM_TSGLOBAL_MAXT_OUTRG_ALERT_THR_VALID      (16u)

#define SDL_VTM_TSGLOBAL_SAMPLES_PER_CNT_VALID           (32u)


typedef uint8_t SDL_VTM_tsGlobal_clkSel;

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_SEL_FIX_REF_CLK         (1u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_SEL_FIX_REF2_CLK        (2u)


typedef uint8_t SDL_VTM_tsGlobal_clkDiv;

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_1                   (0u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_2                   (1u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_3                   (2u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_4                   (3u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_5                   (4u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_6                   (5u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_7                   (6u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_8                   (7u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_9                   (8u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_10                  (9u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_11                  (10u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_12                  (11u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_13                  (12u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_14                  (13u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_15                  (14u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_16                  (15u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_17                  (16u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_18                  (17u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_19                  (18u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_20                  (19u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_21                  (20u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_22                  (21u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_23                  (22u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_24                  (23u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_25                  (24u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_26                  (25u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_27                  (26u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_28                  (27u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_29                  (28u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_30                  (29u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_31                  (30u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_32                  (31u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_33                  (32u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_34                  (33u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_35                  (34u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_36                  (35u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_37                  (36u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_38                  (37u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_39                  (38u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_40                  (39u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_41                  (40u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_42                  (41u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_43                  (42u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_44                  (43u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_45                  (44u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_46                  (45u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_47                  (46u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_48                  (47u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_49                  (48u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_50                  (49u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_51                  (50u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_52                  (51u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_53                  (52u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_54                  (53u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_55                  (54u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_56                  (55u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_57                  (56u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_58                  (57u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_59                  (58u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_60                  (59u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_61                  (60u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_62                  (61u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_63                  (62u)

#define SDL_VTM_TSGLOBAL_CLK_CTRL_CLK_DIV_BY_64                  (63u)


typedef uint8_t  SDL_VTM_tsGlobal_any_maxt_outrg_alert_en;

#define SDL_VTM_TSGLOBAL_ANY_MAXT_OUTRG_ALERT_ENABLE   (1u)

#define SDL_VTM_TSGLOBAL_ANY_MAXT_OUTRG_ALERT_DISABLE  (0u)


typedef uint16_t SDL_VTM_tsGlobal_samples_per_count;


typedef uint8_t SDL_VTM_tsCtrl_valid_map;

#define SDL_VTM_TS_CTRL_MAXT_OUTG_ALERT_VALID                (1u)

#define SDL_VTM_TS_CTRL_RESET_CTRL_VALID                     (2u)

#define SDL_VTM_TS_CTRL_SOC_VALID                            (4u)

#define SDL_VTM_TS_CTRL_MODE_VALID                           (8u)


typedef uint8_t  SDL_VTM_tsCtrl_max_outrg_alert;

#define SDL_VTM_TS_CTRL_MAXT_OUTRG_GEN_ALERT         (1u)

#define SDL_VTM_TS_CTRL_MAXT_OUTRG_NO_ALERT          (0u)


typedef  uint8_t SDL_VTM_tsCtrl_resetCtrl;

#define SDL_VTM_TS_CTRL_SENSOR_RESET                     (0u)

#define SDL_VTM_TS_CTRL_SENSOR_NORM_OP                   (1u)


typedef  uint8_t    SDL_VTM_tsCtrl_mode;

#define SDL_VTM_TS_CTRL_SINGLESHOT_MODE                 (0u)

#define SDL_VTM_TS_CTRL_CONTINUOUS_MODE                 (1u)


typedef  uint8_t SDL_VTM_tsCtrl_singleshot_conv_stat;

#define SDL_VTM_TS_CTRL_SINGLESHOT_ADC_CONV_IN_PROGRESS    (1u)

#define SDL_VTM_TS_CTRL_SINGLESHOT_ADC_CONV_COMPLETE       (0u)


typedef uint8_t  SDL_VTM_thr_valid_map;

#define SDL_VTM_GT_TH1_VALID                (1u)

#define SDL_VTM_GT_TH2_VALID                (2u)

#define SDL_VTM_LT_TH0_VALID                (4u)


typedef uint8_t SDL_VTM_Stat_read_ctrl;

#define SDL_VTM_TS_READ_VD_MAP_VAL                (1U)

#define SDL_VTM_TS_READ_ALL_THRESHOLD_ALERTS      (2U)

#define SDL_VTM_TS_READ_FIRST_TIME_EOC_BIT        (4U)

#define SDL_VTM_TS_READ_DATA_VALID_BIT            (8U)

#define SDL_VTM_TS_READ_DATA_OUT_VAL             (16U)


typedef  int16_t SDL_VTM_adc_code;


typedef uint8_t SDL_VTM_vdEvt_status;


#define SDL_VTM_VD_EVT_STAT_THR_ALERTS_MASK               (7u)

#define SDL_VTM_VD_EVT_STAT_LT_TH0_ALERT                  (4u)

#define SDL_VTM_VD_EVT_STAT_GT_TH1_ALERT                  (1u)

#define SDL_VTM_VD_EVT_STAT_GT_TH2_ALERT                  (2u)


typedef struct {

    SDL_VTM_tsGlobal_ctrl_valid_map             validMap;

    SDL_VTM_tsGlobal_clkSel                     clkSel;

    SDL_VTM_tsGlobal_clkDiv                     clkDiv;

    SDL_VTM_tsGlobal_any_maxt_outrg_alert_en    any_maxt_outrg_alert_en;

    SDL_VTM_adc_code                            maxt_outrg_alert_thr0;

    SDL_VTM_adc_code                            maxt_outrg_alert_thr;

    SDL_VTM_tsGlobal_samples_per_count          samplesPerCnt;

} SDL_VTM_tsGlobal_cfg;


typedef struct {

    SDL_VTM_tsCtrl_valid_map         valid_map;

    SDL_VTM_tsCtrl_max_outrg_alert   maxt_outrg_alert_en;

    SDL_VTM_tsCtrl_resetCtrl         tsReset;

    SDL_VTM_tsCtrl_singleshot_conv_stat adc_stat;

    SDL_VTM_tsCtrl_mode              mode;

} SDL_VTM_Ctrlcfg;


typedef struct {

    SDL_VTM_thr_valid_map    thrValidMap;

    SDL_VTM_adc_code         gtTh1;

    /* 0: disable Th1, otherwise: enable Th1 */

    bool                     gtTh1En;

    SDL_VTM_adc_code         gtTh2;

    /* 0: disable Th2, otherwise: enable Th2 */

    bool                     gtTh2En;

    SDL_VTM_adc_code         ltTh0;

    /* 0: disable Th0, otherwise: enable Th0 */

    bool                     ltTh0En;

} SDL_VTM_tsThrVal;


typedef struct {

    SDL_VTM_ts_stat_vd_map     vd_map;

    uint8_t                    maxt_outrg_alert;

    uint8_t                    lt_th0_alert;

    uint8_t                    gt_th1_alert;

    uint8_t                    gt_th2_alert;

    uint8_t                    soc_fc_update;

    uint8_t                    data_valid;

    SDL_VTM_adc_code           data_out;

} SDL_VTM_Stat_val;


void SDL_VTM_getSensorVDCount(const SDL_VTM_cfg1Regs       *p_cfg1);


SDL_VTM_adc_code SDL_VTM_getBestValue(SDL_VTM_adc_code c0,

                                            SDL_VTM_adc_code c1,

                                            SDL_VTM_adc_code c2);


SDL_VTM_adc_code SDL_VTM_getAdcCode(const SDL_VTM_cfg1Regs_TMPSENS    *p_sensor);


int32_t SDL_VTM_vdSetOppVid (const SDL_VTM_cfg1Regs         *p_cfg1,

                                    SDL_VTM_InstVd          instance,

                                    SDL_VTM_vid_opp         vid_opp,

                                    uint8_t                 vid_opp_val);


int32_t SDL_VTM_vdGetOppVid (const SDL_VTM_cfg1Regs  *p_cfg1,

                            SDL_VTM_InstVd          instance,

                            SDL_VTM_vid_opp         vid_opp,

                            uint8_t                 *p_vid_opp_val);


int32_t SDL_VTM_vdEvtSelSet (const SDL_VTM_cfg1Regs  *p_cfg1,

                            SDL_VTM_InstVd instance,

                            SDL_VTM_vdEvtSel_set   vd_temp_evts);


int32_t SDL_VTM_tsSetGlobalCfg (const SDL_VTM_cfg2Regs       *p_cfg2,

                               const SDL_VTM_tsGlobal_cfg   *p_tsGlobal_cfg);


int32_t SDL_VTM_tsGetGlobalCfg (const SDL_VTM_cfg2Regs       *p_cfg2,

                               SDL_VTM_tsGlobal_cfg         *p_tsGlobal_cfg);


int32_t SDL_VTM_tsSetCtrl (const SDL_VTM_cfg2Regs       *p_cfg2,

                            SDL_VTM_InstTs              instance,

                            const SDL_VTM_Ctrlcfg   *p_tsCtrl_cfg);


int32_t SDL_VTM_tsGetCtrl (const SDL_VTM_cfg2Regs      *p_cfg2,

                            SDL_VTM_InstTs              instance,

                          SDL_VTM_Ctrlcfg         *p_tsCtrl_cfg);


int32_t SDL_VTM_tsSetThresholds (const SDL_VTM_cfg1Regs     *p_cfg1,

                                SDL_VTM_InstTs              instance,

                                const SDL_VTM_tsThrVal      *p_thr_val);


int32_t SDL_VTM_tsGetThresholds (const SDL_VTM_cfg1Regs   *p_cfg1,

                                SDL_VTM_InstTs              instance,

                                SDL_VTM_tsThrVal         *p_thr_val);


int32_t SDL_VTM_tsConvADCToTemp (SDL_VTM_adc_code        adc_code,

                                SDL_VTM_InstTs              instance,

                                int32_t                 *p_milli_degree_temp_val);


int32_t SDL_VTM_tsConvTempToAdc (int32_t milli_degree_temp_val,

                                 SDL_VTM_InstTs instance,

                                 SDL_VTM_adc_code *p_adc_code);


int32_t SDL_VTM_tsSetMaxTOutRgAlertThr(const SDL_VTM_cfg2Regs       *p_cfg2,

                                      SDL_VTM_InstTs                instance,

                                      int32_t               high_temp_in_milli_degree_celcius,

                                      int32_t               low_temp_in_milli_degree_celcius);


#ifdef __cplusplus

}

#endif  /* extern "C" */

#endif  /* end of SDL_IP_VTM_H definition */