ad5460.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _AD5460_H
#define _AD5460_H
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include "stdint.h"
#include "stdbool.h"
#include "no_os_spi.h"
#include "no_os_gpio.h"
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define AD5460_NOP              0x00
#define AD5460_CH_FUNC_SETUP(x)               (0x01 + (x * 6))
#define AD5460_OUTPUT_CONFIG(x)               (0x02 + (x * 6))
#define AD5460_DAC_SLEW_CONFIG(x)       (0x03 + (x * 6))
#define AD5460_DAC_CODE(x)          (0x04 + (x * 6))
#define AD5460_DAC_CLR_CODE(x)                (0x05 + (x * 6))
#define AD5460_DAC_ACTIVE(x)            (0x06 + (x * 6))
#define AD5460_GPIO_CONFIG(x)           (0x19 + x)
#define AD5460_WTD_CONFIG           0x1D
#define AD5460_DIAG_CONFIG          0x1E
#define AD5460_PWR_CONFIG           0x1F
#define AD5460_LIVE_STATUS          0x20
#define AD5460_DIGITAL_ALERT_STATUS     0x21
#define AD5460_ANALOG_ALERT_STATUS      0x22
#define AD5460_DIGITAL_ALERT_MSK        0x23
#define AD5460_ANALOG_ALERT_MSK     0x24
#define AD5460_READ_SELECT          0x73
#define AD5460_THERM_RST            0x74
#define AD5460_CMD_KEY          0x75
#define AD5460_BROADCAST_CMD_KEY        0x76
#define AD5460_SCRATCH(x)           (0x77 + x)
#define AD5460_GENERIC_ID           0x7B
#define AD5460_SILICON_REV          0x7C
#define AD5460_SILICON_ID0          0x7D
#define AD5460_SILICON_ID1          0x7E
#define AD5460_SILICON_ID2          0x7F
 
#define AD5460_CMD_KEY_RESET_1                0x9A17
#define AD5460_CMD_KEY_RESET_2                0xE9C1
 
/* AD5460_CH_FUNC_SETUP */
#define AD5460_CH_FUNC_SETUP_MSK        NO_OS_GENMASK(3, 0)
 
#define AD5460_AVDD_SELECT_MSK      NO_OS_GENMASK(13, 12)
#define AD5460_CLR_EN_MSK           NO_OS_BIT(11)
#define AD5460_WAIT_LDAC_CMD_MSK        NO_OS_BIT(10)
#define AD5460_IOUT_RANGE_MSK           NO_OS_GENMASK(9, 8)
#define AD5460_I_LIMIT_MSK          NO_OS_BIT(7)
#define AD5460_ALARM_DEG_PERIOD_MSK     NO_OS_BIT(6)
#define AD5460_VOUT_RANGE_MSK           NO_OS_BIT(5)
#define AD5460_VIOUT_DRV_EN_DLY_MSK     NO_OS_GENMASK(4, 3)
#define AD5460_VOUT_4W_EN_MSK           NO_OS_BIT(2)
#define AD5460_VIOUT_GLITCH_MSK     NO_OS_GENMASK(1, 0)
 
#define AD5460_SLEW_EN_MSK          NO_OS_GENMASK(5, 4)
#define AD5460_SLEW_LIN_STEP_MSK        NO_OS_GENMASK(3, 2)
#define AD5460_SLEW_LIN_RATE_MSK        NO_OS_GENMASK(1, 0)
 
#define AD5460_DAC_CODE_MSK         NO_OS_GENMASK(15, 0)
 
#define AD5460_DAC_CLR_CODE_MSK     NO_OS_GENMASK(15, 0)
 
#define AD5460_DAC_ACTIVE_MSK           NO_OS_GENMASK(15, 0)
 
#define AD5460_GPI_DATA_MSK         NO_OS_BIT(5)
#define AD5460_GPO_DATA_MSK         NO_OS_BIT(4)
#define AD5460_GP_WK_PD_EN_MSK      NO_OS_BIT(3)
#define AD5460_GPIO_SELECT_MSK      NO_OS_GENMASK(2, 0)
 
