foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
ti_dummy_afe.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 ti_dummy_afe.c
44  * @author foxBMS Team
45  * @date 2023-09-11 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix TI
50  *
51  * @brief Configuration for the TI dummy analog front-end
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "ti_afe.h"
57 #include "ti_dummy.h"
58 
59 #include "afe_dma.h"
60 
61 #include <stdint.h>
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Static Constant and Variable Definitions =======================*/
66 
67 /*========== Extern Constant and Variable Definitions =======================*/
68 
69 /*========== Static Function Prototypes =====================================*/
70 
71 /*========== Static Function Implementations ================================*/
72 
73 /*========== Extern Function Implementations ================================*/
74 
76  return TIDUM_Measure();
77 }
78 
80  return TIDUM_Initialize();
81 }
82 
83 extern STD_RETURN_TYPE_e TI_RequestEepromRead(uint8_t string) {
84  FAS_ASSERT(string < BS_NR_OF_STRINGS);
85  return TIDUM_RequestEepromRead(string);
86 }
87 
88 extern STD_RETURN_TYPE_e TI_RequestEepromWrite(uint8_t string) {
89  FAS_ASSERT(string < BS_NR_OF_STRINGS);
90  return TIDUM_RequestEepromWrite(string);
91 }
92 
94  FAS_ASSERT(string < BS_NR_OF_STRINGS);
95  return TIDUM_RequestTemperatureRead(string);
96 }
97 
99  FAS_ASSERT(string < BS_NR_OF_STRINGS);
100  return TIDUM_RequestBalancingFeedbackRead(string);
101 }
102 
104  FAS_ASSERT(string < BS_NR_OF_STRINGS);
105  return TIDUM_RequestOpenWireCheck(string);
106 }
107 
109  return TIDUM_StartMeasurement();
110 }
111 
114 }
115 
116 extern STD_RETURN_TYPE_e TI_RequestIoRead(uint8_t string) {
117  FAS_ASSERT(string < BS_NR_OF_STRINGS);
118  return TIDUM_RequestIoRead(string);
119 }
120 
122  FAS_ASSERT(string < BS_NR_OF_STRINGS);
123  return TIDUM_RequestIoWrite(string);
124 }
125 
126 /*========== Externalized Static Function Implementations (Unit Test) =======*/
127 #ifdef UNITY_UNIT_TEST
128 #endif
Headers for the driver for the general DMA module of monitoring ICs.
#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:255
STD_RETURN_TYPE_e
Definition: fstd_types.h:82
AFE driver wrapper layer for TI ICs.
STD_RETURN_TYPE_e TIDUM_RequestEepromRead(uint8_t string)
Definition: ti_dummy.c:82
STD_RETURN_TYPE_e TIDUM_RequestTemperatureRead(uint8_t string)
Definition: ti_dummy.c:92
STD_RETURN_TYPE_e TIDUM_RequestBalancingFeedbackRead(uint8_t string)
Definition: ti_dummy.c:97
STD_RETURN_TYPE_e TIDUM_StartMeasurement(void)
Definition: ti_dummy.c:107
bool TIDUM_IsFirstMeasurementCycleFinished(void)
Definition: ti_dummy.c:111
STD_RETURN_TYPE_e TIDUM_RequestIoWrite(uint8_t string)
Definition: ti_dummy.c:120
STD_RETURN_TYPE_e TIDUM_RequestIoRead(uint8_t string)
Definition: ti_dummy.c:115
STD_RETURN_TYPE_e TIDUM_Initialize(void)
Definition: ti_dummy.c:78
STD_RETURN_TYPE_e TIDUM_RequestEepromWrite(uint8_t string)
Definition: ti_dummy.c:87
STD_RETURN_TYPE_e TIDUM_Measure(void)
Definition: ti_dummy.c:74
STD_RETURN_TYPE_e TIDUM_RequestOpenWireCheck(uint8_t string)
Definition: ti_dummy.c:102
Configuration for the TI dummy analog front-end.
STD_RETURN_TYPE_e TI_RequestOpenWireCheck(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:103
STD_RETURN_TYPE_e TI_StartMeasurement(void)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:108
STD_RETURN_TYPE_e TI_RequestIoWrite(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:121
STD_RETURN_TYPE_e TI_RequestTemperatureRead(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:93
STD_RETURN_TYPE_e TI_RequestIoRead(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:116
bool TI_IsFirstMeasurementCycleFinished(void)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:112
STD_RETURN_TYPE_e TI_RequestBalancingFeedbackRead(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:98
STD_RETURN_TYPE_e TI_RequestEepromRead(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:83
STD_RETURN_TYPE_e TI_Initialize(void)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:79
STD_RETURN_TYPE_e TI_Measure(void)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:75
STD_RETURN_TYPE_e TI_RequestEepromWrite(uint8_t string)
This function is used to wrap the TI AFE measurement API to the generic AFE measurement API.
Definition: ti_dummy_afe.c:88