foxBMS  1.0.0
The foxBMS Battery Management System API Documentation
debug_default_mic.c
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 debug_default_mic.c
44  * @author foxBMS Team
45  * @date 2020-09-17 (date of creation)
46  * @updated 2020-09-17 (date of last update)
47  * @ingroup DRIVER
48  * @prefix FAKE
49  *
50  * @brief Implementation of the fake measurement IC driver
51  */
52 
53 /*========== Includes =======================================================*/
54 #include "general.h"
55 
56 #include "debug_default_mic.h"
57 
58 #include "debug_default.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 
64 /*========== Extern Constant and Variable Definitions =======================*/
65 
66 /*========== Static Function Prototypes =====================================*/
67 
68 /*========== Static Function Implementations ================================*/
69 
70 /*========== Extern Function Implementations ================================*/
73 }
74 
76  return FAKE_Initialize();
77 }
78 
80  return STD_OK;
81 }
82 
85 }
86 
87 /* this is a dummy implementation and not using the argument here is fine */
88 #pragma diag_push
89 #pragma diag_suppress 880
90 extern STD_RETURN_TYPE_e MIC_RequestIoWrite(uint8_t string) {
91  return STD_OK;
92 }
93 #pragma diag_pop
94 
95 /* this is a dummy implementation and not using the argument here is fine */
96 #pragma diag_push
97 #pragma diag_suppress 880
98 extern STD_RETURN_TYPE_e MIC_RequestIoRead(uint8_t string) {
99  return STD_OK;
100 }
101 #pragma diag_pop
102 
103 /* this is a dummy implementation and not using the argument here is fine */
104 #pragma diag_push
105 #pragma diag_suppress 880
107  return STD_OK;
108 }
109 #pragma diag_pop
110 
111 /* this is a dummy implementation and not using the argument here is fine */
112 #pragma diag_push
113 #pragma diag_suppress 880
115  return STD_OK;
116 }
117 #pragma diag_pop
118 
119 /* this is a dummy implementation and not using the argument here is fine */
120 #pragma diag_push
121 #pragma diag_suppress 880
122 extern STD_RETURN_TYPE_e MIC_RequestEepromRead(uint8_t string) {
123  return STD_OK;
124 }
125 #pragma diag_pop
126 
127 /* this is a dummy implementation and not using the argument here is fine */
128 #pragma diag_push
129 #pragma diag_suppress 880
131  return STD_OK;
132 }
133 #pragma diag_pop
134 
135 /* this is a dummy implementation and not using the argument here is fine */
136 #pragma diag_push
137 #pragma diag_suppress 880
139  return STD_OK;
140 }
141 #pragma diag_pop
142 
143 /*========== Externalized Static Function Implementations (Unit Test) =======*/
MIC_RequestBalancingFeedbackRead
STD_RETURN_TYPE_e MIC_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the MIC state machine to read balancing feedback from the slaves.
Definition: debug_default_mic.c:114
general.h
TODO.
MIC_RequestTemperatureRead
STD_RETURN_TYPE_e MIC_RequestTemperatureRead(uint8_t string)
Makes the request to the MIC state machine to read from the external temperature sensor on slaves.
Definition: debug_default_mic.c:106
MIC_IsFirstMeasurementCycleFinished
bool MIC_IsFirstMeasurementCycleFinished(void)
Checks if the first MIC measurement cycle was made.
Definition: debug_default_mic.c:83
MIC_RequestEepromWrite
STD_RETURN_TYPE_e MIC_RequestEepromWrite(uint8_t string)
Makes the request to the MIC state machine to write to the external EEPROM on slaves.
Definition: debug_default_mic.c:130
fake_state
FAKE_STATE_s fake_state
Definition: debug_default.c:114
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
MIC_RequestIoRead
STD_RETURN_TYPE_e MIC_RequestIoRead(uint8_t string)
Makes the request to the MIC state machine to read from the IO port-expander.
Definition: debug_default_mic.c:98
FAKE_TriggerMeasurementIc
STD_RETURN_TYPE_e FAKE_TriggerMeasurementIc(FAKE_STATE_s *pFakeState)
Trigger function for the driver, called to advance the state machine.
Definition: debug_default.c:527
debug_default_mic.h
Header for the driver for the fake measurement IC driver.
MIC_RequestOpenWireCheck
STD_RETURN_TYPE_e MIC_RequestOpenWireCheck(uint8_t string)
Makes the request to the MIC state machine to perform open-wire check.
Definition: debug_default_mic.c:138
FAKE_IsFirstMeasurementCycleFinished
bool FAKE_IsFirstMeasurementCycleFinished(FAKE_STATE_s *pFakeState)
return whether the first measurement cycle is finished
Definition: debug_default.c:518
STD_OK
@ STD_OK
Definition: fstd_types.h:72
MIC_RequestEepromRead
STD_RETURN_TYPE_e MIC_RequestEepromRead(uint8_t string)
Makes the request to the MIC state machine to read from the external EEPROM on slaves.
Definition: debug_default_mic.c:122
MIC_StartMeasurement
STD_RETURN_TYPE_e MIC_StartMeasurement(void)
Makes the initialization request to the MIC state machine.
Definition: debug_default_mic.c:79
MIC_Init
STD_RETURN_TYPE_e MIC_Init(void)
Definition: debug_default_mic.c:75
MIC_RequestIoWrite
STD_RETURN_TYPE_e MIC_RequestIoWrite(uint8_t string)
Makes the request to the MIC state machine to write to the IO port-expander.
Definition: debug_default_mic.c:90
debug_default.h
Header for the driver of the fake measurement IC driver.
FAKE_Initialize
STD_RETURN_TYPE_e FAKE_Initialize(void)
initialize driver
Definition: debug_default.c:514
MIC_TriggerIc
STD_RETURN_TYPE_e MIC_TriggerIc(void)
Definition: debug_default_mic.c:71