ad5761r.h

Go to the documentation of this file.

/***************************************************************************/
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#ifndef AD5761R_H_
#define AD5761R_H_
 
/* Input Shift Register Format */
#define AD5761R_INPUT_ZERO_BIT      (1 << 20)
#define AD5761R_INPUT_ADDR_CMD(x)   (((x) & 0xF) << 16)
#define AD5761R_INPUT_DATA(x)       (((x) & 0xFFFF) << 0)
 
#define AD5761R_DATA(x)         (((x) & 0xFFFF) << 0)
#define AD5721R_DATA(x)         (((x) & 0xFFF) << 4)
 
/* Input Shift Register Commands */
#define CMD_NOP             0x0
#define CMD_WR_TO_INPUT_REG     0x1
#define CMD_UPDATE_DAC_REG      0x2
#define CMD_WR_UPDATE_DAC_REG       0x3
#define CMD_WR_CTRL_REG         0x4
#define CMD_NOP_ALT_1           0x5
#define CMD_NOP_ALT_2           0x6
#define CMD_SW_DATA_RESET       0x7
#define CMD_RESERVED            0x8
#define CMD_DIS_DAISY_CHAIN     0x9
#define CMD_RD_INPUT_REG        0xA
#define CMD_RD_DAC_REG          0xB
#define CMD_RD_CTRL_REG         0xC
#define CMD_NOP_ALT_3           0xD
#define CMD_NOP_ALT_4           0xE
#define CMD_SW_FULL_RESET       0xF
 
/* Control Register Format */
#define AD5761R_CTRL_SC         (1 << 12)       // RO
#define AD5761R_CTRL_BO         (1 << 11)       // RO
#define AD5761R_CTRL_CV(x)      (((x) & 0x3) << 9)  // RW
#define AD5761R_CTRL_OVR        (1 << 8)        // RW
#define AD5761R_CTRL_B2C        (1 << 7)        // RW
#define AD5761R_CTRL_ETS        (1 << 6)        // RW
#define AD5761R_CTRL_IRO        (1 << 5)        // RW
#define AD5761R_CTRL_PV(x)      (((x) & 0x3) << 3)  // RW
#define AD5761R_CTRL_RA(x)      (((x) & 0x7) << 0)  // RW
 
/* Disable Daisy-Chain Register Format */
#define AD5761R_DIS_DAISY_CHAIN_DDC(x)  (((x) & 0x1) << 0)
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum ad5761r_type {
    AD5761R,
    AD5721R,
};
 
enum ad5761r_reg {
    AD5761R_REG_INPUT,
    AD5761R_REG_DAC,
    AD5761R_REG_CTRL,
};
 
enum ad5761r_scale {
    AD5761R_SCALE_ZERO,
    AD5761R_SCALE_HALF,
    AD5761R_SCALE_FULL,
};
 
enum ad5761r_range {
    AD5761R_RANGE_M_10V_TO_P_10V,
    AD5761R_RANGE_0_V_TO_P_10V,
    AD5761R_RANGE_M_5V_TO_P_5V,
    AD5761R_RANGE_0V_TO_P_5V,
    AD5761R_RANGE_M_2V5_TO_P_7V5,
    AD5761R_RANGE_M_3V_TO_P_3V,
    AD5761R_RANGE_0V_TO_P_16V,
    AD5761R_RANGE_0V_TO_P_20V,
};
 
struct ad5761r_dev {
    /* SPI */
    struct no_os_spi_desc   *spi_desc;
    /* GPIO */
    struct no_os_gpio_desc  *gpio_reset;
    uint8_t     gpio_reset_value;
    struct no_os_gpio_desc  *gpio_clr;
    uint8_t     gpio_clr_value;
    struct no_os_gpio_desc  *gpio_ldac;
    uint8_t     gpio_ldac_value;
    /* Device Settings */
    enum ad5761r_type   type;
    enum ad5761r_range  ra;
    enum ad5761r_scale  pv;
    enum ad5761r_scale  cv;
    bool        int_ref_en;
    bool        exc_temp_sd_en;
    bool        b2c_range_en;
    bool        ovr_en;
    bool        daisy_chain_en;
};
 
