foxBMS  1.0.0
The foxBMS Battery Management System API Documentation
fassert.c File Reference

Assert macro implementation. More...

#include "fassert.h"
Include dependency graph for fassert.c:

Go to the source code of this file.

Functions

void fas_storeAssertLoc (uint32_t *pc, uint32_t line)
 Copy the assert location into the assert struct. More...
 

Variables

ASSERT_LOC_s fas_assertLocation = {0}
 Stores the information on the last assert. More...
 

Detailed Description

Assert macro implementation.

BSD 3-Clause License 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
2020-05-26 (date of creation)
Updated
2020-05-26 (date of last update)
Prefix
FAS

Implementation for the fassert.h header

Definition in file fassert.c.

Function Documentation

◆ fas_storeAssertLoc()

void fas_storeAssertLoc ( uint32_t *  pc,
uint32_t  line 
)

Copy the assert location into the assert struct.

Takes the location of the last assertion and writes it into fas_assertLocation. This definition has to be at this position in order to be used by the macros below. If you get issues in a unit test with this being not defined, try to add this header to the unit tests includes explicitely.

Parameters
[in]pcaddress of the program counter where the assertion occurred
[in]lineline where the assertion occurred

Definition at line 70 of file fassert.c.

Variable Documentation

◆ fas_assertLocation

ASSERT_LOC_s fas_assertLocation = {0}

Stores the information on the last assert.

Definition at line 63 of file fassert.c.