dac12.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 DAC12_H
#define DAC12_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 DAC12_REG_NOP                   0x00
#define DAC12_REG_DEVICE_ID             0x01
#define DAC12_REG_SYNC                  0x02
#define DAC12_REG_CONFIG                0x03
#define DAC12_REG_GAIN                  0x04
#define DAC12_REG_TRIGGER               0x05
#define DAC12_REG_BROADCAST             0x06
#define DAC12_REG_STATUS                0x07
#define DAC12_REG_DAC0                  0x08
#define DAC12_REG_DAC1                  0x09
#define DAC12_REG_DAC2                  0x0A
#define DAC12_REG_DAC3                  0x0B
#define DAC12_REG_DAC4                  0x0C
#define DAC12_REG_DAC5                  0x0D
#define DAC12_REG_DAC6                  0x0E
#define DAC12_REG_DAC7                  0x0F
 
 // dac12_reg
 
#define DAC12_SELECT_CHANNEL_NONE       0x00
#define DAC12_SELECT_CHANNEL_0          0x01
#define DAC12_SELECT_CHANNEL_1          0x02
#define DAC12_SELECT_CHANNEL_2          0x04
#define DAC12_SELECT_CHANNEL_3          0x08
#define DAC12_SELECT_CHANNEL_4          0x10
#define DAC12_SELECT_CHANNEL_5          0x20
#define DAC12_SELECT_CHANNEL_6          0x40
#define DAC12_SELECT_CHANNEL_7          0x80
#define DAC12_SELECT_CHANNEL_ALL        0xFF
 
#define DAC12_GAIN_REFDIV_EN            0x0100
 
#define DAC12_MIN_DAC_VALUE             0x0000
#define DAC12_MAX_DAC_VALUE             0x0FFF
 
#define DAC12_INTERNAL_VREF             2.5
 
#define DAC12_SOFT_RESET                0x000A
 
#define DAC12_DEVICE_ID                 0x2894
#define DAC12_DEVICE_ID_MASK            0xFFFC
 
#define DAC12_SPI_READ                  0x80
 
#define DAC12_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define DAC12_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // dac12_set
 
#define DAC12_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 );
 
 // dac12_map
 // dac12
 
typedef struct
{
    // Modules
    spi_master_t  spi;                                  
    pin_name_t  chip_select;                            
    pin_name_t  channel_gain;                           
} dac12_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                   
    pin_name_t  mosi;                                   
    pin_name_t  sck;                                    
    pin_name_t  cs;                                     
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} dac12_cfg_t;
 
typedef enum
{
    DAC12_OK = 0,
    DAC12_ERROR = -1
 
} dac12_return_value_t;
 
void dac12_cfg_setup ( dac12_cfg_t *cfg );
 
err_t dac12_init ( dac12_t *ctx, dac12_cfg_t *cfg );
 
err_t dac12_default_cfg ( dac12_t *ctx );
 
err_t dac12_write_register ( dac12_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t dac12_read_register ( dac12_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t dac12_check_communication ( dac12_t *ctx );
 
err_t dac12_soft_reset ( dac12_t *ctx );
 
err_t dac12_set_gain ( dac12_t *ctx, uint8_t channel );
 
err_t dac12_set_channel_value ( dac12_t *ctx, uint8_t channel, uint16_t dac_value );
 
err_t dac12_set_channel_voltage ( dac12_t *ctx, uint8_t channel, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // DAC12_H
 
 // dac12
 
// ------------------------------------------------------------------------ END