Tests for the spi module. More...

#include "unity.h"
#include "MockHL_spi.h"
#include "MockHL_sys_dma.h"
#include "Mockdma_cfg.h"
#include "Mockio.h"
#include "Mockmcu.h"
#include "Mockos.h"
#include "Mockspi_cfg.h"
#include "spi.h"
#include "spi_cfg-helper.h"
#include "test_assert_helper.h"
#include <stdbool.h>

Include dependency graph for test_spi.c:

Go to the source code of this file.

Functions
long	FSYS_RaisePrivilege (void)
	Raise privilege. More...

void	setUp (void)

void	tearDown (void)

void	testSPI_InitializeChipSelects (void)
	Testing static function SPI_InitializeChipSelects. More...

void	testSPI_GetChipSelectPin (void)
	Testing static function SPI_GetChipSelectPin. More...

void	testSPI_GetHardwareChipSelectPin (void)
	Testing static function SPI_GetHardwareChipSelectPin. More...

void	testSPI_SetFunctionalNullPointer (void)

void	testSPI_SetFunctionalTestIntendedFunctionSet (void)

void	testSPI_SetFunctionalTestIntendedFunctionClear (void)

void	testSPI_SetFunctionalRightApiSpi1 (void)

void	testSPI_SetFunctionalRightApiSpi2 (void)

void	testSPI_SetFunctionalRightApiSpi3 (void)

void	testSPI_SetFunctionalRightApiSpi4 (void)

void	testSPI_SetFunctionalRightApiSpi5 (void)

void	testSPI_CheckInterfaceAvailableInvalidInput (void)

void	testSPI_CheckInterfaceAvailable (void)

void	testSPI_GetSpiIndex (void)
	Testing extern function SPI_GetSpiIndex. More...

Variables
spiBASE_t *	dma_spiInterfaces [DMA_NUMBER_SPI_INTERFACES]

DMA_CHANNEL_CONFIG_s	dma_spiDmaChannels [DMA_NUMBER_SPI_INTERFACES]

static spiDAT1_t	spi_kAdiDataConfig [BS_NR_OF_STRINGS]

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_kSbcDataConfig

SPI_INTERFACE_CONFIG_s	spi_adiInterface [BS_NR_OF_STRINGS]

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_sbcMcuInterface

SPI_BUSY_STATE_e	spi_busyFlags []

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

spiBASE_t	spiMockHandle = {0}

spi_config_reg_t	spiMockConfigRegister = {0}

Detailed Description

Tests for the spi module.

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-04-01 (date of creation)

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

Version: v1.6.0

Prefix: TEST

Definition in file test_spi.c.

Function Documentation

◆ FSYS_RaisePrivilege()

long FSYS_RaisePrivilege ( void )

Raise privilege.

This alias is mapped to an ASM function and raises to a privileged processor state if the system is currently in user mode. This is done by the following ASM code:

Copy the contents of a CP14 or CP15 coprocessor register (in this case SPSR – Saved Program Status Register) into local register r12:
```
mrs     r12, spsr 
```
Perform bitwise AND on the contents of r12 and 0x0F
write to r0
update condition code flag on result of operation
```
ands    r0, r12, #0x0F      ; return value 
```
Perform a logical OR on the contents of r12 and 0x1F, if equal to condition code flag from previous instruction
write to r12
```
orreq   r12, r12, #0x1F 
```
Conditionally (equal on previous instruction condition code flag) load immediate result from r12 into control field mask byte, PSR[7:0] (privileged software execution) from SPSR
```
msreq   spsr_c, r12 
```
Branch and exchange instruction set
Target address is contained in r14
```
bx      r14 
```

It is important to issue FSYS_SwitchToUserMode() after the privileged mode is no longer needed. Otherwise the system would stay in privileged mode.

The datatype of the return value has to be reevaluated when changing platform and compiler.

Returns: return value is zero if caller was in user mode (type: long)

Definition at line 81 of file test_spi.c.

◆ setUp()

void setUp ( void )

Definition at line 283 of file test_spi.c.

◆ tearDown()

void tearDown ( void )

Definition at line 288 of file test_spi.c.

◆ testSPI_CheckInterfaceAvailable()

void testSPI_CheckInterfaceAvailable ( void )

test all return codes from HAL with SPI_CheckInterfaceAvailable

Definition at line 487 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_CheckInterfaceAvailableInvalidInput()

