dac7.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 DAC7_H
#define DAC7_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define DAC7_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 );
#define DAC7_RETVAL       uint8_t
#define DAC7_RETVAL_T     uint8_t
 
#define DAC7_OK                                        0x00
#define DAC7_INIT_ERROR                                0xFF
 
#define DAC7_ERROR                                     0x00
#define DAC7_SUCCESS                                   0x01
#define DAC7_COMMAND_WRITE_INPUT_REGISTER              0x00
#define DAC7_COMMAND_UPDATE_DAC_REGISTER               0x08
#define DAC7_COMMAND_WRITE_INPUT_REGISTER_UPDATE_ALL   0x10
#define DAC7_COMMAND_WRITE_UPDATE_CHANNEL              0x18
#define DAC7_COMMAND_POWER_UPDOWN                      0x20
#define DAC7_COMMAND_RESET                             0x28
#define DAC7_COMMAND_SET_LDAC                          0x30
#define DAC7_COMMAND_REFERENCE_ONOFF                   0x38          
 
#define DAC7_ADDRESS_CHANNEL_A                         0x00
#define DAC7_ADDRESS_CHANNEL_B                         0x01
#define DAC7_ADDRESS_CHANNEL_C                         0x02
#define DAC7_ADDRESS_CHANNEL_D                         0x03
#define DAC7_ADDRESS_CHANNEL_ALL                       0x07
#define DAC7_SELECT_CHANNEL_A                          0x01
#define DAC7_SELECT_CHANNEL_B                          0x02
#define DAC7_SELECT_CHANNEL_C                          0x04
#define DAC7_SELECT_CHANNEL_D                          0x08
#define DAC7_SELECT_CHANNEL_ALL                        0x0F
#define DAC7_SET_MODE_INPUT                            0x00
#define DAC7_SET_MODE_INPUT_DAC                        0x18
#define DAC7_SET_MODE_INPUT_DAC_ALL                    0x10
#define DAC7_PWR_MODE_NORMAL                           0x00
#define DAC7_PWR_MODE_POWERDOWN_1K                     0x10
#define DAC7_PWR_MODE_POWERDOWN_100K                   0x20
#define DAC7_PWR_MODE_TRISTATE                         0x30
#define DAC7_PWR_ON_DISABLE                            0x00
#define DAC7_PWR_ON_ENABLE                             0x01
#define DAC7_SW_RST_COMMAND                            0x01
#define DAC7_DONT_CARE_COMMAND                         0x00
#define DAC7_MASK_BIT_COMMAND                          0x38
#define DAC7_MASK_BIT_ADDRESS                          0x07
#define DAC7_MASK_BIT_POWERMODE                        0x30
#define DAC7_MASK_BIT_SEL_CHANNEL                      0x0F
#define DAC7_MASK_BIT_0                                0x01
#define DAC7_MASK_BIT_LBS                              0x00FF
#define DAC7_VREF_4096mV                               0x1000
#define DAC7_VREF_5000mV                               0x13BA
 // End group macro
 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
 
} dac7_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;
 
} dac7_cfg_t;
 
 // End types group
 
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
 
// ------------------------------------------------------------------ VARIABLES
 // End variable group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void dac7_cfg_setup ( dac7_cfg_t *cfg );
 
DAC7_RETVAL dac7_init ( dac7_t *ctx, dac7_cfg_t *cfg );
 
void dac7_write_data ( dac7_t *ctx, uint8_t def_cmd, uint8_t addr_cmd, uint16_t write_data );
 
DAC7_RETVAL_T dac7_set_channel ( dac7_t *ctx, uint8_t set_cmd, uint8_t addr_ch, uint16_t write_data );
 
DAC7_RETVAL_T dac7_set_ch_voltage ( dac7_t *ctx, uint8_t addr_ch, uint16_t vol_val, uint16_t v_ref_mv );
 
DAC7_RETVAL_T dac7_update_channel ( dac7_t *ctx, uint8_t addr_ch, uint16_t ch_data );
 
DAC7_RETVAL_T dac7_set_power ( dac7_t *ctx, uint8_t pwr_en, uint8_t sel_ch );
 
DAC7_RETVAL_T dac7_sw_reset ( dac7_t *ctx );
 
DAC7_RETVAL_T dac7_set_ldac ( dac7_t *ctx, uint8_t sel_ch );
 
DAC7_RETVAL_T dac7_set_internal_reference ( dac7_t *ctx, uint8_t int_ref_en );
 
#ifdef __cplusplus
}
#endif
#endif  // _DAC7_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END