foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
bal_cfg.c
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 bal_cfg.c
44  * @author foxBMS Team
45  * @date 2022-02-26 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix BAL
50  *
51  * @brief implementation for the configuration for the driver for balancing
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "bal_cfg.h"
57 
58 #include "os.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 /** balancing voltage threshold in mV */
65 
66 /*========== Extern Constant and Variable Definitions =======================*/
67 
68 /*========== Static Function Prototypes =====================================*/
69 
70 /*========== Static Function Implementations ================================*/
71 
72 /*========== Extern Function Implementations ================================*/
73 extern void BAL_SetBalancingThreshold(int32_t threshold_mV) {
74  int32_t boundedThreshold_mV = threshold_mV;
75  if (boundedThreshold_mV > BAL_MAXIMUM_THRESHOLD_mV) {
76  boundedThreshold_mV = BAL_MAXIMUM_THRESHOLD_mV;
77  }
78  if (boundedThreshold_mV < BAL_MINIMUM_THRESHOLD_mV) {
79  boundedThreshold_mV = BAL_MINIMUM_THRESHOLD_mV;
80  }
82  bal_threshold_mV = boundedThreshold_mV;
84 }
85 
86 extern int32_t BAL_GetBalancingThreshold_mV(void) {
87  return bal_threshold_mV;
88 }
89 
90 /*========== Externalized Static Function Implementations (Unit Test) =======*/
void BAL_SetBalancingThreshold(int32_t threshold_mV)
set balancing threshold
Definition: bal_cfg.c:73
static int32_t bal_threshold_mV
Definition: bal_cfg.c:64
int32_t BAL_GetBalancingThreshold_mV(void)
get balancing threshold
Definition: bal_cfg.c:86
Header for the configuration for the driver for balancing.
#define BAL_MAXIMUM_THRESHOLD_mV
Definition: bal_cfg.h:77
#define BAL_DEFAULT_THRESHOLD_mV
Definition: bal_cfg.h:74
#define BAL_MINIMUM_THRESHOLD_mV
Definition: bal_cfg.h:80
Declaration of the OS wrapper interface.
void OS_ExitTaskCritical(void)
Exit Critical interface function for use in FreeRTOS-Tasks and FreeRTOS-ISR.
Definition: os_freertos.c:135
void OS_EnterTaskCritical(void)
Enter Critical interface function for use in FreeRTOS-Tasks and FreeRTOS-ISR.
Definition: os_freertos.c:131