foxBMS - Unit Tests
1.2.1
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 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 2021-11-09 (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
61
* @brief NULL definition
62
* @details This define describes a null. Use it to compare against null.
63
*/
64
#ifndef NULL
65
#define NULL ((void *)0u)
66
#endif
67
68
/**
69
* @def NULL_PTR
70
* @brief Null pointer
71
* @details This define describes a null pointer. Use it to compare for null
72
* pointer access.
73
*/
74
#ifndef NULL_PTR
75
#define NULL_PTR ((void *)(0u))
76
#endif
77
78
/*========== Extern Constant and Variable Declarations ======================*/
79
/** enum for standard return type */
80
typedef
enum
STD_RETURN_TYPE
{
81
STD_OK
,
/**< ok */
82
STD_NOT_OK
,
/**< not ok */
83
}
STD_RETURN_TYPE_e
;
84
85
/** enum for pin state */
86
typedef
enum
STD_PIN_STATE
{
87
STD_PIN_LOW
,
/*!< electrical pin state: low */
88
STD_PIN_HIGH
,
/*!< electrical pin state: high */
89
STD_PIN_UNDEFINED
,
/*!< electrical pin state: undefined */
90
}
STD_PIN_STATE_e
;
91
92
/*========== Extern Function Prototypes =====================================*/
93
94
/*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
95
96
#endif
/* FOXBMS__FSTD_TYPES_H_ */
STD_PIN_STATE
STD_PIN_STATE
Definition:
fstd_types.h:86
STD_PIN_UNDEFINED
@ STD_PIN_UNDEFINED
Definition:
fstd_types.h:89
STD_PIN_LOW
@ STD_PIN_LOW
Definition:
fstd_types.h:87
STD_PIN_HIGH
@ STD_PIN_HIGH
Definition:
fstd_types.h:88
STD_RETURN_TYPE
STD_RETURN_TYPE
Definition:
fstd_types.h:80
STD_NOT_OK
@ STD_NOT_OK
Definition:
fstd_types.h:82
STD_OK
@ STD_OK
Definition:
fstd_types.h:81
STD_PIN_STATE_e
enum STD_PIN_STATE STD_PIN_STATE_e
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
src
app
main
include
fstd_types.h
Generated by
1.9.1