adc14.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** 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,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, 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 ADC14_H
#define ADC14_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define ADC14_MEASURE_NUM           100
#define ADC14_RESOLUTION_12BIT      0x0FFFu
#define ADC14_RES_DIVIDER           4096.0f
#define ADC14_CONVERT_V_T_MV        1000.0f
 
#define ADC14_INT_VREF_2_048V       2.048f
 
#define ADC14_EXT_VREF_0V           0.0f
#define ADC14_EXT_VREF_3_3V         3.3f
 
 
#define ADC14_MEASURE_NUM           100
 
#define ADC14_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ADC14_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // adc14_set
 
#define ADC14_MAP_MIKROBUS( cfg, mikrobus )         \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.shd  = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // adc14_map
 // adc14
 
typedef struct
{
    // Output pins
    digital_out_t shd;           
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
    float vref;                  
} adc14_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins
    pin_name_t shd;             
    // static variable
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
    float vref;    
} adc14_cfg_t;
 
typedef enum
{
    ADC14_OK = 0,
    ADC14_ERROR = -1
 
} adc14_return_value_t;
 
void adc14_cfg_setup ( adc14_cfg_t *cfg );
 
err_t adc14_init ( adc14_t *ctx, adc14_cfg_t *cfg );
 
void adc14_device_shutdown ( adc14_t *ctx );
 
void adc14_device_power_up ( adc14_t *ctx );
 
err_t adc14_read_conversion_data ( adc14_t *ctx, uint16_t *adc_data );
 
err_t adc14_get_voltage ( adc14_t *ctx, float *voltage );
 
err_t adc14_set_vref ( adc14_t *ctx, float vref );
 
#ifdef __cplusplus
}
#endif
#endif // ADC14_H
 
 // adc14
 
// ------------------------------------------------------------------------ END