foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
ftask_freertos.c File Reference

OS specific, i.e., FreeRTOS specfific, creation of the tasks. More...

#include "can_cfg.h"
#include "FreeRTOS.h"
#include "task.h"
#include "database.h"
#include "ftask.h"
Include dependency graph for ftask_freertos.c:

Go to the source code of this file.

Macros

#define FTSK_BYTES_TO_WORDS(VARIABALE_IN_BYTES)   ((VARIABALE_IN_BYTES) / GEN_BYTES_PER_WORD)
 
#define FTSK_TASK_ENGINE_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_ENGINE_STACK_SIZE_IN_BYTES)
 
#define FTSK_TASK_CYCLIC_1MS_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_1MS_STACK_SIZE_IN_BYTES)
 Stack size of cyclic 1 ms task in words. More...
 
#define FTSK_TASK_CYCLIC_10MS_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_10MS_STACK_SIZE_IN_BYTES)
 Stack size of cyclic 10 ms task in words. More...
 
#define FTSK_TASK_CYCLIC_100MS_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_100MS_STACK_SIZE_IN_BYTES)
 Stack size of cyclic 100 ms task in words. More...
 
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACK_SIZE_IN_WORDS    FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACK_SIZE_IN_BYTES)
 Stack size of cyclic 100 ms task for algorithms in words. More...
 
#define FTSK_TASK_AFE_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_AFE_STACK_SIZE_IN_BYTES)
 Stack size of continuously running task for AFEs. More...
 
#define FTSK_DATABASE_QUEUE_STORAGE_AREA   (FTSK_DATABASE_QUEUE_LENGTH * FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES)
 
#define FTSK_IMD_QUEUE_STORAGE_AREA   (FTSK_IMD_QUEUE_LENGTH * FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES)
 
#define FTSK_CAN_RX_QUEUE_STORAGE_AREA   (FTSK_CAN_RX_QUEUE_LENGTH * FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES)
 

Functions

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

Variables

TaskHandle_t ftsk_taskHandleAfe
 Definition of task handle for the AFE task. More...
 
volatile bool ftsk_allQueuesCreated = false
 
QueueHandle_t ftsk_databaseQueue = NULL_PTR
 
QueueHandle_t ftsk_imdCanDataQueue = NULL_PTR
 
QueueHandle_t ftsk_canRxQueue = NULL_PTR
 

Detailed Description

OS specific, i.e., FreeRTOS specfific, creation of the tasks.

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
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
FTSK

TODO

Definition in file ftask_freertos.c.

Macro Definition Documentation

◆ FTSK_BYTES_TO_WORDS

#define FTSK_BYTES_TO_WORDS (   VARIABALE_IN_BYTES)    ((VARIABALE_IN_BYTES) / GEN_BYTES_PER_WORD)

helper macro to translate the stack sizes from bytes into words as FreeRTOS requires words and not bytes

Definition at line 66 of file ftask_freertos.c.

◆ FTSK_CAN_RX_QUEUE_STORAGE_AREA

#define FTSK_CAN_RX_QUEUE_STORAGE_AREA   (FTSK_CAN_RX_QUEUE_LENGTH * FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES)

size of storage area for the CAN Rx queue

Definition at line 88 of file ftask_freertos.c.

◆ FTSK_DATABASE_QUEUE_STORAGE_AREA

#define FTSK_DATABASE_QUEUE_STORAGE_AREA   (FTSK_DATABASE_QUEUE_LENGTH * FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES)

size of storage area for the database queue

Definition at line 82 of file ftask_freertos.c.

◆ FTSK_IMD_QUEUE_STORAGE_AREA

#define FTSK_IMD_QUEUE_STORAGE_AREA   (FTSK_IMD_QUEUE_LENGTH * FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES)

size of storage area for the IMD queue

Definition at line 85 of file ftask_freertos.c.

◆ FTSK_TASK_AFE_STACK_SIZE_IN_WORDS

#define FTSK_TASK_AFE_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_AFE_STACK_SIZE_IN_BYTES)

Stack size of continuously running task for AFEs.

Definition at line 79 of file ftask_freertos.c.

◆ FTSK_TASK_CYCLIC_100MS_STACK_SIZE_IN_WORDS

#define FTSK_TASK_CYCLIC_100MS_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_100MS_STACK_SIZE_IN_BYTES)

Stack size of cyclic 100 ms task in words.

Definition at line 74 of file ftask_freertos.c.

◆ FTSK_TASK_CYCLIC_10MS_STACK_SIZE_IN_WORDS

#define FTSK_TASK_CYCLIC_10MS_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_10MS_STACK_SIZE_IN_BYTES)

Stack size of cyclic 10 ms task in words.

Definition at line 72 of file ftask_freertos.c.

◆ FTSK_TASK_CYCLIC_1MS_STACK_SIZE_IN_WORDS

#define FTSK_TASK_CYCLIC_1MS_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_1MS_STACK_SIZE_IN_BYTES)

Stack size of cyclic 1 ms task in words.

Definition at line 70 of file ftask_freertos.c.

◆ FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACK_SIZE_IN_WORDS

#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACK_SIZE_IN_WORDS    FTSK_BYTES_TO_WORDS(FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACK_SIZE_IN_BYTES)

Stack size of cyclic 100 ms task for algorithms in words.

Definition at line 76 of file ftask_freertos.c.

◆ FTSK_TASK_ENGINE_STACK_SIZE_IN_WORDS

#define FTSK_TASK_ENGINE_STACK_SIZE_IN_WORDS   FTSK_BYTES_TO_WORDS(FTSK_TASK_ENGINE_STACK_SIZE_IN_BYTES)

Stack size of engine task in words

Definition at line 68 of file ftask_freertos.c.

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.

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

Here is the call graph for this function:

Variable Documentation

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

◆ ftsk_canRxQueue

QueueHandle_t ftsk_canRxQueue = NULL_PTR

handle of the can driver data queue

Definition at line 103 of file ftask_freertos.c.

◆ ftsk_databaseQueue

QueueHandle_t ftsk_databaseQueue = NULL_PTR

handle of the database queue

Definition at line 98 of file ftask_freertos.c.

◆ ftsk_imdCanDataQueue

QueueHandle_t ftsk_imdCanDataQueue = NULL_PTR

handle of the imd can data queue

Definition at line 100 of file ftask_freertos.c.

◆ ftsk_taskHandleAfe

TaskHandle_t ftsk_taskHandleAfe

Definition of task handle for the AFE task.

Definition of task handles.

Definition at line 94 of file ftask_freertos.c.