no-OS
Loading...
Searching...
No Matches
Classes | Macros | Functions
ad7980.h File Reference

Header file of AD7980 Driver. More...

#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
Include dependency graph for ad7980.h:

Classes

struct  ad7980_dev
 
struct  ad7980_init_param
 

Macros

#define AD7980_CS_LOW
 
#define AD7980_CS_HIGH
 

Functions

int8_t ad7980_init (struct ad7980_dev **device, struct ad7980_init_param init_param)
 Initializes the communication peripheral.
 
int32_t ad7980_remove (struct ad7980_dev *dev)
 Free the resources allocated by ad7980_init().
 
uint16_t ad7980_conversion (struct ad7980_dev *dev)
 Initiates conversion and reads data.
 
float ad7980_convert_to_volts (uint16_t raw_sample, float v_ref)
 Converts a 16-bit raw sample to volts.
 

Detailed Description

Header file of AD7980 Driver.

Author
Bancisor Mihai(Banci.nosp@m.sor..nosp@m.Mihai.nosp@m.@ana.nosp@m.log.c.nosp@m.om)

Copyright 2012(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Macro Definition Documentation

◆ AD7980_CS_HIGH

#define AD7980_CS_HIGH
Value:
no_os_gpio_set_value(dev->gpio_cs, \
NO_OS_GPIO_HIGH)
no_os_gpio_set_value
int32_t no_os_gpio_set_value(struct no_os_gpio_desc *desc, uint8_t value)
Set the value of the specified GPIO.
Definition no_os_gpio.c:170
NO_OS_GPIO_HIGH
@ NO_OS_GPIO_HIGH
Definition no_os_gpio.h:82

◆ AD7980_CS_LOW

#define AD7980_CS_LOW
Value:
no_os_gpio_set_value(dev->gpio_cs, \
NO_OS_GPIO_LOW)
NO_OS_GPIO_LOW
@ NO_OS_GPIO_LOW
Definition no_os_gpio.h:80

Function Documentation

◆ ad7980_conversion()

uint16_t ad7980_conversion ( struct ad7980_dev * dev)

Initiates conversion and reads data.

Initiates conversion and reads data.

Parameters
dev- The device structure.
Returns
receivedData - Data read from the ADC.

◆ ad7980_convert_to_volts()

float ad7980_convert_to_volts ( uint16_t raw_sample,
float v_ref )

Converts a 16-bit raw sample to volts.

Converts a 16-bit raw sample to volts.

Parameters
raw_sample- 16-bit data sample.
v_ref- The value of the voltage reference used by the device.
Returns
voltage - The result of the conversion expressed as volts.

◆ ad7980_init()

int8_t ad7980_init ( struct ad7980_dev ** device,
struct ad7980_init_param init_param )

Initializes the communication peripheral.

Initializes the communication peripheral.

Parameters
device- The device structure.
init_param- The structure that contains the device initial parameters.
Returns
status - Initialization status. Example: -1 - Initialization failed; 0 - Initialization succeeded.

◆ ad7980_remove()

int32_t ad7980_remove ( struct ad7980_dev * dev)

Free the resources allocated by ad7980_init().

Free the resources allocated by ad7980_init().

Parameters
dev- The device structure.
Returns
0 in case of success, negative error code otherwise.