foxBMS  1.1.0
The foxBMS Battery Management System API Documentation
mxm_cfg.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 mxm_cfg.h
44  * @author foxBMS Team
45  * @date 2019-01-09 (date of creation)
46  * @updated 2021-03-24 (date of last update)
47  * @ingroup DRIVERS_CONFIGURATION
48  * @prefix MXM
49  *
50  * @brief Header for the configuration for the Maxim monitoring chip.
51  *
52  */
53 
54 #ifndef FOXBMS__MXM_CFG_H_
55 #define FOXBMS__MXM_CFG_H_
56 
57 /*========== Includes =======================================================*/
58 #include "general.h"
59 
60 #include "battery_system_cfg.h"
61 #include "spi_cfg.h"
62 
63 #include "HL_reg_het.h"
64 
65 #include "spi.h"
66 
67 /*========== Macros and Definitions =========================================*/
68 /**
69  * MAX17841B GPIO configuration
70  * @{
71  */
72 #define MXM_17841B_GIODIR (hetREG1->DIR)
73 #define MXM_17841B_GIOPORT (hetREG1->DOUT)
74 
75 #define MXM_17841B_SHTNDL_PIN (21U)
76 
77 /**@}*/
78 
79 /*========== Extern Constant and Variable Declarations ======================*/
80 
81 /*========== Extern Function Prototypes =====================================*/
82 /**
83  * @brief Initialize the pins connected to the MAX17841B
84  * @details Initializes the pins that are needed by MAX17841B
85  * to a known state. The pins are:
86  * * the interrupt pin
87  * * the shutdown pin
88  * * the chip select pin
89  *
90  * Only the necessary pins are configured.
91  */
92 extern void MXM_MonitoringPinInit(void);
93 
94 /**
95  * @brief Return whether SPI interface is ready
96  * @details In the case of an DMA-based implementation this function
97  * can be used to check the state of the SPI interface and whether
98  * it can be accessed for writing.
99  * @return #STD_OK if the SPI interface is free
100  */
102 
103 /**
104  * @brief Transmit data over SPI
105  * @details Wraps the #SPI_TransmitData API function in order to have
106  * one single point of access for the driver to the SPI interface.
107  * @param[in] txBuffer pointer to an array that is to be transmitted
108  * @param[in] length length of array
109  * @return #STD_NOT_OK for unsuccessful transmissions, #STD_OK on success
110  */
111 extern STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length);
112 
113 /**
114  * @brief Send and Receive data over SPI
115  * @details Wraps the #SPI_TransmitReceiveData API function in order to
116  * have one single point of access for the driver to the SPI
117  * interface.
118  * @param[in] txBuffer pointer to an array that is to be transmitted
119  * @param[out] rxBuffer pointer to an array into which received data shall
120  * be written
121  * @param[in] length length of both arrays
122  * @return #STD_NOT_OK for unsuccessful transmissions, #STD_OK on success
123  */
124 extern STD_RETURN_TYPE_e MXM_ReceiveData(uint16_t *txBuffer, uint16_t *rxBuffer, uint16_t length);
125 
126 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
127 
128 #endif /* FOXBMS__MXM_CFG_H_ */
Configuration of the battery system (e.g., number of battery modules, battery cells,...
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
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:92
STD_RETURN_TYPE_e MXM_GetSPIStateReady(void)
Return whether SPI interface is ready.
Definition: mxm_cfg.c:81
void MXM_MonitoringPinInit(void)
Initialize the pins connected to the MAX17841B.
Definition: mxm_cfg.c:72
STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length)
Transmit data over SPI.
Definition: mxm_cfg.c:86
Headers for the driver for the SPI module.
Headers for the configuration for the SPI module.