foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
nxp_afe.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 nxp_afe.c
44  * @author foxBMS Team
45  * @date 2020-05-25 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVER
49  * @prefix AFE
50  *
51  * @brief AFE driver wrapper layer for NXP ICs
52  */
53 
54 /*========== Includes =======================================================*/
55 
56 /* clang-format off */
57 #include "afe.h"
58 /* clang-format on */
59 #include "nxp_afe.h"
60 
61 #include "battery_system_cfg.h"
62 
63 #include <stdint.h>
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*========== Static Constant and Variable Definitions =======================*/
68 
69 /*========== Extern Constant and Variable Definitions =======================*/
70 
71 /*========== Static Function Prototypes =====================================*/
72 
73 /*========== Static Function Implementations ================================*/
74 
75 /*========== Extern Function Implementations ================================*/
76 
78  return NXP_Measure();
79 }
80 
82  return NXP_Initialize();
83 }
84 
85 extern STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string) {
86  FAS_ASSERT(string < BS_NR_OF_STRINGS);
87  return NXP_RequestEepromRead(string);
88 }
89 
90 extern STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string) {
91  FAS_ASSERT(string < BS_NR_OF_STRINGS);
92  return NXP_RequestEepromWrite(string);
93 }
94 
96  FAS_ASSERT(string < BS_NR_OF_STRINGS);
97  return NXP_RequestTemperatureRead(string);
98 }
99 
101  FAS_ASSERT(string < BS_NR_OF_STRINGS);
102  return NXP_RequestBalancingFeedbackRead(string);
103 }
104 
106  FAS_ASSERT(string < BS_NR_OF_STRINGS);
107  return NXP_RequestOpenWireCheck(string);
108 }
109 
111  return NXP_StartMeasurement();
112 }
113 
116 }
117 
118 extern STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string) {
119  FAS_ASSERT(string < BS_NR_OF_STRINGS);
120  return NXP_RequestIoRead(string);
121 }
122 
124  FAS_ASSERT(string < BS_NR_OF_STRINGS);
125  return NXP_RequestIoWrite(string);
126 }
127 
128 /*========== Externalized Static Function Implementations (Unit Test) =======*/
129 #ifdef UNITY_UNIT_TEST
130 #endif
AFE driver header.
Configuration of the battery system (e.g., number of battery modules, battery cells,...
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:250
STD_RETURN_TYPE_e
Definition: fstd_types.h:82
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.
Definition: nxp_afe.c:85
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.
Definition: nxp_afe.c:90
STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string)
Makes the request to the AFE state machine to read from the IO port-expander.
Definition: nxp_afe.c:118
STD_RETURN_TYPE_e AFE_TriggerIc(void)
Definition: nxp_afe.c:77
STD_RETURN_TYPE_e AFE_RequestOpenWireCheck(uint8_t string)
Makes the request to the AFE state machine to perform open-wire check.
Definition: nxp_afe.c:105
bool AFE_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
Definition: nxp_afe.c:114
STD_RETURN_TYPE_e AFE_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the AFE state machine to read balancing feedback from the slaves.
Definition: nxp_afe.c:100
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.
Definition: nxp_afe.c:95
STD_RETURN_TYPE_e AFE_RequestIoWrite(uint8_t string)
Makes the request to the AFE state machine to write to the IO port-expander.
Definition: nxp_afe.c:123
STD_RETURN_TYPE_e AFE_Initialize(void)
Definition: nxp_afe.c:81
STD_RETURN_TYPE_e AFE_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
Definition: nxp_afe.c:110
AFE driver wrapper layer for NXP ICs.
STD_RETURN_TYPE_e NXP_RequestOpenWireCheck(uint8_t string)
STD_RETURN_TYPE_e NXP_RequestEepromRead(uint8_t string)
bool NXP_IsFirstMeasurementCycleFinished(void)
STD_RETURN_TYPE_e NXP_StartMeasurement(void)
STD_RETURN_TYPE_e NXP_RequestIoWrite(uint8_t string)
STD_RETURN_TYPE_e NXP_Initialize(void)
STD_RETURN_TYPE_e NXP_RequestEepromWrite(uint8_t string)
STD_RETURN_TYPE_e NXP_RequestTemperatureRead(uint8_t string)
STD_RETURN_TYPE_e NXP_RequestBalancingFeedbackRead(uint8_t string)
STD_RETURN_TYPE_e NXP_RequestIoRead(uint8_t string)
STD_RETURN_TYPE_e NXP_Measure(void)