foxBMS - Unit Tests
1.5.0
The foxBMS Unit Tests API Documentation
|
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>
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_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_afeRequestQueue |
OS_QUEUE | ftsk_rtcSetTimeQueue |
OS_QUEUE | ftsk_afeToI2cQueue |
OS_QUEUE | ftsk_afeFromI2cQueue |
volatile bool | ftsk_allQueuesCreated |
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:
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:
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.
#define FTSK_AFE_REQUEST_QUEUE_ITEM_SIZE (sizeof(AFE_REQUEST_e)) |
#define FTSK_AFEI2C_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(AFE_I2C_QUEUE_s)) |
#define FTSK_AFEI2C_QUEUE_LENGTH (1u) |
#define FTSK_CAN_RX_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s)) |
#define FTSK_CAN_RX_QUEUE_LENGTH (50u) |
#define FTSK_DATABASE_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(DATA_QUEUE_MESSAGE_s)) |
#define FTSK_DATABASE_QUEUE_LENGTH (1u) |
#define FTSK_IMD_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(CAN_BUFFER_ELEMENT_s)) |
#define FTSK_IMD_QUEUE_LENGTH (5u) |
#define FTSK_RTC_QUEUE_ITEM_SIZE_IN_BYTES (sizeof(RTC_TIME_DATA_s)) |
#define FTSK_RTC_QUEUE_LENGTH (1u) |
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 130 of file ftask_freertos.c.
void FTSK_CreateTaskAfe | ( | void *const | pvParameters | ) |
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).
pvParameters | parameter for the to task |
Definition at line 159 of file ftask.c.
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).
pvParameters | parameter for the to task |
Definition at line 130 of file ftask.c.
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).
pvParameters | parameter for the to task |
Definition at line 98 of file ftask.c.
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).
pvParameters | parameter for the to task |
Definition at line 188 of file ftask.c.
void FTSK_CreateTaskEngine | ( | void *const | pvParameters | ) |
void FTSK_CreateTaskI2c | ( | void *const | pvParameters | ) |
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 231 of file ftask_freertos.c.
|
extern |
Definition at line 122 of file ftask_freertos.c.
|
extern |
handle of the AFE driver request queue
Definition at line 118 of file ftask_freertos.c.
|
extern |
handle of the I2C transmission over NXP slave queue
Definition at line 121 of file ftask_freertos.c.
|
extern |
indicator whether the queues have successfully been initialized to be used in other parts of the software
Definition at line 108 of file ftask_freertos.c.
|
extern |
CAN driver data queue for RX messages
Definition at line 115 of file ftask_freertos.c.
|
extern |
database queue
Definition at line 110 of file ftask_freertos.c.
|
extern |
queue for CAN based IMD devices
Definition at line 112 of file ftask_freertos.c.
|
extern |
handle of the rtc driver data queue
Definition at line 119 of file ftask_freertos.c.