foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
sys_cfg.h
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 sys_cfg.h
44  * @author foxBMS Team
45  * @date 2020-02-24 (date of creation)
46  * @updated 2021-06-24 (date of last update)
47  * @ingroup ENGINE_CONFIGURATION
48  * @prefix SYS
49  *
50  * @brief Sys driver configuration header
51  */
52 
53 #ifndef FOXBMS__SYS_CFG_H_
54 #define FOXBMS__SYS_CFG_H_
55 
56 /*========== Includes =======================================================*/
57 #include "general.h"
58 
59 /*========== Macros and Definitions =========================================*/
60 
61 /**
62  * This define MUST represent the cycle time of the task in which context the
63  * functions run, e.g., if the #SYS_Trigger() is running in the 10 ms task
64  * then the define must be set to 10.
65  *
66  * This define also sets the minimum time.
67  */
68 #define SYS_TASK_CYCLE_CONTEXT_MS (10u)
69 
70 /**
71  * SYS statemachine short time definition in #SYS_Trigger() calls until next
72  * state/substate is processed
73  */
74 #define SYS_FSM_SHORT_TIME (1u)
75 
76 /**
77  * SYS statemachine medium time definition in #SYS_Trigger() calls until next
78  * state/substate is processed
79  */
80 #define SYS_FSM_MEDIUM_TIME (5u)
81 
82 /**
83  * SYS statemachine long time definition in #SYS_Trigger() calls until next
84  * state/substate is processed
85  */
86 #define SYS_FSM_LONG_TIME (10u)
87 
88 /**
89  * SYS statemachine initialization timeout
90  */
91 #define SYS_STATEMACH_INITIALIZATION_TIMEOUT_MS (200u)
92 
93 /**
94  * SYS statemachine BAL initialization timeout
95  */
96 #define SYS_STATEMACH_BAL_INITIALIZATION_TIMEOUT_MS (500u)
97 
98 /**
99  * SYS statemachine SBC initialization timeout
100  */
101 #define SYS_STATEMACHINE_SBC_INIT_TIMEOUT_MS (1000u)
102 
103 /*========== Extern Constant and Variable Declarations ======================*/
104 
105 /*========== Extern Function Prototypes =====================================*/
106 
107 /**
108  * @brief Function to send out boot message with SW version
109  */
110 extern void SYS_SendBootMessage(void);
111 
112 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
113 
114 #endif /* FOXBMS__SYS_CFG_H_ */
General macros and definitions for the whole platform.
void SYS_SendBootMessage(void)
Function to send out boot message with SW version.
Definition: sys_cfg.c:69