RV32 SoC DS UG
High-Perf RV32 SoC DS UG
RV64 SoC DS UG API and Examples
Embedded IDE UG
Loading...
Searching...
No Matches
temp_sensor_api_t Struct Reference
Hardware Drivers » Sensors » Temperature Sensor Driver » Data Structures

#include <temp_sensor.h>

Data Fields

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)

Detailed Description

Temperature Sensor API structure.

Note
This structure holds function pointers for Temperature Sensor operations.
  • applyConfig: Function to apply I2C and temperature configuration.
  • enableErrorInterrupt: Function to enable error interrupt.
  • getTemp: Function to get current temperature.
  • getTempLimit: Function to get temperature limits.
  • setTempRange: Function to set temperature range (extended or normal).
  • setTempLimit: Function to set temperature limits.
  • checkTempRange: Function to check if temperature is within range.
  • checkTempAlert: Function to check for temperature alerts.

Definition at line 173 of file temp_sensor.h.

Field Documentation

◆ applyConfig

temp_sensor_status_t(* temp_sensor_api_t::applyConfig) (temp_sensor_instance_t *temp)

Definition at line 174 of file temp_sensor.h.

◆ checkTempAlert

temp_sensor_status_t(* temp_sensor_api_t::checkTempAlert) (temp_sensor_instance_t *temp)

Definition at line 180 of file temp_sensor.h.

◆ checkTempRange

u8(* temp_sensor_api_t::checkTempRange) (temp_sensor_instance_t *temp)

Definition at line 181 of file temp_sensor.h.

◆ enableErrorInterrupt

temp_sensor_status_t(* temp_sensor_api_t::enableErrorInterrupt) (temp_sensor_instance_t *temp)

Definition at line 175 of file temp_sensor.h.

◆ getTemp

temp_sensor_status_t(* temp_sensor_api_t::getTemp) (temp_sensor_instance_t *temp)

Definition at line 176 of file temp_sensor.h.

◆ getTempLimit

temp_sensor_status_t(* temp_sensor_api_t::getTempLimit) (temp_sensor_instance_t *temp)

Definition at line 177 of file temp_sensor.h.

◆ setTempLimit

temp_sensor_status_t(* temp_sensor_api_t::setTempLimit) (temp_sensor_instance_t *temp)

Definition at line 179 of file temp_sensor.h.

◆ setTempRange

temp_sensor_status_t(* temp_sensor_api_t::setTempRange) (temp_sensor_instance_t *temp, u8 enable_extended)

Definition at line 178 of file temp_sensor.h.

The documentation for this struct was generated from the following file:
  • C:/Users/JasonLau/Downloads/workspace_local/GitLab/efx_IP/efx_soc_rv64/embedded_sw/software/standalone/driver/sensor/temp_sensor/temp_sensor.h