isoadc5.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 ISOADC5_H
#define ISOADC5_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"
 
#define ISOADC5_REG_PROD_ID                 0x00
#define ISOADC5_REG_ADC_1                   0x01
#define ISOADC5_REG_ADC_2                   0x02
#define ISOADC5_REG_ADC_3                   0x03
#define ISOADC5_REG_ADC_4                   0x04
#define ISOADC5_REG_FADC_1                  0x05
#define ISOADC5_REG_FADC_2                  0x06
#define ISOADC5_REG_FADC_3                  0x07
#define ISOADC5_REG_FADC_4                  0x08
#define ISOADC5_REG_COUNTHI_1               0x09
#define ISOADC5_REG_COUNTHI_2               0x0A
#define ISOADC5_REG_COUNTHI_3               0x0B
#define ISOADC5_REG_COUNTHI_4               0x0C
#define ISOADC5_REG_COUNTLO_1               0x0D
#define ISOADC5_REG_COUNTLO_2               0x0E
#define ISOADC5_REG_COUNTLO_3               0x0F
#define ISOADC5_REG_COUNTLO_4               0x10
#define ISOADC5_REG_COUT_STATUS             0x11
#define ISOADC5_REG_INTERRUPT_STATUS        0x12
#define ISOADC5_REG_INTERRUPT_ENABLE        0x13
#define ISOADC5_REG_CONTROL                 0x14
 
 // isoadc5_reg
 
#define ISOADC5_DEVICE_ID                   0x00
#define ISOADC5_NORMAL_OPERATION            0x00
#define ISOADC5_WAKE_UP_FROM_POR            0x80
#define ISOADC5_DEVICE_REV                  0x01
 
#define ISOADC5_ADC_NOT_UPDATED             0x8000
#define ISOADC5_ADC_12BIT_MASK              0x0FFF
 
#define ISOADC5_CO_MODE_STATUS              0x80
#define ISOADC5_CO_IN_SEL_FILTERED_ADC      0x40
 
#define ISOADC5_STATUS_CO_4                 0x08
#define ISOADC5_STATUS_CO_3                 0x04
#define ISOADC5_STATUS_CO_2                 0x02
#define ISOADC5_STATUS_CO_1                 0x01
 
#define ISOADC5_INT_STATUS_EOC              0x1000
#define ISOADC5_INT_STATUS_ADCF             0x0800
#define ISOADC5_INT_STATUS_FLD              0x0400
#define ISOADC5_INT_STATUS_SPIFRM           0x0200
#define ISOADC5_INT_STATUS_SPICRC           0x0100
#define ISOADC5_INT_STATUS_CO_POS_4         0x0080
#define ISOADC5_INT_STATUS_CO_POS_3         0x0040
#define ISOADC5_INT_STATUS_CO_POS_2         0x0020
#define ISOADC5_INT_STATUS_CO_POS_1         0x0010
#define ISOADC5_INT_STATUS_CO_NEG_4         0x0008
#define ISOADC5_INT_STATUS_CO_NEG_3         0x0004
#define ISOADC5_INT_STATUS_CO_NEG_2         0x0002
#define ISOADC5_INT_STATUS_CO_NEG_1         0x0001
 
#define ISOADC5_EN_CRC                      0x8000
#define ISOADC5_EN_COMMON_COMP              0x4000
#define ISOADC5_CLEAR_FLT_4                 0x0080
#define ISOADC5_CLEAR_FLT_3                 0x0040
#define ISOADC5_CLEAR_FLT_2                 0x0020
#define ISOADC5_CLEAR_FLT_1                 0x0010
#define ISOADC5_DISABLE_PWR                 0x0008
#define ISOADC5_CLEAR_POR                   0x0004
#define ISOADC5_SOFT_RESET                  0x0002
#define ISOADC5_HARD_RESET                  0x0001
 
#define ISOADC5_ADC_CHANNEL_1               0x01
#define ISOADC5_ADC_CHANNEL_2               0x02
#define ISOADC5_ADC_CHANNEL_3               0x03
#define ISOADC5_ADC_CHANNEL_4               0x04
 
#define ISOADC5_ADC_UNFILTERED              0x00
#define ISOADC5_ADC_FILTERED                0x01
 
#define ISOADC5_MAX_VOLTAGE                 48.0
 
#define ISOADC5_SPI_READ                    0x00
#define ISOADC5_SPI_WRITE                   0x02
#define ISOADC5_SPI_BURST                   0x01
 
 // isoadc5_set
 
#define ISOADC5_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // isoadc5_map
 // isoadc5
 
typedef struct
{
    digital_in_t  int_pin;       
    // Modules
    spi_master_t  spi;           
    pin_name_t  chip_select;     
} isoadc5_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  int_pin;                                
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} isoadc5_cfg_t;
 
typedef struct
{
    uint16_t adc_1;
    uint16_t adc_2;
    uint16_t adc_3;
    uint16_t adc_4;
    uint16_t int_status;
 
} isoadc5_burst_payload_t;
 
typedef enum
{
    ISOADC5_OK = 0,
    ISOADC5_ERROR = -1
 
} isoadc5_return_value_t;
 
void isoadc5_cfg_setup ( isoadc5_cfg_t *cfg );
 
err_t isoadc5_init ( isoadc5_t *ctx, isoadc5_cfg_t *cfg );
 
err_t isoadc5_write_register ( isoadc5_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t isoadc5_read_register ( isoadc5_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t isoadc5_read_register_burst ( isoadc5_t *ctx, uint8_t filt, isoadc5_burst_payload_t *payload );
 
err_t isoadc5_read_voltage( isoadc5_t *ctx, uint8_t filt, uint8_t ch, float *volt );
 
uint8_t isoadc5_get_int_pin ( isoadc5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ISOADC5_H
 
 // isoadc5
 
// ------------------------------------------------------------------------ END