foxBMS  1.1.0
The foxBMS Battery Management System API Documentation
n775.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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 n775.h
44  * @author foxBMS Team
45  * @date 2020-05-08 (date of creation)
46  * @updated 2020-05-08 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix N775
49  *
50  * @brief Headers for the driver for the MC33775A monitoring chip.
51  *
52  */
53 
54 #ifndef FOXBMS__N775_H_
55 #define FOXBMS__N775_H_
56 
57 /*========== Includes =======================================================*/
58 #include "n775_cfg.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Extern Constant and Variable Declarations ======================*/
63 /**
64  * Buffer used for SPI Rx transmissions for the communication with MC33775A.
65  */
67 /**
68  * Buffer used for SPI Tx transmissions for the communication with MC33775A.
69  */
70 extern uint16_t n775_TXbuffer[N775_TX_MESSAGE_LENGTH];
71 
72 /**
73  * Struct used for SPI Tx transmissions for the communicaiton with MC33775A.
74  */
76 /**
77  * Struct used for SPI Rx transmissions for the communicaiton with MC33775A.
78  */
80 
81 /**
82  * Variable containing the state machine state for the MC33775A driver.
83  */
85 
86 /*========== Extern Function Prototypes =====================================*/
87 
88 /**
89  * @brief trigger function for the N775 driver state machine.
90  *
91  * This function contains the sequence of events in the N775 state machine.
92  * It must be called time-triggered, every 1ms.
93  */
94 extern void N775_Trigger(void);
95 
96 /**
97  * @brief sets the current state request of the state variable n775_state.
98  *
99  * This function is used to make a state request to the state machine,e.g, start voltage measurement,
100  * read result of voltage measurement, re-initialization
101  * It calls N775_CheckStateRequest() to check if the request is valid.
102  * The state request is rejected if is not valid.
103  * The result of the check is returned immediately, so that the requester can act in case
104  * it made a non-valid state request.
105  *
106  * @param statereq state request to set
107  * @return retVal current state request, taken from N775_STATE_REQUEST_e
108  */
110 
111 extern bool N775_IsFirstMeasurementCycleFinished(void);
112 
113 extern void N775_SaveVoltages(void);
114 extern void N775_SaveTemperatures(void);
116 extern N775_STATEMACH_e N775_GetState(void);
117 
118 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
119 #ifdef UNITY_UNIT_TEST
120 /* Start test functions */
121 extern uint8_t TEST_N775_CheckReEntrance();
123 /* End test functions */
124 #endif
125 
126 #endif /* FOXBMS__N775_H_ */
void TEST_N775_SetFirstMeasurementCycleFinished(N775_STATE_s *n775_state)
Definition: n775.c:551
uint8_t TEST_N775_CheckReEntrance(void)
Definition: n775.c:287
uint16_t n775_TXbuffer[N775_TX_MESSAGE_LENGTH]
Definition: n775.c:82
N775_MESSAGE_s n775_sentData
Definition: n775.c:85
bool N775_IsFirstMeasurementCycleFinished(void)
gets the measurement initialization status.
Definition: n775.c:532
N775_STATE_REQUEST_e N775_GetStateRequest(void)
gets the current state request.
Definition: n775.c:298
void N775_SaveVoltages(void)
void N775_SaveTemperatures(void)
uint16_t n775_RXbuffer[N775_MAX_N_BYTES_FOR_DATA_RECEPTION]
Definition: n775.c:81
N775_STATE_s n775_state
Definition: n775.c:108
void N775_Trigger(void)
trigger function for the N775 driver state machine.
Definition: n775.c:353
N775_STATEMACH_e N775_GetState(void)
gets the current state.
Definition: n775.c:315
N775_RETURN_TYPE_e N775_SetStateRequest(N775_STATE_REQUEST_e statereq)
sets the current state request of the state variable n775_state.
Definition: n775.c:339
N775_MESSAGE_s n775_receivedData
Definition: n775.c:86
Header for the configuration for the MC33775A monitoring chip.
#define N775_MAX_N_BYTES_FOR_DATA_RECEPTION
Definition: n775_cfg.h:151
#define N775_TX_MESSAGE_LENGTH
Definition: n775_cfg.h:79
N775_RETURN_TYPE_e
Definition: n775_defs.h:128
N775_STATE_REQUEST_e
Definition: n775_defs.h:120
N775_STATEMACH_e
Definition: n775_defs.h:82