dac15.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 DAC15_H
#define DAC15_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"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define DAC15_REG_NOOP                      0x00
#define DAC15_REG_DEVID                     0x01
#define DAC15_REG_SYNC                      0x02
#define DAC15_REG_CONFIG                    0x03
#define DAC15_REG_GAIN                      0x04
#define DAC15_REG_TRIGGER                   0x05
#define DAC15_REG_BRDCAST                   0x06
#define DAC15_REG_STATUS                    0x07
#define DAC15_REG_DAC_A_DATA                0x08
#define DAC15_REG_DAC_B_DATA                0x09
 
 // dac15_reg
 
#define DAC15_DEVICE_ID                     0x0295u
 
#define DAC15_SYNC_DAC_B_BRDCAST_DIS        0x0000u
#define DAC15_SYNC_DAC_B_BRDCAST_EN         0x0100u
#define DAC15_SYNC_DAC_A_BRDCAST_DIS        0x0000u
#define DAC15_SYNC_DAC_A_BRDCAST_EN         0x0080u
#define DAC15_SYNC_DAC_B_SYNC_DIS           0x0000u
#define DAC15_SYNC_DAC_B_SYNC_EN            0x0002u
#define DAC15_SYNC_DAC_A_SYNC_DIS           0x0000u
#define DAC15_SYNC_DAC_A_SYNC_EN            0x0001u
 
#define DAC15_CONFIG_REF_PWUP               0x0000u
#define DAC15_CONFIG_REF_PWDWN              0x0100u
#define DAC15_CONFIG_DAC_B_PWUP             0x0000u
#define DAC15_CONFIG_DAC_B_PWDWN            0x0002u
#define DAC15_CONFIG_DAC_A_PWUP             0x0000u
#define DAC15_CONFIG_DAC_A_PWDWN            0x0001u
 
#define DAC15_GAIN_REF_DIV_1                0x0000u
#define DAC15_GAIN_REF_DIV_2                0x0100u
#define DAC15_GAIN_BUFF_B_GAIN_1            0x0000u
#define DAC15_GAIN_BUFF_B_GAIN_2            0x0002u
#define DAC15_GAIN_BUFF_A_GAIN_1            0x0000u
#define DAC15_GAIN_BUFF_A_GAIN_2            0x0001u
 
#define DAC15_TRIGGER_LDA_SYNC_LOAD_DAC     0x0010u
#define DAC15_TRIGGER_SOFT_RESET            0x000Au
 
#define DAC15_SET_DAC_A                     0
#define DAC15_SET_DAC_B                     1
 
#define DAC15_DAC_RES_16BIT                 0xFFFFu
#define DAC15_MAX_DAC_DATA                  65535.0f
#define DAC15_MAX_VOUT_MV                   3300.0f
#define DAC15_VREF_3V3                      3.3f
#define DAC15_VREF_5V                       5.0f
#define DAC15_CONV_DEV_MV_TO_V              1000.0f
 
 
#define DAC15_DEVICE_ADDRESS_GND            0x48
#define DAC15_DEVICE_ADDRESS_VCC            0x49
 
#define DAC15_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define DAC15_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // dac15_set
 
#define DAC15_MAP_MIKROBUS( cfg, mikrobus )         \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
    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.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // dac15_map
 // dac15
 
typedef enum
{
    DAC15_DRV_SEL_SPI,      
    DAC15_DRV_SEL_I2C       
} dac15_drv_t;
 
typedef err_t ( *dac15_master_io_t )( struct dac15_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct dac15_s
{
    digital_out_t rst;    
    i2c_master_t i2c;     
    spi_master_t spi;     
    uint8_t      slave_address;    
    pin_name_t   chip_select;      
    dac15_drv_t drv_sel;           
    dac15_master_io_t write_f;     
    dac15_master_io_t read_f;      
    float vref;    
} dac15_t;
 
typedef struct
{
    pin_name_t scl;     
    pin_name_t sda;     
    pin_name_t miso;    
    pin_name_t mosi;    
    pin_name_t sck;     
    pin_name_t cs;      
    pin_name_t rst;     
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
    dac15_drv_t drv_sel;    
    float vref;             
} dac15_cfg_t;
 
typedef enum
{
    DAC15_OK = 0,
    DAC15_ERROR = -1
 
} dac15_return_value_t;
 
void dac15_cfg_setup ( dac15_cfg_t *cfg );
 
void dac15_drv_interface_selection ( dac15_cfg_t *cfg, dac15_drv_t drv_sel );
 
err_t dac15_init ( dac15_t *ctx, dac15_cfg_t *cfg );
 
err_t dac15_default_cfg ( dac15_t *ctx );
 
err_t dac15_generic_write ( dac15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t dac15_generic_read ( dac15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t dac15_write_reg ( dac15_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t dac15_read_reg ( dac15_t *ctx, uint8_t reg, uint16_t *data_out );
 
void dac15_power_up_to_zero_scale ( dac15_t *ctx );
 
void dac15_power_up_to_midscale ( dac15_t *ctx );
 
err_t dac15_get_device_id ( dac15_t *ctx, uint16_t *device_id );
 
err_t dac15_set_sync_mode ( dac15_t *ctx );
 
err_t dac15_soft_reset ( dac15_t *ctx );
 
err_t dac15_set_dac_data ( dac15_t *ctx, uint8_t dac_sel, uint16_t dac_data );
 
err_t dac15_get_dac_data ( dac15_t *ctx, uint8_t dac_sel, uint16_t *dac_data );
 
err_t dac15_set_dac_vout ( dac15_t *ctx, uint8_t dac_sel, float vtg );
 
err_t dac15_get_dac_vout ( dac15_t *ctx, uint8_t dac_sel, float *vtg );
 
#ifdef __cplusplus
}
#endif
#endif // DAC15_H
 
 // dac15
 
// ------------------------------------------------------------------------ END