foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
pwm.c File Reference

Implementation of the PWM module. More...

#include "pwm.h"
#include "HL_ecap.h"
#include "HL_etpwm.h"
#include "HL_system.h"
#include "foxmath.h"
#include "fsystem.h"
Include dependency graph for pwm.c:

Go to the source code of this file.

Data Structures

struct  PWM_INITIALIZATION_STATE_s
 

Macros

#define PWM_LOWER_THRESHOLD_PERM   (1u)
 
#define PWM_UPPER_THRESHOLD_PERM   (999u)
 
#define PWM_FULL_PERIOD_PERM   (1000u)
 

Functions

static uint16_t PWM_GetEtpwmTimePeriod (void)
 
static uint16_t PWM_ComputeCounterValueFromDutyCycle (uint16_t dutyCycle_perm)
 
void PWM_Initialize (void)
 Initializes the ETPWM and the ECAP module. More...
 
void PWM_StartPwm (void)
 Start the PWM (starts all configured ePWM channels) More...
 
void PWM_StopPwm (void)
 Stop the PWM (stops all configured ePWM channels) More...
 
void PWM_SetDutyCycle (uint16_t dutyCycle_perm)
 Set the duty cycle of the PWM (currently only channel 1A) More...
 
void ecapNotification (ecapBASE_t *ecap, uint16 flags)
 
bool PWM_IsEcapModuleInitialized (void)
 Get initialization state of ecap module. More...
 
PWM_SIGNAL_s PWM_GetPwmData (void)
 Get dutycycle and frequency of input PWM signal. More...
 

Variables

static PWM_INITIALIZATION_STATE_s pwm_state
 
static const int16_t pwm_kLinearOffset = 0
 
static PWM_SIGNAL_s ecap_inputPwmSignal = {.dutyCycle_perc = 0.0f, .frequency_Hz = 0.0f}
 

Detailed Description

Implementation of the PWM module.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2021-10-07 (date of creation)
Updated
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
PWM

Definition in file pwm.c.

Macro Definition Documentation

◆ PWM_FULL_PERIOD_PERM

#define PWM_FULL_PERIOD_PERM   (1000u)

full period in promill

Definition at line 73 of file pwm.c.

◆ PWM_LOWER_THRESHOLD_PERM

#define PWM_LOWER_THRESHOLD_PERM   (1u)

lower threshold permill

Definition at line 67 of file pwm.c.

◆ PWM_UPPER_THRESHOLD_PERM

#define PWM_UPPER_THRESHOLD_PERM   (999u)

upper threshold permill

Definition at line 70 of file pwm.c.

Function Documentation

◆ ecapNotification()

void ecapNotification ( ecapBASE_t *  ecap,
uint16  flags 
)

called in case of ECAP interrupt, defined as weak in HAL

Definition at line 172 of file pwm.c.

◆ PWM_ComputeCounterValueFromDutyCycle()

static uint16_t PWM_ComputeCounterValueFromDutyCycle ( uint16_t  dutyCycle_perm)
static

returns a ePWM counter value based on a duty cycle

Parameters
[in]dutyCycle_permduty cycle in permill
Returns
counter value

Definition at line 113 of file pwm.c.

Here is the call graph for this function:

◆ PWM_GetEtpwmTimePeriod()

static uint16_t PWM_GetEtpwmTimePeriod ( void  )
static

returns the ePWM time period (currently for ePWM1A)

Returns
ePWM time period in counter ticks

Definition at line 107 of file pwm.c.

◆ PWM_GetPwmData()

PWM_SIGNAL_s PWM_GetPwmData ( void  )

Get dutycycle and frequency of input PWM signal.

Definition at line 201 of file pwm.c.

◆ PWM_Initialize()

void PWM_Initialize ( void  )

Initializes the ETPWM and the ECAP module.

Definition at line 124 of file pwm.c.

◆ PWM_IsEcapModuleInitialized()

bool PWM_IsEcapModuleInitialized ( void  )

Get initialization state of ecap module.

Returns
true if module is initialized, otherwise false

Definition at line 197 of file pwm.c.

◆ PWM_SetDutyCycle()

void PWM_SetDutyCycle ( uint16_t  dutyCycle_perm)

Set the duty cycle of the PWM (currently only channel 1A)

Duty cycle values that are out of the range that is supported are limited to the threshold values.

Parameters
[in]dutyCycle_permduty cycle in permill

Definition at line 149 of file pwm.c.

Here is the call graph for this function:

◆ PWM_StartPwm()

void PWM_StartPwm ( void  )

Start the PWM (starts all configured ePWM channels)

In order for this function to work, it is absolutely necessary that etpwmInit() is called first.

Definition at line 131 of file pwm.c.

Here is the call graph for this function:

◆ PWM_StopPwm()

void PWM_StopPwm ( void  )

Stop the PWM (stops all configured ePWM channels)

Definition at line 140 of file pwm.c.

Here is the call graph for this function:

Variable Documentation

◆ ecap_inputPwmSignal

PWM_SIGNAL_s ecap_inputPwmSignal = {.dutyCycle_perc = 0.0f, .frequency_Hz = 0.0f}
static

Definition at line 90 of file pwm.c.

◆ pwm_kLinearOffset

const int16_t pwm_kLinearOffset = 0
static

linear offset (through output circuit)

Definition at line 88 of file pwm.c.

◆ pwm_state

PWM_INITIALIZATION_STATE_s pwm_state
static
Initial value:
= {
.ecapInitialized = false,
.etpwmInitialized = false,
}

Definition at line 82 of file pwm.c.