foxBMS - Unit Tests  1.4.1
The foxBMS Unit Tests API Documentation
test_spi.c File Reference

Tests for the spi module. More...

#include "unity.h"
#include "MockHL_spi.h"
#include "MockHL_sys_dma.h"
#include "Mockio.h"
#include "Mockmcu.h"
#include "Mockos.h"
#include "dma_cfg.h"
#include "spi_cfg.h"
#include "spi.h"
#include "test_assert_helper.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_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)
 

Variables

spiBASE_t spiMockHandle = {0}
 
spi_config_reg_t spiMockConfigRegister = {0}
 

Detailed Description

Tests 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-04-01 (date of creation)
Updated
2022-10-27 (date of last update)
Version
v1.4.1
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_SWITCH_TO_USER_MODE() 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 71 of file test_spi.c.

◆ setUp()

void setUp ( void  )

Definition at line 81 of file test_spi.c.

◆ tearDown()

void tearDown ( void  )

Definition at line 86 of file test_spi.c.

◆ testSPI_CheckInterfaceAvailable()

void testSPI_CheckInterfaceAvailable ( void  )

test all return codes from HAL with SPI_CheckInterfaceAvailable

Definition at line 174 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 169 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 91 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 124 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 133 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 142 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 151 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 160 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 110 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 96 of file test_spi.c.

Here is the call graph for this function:

Variable Documentation

◆ spiMockConfigRegister

spi_config_reg_t spiMockConfigRegister = {0}

Definition at line 78 of file test_spi.c.

◆ spiMockHandle

spiBASE_t spiMockHandle = {0}

mock for testing with an SPI handle

Definition at line 76 of file test_spi.c.