foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
mxm_cfg.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file mxm_cfg.c
44  * @author foxBMS Team
45  * @date 2019-01-09 (date of creation)
46  * @updated 2020-06-22 (date of last update)
47  * @ingroup DRIVERS_CONFIGURATION
48  * @prefix MXM
49  *
50  * @brief Configuration for the MAX monitoring chip
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "mxm_cfg.h"
56 
57 #include "io.h"
58 #include "spi.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 
64 /*========== Extern Constant and Variable Definitions =======================*/
65 
66 /*========== Static Function Prototypes =====================================*/
67 
68 /*========== Static Function Implementations ================================*/
69 
70 /*========== Extern Function Implementations ================================*/
71 
72 extern void MXM_MonitoringPinInit(void) {
75 }
76 
78  /* the current implementation is blocking, therefore the interface is always accesible */
79  return STD_OK;
80 }
81 
82 extern STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length) {
83  return SPI_TransmitData(&spi_MxmInterface, txBuffer, length);
84 }
85 
86 extern STD_RETURN_TYPE_e MXM_ReceiveData(uint16_t *txBuffer, uint16_t *rxBuffer, uint16_t length) {
87  return SPI_TransmitReceiveData(&spi_MxmInterface, txBuffer, rxBuffer, length);
88 }
89 
90 /*========== Externalized Static Function Implementations (Unit Test) =======*/
MXM_GetSPIStateReady
STD_RETURN_TYPE_e MXM_GetSPIStateReady(void)
Return whether SPI interface is ready.
Definition: mxm_cfg.c:77
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
spi.h
Headers for the driver for the SPI module.
MXM_17841B_SHTNDL_PIN
#define MXM_17841B_SHTNDL_PIN
Definition: mxm_cfg.h:75
mxm_cfg.h
Header for the configuration for the Maxim monitoring chip.
SPI_TransmitReceiveData
STD_RETURN_TYPE_e SPI_TransmitReceiveData(SPI_INTERFACE_CONFIG_s *pSpiInterface, uint16 *pTxBuff, uint16 *pRxBuff, uint32 frameLength)
Transmits and receives data on SPI without DMA.
Definition: spi.c:138
STD_OK
@ STD_OK
Definition: fstd_types.h:72
MXM_17841B_GIODIR
#define MXM_17841B_GIODIR
Definition: mxm_cfg.h:72
MXM_17841B_GIOPORT
#define MXM_17841B_GIOPORT
Definition: mxm_cfg.h:73
spi_MxmInterface
SPI_INTERFACE_CONFIG_s spi_MxmInterface
Definition: spi_cfg.c:110
MXM_MonitoringPinInit
void MXM_MonitoringPinInit(void)
Initialize the pins connected to the MAX17841B.
Definition: mxm_cfg.c:72
MXM_ReceiveData
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:86
SPI_TransmitData
STD_RETURN_TYPE_e SPI_TransmitData(SPI_INTERFACE_CONFIG_s *pSpiInterface, uint16_t *pTxBuff, uint32_t frameLength)
Sends data on SPI without DMA.
Definition: spi.c:100
io.h
Header for the driver for the IO module.
rxBuffer
uint16_t rxBuffer[100]
Definition: test_mxm_17841b.c:85
MXM_SendData
STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length)
Transmit data over SPI.
Definition: mxm_cfg.c:82
IO_PinSet
void IO_PinSet(uint32_t *pRegisterAddress, uint32_t pin)
Set pin by writing in pin output register.
Definition: io.c:72