foxBMS  1.0.0
The foxBMS Battery Management System API Documentation
fassert.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file fassert.c
44  * @author foxBMS Team
45  * @date 2020-05-26 (date of creation)
46  * @updated 2020-05-26 (date of last update)
47  * @ingroup ASSERT
48  * @prefix FAS
49  *
50  * @brief Assert macro implementation
51  *
52  * @details Implementation for the fassert.h header
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "fassert.h"
57 
58 /*========== Macros and Definitions =========================================*/
59 
60 /*========== Static Constant and Variable Definitions =======================*/
61 
62 /*========== Extern Constant and Variable Definitions =======================*/
63 ASSERT_LOC_s fas_assertLocation = {0};
64 
65 /*========== Static Function Prototypes =====================================*/
66 
67 /*========== Static Function Implementations ================================*/
68 
69 /*========== Extern Function Implementations ================================*/
70 extern void fas_storeAssertLoc(uint32_t *pc, uint32_t line) {
71  fas_assertLocation.pc = (uint32_t *)pc;
72  /* Storing the line number is redundant if we have pc and lr.
73  It is kept nevertheless in order to make each assert call unique and
74  thus avoid optimization (which makes it more confusing). */
75  fas_assertLocation.line = (uint32_t)line;
76 }
77 
78 /*========== Externalized Static Function Implementations (Unit Test) =======*/
fassert.h
Assert macro implementation.
ASSERT_LOC::line
uint32_t line
Definition: fassert.h:117
ASSERT_LOC
Struct for storing assert information.
Definition: fassert.h:115
fas_assertLocation
ASSERT_LOC_s fas_assertLocation
Stores the information on the last assert.
Definition: fassert.c:63
ASSERT_LOC::pc
uint32_t * pc
Definition: fassert.h:116
fas_storeAssertLoc
void fas_storeAssertLoc(uint32_t *pc, uint32_t line)
Copy the assert location into the assert struct.
Definition: fassert.c:70