Header file of AD5421 Driver for Microblaze processor. More...

#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"

Include dependency graph for ad5421.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	ad5421_dev

struct	ad5421_init_param

Macros
#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

#define	AD5421_CMD(x) ((x & 0xFF) << 16)

#define	AD5421_LDAC_OUT

#define	AD5421_LDAC_LOW

#define	AD5421_LDAC_HIGH

#define	AD5421_FAULT_IN no_os_gpio_direction_input(dev->gpio_faultin)

#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)

Functions
int32_t	ad5421_init (struct ad5421_dev **device, struct ad5421_init_param init_param)
	Initialize SPI and Initial Values for AD5421 Board. More...

int32_t	ad5421_remove (struct ad5421_dev *dev)
	Free the resources allocated by ad5421_init(). More...

void	ad5421_set_dac (struct ad5421_dev *dev, int32_t dac_value)
	Write to the DAC register. More...

void	ad5421_set_offset (struct ad5421_dev *dev, int32_t offset_value)
	Write to the Offset Adjust register. More...

void	ad5421_set_gain (struct ad5421_dev *dev, int32_t gain_value)
	Write to the Gain Adjust register. More...

int32_t	ad5421_get_dac (struct ad5421_dev *dev)
	Read from the DAC register. More...

int32_t	ad5421_get_offset (struct ad5421_dev *dev)
	Read from the Offset Adjust register. More...

int32_t	ad5421_get_gain (struct ad5421_dev *dev)
	Read from the Gain Adjust register. More...

int32_t	ad5421_get_fault (struct ad5421_dev *dev)
	Read from the Fault register. More...

int32_t	ad5421_get_temp (struct ad5421_dev *dev)
	Read the temperature from Fault register. More...

float	ad5421_get_vloop (struct ad5421_dev *dev)
	Read VLoop-COM from Fault register. More...

int32_t	ad5421_set (struct ad5421_dev dev, int32_t i_value)
	Send data via SPI. More...

int32_t	ad5421_get (struct ad5421_dev *dev)
	Read data via SPI. More...

void	ad5421_reset (struct ad5421_dev *dev)
	Resets the ad5421 device. More...

Detailed Description

Header file of AD5421 Driver for Microblaze processor.

Author: Lucian Sin (Lucia.nosp@m.n.Si.nosp@m.n@ana.nosp@m.log..nosp@m.com)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ AD5421_CMD

#define AD5421_CMD ( x ) ((x & 0xFF) << 16)

◆ AD5421_CMDMEASVTEMP

#define AD5421_CMDMEASVTEMP 8

◆ AD5421_CMDRDCTRL

#define AD5421_CMDRDCTRL 130

◆ AD5421_CMDRDDAC

#define AD5421_CMDRDDAC 129

◆ AD5421_CMDRDFAULT

#define AD5421_CMDRDFAULT 133

◆ AD5421_CMDRDGAIN

#define AD5421_CMDRDGAIN 132

◆ AD5421_CMDRDOFFSET

#define AD5421_CMDRDOFFSET 131

◆ AD5421_CMDRST

#define AD5421_CMDRST 7

◆ AD5421_CMDWRCTRL

#define AD5421_CMDWRCTRL 2

◆ AD5421_CMDWRDAC

#define AD5421_CMDWRDAC 1

◆ AD5421_CMDWRGAIN

#define AD5421_CMDWRGAIN 4

◆ AD5421_CMDWROFFSET

#define AD5421_CMDWROFFSET 3

◆ AD5421_FAULT_IN

#define AD5421_FAULT_IN no_os_gpio_direction_input(dev->gpio_faultin)

◆ AD5421_LDAC_HIGH

#define AD5421_LDAC_HIGH

Value:

no_os_gpio_set_value(dev->gpio_ldac, \

NO_OS_GPIO_HIGH)

◆ AD5421_LDAC_LOW

#define AD5421_LDAC_LOW

Value:

no_os_gpio_set_value(dev->gpio_ldac, \

NO_OS_GPIO_LOW)

◆ AD5421_LDAC_OUT

#define AD5421_LDAC_OUT

Value:

no_os_gpio_direction_output(dev->gpio_ldac, \

NO_OS_GPIO_HIGH)

◆ AD5421_NO_OP

#define AD5421_NO_OP 9

◆ CTRL_AUTO_FAULT_RDBK

#define CTRL_AUTO_FAULT_RDBK (1 << 11)

◆ CTRL_ONCHIP_ADC

#define CTRL_ONCHIP_ADC (1 << 7)

◆ CTRL_SEL_ADC_INPUT

#define CTRL_SEL_ADC_INPUT (1 << 8)

◆ CTRL_SPI_WATCHDOG

#define CTRL_SPI_WATCHDOG (1 << 12)

Function Documentation

◆ ad5421_get()

int32_t ad5421_get ( struct ad5421_dev * dev )

