foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
ftask_cfg.h File Reference

Task configuration header. More...

#include "general.h"
#include "os.h"
Include dependency graph for ftask_cfg.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define FTSK_TASK_ENGINE_STACK_SIZE   (1024u / 4u)
 Stack size of engine task. More...
 
#define FTSK_TASK_ENGINE_PHASE   (0u)
 Phase of engine task. More...
 
#define FTSK_TASK_ENGINE_CYCLE_TIME   (1u)
 Cycle time of engine task. More...
 
#define FTSK_TASK_ENGINE_MAXIMUM_JITTER   (1u)
 Maximum allowed jitter of engine task. More...
 
#define FTSK_TASK_CYCLIC_1MS_STACK_SIZE   (1024u / 4u)
 Stack size of cyclic 1 ms task. More...
 
#define FTSK_TASK_CYCLIC_1MS_PHASE   (0u)
 Phase of cyclic 1ms task. More...
 
#define FTSK_TASK_CYCLIC_1MS_CYCLE_TIME   (1u)
 Cycle time of 1ms task. More...
 
#define FTSK_TASK_CYCLIC_1MS_MAXIMUM_JITTER   (1u)
 Maximum allowed jitter of 1ms task. More...
 
#define FTSK_TASK_CYCLIC_10MS_STACK_SIZE   ((4096u) / 4u)
 Stack size of cyclic 10 ms task. More...
 
#define FTSK_TASK_CYCLIC_10MS_PHASE   (2u)
 Phase of cyclic 10 ms task. More...
 
#define FTSK_TASK_CYCLIC_10MS_CYCLE_TIME   (10u)
 Cycle time of 10 ms task. More...
 
#define FTSK_TASK_CYCLIC_10MS_MAXIMUM_JITTER   (2u)
 Maximum allowed jitter of 10ms task. More...
 
#define FTSK_TASK_CYCLIC_100MS_STACK_SIZE   (1024u / 4u)
 Stack size of cyclic 100 ms task. More...
 
#define FTSK_TASK_CYCLIC_100MS_PHASE   (56u)
 Phase of cyclic 100 ms task. More...
 
#define FTSK_TASK_CYCLIC_100MS_CYCLE_TIME   (100u)
 Cycle time of 100ms task. More...
 
#define FTSK_TASK_CYCLIC_100MS_MAXIMUM_JITTER   (5u)
 Maximum allowed jitter of 100ms task. More...
 
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACKSIZE   (1024u / 4u)
 Stack size of cyclic 100 ms task for algorithms. More...
 
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_PHASE   (64u)
 Phase of cyclic 100 ms task for algorithms. More...
 
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME   (100u)
 Cycle time of 100ms task for algorithms. More...
 
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER   (5u)
 Maximum allowed jitter of 100ms task for algorithms. More...
 

Functions

void FTSK_InitializeUserCodeEngine (void)
 Initializes the database. More...
 
void FTSK_RunUserCodeEngine (void)
 Engine task for the database and the system monitoring module. More...
 
void FTSK_InitializeUserCodePreCyclicTasks (void)
 Initialization function before all tasks started. More...
 
void FTSK_RunUserCodeCyclic1ms (void)
 Cyclic 1 ms task. More...
 
void FTSK_RunUserCodeCyclic10ms (void)
 Cyclic 10 ms task. More...
 
void FTSK_RunUserCodeCyclic100ms (void)
 Cyclic 100 ms task. More...
 
void FTSK_RunUserCodeCyclicAlgorithm100ms (void)
 Cyclic 100 ms task for algorithms. More...
 
void FTSK_RunUserCodeIdle (void)
 Idle task. More...
 

Variables

OS_TASK_DEFINITION_s ftsk_taskDefinitionEngine
 Task configuration of the engine task. More...
 
OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclic1ms
 Task configuration of the cyclic 1 ms task. More...
 
OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclic10ms
 Task configuration of the cyclic 10 ms task. More...
 
OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclic100ms
 Task configuration of the cyclic 100 ms task. More...
 
OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclicAlgorithm100ms
 Task configuration of the cyclic 100 ms task for algorithms. More...
 

Detailed Description

Task configuration header.

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-26 (date of creation)
Updated
2021-07-23 (date of last update)
Prefix
FTSK

TODO

Definition in file ftask_cfg.h.

Macro Definition Documentation

◆ FTSK_TASK_CYCLIC_100MS_CYCLE_TIME

#define FTSK_TASK_CYCLIC_100MS_CYCLE_TIME   (100u)

Cycle time of 100ms task.

Definition at line 106 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_100MS_MAXIMUM_JITTER

#define FTSK_TASK_CYCLIC_100MS_MAXIMUM_JITTER   (5u)

Maximum allowed jitter of 100ms task.

Definition at line 109 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_100MS_PHASE

#define FTSK_TASK_CYCLIC_100MS_PHASE   (56u)

Phase of cyclic 100 ms task.

Definition at line 103 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_100MS_STACK_SIZE

#define FTSK_TASK_CYCLIC_100MS_STACK_SIZE   (1024u / 4u)

Stack size of cyclic 100 ms task.

Definition at line 100 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_10MS_CYCLE_TIME

#define FTSK_TASK_CYCLIC_10MS_CYCLE_TIME   (10u)

Cycle time of 10 ms task.

Definition at line 94 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_10MS_MAXIMUM_JITTER

#define FTSK_TASK_CYCLIC_10MS_MAXIMUM_JITTER   (2u)

Maximum allowed jitter of 10ms task.

Definition at line 97 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_10MS_PHASE

#define FTSK_TASK_CYCLIC_10MS_PHASE   (2u)

Phase of cyclic 10 ms task.

Definition at line 91 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_10MS_STACK_SIZE

#define FTSK_TASK_CYCLIC_10MS_STACK_SIZE   ((4096u) / 4u)

Stack size of cyclic 10 ms task.

Definition at line 88 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_1MS_CYCLE_TIME

#define FTSK_TASK_CYCLIC_1MS_CYCLE_TIME   (1u)

Cycle time of 1ms task.

Definition at line 82 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_1MS_MAXIMUM_JITTER

#define FTSK_TASK_CYCLIC_1MS_MAXIMUM_JITTER   (1u)

Maximum allowed jitter of 1ms task.

Definition at line 85 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_1MS_PHASE

#define FTSK_TASK_CYCLIC_1MS_PHASE   (0u)

Phase of cyclic 1ms task.

Definition at line 79 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_1MS_STACK_SIZE

#define FTSK_TASK_CYCLIC_1MS_STACK_SIZE   (1024u / 4u)

Stack size of cyclic 1 ms task.

Definition at line 76 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME

#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME   (100u)

Cycle time of 100ms task for algorithms.

Definition at line 118 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER

#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER   (5u)

Maximum allowed jitter of 100ms task for algorithms.

Definition at line 121 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_ALGORITHM_100MS_PHASE

#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_PHASE   (64u)

Phase of cyclic 100 ms task for algorithms.

Definition at line 115 of file ftask_cfg.h.

◆ FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACKSIZE

#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_STACKSIZE   (1024u / 4u)

Stack size of cyclic 100 ms task for algorithms.

Definition at line 112 of file ftask_cfg.h.

◆ FTSK_TASK_ENGINE_CYCLE_TIME

#define FTSK_TASK_ENGINE_CYCLE_TIME   (1u)

Cycle time of engine task.

Definition at line 70 of file ftask_cfg.h.

◆ FTSK_TASK_ENGINE_MAXIMUM_JITTER

#define FTSK_TASK_ENGINE_MAXIMUM_JITTER   (1u)

Maximum allowed jitter of engine task.

Definition at line 73 of file ftask_cfg.h.

◆ FTSK_TASK_ENGINE_PHASE

#define FTSK_TASK_ENGINE_PHASE   (0u)

