foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
nxp_mc33775a.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_mc33775a.h
44  * @author foxBMS Team
45  * @date 2020-05-08 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVERS
49  * @prefix N775
50  *
51  * @brief Headers for the driver for the MC33775A analog front-end.
52  *
53  */
54 
55 #ifndef FOXBMS__NXP_MC33775A_H_
56 #define FOXBMS__NXP_MC33775A_H_
57 
58 /*========== Includes =======================================================*/
59 #include "nxp_mc33775a_cfg.h"
60 
61 #include <stdint.h>
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Extern Constant and Variable Declarations ======================*/
66 
67 /**
68  * Variable containing the state machine state for the MC33775A driver.
69  */
71 
72 /*========== Extern Function Prototypes =====================================*/
73 
74 /**
75  * @brief trigger function for the N775 driver state machine.
76  *
77  * This function contains the sequence of events in the N775 state machine.
78  * It must be called time-triggered, every 1ms.
79  *
80  * @param n775_state state of the N775A driver
81  *
82  */
83 extern void N775_Meas(N775_STATE_s *n775_state);
84 
85 /**
86  * @brief gets the measurement initialization status.
87  *
88  * @param n775_state state of the N775A driver
89  *
90  * @return true if a first measurement cycle was made, false otherwise
91  *
92  */
93 extern bool N775_IsFirstMeasurementCycleFinished(N775_STATE_s *n775_state);
94 
95 /**
96  * @brief trigger a write on the I2C bus of the slave.
97  *
98  * @param module module number to address in the daisy-chain
99  * @param deviceAddress address of the I2C device addressed
100  * @param pData data to write on I2C bus
101  * @param dataLength number of bytes to write
102  *
103  */
104 extern STD_RETURN_TYPE_e N775_I2cWrite(uint8_t module, uint8_t deviceAddress, uint8_t *pData, uint8_t dataLength);
105 
106 /**
107  * @brief trigger a read on the I2C bus of the slave, first write address of register to read.
108  *
109  * @param module module number to address in the daisy-chain
110  * @param deviceAddress address of the I2C device addressed
111  * @param pDataWrite data written on I2C bus
112  * @param writeDataLength number of bytes to write
113  * @param pDataRead data read on I2C bus
114  * @param readDataLength number of bytes to read
115  *
116  */
118  uint8_t module,
119  uint8_t deviceAddress,
120  uint8_t *pDataWrite,
121  uint8_t writeDataLength,
122  uint8_t *pDataRead,
123  uint8_t readDataLength);
124 /**
125  * @brief trigger a read on the I2C bus of the slave.
126  *
127  * @param module module number to address in the daisy-chain
128  * @param deviceAddress address of the I2C device addressed
129  * @param pData data read on I2C bus
130  * @param dataLength number of bytes to read
131  *
132  */
133 extern STD_RETURN_TYPE_e N775_I2cRead(uint8_t module, uint8_t deviceAddress, uint8_t *pData, uint8_t dataLength);
134 
135 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
136 #ifdef UNITY_UNIT_TEST
137 /* Start test functions */
138 extern uint8_t TEST_N775_CheckReEntrance();
140 /* End test functions */
141 #endif
142 
143 #endif /* FOXBMS__NXP_MC33775A_H_ */
STD_RETURN_TYPE_e
Definition: fstd_types.h:82
STD_RETURN_TYPE_e N775_I2cWriteRead(uint8_t module, uint8_t deviceAddress, uint8_t *pDataWrite, uint8_t writeDataLength, uint8_t *pDataRead, uint8_t readDataLength)
trigger a read on the I2C bus of the slave, first write address of register to read.
Definition: nxp_mc33775a.c:295
void TEST_N775_SetFirstMeasurementCycleFinished(N775_STATE_s *n775_state)
void N775_Meas(N775_STATE_s *n775_state)
trigger function for the N775 driver state machine.
Definition: nxp_mc33775a.c:209
N775_STATE_s n775_stateBase
Definition: nxp_mc33775a.c:104
uint8_t TEST_N775_CheckReEntrance()
STD_RETURN_TYPE_e N775_I2cRead(uint8_t module, uint8_t deviceAddress, uint8_t *pData, uint8_t dataLength)
trigger a read on the I2C bus of the slave.
Definition: nxp_mc33775a.c:337
STD_RETURN_TYPE_e N775_I2cWrite(uint8_t module, uint8_t deviceAddress, uint8_t *pData, uint8_t dataLength)
trigger a write on the I2C bus of the slave.
Definition: nxp_mc33775a.c:266
bool N775_IsFirstMeasurementCycleFinished(N775_STATE_s *n775_state)
gets the measurement initialization status.
Header for the configuration for the MC33775A analog front-end.