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