dac9.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 DAC9_H
#define DAC9_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 DAC9_REG_NOOP                      0x00
#define DAC9_REG_DEVID                     0x01
#define DAC9_REG_SYNC                      0x02
#define DAC9_REG_CONFIG                    0x03
#define DAC9_REG_GAIN                      0x04
#define DAC9_REG_TRIGGER                   0x05
#define DAC9_REG_STATUS                    0x07
#define DAC9_REG_DAC                       0x08
 
 // dac9_reg
 
#define DAC9_SYNC_DISABLE                0x0000
#define DAC9_SYNC_ENABLE                 0x0001
 
#define DAC9_CONFIG_REF_PWDWN_ENABLE     0x0000
#define DAC9_CONFIG_REF_PWDWN_DISABLE    0x0100
#define DAC9_CONFIG_REF_PWDWN_BIT_MASK   0x0100
#define DAC9_CONFIG_DAC_PWDWN_DISABLE    0x0000
#define DAC9_CONFIG_DAC_PWDWN_ENABLE     0x0001
#define DAC9_CONFIG_DAC_PWDWN_BIT_MASK   0x0001
    
#define DAC9_GAIN_REF_DIV_DISABLE        0x0000
#define DAC9_GAIN_REF_DIV_2              0x0100
#define DAC9_GAIN_REF_DIV_BIT_MASK       0x0100
#define DAC9_GAIN_BUFF_GAIN_1            0x0000
#define DAC9_GAIN_BUFF_GAIN_2            0x0001
#define DAC9_GAIN_BUFF_GAIN_BIT_MASK     0x0001
 
#define DAC9_TRIGGER_LDAC                0x0010
#define DAC9_TRIGGER_SOFT_RESET          0x000A
 
#define DAC9_STATUS_REF_ALARM_BIT_MASK   0x0001
 
#define DAC9_I2C_ADR_AGND                0x48
#define DAC9_I2C_ADR_VDD                 0x49
#define DAC9_I2C_ADR_SDA                 0x4A
#define DAC9_I2C_ADR_SCL                 0x4B
 
#define DAC9_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define DAC9_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // dac9_set
 
#define DAC9_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 )
 
 // dac9_map
 // dac9
 
typedef enum
{
   DAC9_DRV_SEL_SPI,      
   DAC9_DRV_SEL_I2C       
} dac9_drv_t;
 
typedef err_t ( *dac9_master_io_t )( struct dac9_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct dac9_s
{
    i2c_master_t  i2c;                              
    spi_master_t  spi;                              
    uint8_t     slave_address;                      
    pin_name_t  chip_select;                        
    dac9_drv_t  drv_sel;               
    dac9_master_io_t  write_f;         
    dac9_master_io_t  read_f;          
} dac9_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;         
    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;     
   dac9_drv_t  drv_sel;                   
} dac9_cfg_t;
 
typedef enum
{
   DAC9_OK = 0,
   DAC9_ERROR = -1
 
} dac9_return_value_t;
 
void dac9_cfg_setup ( dac9_cfg_t *cfg );
 
void dac9_drv_interface_selection ( dac9_cfg_t *cfg, dac9_drv_t drv_sel );
 
err_t dac9_init ( dac9_t *ctx, dac9_cfg_t *cfg );
 
err_t dac9_generic_write ( dac9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t dac9_generic_read ( dac9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t dac9_enable_sync ( dac9_t *ctx, uint8_t en_sync );
 
err_t dac9_set_config ( dac9_t *ctx, uint16_t en_ref_pwdwn, uint16_t en_dac_pwdwn );
 
err_t dac9_set_gain ( dac9_t *ctx, uint16_t en_ref_div, uint16_t en_buff_gain );
 
void dac9_set_synchronously_load ( dac9_t *ctx );
 
void dac9_soft_reset ( dac9_t *ctx );
 
uint8_t dac9_get_ref_alarm ( dac9_t *ctx );
 
err_t dac9_set_vout ( dac9_t *ctx, uint16_t vout_mv );
 
#ifdef __cplusplus
}
#endif
#endif // DAC9_H
 
 // dac9
 
// ------------------------------------------------------------------------ END