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

Header of task driver implementation. More...

#include "ftask_cfg.h"
#include "FreeRTOS.h"
#include "queue.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.

Functions

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

Variables

QueueHandle_t ftsk_databaseQueue
 
QueueHandle_t ftsk_imdCanDataQueue
 
QueueHandle_t 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-07-23 (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.

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 340 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 363 of file ftask.c.

Here is the call graph for this function:

Variable Documentation

◆ ftsk_allQueuesCreated

volatile bool ftsk_allQueuesCreated
extern

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

Definition at line 166 of file ftask.c.

◆ ftsk_canRxQueue

QueueHandle_t ftsk_canRxQueue
extern

handle of the can driver data queue

Definition at line 173 of file ftask.c.

◆ ftsk_databaseQueue

QueueHandle_t ftsk_databaseQueue
extern

handle of the database queue

Definition at line 168 of file ftask.c.

◆ ftsk_imdCanDataQueue

QueueHandle_t ftsk_imdCanDataQueue
extern

handle of the imd can data queue

Definition at line 170 of file ftask.c.