foxBMS  1.5.0
The foxBMS Battery Management System API Documentation
Data Structures | Functions
pwm.h File Reference

PWM driver for the TMS570LC43xx. More...

#include "HL_reg_ecap.h"
#include <math.h>
#include <stdint.h>
Include dependency graph for pwm.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PWM_SIGNAL_s
 

Functions

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...
 
PWM_SIGNAL_s PWM_GetPwmData (void)
 Get dutycycle and frequency of input PWM signal. More...
 
bool PWM_IsEcapModuleInitialized (void)
 Get initialization state of ecap module. More...
 

Detailed Description

PWM driver for the TMS570LC43xx.

Copyright
© 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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
2023-02-03 (date of last update)
Version
v1.5.0
Prefix
PWM

This module uses the PWM hardware of the MCU in order to generate a PWM signal. Currently, the implementation uses only the ePWM (not the HET) and supports only setting a duty cycle (in percent). For the module to work currently, the function etpwmInit() has to be called before using API of this module.

Definition in file pwm.h.

Function Documentation

◆ PWM_GetPwmData()

PWM_SIGNAL_s PWM_GetPwmData ( void  )

Get dutycycle and frequency of input PWM signal.

Definition at line 205 of file pwm.c.

◆ PWM_Initialize()

void PWM_Initialize ( void  )

Initializes the ETPWM and the ECAP module.

Definition at line 128 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 201 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 153 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 135 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 144 of file pwm.c.

Here is the call graph for this function: