ad74413r.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _AD74413R_H
#define _AD74413R_H
 
#include "stdint.h"
#include "stdbool.h"
#include "no_os_spi.h"
#include "no_os_gpio.h"
 
#define AD74413R_N_CHANNELS             4
#define AD74413R_N_DIAG_CHANNELS    4
 
#define AD74413R_CH_A                   0
#define AD74413R_CH_B                   1
#define AD74413R_CH_C                   2
#define AD74413R_CH_D                   3
 
#define AD74413R_RSENSE                 100
 
#define AD74413R_ADC_MAX_VALUE      65535
 
#define AD74413R_NOP                            0x00
#define AD74413R_CH_FUNC_SETUP(x)               (0x01 + x)
#define AD74413R_ADC_CONFIG(x)                  (0x05 + x)
#define AD74413R_DIN_CONFIG(x)                  (0x09 + x)
#define AD74413R_GPO_PARALLEL                   0x0D
#define AD74413R_GPO_CONFIG(x)                  (0x0E + x)
#define AD74413R_OUTPUT_CONFIG(x)               (0x12 + x)
#define AD74413R_DAC_CODE(x)                    (0x16 + x)
#define AD74413R_DAC_CLR_CODE(x)                (0x1A + x)
#define AD74413R_DAC_ACTIVE(x)                  (0x1E + x)
#define AD74413R_DIN_THRESH                     0x22
#define AD74413R_ADC_CONV_CTRL                  0x23
#define AD74413R_DIAG_ASSIGN                    0x24
#define AD74413R_DIN_COMP_OUT                   0x25
#define AD74413R_ADC_RESULT(x)                  (0x26 + x)
#define AD74413R_DIAG_RESULT(x)                 (0x2A + x)
#define AD74413R_ALERT_STATUS                   0x2E
#define AD74413R_LIVE_STATUS                    0x2F
#define AD74413R_ALERT_MASK                     0x3C
#define AD74413R_DIN_COUNTER(x)                 (0x3D + x)
#define AD74413R_READ_SELECT                    0x41
#define AD74413R_THERM_RST                      0x43
#define AD74413R_CMD_KEY                        0x44
#define AD74413R_SCRATCH                        0x45
#define AD74413R_SILICON_REV                    0x46
#define AD74413R_ALERT_STATUS_RESET             NO_OS_GENMASK(15, 0)
 
#define AD74413R_CMD_KEY_RESET_1                0x15FA
#define AD74413R_CMD_KEY_RESET_2                0xAF51
 
#define AD74413R_CMD_KEY_LDAC                   0x953A
 
#define AD74413R_CMD_KEY_DAC_CLEAR      0x73D1
 
#define AD74413R_SPI_RD_RET_INFO_MASK       NO_OS_BIT(8)
#define AD74413R_ERR_CLR_MASK           NO_OS_GENMASK(15, 0)
#define AD74413R_SPI_CRC_ERR_MASK       NO_OS_BIT(13)
#define AD74413R_CH_FUNC_SETUP_MASK             NO_OS_GENMASK(3, 0)
#define AD74413R_ADC_RANGE_MASK                 NO_OS_GENMASK(7, 5)
#define AD74413R_ADC_REJECTION_MASK             NO_OS_GENMASK(4, 3)
#define AD74413R_DEBOUNCE_TIME_MASK             NO_OS_GENMASK(4, 0)
#define AD74413R_DEBOUNCE_MODE_MASK             NO_OS_BIT(5)
#define AD74413R_DIAG_RESULT_MASK       NO_OS_GENMASK(15, 0)
#define AD74413R_REV_ID             NO_OS_GENMASK(7, 0)
#define AD74413R_CH_200K_TO_GND_MASK        NO_OS_BIT(2)
 
#define AD74413R_GPO_PAR_DATA_MASK(x)       NO_OS_BIT(x)
 
#define AD74413R_GPO_SELECT_MASK        NO_OS_GENMASK(2, 0)
#define AD74413R_GPO_DATA_MASK          NO_OS_BIT(3)
 
