foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
pwm.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file pwm.h
44  * @author foxBMS Team
45  * @date 2021-10-07 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS
49  * @prefix PWM
50  *
51  * @brief PWM driver for the TMS570LC43xx.
52  * @details This module uses the PWM hardware of the MCU in order to generate
53  * a PWM signal. Currently, the implementation uses only the ePWM
54  * (not the HET) and supports only setting a duty cycle (in percent).
55  * For the module to work currently, the function etpwmInit() has to
56  * be called before using API of this module.
57  */
58 
59 #ifndef FOXBMS__PWM_H_
60 #define FOXBMS__PWM_H_
61 
62 /*========== Includes =======================================================*/
63 #include "general.h"
64 
65 #include "HL_reg_ecap.h"
66 
67 /*========== Macros and Definitions =========================================*/
68 /** type definition for PWM signal parameters */
69 typedef struct {
71  float frequency_Hz;
72 } PWM_SIGNAL_s;
73 
74 /*========== Extern Constant and Variable Declarations ======================*/
75 
76 /*========== Extern Function Prototypes =====================================*/
77 /** @brief Initializes the ETPWM and the ECAP module
78  */
79 extern void PWM_Initialize(void);
80 
81 /** @brief Start the PWM (starts all configured ePWM channels)
82  * @details In order for this function to work, it is absolutely necessary that
83  * etpwmInit() is called first.
84  */
85 extern void PWM_StartPwm(void);
86 
87 /** @brief Stop the PWM (stops all configured ePWM channels) */
88 extern void PWM_StopPwm(void);
89 
90 /** @brief Set the duty cycle of the PWM (currently only channel 1A)
91  * @details Duty cycle values that are out of the range that is supported are
92  * limited to the threshold values.
93  * @param[in] dutyCycle_perm duty cycle in permill
94  */
95 extern void PWM_SetDutyCycle(uint16_t dutyCycle_perm);
96 
97 /** @brief Get dutycycle and frequency of input PWM signal */
98 extern PWM_SIGNAL_s PWM_GetPwmData(void);
99 
100 /**
101  * @brief Get initialization state of ecap module
102  * @return true if module is initialized, otherwise false
103  */
104 extern bool PWM_IsEcapModuleInitialized(void);
105 
106 /*========== Getter for static Variables (Unit Test) ========================*/
107 #ifdef UNITY_UNIT_TEST
108 extern int16_t TEST_PWM_GetLinearOffset(void);
109 #endif
110 
111 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
112 
113 #endif /* FOXBMS__PWM_H_ */
General macros and definitions for the whole platform.
void PWM_SetDutyCycle(uint16_t dutyCycle_perm)
Set the duty cycle of the PWM (currently only channel 1A)
Definition: pwm.c:149
void PWM_Initialize(void)
Initializes the ETPWM and the ECAP module.
Definition: pwm.c:124
void PWM_StopPwm(void)
Stop the PWM (stops all configured ePWM channels)
Definition: pwm.c:140
void PWM_StartPwm(void)
Start the PWM (starts all configured ePWM channels)
Definition: pwm.c:131
PWM_SIGNAL_s PWM_GetPwmData(void)
Get dutycycle and frequency of input PWM signal.
Definition: pwm.c:201
bool PWM_IsEcapModuleInitialized(void)
Get initialization state of ecap module.
Definition: pwm.c:197
int16_t TEST_PWM_GetLinearOffset(void)
Definition: pwm.c:208
float dutyCycle_perc
Definition: pwm.h:70
float frequency_Hz
Definition: pwm.h:71