foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
masterinfo.c
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.c
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 This file contains the implementation to gather information on the
53  * foxBMS-Master and its connected peripherals on the master PCB.
54  *
55  */
56 
57 /*========== Includes =======================================================*/
58 #include "masterinfo.h"
59 
60 #include "fassert.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Static Constant and Variable Definitions =======================*/
65 /** variable that tracks the state of the system */
67  .resetSource = NO_RESET,
68  .debugProbe = MINFO_DEBUG_PROBE_NOT_CONNECTED,
69 };
70 
71 /*========== Extern Constant and Variable Definitions =======================*/
72 
73 /*========== Static Function Prototypes =====================================*/
74 
75 /*========== Static Function Implementations ================================*/
76 
77 /*========== Extern Function Implementations ================================*/
78 void MINFO_SetResetSource(resetSource_t resetSource) {
79  /* Set system reset source */
80  minfo_state.resetSource = resetSource;
81 }
82 
83 resetSource_t MINFO_GetResetSource(void) {
84  return minfo_state.resetSource;
85 }
86 
88  minfo_state.debugProbe = state;
89 }
90 
92  return minfo_state.debugProbe;
93 }
94 
95 /*========== Externalized Static Function Implementations (Unit Test) =======*/
Assert macro implementation.
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
static MINFO_MASTER_STATE_s minfo_state
Definition: masterinfo.c:66
void MINFO_SetResetSource(resetSource_t resetSource)
Set reason for last reset.
Definition: masterinfo.c:78
General foxBMS-master system information.
@ MINFO_DEBUG_PROBE_NOT_CONNECTED
Definition: masterinfo.h:66
enum MINFO_DEBUG_PROBE_CONNECTION_STATE MINFO_DEBUG_PROBE_CONNECTION_STATE_e
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