Pwm

This section introduces the Pulse-Width Modulation (PWM) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions. More...

Overview

This section introduces the Pulse-Width Modulation (PWM) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions.

Terms and Acronyms

Terms	Details
PWM	Pulse-Width Modulation.

Supported Features

See Supported Features for the details of Supported Features.

How to use this driver

• Device driver sample code is as follows:
  
  • sample code (this is the user application sample code on freeRTos):

    -PWM normal mode:
    
      -Initialize the PWM module.
          - Call mtk_os_hal_pwm_ctlr_init(pwm_groups group_num,
          u32 channel_bit_map)
    
      -Select PWM global kick, IO ctrl, polarity setting.
          - Call mtk_os_hal_pwm_feature_enable(pwm_groups group_num,
          pwm_channels pwm_num,
          bool global_kick_enable,
          bool io_ctrl_sel,
          bool polarity_set)
    
      -Config normal mode freq & duty.
          - Call mtk_os_hal_pwm_config_freq_duty_normal(
          pwm_groups group_num, pwm_channels pwm_num,
          u32  frequency, u32  duty_cycle)
    
      -Enable pwm waveform output.
          - Call mtk_os_hal_pwm_start_normal(pwm_groups group_num,
          pwm_channels pwm_num)
    
      -Disabe pwm waveform output.
          - Call mtk_os_hal_pwm_stop_normal(pwm_groups group_num,
          pwm_channels pwm_num)
    
      -Release the PWM module back to its original state.
          - Call mtk_os_hal_pwm_ctlr_deinit(pwm_groups group_num,
          u32 channel_bit_map)
    
    
    - PWM 2-state mode:
    
      -Initialize the PWM module.
          - Call mtk_os_hal_pwm_ctlr_init(pwm_groups group_num,
          u32 channel_bit_map)
    
      -Select PWM global kick, IO ctrl, polarity setting.
          - Call mtk_os_hal_pwm_feature_enable(pwm_groups group_num,
          pwm_channels pwm_num,
          bool global_kick_enable,
          bool io_ctrl_sel,
          bool polarity_set)
    
      -Set PWM  frequency and duty cycle of S0 stage in 2-state mode.
          - Call mtk_os_hal_pwm_config_freq_duty_2_state(
          pwm_groups group_num,
          pwm_channels pwm_num,
          struct mtk_com_pwm_data state_config)
    
      -Set PWM  frequency and duty cycle of S1 stage in 2-state mode.
          - Call mtk_os_hal_pwm_config_freq_duty_2_state(
          pwm_groups group_num,
          pwm_channels pwm_num,
          struct mtk_com_pwm_data state_config)
    
      -set PWM stay cycles of S0 & S1 in 2-state mode.
          - Call mtk_os_hal_pwm_config_stay_cycle_2_state(
          pwm_groups group_num,
          pwm_channels pwm_num,
          struct mtk_com_pwm_data state_config)
    
      -Disabe pwm waveform output.
          - Call mtk_os_hal_pwm_stop_normal(pwm_groups group_num,
          pwm_channels pwm_num)
    
      -Release the PWM module back to its original state.
          - Call mtk_os_hal_pwm_ctlr_deinit(pwm_groups group_num,
          u32 channel_bit_map)
    
    
    - PWM differential mode:
    
      -Initialize the PWM module.
          - Call mtk_os_hal_pwm_ctlr_init(pwm_groups group_num,
          u32 channel_bit_map)
    
      -Select PWM global kick, IO ctrl, polarity setting.
          - Call mtk_os_hal_pwm_feature_enable(pwm_groups group_num,
          pwm_channels pwm_num,
          bool global_kick_enable,
          bool io_ctrl_sel,
          bool polarity_set)
    
      -Config normal mode freq & duty.
          - Call mtk_os_hal_pwm_config_freq_duty_normal(
          pwm_groups group_num, pwm_channels pwm_num,
          u32  frequency, u32  duty_cycle)
      -Set PWM channel to differential mode.
          - Call mtk_os_hal_pwm_config_dpsel(pwm_groups group_num,
          pwm_channels pwm_num,
          pwm_differential_select mode)
    
      -Enable pwm waveform output.
          - Call mtk_os_hal_pwm_start_normal(pwm_groups group_num,
          pwm_channels pwm_num)
    
      -Disabe pwm waveform output.
          - Call mtk_os_hal_pwm_stop_normal(pwm_groups group_num,
          pwm_channels pwm_num)
    
      -Release the PWM module back to its original state.
          - Call mtk_os_hal_pwm_ctlr_deinit(pwm_groups group_num,
          u32 channel_bit_map)

Modules
	Define
	This section introduces the Macro definition which is used as PWM channel number.
	Enum
	OS-HAL PWM enumeration value list information, including define of the PWM group number enumeration, the PWM channel number enumeration and define of the PWM running status enumeration.
	Function
	OS-HAL PWM API list information, including PWM hardware initializing and de-initializing, setting PWM frequency and duty cycle, enabling and disabling PWM hardware output, feature enabling.