foxBMS - Unit Tests  1.1.2
The foxBMS Unit Tests API Documentation
bal.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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.c
44  * @author foxBMS Team
45  * @date 2020-02-24 (date of creation)
46  * @updated 2020-07-31 (date of last update)
47  * @ingroup APPLICATION
48  * @prefix BAL
49  *
50  * @brief Driver for the Balancing module
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "bal.h"
56 
57 /*========== Macros and Definitions =========================================*/
58 
59 /*========== Static Constant and Variable Definitions =======================*/
60 
61 /*========== Extern Constant and Variable Definitions =======================*/
62 
63 /*========== Static Function Prototypes =====================================*/
64 
65 /*========== Static Function Implementations ================================*/
66 
67 /*========== Extern Function Implementations ================================*/
68 #pragma WEAK(BAL_SaveLastStates)
69 extern void BAL_SaveLastStates(BAL_STATE_s *pBalancingState) {
70  if (pBalancingState->lastState != pBalancingState->state) {
71  pBalancingState->lastState = pBalancingState->state;
72  pBalancingState->lastSubstate = pBalancingState->substate;
73  } else if (pBalancingState->lastSubstate != pBalancingState->substate) {
74  pBalancingState->lastSubstate = pBalancingState->substate;
75  } else {
76  /* Do not set new substate as nothing changed */
77  ;
78  }
79 }
80 
81 #pragma WEAK(BAL_CheckReEntrance)
82 extern uint8_t BAL_CheckReEntrance(BAL_STATE_s *currentState) {
83  uint8_t retval = 0;
84 
86  if (!currentState->triggerEntry) {
87  currentState->triggerEntry++;
88  } else {
89  retval = 0xFF; /* multiple calls of function */
90  }
92 
93  return retval;
94 }
95 
96 #pragma WEAK(BAL_TransferStateRequest)
99 
101  retval = currentState->stateRequest;
102  currentState->stateRequest = BAL_STATE_NO_REQUEST;
104 
105  return retval;
106 }
107 
108 #pragma WEAK(BAL_CheckStateRequest)
110  if (stateRequest == BAL_STATE_ERROR_REQUEST) {
111  return BAL_OK;
112  }
113  if (stateRequest == BAL_STATE_GLOBAL_ENABLE_REQUEST) {
114  pCurrentState->balancingGlobalAllowed = true;
115  return BAL_OK;
116  }
117  if (stateRequest == BAL_STATE_GLOBAL_DISABLE_REQUEST) {
118  pCurrentState->balancingGlobalAllowed = false;
119  return BAL_OK;
120  }
121  if ((stateRequest == BAL_STATE_NO_BALANCING_REQUEST) || (stateRequest == BAL_STATE_ALLOWBALANCING_REQUEST)) {
122  return BAL_OK;
123  }
124 
125  if (pCurrentState->stateRequest == BAL_STATE_NO_REQUEST) {
126  /* init only allowed from the uninitialized state */
127  if (stateRequest == BAL_STATE_INIT_REQUEST) {
128  if (pCurrentState->state == BAL_STATEMACH_UNINITIALIZED) {
129  return BAL_OK;
130  } else {
132  }
133  /* request to forbid balancing */
134  } else {
135  return BAL_ILLEGAL_REQUEST;
136  }
137  } else {
138  return BAL_REQUEST_PENDING;
139  }
140 }
141 
142 #pragma WEAK(BAL_Init)
144  DATA_READ_DATA(pControl);
145  pControl->enableBalancing = 0;
146  DATA_WRITE_DATA(pControl);
147  return STD_OK;
148 }
149 
150 #pragma WEAK(BAL_ProcessStateUninitalized)
151 extern void BAL_ProcessStateUninitalized(BAL_STATE_s *pCurrentState, BAL_STATE_REQUEST_e stateRequest) {
152  if (stateRequest == BAL_STATE_INIT_REQUEST) {
153  pCurrentState->timer = BAL_STATEMACH_SHORTTIME_100ms;
154  pCurrentState->state = BAL_STATEMACH_INITIALIZATION;
155  pCurrentState->substate = BAL_ENTRY;
156  } else if (stateRequest == BAL_STATE_NO_REQUEST) {
157  /* no actual request pending */
158  } else {
159  pCurrentState->errorRequestCounter++; /* illegal request pending */
160  }
161 }
162 
163 #pragma WEAK(BAL_ProcessStateInitialization)
164 extern void BAL_ProcessStateInitialization(BAL_STATE_s *currentState) {
165  currentState->timer = BAL_STATEMACH_SHORTTIME_100ms;
166  currentState->state = BAL_STATEMACH_INITIALIZED;
167  currentState->substate = BAL_ENTRY;
168 }
169 
170 #pragma WEAK(BAL_ProcessStateInitialized)
171 extern void BAL_ProcessStateInitialized(BAL_STATE_s *currentState) {
172  currentState->initializationFinished = STD_OK;
173  currentState->timer = BAL_STATEMACH_SHORTTIME_100ms;
174  currentState->state = BAL_STATEMACH_CHECK_BALANCING;
175  currentState->substate = BAL_ENTRY;
176 }
177 
178 /*========== Externalized Static Function Implementations (Unit Test) =======*/
179 
180 /*========== Getter for static Variables (Unit Test) ========================*/
STD_RETURN_TYPE_e BAL_Init(DATA_BLOCK_BALANCING_CONTROL_s *pControl)
Generic initialization function for the balancing module.
Definition: bal.c:143
void BAL_SaveLastStates(BAL_STATE_s *pBalancingState)
Saves the last state and the last substate.
Definition: bal.c:69
void BAL_ProcessStateInitialization(BAL_STATE_s *currentState)
State machine subfunction to initialize the balancing state machine.
Definition: bal.c:164
void BAL_ProcessStateUninitalized(BAL_STATE_s *pCurrentState, BAL_STATE_REQUEST_e stateRequest)
Substate handling function for BAL_Trigger()
Definition: bal.c:151
BAL_STATE_REQUEST_e BAL_TransferStateRequest(BAL_STATE_s *currentState)
transfers the current state request to the state machine.
Definition: bal.c:97
void BAL_ProcessStateInitialized(BAL_STATE_s *currentState)
State machine subfunction to transfer from an initalized state to "running" states of th state machin...
Definition: bal.c:171
uint8_t BAL_CheckReEntrance(BAL_STATE_s *currentState)
re-entrance check of BAL state machine trigger function
Definition: bal.c:82
BAL_RETURN_TYPE_e BAL_CheckStateRequest(BAL_STATE_s *pCurrentState, BAL_STATE_REQUEST_e stateRequest)
checks the state requests that are made.
Definition: bal.c:109
Header for the driver for balancing.
@ BAL_STATEMACH_UNINITIALIZED
Definition: bal.h:70
@ BAL_STATEMACH_INITIALIZATION
Definition: bal.h:71
@ BAL_STATEMACH_INITIALIZED
Definition: bal.h:72
@ BAL_STATEMACH_CHECK_BALANCING
Definition: bal.h:73
enum BAL_STATE_REQUEST BAL_STATE_REQUEST_e
@ BAL_ALREADY_INITIALIZED
Definition: bal.h:120
@ BAL_OK
Definition: bal.h:113
@ BAL_ILLEGAL_REQUEST
Definition: bal.h:116
@ BAL_REQUEST_PENDING
Definition: bal.h:115
@ BAL_ENTRY
Definition: bal.h:88
@ BAL_STATE_GLOBAL_ENABLE_REQUEST
Definition: bal.h:105
@ BAL_STATE_ERROR_REQUEST
Definition: bal.h:101
@ BAL_STATE_NO_REQUEST
Definition: bal.h:106
@ BAL_STATE_ALLOWBALANCING_REQUEST
Definition: bal.h:103
@ BAL_STATE_NO_BALANCING_REQUEST
Definition: bal.h:102
@ BAL_STATE_INIT_REQUEST
Definition: bal.h:100
@ BAL_STATE_GLOBAL_DISABLE_REQUEST
Definition: bal.h:104
enum BAL_RETURN_TYPE BAL_RETURN_TYPE_e
#define BAL_STATEMACH_SHORTTIME_100ms
Definition: bal_cfg.h:63
#define DATA_READ_DATA(...)
Definition: database.h:76
#define DATA_WRITE_DATA(...)
Definition: database.h:86
@ STD_OK
Definition: fstd_types.h:72
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
void OS_ExitTaskCritical(void)
Exit Critical interface function for use in FreeRTOS-Tasks and FreeRTOS-ISR.
Definition: os.c:178
void OS_EnterTaskCritical(void)
Enter Critical interface function for use in FreeRTOS-Tasks and FreeRTOS-ISR.
Definition: os.c:174
Definition: bal.h:128
BAL_STATEMACH_SUB_e substate
Definition: bal.h:132
uint8_t triggerEntry
Definition: bal.h:135
bool balancingGlobalAllowed
Definition: bal.h:141
uint16_t timer
Definition: bal.h:129
BAL_STATE_REQUEST_e stateRequest
Definition: bal.h:130
uint8_t lastSubstate
Definition: bal.h:134
uint32_t errorRequestCounter
Definition: bal.h:136
STD_RETURN_TYPE_e initializationFinished
Definition: bal.h:137
BAL_STATEMACH_e state
Definition: bal.h:131
BAL_STATEMACH_e lastState
Definition: bal.h:133