void testSPI_CheckInterfaceAvailableInvalidInput ( void )

test invalid input to SPI_CheckInterfaceAvailable

Definition at line 482 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_GetChipSelectPin()

void testSPI_GetChipSelectPin ( void )

Testing static function SPI_GetChipSelectPin.

The following cases need to be tested:

Argument validation:
- AT1/2: invalid chip select type -> assert
- AT2/2: invalid chip select pin number -> assert
Routine validation:
- RT1/2: software chip select pin in the valid range is verbatim piped through the function
- RT1/2: hardware chip select pin in the valid range is mapped to the correct value

Definition at line 335 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_GetHardwareChipSelectPin()

void testSPI_GetHardwareChipSelectPin ( void )

Testing static function SPI_GetHardwareChipSelectPin.

The following cases need to be tested:

Argument validation:
- AT1/1: invalid pin number -> assert
Routine validation:
- RT1/1: check that only valid hardware chip select configurations are returned

Definition at line 373 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_GetSpiIndex()

void testSPI_GetSpiIndex ( void )

Testing extern function SPI_GetSpiIndex.

The following cases need to be tested:

Argument validation:
- AT1/1: NULL_PTR for pNode -> assert
Routine validation:
- RT1/2: check that the correct SPI index is returned
- RT2/2: provide an invalid SPI register -> assert

Definition at line 507 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_InitializeChipSelects()

void testSPI_InitializeChipSelects ( void )

Testing static function SPI_InitializeChipSelects.

The following cases need to be tested:

Argument validation:
- none (void function)
Routine validation:
- RT1/1: software chip select pin in the valid range is verbatim piped through the function

Definition at line 301 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalNullPointer()

void testSPI_SetFunctionalNullPointer ( void )

simple API test that function guards against null pointer

Definition at line 404 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalRightApiSpi1()

void testSPI_SetFunctionalRightApiSpi1 ( void )

test usage of right API functions for SPI1

Definition at line 437 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalRightApiSpi2()

void testSPI_SetFunctionalRightApiSpi2 ( void )

test usage of right API functions for SPI2

Definition at line 446 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalRightApiSpi3()

void testSPI_SetFunctionalRightApiSpi3 ( void )

test usage of right API functions for SPI3

Definition at line 455 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalRightApiSpi4()

void testSPI_SetFunctionalRightApiSpi4 ( void )

test usage of right API functions for SPI4

Definition at line 464 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalRightApiSpi5()

void testSPI_SetFunctionalRightApiSpi5 ( void )

test usage of right API functions for SPI5

Definition at line 473 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalTestIntendedFunctionClear()

void testSPI_SetFunctionalTestIntendedFunctionClear ( void )

test intended function of SPI_SetFunctional() for clearing a bit

fake a config register that is UINT32_MAX and inject into function

Definition at line 423 of file test_spi.c.

Here is the call graph for this function:

◆ testSPI_SetFunctionalTestIntendedFunctionSet()

void testSPI_SetFunctionalTestIntendedFunctionSet ( void )

test intended function of SPI_SetFunctional() for setting a bit

fake a config register that is null and inject into function

Definition at line 409 of file test_spi.c.

Here is the call graph for this function:

Variable Documentation

◆ dma_spiDmaChannels

DMA_CHANNEL_CONFIG_s dma_spiDmaChannels[DMA_NUMBER_SPI_INTERFACES]

Initial value:

= {
    {DMA_CH0, DMA_CH1}, 
    {DMA_CH2, DMA_CH3}, 
    {DMA_CH4, DMA_CH5}, 
    {DMA_CH6, DMA_CH7}, 
    {DMA_CH8, DMA_CH9}, 
}

DMA channel configuration for SPI communication

Definition at line 95 of file test_spi.c.

◆ dma_spiInterfaces

spiBASE_t* dma_spiInterfaces[DMA_NUMBER_SPI_INTERFACES]

Initial value:

= {
    spiREG1, 
    spiREG2, 
    spiREG3, 
    spiREG4, 
    spiREG5, 
}

SPI enumeration for DMA

Definition at line 86 of file test_spi.c.

◆ spi_adiInterface

SPI_INTERFACE_CONFIG_s spi_adiInterface[BS_NR_OF_STRINGS]

Initial value:

= {
    {
        .pConfig  = &spi_kAdiDataConfig[0u],
        .pNode    = spiREG1,
        .pGioPort = &(spiREG1->PC3),
        .csPin    = 1u,
        .csType   = SPI_CHIP_SELECT_HARDWARE,
    },
}

