RTEMS 6.1-rc6
Loading...
Searching...
No Matches
Files | Data Structures | Enumerator | Variables
Tempmon

Files

file  fsl_tempmon.h
 

Data Structures

struct  _tempmon_config
 TEMPMON temperature structure. More...
 

Variables

uint16_t _tempmon_config::frequency
 
int8_t _tempmon_config::highAlarmTemp
 
int8_t _tempmon_config::panicAlarmTemp
 
int8_t _tempmon_config::lowAlarmTemp
 

Driver version

enum  _tempmon_alarm_mode { kTEMPMON_HighAlarmMode = 0U , kTEMPMON_PanicAlarmMode = 1U , kTEMPMON_LowAlarmMode = 2U }
 TEMPMON alarm mode. More...
 
typedef struct _tempmon_config tempmon_config_t
 TEMPMON temperature structure.
 
typedef enum _tempmon_alarm_mode tempmon_alarm_mode
 TEMPMON alarm mode.
 
void TEMPMON_Init (TEMPMON_Type *base, const tempmon_config_t *config)
 Initializes the TEMPMON module.
 
void TEMPMON_Deinit (TEMPMON_Type *base)
 Deinitializes the TEMPMON module.
 
void TEMPMON_GetDefaultConfig (tempmon_config_t *config)
 Gets the default configuration structure.
 
float TEMPMON_GetCurrentTemperature (TEMPMON_Type *base)
 Get current temperature with the fused temperature calibration data.
 
void TEMPMON_SetTempAlarm (TEMPMON_Type *base, int8_t tempVal, tempmon_alarm_mode alarmMode)
 Set the temperature count (raw sensor output) that will generate an alarm interrupt.
 
#define FSL_TEMPMON_DRIVER_VERSION   (MAKE_VERSION(2, 1, 1))
 TEMPMON driver version.
 

Detailed Description

Enumeration Type Documentation

◆ _tempmon_alarm_mode

TEMPMON alarm mode.

Enumerator
kTEMPMON_HighAlarmMode 

The high alarm temperature interrupt mode.

kTEMPMON_PanicAlarmMode 

The panic alarm temperature interrupt mode.

kTEMPMON_LowAlarmMode 

The low alarm temperature interrupt mode.

Function Documentation

◆ TEMPMON_Deinit()

void TEMPMON_Deinit ( TEMPMON_Type base)

Deinitializes the TEMPMON module.

Parameters
baseTEMPMON base pointer

brief Deinitializes the TEMPMON module.

param base TEMPMON base pointer

◆ TEMPMON_GetCurrentTemperature()

float TEMPMON_GetCurrentTemperature ( TEMPMON_Type base)

Get current temperature with the fused temperature calibration data.

Parameters
baseTEMPMON base pointer
Returns
current temperature with degrees Celsius.

brief Get current temperature with the fused temperature calibration data.

param base TEMPMON base pointer return current temperature with degrees Celsius.

◆ TEMPMON_GetDefaultConfig()

void TEMPMON_GetDefaultConfig ( tempmon_config_t config)

Gets the default configuration structure.

This function initializes the TEMPMON configuration structure to a default value. The default values are: tempmonConfig->frequency = 0x02U; tempmonConfig->highAlarmTemp = 44U; tempmonConfig->panicAlarmTemp = 90U; tempmonConfig->lowAlarmTemp = 39U;

Parameters
configPointer to a configuration structure.

brief Gets the default configuration structure.

This function initializes the TEMPMON configuration structure to a default value. The default values are: tempmonConfig->frequency = 0x02U; tempmonConfig->highAlarmTemp = 44U; tempmonConfig->panicAlarmTemp = 90U; tempmonConfig->lowAlarmTemp = 39U;

param config Pointer to a configuration structure.

◆ TEMPMON_Init()

void TEMPMON_Init ( TEMPMON_Type base,
const tempmon_config_t config 
)

Initializes the TEMPMON module.

Parameters
baseTEMPMON base pointer
configPointer to configuration structure.

brief Initializes the TEMPMON module.

param base TEMPMON base pointer param config Pointer to configuration structure.

◆ TEMPMON_SetTempAlarm()

void TEMPMON_SetTempAlarm ( TEMPMON_Type base,
int8_t  tempVal,
tempmon_alarm_mode  alarmMode 
)

Set the temperature count (raw sensor output) that will generate an alarm interrupt.

Parameters
baseTEMPMON base pointer
tempValThe alarm temperature with degrees Celsius
alarmModeThe alarm mode.

brief Set the temperature count (raw sensor output) that will generate an alarm interrupt.

param base TEMPMON base pointer param tempVal The alarm temperature with degrees Celsius param alarmMode The alarm mode.

Variable Documentation

◆ frequency

uint16_t _tempmon_config::frequency

The temperature measure frequency.

◆ highAlarmTemp

int8_t _tempmon_config::highAlarmTemp

The high alarm temperature.

◆ lowAlarmTemp

int8_t _tempmon_config::lowAlarmTemp

The low alarm temperature.

◆ panicAlarmTemp

int8_t _tempmon_config::panicAlarmTemp

The panic alarm temperature.