foxBMS
1.2.1
The foxBMS Battery Management System API Documentation
|
Header for the configuration for the Maxim monitoring chip. More...
#include "general.h"
#include "battery_system_cfg.h"
#include "spi_cfg.h"
#include "HL_reg_het.h"
#include "spi.h"
Go to the source code of this file.
Macros | |
#define | MXM_17841B_GIOPORT (hetREG1) |
#define | MXM_17841B_SHTNDL_PIN (21U) |
#define | MXM_41B_RX_INT_ENABLE_DEFAULT_VALUE (0x00u) |
#define | MXM_41B_TX_INT_ENABLE_DEFAULT_VALUE (0x00u) |
#define | MXM_41B_RX_INT_FLAG_DEFAULT_VALUE (0x00u) |
#define | MXM_41B_TX_INT_FLAG_DEFAULT_VALUE (0x80u) |
#define | MXM_41B_CONFIG_1_DEFAULT_VALUE (0x60u) |
#define | MXM_41B_CONFIG_2_DEFAULT_VALUE (0x10u) |
#define | MXM_41B_CONFIG_3_DEFAULT_VALUE (0x0Fu) |
Functions | |
void | MXM_InitializeMonitoringPins (void) |
Initialize the pins connected to the MAX17841B. More... | |
STD_RETURN_TYPE_e | MXM_GetSPIStateReady (void) |
Return whether SPI interface is ready. More... | |
STD_RETURN_TYPE_e | MXM_SendData (uint16_t *txBuffer, uint16_t length) |
Transmit data over SPI. More... | |
STD_RETURN_TYPE_e | MXM_ReceiveData (uint16_t *txBuffer, uint16_t *rxBuffer, uint16_t length) |
Send and Receive data over SPI. More... | |
void | MXM_ShutDownBridgeIc (void) |
Pulls the shutdown of the bridge IC low. More... | |
void | MXM_EnableBridgeIc (void) |
Pulls the shutdown of the bridge IC high. More... | |
Variables | |
const bool | mxm_allowSkippingPostInitSelfCheck |
Header for the configuration for the Maxim monitoring chip.
SPDX-License-Identifier: BSD-3-Clause
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:
Definition in file mxm_cfg.h.
#define MXM_17841B_GIOPORT (hetREG1) |
#define MXM_17841B_SHTNDL_PIN (21U) |
#define MXM_41B_CONFIG_1_DEFAULT_VALUE (0x60u) |
#define MXM_41B_CONFIG_2_DEFAULT_VALUE (0x10u) |
#define MXM_41B_CONFIG_3_DEFAULT_VALUE (0x0Fu) |
#define MXM_41B_RX_INT_ENABLE_DEFAULT_VALUE (0x00u) |
#define MXM_41B_RX_INT_FLAG_DEFAULT_VALUE (0x00u) |
#define MXM_41B_TX_INT_ENABLE_DEFAULT_VALUE (0x00u) |
#define MXM_41B_TX_INT_FLAG_DEFAULT_VALUE (0x80u) |
void MXM_EnableBridgeIc | ( | void | ) |
Pulls the shutdown of the bridge IC high.
The bridge IC used in this driver has a shutdown pin that allows to switch it off. This function tells the bridge IC to enable. (Pulls the shutdown high, bridge IC will start)
Definition at line 103 of file mxm_cfg.c.
STD_RETURN_TYPE_e MXM_GetSPIStateReady | ( | void | ) |
Return whether SPI interface is ready.
In the case of an DMA-based implementation this function can be used to check the state of the SPI interface and whether it can be accessed for writing.
Definition at line 82 of file mxm_cfg.c.
void MXM_InitializeMonitoringPins | ( | void | ) |
Initialize the pins connected to the MAX17841B.
Initializes the pins that are needed by MAX17841B to a known state. The pins are:
Only the necessary pins are configured.
Definition at line 73 of file mxm_cfg.c.
STD_RETURN_TYPE_e MXM_ReceiveData | ( | uint16_t * | txBuffer, |
uint16_t * | rxBuffer, | ||
uint16_t | length | ||
) |
Send and Receive data over SPI.
Wraps the SPI_TransmitReceiveData API function in order to have one single point of access for the driver to the SPI interface.
[in] | txBuffer | pointer to an array that is to be transmitted |
[out] | rxBuffer | pointer to an array into which received data shall be written |
[in] | length | length of both arrays |
Definition at line 92 of file mxm_cfg.c.
STD_RETURN_TYPE_e MXM_SendData | ( | uint16_t * | txBuffer, |
uint16_t | length | ||
) |
Transmit data over SPI.
Wraps the SPI_TransmitData API function in order to have one single point of access for the driver to the SPI interface.
[in] | txBuffer | pointer to an array that is to be transmitted |
[in] | length | length of array |
Definition at line 86 of file mxm_cfg.c.
void MXM_ShutDownBridgeIc | ( | void | ) |