foxBMS - Unit Tests  1.6.0
The foxBMS Unit Tests API Documentation
test_can_1.c File Reference

Tests for the configuration validation functions and counter reset calculation in the the CAN driver. More...

#include "unity.h"
#include "MockHL_can.h"
#include "Mockcan_cfg.h"
#include "Mockdatabase.h"
#include "Mockdiag.h"
#include "Mockfoxmath.h"
#include "Mockftask.h"
#include "Mockimd.h"
#include "Mockio.h"
#include "Mockmcu.h"
#include "Mockos.h"
#include "Mockpex.h"
#include "Mockqueue.h"
#include "Mocktest_can_mpu_prototype_queue_create_stub.h"
#include "version_cfg.h"
#include "can.h"
#include "test_assert_helper.h"
#include <stdbool.h>
#include <stdint.h>
Include dependency graph for test_can_1.c:

Go to the source code of this file.

Macros

#define CANRX_NOT_PERIODIC   (0u)
 
#define TEST_CANTX_ID_DUMMY   (0x001)
 
#define TEST_CANTX_DUMMY_PERIOD_ms   (51u) /* Period must be divisible by CAN Tick */
 
#define TEST_CANTX_DUMMY_PHASE_ms   (11u) /* Phase must be divisible by CAN Tick */
 
#define TEST_CANTX_DUMMY_MESSAGE
 
#define TEST_CANTX_DUMMY_PERIOD_2_ms   (30)
 
#define TEST_CANTX_DUMMY_PHASE_2_ms   (0)
 
#define TEST_CANTX_DUMMY_MESSAGE_2
 
#define TEST_CANTX_DUMMY_PERIOD_3_ms   (70)
 
#define TEST_CANTX_DUMMY_PHASE_3_ms   (0)
 
#define TEST_CANTX_DUMMY_MESSAGE_3
 
#define TEST_CANRX_ID_DUMMY   (0x002)
 
#define TEST_CANRX_DUMMY_MESSAGE
 

Functions

