-
Notifications
You must be signed in to change notification settings - Fork 38
/
hal_ll_adc.h
227 lines (208 loc) · 6.86 KB
/
hal_ll_adc.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
/*!
* @file hal_ll_adc.h
* @brief This file contains all the functions prototypes for the ADC library.
*/
#ifndef _HAL_LL_ADC_H_
#define _HAL_LL_ADC_H_
#ifdef __cplusplus
extern "C"{
#endif
#include "hal_ll_target.h"
#include "hal_ll_rcu.h"
#define HAL_ADC_6BIT_RES_VAL 0x003FU
#define HAL_ADC_8BIT_RES_VAL 0x00FFU
#define HAL_ADC_10BIT_RES_VAL 0x03FFU
#define HAL_ADC_12BIT_RES_VAL 0x0FFFU
#define HAL_ADC_14BIT_RES_VAL 0x3FFFU
#define HAL_ADC_16BIT_RES_VAL 0xFFFFU
/**
* @brief ADC low level handle.
*
* The context for storing low level object handler.
* User is not to change these values or unexpected behaviour
* may occur.
*/
typedef struct
{
handle_t *hal_ll_adc_handle;
handle_t *hal_drv_adc_handle;
bool init_ll_state;
} hal_ll_adc_handle_register_t;
/**
* ADC VREF.
*/
typedef enum
{
HAL_LL_ADC_VREF_EXTERNAL = 0,
HAL_LL_ADC_VREF_DEFAULT = HAL_LL_ADC_VREF_EXTERNAL
} hal_ll_adc_voltage_reference_t;
/**
* ADC resolution.
*/
typedef enum
{
HAL_LL_ADC_RESOLUTION_NOT_SET = 0,
HAL_LL_ADC_RESOLUTION_6_BIT, /**< 6 bit resolution */
HAL_LL_ADC_RESOLUTION_8_BIT, /**< 8 bit resolution */
HAL_LL_ADC_RESOLUTION_10_BIT, /**< 10 bit resolution */
HAL_LL_ADC_RESOLUTION_12_BIT, /**< 12 bit resolution */
HAL_LL_ADC_RESOLUTION_14_BIT, /**< 14 bit resolution */
HAL_LL_ADC_RESOLUTION_16_BIT, /**< 16 bit resolution */
/*!< Default resolution. */
HAL_LL_ADC_RESOLUTION_DEFAULT = HAL_LL_ADC_RESOLUTION_CMAKE
} hal_ll_adc_resolution_t;
/**
* @brief ADC low level specific structure.
*
* User is not to change these values or unexpected behaviour
* may occur.
*/
typedef struct
{
hal_ll_base_addr_t base;
uint8_t module_index;
hal_ll_pin_name_t pin;
hal_ll_adc_voltage_reference_t vref_input;
float vref_value;
uint32_t resolution;
uint8_t channel;
} hal_ll_adc_hw_specifics_map_t;
/**
* @brief Configures specified module.
*
* Performs module configuration on the hardware
* level.
*
* @param[in] *handle HAL context object handle.
*
* @return hal_ll_err_t Module specific error.
*
* Returns one of pre-defined values.
* Take into consideration that this is hardware specific.
*/
hal_ll_err_t hal_ll_module_configure_adc( handle_t *handle );
/**
* @brief Registers handler for future use.
*
* Registers low level and hal level handlers
* for use with appropriate functions.
*
* @param[in] *handle HAL context object handle.
* @param[in] pin Analog input pin.
* @param[in] vref_input Voltage reference source.
* @param[in] resolution Analog data resolution.
* @param[in] *handle_map HAL layer local handle map.
* @param[in] *hal_module_id HAL layer module number.
* @return hal_ll_err_t Module specific error.
*
* Returns one of pre-defined error values.
* Take into consideration that this is hardware specific.
*/
hal_ll_err_t hal_ll_adc_register_handle(hal_ll_pin_name_t pin, hal_ll_adc_voltage_reference_t vref_input, hal_ll_adc_resolution_t resolution, hal_ll_adc_handle_register_t *handle_map, uint8_t *hal_module_id);
/**
* @brief Sets ADC resolution.
*
* Sets specified ADC resolution for module.
* Take into consideration that the module
* will be re-initialized on the hardware level.
*
* @param[in] *handle HAL context object handle.
* @param[in] resolution ADC resolution.
*
* @return hal_ll_err_t Module specific error or success.
*/
hal_ll_err_t hal_ll_adc_set_resolution(handle_t *handle, hal_ll_adc_resolution_t resolution);
/**
* @brief Sets ADC reference voltage source.
*
* Sets ADC reference voltage source for specified
* object. Take into consideration that the module
* will be re-initialized on the hardware level.
*
* @param[in] *handle HAL context object handle.
* @param[in] vref_input ADC reference voltage source.
*
* @return hal_ll_err_t Module specific error or success.
*/
hal_ll_err_t hal_ll_adc_set_vref_input(handle_t *handle, hal_ll_adc_voltage_reference_t vref_input);
/**
* @brief Sets ADC reference voltage value.
*
* Sets ADC reference voltage value for specified
* object.
*
* @param[in] *handle HAL context object handle.
* @param[in] vref_input ADC reference voltage value.
*
* @return void None.
*/
void hal_ll_adc_set_vref_value(handle_t *handle, float vref_value);
/**
* @brief Executes data read via ADC module.
*
* Function shall read raw unsigned analog value.
*
* @param handle ADC handle.
* @param *readDatabuf Data buffer where read data
* shall be placed.
*
* @return hal_ll_err_t Module specific error.
*
* Returns one of pre-defined error values.
* Take into consideration that this is hardware specific.
*/
hal_ll_err_t hal_ll_adc_read(handle_t *handle, uint16_t *readDatabuf );
/**
* @brief Closes ADC HAL and HAL_LOW_LEVEL context object.
*
* De-allocates hardware resources for specific driver object and
* de-initializes the module on a hardware level.
*
* @param[in] *handle HAL context object handle.
*
* @return void None.
*/
void hal_ll_adc_close( handle_t *handle );
#ifdef __cplusplus
}
#endif
#endif // _HAL_LL_ADC_H_
// ------------------------------------------------------------------------- END