ad5791.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef __AD5791_H__
#define __AD5791_H__
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_delay.h"
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"
#include "no_os_error.h"
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
/* Supported devices */
enum ad5791_type {
    ID_AD5760,
    ID_AD5780,
    ID_AD5781,
    ID_AD5790,
    ID_AD5791
};
 
/* Possible voltage spans for linearity error compensation */
enum ad5791_lin_comp_select {
    AD5781_SPAN_UPTO_10V = 0,
    AD5781_SPAN_10V_TO_20V = 4,
    AD5791_SPAN_10V_TO_12V = 1,
    AD5791_SPAN_12V_TO_16V = 2,
    AD5791_SPAN_16V_TO_19V = 3,
    AD5791_SPAN_19V_TO_20V = 4
};
 
struct ad5791_chip_info {
    uint32_t resolution;
};
 
struct ad5791_dev {
    /* SPI */
    struct no_os_spi_desc   *spi_desc;
    /* GPIO */
    struct no_os_gpio_desc  *gpio_reset;
    struct no_os_gpio_desc  *gpio_clr;
    struct no_os_gpio_desc  *gpio_ldac;
    /* Device Settings */
    enum ad5791_type act_device;
    bool rbuf_gain2;
};
 
struct ad5791_init_param {
    /* SPI */
    struct no_os_spi_init_param spi_init;
    /* GPIO */
    struct no_os_gpio_init_param        gpio_reset;
    struct no_os_gpio_init_param        gpio_clr;
    struct no_os_gpio_init_param        gpio_ldac;
    /* Device Settings */
    enum ad5791_type act_device;
    bool                    rbuf_gain2;
};
 
/******************************************************************************/
/*********************************** GPIO *************************************/
/******************************************************************************/
#define AD5791_RESET_OUT       no_os_gpio_direction_output(dev->gpio_reset, \
                   NO_OS_GPIO_HIGH);
#define AD5791_RESET_LOW       no_os_gpio_set_value(dev->gpio_reset,        \
                   NO_OS_GPIO_LOW)
#define AD5791_RESET_HIGH      no_os_gpio_set_value(dev->gpio_reset,        \
                   NO_OS_GPIO_HIGH)
 
#define AD5791_CLR_OUT         no_os_gpio_direction_output(dev->gpio_clr,  \
                   NO_OS_GPIO_HIGH);
#define AD5791_CLR_LOW         no_os_gpio_set_value(dev->gpio_clr,         \
                   NO_OS_GPIO_LOW)
#define AD5791_CLR_HIGH        no_os_gpio_set_value(dev->gpio_clr,         \
                   NO_OS_GPIO_HIGH)
 
#define AD5791_LDAC_OUT        no_os_gpio_direction_output(dev->gpio_ldac, \
                   NO_OS_GPIO_HIGH);
#define AD5791_LDAC_LOW        no_os_gpio_set_value(dev->gpio_ldac,        \
                   NO_OS_GPIO_LOW)
#define AD5791_LDAC_HIGH       no_os_gpio_set_value(dev->gpio_ldac,        \
                   NO_OS_GPIO_HIGH)
 
/******************************************************************************/
/********************************** AD5791 ************************************/
/******************************************************************************/
 
/* Maximum resolution */
#define MAX_RESOLUTION          20
 
/* Register Map */
#define AD5791_NOP                 0  // No operation (NOP).
#define AD5791_REG_DAC             1  // DAC register.
#define AD5791_REG_CTRL            2  // Control register.
#define AD5791_REG_CLR_CODE        3  // Clearcode register.
#define AD5791_CMD_WR_SOFT_CTRL    4  // Software control register(Write only).
 
/* Input Shift Register bit definition. */
#define AD5791_READ                (1ul << 23)
#define AD5791_WRITE               (0ul << 23)
#define AD5791_ADDR_REG(x)         (((uint32_t)(x) & 0x7) << 20)
 
/* Control Register bit Definition */
#define AD5791_CTRL_LINCOMP_MASK   NO_OS_GENMASK(9,6) // Linearity error compensation.
#define AD5791_CTRL_LINCOMP(x)     (((x) & 0xF) << 6)
#define AD5791_CTRL_SDODIS_MASK    NO_OS_BIT(5)       // SDO pin enable/disable control.
#define AD5791_CTRL_SDODIS(x)      ((x & 0x01) << 5)
#define AD5791_CTRL_BIN2SC_MASK    NO_OS_BIT(4)       // DAC register coding selection.
#define AD5791_CTRL_BIN2SC(x)      ((x & 0x01) << 4)
#define AD5791_CTRL_DACTRI         NO_OS_BIT(3)       // DAC tristate control.
#define AD5791_CTRL_OPGND          NO_OS_BIT(2)       // Output ground clamp control.
#define AD5791_CTRL_RBUF_MASK      NO_OS_BIT(1)       // Output amplifier configuration control.
#define AD5791_CTRL_RBUF(x)        ((x & 0x01) << 1)
 
/* Software Control Register bit definition */
#define AD5791_SOFT_CTRL_RESET      (1 << 2) // RESET function.
#define AD5791_SOFT_CTRL_CLR        (1 << 1) // CLR function.
#define AD5791_SOFT_CTRL_LDAC       (1 << 0) // LDAC function.
 
/* DAC OUTPUT STATES */
#define AD5791_OUT_NORMAL            0x0
#define AD5791_OUT_CLAMPED_6K        0x1
#define AD5791_OUT_TRISTATE          0x2
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
int32_t ad5791_init(struct ad5791_dev **device,
            struct ad5791_init_param init_param);
 
int32_t ad5791_remove(struct ad5791_dev *dev);
 
int32_t ad5791_set_register_value(struct ad5791_dev *dev,
                  uint8_t register_address,
                  uint32_t register_value);
 
int32_t ad5791_get_register_value(struct ad5791_dev *dev,
                  uint8_t register_address,
                  uint32_t *value);
 
int32_t ad5791_dac_ouput_state(struct ad5791_dev *dev,
                   uint8_t state);
 
int32_t ad5791_set_dac_value(struct ad5791_dev *dev,
                 uint32_t value);
 
int32_t ad5791_soft_instruction(struct ad5791_dev *dev,
                uint8_t instruction_bit);
 
int32_t ad5791_setup(struct ad5791_dev *dev,
             uint32_t setup_word);
 
int ad5791_spi_write_mask(struct ad5791_dev *dev,
              uint8_t register_address,
              uint32_t mask,
              uint32_t value);
 
int ad5791_set_lin_comp(struct ad5791_dev *dev,
            enum ad5791_lin_comp_select v_span);
 
int ad5791_ldac_trigger(struct ad5791_dev *dev);
 
int ad5791_clear_async(struct ad5791_dev *dev);
 
#endif /* __AD5791_H__ */