Header of task driver implementation. More...

#include "can_cfg.h"
#include "ftask_cfg.h"
#include "database.h"
#include "os.h"
#include "rtc.h"
#include <stdint.h>

Include dependency graph for ftask.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	FTSK_DATABASE_QUEUE_LENGTH (1u)

#define	FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(DATA_QUEUE_MESSAGE_s))

#define	FTSK_IMD_QUEUE_LENGTH (5u)

#define	FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s))

#define	FTSK_CAN_RX_QUEUE_LENGTH (50u)

#define	FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s))

#define	FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_LENGTH (5u)

#define	FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s))

#define	FTSK_AFE_REQUEST_QUEUE_LENGTH (1u)

#define	FTSK_AFE_REQUEST_QUEUE_ITEM_SIZE (sizeof(AFE_REQUEST_e))

#define	FTSK_RTC_QUEUE_LENGTH (1u)

#define	FTSK_RTC_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(RTC_TIME_DATA_s))

#define	FTSK_AFEI2C_QUEUE_LENGTH (1u)

#define	FTSK_AFEI2C_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(AFE_I2C_QUEUE_s))

Functions
void	FTSK_CreateQueues (void)
	Creates all queues. More...

void	FTSK_CreateTasks (void)
	Creates all tasks of the group. More...

void	FTSK_CreateTaskEngine (void *const pvParameters)
	Database-Task. More...

void	FTSK_CreateTaskCyclic1ms (void *const pvParameters)
	Creation of cyclic 1 ms task. More...

void	FTSK_CreateTaskCyclic10ms (void *const pvParameters)
	Creation of cyclic 10 ms task. More...

void	FTSK_CreateTaskCyclic100ms (void *const pvParameters)
	Creation of cyclic 100 ms task. More...

void	FTSK_CreateTaskCyclicAlgorithm100ms (void *const pvParameters)
	Creation of cyclic 100 ms algorithm task. More...

void	FTSK_CreateTaskI2c (void *const pvParameters)
	Creation of continuously running task for I2c. More...

void	FTSK_CreateTaskAfe (void *const pvParameters)
	Creation of continuously running task for AFEs. More...

Variables
OS_QUEUE	ftsk_databaseQueue

OS_QUEUE	ftsk_imdCanDataQueue

OS_QUEUE	ftsk_canRxQueue

OS_QUEUE	ftsk_canTxUnsentMessagesQueue

OS_QUEUE	ftsk_afeRequestQueue

OS_QUEUE	ftsk_rtcSetTimeQueue

OS_QUEUE	ftsk_afeToI2cQueue

OS_QUEUE	ftsk_afeFromI2cQueue

volatile bool	ftsk_allQueuesCreated

Detailed Description

Header of task driver implementation.

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: 2019-08-27 (date of creation)

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

Version: v1.6.0

Prefix: FTSK

Declares the functions that are need to needed to initialize the operating system. This includes queues, mutexes, events and tasks.

Definition in file ftask.h.

Macro Definition Documentation

◆ FTSK_AFE_REQUEST_QUEUE_ITEM_SIZE

#define FTSK_AFE_REQUEST_QUEUE_ITEM_SIZE (sizeof(AFE_REQUEST_e))

Definition at line 92 of file ftask.h.

◆ FTSK_AFE_REQUEST_QUEUE_LENGTH

#define FTSK_AFE_REQUEST_QUEUE_LENGTH (1u)

Definition at line 91 of file ftask.h.

◆ FTSK_AFEI2C_QUEUE_ITEM_SIZE_IN_BYTES

#define FTSK_AFEI2C_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(AFE_I2C_QUEUE_s))

Size of queue item that is used for I2C transmission over NXP slave

Definition at line 102 of file ftask.h.

◆ FTSK_AFEI2C_QUEUE_LENGTH

#define FTSK_AFEI2C_QUEUE_LENGTH (1u)

Length of queue that is used for I2C transmission over NXP slave

Definition at line 100 of file ftask.h.

◆ FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES

#define FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s))

Size of queue item that is used in the can driver

Definition at line 84 of file ftask.h.

◆ FTSK_CAN_RX_QUEUE_LENGTH

#define FTSK_CAN_RX_QUEUE_LENGTH (50u)

Length of queue that is used in the can module for receiving messages

Definition at line 82 of file ftask.h.