SPI interface configuration for ADI communication This is a list of structs because of multi string

Definition at line 184 of file test_spi.c.

◆ spi_busyFlags

SPI_BUSY_STATE_e spi_busyFlags[]

Initial value:

= {
    SPI_IDLE,
    SPI_IDLE,
    SPI_IDLE,
    SPI_IDLE,
    SPI_IDLE,
}

struct containing the lock state of the SPI interfaces

Definition at line 267 of file test_spi.c.

◆ spi_framInterface

SPI_INTERFACE_CONFIG_s spi_framInterface

Initial value:

= {
    .pConfig  = &spi_kFramDataConfig,
    .pNode    = spiREG3,
    .pGioPort = &(spiREG3->PC3),
    .csPin    = 1u,
    .csType   = SPI_CHIP_SELECT_SOFTWARE,
}

SPI interface configuration for FRAM communication

Definition at line 240 of file test_spi.c.

◆ spi_kAdiDataConfig

spiDAT1_t spi_kAdiDataConfig[BS_NR_OF_STRINGS]

static

Initial value:

= {
    {                      
     .CS_HOLD = TRUE,      
     .WDEL    = FALSE,     
     .DFSEL   = SPI_FMT_0, 
     
     .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL},
}

SPI data configuration struct for ADI communication

Definition at line 104 of file test_spi.c.

◆ spi_kFramDataConfig

spiDAT1_t spi_kFramDataConfig

static

Initial value:

= {
    
    .CS_HOLD = TRUE,      
    .WDEL    = TRUE,      
    .DFSEL   = SPI_FMT_1, 
    
    .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL,
}

SPI data configuration struct for FRAM communication

Definition at line 151 of file test_spi.c.

◆ spi_kLtcDataConfig

spiDAT1_t spi_kLtcDataConfig[BS_NR_OF_STRINGS]

static

Initial value:

= {
    {                      
     .CS_HOLD = TRUE,      
     .WDEL    = FALSE,     
     .DFSEL   = SPI_FMT_0, 
     
     .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL},
}

SPI data configuration struct for LTC communication

Definition at line 114 of file test_spi.c.

◆ spi_kMxmDataConfig

spiDAT1_t spi_kMxmDataConfig

static

Initial value:

= {
    .CS_HOLD = TRUE,      
    .WDEL    = TRUE,      
    .DFSEL   = SPI_FMT_1, 
    
    .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL,
}

SPI data configuration struct for MXM communication

Definition at line 124 of file test_spi.c.

◆ spi_kNxp775DataConfigRx

spiDAT1_t spi_kNxp775DataConfigRx[BS_NR_OF_STRINGS]

static

Initial value:

= {
    {.CS_HOLD = TRUE,      
     .WDEL    = TRUE,      
     .DFSEL   = SPI_FMT_2, 
     
     .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL},
}

SPI data configuration struct for NXP MC33775A communication, Rx part

Definition at line 142 of file test_spi.c.

◆ spi_kNxp775DataConfigTx

spiDAT1_t spi_kNxp775DataConfigTx[BS_NR_OF_STRINGS]

static

Initial value:

= {
    {.CS_HOLD = TRUE,      
     .WDEL    = TRUE,      
     .DFSEL   = SPI_FMT_2, 
     
     .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL},
}

SPI data configuration struct for NXP MC33775A communication, Tx part

Definition at line 133 of file test_spi.c.

◆ spi_kSbcDataConfig

spiDAT1_t spi_kSbcDataConfig

static

Initial value:

= {
    
    .CS_HOLD = TRUE,      
    .WDEL    = TRUE,      
    .DFSEL   = SPI_FMT_0, 
    
    .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL,
}

SPI configuration struct for SBC communication

Definition at line 171 of file test_spi.c.

◆ spi_kSpsDataConfigLowSpeed

spiDAT1_t spi_kSpsDataConfigLowSpeed

static

Initial value:

= {
    
    .CS_HOLD = TRUE,      
    .WDEL    = TRUE,      
    .DFSEL   = SPI_FMT_1, 
    
    .CSNR = SPI_HARDWARE_CHIP_SELECT_DISABLE_ALL,
}

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

Definition at line 161 of file test_spi.c.

◆ spi_ltcInterface

SPI_INTERFACE_CONFIG_s spi_ltcInterface[BS_NR_OF_STRINGS]