#define AD5460_DIAG_SELECT_MSK      NO_OS_GENMASK(4, 0)
 
#define AD5460_REF_EN_MSK           NO_OS_BIT(0)
 
#define AD5460_TEMP_ALERT_STATUS_MSK        NO_OS_BIT(9)
#define AD5460_SUPPLY_STATUS_MSK        NO_OS_BIT(8)
#define AD5460_ANALOG_IO_SC_STATUS_D_MSK    NO_OS_BIT(7)
#define AD5460_ANALOG_IO_SC_STATUS_C_MSK    NO_OS_BIT(6)
#define AD5460_ANALOG_IO_SC_STATUS_B_MSK    NO_OS_BIT(5)
#define AD5460_ANALOG_IO_SC_STATUS_A_MSK    NO_OS_BIT(4)
#define AD5460_ANALOG_IO_OC_STATUS_D_MSK    NO_OS_BIT(3)
#define AD5460_ANALOG_IO_OC_STATUS_C_MSK    NO_OS_BIT(2)
#define AD5460_ANALOG_IO_OC_STATUS_B_MSK    NO_OS_BIT(1)
#define AD5460_ANALOG_IO_OC_STATUS_A_MSK    NO_OS_BIT(0)
 
#define AD5460_TEMP_ALERT_MSK           NO_OS_BIT(4)
#define AD5460_CAL_MEM_ERR_MSK      NO_OS_BIT(3)
#define AD5460_SPI_ERR_MSK          NO_OS_BIT(2)
#define AD5460_WDT_RESET_OCCURRED_MSK       NO_OS_BIT(1)
#define AD5460_RESET_OCCURRED_MSK       NO_OS_BIT(0)
 
/* ANALOG_ALERT_STATUS Register */
#define AD5460_AVDD_HI_ERR_MSK          NO_OS_BIT(12)
#define AD5460_AVDD_LO_ERR_MSK          NO_OS_BIT(11)
#define AD5460_AVCC_ERR_MSK         NO_OS_BIT(10)
#define AD5460_IODVCC_ERR_MSK           NO_OS_BIT(9)
#define AD5460_AVSS_ERR_MSK         NO_OS_BIT(8)
#define AD5460_ANALOG_IO_SC_D_MSK       NO_OS_BIT(7)
#define AD5460_ANALOG_IO_SC_C_MSK       NO_OS_BIT(6)
#define AD5460_ANALOG_IO_SC_B_MSK       NO_OS_BIT(5)
#define AD5460_ANALOG_IO_SC_A_MSK       NO_OS_BIT(4)
#define AD5460_ANALOG_IO_OC_D_MSK       NO_OS_BIT(3)
#define AD5460_ANALOG_IO_OC_C_MSK       NO_OS_BIT(2)
#define AD5460_ANALOG_IO_OC_B_MSK       NO_OS_BIT(1)
#define AD5460_ANALOG_IO_OC_A_MSK       NO_OS_BIT(0)
 
/* AD5460 READ_SELECT Register */
#define AD5460_READBACK_SELECT_MODE_MSK NO_OS_GENMASK(8, 0)
#define AD5460_READBACK_ADDR_MSK        NO_OS_GENMASK(8, 0)
 
/* THERM_RST Register */
#define AD5460_THERM_RST_MSK            NO_OS_GENMASK(8, 0)
 
/* CMD_KEY Register */
#define AD5460_CMD_KEY_MSK          NO_OS_GENMASK(15, 0)
 
/* BROADCAST_CMD_KEY Register */
#define AD5460_BROADCAST_CMD_KEY_MSK        NO_OS_GENMASK(15, 0)
 
/* SCRATCH Register */
#define AD5460_SCRATCH_BITS_MSK     NO_OS_GENMASK(15, 0)
 
/* GENERIC_ID Register */
#define AD5460_GENERIC_ID_MSK           NO_OS_GENMASK(2, 0)
 
/* SILICON_REV Register */
#define AD5460_SILICON_REV_ID_MSK       NO_OS_GENMASK(7, 0)
 