Phase of engine task.

Definition at line 67 of file ftask_cfg.h.

◆ FTSK_TASK_ENGINE_STACK_SIZE

#define FTSK_TASK_ENGINE_STACK_SIZE   (1024u / 4u)

Stack size of engine task.

Definition at line 64 of file ftask_cfg.h.

Function Documentation

◆ FTSK_InitializeUserCodeEngine()

void FTSK_InitializeUserCodeEngine ( void  )

Initializes the database.

Start up after scheduler starts

Warning
Do not change the content of this function. This will very likely break the system. This function is kept in the configuration file to have a uniform task configuration.

Definition at line 130 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_InitializeUserCodePreCyclicTasks()

void FTSK_InitializeUserCodePreCyclicTasks ( void  )

Initialization function before all tasks started.

This function is called after the scheduler started but before any cyclic task runs. Here modules get initialized that are not used during the startup process.

Definition at line 160 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_RunUserCodeCyclic100ms()

void FTSK_RunUserCodeCyclic100ms ( void  )

Cyclic 100 ms task.

TODO

Perform SOC and SOE calculations only every 1s. Not suited if analog integration of current sensor is NOT used. Manual integration of current requires a higher frequency.

Definition at line 227 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_RunUserCodeCyclic10ms()

void FTSK_RunUserCodeCyclic10ms ( void  )

Cyclic 10 ms task.

TODO

Definition at line 205 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_RunUserCodeCyclic1ms()

void FTSK_RunUserCodeCyclic1ms ( void  )

Cyclic 1 ms task.

TODO

Definition at line 195 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_RunUserCodeCyclicAlgorithm100ms()

void FTSK_RunUserCodeCyclicAlgorithm100ms ( void  )

Cyclic 100 ms task for algorithms.

TODO

Definition at line 247 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_RunUserCodeEngine()

void FTSK_RunUserCodeEngine ( void  )

Engine task for the database and the system monitoring module.

Start up after scheduler start. First task to be run, all other tasks only starts when this task has started

Warning
Do not change the content of this function. This will very likely break the system. This function is kept in the configuration file to have a uniform task configuration.

Definition at line 151 of file ftask_cfg.c.

Here is the call graph for this function:

◆ FTSK_RunUserCodeIdle()

void FTSK_RunUserCodeIdle ( void  )

Idle task.

Called by vApplicationIdleHook() if configUSE_IDLE_HOOK in FreeRTOSConfig.h is enabled. If you do not need this hook, you can disable it in the FreeRTOS configuration.

Definition at line 256 of file ftask_cfg.c.

Variable Documentation

◆ ftsk_taskDefinitionCyclic100ms

OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclic100ms
extern

Task configuration of the cyclic 100 ms task.

Cyclic 100 ms task

Definition at line 114 of file ftask_cfg.c.

◆ ftsk_taskDefinitionCyclic10ms

OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclic10ms
extern

Task configuration of the cyclic 10 ms task.

Cyclic 10 ms task

Definition at line 112 of file ftask_cfg.c.

◆ ftsk_taskDefinitionCyclic1ms

OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclic1ms
extern

Task configuration of the cyclic 1 ms task.

Cyclic 1 ms task

Definition at line 107 of file ftask_cfg.c.

◆ ftsk_taskDefinitionCyclicAlgorithm100ms

OS_TASK_DEFINITION_s ftsk_taskDefinitionCyclicAlgorithm100ms
extern

Task configuration of the cyclic 100 ms task for algorithms.

Cyclic 100 ms task for algorithms

Definition at line 119 of file ftask_cfg.c.

◆ ftsk_taskDefinitionEngine

OS_TASK_DEFINITION_s ftsk_taskDefinitionEngine
extern

Task configuration of the engine task.

Task for database and system monitoring

Task configuration of the engine task.

Task is not delayed after the scheduler starts. This task must have the highest priority.

Warning
Do not change the configuration of this task. This will very likely break the system.

Definition at line 105 of file ftask_cfg.c.