adc24.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 ADC24_H
#define ADC24_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 ADC24_CTRL_SET_WRITE             0x0800u
#define ADC24_CTRL_SET_SEQ               0x0400u
#define ADC24_CTRL_SET_CH_0              0x0000u
#define ADC24_CTRL_SET_CH_1              0x0040u
#define ADC24_CTRL_SET_CH_2              0x0080u
#define ADC24_CTRL_SET_CH_3              0x00C0u
#define ADC24_CTRL_SET_CH_4              0x0100u
#define ADC24_CTRL_SET_CH_5              0x0140u
#define ADC24_CTRL_SET_CH_6              0x0180u
#define ADC24_CTRL_SET_CH_7              0x01C0u
#define ADC24_CTRL_SET_CH_8              0x0200u
#define ADC24_CTRL_SET_CH_9              0x0240u
#define ADC24_CTRL_SET_CH_10             0x0280u
#define ADC24_CTRL_SET_CH_11             0x02C0u
#define ADC24_CTRL_SET_CH_12             0x0300u
#define ADC24_CTRL_SET_CH_13             0x0340u
#define ADC24_CTRL_SET_CH_14             0x0380u
#define ADC24_CTRL_SET_CH_15             0x03C0u
#define ADC24_CTRL_SET_PM_NORMAL         0x0030u
#define ADC24_CTRL_SET_PM_FULL_SHDN      0x0020u
#define ADC24_CTRL_SET_PM_AUTO_SHDN      0x0010u
#define ADC24_CTRL_SET_PM_STANDBY        0x0000u
#define ADC24_CTRL_SET_SHADOW            0x0008u
#define ADC24_CTRL_SET_WEAK              0x0004u
#define ADC24_CTRL_SET_RANGE_5V          0x0000u
#define ADC24_CTRL_SET_RANGE_2_5V        0x0002u
#define ADC24_CTRL_SET_CODING_2C         0x0000u
#define ADC24_CTRL_SET_CODING_BIN        0x0001u
 
#define ADC24_SEQ_SHADOW_AN_INPUT        0
#define ADC24_SEQ_SHADOW_PROGRAMMING     1
#define ADC24_SEQ_SHADOW_ALTERED         2
#define ADC24_SEQ_SHADOW_ADDR_CONJ       3
 
#define ADC24_CH_SEL_IN_0                0
#define ADC24_CH_SEL_IN_1                1
#define ADC24_CH_SEL_IN_2                2
#define ADC24_CH_SEL_IN_3                3
#define ADC24_CH_SEL_IN_4                4
#define ADC24_CH_SEL_IN_5                5
#define ADC24_CH_SEL_IN_6                6
#define ADC24_CH_SEL_IN_7                7
#define ADC24_CH_SEL_IN_8                8
#define ADC24_CH_SEL_IN_9                9
#define ADC24_CH_SEL_IN_10               10
#define ADC24_CH_SEL_IN_11               11
#define ADC24_CH_SEL_IN_12               12
#define ADC24_CH_SEL_IN_13               13
#define ADC24_CH_SEL_IN_14               14
#define ADC24_CH_SEL_IN_15               15
 
#define ADC24_PM_STANDBY                 0
#define ADC24_PM_AUTO_SHDN               1
#define ADC24_PM_FULL_SHDN               2
#define ADC24_PM_NORMAL                  3
 
#define ADC24_WEAK_DOUT_THREE_STATE      0
#define ADC24_WEAK_DOUT_WEAKLY_DRIVEN    1
 
#define ADC24_RANGE_VREF_5V              0
#define ADC24_RANGE_VREF_2V5             1
 
#define ADC24_CODING_2C                  0
#define ADC24_CODING_BIN                 1
 
#define ADC24_ADC_RESOLUTION             0x0FFF
#define ADC24_VREF_2V5                   2.5f
#define ADC24_VREF_5V                    5.0f
 
#define ADC24_SET_DATA_SAMPLE_EDGE       SET_SPI_DATA_SAMPLE_EDGE
#define ADC24_SET_DATA_SAMPLE_MIDDLE     SET_SPI_DATA_SAMPLE_MIDDLE
 
 // adc24_set
 
#define ADC24_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 )
 
 // adc24_map
 // adc24
 
typedef struct
{
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
} adc24_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} adc24_cfg_t;
 
typedef struct
{
    uint8_t ch_sel;        
    uint8_t pm;            
    uint8_t seq_shadow;    
    uint8_t weak;          
    uint8_t range;         
    uint8_t coding;        
} adc24_ctrl_t;
 
typedef enum
{
    ADC24_OK = 0,
    ADC24_ERROR = -1
 
} adc24_return_value_t;
 
void adc24_cfg_setup ( adc24_cfg_t *cfg );
 
err_t adc24_init ( adc24_t *ctx, adc24_cfg_t *cfg );
 
err_t adc24_generic_write ( adc24_t *ctx, uint16_t control );
 
err_t adc24_generic_read ( adc24_t *ctx, uint16_t *data_out );
 
err_t adc24_get_adc_data ( adc24_t *ctx, adc24_ctrl_t ctrl, uint8_t *in_pos, uint16_t *adc_data );
 
err_t adc24_get_voltage ( adc24_t *ctx, adc24_ctrl_t ctrl, uint8_t *in_pos, float *voltage );
 
#ifdef __cplusplus
}
#endif
#endif // ADC24_H
 
 // adc24
 
// ------------------------------------------------------------------------ END