Initial value:

= {
    {
        .pConfig  = &spi_kLtcDataConfig[0u],
        .pNode    = spiREG1,
        .pGioPort = &(spiREG1->PC3),
        .csPin    = 1u,
        .csType   = SPI_CHIP_SELECT_HARDWARE,
    },
}

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

Definition at line 198 of file test_spi.c.

◆ spi_mxmInterface

SPI_INTERFACE_CONFIG_s spi_mxmInterface

Initial value:

= {
    .pConfig  = &spi_kMxmDataConfig,
    .pNode    = spiREG4,
    .pGioPort = &(spiREG4->PC3),
    .csPin    = 0u,
    .csType   = SPI_CHIP_SELECT_HARDWARE,
}

SPI interface configuration for MXM communication

Definition at line 209 of file test_spi.c.

◆ spi_nrBusyFlags

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

size of spi_busyFlags

Definition at line 275 of file test_spi.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,
        .csType   = SPI_CHIP_SELECT_HARDWARE,
    },
}

SPI interface configuration for N775 communication, Rx part

Definition at line 229 of file test_spi.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,
        .csType   = SPI_CHIP_SELECT_HARDWARE,
    },
}

SPI interface configuration for N775 communication Tx part

Definition at line 218 of file test_spi.c.

◆ spi_sbcMcuInterface

SPI_INTERFACE_CONFIG_s spi_sbcMcuInterface

Initial value:

= {
    .pConfig  = &spi_kSbcDataConfig,
    .pNode    = spiREG2,
    .pGioPort = &(spiREG2->PC3),
    .csPin    = 0u,
    .csType   = SPI_CHIP_SELECT_HARDWARE,
}

SPI interface configuration for SBC communication

Definition at line 258 of file test_spi.c.

◆ spi_spsInterface

SPI_INTERFACE_CONFIG_s spi_spsInterface

Initial value:

= {
    .pConfig  = &spi_kSpsDataConfigLowSpeed,
    .pNode    = spiREG2,
    .pGioPort = &SPI_SPS_CS_GIOPORT,
    .csPin    = SPI_SPS_CS_PIN,
    .csType   = SPI_CHIP_SELECT_SOFTWARE,
}

SPI interface configuration for SPS communication

Definition at line 249 of file test_spi.c.

◆ spiMockConfigRegister

spi_config_reg_t spiMockConfigRegister = {0}

Definition at line 280 of file test_spi.c.

◆ spiMockHandle

spiBASE_t spiMockHandle = {0}

mock for testing with an SPI handle

Definition at line 278 of file test_spi.c.

Functions

Variables

Detailed Description

Function Documentation

◆ FSYS_RaisePrivilege()

◆ setUp()

◆ tearDown()

◆ testSPI_CheckInterfaceAvailable()

◆ testSPI_CheckInterfaceAvailableInvalidInput()

◆ testSPI_GetChipSelectPin()

◆ testSPI_GetHardwareChipSelectPin()

◆ testSPI_GetSpiIndex()

◆ testSPI_InitializeChipSelects()

◆ testSPI_SetFunctionalNullPointer()

◆ testSPI_SetFunctionalRightApiSpi1()

◆ testSPI_SetFunctionalRightApiSpi2()

◆ testSPI_SetFunctionalRightApiSpi3()

◆ testSPI_SetFunctionalRightApiSpi4()

◆ testSPI_SetFunctionalRightApiSpi5()

◆ testSPI_SetFunctionalTestIntendedFunctionClear()

◆ testSPI_SetFunctionalTestIntendedFunctionSet()

Variable Documentation

◆ dma_spiDmaChannels

◆ dma_spiInterfaces

◆ spi_adiInterface

◆ spi_busyFlags

◆ spi_framInterface

◆ spi_kAdiDataConfig

◆ spi_kFramDataConfig

◆ spi_kLtcDataConfig

◆ spi_kMxmDataConfig

◆ spi_kNxp775DataConfigRx

◆ spi_kNxp775DataConfigTx

◆ spi_kSbcDataConfig

◆ spi_kSpsDataConfigLowSpeed

◆ spi_ltcInterface

◆ spi_mxmInterface

◆ spi_nrBusyFlags

◆ spi_nxp775InterfaceRx

◆ spi_nxp775InterfaceTx

◆ spi_sbcMcuInterface

◆ spi_spsInterface

◆ spiMockConfigRegister

◆ spiMockHandle