AM261x MCU+ SDK: VTM IP Enumerated Data Types

| AM261x MCU+ SDK 26.00.00 |

Data Structures | Typedefs | Macros
VTM IP Enumerated Data Types
APIs for VTM » VTM Low-Level API

## Introduction

Provides the APIs for VTM IP.

## Data Structures
struct | SDL_VTM_Stat_val
| VTM temperature sensor Stat values. More...

## Typedefs
typedef uint8_t | SDL_VTM_configVdCtrl
| This enumerator define for VTM VD configuration valid map. More...
typedef uint8_t | SDL_VTM_configTsCtrl
| This enumerator define for VTM TS configuration valid map. More...
typedef int16_t | SDL_VTM_adc_code
| This typedef for VTM temperature sensor ADC code This is the data_out value of the temperature sensor stat register. More...

## Macros
#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)
#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)
#define | SDL_VTM_BGR_OFF 0x1U
| This enumerator defines the possible VID Codes to set various voltage domain supply voltages. More...
#define | SDL_VTM_BGR_ON 0x0U
#define | SDL_VTM_AIP_OFF 0x1U
#define | SDL_VTM_AIP_ON 0x0U
#define | SDL_VTM_TMPSOFF_OFF 0x1U
#define | SDL_VTM_TMPSOFF_ON 0x0U
#define | SDL_VTM_MUX_HIZ 0x1U
#define | SDL_VTM_NORMAL_HIZ 0x0U
#define | SDL_VTM_SENSOR_SEL0 (1U << 0U)
#define | SDL_VTM_SENSOR_SEL1 (1U << 1U)
#define | SDL_VTM_SENSOR_SEL2 (1U << 2U)
#define | SDL_VTM_SENSOR_SEL3 (1U << 3U)
#define | SDL_VTM_TSENSE_EN 0x1U
#define | SDL_VTM_TSENSE_DIS 0x0U
#define | SDL_VTM_TSENSE0_LOW_TH_FLAG (1U << 0U)
#define | SDL_VTM_TSENSE0_HOT_FLAG (1U << 2U)
#define | SDL_VTM_TSENSE0_COLD_FLAG (1U << 1U)
#define | SDL_VTM_TSENSE1_LOW_TH_FLAG (1U << 4U)
#define | SDL_VTM_TSENSE1_HOT_FLAG (1U << 6U)
#define | SDL_VTM_TSENSE1_COLD_FLAG (1U << 5U)
#define | SDL_VTM_OVERRIDE_PATTERN 0x7U
#define | SDL_VTM_MASK_LOW_TH (1U)
#define | SDL_VTM_MASK_COLD (1U)
#define | SDL_VTM_MASK_HOT (1U)
#define | SDL_VTM_FREEZE_FIFO 1U
#define | SDL_VTM_CLR_FIFO 1U
#define | SDL_VTM_CLR_ACCU 1U
#define | SDL_VTM_BUF_NUM0 0U
#define | SDL_VTM_BUF_NUM1 1U
#define | SDL_VTM_BUF_NUM2 2U
#define | SDL_VTM_BUF_NUM3 3U
#define | SDL_VTM_TSENSE_OFF 0U
#define | SDL_VTM_TSENSE_ON 1U
#define | SDL_VTM_MAXDELAY 0x2FU

## Macro Definition Documentation

## ◆ SDL_VTM_VD_CONFIG_CTRL_VID_OPP

#define SDL_VTM_VD_CONFIG_CTRL_VID_OPP (1U)

## ◆ SDL_VTM_VD_CONFIG_CTRL_EVT_SEL

#define SDL_VTM_VD_CONFIG_CTRL_EVT_SEL (2U)

## ◆ SDL_VTM_VD_CONFIG_CTRL_GLB_CFG

#define SDL_VTM_VD_CONFIG_CTRL_GLB_CFG (4U)

## ◆ SDL_VTM_VD_CONFIG_CTRL_SET_CTL

#define SDL_VTM_VD_CONFIG_CTRL_SET_CTL (1U)

## ◆ SDL_VTM_VD_CONFIG_CTRL_OUTRNG_ALRT

#define SDL_VTM_VD_CONFIG_CTRL_OUTRNG_ALRT (2U)

## ◆ SDL_VTM_VD_CONFIG_CTRL_SET_THR

#define SDL_VTM_VD_CONFIG_CTRL_SET_THR (4U)

## ◆ SDL_VTM_BGR_OFF

#define SDL_VTM_BGR_OFF 0x1U

This enumerator defines the possible VID Codes to set various voltage domain supply voltages.

## ◆ SDL_VTM_BGR_ON

#define SDL_VTM_BGR_ON 0x0U

