foxBMS - Unit Tests
1.3.0
The foxBMS Unit Tests API Documentation
|
Database module implementation. More...
Go to the source code of this file.
Data Structures | |
struct | DATA_BASE_HEADER_s |
Macros | |
#define | DATA_MAX_QUEUE_TIMEOUT_MS (10u) |
#define | DATA_QUEUE_TIMEOUT_MS (DATA_MAX_QUEUE_TIMEOUT_MS / OS_TICK_RATE_MS) |
Functions | |
f_static_assert (DATA_QUEUE_TIMEOUT_MS > 0u, "invalid database queue timeout!") | |
static void | DATA_IterateOverDatabaseEntries (const DATA_QUEUE_MESSAGE_s *kpReceiveMessage) |
static STD_RETURN_TYPE_e | DATA_AccessDatabaseEntries (DATA_BLOCK_ACCESS_TYPE_e accessType, void *pData0, void *pData1, void *pData2, void *pData3) |
static void | DATA_CopyData (DATA_BLOCK_ACCESS_TYPE_e accessType, uint32_t dataLength, void *pDatabaseStruct, void *pPassedDataStruct) |
STD_RETURN_TYPE_e | DATA_Initialize (void) |
Initialization of database manager. More... | |
void | DATA_Task (void) |
trigger of database manager More... | |
void | DATA_DummyFunction (void) |
Dummy void function of the database module. More... | |
STD_RETURN_TYPE_e | DATA_Read1DataBlock (void *pDataToReceiver0) |
Reads one data block in database by value. More... | |
STD_RETURN_TYPE_e | DATA_Read2DataBlocks (void *pDataToReceiver0, void *pDataToReceiver1) |
Reads two data blocks in database by value. More... | |
STD_RETURN_TYPE_e | DATA_Read3DataBlocks (void *pDataToReceiver0, void *pDataToReceiver1, void *pDataToReceiver2) |
Reads three data blocks in database by value. More... | |
STD_RETURN_TYPE_e | DATA_Read4DataBlocks (void *pDataToReceiver0, void *pDataToReceiver1, void *pDataToReceiver2, void *pDataToReceiver3) |
Reads four data blocks in database by value. More... | |
STD_RETURN_TYPE_e | DATA_Write1DataBlock (void *pDataFromSender0) |
Stores one data block in database. More... | |
STD_RETURN_TYPE_e | DATA_Write2DataBlocks (void *pDataFromSender0, void *pDataFromSender1) |
Stores two data blocks in database. More... | |
STD_RETURN_TYPE_e | DATA_Write3DataBlocks (void *pDataFromSender0, void *pDataFromSender1, void *pDataFromSender2) |
Stores three data blocks in database. More... | |
STD_RETURN_TYPE_e | DATA_Write4DataBlocks (void *pDataFromSender0, void *pDataFromSender1, void *pDataFromSender2, void *pDataFromSender3) |
Stores four data blocks in database. More... | |
void | DATA_ExecuteDataBist (void) |
Executes a built-in self-test for the database module. More... | |
Variables | |
static const DATA_BASE_HEADER_s | data_baseHeader |
device configuration of database More... | |
static uint8_t | data_uniqueIdToDatabaseEntry [DATA_BLOCK_ID_MAX] = {0} |
uniqueId to respective database entry selector More... | |
Database module implementation.
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:
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:
The database read/write functions put references to the database entries to be read/written in the database queue. The function DATA_Task() reads the queue to get the database entries to be read/written. Up to DATA_MAX_ENTRIES_PER_ACCESS entries can be read/written with the same function call. To avoid code duplication, the functions to read/write 1 to DATA_MAX_ENTRIES_PER_ACCESS-1 entries call the function to read/write DATA_MAX_ENTRIES_PER_ACCESS entries and use NULL_PTR for the entries that are not to be read/written. DATA_Task() checks that the first entry is not a NULL_PTR and asserts if it is not the case. If subsequent entries are found in the database queue, they are simply ignored if they are NULL_PTR.
Definition in file database.c.
#define DATA_MAX_QUEUE_TIMEOUT_MS (10u) |
Maximum queue timeout time in milliseconds
Definition at line 77 of file database.c.
#define DATA_QUEUE_TIMEOUT_MS (DATA_MAX_QUEUE_TIMEOUT_MS / OS_TICK_RATE_MS) |
Definition at line 79 of file database.c.
|
static |
|
static |
void DATA_DummyFunction | ( | void | ) |
Dummy void function of the database module.
This function is needed in the database module in order to implement the DATA_READ_DATA() and DATA_WRITE_DATA() in a ISO C99 standard compatible way. The invocation of a macro that accepts a variable number of arguments (and this is the case for DATA_READ_DATA() and DATA_WRITE_DATA()) needs more arguments in the invocation than there are parameters in the macro definition. For the most simple case, that DATA_READ_DATA() and DATA_WRITE_DATA() are only called with one argument, a violation of the standard would appear if the DATA_DummyFunction() would be omitted: GET_MACRO(databaseVariable, DATA_Read4DataBlocks, DATA_Read3DataBlocks, DATA_Read2DataBlocks, DATA_Read2DataBlocks, DATA_Read1DataBlock)(databaseVariable) So the macro invocation has six parameters, but it needs seven and an ISO C99 violation would appear. Adding the DATA_DummyFunction() fixes this violation. For details see 6.10.3 (paragraph 4) of the ISO C99 standard.
Definition at line 293 of file database.c.
void DATA_ExecuteDataBist | ( | void | ) |
Executes a built-in self-test for the database module.
This test writes and reads a database entry in order to check that the database module is working as expected. If the test fails, it will fail an assertion.
Definition at line 359 of file database.c.
STD_RETURN_TYPE_e DATA_Initialize | ( | void | ) |
Initialization of database manager.
Definition at line 226 of file database.c.
|
static |
STD_RETURN_TYPE_e DATA_Read1DataBlock | ( | void * | pDataToReceiver0 | ) |
Reads one data block in database by value.
This function reads data from database and copy this content in passed struct
[out] | pDataToReceiver0 | (type: void *) |
Definition at line 296 of file database.c.
STD_RETURN_TYPE_e DATA_Read2DataBlocks | ( | void * | pDataToReceiver0, |
void * | pDataToReceiver1 | ||
) |
Reads two data blocks in database by value.
This function reads data from database and copy this content in passed struct
[out] | pDataToReceiver0 | (type: void *) |
[out] | pDataToReceiver1 | (type: void *) |
Definition at line 301 of file database.c.
STD_RETURN_TYPE_e DATA_Read3DataBlocks | ( | void * | pDataToReceiver0, |
void * | pDataToReceiver1, | ||
void * | pDataToReceiver2 | ||
) |
Reads three data blocks in database by value.
This function reads data from database and copy this content in passed struct
[out] | pDataToReceiver0 | (type: void *) |
[out] | pDataToReceiver1 | (type: void *) |
[out] | pDataToReceiver2 | (type: void *) |
Definition at line 307 of file database.c.
STD_RETURN_TYPE_e DATA_Read4DataBlocks | ( | void * | pDataToReceiver0, |
void * | pDataToReceiver1, | ||
void * | pDataToReceiver2, | ||
void * | pDataToReceiver3 | ||
) |
Reads four data blocks in database by value.
This function reads data from database and copy this content in passed struct
[out] | pDataToReceiver0 | (type: void *) |
[out] | pDataToReceiver1 | (type: void *) |
[out] | pDataToReceiver2 | (type: void *) |
[out] | pDataToReceiver3 | (type: void *) |
Definition at line 314 of file database.c.
void DATA_Task | ( | void | ) |
trigger of database manager
TODO
Definition at line 276 of file database.c.
STD_RETURN_TYPE_e DATA_Write1DataBlock | ( | void * | pDataFromSender0 | ) |
Stores one data block in database.
This function stores passed data in database and updates timestamp and previous timestamp in passed struct
[in,out] | pDataFromSender0 | (type: void *) |
Definition at line 327 of file database.c.
STD_RETURN_TYPE_e DATA_Write2DataBlocks | ( | void * | pDataFromSender0, |
void * | pDataFromSender1 | ||
) |
Stores two data blocks in database.
This function stores passed data in database and updates timestamp and previous timestamp in passed struct
[in,out] | pDataFromSender0 | (type: void *) |
[in,out] | pDataFromSender1 | (type: void *) |
Definition at line 332 of file database.c.
STD_RETURN_TYPE_e DATA_Write3DataBlocks | ( | void * | pDataFromSender0, |
void * | pDataFromSender1, | ||
void * | pDataFromSender2 | ||
) |
Stores three data blocks in database.
This function stores passed data in database and updates timestamp and previous timestamp in passed struct
[in,out] | pDataFromSender0 | (type: void *) |
[in,out] | pDataFromSender1 | (type: void *) |
[in,out] | pDataFromSender2 | (type: void *) |
Definition at line 338 of file database.c.
STD_RETURN_TYPE_e DATA_Write4DataBlocks | ( | void * | pDataFromSender0, |
void * | pDataFromSender1, | ||
void * | pDataFromSender2, | ||
void * | pDataFromSender3 | ||
) |
Stores four data blocks in database.
This function stores passed data in database and updates timestamp and previous timestamp in passed struct
[in,out] | pDataFromSender0 | (type: void *) |
[in,out] | pDataFromSender1 | (type: void *) |
[in,out] | pDataFromSender2 | (type: void *) |
[in,out] | pDataFromSender3 | (type: void *) |
Definition at line 346 of file database.c.
f_static_assert | ( | DATA_QUEUE_TIMEOUT_MS | , |
0u | , | ||
"invalid database queue timeout!" | |||
) |
|
static |
device configuration of database
all attributes of device configuration are listed here (pointer to channel list, number of channels)
Definition at line 96 of file database.c.
|
static |
uniqueId to respective database entry selector
This array is the link between the uniqueId of a database entry and the actual position of the database entry in data_database[]. The IDs are set to its final value, when Data_Initialize is called.
Definition at line 107 of file database.c.