Database module implementation. More...

#include "database.h"
#include <string.h>

Include dependency graph for database.c:

Data Structures
struct	DATA_BASE_HEADER

struct	DATA_QUEUE_MESSAGE

Macros
#define	DATA_QUEUE_TIMEOUT_MS ((TickType_t)10u)

#define	DATA_QUEUE_LENGTH (1u)
	Length of data Queue. More...

#define	DATA_QUEUE_ITEM_SIZE (sizeof(DATA_QUEUE_MESSAGE_s))
	Size of data Queue item. More...

#define	DATA_MAX_ENTRIES_PER_ACCESS (4u)

Typedefs
typedef struct DATA_BASE_HEADER	DATA_BASE_HEADER_s

typedef struct DATA_QUEUE_MESSAGE	DATA_QUEUE_MESSAGE_s

Functions
STD_RETURN_TYPE_e	DATA_Init (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_Read_1_DataBlock (void *pDataToReceiver0)
	Reads a datablock in database by value. More...

STD_RETURN_TYPE_e	DATA_Read_2_DataBlocks (void pDataToReceiver0, void pDataToReceiver1)
	Reads a datablock in database by value. More...

STD_RETURN_TYPE_e	DATA_Read_3_DataBlocks (void pDataToReceiver0, void pDataToReceiver1, void *pDataToReceiver2)
	Reads a datablock in database by value. More...

STD_RETURN_TYPE_e	DATA_Read_4_DataBlocks (void pDataToReceiver0, void pDataToReceiver1, void pDataToReceiver2, void pDataToReceiver3)
	Reads a datablock in database by value. More...

STD_RETURN_TYPE_e	DATA_Write_1_DataBlock (void *pDataFromSender0)
	Stores a datablock in database. More...

STD_RETURN_TYPE_e	DATA_Write_2_DataBlocks (void pDataFromSender0, void pDataFromSender1)
	Stores a datablock in database. More...

STD_RETURN_TYPE_e	DATA_Write_3_DataBlocks (void pDataFromSender0, void pDataFromSender1, void *pDataFromSender2)
	Stores a datablock in database. More...

STD_RETURN_TYPE_e	DATA_Write_4_DataBlocks (void pDataFromSender0, void pDataFromSender1, void pDataFromSender2, void pDataFromSender3)
	Stores a datablock in database. More...

bool	DATA_DatabaseEntryUpdatedAtLeastOnce (void *pDatabaseEntry)
	Checks if passed database entry has been updated at least once. More...

bool	DATA_DatabaseEntryUpdatedRecently (void *pDatabaseEntry, uint32_t timeInterval)
	Checks if passed database entry has been updated within the last time interval. More...

bool	DATA_DatabaseEntryUpdatedWithinInterval (void *pDatabaseEntry, uint32_t timeInterval)
	Checks if passed database entry has been periodically updated within the time interval. More...

Variables
static QueueHandle_t	data_queue

static StaticQueue_t	dataQueueStructure
	structure for static data queue More...

static uint8_t	dataQueueStorageArea [DATA_QUEUE_LENGTH *DATA_QUEUE_ITEM_SIZE]
	size of Queue storage More...

static const DATA_BASE_HEADER_s	data_baseHeader
	device configuration of database More...

static uint16_t	uniqueIdToDatabaseEntry [DATA_BLOCK_ID_MAX]
	uniqueId to respective database entry selector More...

Detailed Description

Database module implementation.

Copyright: © 2010 - 2021, 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: 2015-08-18 (date of creation)

Updated: 2020-01-17 (date of last update)

Prefix: DATA

Implementation of database module

Definition in file database.c.

Macro Definition Documentation

◆ DATA_MAX_ENTRIES_PER_ACCESS

#define DATA_MAX_ENTRIES_PER_ACCESS (4u)

Maximum number of database entries that can be read or written during one access call to the database

Definition at line 80 of file database.c.

◆ DATA_QUEUE_ITEM_SIZE

#define DATA_QUEUE_ITEM_SIZE (sizeof(DATA_QUEUE_MESSAGE_s))

Size of data Queue item.

Definition at line 74 of file database.c.

◆ DATA_QUEUE_LENGTH

#define DATA_QUEUE_LENGTH (1u)

Length of data Queue.

Definition at line 69 of file database.c.

◆ DATA_QUEUE_TIMEOUT_MS

#define DATA_QUEUE_TIMEOUT_MS ((TickType_t)10u)

Maximum queue timeout time in milliseconds

Definition at line 64 of file database.c.

Typedef Documentation

◆ DATA_BASE_HEADER_s

typedef struct DATA_BASE_HEADER DATA_BASE_HEADER_s

configuration struct of database device

◆ DATA_QUEUE_MESSAGE_s

typedef struct DATA_QUEUE_MESSAGE DATA_QUEUE_MESSAGE_s

struct for database queue, contains pointer to data, database entry and access type

Function Documentation

◆ DATA_DatabaseEntryUpdatedAtLeastOnce()

bool DATA_DatabaseEntryUpdatedAtLeastOnce ( void * pDatabaseEntry )

Checks if passed database entry has been updated at least once.

Parameters

[in] pDatabaseEntry (type: void *)

Returns: true if database entry has been updated at least once, otherwise false

Definition at line 328 of file database.c.

◆ DATA_DatabaseEntryUpdatedRecently()

bool DATA_DatabaseEntryUpdatedRecently	(	void *	pDatabaseEntry,
		uint32_t	timeInterval
	)

Checks if passed database entry has been updated within the last time interval.

Parameters

[in]	pDatabaseEntry	(type: void *)
[in]	timeInterval	in systicks (type: uint32_t)

Returns: true if database entry has been updated within the time interval, otherwise false

Definition at line 340 of file database.c.

Here is the call graph for this function:

◆ DATA_DatabaseEntryUpdatedWithinInterval()

bool DATA_DatabaseEntryUpdatedWithinInterval	(	void *	pDatabaseEntry,
		uint32_t	timeInterval
	)

Checks if passed database entry has been periodically updated within the time interval.

Checks if the last update timestamp is not older than time interval and if the difference between previous timestamp and timestamp is smaller than time interval

Parameters

[in]	pDatabaseEntry	(type: void *)
[in]	timeInterval	in systicks (type: uint32_t)

Returns: true if database entry has been periodically updated within the time interval, otherwise false

Definition at line 356 of file database.c.

Here is the call graph for this function:

◆ DATA_DummyFunction()

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(databaseVaribale, DATA_Read_4_DataBlocks, DATA_Read_3_DataBlocks, DATA_Read_2_DataBlocks, DATA_Read_2_DataBlocks, DATA_Read_1_DataBlock)(databaseVaribale) 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 237 of file database.c.

◆ DATA_Init()

STD_RETURN_TYPE_e DATA_Init ( void )

Initialization of database manager.

Returns: STD_OK if initialization successful, otherwise STD_NOT_OK

Definition at line 138 of file database.c.

◆ DATA_Read_1_DataBlock()

STD_RETURN_TYPE_e DATA_Read_1_DataBlock ( void * pDataToReceiver0 )

Reads a datablock in database by value.

This function reads data from database and copy this content in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[out] pDataToReceiver0 (type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 240 of file database.c.

Here is the call graph for this function:

◆ DATA_Read_2_DataBlocks()

STD_RETURN_TYPE_e DATA_Read_2_DataBlocks	(	void *	pDataToReceiver0,
		void *	pDataToReceiver1
	)

Reads a datablock in database by value.

This function reads data from database and copy this content in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[out]	pDataToReceiver0	(type: void *)
[out]	pDataToReceiver1	(type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 245 of file database.c.

Here is the call graph for this function:

◆ DATA_Read_3_DataBlocks()

STD_RETURN_TYPE_e DATA_Read_3_DataBlocks	(	void *	pDataToReceiver0,
		void *	pDataToReceiver1,
		void *	pDataToReceiver2
	)

Reads a datablock in database by value.

This function reads data from database and copy this content in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[out]	pDataToReceiver0	(type: void *)
[out]	pDataToReceiver1	(type: void *)
[out]	pDataToReceiver2	(type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 250 of file database.c.

Here is the call graph for this function:

◆ DATA_Read_4_DataBlocks()

STD_RETURN_TYPE_e DATA_Read_4_DataBlocks	(	void *	pDataToReceiver0,
		void *	pDataToReceiver1,
		void *	pDataToReceiver2,
		void *	pDataToReceiver3
	)

Reads a datablock in database by value.

This function reads data from database and copy this content in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[out]	pDataToReceiver0	(type: void *)
[out]	pDataToReceiver1	(type: void *)
[out]	pDataToReceiver2	(type: void *)
[out]	pDataToReceiver3	(type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 255 of file database.c.

◆ DATA_Task()

void DATA_Task ( void )

trigger of database manager

TODO

Definition at line 189 of file database.c.

Here is the call graph for this function:

◆ DATA_Write_1_DataBlock()

STD_RETURN_TYPE_e DATA_Write_1_DataBlock ( void * pDataFromSender0 )

Stores a datablock in database.

This function stores passed data in database and updates timestamp and previous timestamp in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[in,out] pDataFromSender0 (type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 284 of file database.c.

Here is the call graph for this function:

◆ DATA_Write_2_DataBlocks()

STD_RETURN_TYPE_e DATA_Write_2_DataBlocks	(	void *	pDataFromSender0,
		void *	pDataFromSender1
	)

Stores a datablock in database.

This function stores passed data in database and updates timestamp and previous timestamp in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[in,out]	pDataFromSender0	(type: void *)
[in,out]	pDataFromSender1	(type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 289 of file database.c.

Here is the call graph for this function:

◆ DATA_Write_3_DataBlocks()

STD_RETURN_TYPE_e DATA_Write_3_DataBlocks	(	void *	pDataFromSender0,
		void *	pDataFromSender1,
		void *	pDataFromSender2
	)

Stores a datablock in database.

This function stores passed data in database and updates timestamp and previous timestamp in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[in,out]	pDataFromSender0	(type: void *)
[in,out]	pDataFromSender1	(type: void *)
[in,out]	pDataFromSender2	(type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 294 of file database.c.

Here is the call graph for this function:

◆ DATA_Write_4_DataBlocks()

STD_RETURN_TYPE_e DATA_Write_4_DataBlocks	(	void *	pDataFromSender0,
		void *	pDataFromSender1,
		void *	pDataFromSender2,
		void *	pDataFromSender3
	)

Stores a datablock in database.

This function stores passed data in database and updates timestamp and previous timestamp in passed struct

Warning: Do not call this function from inside a critical section, as it is computationally complex.

Parameters

[in,out]	pDataFromSender0	(type: void *)
[in,out]	pDataFromSender1	(type: void *)
[in,out]	pDataFromSender2	(type: void *)
[in,out]	pDataFromSender3	(type: void *)

Returns: STD_OK if access was successful, otherwise STD_NOT_OK

Definition at line 299 of file database.c.

Variable Documentation

◆ data_baseHeader

const DATA_BASE_HEADER_s data_baseHeader

static

Initial value:

= {
    .nrDatabaseEntries = sizeof(data_database) / sizeof(DATA_BASE_s), 
    .pDatabase         = &data_database[0],
}

device configuration of database

all attributes of device configuration are listed here (pointer to channel list, number of channels)

Definition at line 119 of file database.c.

◆ data_queue

QueueHandle_t data_queue

static

handle of the data queue

Definition at line 100 of file database.c.

◆ dataQueueStorageArea

uint8_t dataQueueStorageArea[DATA_QUEUE_LENGTH *DATA_QUEUE_ITEM_SIZE]

static

size of Queue storage

The array to use as the queue's storage area. This must be at least DATA_QUEUE_LENGTH * DATA_QUEUE_ITEM_SIZE

Definition at line 112 of file database.c.

◆ dataQueueStructure

StaticQueue_t dataQueueStructure

static

structure for static data queue

Definition at line 105 of file database.c.

◆ uniqueIdToDatabaseEntry

uint16_t uniqueIdToDatabaseEntry[DATA_BLOCK_ID_MAX]

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[]

Definition at line 129 of file database.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DATA_MAX_ENTRIES_PER_ACCESS

◆ DATA_QUEUE_ITEM_SIZE

◆ DATA_QUEUE_LENGTH

◆ DATA_QUEUE_TIMEOUT_MS

Typedef Documentation

◆ DATA_BASE_HEADER_s

◆ DATA_QUEUE_MESSAGE_s

Function Documentation

◆ DATA_DatabaseEntryUpdatedAtLeastOnce()

◆ DATA_DatabaseEntryUpdatedRecently()

◆ DATA_DatabaseEntryUpdatedWithinInterval()

◆ DATA_DummyFunction()

◆ DATA_Init()

◆ DATA_Read_1_DataBlock()

◆ DATA_Read_2_DataBlocks()

◆ DATA_Read_3_DataBlocks()

◆ DATA_Read_4_DataBlocks()

◆ DATA_Task()

◆ DATA_Write_1_DataBlock()

◆ DATA_Write_2_DataBlocks()

◆ DATA_Write_3_DataBlocks()

◆ DATA_Write_4_DataBlocks()

Variable Documentation

◆ data_baseHeader

◆ data_queue

◆ dataQueueStorageArea

◆ dataQueueStructure

◆ uniqueIdToDatabaseEntry