static uint32_t TEST_CANTX_DummyCallback (CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
 
static uint32_t TEST_CANRX_DummyCallback (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 
void setUp (void)
 
void tearDown (void)
 
void testCAN_ValidateConfiguredTxMessagePeriod (void)
 
void testCAN_ValidateConfiguredTxMessagePhase (void)
 
void testCAN_CalculateCounterResetValue (void)
 

Variables

const CAN_NODE_s can_node1
 
const CAN_NODE_s can_node2Isolated
 
static DATA_BLOCK_CELL_VOLTAGE_s can_tableCellVoltages = {.header.uniqueId = DATA_BLOCK_ID_CELL_VOLTAGE}
 
static DATA_BLOCK_CELL_TEMPERATURE_s can_tableTemperatures = {.header.uniqueId = DATA_BLOCK_ID_CELL_TEMPERATURE}
 
static DATA_BLOCK_MIN_MAX_s can_tableMinimumMaximumValues = {.header.uniqueId = DATA_BLOCK_ID_MIN_MAX}
 
static DATA_BLOCK_CURRENT_SENSOR_s can_tableCurrentSensor = {.header.uniqueId = DATA_BLOCK_ID_CURRENT_SENSOR}
 
static DATA_BLOCK_OPEN_WIRE_s can_tableOpenWire = {.header.uniqueId = DATA_BLOCK_ID_OPEN_WIRE_BASE}
 
static DATA_BLOCK_STATE_REQUEST_s can_tableStateRequest = {.header.uniqueId = DATA_BLOCK_ID_STATE_REQUEST}
 
OS_QUEUE imd_canDataQueue = NULL_PTR
 
const CAN_SHIM_s can_kShim
 
const CAN_TX_MESSAGE_TYPE_s can_txMessages []
 
const CAN_RX_MESSAGE_TYPE_s can_rxMessages []
 
const uint8_t can_txMessagesLength = sizeof(can_txMessages) / sizeof(can_txMessages[0])
 
const uint8_t can_rxMessagesLength = sizeof(can_rxMessages) / sizeof(can_rxMessages[0])
 
CAN_STATE_scanTestState = NULL_PTR
 
OS_QUEUE ftsk_dataQueue = NULL_PTR
 
OS_QUEUE ftsk_imdCanDataQueue = NULL_PTR
 
OS_QUEUE ftsk_canRxQueue = NULL_PTR
 
OS_QUEUE ftsk_canTxUnsentMessagesQueue = NULL_PTR
 
volatile bool ftsk_allQueuesCreated = false
 

Detailed Description

Tests for the configuration validation functions and counter reset calculation in the the CAN driver.

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
2023-03-13 (date of creation)
Updated
2023-10-12 (date of last update)
Version
v1.6.0
Prefix
TEST

This file implements the test of the validation functions for tx message configuration with the first invalid configuration of message period and phase in dummy message 1. Both functions are tested to assert an error with invalid configuration. Also the test for the CAN_CalculateCounterResetValue function is implemented here. It is tested to calculate the correct value for the given dummy messages.

Definition in file test_can_1.c.

Macro Definition Documentation

◆ CANRX_NOT_PERIODIC

#define CANRX_NOT_PERIODIC   (0u)

Definition at line 104 of file test_can_1.c.

◆ TEST_CANRX_DUMMY_MESSAGE

#define TEST_CANRX_DUMMY_MESSAGE
Value:
{ \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CAN_LITTLE_ENDIAN, \
}, \
{ \
.period = CANRX_NOT_PERIODIC \
}
@ CAN_LITTLE_ENDIAN
Definition: can_cfg.h:157
#define CAN_DEFAULT_DLC
Definition: can_cfg.h:103
@ CAN_STANDARD_IDENTIFIER_11_BIT
Definition: can_cfg.h:163
#define CANRX_NOT_PERIODIC
Definition: test_can_1.c:104
#define TEST_CANRX_ID_DUMMY
Definition: test_can_1.c:151

Definition at line 153 of file test_can_1.c.

◆ TEST_CANRX_ID_DUMMY

#define TEST_CANRX_ID_DUMMY   (0x002)

Definition at line 151 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_MESSAGE

#define TEST_CANTX_DUMMY_MESSAGE
Value:
{ \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CAN_LITTLE_ENDIAN, \
}, \
{ \
}
#define TEST_CANTX_ID_DUMMY
Definition: test_can_1.c:107
#define TEST_CANTX_DUMMY_PERIOD_ms
Definition: test_can_1.c:108
#define TEST_CANTX_DUMMY_PHASE_ms
Definition: test_can_1.c:109

Definition at line 111 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_MESSAGE_2

#define TEST_CANTX_DUMMY_MESSAGE_2
Value:
{ \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CAN_LITTLE_ENDIAN, \
}, \
{ \
}
#define TEST_CANTX_DUMMY_PHASE_2_ms
Definition: test_can_1.c:123
#define TEST_CANTX_DUMMY_PERIOD_2_ms
Definition: test_can_1.c:122

Definition at line 125 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_MESSAGE_3

#define TEST_CANTX_DUMMY_MESSAGE_3
Value:
{ \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CAN_LITTLE_ENDIAN, \
}, \
{ \
}
#define TEST_CANTX_DUMMY_PERIOD_3_ms
Definition: test_can_1.c:136
#define TEST_CANTX_DUMMY_PHASE_3_ms
Definition: test_can_1.c:137

Definition at line 139 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_PERIOD_2_ms

#define TEST_CANTX_DUMMY_PERIOD_2_ms   (30)

Definition at line 122 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_PERIOD_3_ms

#define TEST_CANTX_DUMMY_PERIOD_3_ms   (70)

Definition at line 136 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_PERIOD_ms

#define TEST_CANTX_DUMMY_PERIOD_ms   (51u) /* Period must be divisible by CAN Tick */

Definition at line 108 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_PHASE_2_ms

#define TEST_CANTX_DUMMY_PHASE_2_ms   (0)

Definition at line 123 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_PHASE_3_ms

#define TEST_CANTX_DUMMY_PHASE_3_ms   (0)

Definition at line 137 of file test_can_1.c.

◆ TEST_CANTX_DUMMY_PHASE_ms

#define TEST_CANTX_DUMMY_PHASE_ms   (11u) /* Phase must be divisible by CAN Tick */

Definition at line 109 of file test_can_1.c.

◆ TEST_CANTX_ID_DUMMY

#define TEST_CANTX_ID_DUMMY   (0x001)

Definition at line 107 of file test_can_1.c.

Function Documentation

◆ setUp()

void setUp ( void  )

Definition at line 228 of file test_can_1.c.

◆ tearDown()

void tearDown ( void  )

Definition at line 231 of file test_can_1.c.

◆ TEST_CANRX_DummyCallback()

static uint32_t TEST_CANRX_DummyCallback ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)
static

Definition at line 199 of file test_can_1.c.

◆ TEST_CANTX_DummyCallback()

static uint32_t TEST_CANTX_DummyCallback ( CAN_MESSAGE_PROPERTIES_s  message,
uint8_t *  pCanData,
uint8_t *  pMuxId,
const CAN_SHIM_s *const  kpkCanShim 
)
static

Definition at line 191 of file test_can_1.c.

◆ testCAN_CalculateCounterResetValue()

void testCAN_CalculateCounterResetValue ( void  )

Definition at line 244 of file test_can_1.c.

Here is the call graph for this function:

◆ testCAN_ValidateConfiguredTxMessagePeriod()

void testCAN_ValidateConfiguredTxMessagePeriod ( void  )

Definition at line 236 of file test_can_1.c.

Here is the call graph for this function:

◆ testCAN_ValidateConfiguredTxMessagePhase()

void testCAN_ValidateConfiguredTxMessagePhase ( void  )

Definition at line 240 of file test_can_1.c.

Here is the call graph for this function:

Variable Documentation

◆ can_kShim

const CAN_SHIM_s can_kShim
Initial value:
= {
.pQueueImd = &imd_canDataQueue,
.pTableCellVoltage = &can_tableCellVoltages,
.pTableCellTemperature = &can_tableTemperatures,
.pTableCurrentSensor = &can_tableCurrentSensor,
.pTableOpenWire = &can_tableOpenWire,
.pTableStateRequest = &can_tableStateRequest,
}
static DATA_BLOCK_CELL_VOLTAGE_s can_tableCellVoltages
Definition: test_can_1.c:172
static DATA_BLOCK_MIN_MAX_s can_tableMinimumMaximumValues
Definition: test_can_1.c:174
static DATA_BLOCK_OPEN_WIRE_s can_tableOpenWire
Definition: test_can_1.c:176
static DATA_BLOCK_CELL_TEMPERATURE_s can_tableTemperatures
Definition: test_can_1.c:173
static DATA_BLOCK_STATE_REQUEST_s can_tableStateRequest
Definition: test_can_1.c:177
static DATA_BLOCK_CURRENT_SENSOR_s can_tableCurrentSensor
Definition: test_can_1.c:175
OS_QUEUE imd_canDataQueue
Definition: test_can_1.c:179

variable for storing and passing on the local database table handles

Definition at line 181 of file test_can_1.c.

◆ can_node1

const CAN_NODE_s can_node1
Initial value:
= {
.canNodeRegister = canREG1,
}

CAN node configurations for CAN1 and CAN2 (isolated)

Definition at line 164 of file test_can_1.c.

◆ can_node2Isolated

const CAN_NODE_s can_node2Isolated
Initial value:
= {
.canNodeRegister = canREG2,
}

Definition at line 168 of file test_can_1.c.

◆ can_rxMessages

const CAN_RX_MESSAGE_TYPE_s can_rxMessages[]
Initial value:
= {
}
#define CAN_NODE_1
Definition: can_cfg.h:80
#define TEST_CANRX_DUMMY_MESSAGE
Definition: test_can_1.c:153
static uint32_t TEST_CANRX_DummyCallback(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
Definition: test_can_1.c:199

registry of CAN RX messages

Definition at line 212 of file test_can_1.c.

◆ can_rxMessagesLength

const uint8_t can_rxMessagesLength = sizeof(can_rxMessages) / sizeof(can_rxMessages[0])

length of CAN message arrays

Definition at line 217 of file test_can_1.c.

◆ can_tableCellVoltages

DATA_BLOCK_CELL_VOLTAGE_s can_tableCellVoltages = {.header.uniqueId = DATA_BLOCK_ID_CELL_VOLTAGE}
static

Definition at line 172 of file test_can_1.c.

◆ can_tableCurrentSensor

DATA_BLOCK_CURRENT_SENSOR_s can_tableCurrentSensor = {.header.uniqueId = DATA_BLOCK_ID_CURRENT_SENSOR}
static

Definition at line 175 of file test_can_1.c.

◆ can_tableMinimumMaximumValues

DATA_BLOCK_MIN_MAX_s can_tableMinimumMaximumValues = {.header.uniqueId = DATA_BLOCK_ID_MIN_MAX}
static

Definition at line 174 of file test_can_1.c.

◆ can_tableOpenWire

DATA_BLOCK_OPEN_WIRE_s can_tableOpenWire = {.header.uniqueId = DATA_BLOCK_ID_OPEN_WIRE_BASE}
static

Definition at line 176 of file test_can_1.c.

◆ can_tableStateRequest

DATA_BLOCK_STATE_REQUEST_s can_tableStateRequest = {.header.uniqueId = DATA_BLOCK_ID_STATE_REQUEST}
static

Definition at line 177 of file test_can_1.c.

◆ can_tableTemperatures

DATA_BLOCK_CELL_TEMPERATURE_s can_tableTemperatures = {.header.uniqueId = DATA_BLOCK_ID_CELL_TEMPERATURE}
static

Definition at line 173 of file test_can_1.c.

◆ can_txMessages

const CAN_TX_MESSAGE_TYPE_s can_txMessages[]
Initial value:
= {
}
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:77
#define TEST_CANTX_DUMMY_MESSAGE_2
Definition: test_can_1.c:125
#define TEST_CANTX_DUMMY_MESSAGE_3
Definition: test_can_1.c:139
static uint32_t TEST_CANTX_DummyCallback(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
Definition: test_can_1.c:191
#define TEST_CANTX_DUMMY_MESSAGE
Definition: test_can_1.c:111

CAN RX and TX message configuration structs

registry of CAN TX messages

Definition at line 206 of file test_can_1.c.

◆ can_txMessagesLength

const uint8_t can_txMessagesLength = sizeof(can_txMessages) / sizeof(can_txMessages[0])

array length for transmission CAN0 message definition

length of CAN message arrays

Definition at line 216 of file test_can_1.c.

◆ canTestState

CAN_STATE_s* canTestState = NULL_PTR

Definition at line 219 of file test_can_1.c.

◆ ftsk_allQueuesCreated

volatile bool ftsk_allQueuesCreated = false

indicator whether the queues have successfully been initialized to be used in other parts of the software

Definition at line 225 of file test_can_1.c.

◆ ftsk_canRxQueue

OS_QUEUE ftsk_canRxQueue = NULL_PTR

CAN driver data queue for RX messages

Definition at line 223 of file test_can_1.c.

◆ ftsk_canTxUnsentMessagesQueue

OS_QUEUE ftsk_canTxUnsentMessagesQueue = NULL_PTR

CAN driver data queue for unsent TX messages

Definition at line 224 of file test_can_1.c.

◆ ftsk_dataQueue

OS_QUEUE ftsk_dataQueue = NULL_PTR

Definition at line 221 of file test_can_1.c.

◆ ftsk_imdCanDataQueue

OS_QUEUE ftsk_imdCanDataQueue = NULL_PTR

queue for CAN based IMD devices

Definition at line 222 of file test_can_1.c.

◆ imd_canDataQueue

OS_QUEUE imd_canDataQueue = NULL_PTR

Definition at line 179 of file test_can_1.c.