no-OS
Classes | Macros | Enumerations | Functions
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:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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. More...
 
int32_t ad74xx_remove (struct ad74xx_dev *dev)
 Free the resources allocated by ad74xx_init(). More...
 
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). More...
 
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). More...
 
uint16_t ad74xx_get_register_value (struct ad74xx_dev *dev)
 Reads the conversion value. More...
 
float ad74xx_convert_to_volts (struct ad74xx_dev *dev, uint16_t raw_value, float v_ref)
 Converts a raw sample to volts. More...
 

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.

All rights reserved.

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

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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

◆ AD74XX_CS_HIGH

#define AD74XX_CS_HIGH
Value:

◆ AD74XX_CS_LOW

#define AD74XX_CS_LOW
Value:
gpio_set_value(dev->gpio_cs, \

Enumeration Type Documentation

◆ 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.
Returns
None.

◆ 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.
Returns
None.

◆ 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.
GPIO_LOW
@ GPIO_LOW
Definition: gpio.h:99
gpio_set_value
int32_t gpio_set_value(struct gpio_desc *desc, uint8_t value)
Set the value of the specified GPIO.
Definition: gpio.c:160
GPIO_HIGH
@ GPIO_HIGH
Definition: gpio.h:101
iio_app_device::dev
void * dev
Definition: iio_app.h:60