## ◆ SDL_VTM_AIP_OFF

#define SDL_VTM_AIP_OFF 0x1U

## ◆ SDL_VTM_AIP_ON

#define SDL_VTM_AIP_ON 0x0U

## ◆ SDL_VTM_TMPSOFF_OFF

#define SDL_VTM_TMPSOFF_OFF 0x1U

## ◆ SDL_VTM_TMPSOFF_ON

#define SDL_VTM_TMPSOFF_ON 0x0U

## ◆ SDL_VTM_MUX_HIZ

#define SDL_VTM_MUX_HIZ 0x1U

## ◆ SDL_VTM_NORMAL_HIZ

#define SDL_VTM_NORMAL_HIZ 0x0U

## ◆ SDL_VTM_SENSOR_SEL0

#define SDL_VTM_SENSOR_SEL0 (1U << 0U)

## ◆ SDL_VTM_SENSOR_SEL1

#define SDL_VTM_SENSOR_SEL1 (1U << 1U)

## ◆ SDL_VTM_SENSOR_SEL2

#define SDL_VTM_SENSOR_SEL2 (1U << 2U)

## ◆ SDL_VTM_SENSOR_SEL3

#define SDL_VTM_SENSOR_SEL3 (1U << 3U)

## ◆ SDL_VTM_TSENSE_EN

#define SDL_VTM_TSENSE_EN 0x1U

## ◆ SDL_VTM_TSENSE_DIS

#define SDL_VTM_TSENSE_DIS 0x0U

## ◆ SDL_VTM_TSENSE0_LOW_TH_FLAG

#define SDL_VTM_TSENSE0_LOW_TH_FLAG (1U << 0U)

## ◆ SDL_VTM_TSENSE0_HOT_FLAG

#define SDL_VTM_TSENSE0_HOT_FLAG (1U << 2U)

## ◆ SDL_VTM_TSENSE0_COLD_FLAG

#define SDL_VTM_TSENSE0_COLD_FLAG (1U << 1U)

## ◆ SDL_VTM_TSENSE1_LOW_TH_FLAG

#define SDL_VTM_TSENSE1_LOW_TH_FLAG (1U << 4U)

## ◆ SDL_VTM_TSENSE1_HOT_FLAG

#define SDL_VTM_TSENSE1_HOT_FLAG (1U << 6U)

## ◆ SDL_VTM_TSENSE1_COLD_FLAG

#define SDL_VTM_TSENSE1_COLD_FLAG (1U << 5U)

## ◆ SDL_VTM_OVERRIDE_PATTERN

#define SDL_VTM_OVERRIDE_PATTERN 0x7U

## ◆ SDL_VTM_MASK_LOW_TH

#define SDL_VTM_MASK_LOW_TH (1U)

## ◆ SDL_VTM_MASK_COLD

#define SDL_VTM_MASK_COLD (1U)

## ◆ SDL_VTM_MASK_HOT

#define SDL_VTM_MASK_HOT (1U)

## ◆ SDL_VTM_FREEZE_FIFO

#define SDL_VTM_FREEZE_FIFO 1U

## ◆ SDL_VTM_CLR_FIFO

#define SDL_VTM_CLR_FIFO 1U

## ◆ SDL_VTM_CLR_ACCU

#define SDL_VTM_CLR_ACCU 1U

## ◆ SDL_VTM_BUF_NUM0

#define SDL_VTM_BUF_NUM0 0U

## ◆ SDL_VTM_BUF_NUM1

#define SDL_VTM_BUF_NUM1 1U

## ◆ SDL_VTM_BUF_NUM2

#define SDL_VTM_BUF_NUM2 2U

## ◆ SDL_VTM_BUF_NUM3

#define SDL_VTM_BUF_NUM3 3U

## ◆ SDL_VTM_TSENSE_OFF

#define SDL_VTM_TSENSE_OFF 0U

## ◆ SDL_VTM_TSENSE_ON

#define SDL_VTM_TSENSE_ON 1U

## ◆ SDL_VTM_MAXDELAY

#define SDL_VTM_MAXDELAY 0x2FU

## Typedef Documentation

## ◆ SDL_VTM_configVdCtrl

typedef uint8_t SDL_VTM_configVdCtrl

This enumerator define for VTM VD configuration valid map.

## ◆ SDL_VTM_configTsCtrl

typedef uint8_t SDL_VTM_configTsCtrl

This enumerator define for VTM TS configuration valid map.

## ◆ SDL_VTM_adc_code

typedef int16_t SDL_VTM_adc_code

This typedef for VTM temperature sensor ADC code This is the data_out value of the temperature sensor stat register.