#define AD74413R_SLEW_EN_MASK           NO_OS_GENMASK(7, 6)
#define AD74413R_SLEW_LIN_STEP_MASK     NO_OS_GENMASK(5, 4)
#define AD74413R_SLEW_LIN_RATE_MASK     NO_OS_GENMASK(3, 2)
#define AD74413R_CLR_EN_MASK            NO_OS_BIT(1)
#define AD74413R_I_LIMIT_MASK           NO_OS_BIT(0)
 
#define AD74413R_DAC_CODE_MASK          NO_OS_GENMASK(12, 0)
 
#define AD74413R_CLR_CODE_MASK          NO_OS_GENMASK(12, 0)
 
#define AD74413R_DAC_ACTIVE_CODE_MASK       NO_OS_GENMASK(12, 0)
 
#define AD74413R_COMP_THRESH_MASK       NO_OS_GENMASK(5, 1)
#define AD74413R_DIN_THRESH_MODE_MASK       NO_OS_BIT(0)
 
#define AD74413R_DIN_COMP_CH(x)         NO_OS_BIT(x)
 
#define AD74413R_EN_REJ_DIAG_MASK       NO_OS_BIT(10)
#define AD74413R_CONV_SEQ_MASK                  NO_OS_GENMASK(9, 8)
#define AD74413R_DIAG_EN_MASK(x)        (NO_OS_BIT(x) << 4)
#define AD74413R_CH_EN_MASK(x)                  NO_OS_BIT(x)
 
#define AD74413R_DIAG_ASSIGN_MASK(x)        (NO_OS_GENMASK(3, 0) << (x * 4))
 
#define AD74413R_DAC_RANGE          11000
 
#define AD74413R_DAC_RESOLUTION         13
#define AD74413R_DAC_CODE_MAX           8191
#define AD74413R_ADC_RESOLUTION         16
#define AD74413R_ADC_CODE_MAX           65536
 
#define AD74413R_THRESHOLD_DAC_RANGE        29
 
#define AD74413R_THRESHOLD_RANGE        16000
 
#define AD74413R_TEMP_OFFSET            -2392
#define AD74413R_TEMP_SCALE         8950
#define AD74413R_TEMP_SCALE_DIV         1000
 
#define AD74413R_RANGE_10V_SCALE        15259ULL
#define AD74413R_RANGE_10V_SCALE_DIV        100000ULL
#define AD74413R_RANGE_2V5_SCALE        38147ULL
#define AD74413R_RANGE_2V5_SCALE_DIV        1000000ULL
#define AD74413R_RANGE_5V_SCALE         76294ULL
#define AD74413R_RANGE_5V_SCALE_DIV     1000000ULL
#define AD74413R_RANGE_5V_OFFSET        -(AD74413R_ADC_MAX_VALUE / 2)
#define AD74413R_RTD_PULL_UP            2100000ULL
#define AD74413R_SENSE_RESISTOR_OHMS        100
 
enum ad74413r_chip_id {
    AD74413R,
    AD74412R
};
 
enum ad74413r_rejection {
    AD74413R_REJECTION_50_60,
    AD74413R_REJECTION_NONE,
    AD74413R_REJECTION_50_60_HART,
    AD74413R_REJECTION_HART
};
 
enum ad74413r_op_mode {
    AD74413R_HIGH_Z,
    AD74413R_VOLTAGE_OUT,
    AD74413R_CURRENT_OUT,
    AD74413R_VOLTAGE_IN,
    AD74413R_CURRENT_IN_EXT,
    AD74413R_CURRENT_IN_LOOP,
    AD74413R_RESISTANCE,
    AD74413R_DIGITAL_INPUT,
    AD74413R_DIGITAL_INPUT_LOOP,
    AD74413R_CURRENT_IN_EXT_HART,
    AD74413R_CURRENT_IN_LOOP_HART,
};
 
enum ad74413r_adc_range {
    AD74413R_ADC_RANGE_10V,
    AD74413R_ADC_RANGE_2P5V_EXT_POW,
    AD74413R_ADC_RANGE_2P5V_INT_POW,
    AD74413R_ADC_RANGE_5V_BI_DIR
};
 
enum ad74413r_conv_seq {
    AD74413R_STOP_PWR_UP,
    AD74413R_START_SINGLE,
    AD74413R_START_CONT,
    AD74413R_STOP_PWR_DOWN,
};
 
