PWM

PWM library. More...

Macros
#define	pwm_init_hz(timer, frequency)   pwm_init((timer), 1000000 / (frequency))
	Initializes the PWM for a set timer with a specific frequency (Hz)

Enumerations
enum	PwmTimer {   PWM_TIMER_1 = 0 , PWM_TIMER_2 , PWM_TIMER_3 , PWM_TIMER_4 ,   PWM_TIMER_15 , PWM_TIMER_16 , NUM_PWM_TIMERS }
	PWM Timer selection. More...
enum	PwmChannel {   PWM_CHANNEL_1 = 0 , PWM_CHANNEL_2 , PWM_CHANNEL_3 , PWM_CHANNEL_4 ,   PWM_CHANNEL_5 , PWM_CHANNEL_6 , NUM_PWM_CHANNELS }
	PWM Channel selection. More...

Functions
StatusCode	pwm_init (PwmTimer timer, uint16_t period_us)
	Initializes a specified PWM timer with a period. More...
StatusCode	pwm_set_pulse (PwmTimer timer, uint16_t pulse_width_us, PwmChannel channel, bool n_channel_en)
	Sets the pulse width of a specified channel of a PWM timer. More...
StatusCode	pwm_set_dc (PwmTimer timer, uint16_t dc, PwmChannel channel, bool n_channel_en)
	Sets the duty cycle of a specified channel for a PWM timer. More...
uint16_t	pwm_get_period (PwmTimer timer)
	Gets the current period of a specified PWM timer in microseconds. More...
uint16_t	pwm_get_dc (PwmTimer timer, PwmChannel channel)
	Gets the duty cycle of a specified channel for a PWM timer. More...

Detailed Description

PWM library.

Enumeration Type Documentation

PwmChannel

enum PwmChannel

PWM Channel selection.

Enumerator
PWM_CHANNEL_1	PWM Channel 1
PWM_CHANNEL_2	PWM Channel 2
PWM_CHANNEL_3	PWM Channel 3
PWM_CHANNEL_4	PWM Channel 4
PWM_CHANNEL_5	PWM Channel 5
PWM_CHANNEL_6	PWM Channel 6
NUM_PWM_CHANNELS	Number of PWM Channels

PwmTimer

enum PwmTimer

PWM Timer selection.

Enumerator
PWM_TIMER_1	PWM Advanced control timer
PWM_TIMER_2	PWM General purpose timer
PWM_TIMER_3	PWM General purpose timer
PWM_TIMER_4	PWM General purpose timer
PWM_TIMER_15	PWM General purpose timer
PWM_TIMER_16	PWM General purpose timer
NUM_PWM_TIMERS	Number of PWM timers

Function Documentation

pwm_get_dc()

uint16_t pwm_get_dc	(	PwmTimer	timer,
		PwmChannel	channel
	)

Gets the duty cycle of a specified channel for a PWM timer.

Parameters

timer	PWM timer to configure
channel	Channel of the PWM timer to configure

Returns

Duty cycle of the specified timer

pwm_get_period()

uint16_t pwm_get_period

(

PwmTimer

timer

)

Gets the current period of a specified PWM timer in microseconds.

Parameters

timer

PWM timer to check

Returns

Period of the specified timer

pwm_init()

StatusCode pwm_init	(	PwmTimer	timer,
		uint16_t	period_us
	)

Initializes a specified PWM timer with a period.

Parameters

timer	PWM timer to configure
period_ms	Duration of one cycle in microseconds

Returns

STATUS_CODE_OK if PWM timer initialization succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect

pwm_set_dc()

StatusCode pwm_set_dc	(	PwmTimer	timer,
		uint16_t	dc,
		PwmChannel	channel,
		bool	n_channel_en
	)

Sets the duty cycle of a specified channel for a PWM timer.

Parameters

timer	PWM timer to configure
dc	Duty cycle in units of 1%
channel	Channel of the PWM timer to configure
n_channel_en	Whether N channel is enabled or not

Returns

STATUS_CODE_OK if PWM duty cycle configuration succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect

pwm_set_pulse()

StatusCode pwm_set_pulse	(	PwmTimer	timer,
		uint16_t	pulse_width_us,
		PwmChannel	channel,
		bool	n_channel_en
	)

Sets the pulse width of a specified channel of a PWM timer.

Parameters

timer	PWM timer to configure
pulse_width_us	Pulse width in microseconds
channel	Channel of the PWM timer to configure
n_channel_en	Whether N channel is enabled or not

Returns

STATUS_CODE_OK if PWM duty cycle configuration succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect