LibXR::STM32PWM Class Reference

Inheritance diagram for LibXR::STM32PWM:

Collaboration diagram for LibXR::STM32PWM:

Public Member Functions
	STM32PWM (TIM_HandleTypeDef *htim, uint32_t channel, bool complementary=false)
ErrorCode	SetDutyCycle (float value) override
	Sets the duty cycle of the PWM signal. 设置 PWM 信号的占空比。
ErrorCode	SetConfig (Configuration config) override
	Configures the PWM settings. 配置 PWM 参数。
ErrorCode	Enable () override
	Enables the PWM output. 启用 PWM 输出。
ErrorCode	Disable () override
	Disables the PWM output. 禁用 PWM 输出。
Public Member Functions inherited from LibXR::PWM

Private Attributes
TIM_HandleTypeDef *	htim_
uint32_t	channel_
bool	complementary_

Detailed Description

Definition at line 12 of file stm32_pwm.hpp.

Constructor & Destructor Documentation

STM32PWM()

STM32PWM::STM32PWM	(	TIM_HandleTypeDef *	htim,
		uint32_t	channel,
		bool	complementary = false )

Definition at line 7 of file stm32_pwm.cpp.

    : htim_(htim), channel_(channel), complementary_(complementary)
{
}

Member Function Documentation

Disable()

ErrorCode STM32PWM::Disable ( )

overridevirtual

Disables the PWM output. 禁用 PWM 输出。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 181 of file stm32_pwm.cpp.

{
  if (!complementary_)
  {
    if (HAL_TIM_PWM_Stop(htim_, channel_) != HAL_OK)
    {
      return ErrorCode::FAILED;
    }
  }
  else
  {
    if (HAL_TIMEx_PWMN_Stop(htim_, channel_) != HAL_OK)
    {
      return ErrorCode::FAILED;
    }
  }
  return ErrorCode::OK;
}

Enable()

ErrorCode STM32PWM::Enable ( )

overridevirtual

Enables the PWM output. 启用 PWM 输出。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 162 of file stm32_pwm.cpp.

{
  if (!complementary_)
  {
    if (HAL_TIM_PWM_Start(htim_, channel_) != HAL_OK)
    {
      return ErrorCode::FAILED;
    }
  }
  else
  {
    if (HAL_TIMEx_PWMN_Start(htim_, channel_) != HAL_OK)
    {
      return ErrorCode::FAILED;
    }
  }
  return ErrorCode::OK;
}

SetConfig()

ErrorCode STM32PWM::SetConfig ( Configuration config )

overridevirtual

Configures the PWM settings. 配置 PWM 参数。

Parameters

config

The configuration structure containing PWM settings. 配置结构体，包含 PWM 设置。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 31 of file stm32_pwm.cpp.

{
  uint32_t clock_freq = 0;  // NOLINT
 
#if defined(STM32F0) || defined(STM32G0)
  // STM32F0 and STM32 G0 do not have PCLK1/PCLK2，use HCLK as reference clock
  clock_freq = HAL_RCC_GetHCLKFreq();
#else
  uint32_t& target_freq = config.frequency;
  if (target_freq == 0)
  {
    return ErrorCode::ARG_ERR;
  }
  else if (
#if defined(TIM1)
      htim_->Instance == TIM1 ||
#endif
#if defined(TIM8)
      htim_->Instance == TIM8 ||
#endif
#if defined(TIM9)
      htim_->Instance == TIM9 ||
#endif
#if defined(TIM10)
      htim_->Instance == TIM10 ||
#endif
#if defined(TIM11)
      htim_->Instance == TIM11 ||
#endif
#if defined(TIM15)
      htim_->Instance == TIM15 ||
#endif
#if defined(TIM16)
      htim_->Instance == TIM16 ||
#endif
#if defined(TIM17)
      htim_->Instance == TIM17 ||
#endif
#if defined(TIM20)
      htim_->Instance == TIM20 ||
#endif
      false)
  {
    clock_freq = HAL_RCC_GetPCLK2Freq();
#ifdef RCC_CFGR_PPRE2
    if ((RCC->CFGR & RCC_CFGR_PPRE2) != RCC_CFGR_PPRE2_DIV1)
    {
      clock_freq *= 2;
    }
#endif
  }
  else if (
#if defined(TIM2)
      htim_->Instance == TIM2 ||
#endif
#if defined(TIM3)
      htim_->Instance == TIM3 ||
#endif
#if defined(TIM4)
      htim_->Instance == TIM4 ||
#endif
#if defined(TIM5)
      htim_->Instance == TIM5 ||
#endif
#if defined(TIM6)
      htim_->Instance == TIM6 ||
#endif
#if defined(TIM7)
      htim_->Instance == TIM7 ||
#endif
#if defined(TIM12)
      htim_->Instance == TIM12 ||
#endif
#if defined(TIM13)
      htim_->Instance == TIM13 ||
#endif
#if defined(TIM14)
      htim_->Instance == TIM14 ||
#endif
      false)
  {
    clock_freq = HAL_RCC_GetPCLK1Freq();
#ifdef RCC_CFGR_PPRE1
    if ((RCC->CFGR & RCC_CFGR_PPRE1) != RCC_CFGR_PPRE1_DIV1)
    {
      clock_freq *= 2;
    }
#endif
  }
  else
  {
    return ErrorCode::NOT_SUPPORT;
  }
#endif
 
  if (clock_freq == 0)
  {
    return ErrorCode::INIT_ERR;
  }
 
  bool found = false;
 
  uint32_t prescaler = 1;
  uint32_t period = 0;
 
  for (prescaler = 1; prescaler <= 0xFFFF; ++prescaler)
  {
    uint32_t temp_period = clock_freq / (prescaler * config.frequency);
    if (temp_period <= 0x10000)
    {
      period = temp_period;
      found = true;
      break;
    }
  }
 
  if (!found || period == 0)
  {
    return ErrorCode::INIT_ERR;
  }
 
  htim_->Init.Prescaler = prescaler - 1;
  htim_->Init.Period = period - 1;
 
  if (HAL_TIM_PWM_Init(htim_) != HAL_OK)
  {
    return ErrorCode::INIT_ERR;
  }
  return ErrorCode::OK;
}

SetDutyCycle()

ErrorCode STM32PWM::SetDutyCycle ( float value )

overridevirtual

Sets the duty cycle of the PWM signal. 设置 PWM 信号的占空比。

Parameters

value

The duty cycle as a floating-point value (0.0 to 1.0). 占空比，浮点值（0.0 到 1.0）。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 12 of file stm32_pwm.cpp.

{
  if (value < 0.0f)
  {
    value = 0.0f;
  }
  else if (value > 1.0f)
  {
    value = 1.0f;
  }
 
  uint32_t pulse =
      static_cast<uint32_t>(static_cast<float>(htim_->Init.Period + 1) * value);
 
  __HAL_TIM_SET_COMPARE(htim_, channel_, pulse);
 
  return ErrorCode::OK;
}

Field Documentation

channel_

uint32_t LibXR::STM32PWM::channel_

private

Definition at line 27 of file stm32_pwm.hpp.

complementary_

bool LibXR::STM32PWM::complementary_

private

Definition at line 28 of file stm32_pwm.hpp.

htim_

TIM_HandleTypeDef* LibXR::STM32PWM::htim_

private

Definition at line 26 of file stm32_pwm.hpp.

---

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

• driver/st/stm32_pwm.hpp
• driver/st/stm32_pwm.cpp