foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
algorithm_cfg.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file algorithm_cfg.c
44  * @author foxBMS Team
45  * @date 2017-12-18 (date of creation)
46  * @updated 2020-06-30 (date of last update)
47  * @ingroup ALGORITHMS_CONFIGURATION
48  * @prefix ALGO
49  *
50  * @brief Configuration for the algorithm module
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "algorithm_cfg.h"
56 
57 #include "moving_average.h"
58 #include "os.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 
64 /*========== Extern Constant and Variable Definitions =======================*/
65 /** array of algorithms that should be executed */
66 ALGO_TASKS_s algo_algorithms[] = {
67  {ALGO_UNINITIALIZED, 100, 1000, 0, NULL_PTR, &ALGO_MovAverage},
68 };
69 
70 const uint16_t algo_length = sizeof(algo_algorithms) / sizeof(algo_algorithms[0]);
71 
72 /*========== Static Function Prototypes =====================================*/
73 
74 /*========== Static Function Implementations ================================*/
75 
76 /*========== Extern Function Implementations ================================*/
77 
78 extern void ALGO_MarkAsDone(uint32_t algorithmIndex) {
79  FAS_ASSERT(algorithmIndex < algo_length);
80  if (algo_algorithms[algorithmIndex].state != ALGO_BLOCKED) {
81  algo_algorithms[algorithmIndex].state = ALGO_READY;
82  }
83 }
84 
85 /*========== Externalized Static Function Implementations (Unit Test) =======*/
os.h
Implementation of the tasks used by the system, headers.
ALGO_BLOCKED
@ ALGO_BLOCKED
Definition: algorithm_cfg.h:85
algorithm_cfg.h
Headers for the configuration of the algorithm module.
algo_algorithms
ALGO_TASKS_s algo_algorithms[]
Definition: algorithm_cfg.c:66
ALGO_UNINITIALIZED
@ ALGO_UNINITIALIZED
Definition: algorithm_cfg.h:81
FAS_ASSERT
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:233
ALGO_MarkAsDone
void ALGO_MarkAsDone(uint32_t algorithmIndex)
Mark the current algorithm as done (will reset to ALGO_READY if possible)
Definition: algorithm_cfg.c:78
ALGO_TASKS::state
ALGO_STATE_e state
Definition: algorithm_cfg.h:91
ALGO_TASKS
Definition: algorithm_cfg.h:90
ALGO_READY
@ ALGO_READY
Definition: algorithm_cfg.h:82
moving_average.h
moving average algorithm
NULL_PTR
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
algo_length
const uint16_t algo_length
Definition: algorithm_cfg.c:70
ALGO_MovAverage
void ALGO_MovAverage()
Definition: moving_average.c:173