foxBMS - Unit Tests  1.2.1
The foxBMS Unit Tests API Documentation
ftask.h File Reference

Header of task driver implementation. More...

#include "ftask_cfg.h"
#include "os.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   (sizeof(DATA_QUEUE_MESSAGE_s))
 
#define FTSK_IMD_QUEUE_LENGTH   (5u)
 
#define FTSK_IMD_QUEUE_ITEM_SIZE   (sizeof(CAN_BUFFERELEMENT_s))
 
#define FTSK_CAN_RX_QUEUE_LENGTH   (50u)
 
#define FTSK_CAN_RX_QUEUE_ITEM_SIZE   (sizeof(CAN_BUFFERELEMENT_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...
 

Variables

OS_QUEUE ftsk_databaseQueue
 
OS_QUEUE ftsk_imdCanDataQueue
 
OS_QUEUE ftsk_canRxQueue
 
volatile bool ftsk_allQueuesCreated
 

Detailed Description

Header of task driver 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:

  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
2019-08-27 (date of creation)
Updated
2021-12-01 (date of last update)
Prefix
FTSK

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

Definition in file ftask.h.

Macro Definition Documentation

◆ FTSK_CAN_RX_QUEUE_ITEM_SIZE

#define FTSK_CAN_RX_QUEUE_ITEM_SIZE   (sizeof(CAN_BUFFERELEMENT_s))

Size of queue item that is used in the can driver

Definition at line 78 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 76 of file ftask.h.

◆ FTSK_DATABASE_QUEUE_ITEM_SIZE

#define FTSK_DATABASE_QUEUE_ITEM_SIZE   (sizeof(DATA_QUEUE_MESSAGE_s))

Size of queue item that is used in the database

Definition at line 68 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 65 of file ftask.h.

◆ FTSK_IMD_QUEUE_ITEM_SIZE

#define FTSK_IMD_QUEUE_ITEM_SIZE   (sizeof(CAN_BUFFERELEMENT_s))

Size of queue item that is used in the IMD driver

Definition at line 73 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 71 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 database queue

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

< structure for static database queue

size of storage area for the IMD queue

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

< structure for static data queue

< structure for static data queue

size of storage area for the CAN Rx queue

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

Definition at line 84 of file ftask_freertos.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).

Definition at line 153 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).

Definition at line 126 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).

Definition at line 95 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).

Definition at line 180 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.

Definition at line 73 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 139 of file ftask_freertos.c.

Here is the call graph for this function:

Variable Documentation

◆ 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 68 of file ftask_freertos.c.

◆ ftsk_canRxQueue

OS_QUEUE ftsk_canRxQueue
extern

handle of the can driver data queue

Definition at line 75 of file ftask_freertos.c.

◆ ftsk_databaseQueue

OS_QUEUE ftsk_databaseQueue
extern

handle of the database queue

Definition at line 70 of file ftask_freertos.c.

◆ ftsk_imdCanDataQueue

OS_QUEUE ftsk_imdCanDataQueue
extern

handle of the imd can data queue

Definition at line 72 of file ftask_freertos.c.