struct ad5761r_init_param {
    /* SPI */
    struct no_os_spi_init_param spi_init;
    /* GPIO */
    struct no_os_gpio_init_param    gpio_reset;
    uint8_t     gpio_reset_value;
    struct no_os_gpio_init_param    gpio_clr;
    uint8_t     gpio_clr_value;
    struct no_os_gpio_init_param    gpio_ldac;
    uint8_t     gpio_ldac_value;
    /* Device Settings */
    enum ad5761r_type   type;
    enum ad5761r_range  out_range;
    enum ad5761r_scale  pwr_voltage;
    enum ad5761r_scale  clr_voltage;
    bool        int_ref_en;
    bool        exc_temp_sd_en;
    bool        b2c_range_en;
    bool        ovr_en;
    bool        daisy_chain_en;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initialize the device. */
int32_t ad5761r_init(struct ad5761r_dev **device,
             struct ad5761r_init_param init_param);
/* Free the resources allocated by ad5761r_init(). */
int32_t ad5761r_remove(struct ad5761r_dev *dev);
/* SPI write to device. */
int32_t ad5761r_write(struct ad5761r_dev *dev,
              uint8_t reg_addr_cmd,
              uint16_t reg_data);
/* SPI read from device. */
int32_t ad5761r_read(struct ad5761r_dev *dev,
             uint8_t reg_addr_cmd,
             uint16_t *reg_data);
/* Readback the register data. */
int32_t ad5761r_register_readback(struct ad5761r_dev *dev,
                  enum ad5761r_reg reg,
                  uint16_t *reg_data);
/* Configure the part based on the settings stored in the device structure. */
int32_t ad5761r_config(struct ad5761r_dev *dev);
/* Enable/disable daisy-chain mode. */
int32_t ad5761r_set_daisy_chain_en_dis(struct ad5761r_dev *dev,
                       bool en_dis);
/* Get the status of the daisy-chain mode. */
int32_t ad5761r_get_daisy_chain_en_dis(struct ad5761r_dev *dev,
                       bool *en_dis);
/* Set the output_range. */
int32_t ad5761r_set_output_range(struct ad5761r_dev *dev,
                 enum ad5761r_range out_range);
/* Get the output_range. */
int32_t ad5761r_get_output_range(struct ad5761r_dev *dev,
                 enum ad5761r_range *out_range);
/* Set the power up voltage. */
int32_t ad5761r_set_power_up_voltage(struct ad5761r_dev *dev,
                     enum ad5761r_scale pv);
/* Get the power up voltage. */
int32_t ad5761r_get_power_up_voltage(struct ad5761r_dev *dev,
                     enum ad5761r_scale *pv);
/* Set the clear voltage. */
int32_t ad5761r_set_clear_voltage(struct ad5761r_dev *dev,
                  enum ad5761r_scale cv);
/* Get the clear voltage. */
int32_t ad5761r_get_clear_voltage(struct ad5761r_dev *dev,
                  enum ad5761r_scale *cv);
/* Enable/disable internal reference. */
int32_t ad5761r_set_internal_reference_en_dis(struct ad5761r_dev *dev,
        bool en_dis);
/* Get the status of the internal reference. */
int32_t ad5761r_get_internal_reference_en_dis(struct ad5761r_dev *dev,
        bool *en_dis);
/* Enable/disable ETS (exceed temperature shutdown) function. */
int32_t ad5761r_set_exceed_temp_shutdown_en_dis(struct ad5761r_dev *dev,
        bool en_dis);
/* Get the status of the ETS (exceed temperature shutdown) function. */
int32_t ad5761r_get_exceed_temp_shutdown_en_dis(struct ad5761r_dev *dev,
        bool *en_dis);
/* Enable/disable the twos complement bipolar output range. */
int32_t ad5761r_set_2c_bipolar_range_en_dis(struct ad5761r_dev *dev,
        bool en_dis);
/* Get the status of the twos complement bipolar output range. */
int32_t ad5761r_get_2c_bipolar_range_en_dis(struct ad5761r_dev *dev,
        bool *en_dis);
/* Enable/disable the 5% overrange. */
int32_t ad5761r_set_overrange_en_dis(struct ad5761r_dev *dev,
                     bool en_dis);
/* Get the status of the 5% overrange. */
int32_t ad5761r_get_overrange_en_dis(struct ad5761r_dev *dev,
                     bool *en_dis);
/* Get the short-circuit condition. */
int32_t ad5761r_get_short_circuit_condition(struct ad5761r_dev *dev,
        bool *sc);
/* Get the brownout condition. */
int32_t ad5761r_get_brownout_condition(struct ad5761r_dev *dev,
                       bool *bo);
/* Set the reset pin value. */
int32_t ad5761r_set_reset_pin(struct ad5761r_dev *dev,
                  uint8_t value);
/* Get the reset pin value. */
int32_t ad5761r_get_reset_pin(struct ad5761r_dev *dev,
                  uint8_t *value);
/* Set the clr pin value. */
int32_t ad5761r_set_clr_pin(struct ad5761r_dev *dev,
                uint8_t value);
/* Get the clr pin value. */
int32_t ad5761r_get_clr_pin(struct ad5761r_dev *dev,
                uint8_t *value);
/* Set the ldac pin value. */
int32_t ad5761r_set_ldac_pin(struct ad5761r_dev *dev,
                 uint8_t value);
/* Get the ldac pin value. */
int32_t ad5761r_get_ldac_pin(struct ad5761r_dev *dev,
                 uint8_t *value);
/* Write to input register. */
int32_t ad5761r_write_input_register(struct ad5761r_dev *dev,
                     uint16_t reg_data);
/* Update DAC register. */
int32_t ad5761r_update_dac_register(struct ad5761r_dev *dev);
/* Write to input register and update DAC register. */
int32_t ad5761r_write_update_dac_register(struct ad5761r_dev *dev,
        uint16_t reg_data);
/*Software data reset. */
int32_t ad5761r_software_data_reset(struct ad5761r_dev *dev);
/* Software full reset. */
int32_t ad5761r_software_full_reset(struct ad5761r_dev *dev);
 
#endif // AD5761R_H_