LibXR::STM32Watchdog Class Reference

STM32 IWDG 独立看门狗 / Independent Watchdog. More...

#include <stm32_watchdog.hpp>

Inheritance diagram for LibXR::STM32Watchdog:

Collaboration diagram for LibXR::STM32Watchdog:

Public Member Functions
	STM32Watchdog (IWDG_HandleTypeDef *hiwdg, uint32_t timeout_ms=1000, uint32_t feed_ms=250, uint32_t clock=LSI_VALUE)
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

Data Fields
IWDG_HandleTypeDef *	hiwdg_
	STM32 HAL IWDG handle.
uint32_t	clock_
	LSI clock in Hz.
Data Fields inherited from LibXR::Watchdog
uint32_t	timeout_ms_ = 3000
	溢出时间
uint32_t	auto_feed_interval_ms = 1000
	自动喂狗间隔
bool	auto_feed_ = 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.

Detailed Description

STM32 IWDG 独立看门狗 / Independent Watchdog.

Definition at line 16 of file stm32_watchdog.hpp.

Constructor & Destructor Documentation

STM32Watchdog()

STM32Watchdog::STM32Watchdog ( IWDG_HandleTypeDef * hiwdg, uint32_t timeout_ms = 1000, uint32_t feed_ms = 250, uint32_t clock = LSI_VALUE )

explicit

Definition at line 7 of file stm32_watchdog.cpp.

    : hiwdg_(hiwdg), clock_(clock)
{
  ASSERT(hiwdg);
  SetConfig({timeout_ms, feed_ms});
  Start();
}

Member Function Documentation

Feed()

ErrorCode STM32Watchdog::Feed ( )

overridevirtual

立即手动喂狗 Feed the watchdog immediately

Returns

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

Implements LibXR::Watchdog.

Definition at line 74 of file stm32_watchdog.cpp.

{
  return HAL_IWDG_Refresh(hiwdg_) == HAL_OK ? ErrorCode::OK : ErrorCode::FAILED;
}

SetConfig()

ErrorCode STM32Watchdog::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 16 of file stm32_watchdog.cpp.

{
  if (config.feed_ms == 0 || config.timeout_ms == 0 || config.feed_ms > config.timeout_ms)
  {
    ASSERT(false);
    return ErrorCode::ARG_ERR;
  }
 
  /* 分频与重载自动计算 / Prescaler & reload auto calculation */
  static const struct
  {
    uint8_t pr;
    uint16_t div;
  } TABLE[] = {{0, 4}, {1, 8}, {2, 16}, {3, 32}, {4, 64}, {5, 128}, {6, 256}};
  uint32_t lsi = clock_;
  uint8_t best_pr = 6;
  uint16_t best_rlr = 0xFFF;
  bool found = false;
 
  for (const auto& item : TABLE)
  {
    uint32_t prescaler = item.div;
    uint32_t reload = (config.timeout_ms * lsi) / (1000 * prescaler);
    if (reload == 0)
    {
      reload = 1;
    }
    if (reload > 1)
    {
      reload--;
    }
    if (reload <= 0xFFF)
    {
      best_pr = item.pr;
      best_rlr = static_cast<uint16_t>(reload);
      found = true;
      break;
    }
  }
  if (!found)
  {
    return ErrorCode::NOT_SUPPORT;
  }
 
  timeout_ms_ = config.timeout_ms;
  auto_feed_interval_ms = config.feed_ms;
 
  hiwdg_->Init.Prescaler = best_pr;
  hiwdg_->Init.Reload = best_rlr;
#if defined(IWDG)
  hiwdg_->Instance = IWDG;  // NOLINT
#elif defined(IWDG1)
  hiwdg_->Instance = IWDG1;  // NOLINT
#endif
 
  return ErrorCode::OK;
}

Start()

ErrorCode STM32Watchdog::Start ( )

overridevirtual

启动看门狗 / Start the watchdog

Implements LibXR::Watchdog.

Definition at line 79 of file stm32_watchdog.cpp.

{
  auto_feed_ = true;
  if (HAL_IWDG_Init(hiwdg_) != HAL_OK)
  {
    return ErrorCode::FAILED;
  }
  return ErrorCode::OK;
}

Stop()

ErrorCode STM32Watchdog::Stop ( )

overridevirtual

停止看门狗 / Stop the watchdog

Implements LibXR::Watchdog.

Definition at line 89 of file stm32_watchdog.cpp.

{
  /* STM32 IWDG 不支持关闭 */
  auto_feed_ = false;
  return ErrorCode::NOT_SUPPORT;
}

Field Documentation

clock_

uint32_t LibXR::STM32Watchdog::clock_

LSI clock in Hz.

Definition at line 31 of file stm32_watchdog.hpp.

hiwdg_

IWDG_HandleTypeDef* LibXR::STM32Watchdog::hiwdg_

STM32 HAL IWDG handle.

Definition at line 30 of file stm32_watchdog.hpp.

---

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

• driver/st/stm32_watchdog.hpp
• driver/st/stm32_watchdog.cpp