LibXR::MSPM0PWM Class Reference

Inheritance diagram for LibXR::MSPM0PWM:

Collaboration diagram for LibXR::MSPM0PWM:

Data Structures
struct	Resources

Public Member Functions
	MSPM0PWM (Resources res)
ErrorCode	SetDutyCycle (float value)
	Sets the duty cycle of the PWM signal. 设置 PWM 信号的占空比。
ErrorCode	SetConfig (Configuration config)
	Configures the PWM settings. 配置 PWM 参数。
ErrorCode	Enable ()
	Enables the PWM output. 启用 PWM 输出。
ErrorCode	Disable ()
	Disables the PWM output. 禁用 PWM 输出。
Public Member Functions inherited from LibXR::PWM

Private Attributes
GPTIMER_Regs *	timer_
DL_TIMER_CC_INDEX	channel_
uint32_t	clock_freq_

Detailed Description

Definition at line 9 of file mspm0_pwm.hpp.

Constructor & Destructor Documentation

MSPM0PWM()

MSPM0PWM::MSPM0PWM

(

MSPM0PWM::Resources

res

)

Definition at line 9 of file mspm0_pwm.cpp.

    : timer_(res.timer), channel_(res.channel), clock_freq_(res.clock_freq)
{
  ASSERT(timer_ != nullptr);
  ASSERT(clock_freq_ > 0);
}

Member Function Documentation

Disable()

ErrorCode MSPM0PWM::Disable ( )

virtual

Disables the PWM output. 禁用 PWM 输出。

Returns

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

Implements LibXR::PWM.

Definition at line 112 of file mspm0_pwm.cpp.

{
  DL_Timer_stopCounter(timer_);
  return ErrorCode::OK;
}

Enable()

ErrorCode MSPM0PWM::Enable ( )

virtual

Enables the PWM output. 启用 PWM 输出。

Returns

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

Implements LibXR::PWM.

Definition at line 106 of file mspm0_pwm.cpp.

{
  DL_Timer_startCounter(timer_);
  return ErrorCode::OK;
}

SetConfig()

ErrorCode MSPM0PWM::SetConfig ( Configuration config )

virtual

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 56 of file mspm0_pwm.cpp.

{
  const uint32_t SOURCE_CLOCK = clock_freq_;
  if (config.frequency > SOURCE_CLOCK || config.frequency == 0)
  {
    return ErrorCode::ARG_ERR;
  }
 
  const uint32_t TOTAL_CYCLES_NEEDED = SOURCE_CLOCK / config.frequency;
  uint32_t min_total_prescale = (TOTAL_CYCLES_NEEDED + MAX_TIMER_LOAD) >> 16;
  if (min_total_prescale == 0)
  {
    min_total_prescale = 1;
  }
 
  uint32_t best_div = (min_total_prescale + MAX_PRESCALER - 1) >> 8;
  if (best_div > MAX_DIVIDE_RATIO)
  {
    return ErrorCode::NOT_SUPPORT;  // Frequency too low
  }
  if (best_div == 0)
  {
    best_div = 1;
  }
 
  uint32_t best_prescaler = (min_total_prescale + best_div - 1) / best_div;
  if (best_prescaler == 0)
  {
    best_prescaler = 1;
  }
 
  uint32_t best_load = (SOURCE_CLOCK / (best_div * best_prescaler * config.frequency));
  if (best_load == 0)
  {
    return ErrorCode::NOT_SUPPORT;  // Frequency too high to represent
  }
  best_load -= 1;
 
  DL_Timer_ClockConfig clock_config;
  DL_Timer_getClockConfig(timer_, &clock_config);
 
  clock_config.divideRatio = static_cast<DL_TIMER_CLOCK_DIVIDE>(best_div - 1);
  clock_config.prescale = static_cast<uint8_t>(best_prescaler - 1);
 
  DL_Timer_setClockConfig(timer_, &clock_config);
  DL_Timer_setLoadValue(timer_, best_load);
 
  return ErrorCode::OK;
}

SetDutyCycle()

ErrorCode MSPM0PWM::SetDutyCycle ( float value )

virtual

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 16 of file mspm0_pwm.cpp.

{
  if (value < 0.0f)
  {
    value = 0.0f;
  }
  if (value > 1.0f)
  {
    value = 1.0f;
  }
 
  uint32_t period = DL_Timer_getLoadValue(timer_);
  uint32_t compare_value = 0;
  DL_TIMER_COUNT_MODE count_mode = DL_Timer_getCounterMode(timer_);
 
  switch (count_mode)
  {
    case DL_TIMER_COUNT_MODE_DOWN:
      compare_value = static_cast<uint32_t>(static_cast<float>(period) * (1.0f - value));
      break;
 
    case DL_TIMER_COUNT_MODE_UP:
    case DL_TIMER_COUNT_MODE_UP_DOWN:
      compare_value = static_cast<uint32_t>(static_cast<float>(period) * value);
      break;
 
    default:
      return ErrorCode::NOT_SUPPORT;
  }
 
  if (compare_value > period)
  {
    compare_value = period;
  }
 
  DL_Timer_setCaptureCompareValue(timer_, compare_value, channel_);
 
  return ErrorCode::OK;
}

Field Documentation

channel_

DL_TIMER_CC_INDEX LibXR::MSPM0PWM::channel_

private

Definition at line 31 of file mspm0_pwm.hpp.

clock_freq_

uint32_t LibXR::MSPM0PWM::clock_freq_

private

Definition at line 32 of file mspm0_pwm.hpp.

timer_

GPTIMER_Regs* LibXR::MSPM0PWM::timer_

private

Definition at line 30 of file mspm0_pwm.hpp.

---

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

• driver/mspm0/mspm0_pwm.hpp
• driver/mspm0/mspm0_pwm.cpp