dac11.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 DAC11_H
#define DAC11_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 DAC11_CMD_CHANNEL_A             0x00
#define DAC11_CMD_CHANNEL_B             0x01
#define DAC11_CMD_CHANNEL_C             0x02
#define DAC11_CMD_CHANNEL_D             0x03
#define DAC11_CMD_CHANNEL_E             0x04
#define DAC11_CMD_CHANNEL_F             0x05
#define DAC11_CMD_CHANNEL_G             0x06
#define DAC11_CMD_CHANNEL_H             0x07
#define DAC11_CMD_WRM                   0x08
#define DAC11_CMD_WTM                   0x09
#define DAC11_CMD_UPDATE_SELECT         0x0A
#define DAC11_CMD_CHANNEL_A_WRITE       0x0B       
#define DAC11_CMD_BROADCAST             0x0C
#define DAC11_CMD_PD_HIGH_Z             0x0D
#define DAC11_CMD_PD_100KOHM            0x0E
#define DAC11_CMD_PD_2p5KOHM            0x0F
 
 // dac11_reg
 
#define DAC11_SELECT_CHANNEL_A          0x01
#define DAC11_SELECT_CHANNEL_B          0x02
#define DAC11_SELECT_CHANNEL_C          0x04
#define DAC11_SELECT_CHANNEL_D          0x08
#define DAC11_SELECT_CHANNEL_E          0x10
#define DAC11_SELECT_CHANNEL_F          0x20
#define DAC11_SELECT_CHANNEL_G          0x40
#define DAC11_SELECT_CHANNEL_H          0x80
#define DAC11_SELECT_ALL_CHANNELS       0xFF
 
#define DAC11_MIN_DAC_VALUE             0x0000
#define DAC11_MAX_DAC_VALUE             0x0FFF
 
#define DAC11_VREF_3V3                  3.3
#define DAC11_VREF_5V                   5
 
#define DAC11_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define DAC11_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // dac11_set
 
#define DAC11_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 );
 
 // dac11_map
 // dac11
 
typedef struct
{
    // Modules
    spi_master_t  spi;                                  
    pin_name_t  chip_select;                            
} dac11_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;     
} dac11_cfg_t;
 
typedef enum
{
    DAC11_OK = 0,
    DAC11_ERROR = -1
 
} dac11_return_value_t;
 
void dac11_cfg_setup ( dac11_cfg_t *cfg );
 
err_t dac11_init ( dac11_t *ctx, dac11_cfg_t *cfg );
 
err_t dac11_default_cfg ( dac11_t *ctx );
 
err_t dac11_generic_write ( dac11_t *ctx, uint16_t *data_in, uint8_t len );
 
err_t dac11_write_control_reg( dac11_t *ctx, uint8_t cmd, uint16_t data_in );
 
err_t dac11_set_all_ch_value( dac11_t *ctx, uint16_t dac_value );
 
err_t dac11_set_all_ch_voltage( dac11_t *ctx, float vref, float voltage );
 
err_t dac11_set_specific_ch_value( dac11_t *ctx, uint8_t channel, uint16_t dac_value );
 
err_t dac11_set_specific_ch_voltage( dac11_t *ctx, uint8_t channel, float vref, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // DAC11_H
 
 // dac11
 
// ------------------------------------------------------------------------ END