Read data via SPI.

Parameters

dev	- The device structure.

Returns: returnVal - Data read

Here is the caller graph for this function:

◆ ad5421_get_dac()

int32_t ad5421_get_dac ( struct ad5421_dev * dev )

Read from the DAC register.

Parameters

dev	- The device structure.

Returns: dacValue - value read from the register.

◆ ad5421_get_fault()

int32_t ad5421_get_fault ( struct ad5421_dev * dev )

Read from the Fault register.

Parameters

dev	- The device structure.

Returns: value - register content

◆ ad5421_get_gain()

int32_t ad5421_get_gain ( struct ad5421_dev * dev )

Read from the Gain Adjust register.

Parameters

dev	- The device structure.

Returns: gainValue - value calculated according to the datasheet formula

◆ ad5421_get_offset()

int32_t ad5421_get_offset ( struct ad5421_dev * dev )

Read from the Offset Adjust register.

Parameters

dev	- The device structure.

Returns: offsetValue - value calculated according to the datasheet formula.

◆ ad5421_get_temp()

int32_t ad5421_get_temp ( struct ad5421_dev * dev )

Read the temperature from Fault register.

Parameters

dev	- The device structure.

Returns: tempValue - temperature value in Celsius degrees.

◆ ad5421_get_vloop()

float ad5421_get_vloop ( struct ad5421_dev * dev )

Read VLoop-COM from Fault register.

Parameters

dev	- The device structure.

Returns: vlopValue - value of the voltage drop between Vloop and COM.

◆ ad5421_init()

int32_t ad5421_init	(	struct ad5421_dev **	device,
		struct ad5421_init_param	init_param
	)

Initialize SPI and Initial Values for AD5421 Board.

Parameters

device	- The device structure.
init_param	- The structure that contains the device initial parameters.

Returns: retValue - Result of the initialization. Example: 0 - if initialization was successful; -1 - if initialization was unsuccessful.

◆ ad5421_remove()

int32_t ad5421_remove ( struct ad5421_dev * dev )

Free the resources allocated by ad5421_init().

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

◆ ad5421_reset()

void ad5421_reset ( struct ad5421_dev * dev )

Resets the ad5421 device.

Parameters

dev	- The device structure.

Returns: None.

◆ ad5421_set()

int32_t ad5421_set	(	struct ad5421_dev *	dev,
		int32_t *	value
	)

Send data via SPI.

Parameters

dev	- The device structure.
value	- value to be sent via SPI

Returns: - Result of the initialization. Example: 0 - if initialization was successful; -1 - if initialization was unsuccessful.

Here is the caller graph for this function:

◆ ad5421_set_dac()

void ad5421_set_dac	(	struct ad5421_dev *	dev,
		int32_t	dac_value
	)

Write to the DAC register.

Parameters

dev	- The device structure.
dac_value	- desired value to be written in register.

Returns: None.

◆ ad5421_set_gain()

void ad5421_set_gain	(	struct ad5421_dev *	dev,
		int32_t	gain_value
	)

Write to the Gain Adjust register.

Parameters

dev	- The device structure.
gain_value	- desired value to be written in register.

Returns: None.

◆ ad5421_set_offset()

void ad5421_set_offset	(	struct ad5421_dev *	dev,
		int32_t	offset_value
	)

Write to the Offset Adjust register.

Parameters

dev	- The device structure.
offset_value	- desired value to be written in register.

Returns: None.

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ AD5421_CMD

◆ AD5421_CMDMEASVTEMP

◆ AD5421_CMDRDCTRL

◆ AD5421_CMDRDDAC

◆ AD5421_CMDRDFAULT

◆ AD5421_CMDRDGAIN

◆ AD5421_CMDRDOFFSET

◆ AD5421_CMDRST

◆ AD5421_CMDWRCTRL

◆ AD5421_CMDWRDAC

◆ AD5421_CMDWRGAIN

◆ AD5421_CMDWROFFSET

◆ AD5421_FAULT_IN

◆ AD5421_LDAC_HIGH

◆ AD5421_LDAC_LOW

◆ AD5421_LDAC_OUT

◆ AD5421_NO_OP

◆ CTRL_AUTO_FAULT_RDBK

◆ CTRL_ONCHIP_ADC

◆ CTRL_SEL_ADC_INPUT

◆ CTRL_SPI_WATCHDOG

Function Documentation

◆ ad5421_get()

◆ ad5421_get_dac()

◆ ad5421_get_fault()

◆ ad5421_get_gain()

◆ ad5421_get_offset()

◆ ad5421_get_temp()

◆ ad5421_get_vloop()

◆ ad5421_init()

◆ ad5421_remove()

◆ ad5421_reset()

◆ ad5421_set()

◆ ad5421_set_dac()

◆ ad5421_set_gain()

◆ ad5421_set_offset()