foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
nxp_afe.h
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.h
44  * @author foxBMS Team
45  * @date 2021-06-04 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVER
49  * @prefix NXP
50  *
51  * @brief AFE driver wrapper layer for NXP ICs
52  */
53 
54 #ifndef FOXBMS__NXP_AFE_H_
55 #define FOXBMS__NXP_AFE_H_
56 
57 /*========== Includes =======================================================*/
58 
59 #include "fstd_types.h"
60 
61 /* clang-format off */
62 #include "afe.h"
63 /* clang-format on */
64 
65 #include <stdbool.h>
66 #include <stdint.h>
67 
68 /*========== Macros and Definitions =========================================*/
69 
70 /*========== Extern Constant and Variable Declarations ======================*/
71 
72 /*========== Extern Function Prototypes =====================================*/
73 
74 /** Function called to run the AFE driver */
75 extern STD_RETURN_TYPE_e NXP_Measure(void);
76 /** Function setting the pins of the port expander */
78 /** Function to request a read of the I2C EEPROM on the slaves */
79 extern STD_RETURN_TYPE_e NXP_RequestEepromRead(uint8_t string);
80 /** Function to request a write to the I2C EEPROM on the slaves */
81 extern STD_RETURN_TYPE_e NXP_RequestEepromWrite(uint8_t string);
82 /** Function to request a read of the I2C temperature sensor on the slaves */
83 extern STD_RETURN_TYPE_e NXP_RequestTemperatureRead(uint8_t string);
84 /** Function to request a read of the balancing feedback on the slaves */
86 /** Function to request an openWire check on the slaves */
87 extern STD_RETURN_TYPE_e NXP_RequestOpenWireCheck(uint8_t string);
88 /** Function to request a start of the AFE driver, deprecated with the continuously running task */
90 /** Function to check if at least one measurement cycle has been made */
91 extern bool NXP_IsFirstMeasurementCycleFinished(void);
92 /** Function to request a read of the I2C port expnader on the slaves */
93 extern STD_RETURN_TYPE_e NXP_RequestIoRead(uint8_t string);
94 /** Function to request a write to the I2C port expnader on the slaves */
96 
97 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
98 #ifdef UNITY_UNIT_TEST
99 #endif
100 
101 #endif /* FOXBMS__NXP_AFE_H_ */
AFE driver header.
Definition of foxBMS standard types.
STD_RETURN_TYPE_e
Definition: fstd_types.h:82
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)