dac4.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 DAC4_H
#define DAC4_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_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define DAC4_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.lda = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
#define DAC4_MAP_MIKROBUS( cfg, mikrobus ) \ …
#define DAC4_OK                 0
#define DAC4_ERROR             -1
#define DAC4_DEVICE_ADDRESS     0x60
 
#define DAC4_CHANNEL_A          0
#define DAC4_CHANNEL_B          1
#define DAC4_CHANNEL_C          2
#define DAC4_CHANNEL_D          3
#define DAC4_UPDATE             0
#define DAC4_DONT_UPDATE        1
#define DAC4_VREF_EXTERNAL      0
#define DAC4_VREF_INTERNAL      1
#define DAC4_MODE_NORMAL        0
#define DAC4_MODE_1kOhm         1
#define DAC4_MODE_100kOhm       2
#define DAC4_MODE_500kOhm       3
#define DAC4_GAIN_x1            0
#define DAC4_GAIN_x2            1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    uint8_t rdy_bit;
    uint8_t por_bit;
    uint8_t channel_select;
    uint8_t udac_bit;
    uint8_t voltage_reference;
    uint8_t power_mode;
    uint8_t gain_value;
    uint16_t dac_input_data;
 
} dac4_channel_setting_t;
typedef struct {…};
 
typedef struct 
{
    dac4_channel_setting_t channel_a;
    dac4_channel_setting_t channel_b;
    dac4_channel_setting_t channel_c;
    dac4_channel_setting_t channel_d;
 
} dac4_channel_t;
typedef struct  {…};
 
typedef struct 
{
    uint8_t channel_a; 
    uint8_t channel_b; 
    uint8_t channel_c; 
    uint8_t channel_d;
 
} dac4_v_ref_channels_t;
typedef struct  {…};
 
typedef struct 
{
    uint8_t channel_a; 
    uint8_t channel_b; 
    uint8_t channel_c; 
    uint8_t channel_d;
 
} dac4_pm_channels_t;
typedef struct  {…};
 
typedef struct 
{
    uint8_t channel_a; 
    uint8_t channel_b; 
    uint8_t channel_c;
    uint8_t channel_d;
 
} dac4_gain_channels_t;
typedef struct  {…};
 
typedef struct
{
    // Output pins 
 
    digital_out_t lda;
 
    // Input pins 
 
    digital_in_t rdy;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} dac4_t;
typedef struct {…};
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t lda;
    pin_name_t rdy;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} dac4_cfg_t;
typedef struct {…};
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void dac4_cfg_setup ( dac4_cfg_t *cfg );
 
err_t dac4_init ( dac4_t *ctx, dac4_cfg_t *cfg );
 
void dac4_generic_write ( dac4_t *ctx, uint8_t *data_buf, uint8_t len );
 
void dac4_generic_read ( dac4_t *ctx, uint8_t *data_buf, uint8_t len );
 
uint8_t dac4_int_get ( dac4_t *ctx );
 
void dac4_pwm_set ( dac4_t *ctx, uint8_t pin_state );
 
void dac4_i2c_get ( dac4_t *ctx, uint8_t *get_buffer, uint16_t n_bytes );
 
void dac4_i2c_set ( dac4_t *ctx, uint8_t *set_buffer, uint16_t n_bytes );
 
uint8_t dac4_general_call_reset ( dac4_t *ctx );
 
uint8_t dac4_general_call_wake_up ( dac4_t *ctx );
 
uint8_t dac4_general_call_software_update ( dac4_t *ctx );
 
uint8_t dac4_fast_write ( dac4_t *ctx, dac4_channel_t *channels );
uint8_t dac4_multi_write ( dac4_t *ctx, dac4_channel_setting_t *channel_buffer, uint8_t n_channels );
 
uint8_t dac4_sequential_write ( dac4_t *ctx, uint8_t starting_channel, dac4_channel_setting_t *channel_buffer );
 
uint8_t dac4_single_write ( dac4_t *ctx, dac4_channel_setting_t *channel_x );
 
uint8_t dac4_voltage_reference_set ( dac4_t *ctx, dac4_v_ref_channels_t *vref );
 
uint8_t dac4_power_mode_set ( dac4_t *ctx, dac4_pm_channels_t *pm );
 
uint8_t dac4_gain_set ( dac4_t *ctx, dac4_gain_channels_t *gain );
 
uint8_t dac4_data_report ( dac4_t *ctx, dac4_channel_setting_t *channel_buffer );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _DAC4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END