EspTypes_Base.h

Go to the documentation of this file.

 
#pragma once
 
#include "../../utils/McuSelect.h" // Central MCU platform selection (includes all ESP-IDF headers)
#include "HardwareTypes.h"
#include <atomic>
#include <cstdint>
 
//==============================================================================
// BASIC TYPE DEFINITIONS
//==============================================================================
 
using hf_timeout_ms_t = uint32_t;
 
//==============================================================================
// ESP32-SPECIFIC CONSTANTS
//==============================================================================
 
static constexpr hf_timeout_ms_t HF_TIMEOUT_NEVER = 0xFFFFFFFF;
static constexpr hf_timeout_ms_t HF_TIMEOUT_IMMEDIATE = 0;
static constexpr hf_timeout_ms_t HF_TIMEOUT_DEFAULT = 1000;
 
// Missing ADC constants
static constexpr uint32_t HF_ADC_DEFAULT_SAMPLING_FREQ = 1000U;
static constexpr size_t HF_ADC_DMA_BUFFER_SIZE_DEFAULT = 1024U;
 
//==============================================================================
// ESP32 TIMING CONVERSION MACROS
//==============================================================================
 
#define HF_TICKS_FROM_MS(ms) (pdMS_TO_TICKS(ms))
#define HF_MS_FROM_TICKS(ticks) ((ticks) * portTICK_PERIOD_MS)
#define HF_US_TO_TICKS(us) ((us) / (portTICK_PERIOD_MS * 1000))
#define HF_TICKS_TO_US(ticks) ((ticks) * portTICK_PERIOD_MS * 1000)
 
//==============================================================================
// ESP32 POWER MANAGEMENT AND TIMING TYPES
//==============================================================================
 
enum class hf_power_domain_t : uint8_t {
  HF_POWER_DOMAIN_CPU = 0,    
  HF_POWER_DOMAIN_RTC_PERIPH, 
  HF_POWER_DOMAIN_XTAL,       
  HF_POWER_DOMAIN_MODEM,      
  HF_POWER_DOMAIN_VDDSDIO,    
  HF_POWER_DOMAIN_TOP,        
};
 
enum class hf_sleep_mode_t : uint8_t {
  HF_SLEEP_MODE_NONE = 0,    
  HF_SLEEP_MODE_LIGHT,       
  HF_SLEEP_MODE_DEEP,        
  HF_SLEEP_MODE_HIBERNATION, 
};
 
using hf_timestamp_us_t = uint64_t; 
using hf_timestamp_ns_t = uint64_t; 
using hf_duration_us_t = uint32_t;  
using hf_duration_ns_t = uint32_t;