hal_adc.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 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.
**
****************************************************************************/
#ifndef _HAL_ADC_H_
#define _HAL_ADC_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "hal_target.h"
 
typedef struct
{
    handle_t *hal_adc_handle; 
    handle_t *drv_adc_handle; 
    bool init_state; 
} hal_adc_handle_register_t;
 
typedef enum
{
    HAL_ADC_SUCCESS = 0,                      
    HAL_ADC_WRONG_PIN,                        
    HAL_ADC_MODULE_ERROR,                     
    HAL_ADC_UNSUPPORTED_RESOLUTION = 1100,    
    HAL_ADC_UNSUPPORTED_VREF,                 
    HAL_ADC_WRONG_CHANNEL,                    
    HAL_ADC_ERROR = (-1)                      
} hal_adc_err_t;
 
typedef enum
{
    HAL_ADC_RESOLUTION_NOT_SET = 0,  
    HAL_ADC_RESOLUTION_6_BIT,        
    HAL_ADC_RESOLUTION_8_BIT,        
    HAL_ADC_RESOLUTION_10_BIT,       
    HAL_ADC_RESOLUTION_12_BIT,       
    HAL_ADC_RESOLUTION_14_BIT,       
    HAL_ADC_RESOLUTION_16_BIT,       
    HAL_ADC_RESOLUTION_DEFAULT = HAL_ADC_RESOLUTION_CMAKE
} hal_adc_resolution_t;
 
typedef enum
{
    HAL_ADC_VREF_EXTERNAL = 0,     
    HAL_ADC_VREF_INTERNAL,         
    HAL_ADC_VREF_DEFAULT = HAL_ADC_VREF_EXTERNAL 
} hal_adc_vref_t;
 
typedef struct
{
    hal_pin_name_t              pin;        
    hal_adc_resolution_t        resolution; 
    hal_adc_vref_t              vref_input; 
    float                       vref_value; 
} hal_adc_config_t;
 
typedef struct
{
    handle_t handle; 
    hal_adc_config_t config; 
} hal_adc_t;
 
void hal_adc_configure_default( hal_adc_config_t *config );
 
err_t hal_adc_open( handle_t *handle, bool hal_obj_open_state );
 
err_t hal_adc_set_resolution( handle_t *handle, hal_adc_config_t *config );
 
err_t hal_adc_set_vref_input( handle_t *handle, hal_adc_config_t *config );
 
void hal_adc_set_vref_value( handle_t *handle, hal_adc_config_t *config );
 
err_t hal_adc_read( handle_t *handle, uint16_t *readDatabuf );
 
err_t hal_adc_read_voltage( handle_t *handle, float *readDatabuf );
 
err_t hal_adc_close( handle_t *handle );
 
 // haladcgroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_ADC_H_
// ------------------------------------------------------------------------- END