ad5421.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef _AD5421_H_
#define _AD5421_H_
 
/*****************************************************************************/
/***************************** Include Files *********************************/
/*****************************************************************************/
#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
 
/*****************************************************************************/
/******************** Macros and Constants Definitions ***********************/
/*****************************************************************************/
/* COMMAND Bytes */
#define AD5421_CMDWRDAC         1
#define AD5421_CMDWRCTRL        2
#define AD5421_CMDWROFFSET      3
#define AD5421_CMDWRGAIN        4
#define AD5421_CMDRST           7
#define AD5421_CMDMEASVTEMP     8
#define AD5421_NO_OP            9
#define AD5421_CMDRDDAC         129
#define AD5421_CMDRDCTRL        130
#define AD5421_CMDRDOFFSET      131
#define AD5421_CMDRDGAIN        132
#define AD5421_CMDRDFAULT       133
 
/* AD5421 COMMAND mask */
#define AD5421_CMD(x)           ((x & 0xFF) << 16)
 
/* AD5421 GPIO */
#define AD5421_LDAC_OUT         no_os_gpio_direction_output(dev->gpio_ldac,   \
                            NO_OS_GPIO_HIGH)
#define AD5421_LDAC_LOW         no_os_gpio_set_value(dev->gpio_ldac,          \
                            NO_OS_GPIO_LOW)
#define AD5421_LDAC_HIGH        no_os_gpio_set_value(dev->gpio_ldac,          \
                            NO_OS_GPIO_HIGH)
#define AD5421_FAULT_IN         no_os_gpio_direction_input(dev->gpio_faultin)
 
/* CONTROL register bits */
#define CTRL_SPI_WATCHDOG       (1 << 12)
#define CTRL_AUTO_FAULT_RDBK    (1 << 11)
#define CTRL_SEL_ADC_INPUT      (1 << 8)
#define CTRL_ONCHIP_ADC         (1 << 7)
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
struct ad5421_dev {
    /* SPI */
    struct no_os_spi_desc       *spi_desc;
    /* GPIO */
    struct no_os_gpio_desc  *gpio_ldac;
    struct no_os_gpio_desc  *gpio_faultin;
};
 
struct ad5421_init_param {
    /* 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_faultin;
};
 
/*****************************************************************************/
/************************* Functions Declarations ****************************/
/*****************************************************************************/
/* Initialize the communication with the device. */
int32_t ad5421_init(struct ad5421_dev **device,
            struct ad5421_init_param init_param);
/* Free the resources allocated by ad5421_init(). */
int32_t ad5421_remove(struct ad5421_dev *dev);
/* Set the value of DAC register. */
void ad5421_set_dac(struct ad5421_dev *dev,
            int32_t dac_value);
/* Set the value of OFFSET register. */
void ad5421_set_offset(struct ad5421_dev *dev,
               int32_t offset_value);
/* Set the value of GAIN register. */
void ad5421_set_gain(struct ad5421_dev *dev,
             int32_t gain_value);
/* Read the DAC register. */
int32_t ad5421_get_dac(struct ad5421_dev *dev);
/* Read OFFSET register. */
int32_t ad5421_get_offset(struct ad5421_dev *dev);
/* Read GAIN register. */
int32_t ad5421_get_gain(struct ad5421_dev *dev);
/* Read FAULT register. */
int32_t ad5421_get_fault(struct ad5421_dev *dev);
/* Read the temperature from Fault register. */
int32_t ad5421_get_temp(struct ad5421_dev *dev);
/* Read VLoop-COM from Fault register. */
float ad5421_get_vloop(struct ad5421_dev *dev);
/* Send command via SPI. */
int32_t ad5421_set(struct ad5421_dev *dev,
           int32_t *i_value);
/* Receive value via SPI. */
int32_t ad5421_get(struct ad5421_dev *dev);
/* Resets the AD5421 device. */
void ad5421_reset(struct ad5421_dev *dev);
 
#endif /* _AD5421_H_ */