foxBMS - Unit Tests  1.2.1
The foxBMS Unit Tests API Documentation
ltc_afe.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 ltc_afe.c
44  * @author foxBMS Team
45  * @date 2020-05-08 (date of creation)
46  * @updated 2021-03-24 (date of last update)
47  * @ingroup DRIVER
48  * @prefix AFE
49  *
50  * @brief AFE driver implementation for LTC ICs
51  */
52 
53 /*========== Includes =======================================================*/
54 #include "general.h"
55 /* clang-format off */
56 #include "afe.h"
57 /* clang-format on */
58 #include "ltc.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 ================================*/
71 
74  return STD_OK;
75 }
76 
79  return STD_OK;
80 }
81 
82 extern STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string) {
83  FAS_ASSERT(string < BS_NR_OF_STRINGS);
84  STD_RETURN_TYPE_e retval = STD_OK;
85  LTC_REQUEST_s statereq = {.request = LTC_STATE_EEPROM_READ_REQUEST, .string = string};
86 
87  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
88  retval = STD_NOT_OK;
89  }
90  return retval;
91 }
92 
93 extern STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string) {
94  FAS_ASSERT(string < BS_NR_OF_STRINGS);
95  STD_RETURN_TYPE_e retval = STD_OK;
96  LTC_REQUEST_s statereq = {.request = LTC_STATE_EEPROM_WRITE_REQUEST, .string = string};
97 
98  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
99  retval = STD_NOT_OK;
100  }
101  return retval;
102 }
103 
105  FAS_ASSERT(string < BS_NR_OF_STRINGS);
106  STD_RETURN_TYPE_e retval = STD_OK;
107  LTC_REQUEST_s statereq = {.request = LTC_STATE_TEMP_SENS_READ_REQUEST, .string = string};
108 
109  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
110  retval = STD_NOT_OK;
111  }
112  return retval;
113 }
114 
116  FAS_ASSERT(string < BS_NR_OF_STRINGS);
117  STD_RETURN_TYPE_e retval = STD_NOT_OK;
118  LTC_REQUEST_s statereq = {.request = LTC_STATE_BALANCEFEEDBACK_REQUEST, .string = string};
119 
120  if (LTC_SetStateRequest(&ltc_stateBase, statereq) == LTC_OK) {
121  retval = STD_OK;
122  }
123 
124  return retval;
125 }
126 
128  FAS_ASSERT(string < BS_NR_OF_STRINGS);
129  STD_RETURN_TYPE_e retval = STD_OK;
130  LTC_REQUEST_s statereq = {.request = LTC_STATE_OPENWIRE_CHECK_REQUEST, .string = string};
131 
132  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
133  retval = STD_NOT_OK;
134  }
135  return retval;
136 }
137 
139  STD_RETURN_TYPE_e retval = STD_OK;
140  LTC_REQUEST_s statereq = {.request = LTC_STATE_INIT_REQUEST, .string = 0x0u};
141 
142  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
143  retval = STD_NOT_OK;
144  }
145  return retval;
146 }
147 
150 }
151 
152 extern STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string) {
153  FAS_ASSERT(string < BS_NR_OF_STRINGS);
154 
155  STD_RETURN_TYPE_e retval = STD_NOT_OK;
156 
157  return (retval);
158 }
159 
161  FAS_ASSERT(string < BS_NR_OF_STRINGS);
162 
163  STD_RETURN_TYPE_e retval = STD_NOT_OK;
164 
165  return (retval);
166 }
167 
168 /*========== Externalized Static Function Implementations (Unit Test) =======*/
AFE driver header.
#define BS_NR_OF_STRINGS
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:235
@ STD_NOT_OK
Definition: fstd_types.h:82
@ STD_OK
Definition: fstd_types.h:81
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
General macros and definitions for the whole platform.
Headers for the driver for the LTC monitoring chip.
bool LTC_IsFirstMeasurementCycleFinished(LTC_STATE_s *ltc_state)
gets the measurement initialization status.
Definition: ltc_6806.c:1719
LTC_RETURN_TYPE_e LTC_SetStateRequest(LTC_STATE_s *ltc_state, LTC_REQUEST_s statereq)
sets the current state request of the state variable ltc_state.
Definition: ltc_6806.c:596
LTC_STATE_s ltc_stateBase
Definition: ltc_6806.c:134
void LTC_Trigger(LTC_STATE_s *ltc_state)
trigger function for the LTC driver state machine.
Definition: ltc_6806.c:611
void LTC_monitoringPinInit(void)
Sets the transceiver pins to enable LTC6820 IC.
Definition: ltc_6806.c:1738
STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string)
Makes the request to the AFE state machine to read from the external EEPROM on slaves.
Definition: ltc_afe.c:82
STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string)
Makes the request to the AFE state machine to write to the external EEPROM on slaves.
Definition: ltc_afe.c:93
STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string)
Makes the request to the AFE state machine to read from the IO port-expander.
Definition: ltc_afe.c:152
STD_RETURN_TYPE_e AFE_TriggerIc(void)
Definition: ltc_afe.c:72
STD_RETURN_TYPE_e AFE_RequestOpenWireCheck(uint8_t string)
Makes the request to the AFE state machine to perform open-wire check.
Definition: ltc_afe.c:127
bool AFE_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
Definition: ltc_afe.c:148
STD_RETURN_TYPE_e AFE_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the AFE state machine to read balancing feedback from the slaves.
Definition: ltc_afe.c:115
STD_RETURN_TYPE_e AFE_RequestTemperatureRead(uint8_t string)
Makes the request to the AFE state machine to read from the external temperature sensor on slaves.
Definition: ltc_afe.c:104
STD_RETURN_TYPE_e AFE_RequestIoWrite(uint8_t string)
Makes the request to the AFE state machine to write to the IO port-expander.
Definition: ltc_afe.c:160
STD_RETURN_TYPE_e AFE_Initialize(void)
Definition: ltc_afe.c:77
STD_RETURN_TYPE_e AFE_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
Definition: ltc_afe.c:138
@ LTC_STATE_EEPROM_READ_REQUEST
Definition: ltc_defs.h:370
@ LTC_STATE_INIT_REQUEST
Definition: ltc_defs.h:364
@ LTC_STATE_EEPROM_WRITE_REQUEST
Definition: ltc_defs.h:371
@ LTC_STATE_OPENWIRE_CHECK_REQUEST
Definition: ltc_defs.h:386
@ LTC_STATE_BALANCEFEEDBACK_REQUEST
Definition: ltc_defs.h:374
@ LTC_STATE_TEMP_SENS_READ_REQUEST
Definition: ltc_defs.h:373
@ LTC_OK
Definition: ltc_defs.h:397
LTC_STATE_REQUEST_e request
Definition: ltc_defs.h:512