ad74xx.h File Reference

Header file of AD74xx Driver. More...

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

Include dependency graph for ad74xx.h:

Classes
struct	ad74xx_dev
struct	ad74xx_init_param

Macros
#define	AD74XX_CS_LOW
#define	AD74XX_CS_HIGH

Enumerations
enum	ad74xx_type {   ID_AD7466 = 12 ,   ID_AD7467 = 10 ,   ID_AD7468 = 8 ,   ID_AD7475 = 12 ,   ID_AD7476 = 12 ,   ID_AD7476A = 12 ,   ID_AD7477 = 10 ,   ID_AD7477A = 10 ,   ID_AD7478 = 8 ,   ID_AD7478A = 8 ,   ID_AD7495 = 12 }

Functions
int8_t	ad74xx_init (struct ad74xx_dev **device, struct ad74xx_init_param init_param)
	Initializes the communication peripheral and the initial Values for AD74xx Board.
int32_t	ad74xx_remove (struct ad74xx_dev *dev)
	Free the resources allocated by ad74xx_init().
void	ad74xx_power_down (struct ad74xx_dev *dev)
	Powers down the device. This function is supported only by: AD7475(partial power down), AD7476, AD7477, AD7478, AD7476A, AD7477A, AD7478A, AD7479(partial power down).
void	ad74xx_power_up (struct ad74xx_dev *dev)
	Powers up the device by performing a dummy read. This function is supported only by: AD7475(partial power down), AD7476, AD7477, AD7478, AD7476A, AD7477A, AD7478A, AD7479(partial power down).
uint16_t	ad74xx_get_register_value (struct ad74xx_dev *dev)
	Reads the conversion value.
float	ad74xx_convert_to_volts (struct ad74xx_dev *dev, uint16_t raw_value, float v_ref)
	Converts a raw sample to volts.

Detailed Description

Header file of AD74xx Driver.

Author

DNechita(Dan.N.nosp@m.echi.nosp@m.ta@an.nosp@m.alog.nosp@m..com)

Copyright 2012(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Macro Definition Documentation

AD74XX_CS_HIGH

#define AD74XX_CS_HIGH

Value:

                    no_os_gpio_set_value(dev->gpio_cs,  \
                    NO_OS_GPIO_HIGH)

AD74XX_CS_LOW

#define AD74XX_CS_LOW

Value:

                    no_os_gpio_set_value(dev->gpio_cs,  \
                    NO_OS_GPIO_LOW)

Enumeration Type Documentation

ad74xx_type

enum ad74xx_type

Enumerator
ID_AD7466
ID_AD7467
ID_AD7468
ID_AD7475
ID_AD7476
ID_AD7476A
ID_AD7477
ID_AD7477A
ID_AD7478
ID_AD7478A
ID_AD7495

Function Documentation

ad74xx_convert_to_volts()

float ad74xx_convert_to_volts	(	struct ad74xx_dev *	dev,
		uint16_t	raw_value,
		float	v_ref )

Converts a raw sample to volts.

Converts a raw sample to volts.

Parameters

dev	- The device structure.
raw_value	- The data sample.
v_ref	- The value of the voltage reference used by the device.

Returns

voltage - The result of the conversion expressed as volts.

ad74xx_get_register_value()

uint16_t ad74xx_get_register_value

(

struct ad74xx_dev *

dev

)

Reads the conversion value.

Reads the conversion value.

Parameters

dev	- The device structure.

Returns

convResult - conversion data.

ad74xx_init()

int8_t ad74xx_init	(	struct ad74xx_dev **	device,
		struct ad74xx_init_param	init_param )

Initializes the communication peripheral and the initial Values for AD74xx Board.

Initializes device.

Parameters

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

Returns

ret - The result of the initialization procedure. Example: -1 - SPI peripheral was not initialized or the device is not present. 0 - SPI peripheral was initialized and the device is present.

ad74xx_power_down()

void ad74xx_power_down

(

struct ad74xx_dev *

dev

)

Powers down the device. This function is supported only by: AD7475(partial power down), AD7476, AD7477, AD7478, AD7476A, AD7477A, AD7478A, AD7479(partial power down).

Powers down the device.

Parameters

dev	- The device structure.

ad74xx_power_up()

void ad74xx_power_up

(

struct ad74xx_dev *

dev

)

Powers up the device by performing a dummy read. This function is supported only by: AD7475(partial power down), AD7476, AD7477, AD7478, AD7476A, AD7477A, AD7478A, AD7479(partial power down).

Powers up the device by performing a dummy read.

Parameters

dev	- The device structure.

ad74xx_remove()

int32_t ad74xx_remove

(

struct ad74xx_dev *

dev

)

Free the resources allocated by ad74xx_init().

Free the resources allocated by AD74xx_Init().

Parameters

dev	- The device structure.

Returns

ret - The result of the remove procedure.