◆ FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_ITEM_SIZE_IN_BYTES

#define FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s))

Size of queue item that is used in the can driver

Definition at line 89 of file ftask.h.

◆ FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_LENGTH

#define FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_LENGTH (5u)

Length of queue that is used in the can module for tracking unsent messages

Definition at line 87 of file ftask.h.

◆ FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES

#define FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(DATA_QUEUE_MESSAGE_s))

Size of queue item that is used in the database

Definition at line 74 of file ftask.h.

◆ FTSK_DATABASE_QUEUE_LENGTH

#define FTSK_DATABASE_QUEUE_LENGTH (1u)

Length of queue that is used in the database

Definition at line 71 of file ftask.h.

◆ FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES

#define FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s))

Size of queue item that is used in the IMD driver

Definition at line 79 of file ftask.h.

◆ FTSK_IMD_QUEUE_LENGTH

#define FTSK_IMD_QUEUE_LENGTH (5u)

Length of queue that is used in the insulation measurement device (IMD)

Definition at line 77 of file ftask.h.

◆ FTSK_RTC_QUEUE_ITEM_SIZE_IN_BYTES

#define FTSK_RTC_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(RTC_TIME_DATA_s))

Size of queue item that is used in the can driver

Definition at line 97 of file ftask.h.

◆ FTSK_RTC_QUEUE_LENGTH

#define FTSK_RTC_QUEUE_LENGTH (1u)

Length of queue that is used in the can module for receiving messages

Definition at line 95 of file ftask.h.

Function Documentation

◆ FTSK_CreateQueues()

void FTSK_CreateQueues ( void )

Creates all queues.

Creates all queues. Is called after the hardware is initialized and before the scheduler starts. Queues, Mutexes and Events are already initialized.

size of storage area for the AFE request queue

The array that is used for the queue's storage area. This must be at least FTSK_AFE_REQUEST_QUEUE_LENGTH * FTSK_AFE_REQUEST_QUEUE_ITEM_SIZE

< structure for static database queue

Definition at line 136 of file ftask_freertos.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskAfe()

void FTSK_CreateTaskAfe ( void *const pvParameters )

Creation of continuously running task for AFEs.

Parameters

pvParameters parameter for the to task

Definition at line 239 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskCyclic100ms()

void FTSK_CreateTaskCyclic100ms ( void *const pvParameters )

Creation of cyclic 100 ms task.

Task is delayed by a phase as defined in ftsk_taskDefinitionCyclic100ms.phase (in milliseconds). After the phase delay, the cyclic execution starts, the entry time is saved in current_time. After one cycle, the Task is set to sleep until entry time + ftsk_taskDefinitionCyclic100ms.cycleTime (in milliseconds).

Parameters

pvParameters parameter for the to task

Definition at line 159 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskCyclic10ms()

void FTSK_CreateTaskCyclic10ms ( void *const pvParameters )

Creation of cyclic 10 ms task.

Task is delayed by a phase as defined in ftsk_taskDefinitionCyclic10ms.phase (in milliseconds). After the phase delay, the cyclic execution starts, the entry time is saved in current_time. After one cycle, the Task is set to sleep until entry time + ftsk_taskDefinitionCyclic10ms.cycleTime (in milliseconds).

Parameters

pvParameters parameter for the to task

Definition at line 130 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskCyclic1ms()

void FTSK_CreateTaskCyclic1ms ( void *const pvParameters )

Creation of cyclic 1 ms task.

Then the Task is delayed by a phase as defined in ftsk_taskDefinitionCyclic1ms.phase (in milliseconds). After the phase delay, the cyclic execution starts, the entry time is saved in current_time. After one cycle, the Task is set to sleep until entry time + ftsk_taskDefinitionCyclic1ms.cycleTime (in milliseconds).

Parameters

pvParameters parameter for the to task

Definition at line 98 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskCyclicAlgorithm100ms()

void FTSK_CreateTaskCyclicAlgorithm100ms ( void *const pvParameters )

Creation of cyclic 100 ms algorithm task.

Task is delayed by a phase as defined in ftsk_taskDefinitionCyclicAlgorithm100ms.Phase (in milliseconds). After the phase delay, the cyclic execution starts, the entry time is saved in current_time. After one cycle, the Task is set to sleep until entry time + ftsk_taskDefinitionCyclicAlgorithm100ms.CycleTime (in milliseconds).

