dac13.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 DAC13_H
#define DAC13_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"
#include "spi_specifics.h"
 
#define DAC13_REG_INTERFACE_CONFIG_A        0x00
#define DAC13_REG_INTERFACE_CONFIG_B        0x01
#define DAC13_REG_DEVICE_CONFIG             0x02
#define DAC13_REG_CHIP_TYPE                 0x03
#define DAC13_REG_PRODUCT_ID_L              0x04
#define DAC13_REG_PRODUCT_ID_H              0x05
#define DAC13_REG_CHIP_GRADE                0x06
#define DAC13_REG_SCRATCH_PAD               0x0A
#define DAC13_REG_SPI_REVISION              0x0B
#define DAC13_REG_VENDOR_L                  0x0C
#define DAC13_REG_VENDOR_H                  0x0D
#define DAC13_REG_STREAM_MODE               0x0E
#define DAC13_REG_TRANSFER_REGISTER         0x0F
#define DAC13_REG_INTERFACE_CONFIG_C        0x10
#define DAC13_REG_INTERFACE_STATUS_A        0x11
#define DAC13_REG_INTERFACE_CONFIG_D        0x14
#define DAC13_REG_REFERENCE_CONFIG          0x15
#define DAC13_REG_ERR_ALARM_MASK            0x16
#define DAC13_REG_ERR_STATUS                0x17
#define DAC13_REG_POWERDOWN_CONFIG          0x18
#define DAC13_REG_CH0_OUTPUT_RANGE          0x19
#define DAC13_REG_HW_LDAC_16B               0x28
#define DAC13_REG_CH0_DAC_16B               0x2A
#define DAC13_REG_DAC_PAGE_16B              0x2E
#define DAC13_REG_CH_SELECT_16B             0x2F
#define DAC13_REG_INPUT_PAGE_16B            0x31
#define DAC13_REG_SW_LDAC_16B               0x32
#define DAC13_REG_CH0_INPUT_16B             0x34
#define DAC13_REG_HW_LDAC_24B               0x37
#define DAC13_REG_CH0_DAC_24B               0x3A
#define DAC13_REG_DAC_PAGE_24B              0x40
#define DAC13_REG_CH_SELECT_24B             0x41
#define DAC13_REG_INPUT_PAGE_24B            0x44
#define DAC13_REG_SW_LDAC_24B               0x45
#define DAC13_REG_CH0_INPUT_24B             0x48
 
 // dac13_reg
 
#define DAC13_SPI_READ_BIT                  0x80
 
#define DAC13_PRODUCT_ID                    0x400B
#define DAC13_VENDOR_ID                     0x0456
 
#define DAC13_IDUMP_FASTMODE                0x40
#define DAC13_REFERENCE_VOLTAGE_SEL_INT     0x00
#define DAC13_REFERENCE_VOLTAGE_SEL_INT_OUT 0x01
#define DAC13_REFERENCE_VOLTAGE_SEL_EXT     0x02
#define DAC13_REFERENCE_VOLTAGE_SEL_MASK    0x03
 
#define DAC13_OUT_RANGE_0_TO_2p5V           0x00
#define DAC13_OUT_RANGE_0_TO_5V             0x01
#define DAC13_OUT_RANGE_0_TO_10V            0x02
#define DAC13_OUT_RANGE_NEG_5_TO_5V         0x03
#define DAC13_OUT_RANGE_NEG_2p5_TO_7p5V     0x04
 
#define DAC13_VZS_OUT_RANGE_0_TO_2p5V       ( -0.197f )
#define DAC13_VFS_OUT_RANGE_0_TO_2p5V       ( 2.701f )
#define DAC13_VZS_OUT_RANGE_0_TO_5V         ( -0.077f )
#define DAC13_VFS_OUT_RANGE_0_TO_5V         ( 5.077f )
#define DAC13_VZS_OUT_RANGE_0_TO_10V        ( -0.162f )
#define DAC13_VFS_OUT_RANGE_0_TO_10V        ( 10.164f )
#define DAC13_VZS_OUT_RANGE_NEG_5_TO_5V     ( -5.164f )
#define DAC13_VFS_OUT_RANGE_NEG_5_TO_5V     ( 5.162f )
#define DAC13_VZS_OUT_RANGE_NEG_2p5_TO_7p5V ( -2.663f )
#define DAC13_VFS_OUT_RANGE_NEG_2p5_TO_7p5V ( 7.663f )
#define DAC13_DAC_RES_16BIT                 0xFFFF
 
#define DAC13_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define DAC13_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 
 // dac13_set
 
#define DAC13_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.ldc = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.alt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // dac13_map
 // dac13
 
typedef struct
{
    // Output pins
    digital_out_t ldc;              
    digital_out_t rst;              
    // Input pins
    digital_in_t alt;               
    // Modules
    spi_master_t spi;               
    pin_name_t   chip_select;       
    float        v_zero_scale;      
    float        v_full_scale;      
} dac13_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 ldc;                 
    pin_name_t rst;                 
    pin_name_t alt;                 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} dac13_cfg_t;
 
typedef enum
{
    DAC13_OK = 0,
    DAC13_ERROR = -1
 
} dac13_return_value_t;
 
void dac13_cfg_setup ( dac13_cfg_t *cfg );
 
err_t dac13_init ( dac13_t *ctx, dac13_cfg_t *cfg );
 
err_t dac13_default_cfg ( dac13_t *ctx );
 
err_t dac13_generic_write ( dac13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t dac13_generic_read ( dac13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t dac13_write_register ( dac13_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t dac13_read_register ( dac13_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t dac13_write_register_16b ( dac13_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t dac13_read_register_16b ( dac13_t *ctx, uint8_t reg, uint16_t *data_out );
 
void dac13_set_ldc_pin ( dac13_t *ctx, uint8_t state );
 
void dac13_set_rst_pin ( dac13_t *ctx, uint8_t state );
 
uint8_t dac13_get_alert_pin ( dac13_t *ctx );
 
void dac13_reset_device ( dac13_t *ctx );
 
err_t dac13_check_communication ( dac13_t *ctx );
 
err_t dac13_set_output_range ( dac13_t *ctx, uint8_t out_range );
 
err_t dac13_set_dac_value ( dac13_t *ctx, uint16_t dac_value );
 
err_t dac13_set_output_voltage ( dac13_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // DAC13_H
 
 // dac13
 
// ------------------------------------------------------------------------ END