foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
fstd_types.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
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 */
75 
76 /*========== Extern Function Prototypes =====================================*/
77 
78 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
79 
80 #endif /* FOXBMS__FSTD_TYPES_H_ */
STD_RETURN_TYPE
Definition: fstd_types.h:71
@ STD_NOT_OK
Definition: fstd_types.h:73
@ STD_OK
Definition: fstd_types.h:72
enum STD_RETURN_TYPE STD_RETURN_TYPE_e