foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
adc.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 adc.c
44  * @author foxBMS Team
45  * @date 2019-01-07 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVERS
49  * @prefix ADC
50  *
51  * @brief Driver for the ADC module.
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "adc.h"
57 
58 #include "database.h"
59 
60 #include <math.h>
61 #include <stdbool.h>
62 #include <stdint.h>
63 
64 /*========== Macros and Definitions =========================================*/
65 
66 /*========== Static Constant and Variable Definitions =======================*/
67 
68 /**
69  * @brief describes the current state of the conversion
70  * @details This variable is used as a state-variable for switching through the
71  * steps of a conversion.
72  */
74 
76 
78 
79 /*========== Extern Constant and Variable Definitions =======================*/
80 
81 /*========== Static Function Prototypes =====================================*/
82 
83 /**
84  * @brief converts reading from ADC to a voltage in mV.
85  * @param adcCounts digital value read by ADC
86  * @return voltage in mV
87  */
88 static float_t ADC_ConvertVoltage(uint16_t adcCounts);
89 
90 /*========== Static Function Implementations ================================*/
91 
92 static float_t ADC_ConvertVoltage(uint16_t adcCounts) {
93  /* AXIVION Routine Generic-MissingParameterAssert: adcValue_mV: parameter accepts whole range */
94 
95  /** For details to equation see Equation 28 in Technical Reference Manual SPNU563A - March 2018 page 852 */
96  float_t result_mV = (((adcCounts + ADC_CONV_OFFSET) * (ADC_VREFHIGH_mV - ADC_VREFLOW_mV)) / ADC_CONV_FACTOR_12BIT) +
98 
99  return result_mV;
100 }
101 
102 /*========== Extern Function Implementations ================================*/
103 
104 extern void ADC_Control(void) {
105  bool conversionFinished = true;
106 
107  switch (adc_conversionState) {
109  adcStartConversion(adcREG1, adcGROUP1);
111  break;
112 
114  conversionFinished = true;
115  if (ADC_CONVERSION_ENDDBIT != adcIsConversionComplete(adcREG1, adcGROUP1)) {
116  conversionFinished = false;
117  }
118  if (conversionFinished == true) {
120  }
121  break;
122 
123  /* Start initialization procedure, data sheet figure 106 page 79 */
125  adcGetData(adcREG1, adcGROUP1, &adc_adc1RawVoltages[0]);
126  for (uint8_t i = 0u; i < MCU_ADC1_MAX_NR_CHANNELS; i++) {
128  }
131  break;
132 
133  default:
134  /* invalid state */
136  break;
137  }
138 }
139 
140 /*========== Externalized Static Function Implementations (Unit Test) =======*/
141 #ifdef UNITY_UNIT_TEST
142 #endif
static ADC_STATE_e adc_conversionState
describes the current state of the conversion
Definition: adc.c:73
void ADC_Control(void)
controls ADC measurement sequence.
Definition: adc.c:104
static adcData_t adc_adc1RawVoltages[MCU_ADC1_MAX_NR_CHANNELS]
Definition: adc.c:75
static DATA_BLOCK_ADC_VOLTAGE_s adc_adc1Voltages
Definition: adc.c:77
static float_t ADC_ConvertVoltage(uint16_t adcCounts)
converts reading from ADC to a voltage in mV.
Definition: adc.c:92
Headers for the driver for the ADC module.
#define ADC_VREFLOW_mV
Definition: adc.h:71
ADC_STATE_e
Definition: adc.h:85
@ ADC_WAIT_CONVERSION_FINISHED
Definition: adc.h:87
@ ADC_START_CONVERSION
Definition: adc.h:86
@ ADC_CONVERSION_FINISHED
Definition: adc.h:88
#define ADC_VREFHIGH_mV
Definition: adc.h:69
#define ADC_CONV_OFFSET
Definition: adc.h:77
#define ADC_CONVERSION_ENDDBIT
Definition: adc.h:80
#define ADC_CONV_FACTOR_12BIT
Definition: adc.h:73
Database module header.
#define DATA_WRITE_DATA(...)
Definition: database.h:96
@ DATA_BLOCK_ID_ADC_VOLTAGE
Definition: database_cfg.h:110
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:250
#define FAS_TRAP
Define that evaluates to essential boolean false thus tripping an assert.
Definition: fassert.h:129
#define MCU_ADC1_MAX_NR_CHANNELS
maximum number of channels measured by the ADC1
Definition: mcu.h:75
DATA_BLOCK_HEADER_s header
Definition: database_cfg.h:593
float_t adc1ConvertedVoltages_mV[MCU_ADC1_MAX_NR_CHANNELS]
Definition: database_cfg.h:594
DATA_BLOCK_ID_e uniqueId
Definition: database_cfg.h:122