LibXR::ESP32Watchdog Class Reference

Inheritance diagram for LibXR::ESP32Watchdog:

Collaboration diagram for LibXR::ESP32Watchdog:

Public Member Functions
	ESP32Watchdog (uint32_t timeout_ms=1000, uint32_t feed_ms=250)
ErrorCode	SetConfig (const Configuration &config) override
	初始化硬件并设置超时时间 Initialize hardware and set overflow time
ErrorCode	Feed () override
	立即手动喂狗 Feed the watchdog immediately
ErrorCode	Start () override
	启动看门狗 / Start the watchdog
ErrorCode	Stop () override
	停止看门狗 / Stop the watchdog
Public Member Functions inherited from LibXR::Watchdog
	Watchdog ()
	构造函数 Constructor
virtual	~Watchdog ()
	虚析构函数 Virtual destructor

Private Member Functions
ErrorCode	InitializeHardware ()
ErrorCode	ApplyConfiguration ()

Static Private Member Functions
static bool	IsInstanceSupported (wdt_inst_t instance)

Private Attributes
wdt_hal_context_t	hal_ {}
const wdt_inst_t	instance_ = kESP32WatchdogDefaultInstance
bool	initialized_ = false
bool	started_ = false

Additional Inherited Members
Static Public Member Functions inherited from LibXR::Watchdog
static void	ThreadFun (Watchdog *wdg)
	Watchdog 自动喂狗线程函数 Watchdog thread function for auto-feeding.
static void	TaskFun (Watchdog *wdg)
	Watchdog 自动喂狗定时器任务函数 Watchdog timer task function for auto-feeding.
Data Fields inherited from LibXR::Watchdog
uint32_t	timeout_ms_ = 3000
	溢出时间
uint32_t	auto_feed_interval_ms = 1000
	自动喂狗间隔
bool	auto_feed_ = false
	是否自动喂狗

Detailed Description

Definition at line 45 of file esp_watchdog.hpp.

Constructor & Destructor Documentation

ESP32Watchdog()

LibXR::ESP32Watchdog::ESP32Watchdog ( uint32_t timeout_ms = 1000, uint32_t feed_ms = 250 )

explicit

Definition at line 40 of file esp_watchdog.cpp.

{
  (void)SetConfig({timeout_ms, feed_ms});
  (void)Start();
}

Member Function Documentation

ApplyConfiguration()

ErrorCode LibXR::ESP32Watchdog::ApplyConfiguration ( )

private

Definition at line 100 of file esp_watchdog.cpp.

{
  if (!initialized_)
  {
    return ErrorCode::INIT_ERR;
  }
 
  const uint64_t ticks64 = static_cast<uint64_t>(timeout_ms_) * kWdtTicksPerMs;
  if ((ticks64 == 0) || (ticks64 > UINT32_MAX))
  {
    return ErrorCode::NOT_SUPPORT;
  }
 
  const uint32_t stage0_ticks = static_cast<uint32_t>(ticks64);
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_config_stage(&hal_, WDT_STAGE0, stage0_ticks, WDT_STAGE_ACTION_RESET_SYSTEM);
  wdt_hal_config_stage(&hal_, WDT_STAGE1, 0, WDT_STAGE_ACTION_OFF);
  wdt_hal_config_stage(&hal_, WDT_STAGE2, 0, WDT_STAGE_ACTION_OFF);
  wdt_hal_config_stage(&hal_, WDT_STAGE3, 0, WDT_STAGE_ACTION_OFF);
  wdt_hal_write_protect_enable(&hal_);
 
  return ErrorCode::OK;
}

Feed()

ErrorCode LibXR::ESP32Watchdog::Feed ( )

overridevirtual

立即手动喂狗 Feed the watchdog immediately

Returns

操作结果的错误码 Error code of the operation

Implements LibXR::Watchdog.

Definition at line 145 of file esp_watchdog.cpp.

{
  if (!initialized_ || !started_)
  {
    return ErrorCode::INIT_ERR;
  }
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_feed(&hal_);
  wdt_hal_write_protect_enable(&hal_);
  return ErrorCode::OK;
}

InitializeHardware()

ErrorCode LibXR::ESP32Watchdog::InitializeHardware ( )

private

Definition at line 63 of file esp_watchdog.cpp.

