foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
masterinfo.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 masterinfo.h
44  * @author foxBMS Team
45  * @date 2020-07-08 (date of creation)
46  * @updated 2020-07-08 (date of last update)
47  * @ingroup GENERAL
48  * @prefix MINFO
49  *
50  * @brief General foxBMS-master system information
51  *
52  * @details Header file for the implementation to gather information on the
53  * foxBMS-Master and its connected peripherals on the master PCB.
54  *
55  */
56 
57 #ifndef FOXBMS__MASTERINFO_H_
58 #define FOXBMS__MASTERINFO_H_
59 
60 /*========== Includes =======================================================*/
61 #include "HL_system.h"
62 
63 /*========== Macros and Definitions =========================================*/
64 /** values describing the connection state of the debug probe */
66  MINFO_DEBUG_PROBE_NOT_CONNECTED, /*!< no debug probe connected */
67  MINFO_DEBUG_PROBE_CONNECTED, /*!< debug probe connected */
69 
70 /**
71  * @brief state of the system
72  * @details This currently describes the source of the last reset and whether a
73  * debug probe is attached or not.
74  */
75 typedef struct MINFO_MASTER_STATE {
76  resetSource_t resetSource; /*!< source of the last system reset */
77  MINFO_DEBUG_PROBE_CONNECTION_STATE_e debugProbe; /*!< connection state of debug probe */
79 
80 /*========== Extern Constant and Variable Declarations ======================*/
81 
82 /*========== Extern Function Prototypes =====================================*/
83 /**
84  * @brief Set reason for last reset
85  *
86  * @param[in] resetSource source of last reset
87  */
88 void MINFO_SetResetSource(resetSource_t resetSource);
89 
90 /**
91  * @brief Get reason for last reset
92  *
93  * @return returns reset reason
94  */
95 resetSource_t MINFO_GetResetSource(void);
96 
97 /**
98  * @brief Check if debug probe is connected
99  */
101 
102 /**
103  * @brief Get state if debugger is connected or not
104  *
105  * @return #MINFO_DEBUG_PROBE_CONNECTION_STATE_e if debugger connected or not
106  */
108 
109 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
110 
111 #endif /* FOXBMS__MASTERINFO_H_ */
struct MINFO_MASTER_STATE MINFO_MASTER_STATE_s
state of the system
MINFO_DEBUG_PROBE_CONNECTION_STATE_e MINFO_GetDebugProbeConnectionState(void)
Get state if debugger is connected or not.
Definition: masterinfo.c:91
resetSource_t MINFO_GetResetSource(void)
Get reason for last reset.
Definition: masterinfo.c:83
void MINFO_SetDebugProbeConnectionState(MINFO_DEBUG_PROBE_CONNECTION_STATE_e state)
Check if debug probe is connected.
Definition: masterinfo.c:87
MINFO_DEBUG_PROBE_CONNECTION_STATE
Definition: masterinfo.h:65
@ MINFO_DEBUG_PROBE_CONNECTED
Definition: masterinfo.h:67
@ MINFO_DEBUG_PROBE_NOT_CONNECTED
Definition: masterinfo.h:66
enum MINFO_DEBUG_PROBE_CONNECTION_STATE MINFO_DEBUG_PROBE_CONNECTION_STATE_e
void MINFO_SetResetSource(resetSource_t resetSource)
Set reason for last reset.
Definition: masterinfo.c:78
state of the system
Definition: masterinfo.h:75
resetSource_t resetSource
Definition: masterinfo.h:76
MINFO_DEBUG_PROBE_CONNECTION_STATE_e debugProbe
Definition: masterinfo.h:77