daq3.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 DAQ3_H
#define DAQ3_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 DAQ3_REG_0      0x00
#define DAQ3_REG_1      0x01
#define DAQ3_REG_2      0x02
#define DAQ3_REG_3      0x03
#define DAQ3_REG_CMD    0x14
 
 // daq3_reg
 
#define DAQ3_CMD_WEN          0x00
#define DAQ3_CMD_REG_READ     0x40
#define DAQ3_CMD_REG_WRITE    0x00
 
 // daq3_set
 
#define DAQ3_CMD_REG_DEFAULT     0xE1
 
 // daq3_set
 
#define DAQ3_LOW_POWER_MODE           0x00
#define DAQ3_FULL_PERFORMANCE_MODE    0x01
 
 // mode
 
#define DAQ3_PD_REF_POWER_DOWN    0x00
#define DAQ3_PD_REF_POWER_UP      0x01
 
 // pd_ref
 
#define DAQ3_PD_AMP_POWER_DOWN        0x00
#define DAQ3_PD_AMP_POWER_UP          0x01
 
 // pd_amp
 
#define DAQ3_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.dam = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.dre = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.mod = MIKROBUS( mikrobus, MIKROBUS_PWM );   \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // daq3_map
 // daq3
 
typedef struct
{
    // Output pins
 
    digital_out_t  dam;      
    digital_out_t  dre;      
    digital_out_t  mod;      
    // Input pins
 
    digital_in_t  int_pin;   
    // Modules
 
    spi_master_t  spi;       
    pin_name_t  chip_select; 
} daq3_t;
 
typedef struct
{
    uint8_t    en_six_st_bits; 
    uint8_t    span_comp;      
    uint8_t    high_z_mode;    
    uint8_t    turbo_mode;     
    uint8_t    ov_clamp_flag;  
} daq3_reg_cfg_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  dam;      
    pin_name_t  dre;      
    pin_name_t  mod;      
    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; 
} daq3_cfg_t;
 
void daq3_cfg_setup ( daq3_cfg_t *cfg );
 
err_t daq3_init ( daq3_t *ctx, daq3_cfg_t *cfg );
 
void daq3_default_cfg ( daq3_t *ctx );
 
void daq3_set_pwr_mode ( daq3_t *ctx, uint8_t mode );
 
void daq3_set_pwr_down_ref_buf ( daq3_t *ctx, uint8_t pd_ref );
 
void daq3_set_pwr_down_amp ( daq3_t *ctx, uint8_t pd_amp );
 
 
uint8_t daq3_get_sdo ( daq3_t *ctx );
 
err_t daq3_generic_write ( daq3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t daq3_generic_read ( daq3_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t daq3_set_reg_cfg ( daq3_t *ctx, daq3_reg_cfg_t cfg_data );
 
err_t daq3_get_reg_cfg ( daq3_t *ctx, daq3_reg_cfg_t *cfg_data );
 
int32_t daq3_get_conversion_result ( daq3_t *ctx, daq3_reg_cfg_t cfg_data );
 
float daq3_get_voltage ( daq3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DAQ3_H
 
 // daq3
 
// ------------------------------------------------------------------------ END