foxBMS - Unit Tests
1.2.1
The foxBMS Unit Tests API Documentation
|
Implementation of the tasks and resources used by the system. More...
Go to the source code of this file.
Functions | |
void | OS_InitializeOperatingSystem (void) |
Initialization the RTOS interface. More... | |
void | OS_IncrementTimer (void) |
Increments the system timer os_timer. More... | |
bool | OS_CheckTimeHasPassedWithTimestamp (uint32_t oldTimeStamp_ms, uint32_t currentTimeStamp_ms, uint32_t timeToPass_ms) |
This function checks if timeToPass has passed since the last timestamp to now. More... | |
bool | OS_CheckTimeHasPassed (uint32_t oldTimeStamp_ms, uint32_t timeToPass_ms) |
This function checks if timeToPass has passed since the last timestamp to now. More... | |
STD_RETURN_TYPE_e | OS_CheckTimeHasPassedSelfTest (void) |
Does a self check if the OS_CheckTimeHasPassedWithTimestamp works as expected. More... | |
OS_TIMER_s * | TEST_OS_GetOsTimer () |
Variables | |
static OS_TIMER_s | os_timer = {0u, 0u, 0u, 0u, 0u, 0u, 0u} |
volatile OS_BOOT_STATE_e | os_boot = OS_OFF |
uint32_t | os_schedulerStartTime = 0u |
Scheduler "zero" time for task phase control. More... | |
Implementation of the tasks and resources used by the system.
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:
Definition in file os.c.
bool OS_CheckTimeHasPassed | ( | uint32_t | oldTimeStamp_ms, |
uint32_t | timeToPass_ms | ||
) |
This function checks if timeToPass has passed since the last timestamp to now.
This function retrieves the current time stamp with OS_GetTickCount(), compares it to the oldTimestamp_ms and checks if more or equal of timetoPass_ms timer increments have passed.
[in] | oldTimeStamp_ms | timestamp that shall be compared to the current time in ms |
[in] | timeToPass_ms | timer increments (in ms) that shall pass between oldTimeStamp_ms and now |
Definition at line 140 of file os.c.
STD_RETURN_TYPE_e OS_CheckTimeHasPassedSelfTest | ( | void | ) |
Does a self check if the OS_CheckTimeHasPassedWithTimestamp works as expected.
This functions tests some values with OS_CheckTimeHasPassedWithTimestamp(). It is intended to be side-effect free and to be callable any time to verify from the running program if this portion of the software is working as expected. returns STD_OK if the self check passes successfully, STD_NOT_OK otherwise
Definition at line 144 of file os.c.
bool OS_CheckTimeHasPassedWithTimestamp | ( | uint32_t | oldTimeStamp_ms, |
uint32_t | currentTimeStamp_ms, | ||
uint32_t | timeToPass_ms | ||
) |
This function checks if timeToPass has passed since the last timestamp to now.
This function is passed the current time stamp as argument currentTimeStamp_ms, compares it to the oldTimestamp_ms and checks if more or equal of timetoPass_ms timer increments have passed.
[in] | oldTimeStamp_ms | timestamp that shall be compared to the current time in ms |
[in] | currentTimeStamp_ms | timestamp of the current time in ms |
[in] | timeToPass_ms | timer increments (in ms) that shall pass between oldTimeStamp_ms and now |
void OS_IncrementTimer | ( | void | ) |
void OS_InitializeOperatingSystem | ( | void | ) |
OS_TIMER_s* TEST_OS_GetOsTimer | ( | ) |
volatile OS_BOOT_STATE_e os_boot = OS_OFF |
uint32_t os_schedulerStartTime = 0u |
|
static |