foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
afe.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 afe.h
44  * @author foxBMS Team
45  * @date 2020-05-08 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVER
49  * @prefix AFE
50  *
51  * @brief AFE driver header
52  *
53  * @details TODO
54  */
55 
56 #ifndef FOXBMS__AFE_H_
57 #define FOXBMS__AFE_H_
58 
59 /*========== Includes =======================================================*/
60 #include "general.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /** period for open wire measurement */
65 #define AFE_ERROR_OPEN_WIRE_PERIOD_ms (30000u)
66 
67 /*========== Extern Constant and Variable Declarations ======================*/
68 
69 /*========== Extern Function Prototypes =====================================*/
70 /** tick function, this function is called to advance the state machine */
71 extern STD_RETURN_TYPE_e AFE_TriggerIc(void);
72 /** initializer, this function is called in order to initialize the AFE */
74 /** this function should tell the AFE that it should start measuring */
76 /** this function returns whether the first measurement cycle has finished */
77 extern bool AFE_IsFirstMeasurementCycleFinished(void);
78 
79 /**
80  * @brief Checks if the first AFE measurement cycle was made
81  * @return true is the first measurement cycle was made, false
82  * otherwise
83  */
84 extern bool AFE_IsFirstMeasurementCycleFinished(void);
85 
86 /**
87  * @brief Makes the initialization request to the AFE state machine
88  * @return true or false
89  */
91 
92 /**
93  * @brief Makes the request to the AFE state machine to write to the
94  * IO port-expander
95  * @param string string addressed by the request
96  */
97 extern STD_RETURN_TYPE_e AFE_RequestIoWrite(uint8_t string);
98 
99 /**
100  * @brief Makes the request to the AFE state machine to read from the
101  * IO port-expander
102  * @param string string addressed by the request
103  */
104 extern STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string);
105 
106 /**
107  * @brief Makes the request to the AFE state machine to read from the
108  * external temperature sensor on slaves
109  * @param string string addressed by the request
110  */
111 extern STD_RETURN_TYPE_e AFE_RequestTemperatureRead(uint8_t string);
112 
113 /**
114  * @brief Makes the request to the AFE state machine to read
115  * balancing feedback from the slaves
116  * @param string string addressed by the request
117  */
119 
120 /**
121  * @brief Makes the request to the AFE state machine to read from the
122  * external EEPROM on slaves
123  * @param string string addressed by the request
124  */
125 extern STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string);
126 
127 /**
128  * @brief Makes the request to the AFE state machine to write to the
129  * external EEPROM on slaves
130  * @param string string addressed by the request
131  */
132 extern STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string);
133 
134 /**
135  * @brief Makes the request to the AFE state machine to perform
136  * open-wire check
137  * @param string string addressed by the request
138  */
139 extern STD_RETURN_TYPE_e AFE_RequestOpenWireCheck(uint8_t string);
140 
141 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
142 
143 #endif /* FOXBMS__AFE_H_ */
STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string)
Makes the request to the AFE state machine to read from the external EEPROM on slaves.
STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string)
Makes the request to the AFE state machine to write to the external EEPROM on slaves.
STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string)
Makes the request to the AFE state machine to read from the IO port-expander.
STD_RETURN_TYPE_e AFE_TriggerIc(void)
STD_RETURN_TYPE_e AFE_RequestOpenWireCheck(uint8_t string)
Makes the request to the AFE state machine to perform open-wire check.
bool AFE_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
STD_RETURN_TYPE_e AFE_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the AFE state machine to read balancing feedback from the slaves.
STD_RETURN_TYPE_e AFE_RequestTemperatureRead(uint8_t string)
Makes the request to the AFE state machine to read from the external temperature sensor on slaves.
STD_RETURN_TYPE_e AFE_RequestIoWrite(uint8_t string)
Makes the request to the AFE state machine to write to the IO port-expander.
STD_RETURN_TYPE_e AFE_Initialize(void)
STD_RETURN_TYPE_e AFE_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
General macros and definitions for the whole platform.