foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
fstd_types.h
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 fstd_types.h
44  * @author foxBMS Team
45  * @date 2015-12-20 (date of creation)
46  * @updated 2020-04-02 (date of last update)
47  * @ingroup GENERAL_CONF
48  * @prefix STD
49  *
50  * @brief Definition of foxBMS standard types
51  */
52 
53 #ifndef FOXBMS__FSTD_TYPES_H_
54 #define FOXBMS__FSTD_TYPES_H_
55 
56 /*========== Includes =======================================================*/
57 
58 /*========== Macros and Definitions =========================================*/
59 /**
60  * @def NULL_PTR
61  * @brief Null pointer
62  * @details This define describes a null pointer. Use it to compare for null
63  * pointer access.
64  */
65 #ifndef NULL_PTR
66 #define NULL_PTR ((void *)(0))
67 #endif
68 
69 /*========== Extern Constant and Variable Declarations ======================*/
70 /** enum for standard return type */
71 typedef enum STD_RETURN_TYPE {
72  STD_OK, /**< ok */
73  STD_NOT_OK, /**< not ok */
74 } STD_RETURN_TYPE_e;
75 
76 /*========== Extern Function Prototypes =====================================*/
77 
78 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
79 
80 #endif /* FOXBMS__FSTD_TYPES_H_ */
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
STD_OK
@ STD_OK
Definition: fstd_types.h:72
STD_NOT_OK
@ STD_NOT_OK
Definition: fstd_types.h:73
STD_RETURN_TYPE
STD_RETURN_TYPE
Definition: fstd_types.h:71