foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
algorithm_cfg.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 algorithm_cfg.h
44  * @author foxBMS Team
45  * @date 2017-12-18 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup ALGORITHMS_CONFIGURATION
49  * @prefix ALGO
50  *
51  * @brief Headers for the configuration of the algorithm module
52  *
53  */
54 
55 #ifndef FOXBMS__ALGORITHM_CFG_H_
56 #define FOXBMS__ALGORITHM_CFG_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 /**
63  * @ingroup ALGORITHMS_CONFIGURATION
64  * @details task timeslot where the ALGO main function is called. Repetition
65  * time of algorithm cycle time must be multiple of this
66  */
67 #define ALGO_TICK_ms (100u)
68 
69 /**
70  * function type for the initialization function of an algorithm
71  * @returns #STD_OK if the initialization has passed
72  */
74 
75 /**
76  * function type for the computation function of an algorithm
77  */
78 typedef void ALGO_COMPUTATION_FUNCTION_f(void);
79 
80 /** states that an algorithm can take */
81 typedef enum {
82  ALGO_UNINITIALIZED, /*!< This is the default value indicating that initialization has not run yet */
83  ALGO_READY, /*!< This indicates that the algorithm is ready to be run on next time slot */
84  ALGO_RUNNING, /*!< This indicates that the algorithm is currently running.
85  Note that it may not spend more than #ALGO_TASKS_s::maxCalculationDuration_ms in this state. */
86  ALGO_BLOCKED, /*!< This indicates that the algorithm has violated its maximum calculation duration. */
87  ALGO_FAILED_INIT, /*!< This indicates a failed initialization. */
88  ALGO_REINIT_REQUESTED, /*!< This indicates that a reinitialization of the algorithm has been requested. */
89 } ALGO_STATE_e;
90 
91 /** Struct representing the key parameters of an algorithm */
92 typedef struct {
93  ALGO_STATE_e state; /*!< current execution state */
94  uint32_t cycleTime_ms; /*!< cycle time of algorithm */
95  uint32_t maxCalculationDuration_ms; /*!< maximum allowed calculation duration for task */
96  uint32_t startTime; /*!< start time when executing algorithm */
97  ALGO_INITIALIZATION_FUNCTION_f *fpInitialization; /*!< callback function for init;
98  set to #NULL_PTR if not needed; return #STD_OK if init successful */
99  ALGO_COMPUTATION_FUNCTION_f *fpAlgorithm; /*!< callback function */
100 } ALGO_TASKS_s;
101 
102 /*========== Extern Constant and Variable Declarations ======================*/
103 /** Array with pointer to the different algorithms */
105 
106 /** number of executed algorithms */
107 extern const uint16_t algo_length;
108 
109 /*========== Extern Function Prototypes =====================================*/
110 /**
111  * @brief Mark the current algorithm as done (will reset to #ALGO_READY if possible)
112  * @param[in] algorithmIndex index entry of the algorithm
113  */
114 extern void ALGO_MarkAsDone(uint32_t algorithmIndex);
115 
116 /**
117  * @brief mark a algorithm as requiring a reinitialization.
118  * @param[in] algorithmIndex index entry of the algorithm
119  */
120 extern void ALGO_MarkAsReinit(uint32_t algorithmIndex);
121 
122 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
123 
124 #endif /* FOXBMS__ALGORITHM_CFG_H_ */
const uint16_t algo_length
Definition: algorithm_cfg.c:71
ALGO_STATE_e
Definition: algorithm_cfg.h:81
@ ALGO_UNINITIALIZED
Definition: algorithm_cfg.h:82
@ ALGO_REINIT_REQUESTED
Definition: algorithm_cfg.h:88
@ ALGO_RUNNING
Definition: algorithm_cfg.h:84
@ ALGO_FAILED_INIT
Definition: algorithm_cfg.h:87
@ ALGO_READY
Definition: algorithm_cfg.h:83
@ ALGO_BLOCKED
Definition: algorithm_cfg.h:86
void ALGO_MarkAsReinit(uint32_t algorithmIndex)
mark a algorithm as requiring a reinitialization.
Definition: algorithm_cfg.c:90
STD_RETURN_TYPE_e ALGO_INITIALIZATION_FUNCTION_f(void)
Definition: algorithm_cfg.h:73
ALGO_TASKS_s algo_algorithms[]
Definition: algorithm_cfg.c:67
void ALGO_COMPUTATION_FUNCTION_f(void)
Definition: algorithm_cfg.h:78
void ALGO_MarkAsDone(uint32_t algorithmIndex)
Mark the current algorithm as done (will reset to ALGO_READY if possible)
Definition: algorithm_cfg.c:79
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
General macros and definitions for the whole platform.
uint32_t cycleTime_ms
Definition: algorithm_cfg.h:94
uint32_t startTime
Definition: algorithm_cfg.h:96
uint32_t maxCalculationDuration_ms
Definition: algorithm_cfg.h:95
ALGO_COMPUTATION_FUNCTION_f * fpAlgorithm
Definition: algorithm_cfg.h:99
ALGO_INITIALIZATION_FUNCTION_f * fpInitialization
Definition: algorithm_cfg.h:97
ALGO_STATE_e state
Definition: algorithm_cfg.h:93