/* SILICON_ID0 Register */
#define AD5460_LOT_MSK          NO_OS_GENMASK(6, 0)
 
/* SILICON_ID1 Register */
#define AD5460_Y_COORDS_MSK         NO_OS_GENMASK(13, 7)
#define AD5460_X_COORDS_MSK         NO_OS_GENMASK(6, 0)
 
/* SILICON_ID2 Register */
#define AD5460_WAFER_NUM_MSK            NO_OS_GENMASK(4, 0)
 
#define AD5460_FRAME_SIZE           5
#define AD5460_N_CHANNELS           4
#define AD5460_CH_A             0
#define AD5460_CH_B             1
#define AD5460_CH_C             2
#define AD5460_CH_D             3
#define AD5460_DAC_RANGE            12000
#define AD5460_DAC_CURRENT_RANGE_25MA       25000
#define AD5460_DAC_CURRENT_RANGE_20MA       20000
#define AD5460_DAC_CURRENT_RANGE_4MA        4000
#define AD5460_DAC_RESOLUTION           16
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum ad5460_op_mode {
    AD5460_HIGH_Z = 0x0,
    AD5460_VOLTAGE_OUT = 0x1,
    AD5460_CURRENT_OUT = 0x2,
    AD5460_CURRENT_OUT_HART = 0x10,
 
};
 
enum ad5460_vout_range {
    AD5460_VOUT_RANGE_0_12V,
    AD5460_VOUT_RANGE_NEG12_12V,
};
 
enum ad5460_iout_range {
    AD5460_IOUT_RANGE_0_25MA,
    AD5460_IOUT_RANGE_0_20MA,
    AD5460_IOUT_RANGE_4_20MA,
};
 
enum ad5460_i_limit {
    AD5460_I_LIMIT0,
    AD5460_I_LIMIT1,
};
 
enum ad5460_slew_lin_step {
    AD5460_STEP_0_8_PERCENT,
    AD5460_STEP_1_5_PERCENT,
    AD5460_STEP_6_1_PERCENT,
    AD5460_STEP_22_2_PERCENT,
};
 
enum ad5460_lin_rate {
    AD5460_LIN_RATE_4KHZ8,
    AD5460_LIN_RATE_76KHZ8,
    AD5460_LIN_RATE_153KHZ6,
    AD5460_LIN_RATE_230KHZ4,
};
 
enum ad5460_gpio_select {
    AD5460_GPIO_SEL_HIGH_Z,
    AD5460_GPIO_SEL_GPIO,
    AD5460_GPIO_SEL_GPI,
};
 
enum ad5460_diag_mode {
    AD5460_DIAG_NO_DIAG,
    AD5460_DIAG_PTAT,
    AD5460_DIAG_REFIN,
    AD5460_DIAG_REFOUT,
    AD5460_DIAG_INT_BG_V,
    AD5460_DIAG_SENSE_P_CH_A,
    AD5460_DIAG_SENSE_CH_B,
    AD5460_DIAG_SENSE_P_CH_C,
    AD5460_DIAG_SENSE_P_CH_D,
    AD5460_DIAG_SENSE_N_CH_A,
    AD5460_DIAG_SENSE_N_CH_B,
    AD5460_DIAG_SENSE_N_CH_C,
    AD5460_DIAG_SENSE_N_CH_D,
    AD5460_DIAG_SENSE_AVCC,
    AD5460_DIAG_SENSE_LDO,
    AD5460_DIAG_SENSE_DVCC,
    AD5460_DIAG_SENSE_AGND1,
    AD5460_DIAG_SENSE_AGND2,
    AD5460_DIAG_SENSE_AGND3,
    AD5460_DIAG_SENSE_DGND,
    AD5460_DIAG_SENSE_AVDD_HI,
    AD5460_DIAG_SENSE_AVDD_LO,
    AD5460_DIAG_SENSE_AVSS,
    AD5460_DIAG_SENSE_AVDD_CH_A,
    AD5460_DIAG_SENSE_AVDD_CH_B,
    AD5460_DIAG_SENSE_AVDD_CH_C,
    AD5460_DIAG_SENSE_AVDD_CH_D,
};
 
