foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
spi_cfg.c File Reference

Configuration for the SPI module. More...

#include "spi_cfg.h"
#include "spi_cfg-helper.h"
Include dependency graph for spi_cfg.c:

Go to the source code of this file.

Functions

void SPI_SpsInterfaceSwitchToHighSpeed (SPI_INTERFACE_CONFIG_s *pSpiSpsInterface)
 Switch the SPS spi handle to high speed. More...
 
void SPI_SpsInterfaceSwitchToLowSpeed (SPI_INTERFACE_CONFIG_s *pSpiSpsInterface)
 Switch the SPS spi handle to low speed. More...
 

Variables

static spiDAT1_t spi_kLtcDataConfig [BS_NR_OF_STRINGS]
 
static spiDAT1_t spi_kMxmDataConfig
 
static spiDAT1_t spi_kNxp775DataConfigTx [BS_NR_OF_STRINGS]
 
static spiDAT1_t spi_kNxp775DataConfigRx [BS_NR_OF_STRINGS]
 
static spiDAT1_t spi_kFramDataConfig
 
static spiDAT1_t spi_kSpsDataConfigLowSpeed
 
static spiDAT1_t spi_kSpsDataConfigHighSpeed
 
static spiDAT1_t spi_kAdc0DataConfig
 
static spiDAT1_t spi_kAdc1DataConfig
 
static spiDAT1_t spi_kSbcDataConfig
 
SPI_INTERFACE_CONFIG_s spi_ltcInterface [BS_NR_OF_STRINGS]
 
SPI_INTERFACE_CONFIG_s spi_mxmInterface
 
SPI_INTERFACE_CONFIG_s spi_nxp775InterfaceTx [BS_NR_OF_STRINGS]
 
SPI_INTERFACE_CONFIG_s spi_nxp775InterfaceRx [BS_NR_OF_STRINGS]
 
SPI_INTERFACE_CONFIG_s spi_framInterface
 
SPI_INTERFACE_CONFIG_s spi_spsInterface
 
SPI_INTERFACE_CONFIG_s spi_adc0Interface
 
SPI_INTERFACE_CONFIG_s spi_adc1Interface
 
SPI_INTERFACE_CONFIG_s spi_kSbcMcuInterface
 
SPI_BUSY_STATE_e spi_busyFlags []
 
const uint8_t spi_nrBusyFlags = sizeof(spi_busyFlags) / sizeof(SPI_BUSY_STATE_e)
 

Detailed Description

Configuration for the SPI module.

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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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-03-05 (date of creation)
Updated
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
SPI

Definition in file spi_cfg.c.

Function Documentation

◆ SPI_SpsInterfaceSwitchToHighSpeed()

void SPI_SpsInterfaceSwitchToHighSpeed ( SPI_INTERFACE_CONFIG_s pSpiSpsInterface)

Switch the SPS spi handle to high speed.

Parameters
[out]pSpiSpsInterfacehandle of the SPS spi config

Definition at line 276 of file spi_cfg.c.

◆ SPI_SpsInterfaceSwitchToLowSpeed()

void SPI_SpsInterfaceSwitchToLowSpeed ( SPI_INTERFACE_CONFIG_s pSpiSpsInterface)

Switch the SPS spi handle to low speed.

Parameters
[out]pSpiSpsInterfacehandle of the SPS spi config

Definition at line 281 of file spi_cfg.c.

Variable Documentation

◆ spi_adc0Interface

SPI_INTERFACE_CONFIG_s spi_adc0Interface
Initial value:
= {
.pConfig = &spi_kAdc0DataConfig,
.pNode = spiREG3,
.pGioPort = &(spiREG3->PC3),
.csPin = 4u,
}
static spiDAT1_t spi_kAdc0DataConfig
Definition: spi_cfg.c:144
@ SPI_CHIP_SELECT_SOFTWARE
Definition: spi_cfg.h:117

SPI interface configuration for ADC communication