enum ad74413r_gpo_select {
    AD74413R_GPO_CONFIG_100K_PD,
    AD74413R_GPO_CONFIG_DATA,
    AD74413R_GPO_CONFIG_PAR_DATA,
    AD74413R_GPO_CONFIG_COMP,
    AD74413R_GPO_CONFIG_HIGH_Z
};
 
enum ad74413r_diag_mode {
    AD74413R_DIAG_AGND,
    AD74413R_DIAG_TEMP,
    AD74413R_DIAG_AVDD,
    AD74413R_DIAG_AVSS,
    AD74413R_DIAG_REFOUT,
    AD74413R_DIAG_ALDO_5V,
    AD74413R_DIAG_ALDO_1V8,
    AD74413R_DIAG_DLDO_1V8,
    AD74413R_DIAG_DVCC,
    AD74413R_DIAG_IOVDD,
    AD74413R_SENSEL_A,
    AD74413R_SENSEL_B,
    AD74413R_SENSEL_C,
    AD74413R_SENSEL_D
};
 
enum ad74413r_debounce_mode {
    AD74413R_DEBOUNCE_MODE_0,
    AD74413R_DEBOUNCE_MODE_1
};
 
enum ad74413r_slew_lin_step {
    AD74413R_STEP_64,
    AD74413R_STEP_120,
    AD74413R_STEP_500,
    AD74413R_STEP_1820,
};
 
enum ad74413r_lin_rate {
    AD74413R_LIN_RATE_4KHZ,
    AD74413R_LIN_RATE_64KHZ,
    AD74413R_LIN_RATE_150KHZ,
    AD74413R_LIN_RATE_240KHZ,
};
 
enum ad74413r_adc_sample {
    AD74413R_ADC_SAMPLE_20HZ = 20,
    AD74413R_ADC_SAMPLE_4800HZ = 4800,
    AD74413R_ADC_SAMPLE_10HZ = 10,
    AD74413R_ADC_SAMPLE_1200HZ = 1200,
};
 
struct ad74413r_init_param {
    enum ad74413r_chip_id chip_id;
    struct no_os_spi_init_param comm_param;
    struct no_os_gpio_init_param *reset_gpio_param;
};
 
struct ad74413r_decimal {
    int64_t integer;
    int32_t decimal;
};
 
struct ad74413r_channel_config {
    bool enabled;
    enum ad74413r_op_mode function;
};
 
struct _ad74413r_live_status {
    uint8_t VI_ERR_A: 1;
    uint8_t VI_ERR_B: 1;
    uint8_t VI_ERR_C: 1;
    uint8_t VI_ERR_D: 1;
    uint8_t HI_TEMP_ERR: 1;
    uint8_t CHARGE_PUMP_ERR: 1;
    uint8_t ALDO5V_ERR: 1;
    uint8_t AVDD_ERR: 1;
    uint8_t DVCC_ERR: 1;
    uint8_t ALDO1V8_ERR: 1;
    uint8_t ADC_CH_CURR: 3;
    uint8_t ADC_BUSY: 1;
    uint8_t ADC_DATA_RDY: 1;
    uint8_t _RESERVED: 1;
};
 
union ad74413r_live_status {
    struct _ad74413r_live_status status_bits;
    uint16_t value;
};
 
struct ad74413r_desc {
    enum ad74413r_chip_id chip_id;
    struct no_os_spi_desc *comm_desc;
    uint8_t comm_buff[4];
    struct ad74413r_channel_config channel_configs[AD74413R_N_CHANNELS];
    struct no_os_gpio_desc *reset_gpio;
};
 
int ad74413r_dac_voltage_to_code(uint32_t, uint32_t *);
 
int ad74413r_range_to_voltage_range(enum ad74413r_adc_range, uint32_t *);
 
int ad74413r_range_to_voltage_offset(enum ad74413r_adc_range, int32_t *);
 
int ad74413r_reg_write(struct ad74413r_desc *, uint32_t, uint16_t);
 
int ad74413r_reg_read_raw(struct ad74413r_desc *, uint32_t, uint8_t *);
 
int ad74413r_reg_read(struct ad74413r_desc *, uint32_t, uint16_t *);
 
int ad74413r_reg_update(struct ad74413r_desc *, uint32_t, uint16_t,
            uint16_t);
 
