foxBMS - Unit Tests  1.3.0
The foxBMS Unit Tests API Documentation
mxm_cfg.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 mxm_cfg.h
44  * @author foxBMS Team
45  * @date 2019-01-09 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix MXM
50  *
51  * @brief Header for the configuration for the Maxim monitoring chip.
52  *
53  */
54 
55 #ifndef FOXBMS__MXM_CFG_H_
56 #define FOXBMS__MXM_CFG_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 #include "battery_system_cfg.h"
62 #include "spi_cfg.h"
63 
64 #include "HL_reg_het.h"
65 
66 #include "spi.h"
67 
68 /*========== Macros and Definitions =========================================*/
69 /**
70  * MAX17841B GPIO configuration
71  * @{
72  */
73 #define MXM_17841B_GIOPORT (hetREG1)
74 #define MXM_17841B_SHTNDL_PIN (21U)
75 /**@}*/
76 
77 /**
78  * MAX17841B configuration registers default values
79  * @{
80  */
81 #define MXM_41B_RX_INT_ENABLE_DEFAULT_VALUE (0x00u)
82 #define MXM_41B_TX_INT_ENABLE_DEFAULT_VALUE (0x00u)
83 #define MXM_41B_RX_INT_FLAG_DEFAULT_VALUE (0x00u)
84 #define MXM_41B_TX_INT_FLAG_DEFAULT_VALUE (0x80u)
85 
86 /** default configuration for config 1
87  *
88  * * baudrate 2Mbps
89  * * no single ended mode
90  * * no device count
91  */
92 #define MXM_41B_CONFIG_1_DEFAULT_VALUE (0x60u)
93 
94 /** default configuration for config 2
95  *
96  * * enable tx queue mode
97  */
98 #define MXM_41B_CONFIG_2_DEFAULT_VALUE (0x10u)
99 
100 /** default config for config 3
101  *
102  * * no keep-alive (infinite delay)
103  */
104 #define MXM_41B_CONFIG_3_DEFAULT_VALUE (0x0Fu)
105 /**@}*/
106 
107 /** maximum time that the driver may spend in initialization in ms */
108 #define MXM_MAXIMUM_INIT_TIME_ms (4000u)
109 
110 /*========== Extern Constant and Variable Declarations ======================*/
111 /** if this flag is set, the post init self check will pass on even if the satellite numbers are not correct */
112 extern const bool mxm_allowSkippingPostInitSelfCheck;
113 
114 /*========== Extern Function Prototypes =====================================*/
115 /**
116  * @brief Initialize the pins connected to the MAX17841B
117  * @details Initializes the pins that are needed by MAX17841B
118  * to a known state. The pins are:
119  * * the interrupt pin
120  * * the shutdown pin
121  * * the chip select pin
122  *
123  * Only the necessary pins are configured.
124  */
125 extern void MXM_InitializeMonitoringPins(void);
126 
127 /**
128  * @brief Return whether SPI interface is ready
129  * @details In the case of an DMA-based implementation this function
130  * can be used to check the state of the SPI interface and whether
131  * it can be accessed for writing.
132  * @return #STD_OK if the SPI interface is free
133  */
135 
136 /**
137  * @brief Transmit data over SPI
138  * @details Wraps the #SPI_TransmitData API function in order to have
139  * one single point of access for the driver to the SPI interface.
140  * @param[in] txBuffer pointer to an array that is to be transmitted
141  * @param[in] length length of array
142  * @return #STD_NOT_OK for unsuccessful transmissions, #STD_OK on success
143  */
144 extern STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length);
145 
146 /**
147  * @brief Send and Receive data over SPI
148  * @details Wraps the #SPI_TransmitReceiveData API function in order to
149  * have one single point of access for the driver to the SPI
150  * interface.
151  * @param[in] txBuffer pointer to an array that is to be transmitted
152  * @param[out] rxBuffer pointer to an array into which received data shall
153  * be written
154  * @param[in] length length of both arrays
155  * @return #STD_NOT_OK for unsuccessful transmissions, #STD_OK on success
156  */
157 extern STD_RETURN_TYPE_e MXM_ReceiveData(uint16_t *txBuffer, uint16_t *rxBuffer, uint16_t length);
158 
159 /**
160  * @brief Pulls the shutdown of the bridge IC low
161  * @details The bridge IC used in this driver has a shutdown pin that allows
162  * to switch it off. This function tells the bridge IC to shut down.
163  */
164 extern void MXM_ShutDownBridgeIc(void);
165 
166 /**
167  * @brief Pulls the shutdown of the bridge IC high
168  * @details The bridge IC used in this driver has a shutdown pin that allows
169  * to switch it off. This function tells the bridge IC to enable.
170  * (Pulls the shutdown high, bridge IC will start)
171  */
172 extern void MXM_EnableBridgeIc(void);
173 
174 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
175 
176 #endif /* FOXBMS__MXM_CFG_H_ */
Configuration of the battery system (e.g., number of battery modules, battery cells,...
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
General macros and definitions for the whole platform.
STD_RETURN_TYPE_e MXM_ReceiveData(uint16_t *txBuffer, uint16_t *rxBuffer, uint16_t length)
Send and Receive data over SPI.
Definition: mxm_cfg.c:97
const bool mxm_allowSkippingPostInitSelfCheck
Definition: mxm_cfg.c:67
void MXM_InitializeMonitoringPins(void)
Initialize the pins connected to the MAX17841B.
Definition: mxm_cfg.c:75
STD_RETURN_TYPE_e MXM_GetSPIStateReady(void)
Return whether SPI interface is ready.
Definition: mxm_cfg.c:84
void MXM_ShutDownBridgeIc(void)
Pulls the shutdown of the bridge IC low.
Definition: mxm_cfg.c:107
void MXM_EnableBridgeIc(void)
Pulls the shutdown of the bridge IC high.
Definition: mxm_cfg.c:111
STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length)
Transmit data over SPI.
Definition: mxm_cfg.c:88
Headers for the driver for the SPI module.
Headers for the configuration for the SPI module.
uint16_t rxBuffer[100]