LibXR::MSPM0PWM Class Reference

Inheritance diagram for LibXR::MSPM0PWM:

Collaboration diagram for LibXR::MSPM0PWM:

Classes
struct	Resources

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

Static Public Member Functions
static uint32_t	SourceClockFromSysCfg (GPTIMER_Regs *timer, uint32_t timer_clock_hz)
	由 SysConfig 的定时器时钟反推源时钟 / Source clock from SysConfig's timer clock.

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

禁用 PWM 输出 / Disables the PWM output.

Returns

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

Implements LibXR::PWM.

Definition at line 120 of file mspm0_pwm.cpp.

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

Enable()

ErrorCode MSPM0PWM::Enable ( )

virtual

启用 PWM 输出 / Enables the PWM output.

Returns

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

Implements LibXR::PWM.

Definition at line 114 of file mspm0_pwm.cpp.

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

SetConfig()

ErrorCode MSPM0PWM::SetConfig ( Configuration config )

virtual

配置 PWM 参数 / Configures the PWM settings.

Parameters

config

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

Returns

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

Implements LibXR::PWM.

Definition at line 64 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

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

Parameters

value

占空比，浮点值（0.0 到 1.0）。 The duty cycle as a floating-point value (0.0 to 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;
}

SourceClockFromSysCfg()

uint32_t MSPM0PWM::SourceClockFromSysCfg ( GPTIMER_Regs * timer, uint32_t timer_clock_hz )

static

由 SysConfig 的定时器时钟反推源时钟 / Source clock from SysConfig's timer clock.

Parameters

timer	定时器实例 / Timer instance.
timer_clock_hz	SysConfig 的 NAME_INST_CLK_FREQ（分频后）/ SysConfig's NAME_INST_CLK_FREQ (after the dividers).

Returns

分频前的定时器时钟 / Timer clock before the dividers.

Definition at line 56 of file mspm0_pwm.cpp.

{
  DL_Timer_ClockConfig config;
  DL_Timer_getClockConfig(timer, &config);
  return timer_clock_hz * (static_cast<uint32_t>(config.divideRatio) + 1U) *
         (static_cast<uint32_t>(config.prescale) + 1U);
}

---

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

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