temp_sensor.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef TEMP_SENSOR_H_
#define TEMP_SENSOR_H_

 
#include "i2c/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ========================================================================== */
/* SUB-GROUP : Data Types                                                    */
/* ========================================================================== */


 
        
    typedef enum {
        TEMP_SENSOR_OK          = 0,    
        TEMP_SENSOR_ERR         = 1,    
        TEMP_SENSOR_USER_ERR    = 2,    
        TEMP_SENSOR_SKIP        = 3,    
        TEMP_SENSOR_HIGH_ALERT  = 4,    
        TEMP_SENSOR_LOW_ALERT   = 5,    
    } temp_sensor_status_t;
    // End of TEMP_SENSOR_ENUM group
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                     */
/* ========================================================================== */
    typedef struct temp_sensor_instance temp_sensor_instance_t;

    typedef struct {
        float current_temp;     
        float high_limit;       
        float low_limit;        
    }temp_sensor_channelData_t;

    typedef struct {
        temp_sensor_channelData_t channels[3]; // Supports up to 3 diodes
    } temp_sensor_data_t;

    typedef struct {
        temp_sensor_status_t (*applyConfig)(temp_sensor_instance_t *temp);
        temp_sensor_status_t (*enableErrorInterrupt)(temp_sensor_instance_t *temp);
        temp_sensor_status_t (*getTemp)(temp_sensor_instance_t *temp);
        temp_sensor_status_t (*getTempLimit)(temp_sensor_instance_t *temp);
        temp_sensor_status_t (*setTempRange)(temp_sensor_instance_t *temp, u8 enable_extended);
        temp_sensor_status_t (*setTempLimit)(temp_sensor_instance_t *temp);
        temp_sensor_status_t (*checkTempAlert)(temp_sensor_instance_t *temp);
        u8 (*checkTempRange)(temp_sensor_instance_t *temp);
    }temp_sensor_api_t;
             
    struct temp_sensor_instance{
        i2c_instance_t          *inst;          
        const temp_sensor_api_t *drv;           
        temp_sensor_data_t      temp_value;     
    } ;
 // End of TEMP_SENSOR_Types group
 
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                     */
/* ========================================================================== */

    temp_sensor_status_t tempSensor_applyConfig(temp_sensor_instance_t *temp);
    temp_sensor_status_t tempSensor_enableErrorInterrupt(temp_sensor_instance_t *temp);
    u8 tempSensor_readTempReg(temp_sensor_instance_t *temp, const u8 reg);
    u8 tempSensor_writeTempReg(temp_sensor_instance_t *temp, const u8 reg, const u8 data);
    u8 tempSensor_encodeTempLimit(float val, u8 is_extended, u8 *out_hb, u8 *out_lb);
    float tempSensor_calTempCelsius(u8 hb, u8 lb, u8 is_extended); // End of TEMP_SENSOR_Funcs group
 
 
 
/* ========================================================================== */
/* SUB-GROUP: TEMP SENSOR CONFIGURATION                                       */
/* ========================================================================== */

#include "sensor/temp_sensor/temp_sensor_config.h"
 
#ifdef __cplusplus
 
}
#endif //End of TEMP_SENSOR group
 
#endif /* TEMP_SENSOR_H_ */