Definition at line 233 of file spi_cfg.c.

◆ spi_adc1Interface

SPI_INTERFACE_CONFIG_s spi_adc1Interface
Initial value:
= {
.pConfig = &spi_kAdc1DataConfig,
.pNode = spiREG3,
.pGioPort = &(spiREG3->PC3),
.csPin = 5u,
}
static spiDAT1_t spi_kAdc1DataConfig
Definition: spi_cfg.c:152

SPI interface configuration for ADC communication

Definition at line 242 of file spi_cfg.c.

◆ spi_busyFlags

SPI_BUSY_STATE_e spi_busyFlags[]
Initial value:

struct containing the lock state of the SPI interfaces

Definition at line 260 of file spi_cfg.c.

◆ spi_framInterface

SPI_INTERFACE_CONFIG_s spi_framInterface
Initial value:
= {
.pConfig = &spi_kFramDataConfig,
.pNode = spiREG3,
.pGioPort = &(spiREG3->PC3),
.csPin = 1u,
}
static spiDAT1_t spi_kFramDataConfig
Definition: spi_cfg.c:119

SPI interface configuration for FRAM communication

Definition at line 215 of file spi_cfg.c.

◆ spi_kAdc0DataConfig

spiDAT1_t spi_kAdc0DataConfig
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_2,
#define SPI_HARDWARE_CHIP_SELECT_4_ACTIVE

SPI data configuration struct for ADC communication

Definition at line 144 of file spi_cfg.c.

◆ spi_kAdc1DataConfig

spiDAT1_t spi_kAdc1DataConfig
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_2,
#define SPI_HARDWARE_CHIP_SELECT_5_ACTIVE

SPI data configuration struct for ADC communication

Definition at line 152 of file spi_cfg.c.

◆ spi_kFramDataConfig

spiDAT1_t spi_kFramDataConfig
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_1,
#define SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL

SPI data configuration struct for FRAM communication

Definition at line 119 of file spi_cfg.c.

◆ spi_kLtcDataConfig