struct _ad5460_live_status {
    uint8_t ANALOG_IO_OC_STATUS_A: 1;
    uint8_t ANALOG_IO_OC_STATUS_B: 1;
    uint8_t ANALOG_IO_OC_STATUS_C: 1;
    uint8_t ANALOG_IO_OC_STATUS_D: 1;
    uint8_t ANALOG_IO_SC_STATUS_A: 1;
    uint8_t ANALOG_IO_SC_STATUS_B: 1;
    uint8_t ANALOG_IO_SC_STATUS_C: 1;
    uint8_t ANALOG_IO_SC_STATUS_D: 1;
    uint8_t SUPPLY_STATUS: 1;
    uint8_t TEMP_ALERT_STATUS: 1;
};
 
union ad5460_live_status {
    struct _ad5460_live_status status_bits;
    uint16_t value;
};
 
struct ad5460_init_param {
    uint8_t dev_addr;
    struct no_os_spi_init_param spi_ip;
    struct no_os_gpio_init_param *reset_gpio_param;
};
 
struct ad5460_channel_config {
    bool enabled;
    enum ad5460_op_mode function;
    enum ad5460_vout_range vout_range;
    enum ad5460_iout_range iout_range;
    enum ad5460_i_limit i_limit;
};
 
struct ad5460_desc {
    uint8_t dev_addr;
    struct no_os_spi_desc *spi_desc;
    uint8_t comm_buff[AD5460_FRAME_SIZE];
    struct ad5460_channel_config channel_configs[AD5460_N_CHANNELS];
    struct no_os_gpio_desc *reset_gpio;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
int ad5460_dac_voltage_to_code(struct ad5460_desc *, int32_t,
                   uint16_t *, uint32_t);
 
int ad5460_dac_current_to_code(struct ad5460_desc *, uint32_t, uint16_t *,
                   uint32_t);
 
int ad5460_reg_write(struct ad5460_desc *, uint32_t, uint16_t);
 
int ad5460_reg_read_raw(struct ad5460_desc *, uint32_t, uint8_t *);
 
int ad5460_reg_read(struct ad5460_desc *, uint32_t, uint16_t *);
 
int ad5460_reg_update(struct ad5460_desc *, uint32_t, uint16_t,
              uint16_t);
 
int ad5460_set_channel_function(struct ad5460_desc *,
                uint32_t, enum ad5460_op_mode);
 
int ad5460_set_channel_vout_range(struct ad5460_desc *, uint32_t,
                  enum ad5460_vout_range);
 
int ad5460_set_channel_iout_range(struct ad5460_desc *, uint32_t,
                  enum ad5460_iout_range);
 
int ad5460_set_channel_i_limit(struct ad5460_desc *, uint32_t,
                   enum ad5460_i_limit);
 
int ad5460_set_channel_dac_code(struct ad5460_desc *, uint32_t, uint16_t);
 
int ad5460_set_diag(struct ad5460_desc *, uint32_t,
            enum ad5460_diag_mode);
 
int ad5460_gpio_get(struct ad5460_desc *, uint32_t, uint8_t *);
 
int ad5460_set_gpio_config(struct ad5460_desc *, uint32_t,
               enum ad5460_gpio_select);
 
int ad5460_gpio_set(struct ad5460_desc *, uint32_t, uint8_t);
 
int ad5460_get_live(struct ad5460_desc *,
            union ad5460_live_status *);
 
int ad5460_dac_slew_enable(struct ad5460_desc *, uint32_t,
               enum ad5460_slew_lin_step,
               enum ad5460_lin_rate);
 
int ad5460_dac_slew_disable(struct ad5460_desc *, uint32_t);
 
int ad5460_set_therm_rst(struct ad5460_desc *, bool);
 
int ad5460_reset(struct ad5460_desc *);
 
int ad5460_init(struct ad5460_desc **, struct ad5460_init_param *);
 
int ad5460_remove(struct ad5460_desc *desc);
 
#endif // _AD5460_H