{
  if (initialized_)
  {
    return ErrorCode::OK;
  }
 
  if (!IsInstanceSupported(instance_))
  {
    return ErrorCode::NOT_SUPPORT;
  }
 
  if (instance_ != WDT_RWDT)
  {
    int group_id = 0;
    periph_module_t periph = PERIPH_TIMG0_MODULE;
    if (!GetMwdtGroupInfo(instance_, &group_id, &periph))
    {
      return ErrorCode::NOT_SUPPORT;
    }
 
    PERIPH_RCC_ACQUIRE_ATOMIC(periph, ref_count)
    {
      if (ref_count == 0)
      {
        timer_ll_enable_bus_clock(group_id, true);
        timer_ll_reset_register(group_id);
      }
    }
  }
 
  const uint32_t prescaler = instance_ == WDT_RWDT ? 0U : MWDT_LL_DEFAULT_CLK_PRESCALER;
  wdt_hal_init(&hal_, instance_, prescaler, false);
  initialized_ = true;
  return ErrorCode::OK;
}

IsInstanceSupported()

bool LibXR::ESP32Watchdog::IsInstanceSupported ( wdt_inst_t instance )

staticprivate

Definition at line 46 of file esp_watchdog.cpp.

{
  switch (instance)
  {
    case WDT_MWDT0:
      return true;
#if SOC_TIMER_GROUPS >= 2
    case WDT_MWDT1:
      return true;
#endif
    case WDT_RWDT:
      return true;
    default:
      return false;
  }
}

SetConfig()

ErrorCode LibXR::ESP32Watchdog::SetConfig ( const Configuration & config )

overridevirtual

初始化硬件并设置超时时间 Initialize hardware and set overflow time

Parameters

config

配置参数 Configuration

Returns

操作结果的错误码 Error code of the operation

Implements LibXR::Watchdog.

Definition at line 125 of file esp_watchdog.cpp.

{
  if ((config.timeout_ms == 0) || (config.feed_ms == 0) ||
      (config.feed_ms > config.timeout_ms))
  {
    return ErrorCode::ARG_ERR;
  }
 
  timeout_ms_ = config.timeout_ms;
  auto_feed_interval_ms = config.feed_ms;
 
  ErrorCode ret = InitializeHardware();
  if (ret != ErrorCode::OK)
  {
    return ret;
  }
 
  return ApplyConfiguration();
}

Start()

ErrorCode LibXR::ESP32Watchdog::Start ( )

overridevirtual

启动看门狗 / Start the watchdog

Implements LibXR::Watchdog.

Definition at line 158 of file esp_watchdog.cpp.

{
  ErrorCode ret = InitializeHardware();
  if (ret != ErrorCode::OK)
  {
    return ret;
  }
 
  ret = ApplyConfiguration();
  if (ret != ErrorCode::OK)
  {
    return ret;
  }
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_enable(&hal_);
  wdt_hal_feed(&hal_);
  wdt_hal_write_protect_enable(&hal_);
 
  auto_feed_ = true;
  started_ = true;
  return ErrorCode::OK;
}

Stop()

ErrorCode LibXR::ESP32Watchdog::Stop ( )

overridevirtual

停止看门狗 / Stop the watchdog

Implements LibXR::Watchdog.

Definition at line 182 of file esp_watchdog.cpp.

{
  if (!initialized_)
  {
    return ErrorCode::INIT_ERR;
  }
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_disable(&hal_);
  wdt_hal_write_protect_enable(&hal_);
 
  auto_feed_ = false;
  started_ = false;
  return ErrorCode::OK;
}

Field Documentation

hal_

wdt_hal_context_t LibXR::ESP32Watchdog::hal_ {}

private

Definition at line 60 of file esp_watchdog.hpp.

{};

initialized_

bool LibXR::ESP32Watchdog::initialized_ = false

private

Definition at line 62 of file esp_watchdog.hpp.

instance_

const wdt_inst_t LibXR::ESP32Watchdog::instance_ = kESP32WatchdogDefaultInstance

private

Definition at line 61 of file esp_watchdog.hpp.

started_

bool LibXR::ESP32Watchdog::started_ = false

private

Definition at line 63 of file esp_watchdog.hpp.

---

The documentation for this class was generated from the following files:

• driver/esp/esp_watchdog.hpp
• driver/esp/esp_watchdog.cpp