spiDAT1_t spi_kLtcDataConfig[BS_NR_OF_STRINGS]
static
Initial value:
= {
{
.CS_HOLD = TRUE,
.WDEL = FALSE,
.DFSEL = SPI_FMT_0,
}
#define SPI_HARDWARE_CHIP_SELECT_2_ACTIVE

SPI data configuration struct for LTC communication

Definition at line 87 of file spi_cfg.c.

◆ spi_kMxmDataConfig

spiDAT1_t spi_kMxmDataConfig
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_1,
#define SPI_HARDWARE_CHIP_SELECT_0_ACTIVE

SPI data configuration struct for MXM communication

Definition at line 96 of file spi_cfg.c.

◆ spi_kNxp775DataConfigRx

spiDAT1_t spi_kNxp775DataConfigRx[BS_NR_OF_STRINGS]
static
Initial value:
= {
{.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_2,
}

SPI data configuration struct for NXP MC33775A communication, Rx part

Definition at line 111 of file spi_cfg.c.

◆ spi_kNxp775DataConfigTx

spiDAT1_t spi_kNxp775DataConfigTx[BS_NR_OF_STRINGS]
static
Initial value:
= {
{.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_2,
}
#define SPI_HARDWARE_CHIP_SELECT_1_ACTIVE

SPI data configuration struct for NXP MC33775A communication, Tx part

Definition at line 103 of file spi_cfg.c.

◆ spi_kSbcDataConfig

spiDAT1_t spi_kSbcDataConfig
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_0,

SPI configuration struct for SBC communication

Definition at line 160 of file spi_cfg.c.

◆ spi_kSbcMcuInterface

SPI_INTERFACE_CONFIG_s spi_kSbcMcuInterface
Initial value:
= {
.pConfig = &spi_kSbcDataConfig,
.pNode = spiREG2,
.pGioPort = &(spiREG2->PC3),
.csPin = 0u,
}
static spiDAT1_t spi_kSbcDataConfig
Definition: spi_cfg.c:160
@ SPI_CHIP_SELECT_HARDWARE
Definition: spi_cfg.h:116

SPI interface configuration for SBC communication

Definition at line 251 of file spi_cfg.c.

◆ spi_kSpsDataConfigHighSpeed

spiDAT1_t spi_kSpsDataConfigHighSpeed
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_2,

SPI data configuration struct for SPS communication in high speed (10MHz)

Definition at line 136 of file spi_cfg.c.

◆ spi_kSpsDataConfigLowSpeed

spiDAT1_t spi_kSpsDataConfigLowSpeed
static
Initial value:
= {
.CS_HOLD = TRUE,
.WDEL = TRUE,
.DFSEL = SPI_FMT_1,
}

SPI data configuration struct for SPS communication in low speed (4MHz)

Definition at line 127 of file spi_cfg.c.

◆ spi_ltcInterface

Initial value:
= {
{
.pConfig = &spi_kLtcDataConfig[0u],
.pNode = spiREG1,
.pGioPort = &(spiREG1->PC3),
.csPin = 2u,
},
}
static spiDAT1_t spi_kLtcDataConfig[BS_NR_OF_STRINGS]
Definition: spi_cfg.c:87

SPI interface configuration for LTC communication This is a list of structs because of multistring

Definition at line 173 of file spi_cfg.c.

◆ spi_mxmInterface

SPI_INTERFACE_CONFIG_s spi_mxmInterface
Initial value:
= {
.pConfig = &spi_kMxmDataConfig,
.pNode = spiREG4,
.pGioPort = &(spiREG4->PC3),
.csPin = 0u,
}
static spiDAT1_t spi_kMxmDataConfig
Definition: spi_cfg.c:96

SPI interface configuration for MXM communication

Definition at line 184 of file spi_cfg.c.

◆ spi_nrBusyFlags

const uint8_t spi_nrBusyFlags = sizeof(spi_busyFlags) / sizeof(SPI_BUSY_STATE_e)

size of spi_busyFlags

Definition at line 269 of file spi_cfg.c.

◆ spi_nxp775InterfaceRx

SPI_INTERFACE_CONFIG_s spi_nxp775InterfaceRx[BS_NR_OF_STRINGS]
Initial value:
= {
{
.pConfig = &spi_kNxp775DataConfigRx[0u],
.pNode = spiREG4,
.pGioPort = &(spiREG4->PC3),
.csPin = 0u,
},
}
static spiDAT1_t spi_kNxp775DataConfigRx[BS_NR_OF_STRINGS]
Definition: spi_cfg.c:111

SPI interface configuration for N775 communication, Rx part

Definition at line 204 of file spi_cfg.c.

◆ spi_nxp775InterfaceTx

SPI_INTERFACE_CONFIG_s spi_nxp775InterfaceTx[BS_NR_OF_STRINGS]
Initial value:
= {
{
.pConfig = &spi_kNxp775DataConfigTx[0u],
.pNode = spiREG1,
.pGioPort = &(spiREG1->PC3),
.csPin = 1u,
},
}
static spiDAT1_t spi_kNxp775DataConfigTx[BS_NR_OF_STRINGS]
Definition: spi_cfg.c:103

SPI interface configuration for N775 communication Tx part

Definition at line 193 of file spi_cfg.c.

◆ spi_spsInterface

SPI_INTERFACE_CONFIG_s spi_spsInterface
Initial value:
= {
.pNode = spiREG2,
.pGioPort = &SPI_SPS_CS_GIOPORT,
.csPin = SPI_SPS_CS_PIN,
}
static spiDAT1_t spi_kSpsDataConfigLowSpeed
Definition: spi_cfg.c:127
#define SPI_SPS_CS_GIOPORT
Definition: spi_cfg.h:102
#define SPI_SPS_CS_PIN
Definition: spi_cfg.h:104

SPI interface configuration for SPS communication

Definition at line 224 of file spi_cfg.c.