no-OS
ad5421.h
Go to the documentation of this file.
1 /**************************************************************************/
42 #ifndef _AD5421_H_
43 #define _AD5421_H_
44 
45 /*****************************************************************************/
46 /***************************** Include Files *********************************/
47 /*****************************************************************************/
48 #include <stdint.h>
49 #include "no_os_gpio.h"
50 #include "no_os_spi.h"
51 
52 /*****************************************************************************/
53 /******************** Macros and Constants Definitions ***********************/
54 /*****************************************************************************/
55 /* COMMAND Bytes */
56 #define AD5421_CMDWRDAC 1
57 #define AD5421_CMDWRCTRL 2
58 #define AD5421_CMDWROFFSET 3
59 #define AD5421_CMDWRGAIN 4
60 #define AD5421_CMDRST 7
61 #define AD5421_CMDMEASVTEMP 8
62 #define AD5421_CMDRDDAC 129
63 #define AD5421_CMDRDCTRL 130
64 #define AD5421_CMDRDOFFSET 131
65 #define AD5421_CMDRDGAIN 132
66 #define AD5421_CMDRDFAULT 133
67 
68 /* AD5421 COMMAND mask */
69 #define AD5421_CMD(x) ((x & 0xFF) << 16)
70 
71 /* AD5421 GPIO */
72 #define AD5421_LDAC_OUT no_os_gpio_direction_output(dev->gpio_ldac, \
73  NO_OS_GPIO_HIGH)
74 #define AD5421_LDAC_LOW no_os_gpio_set_value(dev->gpio_ldac, \
75  NO_OS_GPIO_LOW)
76 #define AD5421_LDAC_HIGH no_os_gpio_set_value(dev->gpio_ldac, \
77  NO_OS_GPIO_HIGH)
78 #define AD5421_FAULT_IN no_os_gpio_direction_input(dev->gpio_faultin)
79 
80 /* CONTROL register bits */
81 #define CTRL_SPI_WATCHDOG (1 << 12)
82 #define CTRL_AUTO_FAULT_RDBK (1 << 11)
83 #define CTRL_SEL_ADC_INPUT (1 << 8)
84 #define CTRL_ONCHIP_ADC (1 << 7)
85 
86 /******************************************************************************/
87 /*************************** Types Declarations *******************************/
88 /******************************************************************************/
89 
90 struct ad5421_dev {
91  /* SPI */
93  /* GPIO */
96 };
97 
99  /* SPI */
101  /* GPIO */
104 };
105 
106 /*****************************************************************************/
107 /************************* Functions Declarations ****************************/
108 /*****************************************************************************/
109 /* Initialize the communication with the device. */
110 int32_t ad5421_init(struct ad5421_dev **device,
112 /* Free the resources allocated by ad5421_init(). */
113 int32_t ad5421_remove(struct ad5421_dev *dev);
114 /* Set the value of DAC register. */
115 void ad5421_set_dac(struct ad5421_dev *dev,
116  int32_t dac_value);
117 /* Set the value of OFFSET register. */
118 void ad5421_set_offset(struct ad5421_dev *dev,
119  int32_t offset_value);
120 /* Set the value of GAIN register. */
121 void ad5421_set_gain(struct ad5421_dev *dev,
122  int32_t gain_value);
123 /* Read the DAC register. */
124 int32_t ad5421_get_dac(struct ad5421_dev *dev);
125 /* Read OFFSET register. */
126 int32_t ad5421_get_offset(struct ad5421_dev *dev);
127 /* Read GAIN register. */
128 int32_t ad5421_get_gain(struct ad5421_dev *dev);
129 /* Read FAULT register. */
130 int32_t ad5421_get_fault(struct ad5421_dev *dev);
131 /* Read the temperature from Fault register. */
132 int32_t ad5421_get_temp(struct ad5421_dev *dev);
133 /* Read VLoop-COM from Fault register. */
134 float ad5421_get_vloop(struct ad5421_dev *dev);
135 /* Send command via SPI. */
136 int32_t ad5421_set(struct ad5421_dev *dev,
137  int32_t *i_value);
138 /* Receive value via SPI. */
139 int32_t ad5421_get(struct ad5421_dev *dev);
140 /* Resets the AD5421 device. */
141 void ad5421_reset(struct ad5421_dev *dev);
142 
143 #endif /* _AD5421_H_ */
AD5421_CMDWRGAIN
#define AD5421_CMDWRGAIN
Definition: ad5421.h:59
ad5421_init_param::spi_init
no_os_spi_init_param spi_init
Definition: ad5421.h:100
AD5421_CMDRDGAIN
#define AD5421_CMDRDGAIN
Definition: ad5421.h:65
ad5421_dev::gpio_faultin
struct no_os_gpio_desc * gpio_faultin
Definition: ad5421.h:95
no_os_gpio_init_param
Structure holding the parameters for GPIO initialization.
Definition: no_os_gpio.h:85
ad5421_init_param::gpio_faultin
struct no_os_gpio_init_param gpio_faultin
Definition: ad5421.h:103
no_os_spi_write_and_read
int32_t no_os_spi_write_and_read(struct no_os_spi_desc *desc, uint8_t *data, uint16_t bytes_number)
Write and read data to/from SPI.
Definition: no_os_spi.c:82
ad5421_get_vloop
float ad5421_get_vloop(struct ad5421_dev *dev)
Read VLoop-COM from Fault register.
Definition: ad5421.c:331
ad5421_get
int32_t ad5421_get(struct ad5421_dev *dev)
Read data via SPI.
Definition: ad5421.c:400
no_os_spi.h
Header file of SPI Interface.
ad5421_get
int32_t ad5421_get(struct ad5421_dev *dev)
Read data via SPI.
Definition: ad5421.c:400
AD5421_CMDWROFFSET
#define AD5421_CMDWROFFSET
Definition: ad5421.h:58
AD5421_CMDWRCTRL
#define AD5421_CMDWRCTRL
Definition: ad5421.h:57
ad5421_reset
void ad5421_reset(struct ad5421_dev *dev)
Resets the ad5421 device.
Definition: ad5421.c:425
ad5421_get_dac
int32_t ad5421_get_dac(struct ad5421_dev *dev)
Read from the DAC register.
Definition: ad5421.c:205
ad5421_set
int32_t ad5421_set(struct ad5421_dev *dev, int32_t *value)
Send data via SPI.
Definition: ad5421.c:372
device
Definition: ad9361_util.h:75
ad5421_init_param
Definition: ad5421.h:98
CTRL_ONCHIP_ADC
#define CTRL_ONCHIP_ADC
Definition: ad5421.h:84
ad5421_dev::gpio_ldac
struct no_os_gpio_desc * gpio_ldac
Definition: ad5421.h:94
ad5421_init_param::gpio_ldac
struct no_os_gpio_init_param gpio_ldac
Definition: ad5421.h:102
AD5421_CMDMEASVTEMP
#define AD5421_CMDMEASVTEMP
Definition: ad5421.h:61
CTRL_SPI_WATCHDOG
#define CTRL_SPI_WATCHDOG
Definition: ad5421.h:81
ad5421_init
int32_t ad5421_init(struct ad5421_dev **device, struct ad5421_init_param init_param)
Initialize SPI and Initial Values for AD5421 Board.
Definition: ad5421.c:64
CTRL_AUTO_FAULT_RDBK
#define CTRL_AUTO_FAULT_RDBK
Definition: ad5421.h:82
ad5421_get_fault
int32_t ad5421_get_fault(struct ad5421_dev *dev)
Read from the Fault register.
Definition: ad5421.c:268
ad5421_get_dac
int32_t ad5421_get_dac(struct ad5421_dev *dev)
Read from the DAC register.
Definition: ad5421.c:205
AD5421_CMDRDDAC
#define AD5421_CMDRDDAC
Definition: ad5421.h:62
ad5421_get_gain
int32_t ad5421_get_gain(struct ad5421_dev *dev)
Read from the Gain Adjust register.
Definition: ad5421.c:247
AD5421_CMDRDOFFSET
#define AD5421_CMDRDOFFSET
Definition: ad5421.h:64
ad5421_init
int32_t ad5421_init(struct ad5421_dev **device, struct ad5421_init_param init_param)
Initialize SPI and Initial Values for AD5421 Board.
Definition: ad5421.c:64
ad5421_get_fault
int32_t ad5421_get_fault(struct ad5421_dev *dev)
Read from the Fault register.
Definition: ad5421.c:268
AD5421_CMD
#define AD5421_CMD(x)
Definition: ad5421.h:69
AD5421_CMDRST
#define AD5421_CMDRST
Definition: ad5421.h:60
ad5421_set
int32_t ad5421_set(struct ad5421_dev *dev, int32_t *i_value)
Send data via SPI.
Definition: ad5421.c:372
ad5421_set_dac
void ad5421_set_dac(struct ad5421_dev *dev, int32_t dac_value)
Write to the DAC register.
Definition: ad5421.c:146
ad5421_set_gain
void ad5421_set_gain(struct ad5421_dev *dev, int32_t gain_value)
Write to the Gain Adjust register.
Definition: ad5421.c:186
ad5421_dev
Definition: ad5421.h:90
ad5421_get_temp
int32_t ad5421_get_temp(struct ad5421_dev *dev)
Read the temperature from Fault register.
Definition: ad5421.c:290
ad5421_remove
int32_t ad5421_remove(struct ad5421_dev *dev)
Free the resources allocated by ad5421_init().
Definition: ad5421.c:124
no_os_gpio_remove
int32_t no_os_gpio_remove(struct no_os_gpio_desc *desc)
Free the resources allocated by no_os_gpio_get().
Definition: no_os_gpio.c:95
ad5421_set_gain
void ad5421_set_gain(struct ad5421_dev *dev, int32_t gain_value)
Write to the Gain Adjust register.
Definition: ad5421.c:186
no_os_spi_desc
Structure holding SPI descriptor.
Definition: no_os_spi.h:132
ad5421_get_gain
int32_t ad5421_get_gain(struct ad5421_dev *dev)
Read from the Gain Adjust register.
Definition: ad5421.c:247
ad5421_get_temp
int32_t ad5421_get_temp(struct ad5421_dev *dev)
Read the temperature from Fault register.
Definition: ad5421.c:290
AD5421_FAULT_IN
#define AD5421_FAULT_IN
Definition: ad5421.h:78
no_os_gpio_desc
Structure holding the GPIO descriptor.
Definition: no_os_gpio.h:102
ad5421_get_offset
int32_t ad5421_get_offset(struct ad5421_dev *dev)
Read from the Offset Adjust register.
Definition: ad5421.c:226
no_os_gpio_get
int32_t no_os_gpio_get(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Obtain the GPIO decriptor.
Definition: no_os_gpio.c:55
ad5421_get_offset
int32_t ad5421_get_offset(struct ad5421_dev *dev)
Read from the Offset Adjust register.
Definition: ad5421.c:226
AD5421_LDAC_OUT
#define AD5421_LDAC_OUT
Definition: ad5421.h:72
CTRL_SEL_ADC_INPUT
#define CTRL_SEL_ADC_INPUT
Definition: ad5421.h:83
AD5421_CMDRDFAULT
#define AD5421_CMDRDFAULT
Definition: ad5421.h:66
init_param
struct ad7616_init_param init_param
Definition: ad7616_sdz.c:96
no_os_spi_remove
int32_t no_os_spi_remove(struct no_os_spi_desc *desc)
Free the resources allocated by no_os_spi_init().
Definition: no_os_spi.c:70
no_os_gpio.h
Header file of GPIO Interface.
no_os_spi_init
int32_t no_os_spi_init(struct no_os_spi_desc **desc, const struct no_os_spi_init_param *param)
Initialize the SPI communication peripheral.
Definition: no_os_spi.c:51
ad5421_dev::spi_desc
no_os_spi_desc * spi_desc
Definition: ad5421.h:92
ad5421_get_vloop
float ad5421_get_vloop(struct ad5421_dev *dev)
Read VLoop-COM from Fault register.
Definition: ad5421.c:331
ad5421.h
Header file of AD5421 Driver for Microblaze processor.
AD5421_CMDWRDAC
#define AD5421_CMDWRDAC
Definition: ad5421.h:56
ad5421_set_dac
void ad5421_set_dac(struct ad5421_dev *dev, int32_t dac_value)
Write to the DAC register.
Definition: ad5421.c:146
AD5421_CMDRDCTRL
#define AD5421_CMDRDCTRL
Definition: ad5421.h:63
ad5421_set_offset
void ad5421_set_offset(struct ad5421_dev *dev, int32_t offset_value)
Write to the Offset Adjust register.
Definition: ad5421.c:166
ad5421_remove
int32_t ad5421_remove(struct ad5421_dev *dev)
Free the resources allocated by ad5421_init().
Definition: ad5421.c:124
ad5421_reset
void ad5421_reset(struct ad5421_dev *dev)
Resets the ad5421 device.
Definition: ad5421.c:425
AD5421_LDAC_LOW
#define AD5421_LDAC_LOW
Definition: ad5421.h:74
no_os_spi_init_param
Structure holding the parameters for SPI initialization.
Definition: no_os_spi.h:112
ad5421_set_offset
void ad5421_set_offset(struct ad5421_dev *dev, int32_t offset_value)
Write to the Offset Adjust register.
Definition: ad5421.c:166