Header for the configuration for the Maxim analog front-end. More...

#include "battery_system_cfg.h"
#include "spi_cfg.h"
#include "HL_reg_het.h"
#include "spi.h"
#include <stdint.h>

Include dependency graph for mxm_cfg.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MXM_MAXIMUM_NUMBER_OF_SUPPORTED_CELL_MEASUREMENTS (14u)

#define	MXM_MAXIMUM_INIT_TIME_ms (4000u)


#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

Detailed Description

Header for the configuration for the Maxim analog front-end.

Copyright: © 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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:

″This product uses parts of foxBMS®″
″This product includes parts of foxBMS®″
″This product is derived from foxBMS®″

Author: foxBMS Team

Date: 2019-01-09 (date of creation)

Updated: 2023-10-12 (date of last update)

Version: v1.6.0

Prefix: MXM

Definition in file mxm_cfg.h.

Macro Definition Documentation

◆ MXM_17841B_GIOPORT

#define MXM_17841B_GIOPORT (hetREG1)

MAX17841B GPIO configuration

Definition at line 80 of file mxm_cfg.h.

◆ MXM_17841B_SHTNDL_PIN

#define MXM_17841B_SHTNDL_PIN (21u)

MAX17841B GPIO configuration

Definition at line 81 of file mxm_cfg.h.

◆ MXM_41B_CONFIG_1_DEFAULT_VALUE

#define MXM_41B_CONFIG_1_DEFAULT_VALUE (0x60u)

default configuration for config 1

baudrate 2Mbps
no single ended mode
no device count

Definition at line 99 of file mxm_cfg.h.

◆ MXM_41B_CONFIG_2_DEFAULT_VALUE

#define MXM_41B_CONFIG_2_DEFAULT_VALUE (0x10u)

default configuration for config 2

enable tx queue mode

Definition at line 105 of file mxm_cfg.h.

◆ MXM_41B_CONFIG_3_DEFAULT_VALUE

#define MXM_41B_CONFIG_3_DEFAULT_VALUE (0x0Fu)

default config for config 3

no keep-alive (infinite delay)

Definition at line 111 of file mxm_cfg.h.

◆ MXM_41B_RX_INT_ENABLE_DEFAULT_VALUE

#define MXM_41B_RX_INT_ENABLE_DEFAULT_VALUE (0x00u)

MAX17841B configuration registers default values

Definition at line 88 of file mxm_cfg.h.

◆ MXM_41B_RX_INT_FLAG_DEFAULT_VALUE

#define MXM_41B_RX_INT_FLAG_DEFAULT_VALUE (0x00u)

MAX17841B configuration registers default values

Definition at line 90 of file mxm_cfg.h.

◆ MXM_41B_TX_INT_ENABLE_DEFAULT_VALUE

#define MXM_41B_TX_INT_ENABLE_DEFAULT_VALUE (0x00u)

MAX17841B configuration registers default values

Definition at line 89 of file mxm_cfg.h.

◆ MXM_41B_TX_INT_FLAG_DEFAULT_VALUE

#define MXM_41B_TX_INT_FLAG_DEFAULT_VALUE (0x80u)

MAX17841B configuration registers default values

Definition at line 91 of file mxm_cfg.h.

◆ MXM_MAXIMUM_INIT_TIME_ms

#define MXM_MAXIMUM_INIT_TIME_ms (4000u)

maximum time that the driver may spend in initialization in ms

Definition at line 115 of file mxm_cfg.h.

◆ MXM_MAXIMUM_NUMBER_OF_SUPPORTED_CELL_MEASUREMENTS

#define MXM_MAXIMUM_NUMBER_OF_SUPPORTED_CELL_MEASUREMENTS (14u)

Definition at line 70 of file mxm_cfg.h.

Function Documentation

◆ MXM_EnableBridgeIc()

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 113 of file mxm_cfg.c.

Here is the call graph for this function:

◆ MXM_GetSPIStateReady()

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.

Returns: STD_OK if the SPI interface is free

Definition at line 86 of file mxm_cfg.c.

Here is the call graph for this function:

◆ MXM_InitializeMonitoringPins()

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:

the interrupt pin
the shutdown pin
the chip select pin

Only the necessary pins are configured.

Definition at line 77 of file mxm_cfg.c.

Here is the call graph for this function:

◆ MXM_ReceiveData()

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.

Parameters

[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

Returns: STD_NOT_OK for unsuccessful transmissions, STD_OK on success

Definition at line 99 of file mxm_cfg.c.

Here is the call graph for this function:

◆ MXM_SendData()

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.

Parameters

[in]	txBuffer	pointer to an array that is to be transmitted
[in]	length	length of array

Returns: STD_NOT_OK for unsuccessful transmissions, STD_OK on success

Definition at line 90 of file mxm_cfg.c.

Here is the call graph for this function:

◆ MXM_ShutDownBridgeIc()

void MXM_ShutDownBridgeIc ( void )

Pulls the shutdown of the bridge IC low.

The bridge IC used in this driver has a shutdown pin that allows to switch it off. This function tells the bridge IC to shut down.

Definition at line 109 of file mxm_cfg.c.

Here is the call graph for this function:

Variable Documentation

◆ mxm_allowSkippingPostInitSelfCheck

const bool mxm_allowSkippingPostInitSelfCheck

extern

if this flag is set, the post init self check will pass on even if the satellite numbers are not correct

Definition at line 69 of file mxm_cfg.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MXM_17841B_GIOPORT

◆ MXM_17841B_SHTNDL_PIN

◆ MXM_41B_CONFIG_1_DEFAULT_VALUE

◆ MXM_41B_CONFIG_2_DEFAULT_VALUE

◆ MXM_41B_CONFIG_3_DEFAULT_VALUE

◆ MXM_41B_RX_INT_ENABLE_DEFAULT_VALUE

◆ MXM_41B_RX_INT_FLAG_DEFAULT_VALUE

◆ MXM_41B_TX_INT_ENABLE_DEFAULT_VALUE

◆ MXM_41B_TX_INT_FLAG_DEFAULT_VALUE

◆ MXM_MAXIMUM_INIT_TIME_ms

◆ MXM_MAXIMUM_NUMBER_OF_SUPPORTED_CELL_MEASUREMENTS

Function Documentation

◆ MXM_EnableBridgeIc()

◆ MXM_GetSPIStateReady()

◆ MXM_InitializeMonitoringPins()

◆ MXM_ReceiveData()

◆ MXM_SendData()

◆ MXM_ShutDownBridgeIc()

Variable Documentation

◆ mxm_allowSkippingPostInitSelfCheck