foxBMS  1.3.0
The foxBMS Battery Management System API Documentation
ltc_afe.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, 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 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVER
49  * @prefix AFE
50  *
51  * @brief AFE driver implementation for LTC ICs
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "general.h"
56 /* clang-format off */
57 #include "afe.h"
58 /* clang-format on */
59 #include "ltc.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Static Constant and Variable Definitions =======================*/
64 
65 /*========== Extern Constant and Variable Definitions =======================*/
66 
67 /*========== Static Function Prototypes =====================================*/
68 
69 /*========== Static Function Implementations ================================*/
70 
71 /*========== Extern Function Implementations ================================*/
72 
75  return STD_OK;
76 }
77 
80  return STD_OK;
81 }
82 
83 extern STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string) {
84  FAS_ASSERT(string < BS_NR_OF_STRINGS);
85  STD_RETURN_TYPE_e retval = STD_OK;
86  LTC_REQUEST_s statereq = {.request = LTC_STATE_EEPROM_READ_REQUEST, .string = string};
87 
88  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
89  retval = STD_NOT_OK;
90  }
91  return retval;
92 }
93 
94 extern STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string) {
95  FAS_ASSERT(string < BS_NR_OF_STRINGS);
96  STD_RETURN_TYPE_e retval = STD_OK;
97  LTC_REQUEST_s statereq = {.request = LTC_STATE_EEPROM_WRITE_REQUEST, .string = string};
98 
99  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
100  retval = STD_NOT_OK;
101  }
102  return retval;
103 }
104 
106  FAS_ASSERT(string < BS_NR_OF_STRINGS);
107  STD_RETURN_TYPE_e retval = STD_OK;
108  LTC_REQUEST_s statereq = {.request = LTC_STATE_TEMP_SENS_READ_REQUEST, .string = string};
109 
110  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
111  retval = STD_NOT_OK;
112  }
113  return retval;
114 }
115 
117  FAS_ASSERT(string < BS_NR_OF_STRINGS);
118  STD_RETURN_TYPE_e retval = STD_NOT_OK;
119  LTC_REQUEST_s statereq = {.request = LTC_STATE_BALANCEFEEDBACK_REQUEST, .string = string};
120 
121  if (LTC_SetStateRequest(&ltc_stateBase, statereq) == LTC_OK) {
122  retval = STD_OK;
123  }
124 
125  return retval;
126 }
127 
129  FAS_ASSERT(string < BS_NR_OF_STRINGS);
130  STD_RETURN_TYPE_e retval = STD_OK;
131  LTC_REQUEST_s statereq = {.request = LTC_STATE_OPENWIRE_CHECK_REQUEST, .string = string};
132 
133  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
134  retval = STD_NOT_OK;
135  }
136  return retval;
137 }
138 
140  STD_RETURN_TYPE_e retval = STD_OK;
141  LTC_REQUEST_s statereq = {.request = LTC_STATE_INIT_REQUEST, .string = 0x0u};
142 
143  if (LTC_SetStateRequest(&ltc_stateBase, statereq) != LTC_OK) {
144  retval = STD_NOT_OK;
145  }
146  return retval;
147 }
148 
151 }
152 
153 extern STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string) {
154  FAS_ASSERT(string < BS_NR_OF_STRINGS);
155 
156  STD_RETURN_TYPE_e retval = STD_NOT_OK;
157 
158  return (retval);
159 }
160 
162  FAS_ASSERT(string < BS_NR_OF_STRINGS);
163 
164  STD_RETURN_TYPE_e retval = STD_NOT_OK;
165 
166  return (retval);
167 }
168 
169 /*========== Externalized Static Function Implementations (Unit Test) =======*/
AFE driver header.
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:241
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
@ STD_NOT_OK
Definition: fstd_types.h:83
@ STD_OK
Definition: fstd_types.h:82
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:1729
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:599
void LTC_InitializeMonitoringPin(void)
Sets the transceiver pins to enable LTC6820 IC.
Definition: ltc_6806.c:1748
LTC_STATE_s ltc_stateBase
Definition: ltc_6806.c:137
void LTC_Trigger(LTC_STATE_s *ltc_state)
trigger function for the LTC driver state machine.
Definition: ltc_6806.c:614
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:83
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:94
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:153
STD_RETURN_TYPE_e AFE_TriggerIc(void)
Definition: ltc_afe.c:73
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:128
bool AFE_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
Definition: ltc_afe.c:149
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:116
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:105
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:161
STD_RETURN_TYPE_e AFE_Initialize(void)
Definition: ltc_afe.c:78
STD_RETURN_TYPE_e AFE_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
Definition: ltc_afe.c:139
@ LTC_STATE_EEPROM_READ_REQUEST
Definition: ltc_defs.h:371
@ LTC_STATE_INIT_REQUEST
Definition: ltc_defs.h:365
@ LTC_STATE_EEPROM_WRITE_REQUEST
Definition: ltc_defs.h:372
@ LTC_STATE_OPENWIRE_CHECK_REQUEST
Definition: ltc_defs.h:387
@ LTC_STATE_BALANCEFEEDBACK_REQUEST
Definition: ltc_defs.h:375
@ LTC_STATE_TEMP_SENS_READ_REQUEST
Definition: ltc_defs.h:374
@ LTC_OK
Definition: ltc_defs.h:398
LTC_STATE_REQUEST_e request
Definition: ltc_defs.h:513