foxBMS-UnitTests  1.0.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
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 sys_cfg.h
44  * @author foxBMS Team
45  * @date 2020-02-24 (date of creation)
46  * @updated 2020-02-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  * @details TODO
110  * @param directTransmission TODO
111  */
112 extern void SYS_SendBootMessage(uint8_t directTransmission);
113 
114 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
115 
116 #endif /* FOXBMS__SYS_CFG_H_ */
general.h
TODO.
SYS_SendBootMessage
void SYS_SendBootMessage(uint8_t directTransmission)
Function to send out boot message with SW version.
Definition: sys_cfg.c:69