int ad74413r_nb_active_channels(struct ad74413r_desc *, uint8_t *);
 
int ad74413r_clear_errors(struct ad74413r_desc *);
 
int ad74413r_set_info(struct ad74413r_desc *desc, uint16_t mode);
 
int ad74413r_reset(struct ad74413r_desc *);
 
int ad74413r_set_channel_function(struct ad74413r_desc *,
                  uint32_t, enum ad74413r_op_mode);
 
int ad74413r_get_raw_adc_result(struct ad74413r_desc *, uint32_t,
                uint16_t *);
 
int ad74413r_set_adc_channel_enable(struct ad74413r_desc *, uint32_t,
                    bool);
 
int ad74413r_set_diag_channel_enable(struct ad74413r_desc *, uint32_t, bool);
 
int ad74413r_get_adc_range(struct ad74413r_desc *, uint32_t, uint16_t *);
 
int ad74413r_get_adc_rejection(struct ad74413r_desc *, uint32_t,
                   enum ad74413r_rejection *);
 
int ad74413r_get_adc_diag_rejection(struct ad74413r_desc *,
                    enum ad74413r_rejection *);
 
int ad74413r_set_adc_rejection(struct ad74413r_desc *, uint32_t,
                   enum ad74413r_rejection);
 
int ad74413r_get_adc_rate(struct ad74413r_desc *, uint32_t,
              enum ad74413r_adc_sample *);
 
int ad74413r_set_adc_rate(struct ad74413r_desc *, uint32_t,
              enum ad74413r_adc_sample);
 
int ad74413r_get_adc_diag_rate(struct ad74413r_desc *, uint32_t,
                   enum ad74413r_adc_sample *);
 
int ad74413r_set_adc_diag_rate(struct ad74413r_desc *, uint32_t,
                   enum ad74413r_adc_sample);
 
int ad74413r_set_adc_conv_seq(struct ad74413r_desc *, enum ad74413r_conv_seq);
 
int ad74413r_get_adc_single(struct ad74413r_desc *, uint32_t, uint16_t *, bool);
 
int ad74413r_adc_get_value(struct ad74413r_desc *, uint32_t,
               struct ad74413r_decimal *);
 
int ad74413r_get_temp(struct ad74413r_desc *, uint32_t, uint16_t *);
 
int ad74413r_set_channel_dac_code(struct ad74413r_desc *, uint32_t, uint16_t);
 
int ad74413r_set_diag(struct ad74413r_desc *, uint32_t,
              enum ad74413r_diag_mode);
 
int ad74413r_get_diag(struct ad74413r_desc *, uint32_t, uint16_t *);
 
int ad74413r_set_debounce_mode(struct ad74413r_desc *, uint32_t,
                   enum ad74413r_debounce_mode);
 
int ad74413r_set_debounce_time(struct ad74413r_desc *, uint32_t, uint32_t);
 
int ad74413r_gpo_get(struct ad74413r_desc *, uint32_t, uint8_t *);
 
int ad74413r_set_gpo_config(struct ad74413r_desc *, uint32_t,
                enum ad74413r_gpo_select);
 
int ad74413r_set_threshold(struct ad74413r_desc *, uint32_t, uint32_t);
 
int ad74413r_gpo_set(struct ad74413r_desc *, uint32_t, uint8_t);
 
int ad74413r_gpo_set_multiple(struct ad74413r_desc *, uint32_t);
 
int ad74413r_get_live(struct ad74413r_desc *,
              union ad74413r_live_status *);
 
int ad74413r_set_dac_clear_code(struct ad74413r_desc *, uint32_t, uint16_t);
 
int ad74413r_clear_dac(struct ad74413r_desc *, uint32_t);
 
int ad74413r_dac_slew_enable(struct ad74413r_desc *, uint32_t,
                 enum ad74413r_slew_lin_step,
                 enum ad74413r_lin_rate);
 
int ad74413r_dac_slew_disable(struct ad74413r_desc *, uint32_t);
 
int ad74413r_set_therm_rst(struct ad74413r_desc *, bool);
 
int ad74413r_init(struct ad74413r_desc **, struct ad74413r_init_param *);
 
int ad74413r_remove(struct ad74413r_desc *desc);
 
#endif // _AD74413R_H