ad5629r.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef _AD5629R_H_
#define _AD5629R_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_i2c.h"
 
/******************************************************************************/
/******************* Macros and Constants Definitions *************************/
/******************************************************************************/
/* AD5629R Device I2C Address */
#define AD5629R_I2C_ADDR_0          0x54 // A1=0 and A0=0 (A0_Pin=High)
#define AD5629R_I2C_ADDR_1          0x56 // A1=1 and A0=0 (A0_Pin=NC)
#define AD5629R_I2C_ADDR_2          0x57 // A1=1 and A0=1 (A0_Pin=Low)
 
#define MAX_RESOLUTION              16
 
/* Commands */
#define AD5629R_WRITE_N             0x0
#define AD5629R_UPDATE_N            0x1
#define AD5629R_WRITE_N_UPDATE_ALL  0x2
#define AD5629R_WRITE_N_UPDATE_N    0x3
#define AD5629R_POWER               0x4
#define AD5629R_LOAD_CLEAR_REG      0x5
#define AD5629R_LOAD_LDAC_REG       0x6
#define AD5629R_RESET               0x7
#define AD5629R_REFERENCE           0x8
 
/* AD5629R GPIO */
/* LDAC - GPIO0 */
#define AD5629R_LDAC_OUT            no_os_gpio_direction_output(dev->gpio_ldac, \
                        NO_OS_GPIO_HIGH);
#define AD5629R_LDAC_LOW            no_os_gpio_set_value(dev->gpio_ldac,        \
                        NO_OS_GPIO_LOW)
#define AD5629R_LDAC_HIGH           no_os_gpio_set_value(dev->gpio_ldac,        \
                        NO_OS_GPIO_HIGH)
/* CLR - GPIO1 */
#define AD5629R_CLR_OUT             no_os_gpio_direction_output(dev->gpio_clr,  \
                        NO_OS_GPIO_HIGH);
#define AD5629R_CLR_LOW             no_os_gpio_set_value(dev->gpio_clr,         \
                        NO_OS_GPIO_LOW)
#define AD5629R_CLR_HIGH            no_os_gpio_set_value(dev->gpio_clr,         \
                        NO_OS_GPIO_HIGH)
 
/* DAC Addresses */
#define AD5629R_DAC_A_ADDR          0x0
#define AD5629R_DAC_B_ADDR          0x1
#define AD5629R_DAC_C_ADDR          0x2
#define AD5629R_DAC_D_ADDR          0x3
#define AD5629R_DAC_E_ADDR          0x4
#define AD5629R_DAC_F_ADDR          0x5
#define AD5629R_DAC_G_ADDR          0x6
#define AD5629R_DAC_H_ADDR          0x7
#define AD5629R_DAC_ALL_ADDR        0xF
 
/* DAC Selection */
#define DAC_A_SEL           1
#define DAC_B_SEL           2
#define DAC_C_SEL           4
#define DAC_D_SEL           8
#define DAC_E_SEL           16
#define DAC_F_SEL           32
#define DAC_G_SEL           64
#define DAC_H_SEL           128
 
/* Power modes */
#define PWR_NORMAL              0
#define PWR_1K_TO_GND           1
#define PWR_100K_TO_GND         2
#define PWR_3_STATE             3
 
/* Clear code values */
#define CLR_TO_ZEROSCALE        0
#define CLR_TO_MIDSCALE         1
#define CLR_TO_FULLSCALE        2
#define CLR_NOOP                3
 
/* Internal reference status */
#define REF_ON          1
#define REF_OFF         0
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
/* Supported devices */
enum ad5629r_type {
    ID_AD5629R,
    ID_AD5669R,
    ID_AD5668,
    ID_AD5648,
    ID_AD5628,
};
 
enum comm_type_t {
    com_spi,
    com_i2c
};
 
struct ad5629r_chip_info {
    uint32_t resolution;
    enum comm_type_t communication;
};
 
struct ad5629r_dev {
    /* I2C */
    struct no_os_i2c_desc       *i2c_desc;
    /* SPI */
    struct no_os_spi_desc       *spi_desc;
    /* GPIO */
    struct no_os_gpio_desc  *gpio_ldac;
    struct no_os_gpio_desc  *gpio_clr;
    /* Device Settings */
    enum ad5629r_type       act_device;
};
 
struct ad5629r_init_param {
    /* I2C */
    struct no_os_i2c_init_param i2c_init;
    /* SPI */
    struct no_os_spi_init_param spi_init;
    /* GPIO */
    struct no_os_gpio_init_param    gpio_ldac;
    struct no_os_gpio_init_param    gpio_clr;
    /* Device Settings */
    enum ad5629r_type   act_device;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initializes the communication with the device. */
int8_t ad5629r_init(struct ad5629r_dev **device,
            struct ad5629r_init_param init_param);
/* Free the resources allocated by AD5629R_Init(). */
int32_t ad5629r_remove(struct ad5629r_dev *dev);
/* Writes a value to Input Register N of selected DAC channel. */
void ad5629r_write_reg_n(struct ad5629r_dev *dev,
             uint8_t dac_n,
             uint16_t dac_value);
/* Updates selected DAC register. */
void ad5629r_update_dac_n(struct ad5629r_dev *dev,
              uint8_t dac_n);
/* Writes a value to Input Register N of selected DAC channel, then updates all. */
void ad5629r_write_reg_nupdate_all(struct ad5629r_dev *dev,
                   uint8_t dac_n,
                   uint16_t dac_value);
/* Writes a value to Input Register N and updates the respective DAC channel. */
void ad5629r_write_reg_nupdate_n(struct ad5629r_dev *dev,
                 uint8_t dac_n,
                 uint16_t dac_value);
/* Sets the power mode for one or more selected DAC channels. */
void ad5629r_set_power_mode(struct ad5629r_dev *dev,
                uint8_t dac_sel,
                uint8_t mode);
/* Loads the Clear Code Register with a certain value. */
void ad5629r_load_clear_code_reg(struct ad5629r_dev *dev,
                 uint8_t clear_value);
/* Loads the LDAC register with a certain value. */
void ad5629r_load_ldac_reg(struct ad5629r_dev *dev,
               uint8_t dac_sel);
/* Makes a power-on reset. */
void ad5629r_reset(struct ad5629r_dev *dev);
/* Turns on/off the internal reference. */
void ad5629r_set_ref(struct ad5629r_dev *dev,
             uint8_t status);
 
 
#endif /* AD5629_H_ */