Header for the configuration for the driver for the smart power switches. More...

#include "battery_system_cfg.h"
#include "sps_types.h"
#include <math.h>
#include <stdint.h>

Include dependency graph for sps_cfg.h:

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

Data Structures
struct	SPS_CHANNEL_STATE_s

struct	SPS_CHANNEL_FEEDBACK_MAPPING_s

Macros
#define	SPS_NR_CONTACTOR_PER_IC (4u)

#define	SPS_NR_OF_IC (2u)

#define	SPS_NR_OF_REQUIRED_CONTACTOR_CHANNELS (BS_NR_OF_CONTACTORS)

#define	SPS_NR_OF_AVAILABLE_SPS_CHANNELS (SPS_NR_CONTACTOR_PER_IC * SPS_NR_OF_IC)

#define	SPS_SPI_BUFFERSIZE SPS_NR_OF_IC

#define	SPS_RW_BIT_POSITION (15u)

#define	SPS_RW_READ (0u)

#define	SPS_RW_WRITE (1u)

#define	SPS_ADDRESS_BIT_START (8u)

#define	SPS_DIAG_CTRL_BIT_POSITION (7u)

#define	SPS_NORMAL_MODE (0x01u)

#define	SPS_STRONG_DRIVE (0x00u)

#define	SPS_MEDIUM_DRIVE (0x01u)

#define	SPS_MODE_BIT_START (6u)

#define	SPS_DRIVE_STRENGTH_BIT_START (5u)

#define	SPS_I_MEASUREMENT_LSB_mA (0.98f)

#define	SPS_CHANNEL_ON_DEFAULT_THRESHOLD_mA (20.0f)

#define	SPS_BITMASK_DIAGNOSTIC_ONDEMAND_OUTPUT_CURRENT (0x1FFFu)


#define	SPS_RESET_GIO_PORT (hetREG2->DOUT)

#define	SPS_RESET_GIO_PORT_DIR (hetREG2->DIR)

#define	SPS_RESET_PIN (16u)


#define	SPS_FEEDBACK_GIO_PORT (hetREG2->DOUT)

#define	SPS_FEEDBACK_GIO_PORT_DIR (hetREG2->DIR)

#define	SPS_FEEDBACK_PIN (9u)


#define	SPS_CHANNEL_0 ((SPS_CHANNEL_INDEX)0)

#define	SPS_CHANNEL_1 ((SPS_CHANNEL_INDEX)1)

#define	SPS_CHANNEL_2 ((SPS_CHANNEL_INDEX)2)

#define	SPS_CHANNEL_3 ((SPS_CHANNEL_INDEX)3)

#define	SPS_CHANNEL_4 ((SPS_CHANNEL_INDEX)4)

#define	SPS_CHANNEL_5 ((SPS_CHANNEL_INDEX)5)

#define	SPS_CHANNEL_6 ((SPS_CHANNEL_INDEX)6)

#define	SPS_CHANNEL_7 ((SPS_CHANNEL_INDEX)7)


#define	SPS_GLOBAL_CONTROL_REGISTER_ADDRESS (0x00u)

#define	SPS_OUTPUT_CONTROL_REGISTER_ADDRESS (0x02u)

#define	SPS_C_CONTROL_REGISTER_ADDRESS (0x16u)


#define	SPS_ISR_IRQ_DIAG_REGISTER_ADDRESS (0x06u)

#define	SPS_ISR_WARN_DIAG_REGISTER_ADDRESS (0x07u)

#define	SPS_OD_IOUT1_DIAG_REGISTER_ADDRESS (0x08u)

#define	SPS_OD_IOUT2_DIAG_REGISTER_ADDRESS (0x09u)

#define	SPS_OD_IOUT3_DIAG_REGISTER_ADDRESS (0x0Au)

#define	SPS_OD_IOUT4_DIAG_REGISTER_ADDRESS (0x0Bu)

Enumerations
enum	SPS_WRITE_TYPE_e { SPS_replaceCurrentValue , SPS_orWithCurrentValue , SPS_andWithCurrentValue }

enum	SPS_READ_TYPE_e { SPS_READ_DIAGNOSTIC_REGISTER , SPS_READ_CONTROL_REGISTER }

enum	SPS_CHANNEL_FUNCTION_e { SPS_CHANNEL_OFF , SPS_CHANNEL_ON }

enum	SPS_STATE_e { SPS_START , SPS_RESET_LOW , SPS_RESET_HIGH , SPS_CONFIGURE_CONTROL_REGISTER , SPS_TRIGGER_CURRENT_MEASUREMENT , SPS_READ_MEASURED_CURRENT1 , SPS_READ_MEASURED_CURRENT2 , SPS_READ_MEASURED_CURRENT3 , SPS_READ_MEASURED_CURRENT4 , SPS_READ_EN_IRQ_PIN }

enum	SPS_ACTION_e { SPS_ACTION_CONFIGURE_CONTROL_REGISTER , SPS_ACTION_TRIGGER_CURRENT_MEASUREMENT , SPS_ACTION_READ_CURRENT_MEASUREMENT1 , SPS_ACTION_READ_CURRENT_MEASUREMENT2 , SPS_ACTION_READ_CURRENT_MEASUREMENT3 , SPS_ACTION_READ_CURRENT_MEASUREMENT4 , SPS_ACTION_READ_EN_IRQ_PIN }

Variables
SPS_CHANNEL_STATE_s	sps_channelStatus [SPS_NR_OF_AVAILABLE_SPS_CHANNELS]

const SPS_CHANNEL_FEEDBACK_MAPPING_s	sps_kChannelFeedbackMapping [SPS_NR_OF_AVAILABLE_SPS_CHANNELS]

Detailed Description

Header for the configuration for the driver for the smart power switches.

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: 2020-10-14 (date of creation)

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

Version: v1.6.0

Prefix: SPS

Definition in file sps_cfg.h.

Macro Definition Documentation

◆ SPS_ADDRESS_BIT_START

#define SPS_ADDRESS_BIT_START (8u)

In Tx SPI buffer, register address starts at bit 8

Definition at line 145 of file sps_cfg.h.

◆ SPS_BITMASK_DIAGNOSTIC_ONDEMAND_OUTPUT_CURRENT

#define SPS_BITMASK_DIAGNOSTIC_ONDEMAND_OUTPUT_CURRENT (0x1FFFu)

bitmask for reading the on-demand output current from a SPI transaction

Definition at line 170 of file sps_cfg.h.

◆ SPS_C_CONTROL_REGISTER_ADDRESS

#define SPS_C_CONTROL_REGISTER_ADDRESS (0x16u)

Addresses of used control registers

Definition at line 123 of file sps_cfg.h.