adac3.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 ADAC3_H
#define ADAC3_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_i2c_master.h"
 
#define ADAC3_CONTROL_AOUT_ENABLE           0x40
#define ADAC3_CONTROL_AIN_SINGLE_ENDED      0x00
#define ADAC3_CONTROL_AIN_3_DIFFERENTIAL    0x10
#define ADAC3_CONTROL_AIN_MIXED             0x20
#define ADAC3_CONTROL_AIN_2_DIFFERENTIAL    0x30
#define ADAC3_CONTROL_AUTO_INCREMENT        0x04
#define ADAC3_CONTROL_AD_CH0                0x00
#define ADAC3_CONTROL_AD_CH1                0x01
#define ADAC3_CONTROL_AD_CH2                0x02
#define ADAC3_CONTROL_AD_CH3                0x03
 
#define ADAC3_VREF_2048mV                   2048.0
#define ADAC3_VREF_4096mV                   4096.0
#define ADAC3_RESOLUTION                    0xFF
 
#define ADAC3_DEVICE_ADDRESS_A2A1A0_000     0x48
#define ADAC3_DEVICE_ADDRESS_A2A1A0_001     0x49
#define ADAC3_DEVICE_ADDRESS_A2A1A0_010     0x4A
#define ADAC3_DEVICE_ADDRESS_A2A1A0_011     0x4B
#define ADAC3_DEVICE_ADDRESS_A2A1A0_100     0x4C
#define ADAC3_DEVICE_ADDRESS_A2A1A0_101     0x4D
#define ADAC3_DEVICE_ADDRESS_A2A1A0_110     0x4E
#define ADAC3_DEVICE_ADDRESS_A2A1A0_111     0x4F
 
 // adac3_set
 
#define ADAC3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // adac3_map
 // adac3
 
typedef struct
{
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
    uint8_t control;            
    uint8_t dac;                
} adac3_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} adac3_cfg_t;
 
typedef enum
{
    ADAC3_OK = 0,
    ADAC3_ERROR = -1
 
} adac3_return_value_t;
 
void adac3_cfg_setup ( adac3_cfg_t *cfg );
 
err_t adac3_init ( adac3_t *ctx, adac3_cfg_t *cfg );
 
err_t adac3_default_cfg ( adac3_t *ctx );
 
err_t adac3_write_control ( adac3_t *ctx, uint8_t control );
 
err_t adac3_write_dac ( adac3_t *ctx, uint8_t dac );
 
err_t adac3_read_adc ( adac3_t *ctx, uint8_t *adc );
 
#ifdef __cplusplus
}
#endif
#endif // ADAC3_H
 
 // adac3
 
// ------------------------------------------------------------------------ END