Parameters

pvParameters parameter for the to task

Definition at line 188 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskEngine()

void FTSK_CreateTaskEngine ( void *const pvParameters )

Database-Task.

The task manages the data exchange with the database and must have a higher task priority than any task using the database.

Parameters

pvParameters parameter for the to task

Definition at line 76 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTaskI2c()

void FTSK_CreateTaskI2c ( void *const pvParameters )

Creation of continuously running task for I2c.

Definition at line 219 of file ftask.c.

Here is the call graph for this function:

◆ FTSK_CreateTasks()

void FTSK_CreateTasks ( void )

Creates all tasks of the group.

Creates all tasks. Is called after the hardware is initialized and before the scheduler starts. Queues, Mutexes and Events are already initialized.

Definition at line 249 of file ftask_freertos.c.

Here is the call graph for this function:

Variable Documentation

◆ ftsk_afeFromI2cQueue

OS_QUEUE ftsk_afeFromI2cQueue

extern

Definition at line 128 of file ftask_freertos.c.

◆ ftsk_afeRequestQueue

OS_QUEUE ftsk_afeRequestQueue

extern

handle of the AFE driver request queue

Definition at line 124 of file ftask_freertos.c.

◆ ftsk_afeToI2cQueue

OS_QUEUE ftsk_afeToI2cQueue

extern

handle of the I2C transmission over NXP slave queue

Definition at line 127 of file ftask_freertos.c.

◆ ftsk_allQueuesCreated

volatile bool ftsk_allQueuesCreated

extern

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

Definition at line 112 of file ftask_freertos.c.

◆ ftsk_canRxQueue

OS_QUEUE ftsk_canRxQueue

extern

CAN driver data queue for RX messages

Definition at line 119 of file ftask_freertos.c.

◆ ftsk_canTxUnsentMessagesQueue

OS_QUEUE ftsk_canTxUnsentMessagesQueue

extern

CAN driver data queue for unsent TX messages

Definition at line 122 of file ftask_freertos.c.

◆ ftsk_databaseQueue

OS_QUEUE ftsk_databaseQueue

extern

database queue

Definition at line 114 of file ftask_freertos.c.

◆ ftsk_imdCanDataQueue

OS_QUEUE ftsk_imdCanDataQueue

extern

queue for CAN based IMD devices

Definition at line 116 of file ftask_freertos.c.

◆ ftsk_rtcSetTimeQueue

OS_QUEUE ftsk_rtcSetTimeQueue

extern

handle of the rtc driver data queue

Definition at line 125 of file ftask_freertos.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FTSK_AFE_REQUEST_QUEUE_ITEM_SIZE

◆ FTSK_AFE_REQUEST_QUEUE_LENGTH

◆ FTSK_AFEI2C_QUEUE_ITEM_SIZE_IN_BYTES

◆ FTSK_AFEI2C_QUEUE_LENGTH

◆ FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES

◆ FTSK_CAN_RX_QUEUE_LENGTH

◆ FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_ITEM_SIZE_IN_BYTES

◆ FTSK_CAN_TX_UNSENT_MESSAGES_QUEUE_LENGTH

◆ FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES

◆ FTSK_DATABASE_QUEUE_LENGTH

◆ FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES

◆ FTSK_IMD_QUEUE_LENGTH

◆ FTSK_RTC_QUEUE_ITEM_SIZE_IN_BYTES

◆ FTSK_RTC_QUEUE_LENGTH

Function Documentation

◆ FTSK_CreateQueues()

◆ FTSK_CreateTaskAfe()

◆ FTSK_CreateTaskCyclic100ms()

◆ FTSK_CreateTaskCyclic10ms()

◆ FTSK_CreateTaskCyclic1ms()

◆ FTSK_CreateTaskCyclicAlgorithm100ms()

◆ FTSK_CreateTaskEngine()

◆ FTSK_CreateTaskI2c()

◆ FTSK_CreateTasks()

Variable Documentation

◆ ftsk_afeFromI2cQueue

◆ ftsk_afeRequestQueue

◆ ftsk_afeToI2cQueue

◆ ftsk_allQueuesCreated

◆ ftsk_canRxQueue

◆ ftsk_canTxUnsentMessagesQueue

◆ ftsk_databaseQueue

◆ ftsk_imdCanDataQueue

◆ ftsk_rtcSetTimeQueue