Sapphire SoC DS Sapphire SoC UG Sapphire HP SoC DS Sapphire HP SoC UG RISC-V Embedded IDE UG Board Support Package
Loading...
Searching...
No Matches
temp_sensor.h File Reference

Go to the source code of this file.

Overview

Temperature Sensor driver API definitions.

Author
Efinix Inc

This file provides data structures and APIs for controlling the Temperature Sensor peripheral on the EfxSapphireSoC platform.

Definition in file temp_sensor.h.

Data Structures

struct  temp_sensor_channelData_t
 Hold temperature data for a single channel/diode. More...
struct  temp_sensor_data_t
 Temperature Sensor data structure. More...
struct  temp_sensor_api_t
 Temperature Sensor API structure. More...
struct  temp_sensor_instance
 Temperature Sensor instance structure. More...

Typedefs

typedef struct temp_sensor_instance temp_sensor_instance_t
 Forward declaration of Temperature Sensor instance.

Enumerations

Callback Enums

Enums used for driver callback handling.

Note
Used to indicate success or failure of Temperature Sensor operations.
enum  temp_sensor_status_t {
  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
}
 Temperature Sensor Status List. More...

Functions

u8 temp_readTempReg (temp_sensor_instance_t *temp, const u8 reg)
 Read a register from the Temperature Sensor.
u8 temp_writeTempReg (temp_sensor_instance_t *temp, const u8 reg, const u8 data)
 Write a value to a register in the Temperature Sensor.
u8 encode_temp_limit (float val, u8 is_extended, u8 *out_hb, u8 *out_lb)
 Encode temperature limit into high and low byte format.
float calculate_temp_celsius (u8 hb, u8 lb, u8 is_extended)
 Calculate temperature in Celsius from high and low byte format.