fsl_tempsensor.h

Go to the documentation of this file.

/*
 * Copyright 2020-2022 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef _FSL_TEMPMON_H_
#define _FSL_TEMPMON_H_
 
#include "fsl_common.h"
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#define FSL_TMPSNS_DRIVER_VERSION (MAKE_VERSION(2, 1, 0))
enum
{
    kTEMPSENSOR_HighTempInterruptStatusEnable =
        TMPSNS_CTRL1_HIGH_TEMP_IE_MASK, 
    kTEMPSENSOR_LowTempInterruptStatusEnable =
        TMPSNS_CTRL1_LOW_TEMP_IE_MASK, 
    kTEMPSENSOR_PanicTempInterruptStatusEnable =
        TMPSNS_CTRL1_PANIC_TEMP_IE_MASK, 
    kTEMPSENSOR_FinishInterruptStatusEnable = TMPSNS_CTRL1_FINISH_IE_MASK, 
};
 
enum
{
    kTEMPSENSOR_HighTempInterruptStatus  = TMPSNS_STATUS0_HIGH_TEMP_MASK,  
    kTEMPSENSOR_LowTempInterruptStatus   = TMPSNS_STATUS0_LOW_TEMP_MASK,   
    kTEMPSENSOR_PanicTempInterruptStatus = TMPSNS_STATUS0_PANIC_TEMP_MASK, 
};
 
typedef enum
{
    kTEMPSENSOR_SingleMode     = 0U, 
    kTEMPSENSOR_ContinuousMode = 1U, 
} tmpsns_measure_mode_t;
 
typedef struct _tmpsns_config
{
    tmpsns_measure_mode_t measureMode; 
    uint16_t frequency;                
    int32_t highAlarmTemp;             
    int32_t panicAlarmTemp;            
    int32_t lowAlarmTemp;              
} tmpsns_config_t;
 
typedef enum _tmpsns_alarm_mode
{
    kTEMPMON_HighAlarmMode  = 0U, 
    kTEMPMON_PanicAlarmMode = 1U, 
    kTEMPMON_LowAlarmMode   = 2U, 
} tmpsns_alarm_mode_t;
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif
 
void TMPSNS_Init(TMPSNS_Type *base, const tmpsns_config_t *config);
 
void TMPSNS_Deinit(TMPSNS_Type *base);
 
void TMPSNS_GetDefaultConfig(tmpsns_config_t *config);
 
void TMPSNS_StartMeasure(TMPSNS_Type *base);
 
void TMPSNS_StopMeasure(TMPSNS_Type *base);
 
float TMPSNS_GetCurrentTemperature(TMPSNS_Type *base);
 
void TMPSNS_SetTempAlarm(TMPSNS_Type *base, int32_t tempVal, tmpsns_alarm_mode_t alarmMode);
 
void TMPSNS_EnableInterrupt(TMPSNS_Type *base, uint32_t mask);
 
void TMPSNS_DisableInterrupt(TMPSNS_Type *base, uint32_t mask);
 
static inline uint32_t TMPSNS_GetInterruptFlags(TMPSNS_Type *base)
{
    return base->STATUS0;
}
 
static inline void TMPSNS_ClearInterruptFlags(TMPSNS_Type *base, uint32_t mask)
{
    base->STATUS0 = mask;
}
 
#if defined(__cplusplus)
}
#endif
 
#endif /* _FSL_TEMPMON_H_ */